Git: Move submit highlighter to a separate file

Change-Id: I61e07b2abe3b1da1b56935bb3ce528a5f571705f
Reviewed-by: Tobias Hunger <tobias.hunger@digia.com>

src/plugins/git/git.pro

@@ -22,7 +22,8 @@ HEADERS += gitplugin.h \
     branchadddialog.h \
     logchangedialog.h \
     mergetool.h \
-    branchcheckoutdialog.h
+    branchcheckoutdialog.h \
+    githighlighters.h
 
 SOURCES += gitplugin.cpp \
     gitclient.cpp \
@@ -46,7 +47,8 @@ SOURCES += gitplugin.cpp \
     branchadddialog.cpp \
     logchangedialog.cpp \
     mergetool.cpp \
-    branchcheckoutdialog.cpp
+    branchcheckoutdialog.cpp \
+    githighlighters.cpp
 
 FORMS += settingspage.ui \
     gitsubmitpanel.ui \

src/plugins/git/git.qbs

@@ -42,6 +42,8 @@ QtcPlugin {
         "gitconstants.h",
         "giteditor.cpp",
         "giteditor.h",
+        "githighlighters.cpp",
+        "githighlighters.h",
         "gitplugin.cpp",
         "gitplugin.h",
         "gitsettings.cpp",

src/plugins/git/giteditor.cpp

@@ -35,11 +35,12 @@
 #include "gitsettings.h"
 #include "gitsubmiteditorwidget.h"
 #include "gitconstants.h"
+#include "githighlighters.h"
 
 #include <utils/qtcassert.h>
 #include <vcsbase/vcsbaseoutputwindow.h>
 #include <texteditor/basetextdocument.h>
-#include <QDebug>
+
 #include <QFileInfo>
 #include <QRegExp>
 #include <QSet>

src/plugins/git/githighlighters.cpp

@@ -0,0 +1,108 @@
+/****************************************************************************
+**
+** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
+** Contact: http://www.qt-project.org/legal
+**
+** This file is part of Qt Creator.
+**
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and Digia.  For licensing terms and
+** conditions see http://qt.digia.com/licensing.  For further information
+** use the contact form at http://qt.digia.com/contact-us.
+**
+** 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.
+**
+** In addition, as a special exception, Digia gives you certain additional
+** rights.  These rights are described in the Digia Qt LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+****************************************************************************/
+
+#include <texteditor/fontsettings.h>
+#include <texteditor/texteditorconstants.h>
+#include <texteditor/texteditorsettings.h>
+
+#include <utils/qtcassert.h>
+
+#include "githighlighters.h"
+
+namespace Git {
+namespace Internal {
+
+// Retrieve the comment char format from the text editor.
+static QTextCharFormat commentFormat()
+{
+    const TextEditor::FontSettings settings = TextEditor::TextEditorSettings::instance()->fontSettings();
+    return settings.toTextCharFormat(TextEditor::C_COMMENT);
+}
+
+GitSubmitHighlighter::GitSubmitHighlighter(QTextEdit * parent) :
+    TextEditor::SyntaxHighlighter(parent)
+{
+    initialize();
+}
+
+GitSubmitHighlighter::GitSubmitHighlighter(TextEditor::BaseTextDocument *parent) :
+    TextEditor::SyntaxHighlighter(parent)
+{
+    initialize();
+}
+
+void GitSubmitHighlighter::initialize()
+{
+    m_commentFormat = commentFormat();
+    m_keywordPattern.setPattern(QLatin1String("^[\\w-]+:"));
+    m_hashChar = QLatin1Char('#');
+    QTC_CHECK(m_keywordPattern.isValid());
+}
+
+void GitSubmitHighlighter::highlightBlock(const QString &text)
+{
+    // figure out current state
+    State state = static_cast<State>(previousBlockState());
+    if (text.isEmpty()) {
+        if (state == Header)
+            state = Other;
+        setCurrentBlockState(state);
+        return;
+    } else if (text.startsWith(m_hashChar)) {
+        setFormat(0, text.size(), m_commentFormat);
+        setCurrentBlockState(state);
+        return;
+    } else if (state == None) {
+        state = Header;
+    }
+
+    setCurrentBlockState(state);
+    // Apply format.
+    switch (state) {
+    case None:
+        break;
+    case Header: {
+        QTextCharFormat charFormat = format(0);
+        charFormat.setFontWeight(QFont::Bold);
+        setFormat(0, text.size(), charFormat);
+        break;
+    }
+    case Other:
+        // Format key words ("Task:") italic
+        if (m_keywordPattern.indexIn(text, 0, QRegExp::CaretAtZero) == 0) {
+            QTextCharFormat charFormat = format(0);
+            charFormat.setFontItalic(true);
+            setFormat(0, m_keywordPattern.matchedLength(), charFormat);
+        }
+        break;
+    }
+}
+
+} // namespace Internal
+} // namespace Git

src/plugins/git/githighlighters.h

@@ -0,0 +1,60 @@
+/****************************************************************************
+**
+** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
+** Contact: http://www.qt-project.org/legal
+**
+** This file is part of Qt Creator.
+**
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and Digia.  For licensing terms and
+** conditions see http://qt.digia.com/licensing.  For further information
+** use the contact form at http://qt.digia.com/contact-us.
+**
+** 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.
+**
+** In addition, as a special exception, Digia gives you certain additional
+** rights.  These rights are described in the Digia Qt LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+****************************************************************************/
+
+#ifndef GITHIGHLIGHTERS_H
+#define GITHIGHLIGHTERS_H
+
+#include <texteditor/syntaxhighlighter.h>
+#include <texteditor/texteditorconstants.h>
+
+namespace Git {
+namespace Internal {
+
+// Highlighter for git submit messages. Make the first line bold, indicates
+// comments as such (retrieving the format from the text editor) and marks up
+// keywords (words in front of a colon as in 'Task: <bla>').
+class GitSubmitHighlighter : public TextEditor::SyntaxHighlighter
+{
+public:
+    explicit GitSubmitHighlighter(QTextEdit *parent);
+    explicit GitSubmitHighlighter(TextEditor::BaseTextDocument *parent);
+    void highlightBlock(const QString &text);
+
+    void initialize();
+private:
+    enum State { None = -1, Header, Other };
+    QTextCharFormat m_commentFormat;
+    QRegExp m_keywordPattern;
+    QChar m_hashChar;
+};
+
+} // namespace Internal
+} // namespace Git
+
+#endif // GITHIGHLIGHTERS_H

src/plugins/git/gitsubmiteditorwidget.cpp

@@ -27,19 +27,14 @@
 **
 ****************************************************************************/
 
-#include "gitsubmiteditorwidget.h"
 #include "commitdata.h"
+#include "gitsubmiteditorwidget.h"
+#include "githighlighters.h"
 #include "logchangedialog.h"
 
-#include <texteditor/texteditorsettings.h>
-#include <texteditor/fontsettings.h>
-#include <utils/qtcassert.h>
-
 #include <QRegExpValidator>
-#include <QSyntaxHighlighter>
 #include <QTextEdit>
 
-#include <QDebug>
 #include <QDir>
 #include <QGroupBox>
 #include <QRegExp>
@@ -48,72 +43,6 @@
 namespace Git {
 namespace Internal {
 
-// Retrieve the comment char format from the text editor.
-static QTextCharFormat commentFormat()
-{
-    const TextEditor::FontSettings settings = TextEditor::TextEditorSettings::instance()->fontSettings();
-    return settings.toTextCharFormat(TextEditor::C_COMMENT);
-}
-
-GitSubmitHighlighter::GitSubmitHighlighter(QTextEdit * parent) :
-    TextEditor::SyntaxHighlighter(parent)
-{
-    initialize();
-}
-
-GitSubmitHighlighter::GitSubmitHighlighter(TextEditor::BaseTextDocument *parent) :
-    TextEditor::SyntaxHighlighter(parent)
-{
-    initialize();
-}
-
-void GitSubmitHighlighter::initialize()
-{
-    m_commentFormat = commentFormat();
-    m_keywordPattern.setPattern(QLatin1String("^[\\w-]+:"));
-    m_hashChar = QLatin1Char('#');
-    QTC_CHECK(m_keywordPattern.isValid());
-}
-
-void GitSubmitHighlighter::highlightBlock(const QString &text)
-{
-    // figure out current state
-    State state = static_cast<State>(previousBlockState());
-    if (text.isEmpty()) {
-        if (state == Header)
-            state = Other;
-        setCurrentBlockState(state);
-        return;
-    } else if (text.startsWith(m_hashChar)) {
-        setFormat(0, text.size(), m_commentFormat);
-        setCurrentBlockState(state);
-        return;
-    } else if (state == None) {
-        state = Header;
-    }
-
-    setCurrentBlockState(state);
-    // Apply format.
-    switch (state) {
-    case None:
-        break;
-    case Header: {
-        QTextCharFormat charFormat = format(0);
-        charFormat.setFontWeight(QFont::Bold);
-        setFormat(0, text.size(), charFormat);
-        break;
-    }
-    case Other:
-        // Format key words ("Task:") italic
-        if (m_keywordPattern.indexIn(text, 0, QRegExp::CaretAtZero) == 0) {
-            QTextCharFormat charFormat = format(0);
-            charFormat.setFontItalic(true);
-            setFormat(0, m_keywordPattern.matchedLength(), charFormat);
-        }
-        break;
-    }
-}
-
 // ------------------
 GitSubmitEditorWidget::GitSubmitEditorWidget(QWidget *parent) :
     VcsBase::SubmitEditorWidget(parent),

src/plugins/git/gitsubmiteditorwidget.h

@@ -93,25 +93,6 @@ private:
     bool m_isInitialized;
 };
 
-// Highlighter for git submit messages. Make the first line bold, indicates
-// comments as such (retrieving the format from the text editor) and marks up
-// keywords (words in front of a colon as in 'Task: <bla>').
-
-class GitSubmitHighlighter : public TextEditor::SyntaxHighlighter
-{
-public:
-    explicit GitSubmitHighlighter(QTextEdit *parent);
-    explicit GitSubmitHighlighter(TextEditor::BaseTextDocument *parent);
-    void highlightBlock(const QString &text);
-
-    void initialize();
-private:
-    enum State { None = -1, Header, Other };
-    QTextCharFormat m_commentFormat;
-    QRegExp m_keywordPattern;
-    QChar m_hashChar;
-};
-
 } // namespace Internal
 } // namespace Git