src/plugins/vcsbase/checkoutjobs.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 CHECKOUTJOB_H
  35 #define CHECKOUTJOB_H
  36
  37 #include "vcsbase_global.h"
  38
  39 #include <QtCore/QObject>
  40 #include <QtCore/QStringList>
  41 #include <QtCore/QProcess>
  42 #include <QtCore/QProcessEnvironment>
  43
  44 QT_BEGIN_NAMESPACE
  45 class QStringList;
  46 class QByteArray;
  47 QT_END_NAMESPACE
  48
  49 namespace VCSBase {
  50
  51 struct ProcessCheckoutJobPrivate;
  52
  53 /* Abstract base class for a job creating an initial project checkout.
  54  * It should be something that runs in the background producing log
  55  * messages. */
  56
  57 class VCSBASE_EXPORT AbstractCheckoutJob : public QObject
  58 {
  59     Q_OBJECT
  60 public:
  61     virtual void start() = 0;
  62     virtual void cancel() = 0;
  63
  64 protected:
  65     explicit AbstractCheckoutJob(QObject *parent = 0);
  66
  67 signals:
  68     void succeeded();
  69     void failed(const QString &why);
  70     void output(const QString &what);
  71 };
  72
  73 /* Convenience implementation using a QProcess. */
  74
  75 class VCSBASE_EXPORT ProcessCheckoutJob : public AbstractCheckoutJob
  76 {
  77     Q_OBJECT
  78 public:
  79     explicit ProcessCheckoutJob(QObject *parent = 0);
  80     virtual ~ProcessCheckoutJob();
  81
  82     void addStep(const QString &binary,
  83                  const QStringList &args,
  84                  const QString &workingDirectory = QString(),
  85                  const QProcessEnvironment &env = QProcessEnvironment::systemEnvironment());
  86
  87     virtual void start();
  88     virtual void cancel();
  89
  90 private slots:
  91     void slotError(QProcess::ProcessError error);
  92     void slotFinished (int exitCode, QProcess::ExitStatus exitStatus);
  93     void slotOutput();
  94     void slotNext();
  95
  96 private:
  97     ProcessCheckoutJobPrivate *d;
  98 };
  99
 100 } // namespace VCSBase
 101
 102 #endif // CHECKOUTJOB_H