1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
|
// Copyright (C) 2016 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0
#pragma once
#include "texteditor_global.h"
#include "blockrange.h"
#include "formatter.h"
#include "indenter.h"
#include <coreplugin/textdocument.h>
#include <utils/id.h>
#include <utils/link.h>
#include <utils/multitextcursor.h>
#include <QList>
#include <QMap>
#include <QSharedPointer>
#include <functional>
QT_BEGIN_NAMESPACE
class QAction;
class QTextCursor;
class QTextDocument;
QT_END_NAMESPACE
namespace TextEditor {
class CompletionAssistProvider;
class ExtraEncodingSettings;
class FontSettings;
class IAssistProvider;
class StorageSettings;
class SyntaxHighlighter;
class TabSettings;
class TextDocumentPrivate;
class TextMark;
class TextSuggestion;
class TypingSettings;
using TextMarks = QList<TextMark *>;
class TEXTEDITOR_EXPORT TextDocument : public Core::BaseTextDocument
{
Q_OBJECT
public:
explicit TextDocument(Utils::Id id = Utils::Id());
~TextDocument() override;
static QMap<Utils::FilePath, QString> openedTextDocumentContents();
static QMap<Utils::FilePath, QTextCodec *> openedTextDocumentEncodings();
static TextDocument *currentTextDocument();
static TextDocument *textDocumentForFilePath(const Utils::FilePath &filePath);
static QString convertToPlainText(const QString &rawText);
virtual QString plainText() const;
virtual QString textAt(int pos, int length) const;
virtual QChar characterAt(int pos) const;
void setTypingSettings(const TypingSettings &typingSettings);
void setStorageSettings(const StorageSettings &storageSettings);
void setExtraEncodingSettings(const ExtraEncodingSettings &extraEncodingSettings);
const TypingSettings &typingSettings() const;
const StorageSettings &storageSettings() const;
virtual TabSettings tabSettings() const;
const ExtraEncodingSettings &extraEncodingSettings() const;
const FontSettings &fontSettings() const;
void setIndenter(Indenter *indenter);
Indenter *indenter() const;
void autoIndent(const QTextCursor &cursor,
QChar typedChar = QChar::Null,
int currentCursorPosition = -1);
void autoReindent(const QTextCursor &cursor, int currentCursorPosition = -1);
void autoFormatOrIndent(const QTextCursor &cursor);
Utils::MultiTextCursor indent(const Utils::MultiTextCursor &cursor);
Utils::MultiTextCursor unindent(const Utils::MultiTextCursor &cursor);
void setFormatter(Formatter *indenter); // transfers ownership
void autoFormat(const QTextCursor &cursor);
bool applyChangeSet(const Utils::ChangeSet &changeSet);
// the blocks list must be sorted
void setIfdefedOutBlocks(const QList<BlockRange> &blocks);
TextMarks marks() const;
bool addMark(TextMark *mark);
TextMarks marksAt(int line) const;
void removeMark(TextMark *mark);
void updateLayout() const;
void scheduleUpdateLayout() const;
void updateMark(TextMark *mark);
void moveMark(TextMark *mark, int previousLine);
void removeMarkFromMarksCache(TextMark *mark);
static void temporaryHideMarksAnnotation(const Utils::Id &category);
static void showMarksAnnotation(const Utils::Id &category);
static bool marksAnnotationHidden(const Utils::Id &category);
// IDocument implementation.
QByteArray contents() const override;
bool setContents(const QByteArray &contents) override;
void formatContents() override;
bool shouldAutoSave() const override;
bool isModified() const override;
bool isSaveAsAllowed() const override;
bool reload(QString *errorString, ReloadFlag flag, ChangeType type) override;
void setFilePath(const Utils::FilePath &newName) override;
ReloadBehavior reloadBehavior(ChangeTrigger state, ChangeType type) const override;
Utils::FilePath fallbackSaveAsPath() const override;
QString fallbackSaveAsFileName() const override;
void setFallbackSaveAsPath(const Utils::FilePath &fallbackSaveAsPath);
void setFallbackSaveAsFileName(const QString &fallbackSaveAsFileName);
OpenResult open(QString *errorString, const Utils::FilePath &filePath,
const Utils::FilePath &realFilePath) override;
virtual bool reload(QString *errorString);
bool reload(QString *errorString, const Utils::FilePath &realFilePath);
bool setPlainText(const QString &text);
QTextDocument *document() const;
using SyntaxHighLighterCreator = std::function<SyntaxHighlighter *()>;
void resetSyntaxHighlighter(const SyntaxHighLighterCreator &creator);
SyntaxHighlighter *syntaxHighlighter() const;
bool reload(QString *errorString, QTextCodec *codec);
void cleanWhitespace(const QTextCursor &cursor);
virtual void triggerPendingUpdates();
virtual void setCompletionAssistProvider(CompletionAssistProvider *provider);
virtual CompletionAssistProvider *completionAssistProvider() const;
virtual void setFunctionHintAssistProvider(CompletionAssistProvider *provider);
virtual CompletionAssistProvider *functionHintAssistProvider() const;
void setQuickFixAssistProvider(IAssistProvider *provider) const;
virtual IAssistProvider *quickFixAssistProvider() const;
void setTabSettings(const TextEditor::TabSettings &tabSettings);
void setFontSettings(const TextEditor::FontSettings &fontSettings);
static QAction *createDiffAgainstCurrentFileAction(QObject *parent,
const std::function<Utils::FilePath()> &filePath);
void insertSuggestion(const QString &text, const QTextCursor &cursor);
void insertSuggestion(std::unique_ptr<TextSuggestion> &&suggestion);
#ifdef WITH_TESTS
void setSilentReload();
#endif
signals:
void aboutToOpen(const Utils::FilePath &filePath, const Utils::FilePath &realFilePath);
void openFinishedSuccessfully();
void contentsChangedWithPosition(int position, int charsRemoved, int charsAdded);
void tabSettingsChanged();
void fontSettingsChanged();
void markRemoved(TextMark *mark);
#ifdef WITH_TESTS
void ifdefedOutBlocksChanged(const QList<BlockRange> &blocks);
#endif
protected:
virtual void applyFontSettings();
bool saveImpl(QString *errorString, const Utils::FilePath &filePath, bool autoSave) override;
private:
OpenResult openImpl(QString *errorString,
const Utils::FilePath &filePath,
const Utils::FilePath &realFileName,
bool reload);
void cleanWhitespace(QTextCursor &cursor, bool inEntireDocument, bool cleanIndentation);
void ensureFinalNewLine(QTextCursor &cursor);
void modificationChanged(bool modified);
TextDocumentPrivate *d;
};
using TextDocumentPtr = QSharedPointer<TextDocument>;
} // namespace TextEditor
|
