src/TortoiseProc/RevisionGraph/VisibleGraph.h

   1 // TortoiseSVN - a Windows shell extension for easy version control
   2
   3 // Copyright (C) 2003-2008 - TortoiseSVN
   4
   5 // This program is free software; you can redistribute it and/or
   6 // modify it under the terms of the GNU General Public License
   7 // as published by the Free Software Foundation; either version 2
   8 // of the License, or (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, write to the Free Software Foundation,
  17 // 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  18 //
  19 #pragma once
  20
  21 // required includes
  22
  23 #include "VisibleGraphNode.h"
  24
  25 /**
  26 * Contains a filtered copy of some \ref CFullGraph instance.
  27 *
  28 * Acts as factory and container for all nodes and their sub-structres.
  29 */
  30
  31 class CVisibleGraph
  32 {
  33 private:
  34
  35     CVisibleGraphNode::CFactory nodeFactory;
  36
  37     /// the graph is actually a forest of trees
  38
  39     std::vector<CVisibleGraphNode*> roots;
  40
  41     /// where new roots should be inserted
  42
  43     size_t insertionIndex;
  44
  45 public:
  46
  47     /// construction / destruction
  48
  49     CVisibleGraph(void);
  50     ~CVisibleGraph(void);
  51
  52     /// modification
  53
  54     void Clear();
  55     CVisibleGraphNode* Add ( const CFullGraphNode* base
  56                            , CVisibleGraphNode* source
  57                            , bool preserveNode);
  58
  59     void ReplaceRoot (CVisibleGraphNode* oldRoot, CVisibleGraphNode* newRoot);
  60     void RemoveRoot (CVisibleGraphNode* root);
  61     void AddRoot (CVisibleGraphNode* root);
  62
  63     /// member access
  64
  65     size_t GetRootCount() const;
  66     CVisibleGraphNode* GetRoot (size_t index);
  67     const CVisibleGraphNode* GetRoot (size_t index) const;
  68
  69     size_t GetNodeCount() const;
  70     size_t GetInsertionIndex() const;
  71     void SetInsertionIndex (size_t index);
  72
  73     /// factory access
  74
  75     CVisibleGraphNode::CFactory& GetFactory();
  76 };
  77
  78 /// member access
  79
  80 inline size_t CVisibleGraph::GetRootCount() const
  81 {
  82     return roots.size();
  83 }
  84
  85 inline const CVisibleGraphNode* CVisibleGraph::GetRoot (size_t index) const
  86 {
  87     return roots[index];
  88 }
  89
  90 inline CVisibleGraphNode* CVisibleGraph::GetRoot (size_t index)
  91 {
  92     return roots[index];
  93 }
  94
  95 inline size_t CVisibleGraph::GetNodeCount() const
  96 {
  97     return nodeFactory.GetNodeCount();
  98 }
  99
 100 inline size_t CVisibleGraph::GetInsertionIndex() const
 101 {
 102     return insertionIndex;
 103 }
 104
 105 inline void CVisibleGraph::SetInsertionIndex (size_t index)
 106 {
 107     insertionIndex = index;
 108 }
 109
 110 inline CVisibleGraphNode::CFactory& CVisibleGraph::GetFactory()
 111 {
 112     return nodeFactory;
 113 }
 114