The DotDirDeps Class Reference

Representation of an directory dependency graph. More...

Declaration

class DotDirDeps { ... }

Included Headers

#include <src/dotdirdeps.h>

Base class

class	DotGraph
	A dot graph. More...

Public Constructors Index

	DotDirDeps (const DirDef *dir)

Public Destructor Index

	~DotDirDeps () override

Public Member Functions Index

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)

Protected Member Functions Index

QCString	getBaseName () const override
QCString	getMapLabel () const override
void	computeTheGraph () override
QCString	getImgAltText () const override

Private Member Attributes Index

const DirDef *	m_dir = nullptr
bool	m_linkRelations = false

Description

Representation of an directory dependency graph.

Definition at line 25 of file dotdirdeps.h.

Public Constructors

DotDirDeps()

DotDirDeps::DotDirDeps (const DirDef * dir)

Declaration at line 28 of file dotdirdeps.h, definition at line 403 of file dotdirdeps.cpp.

403DotDirDeps::DotDirDeps(const DirDef *dir) : m_dir(dir)

404{

405}

Reference m_dir.

Public Destructor

~DotDirDeps()

DotDirDeps::~DotDirDeps ()

Declaration at line 29 of file dotdirdeps.h, definition at line 407 of file dotdirdeps.cpp.

407DotDirDeps::~DotDirDeps()

408{

409}

Public Member Functions

isTrivial()

bool DotDirDeps::isTrivial ()

Declaration at line 32 of file dotdirdeps.h, definition at line 447 of file dotdirdeps.cpp.

447bool DotDirDeps::isTrivial() const

448{

449 return m_dir->depGraphIsTrivial();

450}

Reference m_dir.

Referenced by 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)

Declaration at line 33 of file dotdirdeps.h, definition at line 438 of file dotdirdeps.cpp.

438QCString DotDirDeps::writeGraph(TextStream &out, GraphOutputFormat graphFormat, EmbeddedOutputFormat textFormat,

439 const QCString &path, const QCString &fileName, const QCString &relPath, bool generateImageMap,

440 int graphId, bool linkRelations)

441{

442 m_linkRelations = linkRelations;

443 m_urlOnly = TRUE;

444 return DotGraph::writeGraph(out, graphFormat, textFormat, path, fileName, relPath, generateImageMap, graphId);

445}

References m_linkRelations, DotGraph::m_urlOnly, TRUE and DotGraph::writeGraph.

Referenced by DocbookGenerator::endDirDepGraph, HtmlGenerator::endDirDepGraph, LatexGenerator::endDirDepGraph and RTFGenerator::endDirDepGraph.

Protected Member Functions

computeTheGraph()

void DotDirDeps::computeTheGraph ()

protected virtual

Declaration at line 46 of file dotdirdeps.h, definition at line 417 of file dotdirdeps.cpp.

417void DotDirDeps::computeTheGraph()

418{

419 // compute md5 checksum of the graph were are about to generate

420 TextStream md5stream;

421 writeGraphHeader(md5stream, m_dir->displayName());

422 md5stream << " compound=true\n";

423 writeDotDirDepGraph(md5stream,m_dir,m_linkRelations);

424 writeGraphFooter(md5stream);

425 m_theGraph = md5stream.str();

426}

References m_dir, m_linkRelations, DotGraph::m_theGraph, TextStream::str, writeDotDirDepGraph, DotGraph::writeGraphFooter and DotGraph::writeGraphHeader.

getBaseName()

QCString DotDirDeps::getBaseName ()

protected virtual

Declaration at line 44 of file dotdirdeps.h, definition at line 411 of file dotdirdeps.cpp.

411QCString DotDirDeps::getBaseName() const

412{

413 return m_dir->getOutputFileBase()+"_dep";

414

415}

Reference m_dir.

getImgAltText()

QCString DotDirDeps::getImgAltText ()

protected virtual

Declaration at line 47 of file dotdirdeps.h, definition at line 433 of file dotdirdeps.cpp.

433QCString DotDirDeps::getImgAltText() const

434{

435 return convertToXML(m_dir->displayName());

436}

References convertToXML and m_dir.

getMapLabel()

QCString DotDirDeps::getMapLabel ()

protected virtual

Declaration at line 45 of file dotdirdeps.h, definition at line 428 of file dotdirdeps.cpp.

428QCString DotDirDeps::getMapLabel() const

429{

430 return escapeCharsInString(m_baseName,FALSE);

431}

References escapeCharsInString, FALSE and DotGraph::m_baseName.

Private Member Attributes

m_dir

const DirDef* DotDirDeps::m_dir = nullptr

Definition at line 50 of file dotdirdeps.h.

50 const DirDef *m_dir = nullptr;

Referenced by computeTheGraph, DotDirDeps, getBaseName, getImgAltText and isTrivial.

m_linkRelations

bool DotDirDeps::m_linkRelations = false

Definition at line 52 of file dotdirdeps.h.

52 bool m_linkRelations = false;

Referenced by computeTheGraph and writeGraph.

---

The documentation for this class was generated from the following files:

• dotdirdeps.cpp
• dotdirdeps.h

---

Generated via doxygen2docusaurus by Doxygen 1.14.0.