doxygen
dotdirdeps.h
1 /******************************************************************************
2 *
3 * Copyright (C) 1997-2019 by Dimitri van Heesch.
4 *
5 * Permission to use, copy, modify, and distribute this software and its
6 * documentation under the terms of the GNU General Public License is hereby
7 * granted. No representations are made about the suitability of this software
8 * for any purpose. It is provided "as is" without express or implied warranty.
9 * See the GNU General Public License for more details.
10 *
11 * Documents produced by Doxygen are derivative works derived from the
12 * input used in their production; they are not affected by this license.
13 *
14 */
15 
16 #ifndef DOTDIRDEPS_H
17 #define DOTDIRDEPS_H
18 
19 #include <memory>
20 
21 #include "dotgraph.h"
22 #include "dirdef.h"
23 
25 class DotDirDeps : public DotGraph
26 {
27  public:
28  DotDirDeps(const DirDef *dir);
29  ~DotDirDeps();
30  bool isTrivial() const;
31  QCString writeGraph(TextStream &out,
32  GraphOutputFormat gf,
33  EmbeddedOutputFormat ef,
34  const QCString &path,
35  const QCString &fileName,
36  const QCString &relPath,
37  bool writeImageMap=TRUE,
38  int graphId=-1,
39  bool linkRelations=TRUE);
40 
41  protected:
42  virtual QCString getBaseName() const;
43  virtual QCString getMapLabel() const;
44  virtual void computeTheGraph();
45  virtual QCString getImgAltText() const;
46 
47  private:
48  const DirDef *m_dir = 0;
49 
50  bool m_linkRelations = false;
51 };
52 
53 using DotDirDepsPtr = std::shared_ptr<DotDirDeps>;
54 
55 #endif
Text streaming class that buffers data.
Definition: textstream.h:34
A model of a directory symbol.
Definition: dirdef.h:110
A dot graph.
Definition: dotgraph.h:32
Representation of an directory dependency graph.
Definition: dotdirdeps.h:25
This is an alternative implementation of QCString.
Definition: qcstring.h:108