-cmake syntax highlighting, with the help from Daniel

Alex

Merge-request: 2164
Reviewed-by: dt <qtc-committer@nokia.com>

src/plugins/cmakeprojectmanager/cmakeeditor.cpp

@@ -0,0 +1,144 @@
+/**************************************************************************
+**
+** This file is part of Qt Creator
+**
+** Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies).
+**
+** Contact: Nokia Corporation (qt-info@nokia.com)
+**
+** Commercial Usage
+**
+** Licensees holding valid Qt Commercial licenses may use this file in
+** accordance with the Qt Commercial License Agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and Nokia.
+**
+** GNU Lesser General Public License Usage
+**
+** Alternatively, 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.
+**
+** If you are unsure which license is appropriate for your use, please
+** contact the sales department at http://qt.nokia.com/contact.
+**
+**************************************************************************/
+
+#include "cmakeeditor.h"
+
+#include "cmakehighlighter.h"
+#include "cmakeeditorfactory.h"
+#include "cmakeprojectconstants.h"
+
+#include <coreplugin/uniqueidmanager.h>
+#include <texteditor/fontsettings.h>
+#include <texteditor/texteditoractionhandler.h>
+#include <texteditor/texteditorconstants.h>
+#include <texteditor/texteditorsettings.h>
+
+#include <QtCore/QFileInfo>
+
+using namespace CMakeProjectManager;
+using namespace CMakeProjectManager::Internal;
+
+//
+// ProFileEditorEditable
+//
+
+CMakeEditorEditable::CMakeEditorEditable(CMakeEditor *editor)
+    : BaseTextEditorEditable(editor)
+{
+    Core::UniqueIDManager *uidm = Core::UniqueIDManager::instance();
+    m_context << uidm->uniqueIdentifier(CMakeProjectManager::Constants::C_CMAKEEDITOR);
+    m_context << uidm->uniqueIdentifier(TextEditor::Constants::C_TEXTEDITOR);
+//    m_contexts << uidm->uniqueIdentifier(Qt4ProjectManager::Constants::PROJECT_KIND);
+}
+
+QList<int> CMakeEditorEditable::context() const
+{
+    return m_context;
+}
+
+Core::IEditor *CMakeEditorEditable::duplicate(QWidget *parent)
+{
+    CMakeEditor *ret = new CMakeEditor(parent, qobject_cast<CMakeEditor*>(editor())->factory(),
+                                       qobject_cast<CMakeEditor*>(editor())->actionHandler());
+    ret->duplicateFrom(editor());
+    TextEditor::TextEditorSettings::instance()->initializeEditor(ret);
+    return ret->editableInterface();
+}
+
+QString CMakeEditorEditable::id() const
+{
+    return QLatin1String(CMakeProjectManager::Constants::CMAKE_EDITOR_ID);
+}
+
+//
+// CMakeEditor
+//
+
+CMakeEditor::CMakeEditor(QWidget *parent, CMakeEditorFactory *factory, TextEditor::TextEditorActionHandler *ah)
+    : BaseTextEditor(parent), m_factory(factory), m_ah(ah)
+{
+    CMakeDocument *doc = new CMakeDocument();
+    doc->setMimeType(QLatin1String(CMakeProjectManager::Constants::CMAKEMIMETYPE));
+    setBaseTextDocument(doc);
+
+    ah->setupActions(this);
+
+    baseTextDocument()->setSyntaxHighlighter(new CMakeHighlighter);
+}
+
+CMakeEditor::~CMakeEditor()
+{
+}
+
+TextEditor::BaseTextEditorEditable *CMakeEditor::createEditableInterface()
+{
+    return new CMakeEditorEditable(this);
+}
+
+void CMakeEditor::setFontSettings(const TextEditor::FontSettings &fs)
+{
+//     TextEditor::BaseTextEditor::setFontSettings(fs);
+//     return;
+   CMakeHighlighter *highlighter = qobject_cast<CMakeHighlighter*>(baseTextDocument()->syntaxHighlighter());
+   if (!highlighter)
+       return;
+
+   static QVector<QString> categories;
+   if (categories.isEmpty()) {
+       categories << QLatin1String(TextEditor::Constants::C_LABEL)  // variables
+                  << QLatin1String(TextEditor::Constants::C_LINK)   // functions
+                  << QLatin1String(TextEditor::Constants::C_COMMENT)
+                  << QLatin1String(TextEditor::Constants::C_STRING);
+   }
+
+   const QVector<QTextCharFormat> formats = fs.toTextCharFormats(categories);
+   highlighter->setFormats(formats.constBegin(), formats.constEnd());
+   highlighter->rehighlight();
+}
+
+//
+// ProFileDocument
+//
+
+CMakeDocument::CMakeDocument()
+    : TextEditor::BaseTextDocument()
+{
+}
+
+QString CMakeDocument::defaultPath() const
+{
+    QFileInfo fi(fileName());
+    return fi.absolutePath();
+}
+
+QString CMakeDocument::suggestedFileName() const
+{
+    QFileInfo fi(fileName());
+    return fi.fileName();
+}

src/plugins/cmakeprojectmanager/cmakeeditor.h

@@ -0,0 +1,104 @@
+/**************************************************************************
+**
+** This file is part of Qt Creator
+**
+** Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies).
+**
+** Contact: Nokia Corporation (qt-info@nokia.com)
+**
+** Commercial Usage
+**
+** Licensees holding valid Qt Commercial licenses may use this file in
+** accordance with the Qt Commercial License Agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and Nokia.
+**
+** GNU Lesser General Public License Usage
+**
+** Alternatively, 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.
+**
+** If you are unsure which license is appropriate for your use, please
+** contact the sales department at http://qt.nokia.com/contact.
+**
+**************************************************************************/
+
+#ifndef CMAKEEDITOR_H
+#define CMAKEEDITOR_H
+
+#include "cmakeeditorfactory.h"
+
+#include <texteditor/basetextdocument.h>
+#include <texteditor/basetexteditor.h>
+
+
+namespace TextEditor {
+class FontSettings;
+}
+
+namespace CMakeProjectManager {
+
+class CMakeManager;
+
+namespace Internal {
+
+class CMakeHighlighter;
+
+class CMakeEditor;
+
+class CMakeEditorEditable : public TextEditor::BaseTextEditorEditable
+{
+public:
+    CMakeEditorEditable(CMakeEditor *);
+    QList<int> context() const;
+
+    bool duplicateSupported() const { return true; }
+    Core::IEditor *duplicate(QWidget *parent);
+    QString id() const;
+    bool isTemporary() const { return false; }
+private:
+    QList<int> m_context;
+};
+
+class CMakeEditor : public TextEditor::BaseTextEditor
+{
+    Q_OBJECT
+
+public:
+    CMakeEditor(QWidget *parent, CMakeEditorFactory *factory, TextEditor::TextEditorActionHandler *ah);
+    ~CMakeEditor();
+
+    bool save(const QString &fileName = QString());
+
+
+    CMakeEditorFactory *factory() { return m_factory; }
+    TextEditor::TextEditorActionHandler *actionHandler() const { return m_ah; }
+protected:
+    TextEditor::BaseTextEditorEditable *createEditableInterface();
+
+public slots:
+    virtual void setFontSettings(const TextEditor::FontSettings &);
+
+private:
+    CMakeEditorFactory *m_factory;
+    TextEditor::TextEditorActionHandler *m_ah;
+};
+
+class CMakeDocument : public TextEditor::BaseTextDocument
+{
+    Q_OBJECT
+
+public:
+    CMakeDocument();
+    QString defaultPath() const;
+    QString suggestedFileName() const;
+};
+
+} // namespace Internal
+} // namespace Qt4ProjectManager
+
+#endif // CMAKEEDITOR_H

src/plugins/cmakeprojectmanager/cmakeeditorfactory.cpp

@@ -0,0 +1,78 @@
+/**************************************************************************
+**
+** This file is part of Qt Creator
+**
+** Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies).
+**
+** Contact: Nokia Corporation (qt-info@nokia.com)
+**
+** Commercial Usage
+**
+** Licensees holding valid Qt Commercial licenses may use this file in
+** accordance with the Qt Commercial License Agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and Nokia.
+**
+** GNU Lesser General Public License Usage
+**
+** Alternatively, 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.
+**
+** If you are unsure which license is appropriate for your use, please
+** contact the sales department at http://qt.nokia.com/contact.
+**
+**************************************************************************/
+
+#include "cmakeeditorfactory.h"
+#include "cmakeprojectconstants.h"
+#include "cmakeeditor.h"
+
+#include <coreplugin/editormanager/editormanager.h>
+#include <texteditor/texteditorsettings.h>
+
+using namespace CMakeProjectManager;
+using namespace CMakeProjectManager::Internal;
+
+CMakeEditorFactory::CMakeEditorFactory(CMakeManager *manager, TextEditor::TextEditorActionHandler *handler)
+    : m_mimeTypes(QStringList() << QLatin1String(CMakeProjectManager::Constants::CMAKEMIMETYPE)),
+      m_manager(manager),
+      m_actionHandler(handler)
+{
+
+}
+
+CMakeEditorFactory::~CMakeEditorFactory()
+{
+}
+
+QString CMakeEditorFactory::id() const
+{
+    return QLatin1String(CMakeProjectManager::Constants::CMAKE_EDITOR_ID);
+}
+
+QString CMakeEditorFactory::displayName() const
+{
+    return tr(CMakeProjectManager::Constants::CMAKE_EDITOR_DISPLAY_NAME);
+}
+
+Core::IFile *CMakeEditorFactory::open(const QString &fileName)
+{
+    Core::IEditor *iface = Core::EditorManager::instance()->openEditor(fileName, id());
+    return iface ? iface->file() : 0;
+}
+
+Core::IEditor *CMakeEditorFactory::createEditor(QWidget *parent)
+{
+    CMakeEditor *rc = new CMakeEditor(parent, this, m_actionHandler);
+    TextEditor::TextEditorSettings::instance()->initializeEditor(rc);
+    return rc->editableInterface();
+}
+
+QStringList CMakeEditorFactory::mimeTypes() const
+{
+    return m_mimeTypes;
+}

src/plugins/cmakeprojectmanager/cmakeeditorfactory.h

@@ -0,0 +1,73 @@
+/**************************************************************************
+**
+** This file is part of Qt Creator
+**
+** Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies).
+**
+** Contact: Nokia Corporation (qt-info@nokia.com)
+**
+** Commercial Usage
+**
+** Licensees holding valid Qt Commercial licenses may use this file in
+** accordance with the Qt Commercial License Agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and Nokia.
+**
+** GNU Lesser General Public License Usage
+**
+** Alternatively, 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.
+**
+** If you are unsure which license is appropriate for your use, please
+** contact the sales department at http://qt.nokia.com/contact.
+**
+**************************************************************************/
+
+#ifndef CMAKEEDITORFACTORY_H
+#define CMAKEEDITORFACTORY_H
+
+#include <coreplugin/editormanager/ieditorfactory.h>
+#include "cmakeprojectmanager.h"
+
+#include <QtCore/QStringList>
+
+QT_BEGIN_NAMESPACE
+class QAction;
+QT_END_NAMESPACE
+
+namespace TextEditor {
+class TextEditorActionHandler;
+}
+
+namespace CMakeProjectManager {
+
+namespace Internal {
+
+class CMakeEditorFactory : public Core::IEditorFactory
+{
+    Q_OBJECT
+
+public:
+    CMakeEditorFactory(CMakeManager *parent, TextEditor::TextEditorActionHandler *handler);
+    ~CMakeEditorFactory();
+
+    virtual QStringList mimeTypes() const;
+    virtual QString id() const;
+    virtual QString displayName() const;
+    Core::IFile *open(const QString &fileName);
+    Core::IEditor *createEditor(QWidget *parent);
+
+private:
+    const QStringList m_mimeTypes;
+    CMakeManager *m_manager;
+    TextEditor::TextEditorActionHandler *m_actionHandler;
+};
+
+} // namespace Internal
+} // namespace CMakeProjectManager
+
+#endif // CMAKEEDITORFACTORY_H

src/plugins/cmakeprojectmanager/cmakehighlighter.cpp

@@ -0,0 +1,151 @@
+/**************************************************************************
+**
+** This file is part of Qt Creator
+**
+** Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies).
+**
+** Contact: Nokia Corporation (qt-info@nokia.com)
+**
+** Commercial Usage
+**
+** Licensees holding valid Qt Commercial licenses may use this file in
+** accordance with the Qt Commercial License Agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and Nokia.
+**
+** GNU Lesser General Public License Usage
+**
+** Alternatively, 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.
+**
+** If you are unsure which license is appropriate for your use, please
+** contact the sales department at http://qt.nokia.com/contact.
+**
+**************************************************************************/
+
+#include "cmakehighlighter.h"
+
+#include <QtCore/QRegExp>
+#include <QtGui/QColor>
+#include <QtGui/QTextDocument>
+#include <QtGui/QTextEdit>
+
+using namespace CMakeProjectManager::Internal;
+
+
+static bool isVariable(const QString &word)
+{
+  if (word.length() < 4) { // must be at least "${.}"
+    return false;
+  }
+
+  return word.startsWith("${") && word.endsWith('}');
+}
+
+
+CMakeHighlighter::CMakeHighlighter(QTextDocument *document) :
+    QSyntaxHighlighter(document)
+{
+}
+
+
+void CMakeHighlighter::highlightBlock(const QString &text)
+{
+    QString buf;
+    bool inCommentMode = false;
+    bool inStringMode = (previousBlockState() == 1);
+
+    QTextCharFormat emptyFormat;
+    int i=0;
+    for (i=0; i < text.length(); i++) {
+        const QChar c = text.at(i);
+        if (inCommentMode) {
+            setFormat(i, 1, m_formats[CMakeCommentFormat]);
+        }
+        else {
+            if (c == '#') {
+                if (!inStringMode) {
+                    inCommentMode = true;
+                    setFormat(i, 1, m_formats[CMakeCommentFormat]);
+                    buf.clear();
+                }
+                else {
+                    buf += c;
+                }
+            }
+            else if (c == '(') {
+                if (!inStringMode) {
+                    if (!buf.isEmpty()) {
+                        setFormat(i - buf.length(), buf.length(), m_formats[CMakeFunctionFormat]);
+                    }
+                    buf.clear();
+                }
+                else {
+                  buf += c;
+                }
+            }
+            else if (c.isSpace()) {
+                if (!inStringMode) {
+                    buf.clear();
+                }
+                else {
+                    buf += c;
+                }
+            }
+            else if (c == '\"') {
+                buf += c;
+                if (inStringMode) {
+                    setFormat(i + 1 - buf.length(), buf.length(), m_formats[CMakeStringFormat]);
+                    buf.clear();
+                }
+                else {
+                    setFormat(i, 1, m_formats[CMakeStringFormat]);
+                }
+                inStringMode = !inStringMode;
+            }
+            else if (c == '\\') {
+                setFormat(i, 1, emptyFormat);
+                buf += c;
+                i++;
+                if (i < text.length()) {
+                    text.at(i);
+                    setFormat(i, 1, emptyFormat);
+                    buf += c;
+                }
+            }
+            else if (c == '$') {
+              if (inStringMode) {
+                  setFormat(i - buf.length(), buf.length(), m_formats[CMakeStringFormat]);
+              }
+              buf.clear();
+              buf += c;
+              setFormat(i, 1, emptyFormat);
+            }
+            else if (c == '}') {
+                buf += c;
+                if (isVariable(buf))
+                {
+                    setFormat(i + 1 - buf.length(), buf.length(), m_formats[CMakeVariableFormat]);
+                    buf.clear();
+                }
+            }
+            else {
+                buf += c;
+                setFormat(i, 1, emptyFormat);
+            }
+        }
+    }
+
+    if (inStringMode) {
+        setFormat(i - buf.length(), buf.length(), m_formats[CMakeStringFormat]);
+        setCurrentBlockState(1);
+    }
+    else {
+        setCurrentBlockState(0);
+    }
+}
+

src/plugins/cmakeprojectmanager/cmakehighlighter.h

@@ -0,0 +1,68 @@
+/**************************************************************************
+**
+** This file is part of Qt Creator
+**
+** Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies).
+**
+** Contact: Nokia Corporation (qt-info@nokia.com)
+**
+** Commercial Usage
+**
+** Licensees holding valid Qt Commercial licenses may use this file in
+** accordance with the Qt Commercial License Agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and Nokia.
+**
+** GNU Lesser General Public License Usage
+**
+** Alternatively, 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.
+**
+** If you are unsure which license is appropriate for your use, please
+** contact the sales department at http://qt.nokia.com/contact.
+**
+**************************************************************************/
+
+#ifndef CMAKEHIGHLIGHTER_H
+#define CMAKEHIGHLIGHTER_H
+
+#include <QtCore/QtAlgorithms>
+#include <QtGui/QSyntaxHighlighter>
+#include <QtGui/QTextCharFormat>
+
+namespace CMakeProjectManager {
+namespace Internal {
+
+class CMakeHighlighter : public QSyntaxHighlighter
+{
+    Q_OBJECT
+public:
+    enum CMakeFormats {
+        CMakeVariableFormat,
+        CMakeFunctionFormat,
+        CMakeCommentFormat,
+        CMakeStringFormat,
+        NumCMakeFormats
+    };
+
+    CMakeHighlighter(QTextDocument *document = 0);
+    virtual void highlightBlock(const QString &text);
+
+    // Set formats from a sequence of type QTextCharFormat
+    template <class InputIterator>
+        void setFormats(InputIterator begin, InputIterator end) {
+            qCopy(begin, end, m_formats);
+        }
+
+private:
+    QTextCharFormat m_formats[NumCMakeFormats];
+};
+
+} // namespace Internal
+} // namespace CMakeProjectManager
+
+#endif // PROFILEHIGHLIGHTER_H

src/plugins/cmakeprojectmanager/cmakeprojectconstants.h

@@ -35,7 +35,9 @@ namespace Constants {
 
 const char * const PROJECTCONTEXT = "CMakeProject.ProjectContext";
 const char * const CMAKEMIMETYPE  = "text/x-cmake"; // TOOD check that this is correct
-
+const char * const CMAKE_EDITOR_ID = "CMakeProject.CMakeEditor";
+const char * const CMAKE_EDITOR_DISPLAY_NAME = "CMake Editor";
+const char * const C_CMAKEEDITOR = "CMakeProject.Context.CMakeEditor";
 } // namespace Constants
 } // namespace CMakeProjectManager
 

src/plugins/cmakeprojectmanager/cmakeprojectmanager.pro

@@ -11,7 +11,10 @@ HEADERS = cmakeproject.h \
     makestep.h \
     cmakerunconfiguration.h \
     cmakeopenprojectwizard.h \
-    cmakebuildconfiguration.h
+    cmakebuildconfiguration.h \
+    cmakeeditorfactory.h \
+    cmakeeditor.h \
+    cmakehighlighter.h
 SOURCES = cmakeproject.cpp \
     cmakeprojectplugin.cpp \
     cmakeprojectmanager.cpp \
@@ -20,7 +23,10 @@ SOURCES = cmakeproject.cpp \
     makestep.cpp \
     cmakerunconfiguration.cpp \
     cmakeopenprojectwizard.cpp \
-    cmakebuildconfiguration.cpp
+    cmakebuildconfiguration.cpp \
+    cmakeeditorfactory.cpp \
+    cmakeeditor.cpp \
+    cmakehighlighter.cpp
 RESOURCES += cmakeproject.qrc
 FORMS +=
 

src/plugins/cmakeprojectmanager/cmakeprojectplugin.cpp

@@ -30,10 +30,13 @@
 #include "cmakeprojectplugin.h"
 #include "cmakeprojectmanager.h"
 #include "cmakerunconfiguration.h"
+#include "cmakeeditorfactory.h"
 #include "makestep.h"
+#include "cmakeprojectconstants.h"
 
 #include <coreplugin/icore.h>
 #include <coreplugin/mimedatabase.h>
+#include <texteditor/texteditoractionhandler.h>
 
 #include <QtCore/QtPlugin>
 #include <QtCore/QDebug>
@@ -56,9 +59,15 @@ bool CMakeProjectPlugin::initialize(const QStringList & /*arguments*/, QString *
         return false;
     CMakeSettingsPage *cmp = new CMakeSettingsPage();
     addAutoReleasedObject(cmp);
-    addAutoReleasedObject(new CMakeManager(cmp));
+    CMakeManager *manager = new CMakeManager(cmp);
+    addAutoReleasedObject(manager);
     addAutoReleasedObject(new MakeStepFactory);
     addAutoReleasedObject(new CMakeRunConfigurationFactory);
+    TextEditor::TextEditorActionHandler *editorHandler
+           = new TextEditor::TextEditorActionHandler(CMakeProjectManager::Constants::C_CMAKEEDITOR);
+
+    addAutoReleasedObject(new CMakeEditorFactory(manager, editorHandler));
+
     return true;
 }