src/revisioncontrolplugin.h

   1 /***************************************************************************
   2  *   Copyright (C) 2009 by Peter Penz <peter.penz@gmx.at>                  *
   3  *                                                                         *
   4  *   This program is free software; you can redistribute it and/or modify  *
   5  *   it under the terms of the GNU General Public License as published by  *
   6  *   the Free Software Foundation; either version 2 of the License, or     *
   7  *   (at your option) any later version.                                   *
   8  *                                                                         *
   9  *   This program is distributed in the hope that it will be useful,       *
  10  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  11  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  12  *   GNU General Public License for more details.                          *
  13  *                                                                         *
  14  *   You should have received a copy of the GNU General Public License     *
  15  *   along with this program; if not, write to the                         *
  16  *   Free Software Foundation, Inc.,                                       *
  17  *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA            *
  18  ***************************************************************************/
  19
  20 #ifndef REVISIONCONTROLPLUGIN_H
  21 #define REVISIONCONTROLPLUGIN_H
  22
  23 #include <libdolphin_export.h>
  24
  25 #include <QString>
  26
  27 /**
  28  * @brief Base class for revision control plugins.
  29  *
  30  * Enables the file manager to show the revision state
  31  * of a revisioned file.
  32  */
  33 class LIBDOLPHINPRIVATE_EXPORT RevisionControlPlugin
  34 {
  35 public:
  36     enum RevisionState
  37     {
  38         LocalRevision,
  39         LatestRevision
  40         // TODO...
  41     };
  42
  43     enum ItemType
  44     {
  45         Directory,
  46         File
  47     };
  48
  49     RevisionControlPlugin();
  50     virtual ~RevisionControlPlugin();
  51
  52     /**
  53      * Returns the name of the file which stores
  54      * the revision control informations.
  55      * (e. g. .svn, .cvs, .git).
  56      */
  57     virtual QString fileName() const = 0;
  58
  59     /**
  60      * Is invoked whenever the revision control
  61      * information will get retrieved for the directory
  62      * \p directory. It is assured that the directory
  63      * contains a trailing slash.
  64      */
  65     virtual bool beginRetrieval(const QString& directory) = 0;
  66
  67     /**
  68      * Is invoked after the revision control information has been
  69      * received. It is assured that
  70      * RevisionControlPlugin::beginInfoRetrieval() has been
  71      * invoked before.
  72      */
  73     virtual void endRetrieval() = 0;
  74
  75     /**
  76      * Returns the revision state for the file with the name \p fileName.
  77      * It is assured that RevisionControlPlugin::beginInfoRetrieval() has been
  78      * invoked before and that the file is part of the directory specified
  79      * in beginInfoRetrieval().
  80      */
  81     virtual RevisionState revisionState(const QString& name, ItemType type) = 0;
  82
  83 };
  84
  85
  86
  87
  88 // TODO: This is just a temporary test class. It will be made available as
  89 // plugin outside Dolphin later.
  90
  91 #include <QFileInfoList>
  92 #include <QHash>
  93
  94 class LIBDOLPHINPRIVATE_EXPORT SubversionPlugin : public RevisionControlPlugin
  95 {
  96 public:
  97     SubversionPlugin();
  98     virtual ~SubversionPlugin();
  99     virtual QString fileName() const;
 100     virtual bool beginRetrieval(const QString& directory);
 101     virtual void endRetrieval();
 102     virtual RevisionControlPlugin::RevisionState revisionState(const QString& name, ItemType type);
 103
 104 private:
 105     QString m_directory;
 106     QHash<QString, QFileInfo> m_fileInfoHash;
 107 };
 108 #endif // REVISIONCONTROLPLUGIN_H
 109