Initial import

src/plugins/vcsbase/baseannotationhighlighter.h

@@ -0,0 +1,76 @@
+/***************************************************************************
+**
+** This file is part of Qt Creator
+**
+** Copyright (c) 2008 Nokia Corporation and/or its subsidiary(-ies).
+**
+** Contact:  Qt Software Information (qt-info@nokia.com)
+**
+** 
+** Non-Open Source Usage  
+** 
+** Licensees may use this file in accordance with the Qt Beta Version
+** License Agreement, Agreement version 2.2 provided with the Software or,
+** alternatively, in accordance with the terms contained in a written
+** agreement between you and Nokia.  
+** 
+** GNU General Public License Usage 
+** 
+** Alternatively, this file may be used under the terms of the GNU General
+** Public License versions 2.0 or 3.0 as published by the Free Software
+** Foundation and appearing in the file LICENSE.GPL included in the packaging
+** of this file.  Please review the following information to ensure GNU
+** General Public Licensing requirements will be met:
+**
+** http://www.fsf.org/licensing/licenses/info/GPLv2.html and
+** http://www.gnu.org/copyleft/gpl.html.
+**
+** In addition, as a special exception, Nokia gives you certain additional
+** rights. These rights are described in the Nokia Qt GPL Exception version
+** 1.2, included in the file GPL_EXCEPTION.txt in this package.  
+** 
+***************************************************************************/
+#ifndef BASEANNOTATIONHIGHLIGHTER_H
+#define BASEANNOTATIONHIGHLIGHTER_H
+
+#include "vcsbase_global.h"
+
+#include <QtCore/QMap>
+#include <QtCore/QSet>
+#include <QtGui/QSyntaxHighlighter>
+#include <QtGui/QTextCharFormat>
+
+namespace VCSBase {
+
+struct BaseAnnotationHighlighterPrivate;
+
+// Base for a highlighter for annotation lines of the form
+// 'changenumber:XXXX'. The change numbers are assigned a color gradient.
+// Example:
+// 112: text1 <color 1>
+// 113: text2 <color 2>
+// 112: text3 <color 1>
+class VCSBASE_EXPORT BaseAnnotationHighlighter : public QSyntaxHighlighter
+{
+    Q_OBJECT
+public:
+    typedef  QSet<QString> ChangeNumbers;
+
+    explicit BaseAnnotationHighlighter(const ChangeNumbers &changeNumbers,
+                                       QTextDocument *document = 0);
+    virtual ~BaseAnnotationHighlighter();
+
+    void setChangeNumbers(const ChangeNumbers &changeNumbers);
+
+    virtual void highlightBlock(const QString &text);
+
+private:
+    // Implement this to return the change number of a line
+    virtual QString changeNumber(const QString &block) const = 0;
+
+    BaseAnnotationHighlighterPrivate *m_d;
+};
+
+} //namespace Internal
+
+#endif