src/patches/CommitsCursor.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 COMMITSCURSOR_H
  20 #define COMMITSCURSOR_H
  21
  22 #include "../InterviewCursor.h"
  23 #include "Commit.h"
  24
  25 class CommitsMatcher;
  26
  27 class CommitsCursor : public InterviewCursor
  28 {
  29 public:
  30     enum SelectionType {
  31         SelectOnePatch, ///< gives user choice of 'yes'/'no'
  32         SelectRange     ///< gives user navigating abilities and ability to say yes to multiple patches
  33     };
  34
  35     CommitsCursor(SelectionType selectionType);
  36     virtual ~CommitsCursor();
  37
  38     virtual int forward(Scope scope = ItemScope, bool skipAnswered = true);
  39     virtual int back(Scope scope = ItemScope);
  40     virtual void setResponse(bool response, Scope scope = ItemScope);
  41
  42     virtual int count();
  43     virtual void forceCount();
  44     virtual QString currentText() const;
  45     virtual QString helpMessage() const;
  46     virtual bool isValid() const;
  47     virtual QString allowedOptions() const;
  48
  49     Commit head();
  50
  51     /// returns the index into the list of patches that is the oldest patch the user adjusted.
  52     int oldestCommitAltered() const { return m_oldestIndex; }
  53
  54     /**
  55      * make the cursor use the matcher to match only commits that match the command line arguments.
  56      * @param use if true the next call to forward() or back() will use the CommitsMatcher, otherwise it won't.
  57      * The default is to use no matcher.
  58      */
  59     void setUseMatcher(bool use);
  60
  61 private:
  62     int m_currentIndex, m_oldestIndex;
  63     Commit m_head;
  64     Commit m_current;
  65     Commit m_firstInBranch;
  66     bool m_done;
  67     CommitsMatcher *m_matcher;
  68     SelectionType m_selectionType;
  69 };
  70
  71 #endif