1 /****************************************************************************
3 ** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
4 ** All rights reserved.
5 ** Contact: Nokia Corporation (qt-info@nokia.com)
7 ** This file is part of the QtGui module of the Qt Toolkit.
9 ** $QT_BEGIN_LICENSE:LGPL$
10 ** GNU Lesser General Public License Usage
11 ** This file may be used under the terms of the GNU Lesser General Public
12 ** License version 2.1 as published by the Free Software Foundation and
13 ** appearing in the file LICENSE.LGPL included in the packaging of this
14 ** file. Please review the following information to ensure the GNU Lesser
15 ** General Public License version 2.1 requirements will be met:
16 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
18 ** In addition, as a special exception, Nokia gives you certain additional
19 ** rights. These rights are described in the Nokia Qt LGPL Exception
20 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
22 ** GNU General Public License Usage
23 ** Alternatively, this file may be used under the terms of the GNU General
24 ** Public License version 3.0 as published by the Free Software Foundation
25 ** and appearing in the file LICENSE.GPL included in the packaging of this
26 ** file. Please review the following information to ensure the GNU General
27 ** Public License version 3.0 requirements will be met:
28 ** http://www.gnu.org/copyleft/gpl.html.
31 ** Alternatively, this file may be used in accordance with the terms and
32 ** conditions contained in a signed written agreement between you and Nokia.
40 ****************************************************************************/
42 #ifndef QTEXTENGINE_P_H
43 #define QTEXTENGINE_P_H
49 // This file is not part of the Qt API. It exists for the convenience
50 // of other Qt classes. This header file may change from version to
51 // version without notice, or even be removed.
56 #include "QtCore/qglobal.h"
57 #include "QtCore/qstring.h"
58 #include "QtCore/qvarlengtharray.h"
59 #include "QtCore/qnamespace.h"
60 #include "QtGui/qtextlayout.h"
61 #include "private/qtextformat_p.h"
62 #include "private/qfont_p.h"
63 #include "QtCore/qvector.h"
64 #include "QtGui/qpaintengine.h"
65 #include "QtGui/qtextobject.h"
66 #include "QtGui/qtextoption.h"
67 #include "QtGui/qtextcursor.h"
68 #include "QtCore/qset.h"
69 #include "QtCore/qdebug.h"
70 #ifndef QT_BUILD_COMPAT_LIB
71 #include "private/qtextdocument_p.h"
73 #include "private/qharfbuzz_p.h"
74 #include "private/qfixed_p.h"
86 class QAbstractTextDocumentLayout;
89 // this uses the same coordinate system as Qt, but a different one to freetype.
90 // * y is usually negative, and is equal to the ascent.
91 // * negative yoff means the following stuff is drawn higher up.
92 // the characters bounding rect is given by QRect(x,y,width,height), its advance by
94 struct glyph_metrics_t
96 inline glyph_metrics_t()
97 : x(100000), y(100000) {}
98 inline glyph_metrics_t(QFixed _x, QFixed _y, QFixed _width, QFixed _height, QFixed _xoff, QFixed _yoff)
113 glyph_metrics_t transformed(const QTransform &xform) const;
114 inline bool isValid() const {return x != 100000 && y != 100000;}
116 Q_DECLARE_TYPEINFO(glyph_metrics_t, Q_PRIMITIVE_TYPE);
118 struct Q_AUTOTEST_EXPORT QScriptAnalysis
125 LineOrParagraphSeparator = 4,
127 SpaceTabOrObject = Space,
132 unsigned short script : 7;
133 unsigned short bidiLevel : 6; // Unicode Bidi algorithm embedding level (0-61)
134 unsigned short flags : 3;
135 inline bool operator == (const QScriptAnalysis &other) const {
136 return script == other.script && bidiLevel == other.bidiLevel && flags == other.flags;
139 Q_DECLARE_TYPEINFO(QScriptAnalysis, Q_PRIMITIVE_TYPE);
141 struct QGlyphJustification
143 inline QGlyphJustification()
144 : type(0), nKashidas(0), space_18d6(0)
147 enum JustificationType {
154 uint nKashidas : 6; // more do not make sense...
155 uint space_18d6 : 24;
157 Q_DECLARE_TYPEINFO(QGlyphJustification, Q_PRIMITIVE_TYPE);
159 struct QGlyphLayoutInstance
164 QGlyphJustification justification;
165 HB_GlyphAttributes attributes;
170 // init to 0 not needed, done when shaping
171 QFixedPoint *offsets; // 8 bytes per element
172 HB_Glyph *glyphs; // 4 bytes per element
173 QFixed *advances_x; // 4 bytes per element
174 QFixed *advances_y; // 4 bytes per element
175 QGlyphJustification *justifications; // 4 bytes per element
176 HB_GlyphAttributes *attributes; // 2 bytes per element
180 inline QGlyphLayout() : numGlyphs(0) {}
182 inline explicit QGlyphLayout(char *address, int totalGlyphs)
184 offsets = reinterpret_cast<QFixedPoint *>(address);
185 int offset = totalGlyphs * sizeof(HB_FixedPoint);
186 glyphs = reinterpret_cast<HB_Glyph *>(address + offset);
187 offset += totalGlyphs * sizeof(HB_Glyph);
188 advances_x = reinterpret_cast<QFixed *>(address + offset);
189 offset += totalGlyphs * sizeof(QFixed);
190 advances_y = reinterpret_cast<QFixed *>(address + offset);
191 offset += totalGlyphs * sizeof(QFixed);
192 justifications = reinterpret_cast<QGlyphJustification *>(address + offset);
193 offset += totalGlyphs * sizeof(QGlyphJustification);
194 attributes = reinterpret_cast<HB_GlyphAttributes *>(address + offset);
195 numGlyphs = totalGlyphs;
198 inline QGlyphLayout mid(int position, int n = -1) const {
199 QGlyphLayout copy = *this;
200 copy.glyphs += position;
201 copy.advances_x += position;
202 copy.advances_y += position;
203 copy.offsets += position;
204 copy.justifications += position;
205 copy.attributes += position;
207 copy.numGlyphs -= position;
213 static inline int spaceNeededForGlyphLayout(int totalGlyphs) {
214 return totalGlyphs * (sizeof(HB_Glyph) + sizeof(HB_GlyphAttributes)
215 + sizeof(QFixed) + sizeof(QFixed) + sizeof(QFixedPoint)
216 + sizeof(QGlyphJustification));
219 inline QFixed effectiveAdvance(int item) const
220 { return (advances_x[item] + QFixed::fromFixed(justifications[item].space_18d6)) * !attributes[item].dontPrint; }
222 inline QGlyphLayoutInstance instance(int position) const {
223 QGlyphLayoutInstance g;
224 g.offset.x = offsets[position].x;
225 g.offset.y = offsets[position].y;
226 g.glyph = glyphs[position];
227 g.advance.x = advances_x[position];
228 g.advance.y = advances_y[position];
229 g.justification = justifications[position];
230 g.attributes = attributes[position];
234 inline void setInstance(int position, const QGlyphLayoutInstance &g) {
235 offsets[position].x = g.offset.x;
236 offsets[position].y = g.offset.y;
237 glyphs[position] = g.glyph;
238 advances_x[position] = g.advance.x;
239 advances_y[position] = g.advance.y;
240 justifications[position] = g.justification;
241 attributes[position] = g.attributes;
244 inline void clear(int first = 0, int last = -1) {
247 if (first == 0 && last == numGlyphs
248 && reinterpret_cast<char *>(offsets + numGlyphs) == reinterpret_cast<char *>(glyphs)) {
249 memset(offsets, 0, spaceNeededForGlyphLayout(numGlyphs));
251 const int num = last - first;
252 memset(offsets + first, 0, num * sizeof(QFixedPoint));
253 memset(glyphs + first, 0, num * sizeof(HB_Glyph));
254 memset(advances_x + first, 0, num * sizeof(QFixed));
255 memset(advances_y + first, 0, num * sizeof(QFixed));
256 memset(justifications + first, 0, num * sizeof(QGlyphJustification));
257 memset(attributes + first, 0, num * sizeof(HB_GlyphAttributes));
261 inline char *data() {
262 return reinterpret_cast<char *>(offsets);
265 void grow(char *address, int totalGlyphs);
268 class QVarLengthGlyphLayoutArray : private QVarLengthArray<void *>, public QGlyphLayout
271 typedef QVarLengthArray<void *> Array;
273 QVarLengthGlyphLayoutArray(int totalGlyphs)
274 : Array(spaceNeededForGlyphLayout(totalGlyphs) / sizeof(void *) + 1)
275 , QGlyphLayout(reinterpret_cast<char *>(Array::data()), totalGlyphs)
277 memset(Array::data(), 0, Array::size() * sizeof(void *));
280 void resize(int totalGlyphs)
282 Array::resize(spaceNeededForGlyphLayout(totalGlyphs) / sizeof(void *) + 1);
284 *((QGlyphLayout *)this) = QGlyphLayout(reinterpret_cast<char *>(Array::data()), totalGlyphs);
285 memset(Array::data(), 0, Array::size() * sizeof(void *));
289 template <int N> struct QGlyphLayoutArray : public QGlyphLayout
293 : QGlyphLayout(reinterpret_cast<char *>(buffer), N)
295 memset(buffer, 0, sizeof(buffer));
299 void *buffer[(N * (sizeof(HB_Glyph) + sizeof(HB_GlyphAttributes)
300 + sizeof(QFixed) + sizeof(QFixed) + sizeof(QFixedPoint)
301 + sizeof(QGlyphJustification)))
302 / sizeof(void *) + 1];
306 /// Internal QTextItem
307 class QTextItemInt : public QTextItem
310 inline QTextItemInt()
311 : justified(false), underlineStyle(QTextCharFormat::NoUnderline), num_chars(0), chars(0),
312 logClusters(0), f(0), fontEngine(0)
314 QTextItemInt(const QScriptItem &si, QFont *font, const QTextCharFormat &format = QTextCharFormat());
315 QTextItemInt(const QGlyphLayout &g, QFont *font, const QChar *chars, int numChars, QFontEngine *fe);
317 /// copy the structure items, adjusting the glyphs arrays to the right subarrays.
318 /// the width of the returned QTextItemInt is not adjusted, for speed reasons
319 QTextItemInt midItem(QFontEngine *fontEngine, int firstGlyphIndex, int numGlyphs) const;
327 QTextCharFormat::UnderlineStyle underlineStyle;
328 const QTextCharFormat charFormat;
331 const unsigned short *logClusters;
335 QFontEngine *fontEngine;
338 inline bool qIsControlChar(ushort uc)
340 return uc >= 0x200b && uc <= 0x206f
341 && (uc <= 0x200f /* ZW Space, ZWNJ, ZWJ, LRM and RLM */
342 || (uc >= 0x2028 && uc <= 0x202f /* LS, PS, LRE, RLE, PDF, LRO, RLO, NNBSP */)
343 || uc >= 0x206a /* ISS, ASS, IAFS, AFS, NADS, NODS */);
346 struct Q_AUTOTEST_EXPORT QScriptItem
350 num_glyphs(0), descent(-1), ascent(-1), leading(-1), width(-1),
351 glyph_data_offset(0) {}
352 inline QScriptItem(int p, const QScriptAnalysis &a)
353 : position(p), analysis(a),
354 num_glyphs(0), descent(-1), ascent(-1), leading(-1), width(-1),
355 glyph_data_offset(0) {}
358 QScriptAnalysis analysis;
359 unsigned short num_glyphs;
364 int glyph_data_offset;
365 QFixed height() const { return ascent + descent + 1; }
369 Q_DECLARE_TYPEINFO(QScriptItem, Q_MOVABLE_TYPE);
371 typedef QVector<QScriptItem> QScriptItemArray;
373 struct Q_AUTOTEST_EXPORT QScriptLine
375 // created and filled in QTextLine::layout_helper
377 : from(0), length(0),
378 justified(0), gridfitted(0),
379 hasTrailingSpaces(0), leadingIncluded(0) {}
389 signed int length : 28;
390 mutable uint justified : 1;
391 mutable uint gridfitted : 1;
392 uint hasTrailingSpaces : 1;
393 uint leadingIncluded : 1;
394 QFixed height() const { return (ascent + descent).ceil() + 1
395 + (leadingIncluded? qMax(QFixed(),leading) : QFixed()); }
396 QFixed base() const { return ascent
397 + (leadingIncluded ? qMax(QFixed(),leading) : QFixed()); }
398 void setDefaultHeight(QTextEngine *eng);
399 void operator+=(const QScriptLine &other);
401 Q_DECLARE_TYPEINFO(QScriptLine, Q_PRIMITIVE_TYPE);
404 inline void QScriptLine::operator+=(const QScriptLine &other)
406 leading= qMax(leading + ascent, other.leading + other.ascent) - qMax(ascent, other.ascent);
407 descent = qMax(descent, other.descent);
408 ascent = qMax(ascent, other.ascent);
409 textWidth += other.textWidth;
410 length += other.length;
413 typedef QVector<QScriptLine> QScriptLineArray;
416 class QTextFormatCollection;
418 class Q_GUI_EXPORT QTextEngine {
426 LayoutData(const QString &str, void **stack_memory, int mem_size);
429 mutable QScriptItemArray items;
431 int available_glyphs;
433 unsigned short *logClustersPtr;
434 QGlyphLayout glyphLayout;
437 uint layoutState : 2;
438 uint memory_on_stack : 1;
439 uint haveCharAttributes : 1;
441 bool reallocate(int totalGlyphs);
444 QTextEngine(LayoutData *data);
446 QTextEngine(const QString &str, const QFont &f);
453 // keep in sync with QAbstractFontEngine::TextShapingFlag!!
455 RightToLeft = 0x0001,
456 DesignMetrics = 0x0002,
457 GlyphIndicesOnly = 0x0004
459 Q_DECLARE_FLAGS(ShaperFlags, ShaperFlag)
462 void clearLineData();
464 void validate() const;
465 void itemize() const;
467 bool isRightToLeft() const;
468 static void bidiReorder(int numRuns, const quint8 *levels, int *visualOrder);
470 const HB_CharAttributes *attributes() const;
472 void shape(int item) const;
474 void justify(const QScriptLine &si);
475 QFixed alignLine(const QScriptLine &line);
477 QFixed width(int charFrom, int numChars) const;
478 glyph_metrics_t boundingBox(int from, int len) const;
479 glyph_metrics_t tightBoundingBox(int from, int len) const;
481 int length(int item) const {
482 const QScriptItem &si = layoutData->items[item];
483 int from = si.position;
485 return (item < layoutData->items.size() ? layoutData->items[item].position : layoutData->string.length()) - from;
487 int length(const QScriptItem *si) const {
489 if (si + 1 < layoutData->items.constData()+ layoutData->items.size())
490 end = (si+1)->position;
492 end = layoutData->string.length();
493 return end - si->position;
496 QFontEngine *fontEngine(const QScriptItem &si, QFixed *ascent = 0, QFixed *descent = 0, QFixed *leading = 0) const;
497 QFont font(const QScriptItem &si) const;
498 inline QFont font() const { return fnt; }
501 * Returns a pointer to an array of log clusters, offset at the script item.
502 * Each item in the array is a unsigned short. For each character in the original string there is an entry in the table
503 * so there is a one to one correlation in indexes between the original text and the index in the logcluster.
504 * The value of each item is the position in the glyphs array. Multiple similar pointers in the logclusters array imply
505 * that one glyph is used for more than one character.
508 inline unsigned short *logClusters(const QScriptItem *si) const
509 { return layoutData->logClustersPtr+si->position; }
511 * Returns an array of QGlyphLayout items, offset at the script item.
512 * Each item in the array matches one glyph in the text, storing the advance, position etc.
513 * The returned item's length equals to the number of available glyphs. This may be more
514 * than what was actually shaped.
517 inline QGlyphLayout availableGlyphs(const QScriptItem *si) const {
518 return layoutData->glyphLayout.mid(si->glyph_data_offset);
521 * Returns an array of QGlyphLayout items, offset at the script item.
522 * Each item in the array matches one glyph in the text, storing the advance, position etc.
523 * The returned item's length equals to the number of shaped glyphs.
526 inline QGlyphLayout shapedGlyphs(const QScriptItem *si) const {
527 return layoutData->glyphLayout.mid(si->glyph_data_offset, si->num_glyphs);
530 inline bool ensureSpace(int nGlyphs) const {
531 if (layoutData->glyphLayout.numGlyphs - layoutData->used < nGlyphs)
532 return layoutData->reallocate((((layoutData->used + nGlyphs)*3/2 + 15) >> 4) << 4);
538 int findItem(int strPos) const;
539 inline QTextFormatCollection *formats() const {
540 #ifdef QT_BUILD_COMPAT_LIB
541 return 0; // Compat should never reference this symbol
543 return block.docHandle()->formatCollection();
546 QTextCharFormat format(const QScriptItem *si) const;
547 inline QAbstractTextDocumentLayout *docLayout() const {
548 #ifdef QT_BUILD_COMPAT_LIB
549 return 0; // Compat should never reference this symbol
551 return block.docHandle()->document()->documentLayout();
554 int formatIndex(const QScriptItem *si) const;
556 /// returns the width of tab at index (in the tabs array) with the tab-start at position x
557 QFixed calculateTabWidth(int index, QFixed x) const;
559 mutable QScriptLineArray lines;
561 struct FontEngineCache {
563 mutable QFontEngine *prevFontEngine;
564 mutable QFontEngine *prevScaledFontEngine;
565 mutable int prevScript;
566 mutable int prevPosition;
567 mutable int prevLength;
568 inline void reset() {
570 prevScaledFontEngine = 0;
576 mutable FontEngineCache feCache;
588 uint cacheGlyphs : 1;
589 uint stackEngine : 1;
590 uint forceJustification : 1;
591 uint visualMovement : 1;
593 int *underlinePositions;
595 mutable LayoutData *layoutData;
597 inline bool hasFormats() const { return (block.docHandle() || specialData); }
598 inline bool visualCursorMovement() const
600 return (visualMovement ||
601 (block.docHandle() ? block.docHandle()->defaultCursorMoveStyle == Qt::VisualMoveStyle : false));
607 QList<QTextLayout::FormatRange> addFormats;
608 QVector<int> addFormatIndices;
609 QVector<int> resolvedFormatIndices;
611 SpecialData *specialData;
613 bool atWordSeparator(int position) const;
614 bool atSpace(int position) const;
615 void indexAdditionalFormats();
617 QString elidedText(Qt::TextElideMode mode, const QFixed &width, int flags = 0) const;
619 void shapeLine(const QScriptLine &line);
620 QFixed leadingSpaceWidth(const QScriptLine &line);
622 QFixed offsetInLigature(const QScriptItem *si, int pos, int max, int glyph_pos);
623 int positionInLigature(const QScriptItem *si, int end, QFixed x, QFixed edge, int glyph_pos, bool cursorOnCharacter);
624 int previousLogicalPosition(int oldPos) const;
625 int nextLogicalPosition(int oldPos) const;
626 int lineNumberForTextPosition(int pos);
627 int positionAfterVisualMovement(int oldPos, QTextCursor::MoveOperation op);
628 void insertionPointsForLine(int lineNum, QVector<int> &insertionPoints);
631 void setBoundary(int strPos) const;
632 void addRequiredBoundaries() const;
633 void shapeText(int item) const;
634 void shapeTextWithHarfbuzz(int item) const;
635 #if defined(Q_WS_WINCE)
636 void shapeTextWithCE(int item) const;
638 #if defined(Q_WS_MAC)
639 void shapeTextMac(int item) const;
641 void splitItem(int item, int pos) const;
643 void resolveAdditionalFormats() const;
644 int endOfLine(int lineNum);
645 int beginningOfLine(int lineNum);
646 int getClusterLength(unsigned short *logClusters, const HB_CharAttributes *attributes, int from, int to, int glyph_pos, int *start);
649 class QStackTextEngine : public QTextEngine {
651 enum { MemSize = 256*40/sizeof(void *) };
652 QStackTextEngine(const QString &string, const QFont &f);
653 LayoutData _layoutData;
654 void *_memory[MemSize];
657 struct QTextLineItemIterator
659 QTextLineItemIterator(QTextEngine *eng, int lineNum, const QPointF &pos = QPointF(),
660 const QTextLayout::FormatRange *_selection = 0);
662 inline bool atEnd() const { return logicalItem >= nItems - 1; }
663 inline bool atBeginning() const { return logicalItem <= 0; }
666 bool getSelectionBounds(QFixed *selectionX, QFixed *selectionWidth) const;
667 inline bool isOutsideSelection() const {
669 return !getSelectionBounds(&tmp1, &tmp2);
676 const QScriptLine &line;
695 QVarLengthArray<int> visualOrder;
696 QVarLengthArray<uchar> levels;
698 const QTextLayout::FormatRange *selection;
701 Q_DECLARE_OPERATORS_FOR_FLAGS(QTextEngine::ShaperFlags)
705 #endif // QTEXTENGINE_P_H