source: trunk/src/gui/text/qtextdocument_p.h@ 1035

Last change on this file since 1035 was 846, checked in by Dmitry A. Kuminov, 15 years ago

trunk: Merged in qt 4.7.2 sources from branches/vendor/nokia/qt.
File size: 13.8 KB
Line 
1/****************************************************************************
2**
3** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
4** All rights reserved.
5** Contact: Nokia Corporation ([email protected])
6**
7** This file is part of the QtGui module of the Qt Toolkit.
8**
9** $QT_BEGIN_LICENSE:LGPL$
10** Commercial Usage
11** Licensees holding valid Qt Commercial licenses may use this file in
12** accordance with the Qt Commercial License Agreement provided with the
13** Software or, alternatively, in accordance with the terms contained in
14** a written agreement between you and Nokia.
15**
16** GNU Lesser General Public License Usage
17** Alternatively, this file may be used under the terms of the GNU Lesser
18** General Public License version 2.1 as published by the Free Software
19** Foundation and appearing in the file LICENSE.LGPL included in the
20** packaging of this file. Please review the following information to
21** ensure the GNU Lesser General Public License version 2.1 requirements
22** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
23**
24** In addition, as a special exception, Nokia gives you certain additional
25** rights. These rights are described in the Nokia Qt LGPL Exception
26** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
27**
28** GNU General Public License Usage
29** Alternatively, this file may be used under the terms of the GNU
30** General Public License version 3.0 as published by the Free Software
31** Foundation and appearing in the file LICENSE.GPL included in the
32** packaging of this file. Please review the following information to
33** ensure the GNU General Public License version 3.0 requirements will be
34** met: http://www.gnu.org/copyleft/gpl.html.
35**
36** If you have questions regarding the use of this file, please contact
37** Nokia at [email protected].
38** $QT_END_LICENSE$
39**
40****************************************************************************/
41
42#ifndef QTEXTDOCUMENT_P_H
43#define QTEXTDOCUMENT_P_H
44
45//
46// W A R N I N G
47// -------------
48//
49// This file is not part of the Qt API. It exists purely as an
50// implementation detail. This header file may change from version to
51// version without notice, or even be removed.
52//
53// We mean it.
54//
55
56#include "QtCore/qglobal.h"
57#include "QtCore/qstring.h"
58#include "QtCore/qvector.h"
59#include "QtCore/qlist.h"
60#include "private/qobject_p.h"
61#include "private/qfragmentmap_p.h"
62#include "QtGui/qtextlayout.h"
63#include "QtGui/qtextoption.h"
64#include "private/qtextformat_p.h"
65#include "QtGui/qtextdocument.h"
66#include "QtGui/qtextobject.h"
67#include "QtCore/qmap.h"
68#include "QtCore/qvariant.h"
69#include "QtCore/qurl.h"
70#include "private/qcssparser_p.h"
71
72// #define QT_QMAP_DEBUG
73
74#ifdef QT_QMAP_DEBUG
75#include <iostream>
76#endif
77
78QT_BEGIN_NAMESPACE
79
80class QTextFormatCollection;
81class QTextFormat;
82class QTextBlockFormat;
83class QTextCursorPrivate;
84class QAbstractTextDocumentLayout;
85class QTextDocument;
86class QTextFrame;
87
88#define QTextBeginningOfFrame QChar(0xfdd0)
89#define QTextEndOfFrame QChar(0xfdd1)
90
91class QTextFragmentData : public QFragment<>
92{
93public:
94 inline void initialize() {}
95 inline void invalidate() const {}
96 inline void free() {}
97 int stringPosition;
98 int format;
99};
100
101class QTextBlockData : public QFragment<3>
102{
103public:
104 inline void initialize()
105 { layout = 0; userData = 0; userState = -1; revision = 0; hidden = 0; }
106 void invalidate() const;
107 inline void free()
108 { delete layout; layout = 0; delete userData; userData = 0; }
109
110 mutable int format;
111 // ##### probably store a QTextEngine * here!
112 mutable QTextLayout *layout;
113 mutable QTextBlockUserData *userData;
114 mutable int userState;
115 mutable int revision : 31;
116 mutable uint hidden : 1;
117};
118
119
120class QAbstractUndoItem;
121
122class QTextUndoCommand
123{
124public:
125 enum Command {
126 Inserted = 0,
127 Removed = 1,
128 CharFormatChanged = 2,
129 BlockFormatChanged = 3,
130 BlockInserted = 4,
131 BlockRemoved = 5,
132 BlockAdded = 6,
133 BlockDeleted = 7,
134 GroupFormatChange = 8,
135 CursorMoved = 9,
136 Custom = 256
137 };
138 enum Operation {
139 KeepCursor = 0,
140 MoveCursor = 1
141 };
142 quint16 command;
143 uint block_part : 1; // all commands that are part of an undo block (including the first and the last one) have this set to 1
144 uint block_end : 1; // the last command in an undo block has this set to 1.
145 uint block_padding : 6; // padding since block used to be a quint8
146 quint8 operation;
147 int format;
148 quint32 strPos;
149 quint32 pos;
150 union {
151 int blockFormat;
152 quint32 length;
153 QAbstractUndoItem *custom;
154 int objectIndex;
155 };
156 quint32 revision;
157
158 bool tryMerge(const QTextUndoCommand &other);
159};
160Q_DECLARE_TYPEINFO(QTextUndoCommand, Q_PRIMITIVE_TYPE);
161
162class Q_AUTOTEST_EXPORT QTextDocumentPrivate : public QObjectPrivate
163{
164 Q_DECLARE_PUBLIC(QTextDocument)
165public:
166 typedef QFragmentMap<QTextFragmentData> FragmentMap;
167 typedef FragmentMap::ConstIterator FragmentIterator;
168 typedef QFragmentMap<QTextBlockData> BlockMap;
169
170 QTextDocumentPrivate();
171 ~QTextDocumentPrivate();
172
173 void init();
174 void clear();
175
176 void setLayout(QAbstractTextDocumentLayout *layout);
177
178 void insert(int pos, const QString &text, int format);
179 void insert(int pos, int strPos, int strLength, int format);
180 int insertBlock(int pos, int blockFormat, int charFormat, QTextUndoCommand::Operation = QTextUndoCommand::MoveCursor);
181 int insertBlock(const QChar &blockSeparator, int pos, int blockFormat, int charFormat,
182 QTextUndoCommand::Operation op = QTextUndoCommand::MoveCursor);
183
184 void move(int from, int to, int length, QTextUndoCommand::Operation = QTextUndoCommand::MoveCursor);
185 void remove(int pos, int length, QTextUndoCommand::Operation = QTextUndoCommand::MoveCursor);
186
187 void aboutToRemoveCell(int cursorFrom, int cursorEnd);
188
189 QTextFrame *insertFrame(int start, int end, const QTextFrameFormat &format);
190 void removeFrame(QTextFrame *frame);
191
192 enum FormatChangeMode { MergeFormat, SetFormat, SetFormatAndPreserveObjectIndices };
193
194 void setCharFormat(int pos, int length, const QTextCharFormat &newFormat, FormatChangeMode mode = SetFormat);
195 void setBlockFormat(const QTextBlock &from, const QTextBlock &to,
196 const QTextBlockFormat &newFormat, FormatChangeMode mode = SetFormat);
197
198 void emitUndoAvailable(bool available);
199 void emitRedoAvailable(bool available);
200
201 int undoRedo(bool undo);
202 inline void undo() { undoRedo(true); }
203 inline void redo() { undoRedo(false); }
204 void appendUndoItem(QAbstractUndoItem *);
205 inline void beginEditBlock() { if (0 == editBlock++) ++revision; }
206 void joinPreviousEditBlock();
207 void endEditBlock();
208 void finishEdit();
209 inline bool isInEditBlock() const { return editBlock; }
210 void enableUndoRedo(bool enable);
211 inline bool isUndoRedoEnabled() const { return undoEnabled; }
212
213 inline bool isUndoAvailable() const { return undoEnabled && undoState > 0; }
214 inline bool isRedoAvailable() const { return undoEnabled && undoState < undoStack.size(); }
215
216 inline int availableUndoSteps() const { return undoEnabled ? undoState : 0; }
217 inline int availableRedoSteps() const { return undoEnabled ? qMax(undoStack.size() - undoState - 1, 0) : 0; }
218
219 inline QString buffer() const { return text; }
220 QString plainText() const;
221 inline int length() const { return fragments.length(); }
222
223 inline QTextFormatCollection *formatCollection() { return &formats; }
224 inline const QTextFormatCollection *formatCollection() const { return &formats; }
225 inline QAbstractTextDocumentLayout *layout() const { return lout; }
226
227 inline FragmentIterator find(int pos) const { return fragments.find(pos); }
228 inline FragmentIterator begin() const { return fragments.begin(); }
229 inline FragmentIterator end() const { return fragments.end(); }
230
231 inline QTextBlock blocksBegin() const { return QTextBlock(const_cast<QTextDocumentPrivate *>(this), blocks.firstNode()); }
232 inline QTextBlock blocksEnd() const { return QTextBlock(const_cast<QTextDocumentPrivate *>(this), 0); }
233 inline QTextBlock blocksFind(int pos) const { return QTextBlock(const_cast<QTextDocumentPrivate *>(this), blocks.findNode(pos)); }
234 int blockCharFormatIndex(int node) const;
235
236 inline int numBlocks() const { return blocks.numNodes(); }
237
238 const BlockMap &blockMap() const { return blocks; }
239 const FragmentMap &fragmentMap() const { return fragments; }
240 BlockMap &blockMap() { return blocks; }
241 FragmentMap &fragmentMap() { return fragments; }
242
243 static const QTextBlockData *block(const QTextBlock &it) { return it.p->blocks.fragment(it.n); }
244
245 int nextCursorPosition(int position, QTextLayout::CursorMode mode) const;
246 int previousCursorPosition(int position, QTextLayout::CursorMode mode) const;
247
248 void changeObjectFormat(QTextObject *group, int format);
249
250 void setModified(bool m);
251 inline bool isModified() const { return modified; }
252
253 inline QFont defaultFont() const { return formats.defaultFont(); }
254 inline void setDefaultFont(const QFont &f) { formats.setDefaultFont(f); }
255
256 void clearUndoRedoStacks(QTextDocument::Stacks stacksToClear, bool emitSignals = false);
257
258private:
259 bool split(int pos);
260 bool unite(uint f);
261
262 void insert_string(int pos, uint strPos, uint length, int format, QTextUndoCommand::Operation op);
263 int insert_block(int pos, uint strPos, int format, int blockformat, QTextUndoCommand::Operation op, int command);
264 int remove_string(int pos, uint length, QTextUndoCommand::Operation op);
265 int remove_block(int pos, int *blockformat, int command, QTextUndoCommand::Operation op);
266
267 void insert_frame(QTextFrame *f);
268 void scan_frames(int pos, int charsRemoved, int charsAdded);
269 static void clearFrame(QTextFrame *f);
270
271 void adjustDocumentChangesAndCursors(int from, int addedOrRemoved, QTextUndoCommand::Operation op);
272
273 bool wasUndoAvailable;
274 bool wasRedoAvailable;
275
276public:
277 void documentChange(int from, int length);
278
279 inline void addCursor(QTextCursorPrivate *c) { cursors.append(c); }
280 inline void removeCursor(QTextCursorPrivate *c) { cursors.removeAll(c); }
281
282 QTextFrame *frameAt(int pos) const;
283 QTextFrame *rootFrame() const;
284
285 QTextObject *objectForIndex(int objectIndex) const;
286 QTextObject *objectForFormat(int formatIndex) const;
287 QTextObject *objectForFormat(const QTextFormat &f) const;
288
289 QTextObject *createObject(const QTextFormat &newFormat, int objectIndex = -1);
290 void deleteObject(QTextObject *object);
291
292 QTextDocument *document() { return q_func(); }
293 const QTextDocument *document() const { return q_func(); }
294
295 bool ensureMaximumBlockCount();
296
297private:
298 QTextDocumentPrivate(const QTextDocumentPrivate& m);
299 QTextDocumentPrivate& operator= (const QTextDocumentPrivate& m);
300
301 void appendUndoItem(const QTextUndoCommand &c);
302
303 void contentsChanged();
304
305 void compressPieceTable();
306
307 QString text;
308 uint unreachableCharacterCount;
309
310 QVector<QTextUndoCommand> undoStack;
311 bool undoEnabled;
312 int undoState;
313 int revision;
314 // position in undo stack of the last setModified(false) call
315 int modifiedState;
316 bool modified;
317
318 int editBlock;
319 int editBlockCursorPosition;
320 int docChangeFrom;
321 int docChangeOldLength;
322 int docChangeLength;
323 bool framesDirty;
324
325 QTextFormatCollection formats;
326 mutable QTextFrame *rtFrame;
327 QAbstractTextDocumentLayout *lout;
328 FragmentMap fragments;
329 BlockMap blocks;
330 int initialBlockCharFormatIndex;
331
332 QList<QTextCursorPrivate *> cursors;
333 QMap<int, QTextObject *> objects;
334 QMap<QUrl, QVariant> resources;
335 QMap<QUrl, QVariant> cachedResources;
336 QString defaultStyleSheet;
337
338 int lastBlockCount;
339
340public:
341 QTextOption defaultTextOption;
342#ifndef QT_NO_CSSPARSER
343 QCss::StyleSheet parsedDefaultStyleSheet;
344#endif
345 int maximumBlockCount;
346 uint needsEnsureMaximumBlockCount : 1;
347 uint inContentsChange : 1;
348 uint blockCursorAdjustment : 1;
349 QSizeF pageSize;
350 QString title;
351 QString url;
352 qreal indentWidth;
353 qreal documentMargin;
354
355 void mergeCachedResources(const QTextDocumentPrivate *priv);
356
357 friend class QTextHtmlExporter;
358 friend class QTextCursor;
359};
360
361class QTextTable;
362class QTextHtmlExporter
363{
364public:
365 QTextHtmlExporter(const QTextDocument *_doc);
366
367 enum ExportMode {
368 ExportEntireDocument,
369 ExportFragment
370 };
371
372 QString toHtml(const QByteArray &encoding, ExportMode mode = ExportEntireDocument);
373
374private:
375 enum StyleMode { EmitStyleTag, OmitStyleTag };
376 enum FrameType { TextFrame, TableFrame, RootFrame };
377
378 void emitFrame(QTextFrame::Iterator frameIt);
379 void emitTextFrame(const QTextFrame *frame);
380 void emitBlock(const QTextBlock &block);
381 void emitTable(const QTextTable *table);
382 void emitFragment(const QTextFragment &fragment);
383
384 void emitBlockAttributes(const QTextBlock &block);
385 bool emitCharFormatStyle(const QTextCharFormat &format);
386 void emitTextLength(const char *attribute, const QTextLength &length);
387 void emitAlignment(Qt::Alignment alignment);
388 void emitFloatStyle(QTextFrameFormat::Position pos, StyleMode mode = EmitStyleTag);
389 void emitMargins(const QString &top, const QString &bottom, const QString &left, const QString &right);
390 void emitAttribute(const char *attribute, const QString &value);
391 void emitFrameStyle(const QTextFrameFormat &format, FrameType frameType);
392 void emitBorderStyle(QTextFrameFormat::BorderStyle style);
393 void emitPageBreakPolicy(QTextFormat::PageBreakFlags policy);
394
395 void emitFontFamily(const QString &family);
396
397 void emitBackgroundAttribute(const QTextFormat &format);
398 QString findUrlForImage(const QTextDocument *doc, qint64 cacheKey, bool isPixmap);
399
400 QString html;
401 QTextCharFormat defaultCharFormat;
402 const QTextDocument *doc;
403 bool fragmentMarkers;
404};
405
406QT_END_NAMESPACE
407
408#endif // QTEXTDOCUMENT_P_H
Note: See TracBrowser for help on using the repository browser.