patches/Commit.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 #ifndef COMMIT_H
  19 #define COMMIT_H
  20
  21 #include "../Vng.h"
  22
  23 #include <QString>
  24 #include <QDateTime>
  25
  26 class CommitPrivate;
  27 class ChangeSet;
  28
  29 class Commit {
  30 public:
  31     /// default constructor creates an invalid commit object.
  32     Commit();
  33     Commit(const QString &treeism, const Commit &nextCommit = Commit());
  34     Commit(const Commit &other);
  35     ~Commit();
  36
  37     /// return an older commit
  38     QList<Commit> previous();
  39     /// return a commit made at a later time that has this one as its parent.
  40     Commit next();
  41
  42     int previousCommitsCount() const;
  43
  44     QString author() const;
  45     QString committer() const;
  46     QString logMessage() const;
  47     /// The actual sha1 of this commit
  48     QString tree() const;
  49     /// the param passed to the constructor. This can be something like "HEAD"
  50     QString commitTreeIsm() const;
  51
  52     QDateTime commitTime() const;
  53     QDateTime authorTime() const;
  54
  55     /// available only when the diff provided it.
  56     ChangeSet changeSet() const;
  57
  58     /// Clear references to the previousCommits, if this commit is the last user of the parent commits it will clean up some memory.
  59     void clearParents();
  60
  61     Commit &operator=(const Commit &other);
  62     bool operator==(const Commit &other);
  63
  64     Vng::Acceptance acceptance() const;
  65     void setAcceptance(Vng::Acceptance accepted);
  66
  67     bool isValid() const;
  68
  69     /**
  70      * Return the first commit on this branch.
  71      * If this is head commit on a branch (not master), this will search for
  72      * the first commit that both this branch and another branch share.
  73      */
  74     Commit firstCommitInBranch();
  75
  76     static Commit createFromStream(QIODevice *device);
  77
  78 protected:
  79     Commit(CommitPrivate *priv);
  80     void fillFromTreeIsm(const QString &treeIsm);
  81     CommitPrivate * d;
  82
  83 private:
  84     static Commit createFromStream(QIODevice *device, CommitPrivate *priv);
  85 };
  86
  87 #endif