src/AbstractCommand.h

   1 /*
   2  * This file is part of the vng project
   3  * Copyright (C) 2008 Thomas Zander <tzander@trolltech.com>
   4  *
   5  * This program is free software: you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation, either version 3 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17  */
  18
  19 #ifndef ABSTRACTCOMMAND_H
  20 #define ABSTRACTCOMMAND_H
  21
  22 #include "Configuration.h"
  23
  24 #include <QString>
  25 #include <QProcess>
  26 #include <QDir>
  27 #include <QTextStream>
  28
  29 /**
  30  * This baseclass can be used to inherit from in order to add new top-level commands to vng.
  31  * Top level commands are things like 'whatsnew' and 'add'.
  32  * @see CommandLineParser
  33  */
  34 class AbstractCommand {
  35 public:
  36     /// an enum of return codes to be used by start() and run() so all commands syncronize their codes.
  37     enum ReturnCodes {
  38         // note that Unix requires 'Ok' to be zero.
  39         Ok = 0,
  40         InvalidOptions = 1,
  41         Disabled,
  42         NotInRepo,
  43         WriteError,
  44         OtherVngError,
  45         UserCancelled,
  46         GitCrashed = 10,
  47         GitFailed,
  48         GitTimedOut
  49     };
  50
  51     /**
  52      * Constructor.
  53      * @param name the name this command has. Used (o.a.) to create a Configuration object.
  54      */
  55     AbstractCommand(const QString &name);
  56     virtual ~AbstractCommand();
  57
  58     /**
  59      * Start the execution of the commmand.
  60      * This will setup various items and read the default options after which it will call run().
  61      * @return the exit code as used by the comamnd.
  62      * @see ReturnCodes
  63      */
  64     ReturnCodes start();
  65
  66     /// return the name of this command.
  67     QString name() const;
  68
  69 protected:
  70     /**
  71      * return the short visual description of the arguments you can pass to this command.
  72      * If the command takes arguments that are not options, you can make the help message print that
  73      * by returning something in this method.
  74      */
  75     virtual QString argumentDescription() const = 0;
  76
  77     /**
  78      * return long (multiline) Description of the command.
  79      */
  80     virtual QString commandDescription() const = 0;
  81
  82     /**
  83      * Run the commmand from the repository root.
  84      * @return the exit code as used by the comamnd.
  85      * @see ReturnCodes
  86      */
  87     virtual ReturnCodes run() = 0;
  88
  89     /// returns the repository we are in.
  90     QDir repository() const;
  91     /// returns if the command is a dry run which means that user interaction should take place, but no files changed.
  92     bool dryRun() const;
  93
  94     /// The configuation object for this command.
  95     Configuration m_config;
  96
  97     /**
  98      * Changes the arguments passed like they are paths to compensate for the repodir.
  99      * In vng all commands work on the whole repo, which is accomplished by changing the current
 100      * directory to the repo root before run() is called.
 101      * In case the user passed relative path arguments the change in current directory needs to be
 102      * reflected in the paths.
 103      * This method will take all the arguments and assume they are paths. For relative paths (not
 104      * starting with slash or a drive name) the change in directory will be applied.
 105      */
 106     QStringList rebasedArguments() const;
 107
 108     /// check if we are in a repository; return true if we are
 109     bool checkInRepository() const;
 110
 111     bool shouldUsePager() const;
 112
 113     enum RebaseOptionFlag {
 114         NoOption = 0,       ///< No options
 115         /// For each command line argument, do a stat to find if the original file or the rebased file is meant.
 116         CheckFileSystem = 1,
 117         /// In case the rebased filename does not exist, print an error message saying so.
 118         PrintError = 2
 119     };
 120     Q_DECLARE_FLAGS( RebaseOptions, RebaseOptionFlag )
 121
 122     /// make the current directory for vng the root of the repo. This will also populate the m_rebasedArguments list.
 123     void moveToRoot(RebaseOptions options = NoOption);
 124
 125 private:
 126     QDir m_repository;
 127     bool m_dryRun;
 128     QString m_name;
 129     QStringList m_rebasedArguments;
 130 };
 131
 132 #endif