vcsrevision.h

Go to the documentation of this file.

/* This file is part of KDevelop
 *
 * Copyright 2007 Andreas Pakulat <[email protected]>
 * Copyright 2007 Matthew Woehlke <[email protected]>
 *
 * 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.
 */
 
#ifndef KDEVPLATFORM_VCSREVISION_H
#define KDEVPLATFORM_VCSREVISION_H
 
#include "vcsexport.h"
#include <QVariant>
#include <QSharedDataPointer>
class QStringList;
class QString;
 
namespace KDevelop
{
 
class KDEVPLATFORMVCS_EXPORT VcsRevision
{
public:
 
    enum RevisionType
    {
        Special = 0         ,
        GlobalNumber = 1    ,
        FileNumber = 2      ,
        Date = 3,           
        Invalid = 4         ,
        UserType = 1000     
    };
    enum RevisionSpecialType
    {
        Head = 0                   ,
        Working = 1                ,
        Base = 2                   ,
        Previous = 3               ,
        Start = 4,                 
        UserSpecialType = 1000     
    };
 
    VcsRevision();
    virtual ~VcsRevision();
 
    VcsRevision( const VcsRevision& );
 
    VcsRevision& operator=( const VcsRevision& );
 
    void setRevisionValue( const QVariant& rev, RevisionType type );
 
    RevisionType revisionType() const;
 
    RevisionSpecialType specialType() const;
 
    QVariant revisionValue() const;
 
    QString prettyValue() const;
 
    bool operator==( const KDevelop::VcsRevision&) const;
 
    static VcsRevision createSpecialRevision( KDevelop::VcsRevision::RevisionSpecialType type );
protected:
    QStringList keys() const;
    QVariant value(const QString& key) const;
    void setValue( const QString& key, const QVariant& value );
 
    void setType( RevisionType t);
    void setSpecialType( RevisionSpecialType t);
    void setValue( const QVariant& );
 
 
private:
    QSharedDataPointer<class VcsRevisionPrivate> d;
};
 
KDEVPLATFORMVCS_EXPORT uint qHash( const KDevelop::VcsRevision& rev);
 
}
 
Q_DECLARE_METATYPE(KDevelop::VcsRevision)
Q_DECLARE_TYPEINFO(KDevelop::VcsRevision, Q_MOVABLE_TYPE);
Q_DECLARE_METATYPE(KDevelop::VcsRevision::RevisionSpecialType)
 
 
 
#endif