src/TortoiseProc/RevisionGraph/GraphNodeState.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 ///////////////////////////////////////////////////////////////
  22 // required includes
  23 ///////////////////////////////////////////////////////////////
  24
  25 #include "./Containers/DictionaryBasedTempPath.h"
  26
  27 using namespace LogCache;
  28
  29 ///////////////////////////////////////////////////////////////
  30 // forward declarations
  31 ///////////////////////////////////////////////////////////////
  32
  33 class CFullGraph;
  34 class CFullGraphNode;
  35 class CVisibleGraphNode;
  36
  37 /**
  38  * This is a container that stores all nodes that have been
  39  * collapsed or cut.
  40  */
  41
  42 class CGraphNodeStates
  43 {
  44 public:
  45
  46     /** All possible node states. All freely combinable.
  47      * Not all of them are in use.
  48      */
  49
  50     enum
  51     {
  52         COLLAPSED_ABOVE = 0x01,  ///< hide previous or copy source node, respectively
  53         COLLAPSED_BELOW = 0x02,  ///< hide next node (and following) in the same line
  54         COLLAPSED_LEFT  = 0x04,  ///< not used, yet
  55         COLLAPSED_RIGHT = 0x08,  ///< hide sub-trees that expand to the right side
  56
  57         COLLAPSED_ALL   =  CGraphNodeStates::COLLAPSED_ABOVE
  58                          | CGraphNodeStates::COLLAPSED_RIGHT
  59                          | CGraphNodeStates::COLLAPSED_LEFT
  60                          | CGraphNodeStates::COLLAPSED_BELOW,
  61
  62         SPLIT_ABOVE     = 0x10,  ///< make this a new graph root node
  63         SPLIT_BELOW     = 0x20,  ///< make the next node a new graph root node
  64         SPLIT_LEFT      = 0x40,  ///< not used, yet
  65         SPLIT_RIGHT     = 0x80,  ///< show all sub-trees as separate graphs
  66
  67         SPLIT_ALL       =  CGraphNodeStates::SPLIT_ABOVE
  68                          | CGraphNodeStates::SPLIT_RIGHT
  69                          | CGraphNodeStates::SPLIT_LEFT
  70                          | CGraphNodeStates::SPLIT_BELOW,
  71     };
  72
  73     /// used tempoarily to hold the status while the query is re-run
  74     /// (i.e. when the node pointers will become invalid)
  75
  76     typedef std::pair<revision_t, CDictionaryBasedTempPath> TNodeDescriptor;
  77     typedef std::map<TNodeDescriptor, DWORD> TSavedStates;
  78
  79     typedef TSavedStates TSavedData;
  80
  81 private:
  82
  83     /// associates a state to the given graph node
  84
  85     typedef std::map<const CFullGraphNode*, DWORD> TStates;
  86     TStates states;
  87
  88     /// utiltiy methods: restore state from saved data
  89
  90     void RestoreStates ( const TSavedStates& saved
  91                        , const CFullGraphNode* node);
  92
  93     /// \ref ResetFlags() may call this multiple times if links are defined
  94
  95     void InternalResetFlags (const CFullGraphNode* node, DWORD flags);
  96
  97     /// traverse the unfiltered tree in the given direction
  98     /// and look for a suitable node state.
  99
 100     typedef std::pair<const CFullGraphNode*, DWORD> TFlaggedNode;
 101     typedef std::vector<const CFullGraphNode*> TFlaggedNodes;
 102
 103     TFlaggedNode FindPreviousRelevant ( const CVisibleGraphNode* node
 104                                       , DWORD flags
 105                                       , bool withinAsWell) const;
 106
 107     TFlaggedNode FindNextRelevant ( const CVisibleGraphNode* node
 108                                   , DWORD flags
 109                                   , bool withinAsWell) const;
 110
 111     TFlaggedNode FindRightRelevant (const CVisibleGraphNode* node) const;
 112     TFlaggedNodes FindSplitSubtrees (const CVisibleGraphNode* node) const;
 113
 114     /// store, update and qeuery state
 115
 116     void SetFlags (const CFullGraphNode* node, DWORD flags);
 117     void ResetFlags (const CFullGraphNode* node, DWORD flags);
 118     DWORD GetFlags (const CFullGraphNode* node) const;
 119
 120 public:
 121
 122     /// construction / destruction
 123
 124     CGraphNodeStates(void);
 125     ~CGraphNodeStates(void);
 126
 127     /// store, update and qeuery state
 128
 129     void SetFlags (const CVisibleGraphNode* node, DWORD flags);
 130     void ResetFlags (const CVisibleGraphNode* node, DWORD flags);
 131
 132     /// crawl the tree, find the next relavant entries and combine
 133     /// the status info. Include (or don't) flags between visible
 134     /// nodes of the same branch.
 135
 136     DWORD GetFlags (const CVisibleGraphNode* node, bool withinAsWell = false) const;
 137
 138     /// quick update all
 139
 140     void ResetFlags (DWORD flags);
 141
 142     /// disjuctive combination of all flags currently set
 143
 144     DWORD GetCombinedFlags() const;
 145
 146     /// re-qeuery support
 147
 148     TSavedData SaveData() const;
 149     void LoadData (const TSavedData& saved, const CFullGraph* graph);
 150 };