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
|
/****************************************************************************
**
** Copyright (C) 2016 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 "texteditor_global.h"
#include <QString>
QT_BEGIN_NAMESPACE
class QTextCursor;
QT_END_NAMESPACE
namespace TextEditor {
class TabSettings;
class TEXTEDITOR_EXPORT AutoCompleter
{
public:
AutoCompleter();
virtual ~AutoCompleter();
void setAutoInsertBracketsEnabled(bool b) { m_autoInsertBrackets = b; }
bool isAutoInsertBracketsEnabled() const { return m_autoInsertBrackets; }
void setSurroundWithBracketsEnabled(bool b) { m_surroundWithBrackets = b; }
bool isSurroundWithBracketsEnabled() const { return m_surroundWithBrackets; }
void setAutoInsertQuotesEnabled(bool b) { m_autoInsertQuotes = b; }
bool isAutoInsertQuotesEnabled() const { return m_autoInsertQuotes; }
void setSurroundWithQuotesEnabled(bool b) { m_surroundWithQuotes = b; }
bool isSurroundWithQuotesEnabled() const { return m_surroundWithQuotes; }
// Returns the text to complete at the cursor position, or an empty string
virtual QString autoComplete(QTextCursor &cursor, const QString &text, bool skipChars) const;
// Handles backspace. When returning true, backspace processing is stopped
virtual bool autoBackspace(QTextCursor &cursor);
// Hook to insert special characters on enter. Returns the number of extra blocks inserted.
virtual int paragraphSeparatorAboutToBeInserted(QTextCursor &cursor,
const TabSettings &tabSettings);
virtual bool contextAllowsAutoBrackets(const QTextCursor &cursor,
const QString &textToInsert = QString()) const;
virtual bool contextAllowsAutoQuotes(const QTextCursor &cursor,
const QString &textToInsert = QString()) const;
virtual bool contextAllowsElectricCharacters(const QTextCursor &cursor) const;
// Returns true if the cursor is inside a comment.
virtual bool isInComment(const QTextCursor &cursor) const;
// Returns true if the cursor is inside a string.
virtual bool isInString(const QTextCursor &cursor) const;
virtual QString insertMatchingBrace(const QTextCursor &cursor, const
QString &text,
QChar lookAhead, bool skipChars,
int *skippedChars) const;
virtual QString insertMatchingQuote(const QTextCursor &cursor, const
QString &text,
QChar lookAhead, bool skipChars,
int *skippedChars) const;
// Returns the text that needs to be inserted
virtual QString insertParagraphSeparator(const QTextCursor &cursor) const;
static bool isQuote(const QString &text);
private:
QString replaceSelection(QTextCursor &cursor, const QString &textToInsert) const;
private:
mutable bool m_allowSkippingOfBlockEnd;
bool m_autoInsertBrackets;
bool m_surroundWithBrackets;
bool m_autoInsertQuotes;
bool m_surroundWithQuotes;
};
} // TextEditor
|
