kmime_util.h

/*  -*- c++ -*-
    kmime_util.h

    KMime, the KDE Internet mail/usenet news message library.
    Copyright (c) 2001 the KMime authors.
    See file AUTHORS for details

    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Library General Public
    License as published by the Free Software Foundation; either
    version 2 of the License, or (at your option) any later version.

    This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Library General Public License for more details.

    You should have received a copy of the GNU Library General Public License
    along with this library; see the file COPYING.LIB.  If not, write to
    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
    Boston, MA 02110-1301, USA.
*/
#ifndef __KMIME_UTIL_H__
#define __KMIME_UTIL_H__

#include <QtCore/QString>
#include "kmime_export.h"
#include "kmime_headers.h"
#include "kmime_content.h"

namespace KMime {

class Message;

KMIME_EXPORT extern QByteArray cachedCharset( const QByteArray &name );

KMIME_EXPORT extern QByteArray cachedLanguage( const QByteArray &name );

KMIME_EXPORT extern bool isUsAscii( const QString &s );

KMIME_EXPORT extern QString nameForEncoding( KMime::Headers::contentEncoding enc );

KMIME_EXPORT QList<KMime::Headers::contentEncoding> encodingsForData(
                                                       const QByteArray &data );
//@cond PRIVATE
extern const uchar specialsMap[16];
extern const uchar tSpecialsMap[16];
extern const uchar aTextMap[16];
extern const uchar tTextMap[16];
extern const uchar eTextMap[16];

inline bool isOfSet( const uchar map[16], unsigned char ch )
{
  return ( ch < 128 ) && ( map[ ch/8 ] & 0x80 >> ch%8 );
}
inline bool isSpecial( char ch )
{
  return isOfSet( specialsMap, ch );
}
inline bool isTSpecial( char ch )
{
  return isOfSet( tSpecialsMap, ch );
}
inline bool isAText( char ch )
{
  return isOfSet( aTextMap, ch );
}
inline bool isTText( char ch )
{
  return isOfSet( tTextMap, ch );
}
inline bool isEText( char ch )
{
  return isOfSet( eTextMap, ch );
}
//@endcond

KMIME_EXPORT extern void setFallbackCharEncoding( const QString& fallbackCharEnc );

KMIME_EXPORT extern QString fallbackCharEncoding();

KMIME_EXPORT extern void setUseOutlookAttachmentEncoding( bool violateStandard );

KMIME_EXPORT extern bool useOutlookAttachmentEncoding();
KMIME_EXPORT extern QString decodeRFC2047String(
  const QByteArray &src, QByteArray &usedCS, const QByteArray &defaultCS = QByteArray(),
  bool forceCS = false );

KMIME_EXPORT extern QString decodeRFC2047String( const QByteArray &src );

KMIME_EXPORT extern QByteArray encodeRFC2047String(
  const QString &src, const QByteArray &charset, bool addressHeader=false,
  bool allow8bitHeaders=false );


KMIME_EXPORT extern QString decodeRFC2231String(
  const QByteArray &src, QByteArray &usedCS, const QByteArray &defaultCS = QByteArray(),
  bool forceCS = false );

KMIME_EXPORT extern QString decodeRFC2231String( const QByteArray &src );


KMIME_EXPORT extern QByteArray encodeRFC2231String( const QString &src, const QByteArray &charset );

KMIME_EXPORT extern QByteArray uniqueString();

KMIME_EXPORT extern QByteArray multiPartBoundary();

KMIME_EXPORT extern QByteArray unfoldHeader( const QByteArray &header );

KMIME_EXPORT extern QByteArray extractHeader( const QByteArray &src,
                                 const QByteArray &name );

KMIME_EXPORT extern QList<QByteArray> extractHeaders( const QByteArray &src,
                                 const QByteArray &name );

KMIME_EXPORT extern QByteArray CRLFtoLF( const QByteArray &s );

KMIME_EXPORT extern QByteArray CRLFtoLF( const char *s );

KMIME_EXPORT extern QByteArray LFtoCRLF( const QByteArray &s );

//AK_REVIEW: add correctly spelled methods and deprecated the wrongly spelled
// TODO: KDE5: BIC: rename to "removeQuotes"
KMIME_EXPORT extern void removeQuots( QByteArray &str );

//AK_REVIEW: add correctly spelled methods and deprecated the wrongly spelled
// TODO: KDE5: BIC: rename to "removeQuotes"
KMIME_EXPORT extern void removeQuots( QString &str );

KMIME_EXPORT extern void addQuotes( QByteArray &str, bool forceQuotes );

KMIME_EXPORT extern void addQuotes( QString &str, bool forceQuotes );

KMIME_EXPORT QString balanceBidiState( const QString &input );

KMIME_EXPORT QString removeBidiControlChars( const QString &input );

KMIME_EXPORT bool hasAttachment( Content* content );

KMIME_EXPORT bool isSigned( Message* message );

KMIME_EXPORT bool isEncrypted( Message* message );

KMIME_EXPORT bool isInvitation( Content* content );

} // namespace KMime

#endif /* __KMIME_UTIL_H__ */