/************************************************************************** ** ** This file is part of Qt Creator ** ** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies). ** ** Contact: Nokia Corporation (info@qt.nokia.com) ** ** ** GNU Lesser General Public License Usage ** ** This file may be used under the terms of the GNU Lesser General Public ** License version 2.1 as published by the Free Software Foundation and ** appearing in the file LICENSE.LGPL included in the packaging of this file. ** Please review the following information to ensure the GNU Lesser General ** Public License version 2.1 requirements will be met: ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. ** ** In addition, as a special exception, Nokia gives you certain additional ** rights. These rights are described in the Nokia Qt LGPL Exception ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. ** ** Other Usage ** ** Alternatively, this file may be used in accordance with the terms and ** conditions contained in a signed written agreement between you and Nokia. ** ** If you have questions regarding the use of this file, please contact ** Nokia at info@qt.nokia.com. ** **************************************************************************/ #include "qmljscompletionassist.h" #include "qmljseditorconstants.h" #include "qmljsreuse.h" #include "qmlexpressionundercursor.h" #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include using namespace QmlJS; using namespace QmlJSEditor; using namespace Internal; using namespace TextEditor; namespace { enum CompletionOrder { EnumValueOrder = -5, SnippetOrder = -15, PropertyOrder = -10, SymbolOrder = -20, KeywordOrder = -25, TypeOrder = -30 }; class EnumerateProperties: private Interpreter::MemberProcessor { QSet _processed; QHash _properties; bool _globalCompletion; bool _enumerateGeneratedSlots; bool _enumerateSlots; const Interpreter::Context *_context; const Interpreter::ObjectValue *_currentObject; public: EnumerateProperties(const Interpreter::Context *context) : _globalCompletion(false), _enumerateGeneratedSlots(false), _enumerateSlots(true), _context(context), _currentObject(0) { } void setGlobalCompletion(bool globalCompletion) { _globalCompletion = globalCompletion; } void setEnumerateGeneratedSlots(bool enumerate) { _enumerateGeneratedSlots = enumerate; } void setEnumerateSlots(bool enumerate) { _enumerateSlots = enumerate; } QHash operator ()(const Interpreter::Value *value) { _processed.clear(); _properties.clear(); _currentObject = Interpreter::value_cast(value); enumerateProperties(value); return _properties; } QHash operator ()() { _processed.clear(); _properties.clear(); _currentObject = 0; foreach (const Interpreter::ObjectValue *scope, _context->scopeChain().all()) enumerateProperties(scope); return _properties; } private: void insertProperty(const QString &name, const Interpreter::Value *value) { _properties.insert(name, value); } virtual bool processProperty(const QString &name, const Interpreter::Value *value) { insertProperty(name, value); return true; } virtual bool processEnumerator(const QString &name, const Interpreter::Value *value) { if (! _globalCompletion) insertProperty(name, value); return true; } virtual bool processSignal(const QString &, const Interpreter::Value *) { return true; } virtual bool processSlot(const QString &name, const Interpreter::Value *value) { if (_enumerateSlots) insertProperty(name, value); return true; } virtual bool processGeneratedSlot(const QString &name, const Interpreter::Value *value) { if (_enumerateGeneratedSlots || (_currentObject && _currentObject->className().endsWith(QLatin1String("Keys")))) { // ### FIXME: add support for attached properties. insertProperty(name, value); } return true; } void enumerateProperties(const Interpreter::Value *value) { if (! value) return; else if (const Interpreter::ObjectValue *object = value->asObjectValue()) { enumerateProperties(object); } } void enumerateProperties(const Interpreter::ObjectValue *object) { if (! object || _processed.contains(object)) return; _processed.insert(object); enumerateProperties(object->prototype(_context)); object->processMembers(this); } }; const Interpreter::Value *getPropertyValue(const Interpreter::ObjectValue *object, const QStringList &propertyNames, const Interpreter::Context *context) { if (propertyNames.isEmpty() || !object) return 0; const Interpreter::Value *value = object; foreach (const QString &name, propertyNames) { if (const Interpreter::ObjectValue *objectValue = value->asObjectValue()) { value = objectValue->lookupMember(name, context); if (!value) return 0; } else { return 0; } } return value; } bool isLiteral(AST::Node *ast) { if (AST::cast(ast)) return true; else if (AST::cast(ast)) return true; else return false; } } // Anonymous // ----------------------- // QmlJSAssistProposalItem // ----------------------- bool QmlJSAssistProposalItem::prematurelyApplies(const QChar &c) const { if (data().canConvert()) // snippet return false; return (text().endsWith(QLatin1String(": ")) && c == QLatin1Char(':')) || (text().endsWith(QLatin1Char('.')) && c == QLatin1Char('.')); } void QmlJSAssistProposalItem::applyContextualContent(TextEditor::BaseTextEditor *editor, int basePosition) const { const int currentPosition = editor->position(); editor->setCursorPosition(basePosition); editor->remove(currentPosition - basePosition); QString replaceable; const QString &content = text(); if (content.endsWith(QLatin1String(": "))) replaceable = QLatin1String(": "); else if (content.endsWith(QLatin1Char('.'))) replaceable = QLatin1String("."); int replacedLength = 0; for (int i = 0; i < replaceable.length(); ++i) { const QChar a = replaceable.at(i); const QChar b = editor->characterAt(editor->position() + i); if (a == b) ++replacedLength; else break; } const int length = editor->position() - basePosition + replacedLength; editor->replace(length, content); } // ------------------------- // FunctionHintProposalModel // ------------------------- class FunctionHintProposalModel : public TextEditor::IFunctionHintProposalModel { public: FunctionHintProposalModel(const QString &functionName, const QStringList &signature) : m_functionName(functionName) , m_signature(signature) , m_minimumArgumentCount(signature.size()) {} virtual void reset() {} virtual int size() const { return 1; } virtual QString text(int index) const; virtual int activeArgument(const QString &prefix) const; private: QString m_functionName; QStringList m_signature; int m_minimumArgumentCount; }; QString FunctionHintProposalModel::text(int index) const { Q_UNUSED(index) QString prettyMethod; prettyMethod += QString::fromLatin1("function "); prettyMethod += m_functionName; prettyMethod += QLatin1Char('('); for (int i = 0; i < m_minimumArgumentCount; ++i) { if (i != 0) prettyMethod += QLatin1String(", "); QString arg = m_signature.at(i); if (arg.isEmpty()) { arg = QLatin1String("arg"); arg += QString::number(i + 1); } prettyMethod += arg; } prettyMethod += QLatin1Char(')'); return prettyMethod; } int FunctionHintProposalModel::activeArgument(const QString &prefix) const { int argnr = 0; int parcount = 0; Scanner tokenize; const QList tokens = tokenize(prefix); for (int i = 0; i < tokens.count(); ++i) { const Token &tk = tokens.at(i); if (tk.is(Token::LeftParenthesis)) ++parcount; else if (tk.is(Token::RightParenthesis)) --parcount; else if (! parcount && tk.is(Token::Colon)) ++argnr; } if (parcount < 0) return -1; return argnr; } // ----------------------------- // QmlJSCompletionAssistProvider // ----------------------------- bool QmlJSCompletionAssistProvider::supportsEditor(const QString &editorId) const { return editorId == QLatin1String(Constants::C_QMLJSEDITOR_ID); } int QmlJSCompletionAssistProvider::activationCharSequenceLength() const { return 1; } bool QmlJSCompletionAssistProvider::isActivationCharSequence(const QString &sequence) const { return isActivationChar(sequence.at(0)); } bool QmlJSCompletionAssistProvider::isContinuationChar(const QChar &c) const { return isIdentifierChar(c, false); } IAssistProcessor *QmlJSCompletionAssistProvider::createProcessor() const { return new QmlJSCompletionAssistProcessor; } // ------------------------------ // QmlJSCompletionAssistProcessor // ------------------------------ QmlJSCompletionAssistProcessor::QmlJSCompletionAssistProcessor() : m_startPosition(0) , m_snippetCollector(Constants::QML_SNIPPETS_GROUP_ID, iconForColor(Qt::red), SnippetOrder) {} QmlJSCompletionAssistProcessor::~QmlJSCompletionAssistProcessor() {} IAssistProposal *QmlJSCompletionAssistProcessor::createContentProposal() const { IGenericProposalModel *model = new QmlJSAssistProposalModel(m_completions); IAssistProposal *proposal = new GenericProposal(m_startPosition, model); return proposal; } IAssistProposal *QmlJSCompletionAssistProcessor::createHintProposal(const QString &functionName, const QStringList &signature) const { IFunctionHintProposalModel *model = new FunctionHintProposalModel(functionName, signature); IAssistProposal *proposal = new FunctionHintProposal(m_startPosition, model); return proposal; } IAssistProposal *QmlJSCompletionAssistProcessor::perform(const IAssistInterface *assistInterface) { m_interface.reset(static_cast(assistInterface)); if (assistInterface->reason() == IdleEditor && !acceptsIdleEditor()) return 0; const QString &fileName = m_interface->file()->fileName(); m_startPosition = assistInterface->position(); while (isIdentifierChar(m_interface->document()->characterAt(m_startPosition - 1), false, false)) --m_startPosition; m_completions.clear(); const QmlJSCompletionAssistInterface *qmlInterface = static_cast(assistInterface); const SemanticInfo &semanticInfo = qmlInterface->semanticInfo(); if (!semanticInfo.isValid()) return 0; const Document::Ptr document = semanticInfo.document; const QFileInfo currentFileInfo(fileName); bool isQmlFile = false; if (currentFileInfo.suffix() == QLatin1String("qml")) isQmlFile = true; const QList path = semanticInfo.astPath(m_interface->position()); LookupContext::Ptr lookupContext = semanticInfo.lookupContext(path); const Interpreter::Context *context = lookupContext->context(); // Search for the operator that triggered the completion. QChar completionOperator; if (m_startPosition > 0) completionOperator = m_interface->document()->characterAt(m_startPosition - 1); QTextCursor startPositionCursor(qmlInterface->document()); startPositionCursor.setPosition(m_startPosition); CompletionContextFinder contextFinder(startPositionCursor); const Interpreter::ObjectValue *qmlScopeType = 0; if (contextFinder.isInQmlContext()) { // find the enclosing qml object // ### this should use semanticInfo.declaringMember instead, but that may also return functions int i; for (i = path.size() - 1; i >= 0; --i) { AST::Node *node = path[i]; if (AST::cast(node) || AST::cast(node)) { qmlScopeType = document->bind()->findQmlObject(node); if (qmlScopeType) break; } } // grouped property bindings change the scope type for (i++; i < path.size(); ++i) { AST::UiObjectDefinition *objDef = AST::cast(path[i]); if (!objDef || !document->bind()->isGroupedPropertyBinding(objDef)) break; const Interpreter::ObjectValue *newScopeType = qmlScopeType; for (AST::UiQualifiedId *it = objDef->qualifiedTypeNameId; it; it = it->next) { if (!newScopeType || !it->name) { newScopeType = 0; break; } const Interpreter::Value *v = newScopeType->lookupMember(it->name->asString(), context); v = context->lookupReference(v); newScopeType = Interpreter::value_cast(v); } if (!newScopeType) break; qmlScopeType = newScopeType; } // fallback to getting the base type object if (!qmlScopeType) qmlScopeType = context->lookupType(document.data(), contextFinder.qmlObjectTypeName()); } if (contextFinder.isInStringLiteral()) { // get the text of the literal up to the cursor position //QTextCursor tc = textWidget->textCursor(); QTextCursor tc(qmlInterface->document()); tc.setPosition(qmlInterface->position()); QmlExpressionUnderCursor expressionUnderCursor; expressionUnderCursor(tc); QString literalText = expressionUnderCursor.text(); QTC_ASSERT(!literalText.isEmpty() && ( literalText.at(0) == QLatin1Char('"') || literalText.at(0) == QLatin1Char('\'')), return 0); literalText = literalText.mid(1); if (contextFinder.isInImport()) { QStringList patterns; patterns << QLatin1String("*.qml") << QLatin1String("*.js"); if (completeFileName(document->path(), literalText, patterns)) return createContentProposal(); return 0; } const Interpreter::Value *value = getPropertyValue(qmlScopeType, contextFinder.bindingPropertyName(), context); if (!value) { // do nothing } else if (value->asUrlValue()) { if (completeUrl(document->path(), literalText)) return createContentProposal(); } // ### enum completion? // completion gets triggered for / in string literals, if we don't // return here, this will mean the snippet completion pops up for // each / in a string literal that is not triggering file completion return 0; } else if (completionOperator.isSpace() || completionOperator.isNull() || isDelimiterChar(completionOperator) || (completionOperator == QLatin1Char('(') && m_startPosition != m_interface->position())) { bool doGlobalCompletion = true; bool doQmlKeywordCompletion = true; bool doJsKeywordCompletion = true; bool doQmlTypeCompletion = false; if (contextFinder.isInLhsOfBinding() && qmlScopeType) { doGlobalCompletion = false; doJsKeywordCompletion = false; doQmlTypeCompletion = true; EnumerateProperties enumerateProperties(context); enumerateProperties.setGlobalCompletion(true); enumerateProperties.setEnumerateGeneratedSlots(true); enumerateProperties.setEnumerateSlots(false); // id: is special BasicProposalItem *idProposalItem = new QmlJSAssistProposalItem; idProposalItem->setText(QLatin1String("id: ")); idProposalItem->setIcon(m_interface->symbolIcon()); idProposalItem->setOrder(PropertyOrder); m_completions.append(idProposalItem); addCompletionsPropertyLhs(enumerateProperties(qmlScopeType), m_interface->symbolIcon(), PropertyOrder, contextFinder.isAfterOnInLhsOfBinding()); if (ScopeBuilder::isPropertyChangesObject(context, qmlScopeType) && context->scopeChain().qmlScopeObjects.size() == 2) { addCompletions(enumerateProperties(context->scopeChain().qmlScopeObjects.first()), m_interface->symbolIcon(), SymbolOrder); } } if (contextFinder.isInRhsOfBinding() && qmlScopeType) { doQmlKeywordCompletion = false; // complete enum values for enum properties const Interpreter::Value *value = getPropertyValue(qmlScopeType, contextFinder.bindingPropertyName(), context); if (const Interpreter::QmlEnumValue *enumValue = dynamic_cast(value)) { foreach (const QString &key, enumValue->keys()) addCompletion(key, m_interface->symbolIcon(), EnumValueOrder, QString("\"%1\"").arg(key)); } } if (!contextFinder.isInImport() && !contextFinder.isInQmlContext()) doQmlTypeCompletion = true; if (doQmlTypeCompletion) { if (const Interpreter::ObjectValue *qmlTypes = context->scopeChain().qmlTypes) { EnumerateProperties enumerateProperties(context); addCompletions(enumerateProperties(qmlTypes), m_interface->symbolIcon(), TypeOrder); } } if (doGlobalCompletion) { // It's a global completion. EnumerateProperties enumerateProperties(context); enumerateProperties.setGlobalCompletion(true); addCompletions(enumerateProperties(), m_interface->symbolIcon(), SymbolOrder); } if (doJsKeywordCompletion) { // add js keywords addCompletions(Scanner::keywords(), m_interface->keywordIcon(), KeywordOrder); } // add qml extra words if (doQmlKeywordCompletion && isQmlFile) { static QStringList qmlWords; static QStringList qmlWordsAlsoInJs; if (qmlWords.isEmpty()) { qmlWords << QLatin1String("property") //<< QLatin1String("readonly") << QLatin1String("signal") << QLatin1String("import"); } if (qmlWordsAlsoInJs.isEmpty()) qmlWordsAlsoInJs << QLatin1String("default") << QLatin1String("function"); addCompletions(qmlWords, m_interface->keywordIcon(), KeywordOrder); if (!doJsKeywordCompletion) addCompletions(qmlWordsAlsoInJs, m_interface->keywordIcon(), KeywordOrder); } } else if (completionOperator == QLatin1Char('.') || completionOperator == QLatin1Char('(')) { // Look at the expression under cursor. //QTextCursor tc = textWidget->textCursor(); QTextCursor tc(qmlInterface->document()); tc.setPosition(m_startPosition - 1); QmlExpressionUnderCursor expressionUnderCursor; QmlJS::AST::ExpressionNode *expression = expressionUnderCursor(tc); if (expression != 0 && ! isLiteral(expression)) { // Evaluate the expression under cursor. Interpreter::Engine *interp = lookupContext->engine(); const Interpreter::Value *value = interp->convertToObject(lookupContext->evaluate(expression)); //qDebug() << "type:" << interp.typeId(value); if (value && completionOperator == QLatin1Char('.')) { // member completion EnumerateProperties enumerateProperties(context); if (contextFinder.isInLhsOfBinding() && qmlScopeType) { enumerateProperties.setEnumerateGeneratedSlots(true); addCompletionsPropertyLhs(enumerateProperties(value), m_interface->symbolIcon(), PropertyOrder, contextFinder.isAfterOnInLhsOfBinding()); } else addCompletions(enumerateProperties(value), m_interface->symbolIcon(), SymbolOrder); } else if (value && completionOperator == QLatin1Char('(') && m_startPosition == m_interface->position()) { // function completion if (const Interpreter::FunctionValue *f = value->asFunctionValue()) { QString functionName = expressionUnderCursor.text(); int indexOfDot = functionName.lastIndexOf(QLatin1Char('.')); if (indexOfDot != -1) functionName = functionName.mid(indexOfDot + 1); QStringList signature; for (int i = 0; i < f->argumentCount(); ++i) signature.append(f->argumentName(i)); return createHintProposal(functionName.trimmed(), signature); } } } if (! m_completions.isEmpty()) return createContentProposal(); return 0; } if (isQmlFile && (completionOperator.isNull() || completionOperator.isSpace() || isDelimiterChar(completionOperator))) { m_completions.append(m_snippetCollector.collect()); } if (! m_completions.isEmpty()) return createContentProposal(); return 0; } bool QmlJSCompletionAssistProcessor::acceptsIdleEditor() const { const int cursorPos = m_interface->position(); bool maybeAccept = false; const QChar &charBeforeCursor = m_interface->document()->characterAt(cursorPos - 1); if (isActivationChar(charBeforeCursor)) { maybeAccept = true; } else { const QChar &charUnderCursor = m_interface->document()->characterAt(cursorPos); if (isIdentifierChar(charBeforeCursor) && ((charUnderCursor.isSpace() || charUnderCursor.isNull() || isDelimiterChar(charUnderCursor)) || isIdentifierChar(charUnderCursor))) { int startPos = cursorPos - 1; for (; startPos != -1; --startPos) { if (!isIdentifierChar(m_interface->document()->characterAt(startPos))) break; } ++startPos; const QString &word = m_interface->textAt(startPos, cursorPos - startPos); if (word.length() > 2 && isIdentifierChar(word.at(0), true)) { for (int i = 1; i < word.length(); ++i) { if (!isIdentifierChar(word.at(i))) return false; } maybeAccept = true; } } } if (maybeAccept) { QTextCursor tc(m_interface->document()); tc.setPosition(m_interface->position()); const QTextBlock &block = tc.block(); const QString &blockText = block.text(); const int blockState = qMax(0, block.previous().userState()) & 0xff; Scanner scanner; const QList tokens = scanner(blockText, blockState); const int column = block.position() - m_interface->position(); foreach (const Token &tk, tokens) { if (column >= tk.begin() && column <= tk.end()) { if (charBeforeCursor == QLatin1Char('/') && tk.is(Token::String)) return true; // path completion inside string literals if (tk.is(Token::Comment) || tk.is(Token::String) || tk.is(Token::RegExp)) return false; break; } } if (charBeforeCursor != QLatin1Char('/')) return true; } return false; } bool QmlJSCompletionAssistProcessor::completeFileName(const QString &relativeBasePath, const QString &fileName, const QStringList &patterns) { const QFileInfo fileInfo(fileName); QString directoryPrefix; if (fileInfo.isRelative()) { directoryPrefix = relativeBasePath; directoryPrefix += QDir::separator(); directoryPrefix += fileInfo.path(); } else { directoryPrefix = fileInfo.path(); } if (!QFileInfo(directoryPrefix).exists()) return false; QDirIterator dirIterator(directoryPrefix, patterns, QDir::AllDirs | QDir::Files | QDir::NoDotAndDotDot); while (dirIterator.hasNext()) { dirIterator.next(); const QString fileName = dirIterator.fileName(); BasicProposalItem *item = new QmlJSAssistProposalItem; item->setText(fileName); item->setIcon(m_interface->fileNameIcon()); m_completions.append(item); } return !m_completions.isEmpty(); } bool QmlJSCompletionAssistProcessor::completeUrl(const QString &relativeBasePath, const QString &urlString) { const QUrl url(urlString); QString fileName = url.toLocalFile(); if (fileName.isEmpty()) return false; return completeFileName(relativeBasePath, fileName); } void QmlJSCompletionAssistProcessor::addCompletionsPropertyLhs(const QHash &newCompletions, const QIcon &icon, int order, bool afterOn) { QHashIterator it(newCompletions); while (it.hasNext()) { it.next(); QString itemText = it.key(); QString postfix; if (!itemText.isEmpty() && itemText.at(0).isLower()) postfix = QLatin1String(": "); if (afterOn) postfix = QLatin1String(" {"); if (const Interpreter::QmlObjectValue *qmlValue = dynamic_cast(it.value())) { // to distinguish "anchors." from "gradient:" we check if the right hand side // type is instantiatable or is the prototype of an instantiatable object if (qmlValue->hasChildInPackage()) itemText.append(postfix); else itemText.append(QLatin1Char('.')); } else { itemText.append(postfix); } addCompletion(itemText, icon, order); } } void QmlJSCompletionAssistProcessor::addCompletion(const QString &text, const QIcon &icon, int order, const QVariant &data) { if (text.isEmpty()) return; BasicProposalItem *item = new QmlJSAssistProposalItem; item->setText(text); item->setIcon(icon); item->setOrder(order); item->setData(data); m_completions.append(item); } void QmlJSCompletionAssistProcessor::addCompletions(const QHash &newCompletions, const QIcon &icon, int order) { QHashIterator it(newCompletions); while (it.hasNext()) { it.next(); addCompletion(it.key(), icon, order); } } void QmlJSCompletionAssistProcessor::addCompletions(const QStringList &newCompletions, const QIcon &icon, int order) { foreach (const QString &text, newCompletions) addCompletion(text, icon, order); } // ------------------------------ // QmlJSCompletionAssistInterface // ------------------------------ QmlJSCompletionAssistInterface::QmlJSCompletionAssistInterface(QTextDocument *document, int position, Core::IFile *file, TextEditor::AssistReason reason, const SemanticInfo &info) : DefaultAssistInterface(document, position, file, reason) , m_semanticInfo(info) , m_darkBlueIcon(iconForColor(Qt::darkBlue)) , m_darkYellowIcon(iconForColor(Qt::darkYellow)) , m_darkCyanIcon(iconForColor(Qt::darkCyan)) {} const SemanticInfo &QmlJSCompletionAssistInterface::semanticInfo() const { return m_semanticInfo; } namespace { struct QmlJSLessThan { bool operator() (const BasicProposalItem *a, const BasicProposalItem *b) { if (a->order() != b->order()) return a->order() > b->order(); else if (a->text().isEmpty()) return true; else if (b->text().isEmpty()) return false; else if (a->data().isValid() != b->data().isValid()) return a->data().isValid(); else if (a->text().at(0).isUpper() && b->text().at(0).isLower()) return false; else if (a->text().at(0).isLower() && b->text().at(0).isUpper()) return true; return a->text() < b->text(); } }; } // Anonymous // ------------------------- // QmlJSAssistProposalModel // ------------------------- void QmlJSAssistProposalModel::sort() { qSort(currentItems().first, currentItems().second, QmlJSLessThan()); } bool QmlJSAssistProposalModel::keepPerfectMatch(TextEditor::AssistReason reason) const { return reason == ExplicitlyInvoked; }