src/plugins/vcsbase/diffhighlighter.h

   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 (info@qt.nokia.com)
   8 **
   9 **
  10 ** GNU Lesser General Public License Usage
  11 **
  12 ** This file may be used under the terms of the GNU Lesser General Public
  13 ** License version 2.1 as published by the Free Software Foundation and
  14 ** appearing in the file LICENSE.LGPL included in the packaging of this file.
  15 ** Please review the following information to ensure the GNU Lesser General
  16 ** Public License version 2.1 requirements will be met:
  17 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  18 **
  19 ** In addition, as a special exception, Nokia gives you certain additional
  20 ** rights. These rights are described in the Nokia Qt LGPL Exception
  21 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  22 **
  23 ** Other Usage
  24 **
  25 ** Alternatively, this file may be used in accordance with the terms and
  26 ** conditions contained in a signed written agreement between you and Nokia.
  27 **
  28 ** If you have questions regarding the use of this file, please contact
  29 ** Nokia at qt-info@nokia.com.
  30 **
  31 **************************************************************************/
  32
  33 #ifndef DIFFHIGHLIGHTER_H
  34 #define DIFFHIGHLIGHTER_H
  35
  36 #include "vcsbase_global.h"
  37
  38 #include <texteditor/syntaxhighlighter.h>
  39
  40 QT_BEGIN_NAMESPACE
  41 class QRegExp;
  42 class QTextCharFormat;
  43 QT_END_NAMESPACE
  44
  45 namespace Core {
  46     class ICore;
  47 }
  48 namespace TextEditor {
  49     class FontSettingsPage;
  50 }
  51
  52 namespace VCSBase {
  53
  54 namespace Internal {
  55 class DiffHighlighterPrivate;
  56 } // namespace Internal
  57
  58 /* A highlighter for diffs. Parametrizable by the file indicator,
  59  *  which is for example '^====' in case of p4:
  60  * \code
  61    ==== //depot/research/main/qdynamicmainwindow3/qdynamicdockwidgetlayout_p.h#34 (text) ====
  62  * \endcode
  63  * Or  '--- a/|'+++ b/' in case of git:
  64  * \code
  65    diff --git a/src/plugins/plugins.pro b/src/plugins/plugins.pro
  66    index 9401ee7..ef35c3b 100644
  67    --- a/src/plugins/plugins.pro
  68    +++ b/src/plugins/plugins.pro
  69    @@ -10,6 +10,7 @@ SUBDIRS   = plugin_coreplugin \
  70  * \endcode
  71  * */
  72
  73 class VCSBASE_EXPORT DiffHighlighter : public TextEditor::SyntaxHighlighter
  74 {
  75     Q_OBJECT
  76 public:
  77     explicit DiffHighlighter(const QRegExp &filePattern,
  78                              QTextDocument *document = 0);
  79     virtual ~DiffHighlighter();
  80
  81     virtual void highlightBlock(const QString &text);
  82
  83     // Set formats from a sequence of type QTextCharFormat
  84     void setFormats(const QVector<QTextCharFormat> &s);
  85
  86     QRegExp filePattern() const;
  87
  88 private:
  89     Internal::DiffHighlighterPrivate *m_d;
  90 };
  91
  92 } // namespace VCSBase
  93
  94 #endif // DIFFHIGHLIGHTER_H