kdevversioncontrol.h

Go to the documentation of this file.

/* This file is part of the KDE project
   Copyright (C) 2001 Matthias Hoelzer-Kluepfel <hoelzer@kde.org>
   Copyright (C) 2002-2003 Roberto Raggi <roberto@kdevelop.org>
   Copyright (C) 2002 Simon Hausmann <hausmann@kde.org>
   Copyright (C) 2003 Mario Scalas <mario.scalas@libero.it>
   Copyright (C) 2004 Alexander Dymo <adymo@kdevelop.org>
 
   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Library General Public
   License as published by the Free Software Foundation; either
   version 2 of the License, or (at your option) any later version.
 
   This library 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
   Library General Public License for more details.
 
   You should have received a copy of the GNU Library General Public License
   along with this library; see the file COPYING.LIB.  If not, write to
   the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
   Boston, MA 02110-1301, USA.
*/
#ifndef KDEVVERSIONCONTROL_H
#define KDEVVERSIONCONTROL_H
 
#include <tqobject.h>
#include <tqstring.h>
#include <tqwidget.h>
#include <tqmap.h>
#include <tqvaluelist.h>
 
#include <kdevplugin.h>


struct VCSFileInfo
{
    enum FileState {
        Unknown        ,
        Added          ,
        Uptodate       ,
        Modified       ,
        Conflict       ,
        Sticky         ,
        NeedsPatch     ,
        NeedsCheckout  ,
        Directory       ,
        Deleted         ,
        Replaced       
    };

    VCSFileInfo() {}
    VCSFileInfo( TQString fn, TQString workRev, TQString repoRev, FileState aState )
        : fileName(fn), workRevision(workRev), repoRevision(repoRev), state(aState) {}

    TQString fileName;   // Yeah, _just_ the file name ;-)
    TQString workRevision;
    TQString repoRevision;
    FileState state;

    TQString toString() const
    {
        return "(" + fileName + ", " + workRevision + ", " + repoRevision + ", " + state2String( state ) + ")";
    }

    static TQString state2String( FileState state )
    {
        switch (state)
        {
            case Added: return "added";
            case Uptodate: return "up-to-date";
            case Modified: return "modified";
            case Conflict: return "conflict";
            case Sticky: return "sticky";
            case NeedsPatch: return "needs patch";
            case NeedsCheckout: return "needs check-out";
            case Directory: return "directory";
            case Deleted: return "deleted";
            case Replaced: return "replaced";
            case Unknown:
            default:
                return "unknown";
        }
    }
 
};

typedef TQMap<TQString,VCSFileInfo> VCSFileInfoMap;
 
class KDevVCSFileInfoProvider;
 

class KDevVersionControl: public KDevPlugin
{
    TQ_OBJECT
  
 
public:
    KDevVersionControl(const KDevPluginInfo *info, TQObject *parent, const char *name )
        :KDevPlugin(info, parent, name ) {}

    virtual void createNewProject(const TQString& dir) = 0;

    virtual bool fetchFromRepository() = 0;

    virtual KDevVCSFileInfoProvider *fileInfoProvider() const = 0;

    virtual bool isValidDirectory(const TQString &dirPath) const = 0;
 
 
signals:
    void finishedFetching(TQString destinationDir);
 
};

class KDevVCSFileInfoProvider: public TQObject
{
    TQ_OBJECT
  
public:
    KDevVCSFileInfoProvider(KDevVersionControl *parent, const char *name)
        : TQObject( parent, name ), m_owner(parent) {}

    virtual const VCSFileInfoMap *status(const TQString &dirPath) = 0;

    virtual bool requestStatus( const TQString &dirPath, void *callerData, bool recursive = true, bool checkRepos = true ) = 0;
 
signals:
    void statusReady(const VCSFileInfoMap &fileInfoMap, void *callerData);
 
protected:
    KDevVersionControl *owner() const { return m_owner; }
 
private:
    KDevVersionControl *m_owner;
 
private:
    KDevVCSFileInfoProvider( const KDevVCSFileInfoProvider & );
    KDevVCSFileInfoProvider &operator=( const KDevVCSFileInfoProvider & );
};
 
#endif