/****************************************************************************
**
** Copyright (C) 1992-2007 Trolltech ASA. All rights reserved.
**
** This file is part of the QtCore module of the Qt Toolkit.
**
** This file may be used under the terms of the GNU General Public
** License version 2.0 as published by the Free Software Foundation
** and appearing in the file LICENSE.GPL included in the packaging of
** this file.  Please review the following information to ensure GNU
** General Public Licensing requirements will be met:
** http://www.trolltech.com/products/qt/opensource.html
**
** If you are unsure which license is appropriate for your use, please
** review the following information:
** http://www.trolltech.com/products/qt/licensing.html or contact the
** sales department at sales@trolltech.com.
**
** This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
** WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
**
****************************************************************************/

#ifndef QUNICODETABLES_P_H
#define QUNICODETABLES_P_H

//
//  W A R N I N G
//  -------------
//
// This file is not part of the Qt API.  It exists for the convenience
// of internal files.  This header file may change from version to version
// without notice, or even be removed.
//
// We mean it.
//

#include "QtCore/qstring.h"

namespace QUnicodeTables {
    struct Properties {
        uint category : 5;
        uint line_break_class : 5;
        uint direction : 5;
        uint titleCaseDiffersFromUpper : 1;
        uint combiningClass :8;
        uint unicode_version : 4;
        uint digit_value : 4;
        
        signed short mirrorDiff : 14 /* 13 needed */;
        uint joining : 2;
        signed short caseDiff /* 14 needed */;
    };
    Q_CORE_EXPORT const Properties * QT_FASTCALL properties(uint ucs4);

    // see http://www.unicode.org/reports/tr14/tr14-13.html
    // we don't use the XX and AI properties and map them to AL instead.
    enum LineBreakClass {
        LineBreak_OP, LineBreak_CL, LineBreak_QU, LineBreak_GL, LineBreak_NS,
        LineBreak_EX, LineBreak_SY, LineBreak_IS, LineBreak_PR, LineBreak_PO,
        LineBreak_NU, LineBreak_AL, LineBreak_ID, LineBreak_IN, LineBreak_HY,
        LineBreak_BA, LineBreak_BB, LineBreak_B2, LineBreak_ZW, LineBreak_CM,
        LineBreak_SA, LineBreak_BK, LineBreak_CR, LineBreak_LF, LineBreak_SG,
        LineBreak_CB, LineBreak_SP
    };

    inline uint surrogateToUcs4(ushort high, ushort low) {
        return (high<<10) + low - 0x35fdc00;
    }
    inline ushort highSurrogate(uint ucs4) {
        return (ucs4>>10) + 0xd7c0;
    }
    inline ushort lowSurrogate(uint ucs4) {
        return ucs4%0x400 + 0xdc00;
    }
    inline bool isHighSurrogate(uint utf16) {
        return (utf16 >= 0xd800 && utf16 < 0xdc00);
    }
    inline bool isLowSurrogate(uint utf16) {
        return (utf16 >= 0xdc00 && utf16 < 0xe000);
    }

    Q_CORE_EXPORT QChar::Category  QT_FASTCALL category(uint ucs4);
    inline QChar::Category category(const QChar &c) {
        return category(c.unicode());
    }

    Q_CORE_EXPORT unsigned char  QT_FASTCALL combiningClass(uint ucs4);
    inline unsigned char combiningClass(const QChar &ch) {
        return QUnicodeTables::combiningClass(ch.unicode());
    }
    Q_CORE_EXPORT QChar::Direction QT_FASTCALL direction(uint ucs4);
    inline QChar::Direction direction(const QChar &c) {
        return QUnicodeTables::direction(c.unicode());
    }

    Q_CORE_EXPORT LineBreakClass QT_FASTCALL lineBreakClass(uint ucs4);
    inline int lineBreakClass(const QChar &ch) {
        return QUnicodeTables::lineBreakClass(ch.unicode());
    }

    Q_CORE_EXPORT int QT_FASTCALL script(uint ucs4);
    Q_CORE_EXPORT_INLINE int QT_FASTCALL script(const QChar &ch) {
        return script(ch.unicode());
    }

    Q_CORE_EXPORT QChar::UnicodeVersion QT_FASTCALL unicodeVersion(uint ucs4);
    Q_CORE_EXPORT QChar::Joining QT_FASTCALL joining(uint ucs4);
    inline QChar::Joining joining(const QChar &c) {
        return QUnicodeTables::joining(c.unicode());
    }

    Q_CORE_EXPORT bool QT_FASTCALL mirrored(uint ucs4);
    inline bool mirrored(const QChar &c) {
        return QUnicodeTables::mirrored(c.unicode());
    }
    Q_CORE_EXPORT int QT_FASTCALL mirroredChar(uint ucs4);
    inline QChar mirroredChar(const QChar &c) {
        return QUnicodeTables::mirroredChar(c.unicode());
    }
    Q_CORE_EXPORT int QT_FASTCALL upper(uint ucs4);
    inline QChar upper(const QChar &c) {
        return QChar(QUnicodeTables::upper(c.unicode()));
    }

    Q_CORE_EXPORT int QT_FASTCALL lower(uint ucs4);
    inline QChar lower(const QChar &c) {
        return QChar(QUnicodeTables::lower(c.unicode()));
    }


    inline bool isMark(const QChar &ch) {
        QChar::Category c = QUnicodeTables::category(ch.unicode());
        return c >= QChar::Mark_NonSpacing && c <= QChar::Mark_Enclosing;
    }
    inline bool isSpace(const QChar &ch) {
        if(ch.unicode() >= 9 && ch.unicode() <=13) return true;
        QChar::Category c = QUnicodeTables::category(ch.unicode());
        return c >= QChar::Separator_Space && c <= QChar::Separator_Paragraph;
    }


    Q_CORE_EXPORT int QT_FASTCALL digitValue(uint ucs4);
    Q_CORE_EXPORT QString QT_FASTCALL decomposition(uint ucs4);
    Q_CORE_EXPORT QChar::Decomposition QT_FASTCALL decompositionTag(uint ucs4);
    Q_CORE_EXPORT ushort QT_FASTCALL ligature(ushort u1, ushort u2);

    Q_CORE_EXPORT QString normalize(const QString &str, QString::NormalizationForm mode);
    Q_CORE_EXPORT QString normalize(const QString &str, QString::NormalizationForm mode, QChar::UnicodeVersion version);

#include "qunicodedata_p.h"

}







#endif // QUNICODETABLES_P_H
