src/plugins/qmljseditor/qmljseditorplugin.cpp

   1 /**************************************************************************
   2 **
   3 ** This file is part of Qt Creator
   4 **
   5 ** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
   6 **
   7 ** Contact: Nokia Corporation (qt-info@nokia.com)
   8 **
   9 ** No Commercial Usage
  10 **
  11 ** This file contains pre-release code and may not be distributed.
  12 ** You may use this file in accordance with the terms and conditions
  13 ** contained in the Technology Preview License Agreement accompanying
  14 ** this package.
  15 **
  16 ** GNU Lesser General Public License Usage
  17 **
  18 ** Alternatively, this file may be used under the terms of the GNU Lesser
  19 ** General Public License version 2.1 as published by the Free Software
  20 ** Foundation and appearing in the file LICENSE.LGPL included in the
  21 ** packaging of this file.  Please review the following information to
  22 ** ensure the GNU Lesser General Public License version 2.1 requirements
  23 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  24 **
  25 ** In addition, as a special exception, Nokia gives you certain additional
  26 ** rights.  These rights are described in the Nokia Qt LGPL Exception
  27 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  28 **
  29 ** If you have questions regarding the use of this file, please contact
  30 ** Nokia at qt-info@nokia.com.
  31 **
  32 **************************************************************************/
  33
  34 #include "qmljseditorplugin.h"
  35 #include "qmljshighlighter.h"
  36 #include "qmljseditor.h"
  37 #include "qmljseditorconstants.h"
  38 #include "qmljseditorfactory.h"
  39 #include "qmljscodecompletion.h"
  40 #include "qmljshoverhandler.h"
  41 #include "qmlfilewizard.h"
  42 #include "jsfilewizard.h"
  43 #include "qmljsoutline.h"
  44 #include "qmljspreviewrunner.h"
  45 #include "qmljsquickfix.h"
  46 #include "qmljssnippetprovider.h"
  47 #include "qmltaskmanager.h"
  48 #include "quicktoolbar.h"
  49 #include "quicktoolbarsettingspage.h"
  50
  51 #include <qmljs/qmljsicons.h>
  52 #include <qmljs/qmljsmodelmanagerinterface.h>
  53
  54 #include <qmldesigner/qmldesignerconstants.h>
  55
  56 #include <coreplugin/icore.h>
  57 #include <coreplugin/coreconstants.h>
  58 #include <coreplugin/mimedatabase.h>
  59 #include <coreplugin/uniqueidmanager.h>
  60 #include <coreplugin/fileiconprovider.h>
  61 #include <coreplugin/actionmanager/actionmanager.h>
  62 #include <coreplugin/actionmanager/actioncontainer.h>
  63 #include <coreplugin/actionmanager/command.h>
  64 #include <coreplugin/editormanager/editormanager.h>
  65 #include <projectexplorer/taskhub.h>
  66 #include <extensionsystem/pluginmanager.h>
  67 #include <texteditor/fontsettings.h>
  68 #include <texteditor/storagesettings.h>
  69 #include <texteditor/texteditorconstants.h>
  70 #include <texteditor/texteditorsettings.h>
  71 #include <texteditor/textfilewizard.h>
  72 #include <texteditor/texteditoractionhandler.h>
  73 #include <texteditor/completionsupport.h>
  74 #include <utils/qtcassert.h>
  75
  76 #include <QtCore/QtPlugin>
  77 #include <QtCore/QDebug>
  78 #include <QtCore/QSettings>
  79 #include <QtCore/QDir>
  80 #include <QtCore/QCoreApplication>
  81 #include <QtCore/QTimer>
  82 #include <QtGui/QMenu>
  83 #include <QtGui/QAction>
  84
  85 using namespace QmlJSEditor;
  86 using namespace QmlJSEditor::Internal;
  87 using namespace QmlJSEditor::Constants;
  88
  89 enum {
  90     QUICKFIX_INTERVAL = 20
  91 };
  92
  93 QmlJSEditorPlugin *QmlJSEditorPlugin::m_instance = 0;
  94
  95 QmlJSEditorPlugin::QmlJSEditorPlugin() :
  96         m_modelManager(0),
  97     m_wizard(0),
  98     m_editor(0),
  99     m_actionHandler(0)
 100 {
 101     m_instance = this;
 102
 103     m_quickFixCollector = 0;
 104     m_quickFixTimer = new QTimer(this);
 105     m_quickFixTimer->setInterval(20);
 106     m_quickFixTimer->setSingleShot(true);
 107     connect(m_quickFixTimer, SIGNAL(timeout()), this, SLOT(quickFixNow()));
 108 }
 109
 110 QmlJSEditorPlugin::~QmlJSEditorPlugin()
 111 {
 112     removeObject(m_editor);
 113     delete m_actionHandler;
 114     m_instance = 0;
 115 }
 116
 117 /*! Copied from cppplugin.cpp */
 118 static inline
 119 Core::Command *createSeparator(Core::ActionManager *am,
 120                                QObject *parent,
 121                                Core::Context &context,
 122                                const char *id)
 123 {
 124     QAction *separator = new QAction(parent);
 125     separator->setSeparator(true);
 126     return am->registerAction(separator, Core::Id(id), context);
 127 }
 128
 129 bool QmlJSEditorPlugin::initialize(const QStringList & /*arguments*/, QString *error_message)
 130 {
 131     Core::ICore *core = Core::ICore::instance();
 132     if (!core->mimeDatabase()->addMimeTypes(QLatin1String(":/qmljseditor/QmlJSEditor.mimetypes.xml"), error_message))
 133         return false;
 134
 135     m_modelManager = QmlJS::ModelManagerInterface::instance();
 136     addAutoReleasedObject(new QmlJSSnippetProvider);
 137
 138     Core::Context context(QmlJSEditor::Constants::C_QMLJSEDITOR_ID);
 139
 140     m_editor = new QmlJSEditorFactory(this);
 141     addObject(m_editor);
 142
 143     Core::BaseFileWizardParameters qmlWizardParameters(Core::IWizard::FileWizard);
 144     qmlWizardParameters.setCategory(QLatin1String(Constants::WIZARD_CATEGORY_QML));
 145     qmlWizardParameters.setDisplayCategory(QCoreApplication::translate("QmlJsEditor", Constants::WIZARD_TR_CATEGORY_QML));
 146     qmlWizardParameters.setDescription(tr("Creates a QML file."));
 147     qmlWizardParameters.setDisplayName(tr("QML File"));
 148     qmlWizardParameters.setId(QLatin1String("Q.Qml"));
 149     addAutoReleasedObject(new QmlFileWizard(qmlWizardParameters, core));
 150
 151     Core::BaseFileWizardParameters jsWizardParameters(Core::IWizard::FileWizard);
 152     jsWizardParameters.setCategory(QLatin1String(Constants::WIZARD_CATEGORY_QML));
 153     jsWizardParameters.setDisplayCategory(QCoreApplication::translate("QmlJsEditor", Constants::WIZARD_TR_CATEGORY_QML));
 154     jsWizardParameters.setDescription(tr("Creates a JavaScript file."));
 155     jsWizardParameters.setDisplayName(tr("JS File"));
 156     jsWizardParameters.setId(QLatin1String("Z.Js"));
 157     addAutoReleasedObject(new JsFileWizard(jsWizardParameters, core));
 158
 159     m_actionHandler = new TextEditor::TextEditorActionHandler(QmlJSEditor::Constants::C_QMLJSEDITOR_ID,
 160           TextEditor::TextEditorActionHandler::Format
 161         | TextEditor::TextEditorActionHandler::UnCommentSelection
 162         | TextEditor::TextEditorActionHandler::UnCollapseAll);
 163     m_actionHandler->initializeActions();
 164
 165     Core::ActionManager *am =  core->actionManager();
 166     Core::ActionContainer *contextMenu = am->createMenu(QmlJSEditor::Constants::M_CONTEXT);
 167     Core::ActionContainer *qmlToolsMenu = am->createMenu(Core::Id(Constants::M_TOOLS_QML));
 168     qmlToolsMenu->setOnAllDisabledBehavior(Core::ActionContainer::Hide);
 169     QMenu *menu = qmlToolsMenu->menu();
 170     //: QML sub-menu in the Tools menu
 171     menu->setTitle(tr("QML"));
 172     am->actionContainer(Core::Constants::M_TOOLS)->addMenu(qmlToolsMenu);
 173
 174     Core::Command *cmd;
 175     QAction *followSymbolUnderCursorAction = new QAction(tr("Follow Symbol Under Cursor"), this);
 176     cmd = am->registerAction(followSymbolUnderCursorAction, Constants::FOLLOW_SYMBOL_UNDER_CURSOR, context);
 177     cmd->setDefaultKeySequence(QKeySequence(Qt::Key_F2));
 178     connect(followSymbolUnderCursorAction, SIGNAL(triggered()), this, SLOT(followSymbolUnderCursor()));
 179     contextMenu->addAction(cmd);
 180     qmlToolsMenu->addAction(cmd);
 181
 182     QAction *findUsagesAction = new QAction(tr("Find Usages"), this);
 183     cmd = am->registerAction(findUsagesAction, Constants::FIND_USAGES, context);
 184     cmd->setDefaultKeySequence(QKeySequence(tr("Ctrl+Shift+U")));
 185     connect(findUsagesAction, SIGNAL(triggered()), this, SLOT(findUsages()));
 186     contextMenu->addAction(cmd);
 187     qmlToolsMenu->addAction(cmd);
 188
 189     QAction *showQuickToolbar = new QAction(tr("Show Qt Quick Toolbar"), this);
 190     cmd = am->registerAction(showQuickToolbar, Constants::SHOW_QT_QUICK_HELPER, context);
 191 #ifdef Q_WS_MACX
 192     cmd->setDefaultKeySequence(QKeySequence(Qt::META + Qt::ALT + Qt::Key_Space));
 193 #else
 194     cmd->setDefaultKeySequence(QKeySequence(Qt::CTRL + Qt::ALT + Qt::Key_Space));
 195 #endif
 196     connect(showQuickToolbar, SIGNAL(triggered()), this, SLOT(showContextPane()));
 197     contextMenu->addAction(cmd);
 198     qmlToolsMenu->addAction(cmd);
 199
 200     // Insert marker for "Refactoring" menu:
 201     Core::Context globalContext(Core::Constants::C_GLOBAL);
 202     Core::Command *sep = createSeparator(am, this, globalContext,
 203                                          Constants::SEPARATOR1);
 204     sep->action()->setObjectName(Constants::M_REFACTORING_MENU_INSERTION_POINT);
 205     contextMenu->addAction(sep);
 206     contextMenu->addAction(createSeparator(am, this, globalContext,
 207                                            Constants::SEPARATOR2));
 208
 209     cmd = am->command(TextEditor::Constants::AUTO_INDENT_SELECTION);
 210     contextMenu->addAction(cmd);
 211
 212     cmd = am->command(TextEditor::Constants::UN_COMMENT_SELECTION);
 213     contextMenu->addAction(cmd);
 214
 215     CodeCompletion *completion = new CodeCompletion(m_modelManager);
 216     addAutoReleasedObject(completion);
 217
 218     addAutoReleasedObject(new HoverHandler);
 219
 220     // Set completion settings and keep them up to date
 221     TextEditor::TextEditorSettings *textEditorSettings = TextEditor::TextEditorSettings::instance();
 222     completion->setCompletionSettings(textEditorSettings->completionSettings());
 223     connect(textEditorSettings, SIGNAL(completionSettingsChanged(TextEditor::CompletionSettings)),
 224             completion, SLOT(setCompletionSettings(TextEditor::CompletionSettings)));
 225
 226     error_message->clear();
 227
 228     Core::FileIconProvider *iconProvider = Core::FileIconProvider::instance();
 229     iconProvider->registerIconOverlayForSuffix(QIcon(QLatin1String(":/qmljseditor/images/qmlfile.png")), "qml");
 230
 231     m_quickFixCollector = new QmlJSQuickFixCollector;
 232     addAutoReleasedObject(m_quickFixCollector);
 233     QmlJSQuickFixCollector::registerQuickFixes(this);
 234
 235     addAutoReleasedObject(new QmlJSOutlineWidgetFactory);
 236
 237     m_qmlTaskManager = new QmlTaskManager;
 238     addAutoReleasedObject(m_qmlTaskManager);
 239
 240     connect(m_modelManager, SIGNAL(documentChangedOnDisk(QmlJS::Document::Ptr)),
 241             m_qmlTaskManager, SLOT(documentChangedOnDisk(QmlJS::Document::Ptr)));
 242     connect(m_modelManager, SIGNAL(aboutToRemoveFiles(QStringList)),
 243             m_qmlTaskManager, SLOT(documentsRemoved(QStringList)));
 244
 245     addAutoReleasedObject(new QuickToolBar);
 246     addAutoReleasedObject(new Internal::QuickToolBarSettingsPage);
 247
 248     connect(core->editorManager(), SIGNAL(currentEditorChanged(Core::IEditor*)), SLOT(currentEditorChanged(Core::IEditor*)));
 249
 250     return true;
 251 }
 252
 253 void QmlJSEditorPlugin::extensionsInitialized()
 254 {
 255     ProjectExplorer::TaskHub *taskHub =
 256         ExtensionSystem::PluginManager::instance()->getObject<ProjectExplorer::TaskHub>();
 257     taskHub->addCategory(Constants::TASK_CATEGORY_QML, tr("QML"));
 258 }
 259
 260 ExtensionSystem::IPlugin::ShutdownFlag QmlJSEditorPlugin::aboutToShutdown()
 261 {
 262     delete QmlJS::Icons::instance(); // delete object held by singleton
 263
 264     return IPlugin::aboutToShutdown();
 265 }
 266
 267 void QmlJSEditorPlugin::initializeEditor(QmlJSEditor::QmlJSTextEditorWidget *editor)
 268 {
 269     QTC_ASSERT(m_instance, /**/);
 270
 271     m_actionHandler->setupActions(editor);
 272
 273     TextEditor::TextEditorSettings::instance()->initializeEditor(editor);
 274 }
 275
 276 void QmlJSEditorPlugin::followSymbolUnderCursor()
 277 {
 278     Core::EditorManager *em = Core::EditorManager::instance();
 279
 280     if (QmlJSTextEditorWidget *editor = qobject_cast<QmlJSTextEditorWidget*>(em->currentEditor()->widget()))
 281         editor->followSymbolUnderCursor();
 282 }
 283
 284 void QmlJSEditorPlugin::findUsages()
 285 {
 286     Core::EditorManager *em = Core::EditorManager::instance();
 287     if (QmlJSTextEditorWidget *editor = qobject_cast<QmlJSTextEditorWidget*>(em->currentEditor()->widget()))
 288         editor->findUsages();
 289 }
 290
 291 void QmlJSEditorPlugin::showContextPane()
 292 {
 293     Core::EditorManager *em = Core::EditorManager::instance();
 294
 295     if (QmlJSTextEditorWidget *editor = qobject_cast<QmlJSTextEditorWidget*>(em->currentEditor()->widget()))
 296         editor->showContextPane();
 297
 298 }
 299
 300 Core::Command *QmlJSEditorPlugin::addToolAction(QAction *a, Core::ActionManager *am,
 301                                           Core::Context &context, const QString &name,
 302                                           Core::ActionContainer *c1, const QString &keySequence)
 303 {
 304     Core::Command *command = am->registerAction(a, name, context);
 305     if (!keySequence.isEmpty())
 306         command->setDefaultKeySequence(QKeySequence(keySequence));
 307     c1->addAction(command);
 308     return command;
 309 }
 310
 311 QmlJSQuickFixCollector *QmlJSEditorPlugin::quickFixCollector() const
 312 { return m_quickFixCollector; }
 313
 314 void QmlJSEditorPlugin::quickFix(TextEditor::ITextEditor *editable)
 315 {
 316     m_currentTextEditable = editable;
 317     quickFixNow();
 318 }
 319
 320 void QmlJSEditorPlugin::quickFixNow()
 321 {
 322     if (! m_currentTextEditable)
 323         return;
 324
 325     Core::EditorManager *em = Core::EditorManager::instance();
 326     QmlJSTextEditorWidget *currentEditor = qobject_cast<QmlJSTextEditorWidget*>(em->currentEditor()->widget());
 327
 328     if (QmlJSTextEditorWidget *editor = qobject_cast<QmlJSTextEditorWidget*>(m_currentTextEditable->widget())) {
 329         if (currentEditor == editor) {
 330             if (editor->isOutdated()) {
 331                 // qDebug() << "TODO: outdated document" << editor->editorRevision() << editor->semanticInfo().revision();
 332                 // ### FIXME: m_quickFixTimer->start(QUICKFIX_INTERVAL);
 333                 m_quickFixTimer->stop();
 334             } else {
 335                 TextEditor::CompletionSupport::instance()
 336                     ->complete(m_currentTextEditable, TextEditor::QuickFixCompletion, true);
 337             }
 338         }
 339     }
 340 }
 341
 342 void QmlJSEditorPlugin::currentEditorChanged(Core::IEditor *editor)
 343 {
 344     if (! editor)
 345         return;
 346
 347     else if (QmlJSTextEditorWidget *textEditor = qobject_cast<QmlJSTextEditorWidget *>(editor->widget())) {
 348         textEditor->forceSemanticRehighlight();
 349     }
 350 }
 351
 352 Q_EXPORT_PLUGIN(QmlJSEditorPlugin)