ground/openpilotgcs/src/plugins/coreplugin/iversioncontrol.h

   1 /**
   2  ******************************************************************************
   3  *
   4  * @file       iversioncontrol.h
   5  * @author     The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010.
   6  *             Parts by Nokia Corporation (qt-info@nokia.com) Copyright (C) 2009.
   7  * @addtogroup GCSPlugins GCS Plugins
   8  * @{
   9  * @addtogroup CorePlugin Core Plugin
  10  * @{
  11  * @brief The Core GCS plugin
  12  *****************************************************************************/
  13 /*
  14  * This program is free software; you can redistribute it and/or modify
  15  * it under the terms of the GNU General Public License as published by
  16  * the Free Software Foundation; either version 3 of the License, or
  17  * (at your option) any later version.
  18  *
  19  * This program is distributed in the hope that it will be useful, but
  20  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  21  * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
  22  * for more details.
  23  *
  24  * You should have received a copy of the GNU General Public License along
  25  * with this program; if not, write to the Free Software Foundation, Inc.,
  26  * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  27  */
  28
  29 #ifndef IVERSIONCONTROL_H
  30 #define IVERSIONCONTROL_H
  31
  32 #include "core_global.h"
  33
  34 #include <QtCore/QObject>
  35 #include <QtCore/QString>
  36
  37 namespace Core {
  38 class CORE_EXPORT IVersionControl : public QObject {
  39     Q_OBJECT
  40 public:
  41     enum Operation { AddOperation, DeleteOperation, OpenOperation };
  42
  43     IVersionControl(QObject *parent = 0) : QObject(parent) {}
  44     virtual ~IVersionControl() {}
  45
  46     virtual QString name() const   = 0;
  47
  48     virtual bool isEnabled() const = 0;
  49
  50     /*!
  51      * Enable the VCS, that is, make its menu actions visible.
  52      */
  53     virtual void setEnabled(bool enabled) = 0;
  54
  55     /*!
  56      * Returns whether files in this directory should be managed with this
  57      * version control.
  58      */
  59     virtual bool managesDirectory(const QString &filename) const = 0;
  60
  61     /*!
  62      * This function should return the topmost directory, for which this
  63      * IVersionControl should be used. The VCSManager assumes that all files in
  64      * the returned directory are managed by the same IVersionControl.
  65      *
  66      * Note that this is used as an optimization, so that the VCSManager
  67      * doesn't need to call managesDirectory(..) for each directory.
  68      *
  69      * This function is called after finding out that the directory is managed
  70      * by a specific version control.
  71      */
  72     virtual QString findTopLevelForDirectory(const QString &directory) const = 0;
  73
  74     /*!
  75      * Called to query whether a VCS supports the respective operations.
  76      */
  77     virtual bool supportsOperation(Operation operation) const = 0;
  78
  79     /*!
  80      * Called prior to save, if the file is read only. Should be implemented if
  81      * the scc requires a operation before editing the file, e.g. 'p4 edit'
  82      *
  83      * \note The EditorManager calls this for the editors.
  84      */
  85     virtual bool vcsOpen(const QString &fileName)   = 0;
  86
  87     /*!
  88      * Called after a file has been added to a project If the version control
  89      * needs to know which files it needs to track you should reimplement this
  90      * function, e.g. 'p4 add', 'cvs add', 'svn add'.
  91      *
  92      * \note This function should be called from IProject subclasses after
  93      *       files are added to the project.
  94      */
  95     virtual bool vcsAdd(const QString &filename)    = 0;
  96
  97     /*!
  98      * Called after a file has been removed from the project (if the user
  99      * wants), e.g. 'p4 delete', 'svn delete'.
 100      *
 101      * You probably want to call VcsManager::showDeleteDialog, which asks the
 102      * user to confirm the deletion.
 103      */
 104     virtual bool vcsDelete(const QString &filename) = 0;
 105
 106 signals:
 107     void repositoryChanged(const QString &repository);
 108     void filesChanged(const QStringList &files);
 109
 110     // TODO: ADD A WAY TO DETECT WHETHER A FILE IS MANAGED, e.g
 111     // virtual bool sccManaged(const QString &filename) = 0;
 112 };
 113 } // namespace Core
 114
 115 #endif // IVERSIONCONTROL_H