Representation of a group collaboration graph 更多...

#include <dotgroupcollaboration.h>

类 DotGroupCollaboration 继承关系图:

DotGroupCollaboration 的协作图:

类
struct	Edge

struct	Link

Public 成员函数
	DotGroupCollaboration (const GroupDef *gd)

	~DotGroupCollaboration ()

QCString	writeGraph (TextStream &t, GraphOutputFormat gf, EmbeddedOutputFormat ef, const QCString &path, const QCString &fileName, const QCString &relPath, bool writeImageMap=TRUE, int graphId=-1)

bool	isTrivial () const

Public 成员函数继承自 DotGraph
	DotGraph ()

virtual	~DotGraph ()

Protected 成员函数
virtual QCString	getBaseName () const

virtual QCString	getMapLabel () const

virtual void	computeTheGraph ()

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

virtual QCString	getImgAltText () const

QCString	absBaseName () const

QCString	absDotName () const

QCString	imgName () const

QCString	absImgName () const

QCString	relImgName () const

Private 类型
enum	EdgeType { tmember = 0, tclass, tnamespace, tfile, tpages, tdir, thierarchy }

Private 成员函数
void	buildGraph (const GroupDef *gd)

void	addCollaborationMember (const Definition *def, QCString &url, EdgeType eType)

void	addMemberList (class MemberList *ml)

void	writeGraphHeader (TextStream &t, const QCString &title) const

Edge *	addEdge (DotNode _pNStart, DotNode _pNEnd, EdgeType _eType, const QCString &_label, const QCString &_url)

Private 属性
DotNode *	m_rootNode

DotNodeMap	m_usedNodes

QCString	m_diskName

std::vector< std::unique_ptr< Edge > >	m_edges

额外继承的成员函数
静态 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 a group collaboration graph

在文件 dotgroupcollaboration.h 第 28 行定义.

成员枚举类型说明

◆ EdgeType

enum DotGroupCollaboration::EdgeType

private

枚举值
tmember
tclass
tnamespace
tfile
tpages
tdir
thierarchy

在文件 dotgroupcollaboration.h 第 44 行定义.

     {
       tmember = 0,
       tclass,
       tnamespace,
       tfile,
       tpages,
       tdir,
       thierarchy
     };

构造及析构函数说明

◆ DotGroupCollaboration()

DotGroupCollaboration::DotGroupCollaboration ( const GroupDef * gd )

在文件 dotgroupcollaboration.cpp 第 25 行定义.

 {
   QCString tmp_url = gd->getReference()+"$"+gd->getOutputFileBase();
   QCString tooltip = gd->briefDescriptionAsTooltip();
   m_rootNode = new DotNode(getNextNodeNumber(), gd->groupTitle(), tooltip, tmp_url, TRUE );
   m_rootNode->markAsVisible();
   m_usedNodes.insert(std::make_pair(gd->name().str(), m_rootNode));
  
   m_diskName = gd->getOutputFileBase();
  
   buildGraph( gd );
 }

引用了 Definition::briefDescriptionAsTooltip(), buildGraph(), DotGraph::getNextNodeNumber(), GroupDef::getOutputFileBase(), Definition::getReference(), GroupDef::groupTitle(), m_diskName, m_rootNode, m_usedNodes, DotNode::markAsVisible(), Definition::name(), QCString::str() , 以及 TRUE.

◆ ~DotGroupCollaboration()

DotGroupCollaboration::~DotGroupCollaboration ( )

在文件 dotgroupcollaboration.cpp 第 38 行定义.

 {
   // delete all created Nodes saved in m_usedNodes map
   for (const auto &kv : m_usedNodes)
   {
     delete kv.second;
   }
 }

引用了 m_usedNodes.

成员函数说明

◆ addCollaborationMember()

void DotGroupCollaboration::addCollaborationMember	(	const Definition *	def,
		QCString &	url,
		EdgeType	eType
	)

private

在文件 dotgroupcollaboration.cpp 第 179 行定义.

 {
   // Create group nodes
   QCString tmp_str;
   for (const auto &d : def->partOfGroups())
   {
     auto it = m_usedNodes.find(d->name().str());
     DotNode* nnode = it!=m_usedNodes.end() ? it->second : 0;
     if ( nnode != m_rootNode )
     {
       if ( nnode==0 )
       { // add node
         tmp_str = d->getReference()+"$"+d->getOutputFileBase();
         QCString tooltip = d->briefDescriptionAsTooltip();
         nnode = new DotNode(getNextNodeNumber(), d->groupTitle(), tooltip, tmp_str );
         nnode->markAsVisible();
         m_usedNodes.insert(std::make_pair(d->name().str(), nnode));
       }
       tmp_str = def->qualifiedName();
       addEdge( m_rootNode, nnode, eType, tmp_str, url );
     }
   }
 }

引用了 addEdge(), DotGraph::getNextNodeNumber(), m_rootNode, m_usedNodes, DotNode::markAsVisible(), Definition::partOfGroups() , 以及 Definition::qualifiedName().

被这些函数引用 addMemberList() , 以及 buildGraph().

◆ addEdge()

DotGroupCollaboration::Edge * DotGroupCollaboration::addEdge	(	DotNode *	_pNStart,
		DotNode *	_pNEnd,
		EdgeType	_eType,
		const QCString &	_label,
		const QCString &	_url
	)

private

在文件 dotgroupcollaboration.cpp 第 155 行定义.

 {
   // search a existing link.
   auto it = std::find_if(m_edges.begin(),m_edges.end(),
       [&_pNStart,&_pNEnd,&_eType](const auto &edge)
       { return edge->pNStart==_pNStart && edge->pNEnd==_pNEnd && edge->eType==_eType; });
  
   if (it==m_edges.end()) // new link
   {
     m_edges.emplace_back(std::make_unique<Edge>(_pNStart,_pNEnd,_eType));
     it = m_edges.end()-1;
   }
  
   if (!_label.isEmpty()) // add label
   {
     (*it)->links.emplace_back(_label,_url);
   }
  
   // return found or added edge
   return (*it).get();
 }

引用了 QCString::isEmpty() , 以及 m_edges.

被这些函数引用 addCollaborationMember() , 以及 buildGraph().

◆ addMemberList()

void DotGroupCollaboration::addMemberList ( class MemberList * ml )

private

在文件 dotgroupcollaboration.cpp 第 144 行定义.

 {
   if ( ml==0 || ml->empty() ) return;
   for (const auto &def : *ml)
   {
     QCString tmp_url = def->getReference()+"$"+addHtmlExtensionIfMissing(def->getOutputFileBase());
       +"#"+def->anchor();
     addCollaborationMember( def, tmp_url, DotGroupCollaboration::tmember );
   }
 }

引用了 addCollaborationMember(), addHtmlExtensionIfMissing(), MemberVector::empty() , 以及 tmember.

被这些函数引用 buildGraph().

◆ buildGraph()

void DotGroupCollaboration::buildGraph ( const GroupDef * gd )

private

在文件 dotgroupcollaboration.cpp 第 47 行定义.

 {
   QCString tmp_url;
   //===========================
   // hierarchy.
  
   // Write parents
   for (const auto &d : gd->partOfGroups())
   {
     DotNode *nnode = 0;
     auto it = m_usedNodes.find(d->name().str());
     if ( it==m_usedNodes.end())
     { // add node
       tmp_url = d->getReference()+"$"+d->getOutputFileBase();
       QCString tooltip = d->briefDescriptionAsTooltip();
       nnode = new DotNode(getNextNodeNumber(), d->groupTitle(), tooltip, tmp_url );
       nnode->markAsVisible();
       m_usedNodes.insert(std::make_pair(d->name().str(), nnode));
     }
     else
     {
       nnode = it->second;
     }
     tmp_url = "";
     addEdge( nnode, m_rootNode, DotGroupCollaboration::thierarchy, tmp_url, tmp_url );
   }
  
   // Add subgroups
   for (const auto &def : gd->getSubGroups())
   {
     DotNode *nnode = 0;
     auto it = m_usedNodes.find(def->name().str());
     if ( it==m_usedNodes.end())
     { // add node
       tmp_url = def->getReference()+"$"+def->getOutputFileBase();
       QCString tooltip = def->briefDescriptionAsTooltip();
       nnode = new DotNode(getNextNodeNumber(), def->groupTitle(), tooltip, tmp_url );
       nnode->markAsVisible();
       m_usedNodes.insert(std::make_pair(def->name().str(), nnode));
     }
     else
     {
       nnode = it->second;
     }
     tmp_url = "";
     addEdge( m_rootNode, nnode, DotGroupCollaboration::thierarchy, tmp_url, tmp_url );
   }
  
   //=======================
   // Write collaboration
  
   // Add members
   addMemberList( gd->getMemberList(MemberListType_allMembersList) );
  
   // Add classes
   for (const auto &def : gd->getClasses())
   {
     tmp_url = def->getReference()+"$"+addHtmlExtensionIfMissing(def->getOutputFileBase());
     if (!def->anchor().isEmpty())
     {
       tmp_url+="#"+def->anchor();
     }
     addCollaborationMember( def, tmp_url, DotGroupCollaboration::tclass );
   }
  
   // Add namespaces
   for (const auto &def : gd->getNamespaces())
   {
     tmp_url = def->getReference()+"$"+addHtmlExtensionIfMissing(def->getOutputFileBase());
     addCollaborationMember( def, tmp_url, DotGroupCollaboration::tnamespace );
   }
  
   // Add files
   for (const auto &def : gd->getFiles())
   {
     tmp_url = def->getReference()+"$"+addHtmlExtensionIfMissing(def->getOutputFileBase());
     addCollaborationMember( def, tmp_url, DotGroupCollaboration::tfile );
   }
  
   // Add pages
   for (const auto &def : gd->getPages())
   {
     tmp_url = def->getReference()+"$"+addHtmlExtensionIfMissing(def->getOutputFileBase());
     addCollaborationMember( def, tmp_url, DotGroupCollaboration::tpages );
   }
  
   // Add directories
   if ( !gd->getDirs().empty() )
   {
     for(const auto def : gd->getDirs())
     {
       tmp_url = def->getReference()+"$"+addHtmlExtensionIfMissing(def->getOutputFileBase());
       addCollaborationMember( def, tmp_url, DotGroupCollaboration::tdir );
     }
   }
 }

引用了 addCollaborationMember(), addEdge(), addHtmlExtensionIfMissing(), addMemberList(), GroupDef::getClasses(), GroupDef::getDirs(), GroupDef::getFiles(), GroupDef::getMemberList(), GroupDef::getNamespaces(), DotGraph::getNextNodeNumber(), GroupDef::getPages(), GroupDef::getSubGroups(), m_rootNode, m_usedNodes, DotNode::markAsVisible(), MemberListType_allMembersList, Definition::partOfGroups(), tclass, tdir, tfile, thierarchy, tnamespace , 以及 tpages.

被这些函数引用 DotGroupCollaboration().

◆ computeTheGraph()

void DotGroupCollaboration::computeTheGraph ( )

protectedvirtual

实现了 DotGraph.

在文件 dotgroupcollaboration.cpp 第 209 行定义.

 {
   TextStream md5stream;
   writeGraphHeader(md5stream,m_rootNode->label());
  
   // clean write flags
   for (const auto &kv : m_usedNodes)
   {
     kv.second->clearWriteFlag();
   }
  
   // write other nodes.
   for (const auto &kv : m_usedNodes)
   {
     kv.second->write(md5stream,Inheritance,m_graphFormat,TRUE,FALSE,FALSE);
   }
  
   // write edges
   for (const auto &edge : m_edges)
   {
     edge->write( md5stream );
   }
  
   writeGraphFooter(md5stream);
  
   m_theGraph = md5stream.str();
 }

引用了 FALSE, Inheritance, DotNode::label(), m_edges, DotGraph::m_graphFormat, m_rootNode, DotGraph::m_theGraph, m_usedNodes, TextStream::str(), TRUE, DotGraph::writeGraphFooter() , 以及 writeGraphHeader().

◆ getBaseName()

QCString DotGroupCollaboration::getBaseName ( ) const

protectedvirtual

实现了 DotGraph.

在文件 dotgroupcollaboration.cpp 第 204 行定义.

 {
   return m_diskName;
 }

引用了 m_diskName.

◆ getMapLabel()

QCString DotGroupCollaboration::getMapLabel ( ) const

protectedvirtual

实现了 DotGraph.

在文件 dotgroupcollaboration.cpp 第 237 行定义.

 {
   return escapeCharsInString(m_baseName, FALSE);
 }

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

◆ isTrivial()

bool DotGroupCollaboration::isTrivial ( ) const

在文件 dotgroupcollaboration.cpp 第 312 行定义.

 {
   return m_usedNodes.size() <= 1;
 }

引用了 m_usedNodes.

被这些函数引用 GroupDefImpl::writeGroupGraph().

◆ writeGraph()

QCString DotGroupCollaboration::writeGraph	(	TextStream &	t,
		GraphOutputFormat	gf,
		EmbeddedOutputFormat	ef,
		const QCString &	path,
		const QCString &	fileName,
		const QCString &	relPath,
		bool	writeImageMap = `TRUE`,
		int	graphId = `-1`
	)

在文件 dotgroupcollaboration.cpp 第 242 行定义.

 {
   m_doNotAddImageToIndex = TRUE;
  
   return DotGraph::writeGraph(t, graphFormat, textFormat, path, fileName, relPath, generateImageMap, graphId);
 }

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

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

◆ writeGraphHeader()

void DotGroupCollaboration::writeGraphHeader	(	TextStream &	t,
		const QCString &	title
	)		const

private

在文件 dotgroupcollaboration.cpp 第 317 行定义.

 {
   int fontSize      = Config_getInt(DOT_FONTSIZE);
   QCString fontName = Config_getString(DOT_FONTNAME);
   t << "digraph ";
   if (title.isEmpty())
   {
     t << "\"Dot Graph\"";
   }
   else
   {
     t << "\"" << convertToXML(title) << "\"";
   }
   t << "\n";
   t << "{\n";
   if (Config_getBool(DOT_TRANSPARENT))
   {
     t << "  bgcolor=\"transparent\";\n";
   }
   t << "  edge [fontname=\"" << fontName << "\",fontsize=\"" << fontSize << "\","
     "labelfontname=\"" << fontName << "\",labelfontsize=\"" << fontSize << "\"];\n";
   t << "  node [fontname=\"" << fontName << "\",fontsize=\"" << fontSize << "\",shape=box];\n";
   t << "  rankdir=LR;\n";
 }

引用了 Config_getBool, Config_getInt, Config_getString, convertToXML() , 以及 QCString::isEmpty().

被这些函数引用 computeTheGraph().

类成员变量说明

◆ m_diskName

QCString DotGroupCollaboration::m_diskName

private

在文件 dotgroupcollaboration.h 第 84 行定义.

被这些函数引用 DotGroupCollaboration() , 以及 getBaseName().

◆ m_edges

std::vector< std::unique_ptr<Edge> > DotGroupCollaboration::m_edges

private

在文件 dotgroupcollaboration.h 第 85 行定义.

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

◆ m_rootNode

DotNode* DotGroupCollaboration::m_rootNode

private

在文件 dotgroupcollaboration.h 第 82 行定义.

被这些函数引用 addCollaborationMember(), buildGraph(), computeTheGraph() , 以及 DotGroupCollaboration().

◆ m_usedNodes

DotNodeMap DotGroupCollaboration::m_usedNodes

private

在文件 dotgroupcollaboration.h 第 83 行定义.

被这些函数引用 addCollaborationMember(), buildGraph(), computeTheGraph(), DotGroupCollaboration(), isTrivial() , 以及 ~DotGroupCollaboration().

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

src/dotgroupcollaboration.h
src/dotgroupcollaboration.cpp

类

Public 成员函数

Protected 成员函数

Private 类型

Private 成员函数

Private 属性

额外继承的成员函数

详细描述

成员枚举类型说明

◆ EdgeType

构造及析构函数说明

◆ DotGroupCollaboration()

◆ ~DotGroupCollaboration()

成员函数说明

◆ addCollaborationMember()

◆ addEdge()

◆ addMemberList()

◆ buildGraph()

◆ computeTheGraph()

◆ getBaseName()

◆ getMapLabel()

◆ isTrivial()

◆ writeGraph()

◆ writeGraphHeader()

类成员变量说明

◆ m_diskName

◆ m_edges

◆ m_rootNode

◆ m_usedNodes