vcsdiff.h 4.34 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21
/* This file is part of KDevelop
 *
 * Copyright 2007 Andreas Pakulat <apaku@gmx.de>
 * Copyright 2007 Matthew Woehlke <mw_triad@users.sourceforge.net>
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
 * 02110-1301, USA.
 */

22 23
#ifndef KDEVPLATFORM_VCSDIFF_H
#define KDEVPLATFORM_VCSDIFF_H
24

25
//Needed first as it provides a hash-function for QHash
26
#include "vcslocation.h"
27

28
#include <QHash>
29

30 31
#include "vcsexport.h"

32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47
class QString;
class QByteArray;

namespace KDevelop
{

class KDEVPLATFORMVCS_EXPORT VcsDiff
{
public:
    /**
     * Specify the type of difference the diff() method should create. Note that a
     * request for DiffUnified may not be honored, e.g. if the items being diffed are
     * binary rather than text.
     */
    enum Type
    {
48 49 50
        DiffRaw         /**< Request complete copies of both items. */,
        DiffUnified     /**< Request copy of first item with diff. */,
        DiffDontCare    /**< Don't care; plugin will return whichever is easiest. */
51 52 53 54
    };

    enum Content
    {
55 56
        Binary          /**< Binary diff, using the full content of both files.*/,
        Text            /**< Textual diff.*/
57 58 59
    };

    VcsDiff();
60
    virtual ~VcsDiff();
61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76
    VcsDiff( const VcsDiff& );

    /**
     * @returns the type of diff, i.e. raw or unified
     */
    Type type() const;

    /**
     * @returns the content type, i.e. binary or text
     */
    Content contentType() const;

    /**
     * @returns the binary content of the first file of the difference or
     * an empty QByteArray if this is a textual diff
     */
77
    QHash<KDevelop::VcsLocation, QByteArray> leftBinaries() const;
78 79 80 81 82

    /**
     * @returns the binary content of the second file of the difference or
     * an empty QByteArray if this is a textual diff
     */
83
    QHash<KDevelop::VcsLocation, QByteArray> rightBinaries() const;
84 85 86 87 88

    /**
     * @returns the textual content of the first file of the difference or
     * an empty QString if this is a binary diff
     */
89
    QHash<KDevelop::VcsLocation, QString> leftTexts() const;
90 91 92 93 94

    /**
     * @returns the textual content of the second file of the difference or
     * an empty QString if this is a unified or binary diff
     */
95
    QHash<KDevelop::VcsLocation, QString> rightTexts() const;
96 97 98 99 100 101 102

    /**
     * @returns the difference between the first and the second file in
     * unified diff format or an empty QString if this is a binary diff
     * or a textual diff using raw format
     */
    QString diff() const;
103 104
    
    /** @returns the base directory of the diff. */
Milian Wolff's avatar
Milian Wolff committed
105
    QUrl baseDiff() const;
106 107 108 109 110 111 112

	/**
	 * Depth - number of directories to left-strip from paths in the patch - see "patch -p"
     * Defaults to 0
	 */
    uint depth() const;

113
    /** Sets the base directory of the diff to the @p url */
114
    void setBaseDiff(const QUrl& url);
115
    /** Sets the depth of the diff to @p depth */
116
    void setDepth(const uint depth);
117 118

    void setDiff( const QString& );
119 120 121 122 123 124 125 126 127 128
    void addLeftBinary( const KDevelop::VcsLocation&, const QByteArray& );
    void removeLeftBinary( const KDevelop::VcsLocation& );
    void addRightBinary( const KDevelop::VcsLocation&, const QByteArray& );
    void removeRightBinary( const KDevelop::VcsLocation& );

    void addLeftText( const KDevelop::VcsLocation&, const QString& );
    void removeLeftText( const KDevelop::VcsLocation& );
    void addRightText( const KDevelop::VcsLocation&, const QString& );
    void removeRightText( const KDevelop::VcsLocation& );

129 130 131
    void setType( Type );
    void setContentType( Content );
    VcsDiff& operator=( const VcsDiff& rhs);
132 133 134
    
    /** @returns whether there are not changes on the diff */
    bool isEmpty() const;
135
    
136
private:
137
    const QScopedPointer<class VcsDiffPrivate> d;
138 139 140 141 142 143 144 145
};

}

Q_DECLARE_METATYPE( KDevelop::VcsDiff )

#endif