1 /****************************************************************************
2 **
3 ** Copyright (C) 2016 The Qt Company Ltd.
4 ** Contact: https://www.qt.io/licensing/
5 **
6 ** This file is part of the QtCore module of the Qt Toolkit.
7 **
8 ** $QT_BEGIN_LICENSE:LGPL$
9 ** Commercial License Usage
10 ** Licensees holding valid commercial Qt licenses may use this file in
11 ** accordance with the commercial license agreement provided with the
12 ** Software or, alternatively, in accordance with the terms contained in
13 ** a written agreement between you and The Qt Company. For licensing terms
14 ** and conditions see https://www.qt.io/terms-conditions. For further
15 ** information use the contact form at https://www.qt.io/contact-us.
16 **
17 ** GNU Lesser General Public License Usage
18 ** Alternatively, this file may be used under the terms of the GNU Lesser
19 ** General Public License version 3 as published by the Free Software
20 ** Foundation and appearing in the file LICENSE.LGPL3 included in the
21 ** packaging of this file. Please review the following information to
22 ** ensure the GNU Lesser General Public License version 3 requirements
23 ** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24 **
25 ** GNU General Public License Usage
26 ** Alternatively, this file may be used under the terms of the GNU
27 ** General Public License version 2.0 or (at your option) the GNU General
28 ** Public license version 3 or any later version approved by the KDE Free
29 ** Qt Foundation. The licenses are as published by the Free Software
30 ** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31 ** included in the packaging of this file. Please review the following
32 ** information to ensure the GNU General Public License requirements will
33 ** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34 ** https://www.gnu.org/licenses/gpl-3.0.html.
35 **
36 ** $QT_END_LICENSE$
37 **
38 ****************************************************************************/
39 
40 #ifndef QUNICODETOOLS_P_H
41 #define QUNICODETOOLS_P_H
42 
43 //
44 //  W A R N I N G
45 //  -------------
46 //
47 // This file is not part of the Qt API.  It exists for the convenience
48 // of other Qt classes.  This header file may change from version to
49 // version without notice, or even be removed.
50 //
51 // We mean it.
52 //
53 
54 #include <QtCore/private/qglobal_p.h>
55 #include <QtCore/qchar.h>
56 
57 QT_BEGIN_NAMESPACE
58 
59 struct QCharAttributes
60 {
61     uchar graphemeBoundary : 1;
62     uchar wordBreak        : 1;
63     uchar sentenceBoundary : 1;
64     uchar lineBreak        : 1;
65     uchar whiteSpace       : 1;
66     uchar wordStart        : 1;
67     uchar wordEnd          : 1;
68     uchar mandatoryBreak   : 1;
69 };
70 Q_DECLARE_TYPEINFO(QCharAttributes, Q_PRIMITIVE_TYPE);
71 
72 namespace QUnicodeTools {
73 
74 // ### temporary
75 struct ScriptItem
76 {
77     int position;
78     int script;
79 };
80 
81 } // namespace QUnicodeTools
82 Q_DECLARE_TYPEINFO(QUnicodeTools::ScriptItem, Q_PRIMITIVE_TYPE);
83 namespace QUnicodeTools {
84 
85 enum CharAttributeOption {
86     GraphemeBreaks = 0x01,
87     WordBreaks = 0x02,
88     SentenceBreaks = 0x04,
89     LineBreaks = 0x08,
90     WhiteSpaces = 0x10,
91     HangulLineBreakTailoring = 0x20,
92     DefaultOptionsCompat = GraphemeBreaks | LineBreaks | WhiteSpaces, // ### remove
93 
94     DontClearAttributes = 0x1000
95 };
96 Q_DECLARE_FLAGS(CharAttributeOptions, CharAttributeOption)
97 
98 // attributes buffer has to have a length of string length + 1
99 Q_CORE_EXPORT void initCharAttributes(const ushort *string, int length,
100                                       const ScriptItem *items, int numItems,
101                                       QCharAttributes *attributes, CharAttributeOptions options = DefaultOptionsCompat);
102 
103 
104 Q_CORE_EXPORT void initScripts(const ushort *string, int length, uchar *scripts);
105 
106 } // namespace QUnicodeTools
107 
108 QT_END_NAMESPACE
109 
110 #endif // QUNICODETOOLS_P_H
111