src/TortoiseProc/RevisionGraph/StandardLayout.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 #include "IRevisionGraphLayout.h"
  22
  23 class CVisibleGraphNode;
  24 class CVisibleGraph;
  25
  26 namespace LogCache
  27 {
  28     class CCachedLogInfo;
  29 }
  30
  31 class CStandardLayoutNodeInfo
  32 {
  33 public:
  34
  35     /// the node to place within the layout
  36
  37     const CVisibleGraphNode* node;
  38
  39     /// links for faster navigation
  40
  41     CStandardLayoutNodeInfo* parentBranch;
  42     CStandardLayoutNodeInfo* firstSubBranch;
  43     CStandardLayoutNodeInfo* nextInBranch;
  44     CStandardLayoutNodeInfo* previousInBranch;
  45     CStandardLayoutNodeInfo* lastInBranch;
  46     CStandardLayoutNodeInfo* nextBranch;
  47     CStandardLayoutNodeInfo* previousBranch;
  48     CStandardLayoutNodeInfo* lastBranch;
  49
  50     /// the graph may consist of multiple trees.
  51     /// root(node) = graph (node)->GetRoot (rootID);
  52
  53     index_t rootID;
  54
  55     /// branch sizes
  56
  57     index_t subTreeWidth;
  58     index_t subTreeHeight;
  59     index_t subTreeWeight;
  60     index_t branchLength;
  61
  62     /// node properties
  63
  64     bool requiresRevision;
  65     bool requiresPath;
  66     bool requiresGap;
  67
  68     /// number of path elements that shall not be shown
  69     /// (used by "show diff path" option)
  70
  71     index_t skipStartPathElements;
  72     index_t skipTailPathElements;
  73
  74     /// required size(s) to display all content
  75
  76     CSize requiredSize;
  77
  78     /// temp. value used to store the offset of the final position
  79     /// to the current one (logical coordinates)
  80
  81     CSize treeShift;
  82     CSize subTreeShift;
  83
  84     /// actual position (logical coordinates)
  85
  86     CRect rect;
  87
  88     /// initialization
  89
  90     CStandardLayoutNodeInfo();
  91 };
  92
  93 /**
  94 * utility interface that gives layout options access to the layout info
  95 */
  96
  97 class IStandardLayoutNodeAccess
  98 {
  99 public:
 100
 101     /// make sub-classes deletable through the base interface
 102
 103     virtual ~IStandardLayoutNodeAccess() {};
 104
 105     /// access graph node layout
 106
 107     virtual index_t GetNodeCount() const = 0;
 108     virtual CStandardLayoutNodeInfo* GetNode (index_t index) = 0;
 109 };
 110
 111 class CStandardLayout
 112     : public IRevisionGraphLayout
 113     , public IStandardLayoutNodeAccess
 114 {
 115 public:
 116
 117     struct STextInfo
 118     {
 119         index_t nodeIndex;
 120         int subPathIndex;   // 0 -> revNum, pathElementIndex otherwise
 121
 122         STextInfo (index_t nodeIndex, int subPathIndex)
 123             : nodeIndex (nodeIndex)
 124             , subPathIndex (subPathIndex)
 125         {
 126         }
 127     };
 128
 129 private:
 130
 131     /// source of revision data
 132
 133     const CCachedLogInfo* cache;
 134
 135     /// logical tree structure
 136
 137     const CVisibleGraph* graph;
 138
 139     /// nodes (in the order defined by CVisibleGraphNode::index)
 140
 141     std::vector<CStandardLayoutNodeInfo> nodes;
 142
 143     /// connections with length > 0. Stored as node index pairs.
 144
 145     std::vector<std::pair<index_t, index_t> > connections;
 146
 147     /// non-empty texts. Stored as node index, 'is path' pairs
 148
 149     std::vector<STextInfo> texts;
 150
 151     /// bounding rects of the individual trees
 152
 153     std::vector<CRect> trees;
 154
 155     /// area that covers all visible items
 156
 157     CRect boundingRect;
 158
 159     /// layout creation
 160
 161     void SortNodes();
 162     void InitializeNodes ( const CVisibleGraphNode* node
 163                          , CStandardLayoutNodeInfo* parentBranch);
 164     void InitializeNodes();
 165
 166     void CreateConnections();
 167     void CreateTexts();
 168
 169     void CloseTreeBoundingRectGaps();
 170     void CalculateTreeBoundingRects();
 171
 172     void CalculateBoundingRect();
 173
 174 public:
 175
 176     /// construction / destruction
 177
 178     CStandardLayout (const CCachedLogInfo* cache, const CVisibleGraph* graph);
 179     virtual ~CStandardLayout(void);
 180
 181     /// call this after executing the format options
 182
 183     void Finalize();
 184
 185     /// implement IRevisionGraphLayout
 186
 187     virtual CRect GetRect() const;
 188
 189     virtual const ILayoutRectList* GetTrees() const;
 190     virtual const ILayoutNodeList* GetNodes() const;
 191     virtual const ILayoutConnectionList* GetConnections() const;
 192     virtual const ILayoutTextList* GetTexts() const;
 193
 194     /// implement IStandardLayoutNodeAccess
 195
 196     virtual index_t GetNodeCount() const;
 197     virtual CStandardLayoutNodeInfo* GetNode (index_t index);
 198 };
 199