src/plugins/coreplugin/vcsmanager.h

   1 /**************************************************************************
   2 **
   3 ** This file is part of Qt Creator
   4 **
   5 ** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
   6 **
   7 ** Contact: Nokia Corporation (qt-info@nokia.com)
   8 **
   9 ** No Commercial Usage
  10 **
  11 ** This file contains pre-release code and may not be distributed.
  12 ** You may use this file in accordance with the terms and conditions
  13 ** contained in the Technology Preview License Agreement accompanying
  14 ** this package.
  15 **
  16 ** GNU Lesser General Public License Usage
  17 **
  18 ** Alternatively, this file may be used under the terms of the GNU Lesser
  19 ** General Public License version 2.1 as published by the Free Software
  20 ** Foundation and appearing in the file LICENSE.LGPL included in the
  21 ** packaging of this file.  Please review the following information to
  22 ** ensure the GNU Lesser General Public License version 2.1 requirements
  23 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  24 **
  25 ** In addition, as a special exception, Nokia gives you certain additional
  26 ** rights.  These rights are described in the Nokia Qt LGPL Exception
  27 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  28 **
  29 ** If you have questions regarding the use of this file, please contact
  30 ** Nokia at qt-info@nokia.com.
  31 **
  32 **************************************************************************/
  33
  34 #ifndef VCSMANAGER_H
  35 #define VCSMANAGER_H
  36
  37 #include "core_global.h"
  38
  39 #include <QtCore/QString>
  40 #include <QtCore/QObject>
  41
  42 QT_BEGIN_NAMESPACE
  43 class QDebug;
  44 QT_END_NAMESPACE
  45
  46 namespace Core {
  47
  48 class VcsManagerPrivate;
  49 class IVersionControl;
  50
  51 /* VcsManager:
  52  * 1) Provides functionality for finding the IVersionControl * for a given
  53  *    filename (findVersionControlForDirectory). Note that the VcsManager assumes
  54  *    that if a IVersionControl * manages a directory, then it also manages
  55  *    all the files and all the subdirectories.
  56  *    It works by asking all IVersionControl * if they manage the file, and ask
  57  *    for the topmost directory it manages. This information is cached and
  58  *    VCSManager thus knows pretty fast which IVersionControl * is responsible.
  59  * 2) Passes on the changes from the version controls caused by updating or
  60  *    branching repositories and routes them to its signals (repositoryChanged,
  61  *    filesChanged). */
  62
  63 class CORE_EXPORT VcsManager : public QObject
  64 {
  65     Q_OBJECT
  66 public:
  67     explicit VcsManager(QObject *parent = 0);
  68     virtual ~VcsManager();
  69
  70     void extensionsInitialized();
  71
  72     IVersionControl *findVersionControlForDirectory(const QString &directory,
  73                                                     QString *topLevelDirectory = 0);
  74     IVersionControl *checkout(const QString &versionControlType,
  75                               const QString &directory,
  76                               const QByteArray &url);
  77     // Used only by Trac plugin.
  78     bool findVersionControl(const QString &versionControl);
  79     // Used only by Trac plugin.
  80     QString repositoryUrl(const QString &directory);
  81
  82     // Shows a confirmation dialog, whether the file should also be deleted
  83     // from revision control Calls sccDelete on the file. Returns false
  84     // if a failure occurs
  85     bool promptToDelete(const QString &fileName);
  86     bool promptToDelete(IVersionControl *versionControl, const QString &fileName);
  87
  88     friend CORE_EXPORT QDebug operator<<(QDebug in, const VcsManager &);
  89
  90 signals:
  91     void repositoryChanged(const QString &repository);
  92
  93 private:
  94     VcsManagerPrivate *m_d;
  95 };
  96
  97 CORE_EXPORT QDebug operator<<(QDebug in, const VcsManager &);
  98
  99 } // namespace Core
 100
 101 #endif // VCSMANAGER_H