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 
24 /** Representation of an directory dependency graph */
25 class DotDirDeps : public DotGraph
26 {
27  public:
28  DotDirDeps(const DirDef *dir);
29  ~DotDirDeps();
30  bool isTrivial() const;
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
DotDirDeps::m_linkRelations
bool m_linkRelations
Definition: dotdirdeps.h:63
DotDirDeps::DotDirDeps
DotDirDeps(const DirDef *dir)
Definition: dotdirdeps.cpp:397
DotDirDeps
Representation of an directory dependency graph
Definition: dotdirdeps.h:25
DotDirDeps::~DotDirDeps
~DotDirDeps()
Definition: dotdirdeps.cpp:401
DirDef
A model of a directory symbol.
Definition: dirdef.h:110
DotDirDeps::getMapLabel
virtual QCString getMapLabel() const
Definition: dotdirdeps.cpp:422
TextStream
Text streaming class that buffers data.
Definition: textstream.h:33
DotDirDeps::writeGraph
QCString writeGraph(TextStream &out, GraphOutputFormat gf, EmbeddedOutputFormat ef, const QCString &path, const QCString &fileName, const QCString &relPath, bool writeImageMap=TRUE, int graphId=-1, bool linkRelations=TRUE)
Definition: dotdirdeps.cpp:432
DotDirDeps::getImgAltText
virtual QCString getImgAltText() const
Definition: dotdirdeps.cpp:427
DotDirDeps::getBaseName
virtual QCString getBaseName() const
Definition: dotdirdeps.cpp:405
DotDirDeps::isTrivial
bool isTrivial() const
Definition: dotdirdeps.cpp:441
TRUE
#define TRUE
Definition: qcstring.h:36
dotgraph.h
dirdef.h
DotDirDepsPtr
std::shared_ptr< DotDirDeps > DotDirDepsPtr
Definition: dotdirdeps.h:53
DotDirDeps::m_dir
const DirDef * m_dir
Definition: dotdirdeps.h:61
EmbeddedOutputFormat
EmbeddedOutputFormat
Definition: dotgraph.h:28
GraphOutputFormat
GraphOutputFormat
Definition: dotgraph.h:27
DotGraph
A dot graph
Definition: dotgraph.h:32
DotDirDeps::computeTheGraph
virtual void computeTheGraph()
Definition: dotdirdeps.cpp:411
QCString
This is an alternative implementation of QCString.
Definition: qcstring.h:108