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