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
|
/*
* This file is part of qmljs, the QML/JS language support plugin for KDevelop
* Copyright (c) 2013 Sven Brauch <svenbrauch@googlemail.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) version 3 or any later version
* accepted by the membership of KDE e.V. (or its successor approved
* by the membership of KDE e.V.), which shall act as a proxy
* defined in Section 14 of version 3 of the license.
*
* 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, see <http://www.gnu.org/licenses/>.
*
*/
#ifndef QMLJS_CONTEXT_H
#define QMLJS_CONTEXT_H
#include "codecompletionexport.h"
#include "items/completionitem.h"
#include <language/codecompletion/codecompletioncontext.h>
#include <language/duchain/ducontext.h>
namespace QmlJS {
class KDEVQMLJSCOMPLETION_EXPORT CodeCompletionContext : public KDevelop::CodeCompletionContext
{
public:
CodeCompletionContext(const KDevelop::DUContextPointer& context, const QString& text,
const KDevelop::CursorInRevision& position, int depth = 0);
virtual QList<KDevelop::CompletionTreeItemPointer> completionItems(bool& abort, bool fullCompletion = true) override;
KDevelop::AbstractType::Ptr typeToMatch() const;
enum CompletionInContextFlag {
CompletionOnlyLocal = 1, /*!< @brief Don't list the items available in parent contexts */
CompletionHideWrappers = 2, /*!< @brief Filter out QML component wrappers (Q... C++ classes) */
};
Q_DECLARE_FLAGS(CompletionInContextFlags, CompletionInContextFlag)
private:
/**
* @brief Entry in the expression stack returned by expressionStack()
*
* Code-completion usually happens in partial expressions that cannot be
* parsed using the QML/JS parser. expressionStack() can be used to build
* a stack of unterminated partial expressions. This structure represents
* an entry in this stack.
*
* Every expression stack entry contains information about where the
* expression started (at the beginning of the string or just after a brace),
* how many commas have been encountered in it (so that function call-tips
* can know which is the current argument being edited), and where is the last
* operator in the sub-expression. Normally, anything after the last operator
* should be a valid sub-expression identifying a declaration.
*
* @code
* foo(A, B, C
* [ [ se
* @endcode
*
* In the above snippet, the inner-most expression starts at A. However,
* "A, B, C" is not a valid JS expression (or one that should be used for
* code-completion). However, everything after the last comma, identified
* by operatorStart and operatorEnd, is valid ("C" is a identifier). "s" is
* operatorStart, and "e" is operatorEnd.
*/
struct ExpressionStackEntry {
int startPosition;
int operatorStart;
int operatorEnd;
int commas;
};
QList<KDevelop::CompletionTreeItemPointer> normalCompletion();
QList<KDevelop::CompletionTreeItemPointer> commentCompletion();
QList<KDevelop::CompletionTreeItemPointer> importCompletion();
QList<KDevelop::CompletionTreeItemPointer> nodeModuleCompletions();
QList<KDevelop::CompletionTreeItemPointer> functionCallTips();
QList<KDevelop::CompletionTreeItemPointer> completionsFromImports(CompletionInContextFlags flags);
QList<KDevelop::CompletionTreeItemPointer> completionsFromNodeModule(CompletionInContextFlags flags,
const QString& module);
QList<KDevelop::CompletionTreeItemPointer> completionsInContext(const KDevelop::DUContextPointer& context,
CompletionInContextFlags flags,
CompletionItem::Decoration decoration);
QList<KDevelop::CompletionTreeItemPointer> fieldCompletions(const QString &expression,
CompletionItem::Decoration decoration);
QStack<ExpressionStackEntry> expressionStack(const QString& expression); /*!< @see ExpressionStackEntry */
KDevelop::DeclarationPointer declarationAtEndOfString(const QString& expression);
bool containsOnlySpaces(const QString &str);
private:
enum CompletionKind {
NoCompletion, /*!< @brief No code-completion at all */
NormalCompletion, /*!< @brief Completion in a code context */
CommentCompletion, /*!< @brief Completion in comments */
StringCompletion, /*!< @brief Completion in strings */
ImportCompletion, /*!< @brief Completion for import statements */
NodeModulesCompletion /*!< @brief Completion for node.js module names */
};
CompletionKind m_completionKind;
KDevelop::AbstractType::Ptr m_typeToMatch;
};
Q_DECLARE_OPERATORS_FOR_FLAGS(CodeCompletionContext::CompletionInContextFlags)
}
#endif // QMLJS_CONTEXT_H
|