autocompleter.cpp 12.2 KB
Newer Older
hjk's avatar
hjk committed
1
/****************************************************************************
2
**
3
4
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
5
**
hjk's avatar
hjk committed
6
** This file is part of Qt Creator.
7
**
hjk's avatar
hjk committed
8
9
10
11
** 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
12
13
14
** 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.
15
**
16
17
18
19
20
21
22
** 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.
con's avatar
con committed
23
**
hjk's avatar
hjk committed
24
****************************************************************************/
25
26

#include "autocompleter.h"
27
#include "textdocumentlayout.h"
28
#include "tabsettings.h"
29

30
31
#include <QDebug>
#include <QTextCursor>
32
33
34

using namespace TextEditor;

35
36
37
38
AutoCompleter::AutoCompleter() :
    m_allowSkippingOfBlockEnd(false),
    m_surroundWithEnabled(true),
    m_autoParenthesesEnabled(true)
39
40
41
42
43
{}

AutoCompleter::~AutoCompleter()
{}

44
void AutoCompleter::setAutoParenthesesEnabled(bool b)
45
{
46
    m_autoParenthesesEnabled = b;
47
48
}

49
bool AutoCompleter::isAutoParenthesesEnabled() const
50
{
51
    return m_autoParenthesesEnabled;
52
53
}

54
void AutoCompleter::setSurroundWithEnabled(bool b)
55
{
56
    m_surroundWithEnabled = b;
57
58
}

59
bool AutoCompleter::isSurroundWithEnabled() const
60
{
61
    return m_surroundWithEnabled;
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
void AutoCompleter::countBracket(QChar open, QChar close, QChar c, int *errors, int *stillopen)
{
    if (c == open)
        ++*stillopen;
    else if (c == close)
        --*stillopen;

    if (*stillopen < 0) {
        *errors += -1 * (*stillopen);
        *stillopen = 0;
    }
}

void AutoCompleter::countBrackets(QTextCursor cursor,
                                  int from,
                                  int end,
                                  QChar open,
                                  QChar close,
                                  int *errors,
                                  int *stillopen)
{
    cursor.setPosition(from);
    QTextBlock block = cursor.block();
    while (block.isValid() && block.position() < end) {
88
89
        Parentheses parenList = TextDocumentLayout::parentheses(block);
        if (!parenList.isEmpty() && !TextDocumentLayout::ifdefedOut(block)) {
90
            for (int i = 0; i < parenList.count(); ++i) {
91
                Parenthesis paren = parenList.at(i);
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
                int position = block.position() + paren.pos;
                if (position < from || position >= end)
                    continue;
                countBracket(open, close, paren.chr, errors, stillopen);
            }
        }
        block = block.next();
    }
}

QString AutoCompleter::autoComplete(QTextCursor &cursor, const QString &textToInsert) const
{
    const bool checkBlockEnd = m_allowSkippingOfBlockEnd;
    m_allowSkippingOfBlockEnd = false; // consume blockEnd.

    if (m_surroundWithEnabled && cursor.hasSelection()) {
        if (textToInsert == QLatin1String("("))
109
            return cursor.selectedText() + QLatin1Char(')');
110
111
112
113
114
115
116
117
        if (textToInsert == QLatin1String("{")) {
            //If the text span multiple lines, insert on different lines
            QString str = cursor.selectedText();
            if (str.contains(QChar::ParagraphSeparator)) {
                //Also, try to simulate auto-indent
                str = (str.startsWith(QChar::ParagraphSeparator) ? QString() : QString(QChar::ParagraphSeparator)) +
                      str;
                if (str.endsWith(QChar::ParagraphSeparator))
118
                    str += QLatin1Char('}') + QString(QChar::ParagraphSeparator);
119
                else
120
                    str += QString(QChar::ParagraphSeparator) + QLatin1Char('}');
121
            } else {
122
                str += QLatin1Char('}');
123
124
125
126
            }
            return str;
        }
        if (textToInsert == QLatin1String("["))
127
            return cursor.selectedText() + QLatin1Char(']');
128
        if (textToInsert == QLatin1String("\""))
129
            return cursor.selectedText() + QLatin1Char('"');
130
        if (textToInsert == QLatin1String("'"))
131
            return cursor.selectedText() + QLatin1Char('\'');
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
    }

    if (!m_autoParenthesesEnabled)
        return QString();

    if (!contextAllowsAutoParentheses(cursor, textToInsert))
        return QString();

    QTextDocument *doc = cursor.document();
    const QString text = textToInsert;
    const QChar lookAhead = doc->characterAt(cursor.selectionEnd());

    const QChar character = textToInsert.at(0);
    const QString parentheses = QLatin1String("()");
    const QString brackets = QLatin1String("[]");
    if (parentheses.contains(character) || brackets.contains(character)) {
        QTextCursor tmp= cursor;
149
        bool foundBlockStart = TextBlockUserData::findPreviousBlockOpenParenthesis(&tmp);
150
151
        int blockStart = foundBlockStart ? tmp.position() : 0;
        tmp = cursor;
152
        bool foundBlockEnd = TextBlockUserData::findNextBlockClosingParenthesis(&tmp);
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
188
189
190
191
192
193
194
195
        int blockEnd = foundBlockEnd ? tmp.position() : (cursor.document()->characterCount() - 1);
        const QChar openChar = parentheses.contains(character) ? QLatin1Char('(') : QLatin1Char('[');
        const QChar closeChar = parentheses.contains(character) ? QLatin1Char(')') : QLatin1Char(']');

        int errors = 0;
        int stillopen = 0;
        countBrackets(cursor, blockStart, blockEnd, openChar, closeChar, &errors, &stillopen);
        int errorsBeforeInsertion = errors + stillopen;
        errors = 0;
        stillopen = 0;
        countBrackets(cursor, blockStart, cursor.position(), openChar, closeChar, &errors, &stillopen);
        countBracket(openChar, closeChar, character, &errors, &stillopen);
        countBrackets(cursor, cursor.position(), blockEnd, openChar, closeChar, &errors, &stillopen);
        int errorsAfterInsertion = errors + stillopen;
        if (errorsAfterInsertion < errorsBeforeInsertion)
            return QString(); // insertion fixes parentheses or bracket errors, do not auto complete
    }

    int skippedChars = 0;
    const QString autoText = insertMatchingBrace(cursor, text, lookAhead, &skippedChars);

    if (checkBlockEnd && textToInsert.at(0) == QLatin1Char('}')) {
        if (textToInsert.length() > 1)
            qWarning() << "*** handle event compression";

        int startPos = cursor.selectionEnd(), pos = startPos;
        while (doc->characterAt(pos).isSpace())
            ++pos;

        if (doc->characterAt(pos) == QLatin1Char('}'))
            skippedChars += (pos - startPos) + 1;
    }

    if (skippedChars) {
        const int pos = cursor.position();
        cursor.setPosition(pos + skippedChars);
        cursor.setPosition(pos, QTextCursor::KeepAnchor);
    }

    return autoText;
}

bool AutoCompleter::autoBackspace(QTextCursor &cursor)
196
{
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
    m_allowSkippingOfBlockEnd = false;

    if (!m_autoParenthesesEnabled)
        return false;

    int pos = cursor.position();
    if (pos == 0)
        return false;
    QTextCursor c = cursor;
    c.setPosition(pos - 1);

    QTextDocument *doc = cursor.document();
    const QChar lookAhead = doc->characterAt(pos);
    const QChar lookBehind = doc->characterAt(pos - 1);

    const QChar character = lookBehind;
    if (character == QLatin1Char('(') || character == QLatin1Char('[')) {
        QTextCursor tmp = cursor;
215
        TextBlockUserData::findPreviousBlockOpenParenthesis(&tmp);
216
217
        int blockStart = tmp.isNull() ? 0 : tmp.position();
        tmp = cursor;
218
        TextBlockUserData::findNextBlockClosingParenthesis(&tmp);
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
        int blockEnd = tmp.isNull() ? (cursor.document()->characterCount()-1) : tmp.position();
        QChar openChar = character;
        QChar closeChar = (character == QLatin1Char('(')) ? QLatin1Char(')') : QLatin1Char(']');

        int errors = 0;
        int stillopen = 0;
        countBrackets(cursor, blockStart, blockEnd, openChar, closeChar, &errors, &stillopen);
        int errorsBeforeDeletion = errors + stillopen;
        errors = 0;
        stillopen = 0;
        countBrackets(cursor, blockStart, pos - 1, openChar, closeChar, &errors, &stillopen);
        countBrackets(cursor, pos, blockEnd, openChar, closeChar, &errors, &stillopen);
        int errorsAfterDeletion = errors + stillopen;

        if (errorsAfterDeletion < errorsBeforeDeletion)
            return false; // insertion fixes parentheses or bracket errors, do not auto complete
    }

    // ### this code needs to be generalized
    if    ((lookBehind == QLatin1Char('(') && lookAhead == QLatin1Char(')'))
239
        || (lookBehind == QLatin1Char('[') && lookAhead == QLatin1Char(']'))) {
240
241
242
243
244
245
246
247
248
        if (! isInComment(c)) {
            cursor.beginEditBlock();
            cursor.deleteChar();
            cursor.deletePreviousChar();
            cursor.endEditBlock();
            return true;
        }
    }
    return false;
249
250
}

251
252
int AutoCompleter::paragraphSeparatorAboutToBeInserted(QTextCursor &cursor,
                                                       const TabSettings &tabSettings)
253
254
255
256
257
258
259
260
261
262
263
264
{
    if (!m_autoParenthesesEnabled)
        return 0;

    QTextDocument *doc = cursor.document();
    if (doc->characterAt(cursor.position() - 1) != QLatin1Char('{'))
        return 0;

    if (!contextAllowsAutoParentheses(cursor))
        return 0;

    // verify that we indeed do have an extra opening brace in the document
Flex Ferrum's avatar
Flex Ferrum committed
265
266
    QTextBlock block = cursor.block();
    const QString textFromCusror = block.text().mid(cursor.positionInBlock()).trimmed();
267
    int braceDepth = TextDocumentLayout::braceDepth(doc->lastBlock());
268

Flex Ferrum's avatar
Flex Ferrum committed
269
270
    if (braceDepth <= 0 && (textFromCusror.isEmpty() || textFromCusror.at(0) != QLatin1Char('}')))
        return 0; // braces are all balanced or worse, no need to do anything and separator inserted not between '{' and '}'
271
272
273
274
275
276
277
278
279

    // we have an extra brace , let's see if we should close it

    /* verify that the next block is not further intended compared to the current block.
       This covers the following case:

            if (condition) {|
                statement;
    */
280
    int indentation = tabSettings.indentationColumn(block.text());
281
282
283
284

    if (block.next().isValid()) { // not the last block
        block = block.next();
        //skip all empty blocks
285
        while (block.isValid() && tabSettings.onlySpace(block.text()))
286
287
            block = block.next();
        if (block.isValid()
288
                && tabSettings.indentationColumn(block.text()) > indentation)
289
290
291
292
293
294
295
296
297
            return 0;
    }

    const QString &textToInsert = insertParagraphSeparator(cursor);
    int pos = cursor.position();
    cursor.insertBlock();
    cursor.insertText(textToInsert);
    cursor.setPosition(pos);

298
299
300
301
    // if we actually insert a separator, allow it to be overwritten if
    // user types it
    if (!textToInsert.isEmpty())
        m_allowSkippingOfBlockEnd = true;
302
303
304
305
306
307

    return 1;
}

bool AutoCompleter::contextAllowsAutoParentheses(const QTextCursor &cursor,
                                                 const QString &textToInsert) const
308
309
310
311
312
313
{
    Q_UNUSED(cursor);
    Q_UNUSED(textToInsert);
    return false;
}

314
bool AutoCompleter::contextAllowsElectricCharacters(const QTextCursor &cursor) const
315
{
316
    return contextAllowsAutoParentheses(cursor);
317
318
}

319
bool AutoCompleter::isInComment(const QTextCursor &cursor) const
320
321
322
323
324
{
    Q_UNUSED(cursor);
    return false;
}

325
326
327
328
329
330
bool AutoCompleter::isInString(const QTextCursor &cursor) const
{
    Q_UNUSED(cursor);
    return false;
}

331
332
333
334
QString AutoCompleter::insertMatchingBrace(const QTextCursor &cursor,
                                           const QString &text,
                                           QChar la,
                                           int *skippedChars) const
335
336
337
338
339
340
341
342
{
    Q_UNUSED(cursor);
    Q_UNUSED(text);
    Q_UNUSED(la);
    Q_UNUSED(skippedChars);
    return QString();
}

343
QString AutoCompleter::insertParagraphSeparator(const QTextCursor &cursor) const
344
345
346
347
{
    Q_UNUSED(cursor);
    return QString();
}