DotDirDeps类 参考

Representation of an directory dependency graph 更多...

#include <dotdirdeps.h>

类 DotDirDeps 继承关系图:

DotDirDeps 的协作图:

Public 成员函数
	DotDirDeps (const DirDef *dir)
	~DotDirDeps ()
bool	isTrivial () const
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)
Public 成员函数 继承自 DotGraph
	DotGraph ()
virtual	~DotGraph ()

Protected 成员函数
virtual QCString	getBaseName () const
virtual QCString	getMapLabel () const
virtual void	computeTheGraph ()
virtual QCString	getImgAltText () const
Protected 成员函数 继承自 DotGraph
int	getNextNodeNumber ()
	returns node numbers. 更多...
QCString	writeGraph (TextStream &t, GraphOutputFormat gf, EmbeddedOutputFormat ef, const QCString &path, const QCString &fileName, const QCString &relPath, bool writeImageMap=TRUE, int graphId=-1)
virtual QCString	absMapName () const
QCString	absBaseName () const
QCString	absDotName () const
QCString	imgName () const
QCString	absImgName () const
QCString	relImgName () const

Private 属性
const DirDef *	m_dir = 0
bool	m_linkRelations = false

额外继承的成员函数
静态 Protected 成员函数 继承自 DotGraph
static void	writeGraphHeader (TextStream &t, const QCString &title=QCString())
static void	writeGraphFooter (TextStream &t)
static void	computeGraph (DotNode *root, GraphType gt, GraphOutputFormat format, const QCString &rank, bool renderParents, bool backArrows, const QCString &title, QCString &graphStr)
Protected 属性 继承自 DotGraph
GraphOutputFormat	m_graphFormat = GOF_BITMAP
EmbeddedOutputFormat	m_textFormat = EOF_Html
Dir	m_dir
QCString	m_fileName
QCString	m_relPath
bool	m_generateImageMap = false
int	m_graphId = 0
QCString	m_absPath
QCString	m_baseName
QCString	m_theGraph
bool	m_regenerate = false
bool	m_doNotAddImageToIndex = false
bool	m_noDivTag = false
bool	m_zoomable = true
bool	m_urlOnly = false

详细描述

Representation of an directory dependency graph

在文件 dotdirdeps.h 第 25 行定义.

构造及析构函数说明

DotDirDeps()

DotDirDeps::DotDirDeps

(

const DirDef *

dir

)

在文件 dotdirdeps.cpp 第 397 行定义.

                                        : m_dir(dir)
{
}

~DotDirDeps()

DotDirDeps::~DotDirDeps

(

)

在文件 dotdirdeps.cpp 第 401 行定义.

{
}

成员函数说明

computeTheGraph()

void DotDirDeps::computeTheGraph ( )

protectedvirtual

实现了 DotGraph.

在文件 dotdirdeps.cpp 第 411 行定义.

{
  // compute md5 checksum of the graph were are about to generate
  TextStream md5stream;
  writeGraphHeader(md5stream, m_dir->displayName());
  md5stream << "  compound=true\n";
  writeDotDirDepGraph(md5stream,m_dir,m_linkRelations);
  writeGraphFooter(md5stream);
  m_theGraph = md5stream.str();
}

引用了 DirDef::displayName(), m_dir, m_linkRelations, DotGraph::m_theGraph, TextStream::str(), writeDotDirDepGraph(), DotGraph::writeGraphFooter() , 以及 DotGraph::writeGraphHeader().

getBaseName()

QCString DotDirDeps::getBaseName ( ) const

protectedvirtual

实现了 DotGraph.

在文件 dotdirdeps.cpp 第 405 行定义.

{
  return m_dir->getOutputFileBase()+"_dep";
 
}

引用了 DirDef::getOutputFileBase() , 以及 m_dir.

getImgAltText()

QCString DotDirDeps::getImgAltText ( ) const

protectedvirtual

重载 DotGraph .

在文件 dotdirdeps.cpp 第 427 行定义.

{
  return convertToXML(m_dir->displayName());
}

引用了 convertToXML(), DirDef::displayName() , 以及 m_dir.

getMapLabel()

QCString DotDirDeps::getMapLabel ( ) const

protectedvirtual

实现了 DotGraph.

在文件 dotdirdeps.cpp 第 422 行定义.

{
  return escapeCharsInString(m_baseName,FALSE);
}

引用了 escapeCharsInString(), FALSE , 以及 DotGraph::m_baseName.

isTrivial()

bool DotDirDeps::isTrivial

(

)

const

在文件 dotdirdeps.cpp 第 441 行定义.

{
  return m_dir->depGraphIsTrivial();
}

引用了 DirDef::depGraphIsTrivial() , 以及 m_dir.

被这些函数引用 DirDefImpl::writeDirectoryGraph().

writeGraph()

QCString DotDirDeps::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
	)

在文件 dotdirdeps.cpp 第 432 行定义.

{
  m_linkRelations = linkRelations;
  m_urlOnly = TRUE;
  return DotGraph::writeGraph(out, graphFormat, textFormat, path, fileName, relPath, generateImageMap, graphId);
}

引用了 m_linkRelations, DotGraph::m_urlOnly, TRUE , 以及 DotGraph::writeGraph().

被这些函数引用 RTFGenerator::endDirDepGraph(), DocbookGenerator::endDirDepGraph(), LatexGenerator::endDirDepGraph() , 以及 HtmlGenerator::endDirDepGraph().

类成员变量说明

m_dir

const DirDef* DotDirDeps::m_dir = 0

private

在文件 dotdirdeps.h 第 61 行定义.

被这些函数引用 computeTheGraph(), getBaseName(), getImgAltText() , 以及 isTrivial().

m_linkRelations

bool DotDirDeps::m_linkRelations = false

private

在文件 dotdirdeps.h 第 63 行定义.

被这些函数引用 computeTheGraph() , 以及 writeGraph().

---

该类的文档由以下文件生成:

• src/dotdirdeps.h
• src/dotdirdeps.cpp