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
|
/****************************************************************************
**
** Copyright (C) 2019 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of Qt Creator.
**
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3 as published by the Free Software
** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-3.0.html.
**
****************************************************************************/
#pragma once
#include <utils/fileutils.h>
#include <utils/optional.h>
#include <utils/textutils.h>
#include <QMap>
#include <QTextBlock>
#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)
{}
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 void autoIndent(const QTextCursor &cursor,
const TabSettings &tabSettings,
int cursorPositionInEditor = -1)
{
indent(cursor, QChar::Null, tabSettings, cursorPositionInEditor);
}
virtual Utils::Text::Replacements format(const RangesInLines & /*rangesInLines*/)
{
return Utils::Text::Replacements();
}
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 Utils::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 Utils::optional<int> margin() const { return Utils::nullopt; }
protected:
QTextDocument *m_doc;
Utils::FilePath m_fileName;
};
} // namespace TextEditor
|
