Initial import

src/plugins/vcsbase/vcsbaseeditor.h

@@ -0,0 +1,173 @@
+/***************************************************************************
+**
+** 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 VCSBaseBASEEDITOR_H
+#define VCSBaseBASEEDITOR_H
+
+#include "vcsbase_global.h"
+
+#include <texteditor/basetexteditor.h>
+
+#include <QtCore/QSet>
+
+QT_BEGIN_NAMESPACE
+class QAction;
+class QTextCodec;
+class QTextCursor;
+QT_END_NAMESPACE
+
+namespace Core {
+class ICore;
+}
+
+namespace VCSBase {
+
+struct VCSBaseEditorPrivate;
+class DiffHighlighter;
+class BaseAnnotationHighlighter;
+
+// Contents of a VCSBaseEditor
+enum EditorContentType {
+    // No special handling.
+    RegularCommandOutput,
+    // Log of a file under revision control. Provide  'click on change'
+    // description.
+    LogOutput,
+    // <change description>: file line
+    // Color per change number and provide 'click on change' description.
+    AnnotateOutput,
+    // Diff output. Might includes describe output, which consists of a
+    // header and diffs. Interaction is 'double click in  hunk' which
+    // opens the file
+    DiffOutput
+};
+
+// Helper struct used to parametrize an editor with mime type, context
+// and kind. The extension is currently only a suggestion when running
+// VCS commands with redirection.
+struct VCSBASE_EXPORT VCSBaseEditorParameters {
+    EditorContentType type;
+    const char *kind;
+    const char *context;
+    const char *mimeType;
+    const char *extension;
+};
+
+// Base class for editors showing version control system output
+// of the type enumerated by EditorContentType.
+// The source property should contain the file or directory the log
+// refers to and will be emitted with describeRequested().
+// This is for VCS that need a current directory.
+class VCSBASE_EXPORT VCSBaseEditor : public TextEditor::BaseTextEditor
+{
+    Q_PROPERTY(QString source READ source WRITE setSource);
+    Q_PROPERTY(QTextCodec *codec READ codec WRITE setCodec);
+    Q_OBJECT
+protected:
+    // Initialization requires calling init() (which in turns calls
+    // virtual functions).
+    explicit VCSBaseEditor(const VCSBaseEditorParameters *type,
+                           QWidget *parent);
+public:
+    void init();
+
+    virtual ~VCSBaseEditor();
+
+    QString source() const;
+    void setSource(const  QString &source);
+
+    QTextCodec *codec() const;
+    void setCodec(QTextCodec *);
+
+    bool isModified() const;
+
+    EditorContentType contentType() const;
+
+    // Utility to find a parameter set by type in an array.
+    static  const VCSBaseEditorParameters *
+        findType(const VCSBaseEditorParameters *array, int arraySize, EditorContentType et);
+
+    // Utility to find the codec for a source (file or directory), querying
+    // the editor manager and the project managers (defaults to system codec).
+    // The codec should be set on editors displaying diff or annotation
+    // output.
+    static QTextCodec *getCodec(const Core::ICore *core, const QString &source);
+
+    // Utility to return the editor from the IEditor returned by the editor
+    // manager which is a BaseTextEditable.
+    static VCSBaseEditor *getVcsBaseEditor(const Core::IEditor *editor);
+
+signals:
+    void describeRequested(const QString &source, const QString &change);
+
+public slots:
+    // Convenience slot to set data read from stdout, will use the
+    // documents' codec to decode
+    void setPlainTextData(const QByteArray &data);
+
+protected:
+    virtual TextEditor::BaseTextEditorEditable *createEditableInterface();
+
+    void contextMenuEvent(QContextMenuEvent *e);
+    void mouseMoveEvent(QMouseEvent *e);
+    void mouseReleaseEvent(QMouseEvent *e);
+    void mouseDoubleClickEvent(QMouseEvent *e);
+    void keyPressEvent(QKeyEvent *);
+
+public slots:
+    void setFontSettings(const TextEditor::FontSettings &);
+
+private slots:
+    void describe();
+    void slotActivateAnnotation();
+
+private:
+    // Implement to return a set of change identifiers in
+    // annotation mode
+    virtual QSet<QString> annotationChanges() const = 0;
+    // Implement to identify a change number at the cursor position
+    virtual QString changeUnderCursor(const QTextCursor &) const = 0;
+    // Factory functions for highlighters
+    virtual DiffHighlighter *createDiffHighlighter() const = 0;
+    virtual BaseAnnotationHighlighter *createAnnotationHighlighter(const QSet<QString> &changes) const = 0;
+    // Implement to return a local file name from the diff file specification
+    // (text cursor at position above change hunk)
+    virtual QString fileNameFromDiffSpecification(const QTextBlock &diffFileSpec) const = 0;
+
+    void jumpToChangeFromDiff(QTextCursor cursor);
+
+    VCSBaseEditorPrivate *m_d;
+};
+
+} // namespace Internal
+
+#endif // VCSBaseBASEEDITOR_H