src/Graph.cpp

   1 /**
   2  * \file Graph.cpp
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author Dekel Tsur (original code)
   7  * \author Richard Heck (re-implementation)
   8  *
   9  * Full author contact details are available in file CREDITS.
  10  */
  11
  12 #include <config.h>
  13
  14 #include "Graph.h"
  15 #include "Format.h"
  16
  17 #include "support/debug.h"
  18 #include "support/lassert.h"
  19
  20 #include <algorithm>
  21
  22 using namespace std;
  23
  24 namespace lyx {
  25
  26
  27 bool Graph::bfs_init(int s, bool clear_visited, queue<int> & Q)
  28 {
  29         if (s < 0)
  30                 return false;
  31
  32         if (!Q.empty())
  33                 Q = queue<int>();
  34
  35         if (clear_visited) {
  36                 vector<Vertex>::iterator it = vertices_.begin();
  37                 vector<Vertex>::iterator en = vertices_.end();
  38                 for (; it != en; ++it)
  39                         it->visited = false;
  40         }
  41         if (!vertices_[s].visited) {
  42                 Q.push(s);
  43                 vertices_[s].visited = true;
  44         }
  45         return true;
  46 }
  47
  48
  49 Graph::EdgePath const
  50         Graph::getReachableTo(int target, bool clear_visited)
  51 {
  52         EdgePath result;
  53         queue<int> Q;
  54         if (!bfs_init(target, clear_visited, Q))
  55                 return result;
  56
  57         // Here's the logic, which is shared by the other routines.
  58         // Q holds a list of nodes we have been able to reach (in this
  59         // case, reach backwards). It is initialized to the current node
  60         // by bfs_init, and then we recurse, adding the nodes we can reach
  61         // from the current node as we go. That makes it a breadth-first
  62         // search.
  63         while (!Q.empty()) {
  64                 int const current = Q.front();
  65                 Q.pop();
  66                 if (current != target || formats.get(target).name() != "lyx")
  67                         result.push_back(current);
  68
  69                 vector<Arrow *>::iterator it = vertices_[current].in_arrows.begin();
  70                 vector<Arrow *>::iterator const end = vertices_[current].in_arrows.end();
  71                 for (; it != end; ++it) {
  72                         const int cv = (*it)->from;
  73                         if (!vertices_[cv].visited) {
  74                                 vertices_[cv].visited = true;
  75                                 Q.push(cv);
  76                         }
  77                 }
  78         }
  79
  80         return result;
  81 }
  82
  83
  84 Graph::EdgePath const
  85         Graph::getReachable(int from, bool only_viewable,
  86                 bool clear_visited, set<int> excludes)
  87 {
  88         EdgePath result;
  89         queue<int> Q;
  90         if (!bfs_init(from, clear_visited, Q))
  91                 return result;
  92
  93         while (!Q.empty()) {
  94                 int const current = Q.front();
  95                 Q.pop();
  96                 Format const & format = formats.get(current);
  97                 if (!only_viewable || !format.viewer().empty())
  98                         result.push_back(current);
  99                 else if (format.isChildFormat()) {
 100                         Format const * const parent =
 101                                 formats.getFormat(format.parentFormat());
 102                         if (parent && !parent->viewer().empty())
 103                                 result.push_back(current);
 104                 }
 105
 106                 vector<Arrow *>::const_iterator cit =
 107                         vertices_[current].out_arrows.begin();
 108                 vector<Arrow *>::const_iterator end =
 109                         vertices_[current].out_arrows.end();
 110                 for (; cit != end; ++cit) {
 111                         int const cv = (*cit)->to;
 112                         if (!vertices_[cv].visited) {
 113                                 vertices_[cv].visited = true;
 114                                 if (excludes.find(cv) == excludes.end())
 115                                         Q.push(cv);
 116                         }
 117                 }
 118         }
 119
 120         return result;
 121 }
 122
 123
 124 bool Graph::isReachable(int from, int to)
 125 {
 126         if (from == to)
 127                 return true;
 128
 129         queue<int> Q;
 130         if (to < 0 || !bfs_init(from, true, Q))
 131                 return false;
 132
 133         while (!Q.empty()) {
 134                 int const current = Q.front();
 135                 Q.pop();
 136                 if (current == to)
 137                         return true;
 138
 139                 vector<Arrow *>::const_iterator cit =
 140                         vertices_[current].out_arrows.begin();
 141                 vector<Arrow *>::const_iterator end =
 142                         vertices_[current].out_arrows.end();
 143                 for (; cit != end; ++cit) {
 144                         int const cv = (*cit)->to;
 145                         if (!vertices_[cv].visited) {
 146                                 vertices_[cv].visited = true;
 147                                 Q.push(cv);
 148                         }
 149                 }
 150         }
 151
 152         return false;
 153 }
 154
 155
 156 Graph::EdgePath const Graph::getPath(int from, int to)
 157 {
 158         if (from == to)
 159                 return EdgePath();
 160
 161         queue<int> Q;
 162         if (to < 0 || !bfs_init(from, true, Q))
 163                 return EdgePath();
 164
 165         vector<EdgePath> pathes;
 166         pathes.resize(vertices_.size());
 167         while (!Q.empty()) {
 168                 int const current = Q.front();
 169                 Q.pop();
 170
 171                 vector<Arrow *>::const_iterator cit =
 172                         vertices_[current].out_arrows.begin();
 173                 vector<Arrow *>::const_iterator end =
 174                         vertices_[current].out_arrows.end();
 175                 for (; cit != end; ++cit) {
 176                         int const cv = (*cit)->to;
 177                         if (!vertices_[cv].visited) {
 178                                 vertices_[cv].visited = true;
 179                                 Q.push(cv);
 180                                 // NOTE If we wanted to collect all the paths, then
 181                                 // we just need to collect them here and not worry
 182                                 // about "visited".
 183                                 EdgePath lastpath = pathes[(*cit)->from];
 184                                 lastpath.push_back((*cit)->id);
 185                                 pathes[cv] = lastpath;
 186                         }
 187                         if (cv == to) {
 188                                 return pathes[cv];
 189                         }
 190                 }
 191         }
 192         // failure
 193         return EdgePath();
 194 }
 195
 196
 197 void Graph::init(int size)
 198 {
 199         vertices_ = vector<Vertex>(size);
 200         arrows_.clear();
 201         numedges_ = 0;
 202 }
 203
 204
 205 void Graph::addEdge(int from, int to)
 206 {
 207         arrows_.push_back(Arrow(from, to, numedges_));
 208         numedges_++;
 209         Arrow * ar = &(arrows_.back());
 210         vertices_[to].in_arrows.push_back(ar);
 211         vertices_[from].out_arrows.push_back(ar);
 212 }
 213
 214
 215 // At present, we do not need this debugging code, but
 216 // I am going to leave it here in case we need it again.
 217 #if 0
 218 void Graph::dumpGraph() const
 219 {
 220         vector<Vertex>::const_iterator it = vertices_.begin();
 221         vector<Vertex>::const_iterator en = vertices_.end();
 222         for (; it != en; ++it) {
 223                 LYXERR0("Next vertex...");
 224                 LYXERR0("In arrows...");
 225                 std::vector<Arrow *>::const_iterator iit = it->in_arrows.begin();
 226                 std::vector<Arrow *>::const_iterator ien = it->in_arrows.end();
 227                 for (; iit != ien; ++iit)
 228                         LYXERR0("From " << (*iit)->from << " to " << (*iit)->to);
 229                 LYXERR0("Out arrows...");
 230                 iit = it->out_arrows.begin();
 231                 ien = it->out_arrows.end();
 232                 for (; iit != ien; ++iit)
 233                         LYXERR0("From " << (*iit)->from << " to " << (*iit)->to);
 234         }
 235 }
 236 #endif
 237
 238
 239 } // namespace lyx