File: autocompleter.hpp

package info (click to toggle)
supercollider 1%3A3.13.0%2Brepack-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 80,292 kB
  • sloc: cpp: 476,363; lisp: 84,680; ansic: 77,685; sh: 25,509; python: 7,909; makefile: 3,440; perl: 1,964; javascript: 974; xml: 826; java: 677; yacc: 314; lex: 175; objc: 152; ruby: 136
file content (144 lines) | stat: -rw-r--r-- 4,435 bytes parent folder | download | duplicates (4)
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
/*
    SuperCollider Qt IDE
    Copyright (c) 2012 Jakob Leben & Tim Blechmann
    http://www.audiosynth.com

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301  USA
*/

#pragma once

#include <QObject>
#include <QTextDocument>
#include <QStack>
#include <QKeyEvent>
#include <QStringList>
#include <QPointer>

#include "tokens.hpp"
#include "completion_menu.hpp"

#include "SCDoc/SCDoc.h"

namespace ScIDE {

class ScCodeEditor;
class TokenIterator;
class MethodCallWidget;

namespace ScLanguage {
struct Method;
struct Class;
}

class AutoCompleter : public QObject {
    Q_OBJECT

public:
    AutoCompleter(ScCodeEditor*);

    void keyPress(QKeyEvent*);
    void documentChanged(QTextDocument*);
    // NOTE: default 'force' to true in the following methods
    // for the purpose of argument-less QAction::triggered() signal:
    void triggerCompletion(bool forceShow = true);
    void triggerMethodCallAid(bool explicitly = true);

private slots:
    void onContentsChange(int pos, int removed, int added);
    void onCursorChanged();
    void onCompletionMenuFinished(int result);
    void updateCompletionMenuInfo();
    void clearMethodCallStack();
    void hideWidgets();
    void gotoHelp(QString symbol);

private:
    friend class MethodCallWidget;

    struct MethodCall {
        MethodCall(): position(0), method(0), functionalNotation(false), suppressed(false) {}
        int position;
        const ScLanguage::Method* method;
        bool functionalNotation;
        bool suppressed;
    };

    enum CompletionType { ClassCompletion, ClassMethodCompletion, MethodCompletion, InvalidCompletion };

    struct CompletionDescription {
        bool on;
        CompletionType type;
        int pos;
        int len;
        int contextPos;
        QString base;
        QString text;
        QPointer<CompletionMenu> menu;
        Token::Type tokenType;
    };

    struct MethodCallContext {
        QStack<MethodCall> stack;
        QPointer<CompletionMenu> menu;
        QPointer<MethodCallWidget> widget;
    };

    typedef QStack<MethodCall>::iterator MethodCallIterator;

    bool eventFilter(QObject*, QEvent*);

    QTextDocument* document();

    // completion

    void quitCompletion(const QString& reason = QString());
    void showCompletionMenu(bool forceShow);
    void updateCompletionMenu(bool forceShow);

    // method call aid

    const ScLanguage::Method* disambiguateMethod(const QString& methodName, int cursorPos);
    void updateMethodCall(int cursorPos);
    void pushMethodCall(const MethodCall& call);
    void showMethodCall(const MethodCall& call, int arg = 0);
    void hideMethodCall();
    bool trySwitchMethodCallArgument(bool backwards = false);
    bool testMethodCall(const MethodCall&, int cursorPos, int& argNum, TokenIterator& argNameToken,
                        bool strict = false);

    static CompletionMenu* menuForClassCompletion(CompletionDescription const& completion, ScCodeEditor* editor);
    static CompletionMenu* menuForClassMethodCompletion(CompletionDescription const& completion, ScCodeEditor* editor);
    static CompletionMenu* menuForMethodCompletion(CompletionDescription const& completion, ScCodeEditor* editor);

    static const ScLanguage::Class* classForToken(Token::Type type, const QString& string);

    // utilities

    QString tokenText(TokenIterator& it);
    QRect globalCursorRect(int cursorPosition);
    static QString findHelpClass(QString klass);
    static DocNode* parseHelpClass(QString file);
    static QString parseClassElement(DocNode* node, QString element);
    static void parseClassNode(DocNode* node, QString* str);

    // data

    ScCodeEditor* mEditor;
    CompletionDescription mCompletion;
    MethodCallContext mMethodCall;
};

} // namespace ScIDE