Represents a graphical class hierarchy 更多...

#include <dotgfxhierarchytable.h>

类 DotGfxHierarchyTable 继承关系图:

DotGfxHierarchyTable 的协作图:

Public 成员函数
	DotGfxHierarchyTable (const QCString &prefix="", ClassDef::CompoundType ct=ClassDef::Class)

void	createGraph (DotNode *rootNode, TextStream &t, const QCString &path, const QCString &fileName, int id)

void	writeGraph (TextStream &t, const QCString &path, const QCString &fileName)

const std::vector< DotNode * >	subGraphs () 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 类型
using	DotNodeMap = std::unordered_multimap< std::string, std::unique_ptr< DotNode > >

Private 成员函数
void	addHierarchy (DotNode n, const ClassDef cd, ClassDefSet &visited)

void	addClassList (const ClassLinkedMap &cl, ClassDefSet &visited)

Private 属性
int	m_graphId

QCString	m_prefix

ClassDef::CompoundType	m_classType

std::vector< DotNode * >	m_rootNodes

DotNodeMap	m_usedNodes

std::vector< DotNode * >	m_rootSubgraphs

DotNode *	m_rootSubgraphNode

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

详细描述

Represents a graphical class hierarchy

在文件 dotgfxhierarchytable.h 第 31 行定义.

成员类型定义说明

◆ DotNodeMap

using DotGfxHierarchyTable::DotNodeMap = std::unordered_multimap< std::string, std::unique_ptr<DotNode> >

private

在文件 dotgfxhierarchytable.h 第 49 行定义.

构造及析构函数说明

◆ DotGfxHierarchyTable()

DotGfxHierarchyTable::DotGfxHierarchyTable	(	const QCString &	prefix = `""`,
		ClassDef::CompoundType	ct = `ClassDef::Class`
	)

在文件 dotgfxhierarchytable.cpp 第 226 行定义.

   : m_prefix(prefix)
   , m_classType(ct)
 {
   // build a graph with each class as a node and the inheritance relations
   // as edges
   ClassDefSet visitedClasses;
   addClassList(*Doxygen::classLinkedMap,visitedClasses);
   addClassList(*Doxygen::hiddenClassLinkedMap,visitedClasses);
   // m_usedNodes now contains all nodes in the graph
  
   // color the graph into a set of independent subgraphs
   bool done=FALSE;
   int curColor=0;
   while (!done) // there are still nodes to color
   {
     done=TRUE; // we are done unless there are still uncolored nodes
     for (auto n : m_rootNodes)
     {
       if (n->subgraphId()==-1) // not yet colored
       {
         //printf("Starting at node %s (%p): %d\n",qPrint(n->label()),n,curColor);
         done=FALSE; // still uncolored nodes
         n->setSubgraphId(curColor);
         n->markAsVisible();
         n->colorConnectedNodes(curColor);
         curColor++;
         m_rootSubgraphs.push_back(n);
       }
     }
   }
  
   //printf("Number of independent subgraphs: %d\n",curColor);
   for (auto n : m_rootSubgraphs)
   {
     //printf("Node %s color=%d (c=%d,p=%d)\n",
     //    qPrint(n->label()),n->m_subgraphId,
     //    n->children()?n->children()->count():0,
     //    n->parents()?n->parents()->count():0);
     int number=0;
     n->renumberNodes(number);
   }
 }

引用了 addClassList(), Doxygen::classLinkedMap, FALSE, Doxygen::hiddenClassLinkedMap, m_rootNodes, m_rootSubgraphs , 以及 TRUE.

成员函数说明

◆ addClassList()

void DotGfxHierarchyTable::addClassList	(	const ClassLinkedMap &	cl,
		ClassDefSet &	visited
	)

private

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

 {
   for (const auto &cd : cl)
   {
     //printf("Trying %s subClasses=%d\n",qPrint(cd->name()),cd->subClasses()->count());
     if (cd->getLanguage()==SrcLangExt_VHDL &&
       (VhdlDocGen::VhdlClasses)cd->protection()!=VhdlDocGen::ENTITYCLASS
       )
     {
       continue;
     }
     if (Config_getBool(OPTIMIZE_OUTPUT_SLICE) && cd->compoundType() != m_classType)
     {
       continue;
     }
     if (!hasVisibleRoot(cd->baseClasses()) &&
       cd->isVisibleInHierarchy()
       ) // root node in the forest
     {
       QCString tmp_url="";
       if (cd->isLinkable() && !cd->isHidden())
       {
         tmp_url=cd->getReference()+"$"+cd->getOutputFileBase();
         if (!cd->anchor().isEmpty())
         {
           tmp_url+="#"+cd->anchor();
         }
       }
       //printf("Inserting root class %s\n",qPrint(cd->name()));
       QCString tooltip = cd->briefDescriptionAsTooltip();
       auto n = std::make_unique<DotNode>(getNextNodeNumber(),
         cd->displayName(),
         tooltip,
         tmp_url);
       DotNode *root = n.get();
  
       m_usedNodes.insert(std::make_pair(cd->name().str(),std::move(n)));
       m_rootNodes.push_back(root);
       if (visitedClasses.find(cd.get())==visitedClasses.end() && !cd->subClasses().empty())
       {
         addHierarchy(root,cd.get(),visitedClasses);
         visitedClasses.insert(cd.get());
       }
     }
   }
 }

引用了 addHierarchy(), Config_getBool, VhdlDocGen::ENTITYCLASS, DotGraph::getNextNodeNumber(), hasVisibleRoot(), m_classType, m_rootNodes, m_usedNodes , 以及 SrcLangExt_VHDL.

被这些函数引用 DotGfxHierarchyTable().

◆ addHierarchy()

void DotGfxHierarchyTable::addHierarchy	(	DotNode *	n,
		const ClassDef *	cd,
		ClassDefSet &	visited
	)

private

在文件 dotgfxhierarchytable.cpp 第 105 行定义.

 {
   //printf("addHierarchy '%s' baseClasses=%d\n",qPrint(cd->name()),cd->baseClasses()->count());
   for (const auto &bcd : cd->subClasses())
   {
     ClassDef *bClass=bcd.classDef;
     //printf("  Trying sub class='%s' usedNodes=%d\n",qPrint(bClass->name()),m_usedNodes->count());
     if (bClass && bClass->isVisibleInHierarchy() && hasVisibleRoot(bClass->baseClasses()))
     {
       auto it = m_usedNodes.find(bClass->name().str());
       //printf("  Node '%s' Found visible class='%s'\n",qPrint(n->label()),
       //                                              qPrint(bClass->name()));
       DotNode *root = 0;
       if (it!=m_usedNodes.end()) // node already present
       {
         const auto &bn = it->second;
         root = bn.get();
         const auto &children = n->children();
         auto child_it = std::find(children.begin(),children.end(),bn.get());
         if (child_it==children.end()) // no arrow yet
         {
           n->addChild(bn.get(),bcd.prot);
           bn->addParent(n);
           //printf("  Adding node %s to existing base node %s (c=%d,p=%d)\n",
           //       qPrint(n->label()),
           //       qPrint(bn->label()),
           //       bn->children() ? bn->children()->count() : 0,
           //       bn->parents()  ? bn->parents()->count()  : 0
           //     );
         }
         //else
         //{
         //  printf("  Class already has an arrow!\n");
         //}
       }
       else
       {
         QCString tmp_url="";
         if (bClass->isLinkable() && !bClass->isHidden())
         {
           tmp_url=bClass->getReference()+"$"+bClass->getOutputFileBase();
           if (!bClass->anchor().isEmpty())
           {
             tmp_url+="#"+bClass->anchor();
           }
         }
         QCString tooltip = bClass->briefDescriptionAsTooltip();
         auto bn = std::make_unique<DotNode>(getNextNodeNumber(),
             bClass->displayName(),
             tooltip,
             tmp_url
             );
         n->addChild(bn.get(),bcd.prot);
         bn->addParent(n);
         root = bn.get();
         //printf("  Adding node %s to new base node %s (c=%d,p=%d)\n",
         //   qPrint(n->label()),
         //   qPrint(bn->label()),
         //   bn->children() ? bn->children()->count() : 0,
         //   bn->parents()  ? bn->parents()->count()  : 0
         //  );
         //printf("  inserting %s (%p)\n",qPrint(bClass->name()),bn);
         m_usedNodes.insert(std::make_pair(bClass->name().str(),std::move(bn))); // add node to the used list
       }
       if (visitedClasses.find(bClass)==visitedClasses.end() && !bClass->subClasses().empty())
       {
         visitedClasses.insert(bClass);
         addHierarchy(root,bClass,visitedClasses);
       }
     }
   }
   //printf("end addHierarchy\n");
 }

引用了 DotNode::addChild(), ClassDef::anchor(), ClassDef::baseClasses(), Definition::briefDescriptionAsTooltip(), DotNode::children(), ClassDef::displayName(), DotGraph::getNextNodeNumber(), ClassDef::getOutputFileBase(), ClassDef::getReference(), hasVisibleRoot(), QCString::isEmpty(), Definition::isHidden(), ClassDef::isLinkable(), ClassDef::isVisibleInHierarchy(), m_usedNodes, Definition::name(), QCString::str() , 以及 ClassDef::subClasses().

被这些函数引用 addClassList().

◆ computeTheGraph()

void DotGfxHierarchyTable::computeTheGraph ( )

protectedvirtual

实现了 DotGraph.

在文件 dotgfxhierarchytable.cpp 第 37 行定义.

 {
   TextStream md5stream;
   writeGraphHeader(md5stream,theTranslator->trGraphicalHierarchy());
   md5stream << "  rankdir=\"LR\";\n";
   for (auto node : m_rootNodes)
   {
     if (node->subgraphId()==m_rootSubgraphNode->subgraphId())
     {
       node->clearWriteFlag();
     }
   }
   for (auto node : m_rootNodes)
   {
     if (node->subgraphId()==m_rootSubgraphNode->subgraphId())
     {
       node->write(md5stream,Hierarchy,GOF_BITMAP,FALSE,TRUE,TRUE);
     }
   }
   writeGraphFooter(md5stream);
   m_theGraph = md5stream.str();
 }

引用了 FALSE, GOF_BITMAP, Hierarchy, m_rootNodes, m_rootSubgraphNode, DotGraph::m_theGraph, TextStream::str(), DotNode::subgraphId(), theTranslator, Translator::trGraphicalHierarchy(), TRUE, TextStream::write(), DotGraph::writeGraphFooter() , 以及 DotGraph::writeGraphHeader().

◆ createGraph()

void DotGfxHierarchyTable::createGraph	(	DotNode *	rootNode,
		TextStream &	t,
		const QCString &	path,
		const QCString &	fileName,
		int	id
	)

在文件 dotgfxhierarchytable.cpp 第 65 行定义.

 {
   m_rootSubgraphNode = n;
   m_graphId = id;
   m_noDivTag = TRUE;
   m_zoomable = FALSE;
   DotGraph::writeGraph(out, GOF_BITMAP, EOF_Html, path, fileName, "", TRUE, 0);
 }

引用了 EOF_Html, FALSE, GOF_BITMAP, m_graphId, DotGraph::m_noDivTag, m_rootSubgraphNode, DotGraph::m_zoomable, TRUE , 以及 DotGraph::writeGraph().

被这些函数引用 writeGraph().

◆ getBaseName()

QCString DotGfxHierarchyTable::getBaseName ( ) const

protectedvirtual

实现了 DotGraph.

在文件 dotgfxhierarchytable.cpp 第 27 行定义.

 {
   QCString baseName;
   if (m_prefix.isEmpty())
     baseName.sprintf("inherit_graph_%d", m_graphId);
   else
     baseName.sprintf("%sinherit_graph_%d",qPrint(m_prefix), m_graphId);
   return baseName;
 }

引用了 QCString::isEmpty(), m_graphId, m_prefix, qPrint() , 以及 QCString::sprintf().

◆ getMapLabel()

QCString DotGfxHierarchyTable::getMapLabel ( ) const

protectedvirtual

实现了 DotGraph.

在文件 dotgfxhierarchytable.cpp 第 60 行定义.

 {
   return escapeCharsInString(m_rootSubgraphNode->label(),FALSE);
 }

引用了 escapeCharsInString(), FALSE, DotNode::label() , 以及 m_rootSubgraphNode.

◆ subGraphs()

const std::vector<DotNode*> DotGfxHierarchyTable::subGraphs ( ) const

inline

在文件 dotgfxhierarchytable.h 第 38 行定义.

38 { return m_rootSubgraphs; }

引用了 m_rootSubgraphs.

◆ writeGraph()

void DotGfxHierarchyTable::writeGraph	(	TextStream &	t,
		const QCString &	path,
		const QCString &	fileName
	)

在文件 dotgfxhierarchytable.cpp 第 75 行定义.

 {
   //printf("DotGfxHierarchyTable::writeGraph(%s)\n",name);
   //printf("m_rootNodes=%p count=%d\n",m_rootNodes,m_rootNodes->count());
  
   if (m_rootSubgraphs.empty()) return;
  
   Dir d(path.str());
   // store the original directory
   if (!d.exists())
   {
     term("Output dir %s does not exist!\n",qPrint(path));
   }
  
   // put each connected subgraph of the hierarchy in a row of the HTML output
   out << "<table border=\"0\" cellspacing=\"10\" cellpadding=\"0\">\n";
  
   int count=0;
   std::sort(m_rootSubgraphs.begin(),m_rootSubgraphs.end(),
             [](auto n1,auto n2) { return qstricmp(n1->label(),n2->label())<0; });
   for (auto n : m_rootSubgraphs)
   {
     out << "<tr><td>";
     createGraph(n,out,path,fileName,count++);
     out << "</td></tr>\n";
   }
   out << "</table>\n";
 }

引用了 createGraph(), Dir::exists(), m_rootSubgraphs, qPrint(), QCString::str() , 以及 term().

被这些函数引用 HtmlGenerator::writeGraphicalHierarchy().

类成员变量说明

◆ m_classType

ClassDef::CompoundType DotGfxHierarchyTable::m_classType

private

在文件 dotgfxhierarchytable.h 第 52 行定义.

被这些函数引用 addClassList().

◆ m_graphId

int DotGfxHierarchyTable::m_graphId

private

在文件 dotgfxhierarchytable.h 第 50 行定义.

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

◆ m_prefix

QCString DotGfxHierarchyTable::m_prefix

private

在文件 dotgfxhierarchytable.h 第 51 行定义.

被这些函数引用 getBaseName().

◆ m_rootNodes

std::vector<DotNode*> DotGfxHierarchyTable::m_rootNodes

private

在文件 dotgfxhierarchytable.h 第 53 行定义.

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

◆ m_rootSubgraphNode

DotNode* DotGfxHierarchyTable::m_rootSubgraphNode

private

在文件 dotgfxhierarchytable.h 第 56 行定义.

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

◆ m_rootSubgraphs

std::vector<DotNode*> DotGfxHierarchyTable::m_rootSubgraphs

private

在文件 dotgfxhierarchytable.h 第 55 行定义.

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

◆ m_usedNodes

DotNodeMap DotGfxHierarchyTable::m_usedNodes

private

在文件 dotgfxhierarchytable.h 第 54 行定义.

被这些函数引用 addClassList() , 以及 addHierarchy().

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

src/dotgfxhierarchytable.h
src/dotgfxhierarchytable.cpp

Public 成员函数

Protected 成员函数

Private 类型

Private 成员函数

Private 属性

额外继承的成员函数

详细描述

成员类型定义说明

◆ DotNodeMap

构造及析构函数说明

◆ DotGfxHierarchyTable()

成员函数说明

◆ addClassList()

◆ addHierarchy()

◆ computeTheGraph()

◆ createGraph()

◆ getBaseName()

◆ getMapLabel()

◆ subGraphs()

◆ writeGraph()

类成员变量说明

◆ m_classType

◆ m_graphId

◆ m_prefix

◆ m_rootNodes

◆ m_rootSubgraphNode

◆ m_rootSubgraphs

◆ m_usedNodes