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 145 146 147 148 149 150 151 152 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 196 197 198 199 200 201 202 203 204
|
/*************************************************************************************
* Copyright (C) 2012 by Aleix Pol <aleixpol@kde.org> *
* Copyright (C) 2012 by Milian Wolff <mail@milianw.de> *
* Copyright (C) 2013 by Sven Brauch <svenbrauch@gmail.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 *
*************************************************************************************/
#include "kdevqmljsplugin.h"
#include "qmljsparsejob.h"
#include "qmljshighlighting.h"
#include "codecompletion/model.h"
#include "navigation/propertypreviewwidget.h"
#include "duchain/helper.h"
#include <qmljs/qmljsmodelmanagerinterface.h>
#include <KPluginFactory>
#include <language/codecompletion/codecompletion.h>
#include <language/assistant/renameassistant.h>
#include <language/assistant/staticassistantsmanager.h>
#include <language/codegen/basicrefactoring.h>
#include <language/duchain/duchain.h>
#include <language/duchain/duchainutils.h>
#include <language/interfaces/editorcontext.h>
#include <interfaces/icore.h>
#include <interfaces/idocumentcontroller.h>
#include <interfaces/ilanguagecontroller.h>
#include <interfaces/contextmenuextension.h>
#include <QReadWriteLock>
K_PLUGIN_FACTORY_WITH_JSON(KDevQmlJsSupportFactory, "kdevqmljs.json", registerPlugin<KDevQmlJsPlugin>(); )
using namespace KDevelop;
/// TODO: Extend? See qmljsmodelmanager.h in qt-creator.git
class ModelManager: public QmlJS::ModelManagerInterface
{
Q_OBJECT
public:
explicit ModelManager(QObject *parent = nullptr);
~ModelManager() override;
};
ModelManager::ModelManager(QObject* parent)
: QmlJS::ModelManagerInterface(parent) {}
ModelManager::~ModelManager() {}
KDevQmlJsPlugin::KDevQmlJsPlugin(QObject* parent, const QVariantList& )
: IPlugin(QStringLiteral("kdevqmljssupport"), parent )
, ILanguageSupport()
, m_highlighting(new QmlJsHighlighting(this))
, m_refactoring(new BasicRefactoring(this))
, m_modelManager(new ModelManager(this))
{
QmlJS::registerDUChainItems();
CodeCompletionModel* codeCompletion = new QmlJS::CodeCompletionModel(this);
new KDevelop::CodeCompletion(this, codeCompletion, name());
auto assistantsManager = core()->languageController()->staticAssistantsManager();
assistantsManager->registerAssistant(StaticAssistant::Ptr(new RenameAssistant(this)));
}
KDevQmlJsPlugin::~KDevQmlJsPlugin()
{
parseLock()->lockForWrite();
// By locking the parse-mutexes, we make sure that parse jobs get a chance to finish in a good state
parseLock()->unlock();
QmlJS::unregisterDUChainItems();
}
ParseJob* KDevQmlJsPlugin::createParseJob(const IndexedString& url)
{
return new QmlJsParseJob(url, this);
}
QString KDevQmlJsPlugin::name() const
{
return QStringLiteral("qml/js");
}
ICodeHighlighting* KDevQmlJsPlugin::codeHighlighting() const
{
return m_highlighting;
}
BasicRefactoring* KDevQmlJsPlugin::refactoring() const
{
return m_refactoring;
}
ContextMenuExtension KDevQmlJsPlugin::contextMenuExtension(Context* context, QWidget* parent)
{
ContextMenuExtension cm;
auto *ec = dynamic_cast<KDevelop::EditorContext *>(context);
if (ec && ICore::self()->languageController()->languagesForUrl(ec->url()).contains(this)) {
// It's a QML/JS file, let's add our context menu.
m_refactoring->fillContextMenu(cm, context, parent);
}
return cm;
}
const QString textFromDoc(const IDocument* doc, const KTextEditor::Range& range) {
return doc->textDocument()->line(range.start().line()).mid(range.start().column(), range.end().column()-range.start().column());
}
// Finds how many spaces the given string has at one end.
// direction=+1 -> left end of the string, -1 for right end.
int spacesAtCorner(const QString& string, int direction = +1) {
int spaces = 0;
QString::const_iterator it;
for ( it = direction == 1 ? string.begin() : string.end()-1 ; it != string.end(); it += direction ) {
if ( ! it->isSpace() ) break;
spaces += 1;
}
return spaces;
}
// Take the given QML line and check if it's a line of the form foo.bar: value.
// Return ranges for the key and the value.
const QPair<KTextEditor::Range, KTextEditor::Range> parseProperty(const QString& line, const KTextEditor::Cursor& position) {
const QStringList items = line.split(QLatin1Char(';'));
QString matchingItem;
int col_offset = -1;
// This is to also support FooAnimation { foo: bar; baz: bang; duration: 200 }
// or similar
for (const QString& item : items) {
col_offset += item.size() + 1;
if ( position.column() < col_offset ) {
matchingItem = item;
break;
}
}
QStringList split = matchingItem.split(QLatin1Char(':'));
if ( split.size() != 2 ) {
// The expression is not of the form foo:bar, thus invalid.
return qMakePair(KTextEditor::Range::invalid(), KTextEditor::Range::invalid());
}
QString key = split.at(0);
QString value = split.at(1);
// For animations or similar, remove the trailing '}' if there's no semicolon after the last entry
if (value.trimmed().endsWith(QLatin1Char('}'))) {
col_offset -= value.size() - value.lastIndexOf(QLatin1Char('}')) + 1;
value = value.left(value.lastIndexOf(QLatin1Char('}'))-1);
}
return qMakePair(
KTextEditor::Range(
KTextEditor::Cursor(position.line(), col_offset - value.size() - key.size() + spacesAtCorner(key, +1) - 1),
KTextEditor::Cursor(position.line(), col_offset - value.size() - 1 + spacesAtCorner(key, -1))
),
KTextEditor::Range(
KTextEditor::Cursor(position.line(), col_offset - value.size() + spacesAtCorner(value, +1)),
KTextEditor::Cursor(position.line(), col_offset + spacesAtCorner(value, -1))
));
}
QPair<QWidget*, KTextEditor::Range> KDevQmlJsPlugin::specialLanguageObjectNavigationWidget(const QUrl& url, const KTextEditor::Cursor& position)
{
IDocument* doc = ICore::self()->documentController()->documentForUrl(url);
if ( doc && doc->textDocument() ) {
// Check for a QML property, and construct a property preview widget
// if the property key is listed in the supported properties.
QPair<KTextEditor::Range, KTextEditor::Range> property = parseProperty(doc->textDocument()->line(position.line()), position);
if ( property.first.isValid() && property.second.isValid() ) {
const auto itemUnderCursor = DUChainUtils::itemUnderCursor(url, property.first.start());
return {PropertyPreviewWidget::constructIfPossible(
doc->textDocument(),
property.first,
property.second,
itemUnderCursor.declaration,
textFromDoc(doc, property.first),
textFromDoc(doc, property.second)
), itemUnderCursor.range};
}
}
// Otherwise, display no special "navigation" widget.
return KDevelop::ILanguageSupport::specialLanguageObjectNavigationWidget(url, position);
}
#include "kdevqmljsplugin.moc"
|