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
|
// Copyright (C) 2019 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0
#pragma once
#include <utils/changeset.h>
#include <utils/fileutils.h>
#include <QMap>
#include <QTextBlock>
#include <optional>
#include <vector>
namespace Utils {
class FilePath;
}
namespace TextEditor {
class ICodeStylePreferences;
class TabSettings;
using IndentationForBlock = QMap<int, int>;
class RangeInLines
{
public:
int startLine;
int endLine;
};
using RangesInLines = std::vector<RangeInLines>;
class Indenter
{
public:
explicit Indenter(QTextDocument *doc)
: m_doc(doc)
{}
virtual void setFileName(const Utils::FilePath &fileName) { m_fileName = fileName; }
virtual ~Indenter() = default;
// Returns true if key triggers an indent.
virtual bool isElectricCharacter(const QChar & /*ch*/) const { return false; }
virtual void setCodeStylePreferences(ICodeStylePreferences * /*preferences*/) {}
virtual void invalidateCache() {}
virtual int indentFor(const QTextBlock & /*block*/,
const TabSettings & /*tabSettings*/,
int /*cursorPositionInEditor*/ = -1)
{
return -1;
}
virtual int visualIndentFor(const QTextBlock & /*block*/,
const TabSettings & /*tabSettings*/)
{
return -1;
}
virtual void autoIndent(const QTextCursor &cursor,
const TabSettings &tabSettings,
int cursorPositionInEditor = -1)
{
indent(cursor, QChar::Null, tabSettings, cursorPositionInEditor);
}
enum class FormattingMode { Forced, Settings };
virtual Utils::EditOperations format(const RangesInLines &,
FormattingMode = FormattingMode::Forced)
{
return Utils::EditOperations();
}
virtual bool formatOnSave() const { return false; }
// Expects a list of blocks in order of occurrence in the document.
virtual IndentationForBlock indentationForBlocks(const QVector<QTextBlock> &blocks,
const TabSettings &tabSettings,
int cursorPositionInEditor = -1)
= 0;
virtual std::optional<TabSettings> tabSettings() const = 0;
// Indent a text block based on previous line. Default does nothing
virtual void indentBlock(const QTextBlock &block,
const QChar &typedChar,
const TabSettings &tabSettings,
int cursorPositionInEditor = -1)
= 0;
// Indent at cursor. Calls indentBlock for selection or current line.
virtual void indent(const QTextCursor &cursor,
const QChar &typedChar,
const TabSettings &tabSettings,
int cursorPositionInEditor = -1)
= 0;
// Reindent at cursor. Selection will be adjusted according to the indentation
// change of the first block.
virtual void reindent(const QTextCursor &cursor,
const TabSettings &tabSettings,
int cursorPositionInEditor = -1)
= 0;
virtual std::optional<int> margin() const { return std::nullopt; }
protected:
QTextDocument *m_doc;
Utils::FilePath m_fileName;
};
} // namespace TextEditor
|
