diffeditordocument.h 3.73 KB
Newer Older
1 2
/****************************************************************************
**
Eike Ziller's avatar
Eike Ziller committed
3 4
** Copyright (C) 2015 The Qt Company Ltd.
** Contact: http://www.qt.io/licensing
5 6 7 8 9 10 11
**
** 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
Eike Ziller's avatar
Eike Ziller committed
12 13
** a written agreement between you and The Qt Company.  For licensing terms and
** conditions see http://www.qt.io/terms-conditions.  For further information
Eike Ziller's avatar
Eike Ziller committed
14
** use the contact form at http://www.qt.io/contact-us.
15 16 17
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
Eike Ziller's avatar
Eike Ziller committed
18 19 20 21 22 23
** General Public License version 2.1 or version 3 as published by the Free
** Software Foundation and appearing in the file LICENSE.LGPLv21 and
** LICENSE.LGPLv3 included in the packaging of this file.  Please review the
** following information to ensure the GNU Lesser General Public License
** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
24
**
Eike Ziller's avatar
Eike Ziller committed
25 26
** In addition, as a special exception, The Qt Company gives you certain additional
** rights.  These rights are described in The Qt Company LGPL Exception
27 28 29 30
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
****************************************************************************/

31 32
#ifndef DIFFEDITORDOCUMENT_H
#define DIFFEDITORDOCUMENT_H
33

34 35
#include "diffutils.h"

36
#include <coreplugin/textdocument.h>
37

38 39
QT_FORWARD_DECLARE_CLASS(QMenu)

40 41
namespace DiffEditor {

42 43
class DiffEditorController;

44 45 46
namespace Internal {

class DiffEditorDocument : public Core::BaseTextDocument
47 48
{
    Q_OBJECT
49
    Q_PROPERTY(QString plainText READ plainText STORED false) // For access by code pasters
50
public:
51
    DiffEditorDocument();
52
    ~DiffEditorDocument();
53

jkobus's avatar
jkobus committed
54
    DiffEditorController *controller() const;
55

56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71
    QString makePatch(int fileIndex, int chunkIndex, bool revert, bool addPrefix = false) const;

    void setDiffFiles(const QList<FileData> &data, const QString &directory);
    QList<FileData> diffFiles() const;
    QString baseDirectory() const;

    void setDescription(const QString &description);
    QString description() const;

    void setContextLineCount(int lines);
    int contextLineCount() const;
    void forceContextLineCount(int lines);
    bool isContextLineCountForced() const;
    void setIgnoreWhitespace(bool ignore);
    bool ignoreWhitespace() const;

72
    bool setContents(const QByteArray &contents);
73
    QString defaultPath() const;
74
    QString suggestedFileName() const Q_DECL_OVERRIDE;
75

Jarek Kobus's avatar
Jarek Kobus committed
76
    bool isModified() const { return false; }
77
    bool isSaveAsAllowed() const { return true; }
78
    bool save(QString *errorString, const QString &fileName, bool autoSave);
79
    void reload();
80
    bool reload(QString *errorString, ReloadFlag flag, ChangeType type);
jkobus's avatar
jkobus committed
81
    bool open(QString *errorString, const QString &fileName);
82

83 84
    QString plainText() const;

85 86 87 88 89 90 91 92 93 94 95
signals:
    void temporaryStateChanged();
    void documentChanged();
    void descriptionChanged();
    void chunkActionsRequested(QMenu *menu, int diffFileIndex, int chunkIndex);
    void requestMoreInformation();

public slots:
    void beginReload();
    void endReload(bool success);

96
private:
97 98 99 100 101 102 103 104 105 106 107
    void setController(DiffEditorController *controller);

    DiffEditorController *m_controller;
    QList<FileData> m_diffFiles;
    QString m_baseDirectory;
    QString m_description;
    int m_contextLineCount;
    bool m_isContextLineCountForced;
    bool m_ignoreWhitespace;

    friend class ::DiffEditor::DiffEditorController;
108 109
};

110
} // namespace Internal
111 112
} // namespace DiffEditor

113
#endif // DIFFEDITORDOCUMENT_H