A node in a dot graph. More...

#include <src/dotnode.h>

Collaboration diagram for DotNode:

Public Types
enum class	LabelStyle { Plain , List , Table }
enum	TruncState { Unknown , Truncated , Untruncated }

Public Member Functions
	DotNode (DotGraph graph, const QCString &lab, const QCString &tip, const QCString &url, bool rootNode=FALSE, const ClassDef cd=nullptr)
void	addChild (DotNode *n, EdgeInfo::Colors edgeColor=EdgeInfo::Purple, EdgeInfo::Styles edgeStyle=EdgeInfo::Solid, const QCString &edgeLab=QCString(), const QCString &edgeURL=QCString(), int edgeLabCol=-1)
void	addParent (DotNode *n)
void	deleteNode (DotNodeRefVector &deletedList)
void	removeChild (DotNode *n)
void	removeParent (DotNode *n)
int	findParent (DotNode *n)
void	write (TextStream &t, GraphType gt, GraphOutputFormat f, bool topDown, bool toChildren, bool backArrows)
void	writeXML (TextStream &t, bool isClassGraph) const
void	writeDocbook (TextStream &t, bool isClassGraph) const
void	writeDEF (TextStream &t) const
void	writeLabel (TextStream &t, GraphType gt) const
void	writeUrl (TextStream &t) const
void	writeBox (TextStream &t, GraphType gt, GraphOutputFormat f, bool hasNonReachableChildren) const
void	writeArrow (TextStream &t, GraphType gt, GraphOutputFormat f, const DotNode cn, const EdgeInfo ei, bool topDown, bool pointBack=TRUE) const
QCString	label () const
int	number () const
bool	isVisible () const
TruncState	isTruncated () const
int	distance () const
int	subgraphId () const
bool	isRenumbered () const
bool	hasDocumentation () const
bool	isWritten () const
void	clearWriteFlag ()
void	renumberNodes (int &number)
void	markRenumbered ()
DotNode &	markHasDocumentation ()
void	setSubgraphId (int id)
void	colorConnectedNodes (int curColor)
void	setDistance (int distance)
void	markAsVisible (bool b=TRUE)
DotNode &	markAsTruncated (bool b=TRUE)
const DotNodeRefVector &	children () const
const DotNodeRefVector &	parents () const
const EdgeInfoVector &	edgeInfo () const
DotNode &	setNodeId (int number)

Static Public Member Functions
static void	deleteNodes (DotNode *node)
static QCString	convertLabel (const QCString &, LabelStyle=LabelStyle::Plain)

Static Public Attributes
static constexpr auto	placeholderUrl = "-"

Private Attributes
DotGraph *	m_graph
int	m_number
QCString	m_label
	label text
QCString	m_tooltip
	node's tooltip
QCString	m_url
	url of the node (format: remote$local)
DotNodeRefVector	m_parents
	list of parent nodes (incoming arrows)
DotNodeRefVector	m_children
	list of child nodes (outgoing arrows)
EdgeInfoVector	m_edgeInfo
	edge info for each child
bool	m_deleted = false
	used to mark a node as deleted
bool	m_written = false
	used to mark a node as written
bool	m_hasDoc = false
	used to mark a node as documented
bool	m_isRoot
	indicates if this is a root node
const ClassDef *	m_classDef
	class representing this node (can be 0)
bool	m_visible = false
	is the node visible in the output
TruncState	m_truncated = Unknown
	does the node have non-visible children/parents
int	m_distance = 1000
	shortest path to the root node
bool	m_renumbered = false
	indicates if the node has been renumbered (to prevent endless loops)
int	m_subgraphId = -1

Detailed Description

A node in a dot graph.

Definition at line 67 of file dotnode.h.

Member Enumeration Documentation

◆ LabelStyle

enum class DotNode::LabelStyle

strong

Enumerator
Plain
List
Table

Definition at line 70 of file dotnode.h.

70{ Plain, List, Table };

OutputType::List

@ List

Definition outputgen.h:59

◆ TruncState

enum DotNode::TruncState

Enumerator
Unknown
Truncated
Untruncated

Definition at line 77 of file dotnode.h.

77{ Unknown, Truncated, Untruncated };

DotNode::Truncated

@ Truncated

Definition dotnode.h:77

DotNode::Untruncated

@ Untruncated

Definition dotnode.h:77

DotNode::Unknown

@ Unknown

Definition dotnode.h:77

Constructor & Destructor Documentation

◆ DotNode()

DotNode::DotNode	(	DotGraph *	graph,
		const QCString &	lab,
		const QCString &	tip,
		const QCString &	url,
		bool	rootNode = FALSE,
		const ClassDef *	cd = nullptr )

Definition at line 326 of file dotnode.cpp.

  : m_graph(graph)
  , m_number(graph->getNextNodeNumber())
  , m_label(lab)
  , m_tooltip(tip)
  , m_url(url)
  , m_isRoot(isRoot)
  , m_classDef(cd)
{
}

References m_classDef, m_graph, m_isRoot, m_label, m_number, m_tooltip, and m_url.

Referenced by addChild(), addParent(), deleteNodes(), findParent(), markAsTruncated(), markHasDocumentation(), removeChild(), removeParent(), setNodeId(), and writeArrow().

Member Function Documentation

◆ addChild()

void DotNode::addChild	(	DotNode *	n,
		EdgeInfo::Colors	edgeColor = EdgeInfo::Purple,
		EdgeInfo::Styles	edgeStyle = EdgeInfo::Solid,
		const QCString &	edgeLab = QCString(),
		const QCString &	edgeURL = QCString(),
		int	edgeLabCol = -1 )

Definition at line 338 of file dotnode.cpp.

{
  m_children.push_back(n);
  m_edgeInfo.emplace_back(
      edgeColor,
      edgeStyle,
      edgeLab,
      edgeURL,
      edgeLabCol==-1 ? edgeColor : edgeLabCol);
}

References DotNode(), m_children, and m_edgeInfo.

Referenced by DotClassGraph::addClass(), DotGfxHierarchyTable::addHierarchy(), DotCallGraph::buildGraph(), and DotInclDepGraph::buildGraph().

◆ addParent()

void DotNode::addParent ( DotNode * n )

Definition at line 355 of file dotnode.cpp.

{
  m_parents.push_back(n);
}

References DotNode(), and m_parents.

Referenced by DotClassGraph::addClass(), DotCallGraph::buildGraph(), and DotInclDepGraph::buildGraph().

◆ children()

const DotNodeRefVector & DotNode::children ( ) const

inline

Definition at line 123 of file dotnode.h.

123{ return m_children; }

References m_children.

Referenced by DotGfxHierarchyTable::addHierarchy(), DotCallGraph::determineTruncatedNodes(), DotClassGraph::determineTruncatedNodes(), DotInclDepGraph::determineTruncatedNodes(), DotCallGraph::determineVisibleNodes(), DotClassGraph::determineVisibleNodes(), DotInclDepGraph::determineVisibleNodes(), and write().

◆ clearWriteFlag()

void DotNode::clearWriteFlag ( )

Definition at line 887 of file dotnode.cpp.

{
  m_written=FALSE;
  for (const auto &pn : m_parents)  if (pn->isWritten()) pn->clearWriteFlag();
  for (const auto &cn : m_children) if (cn->isWritten()) cn->clearWriteFlag();
}

References FALSE, m_children, m_parents, and m_written.

Referenced by DotGraph::computeGraph().

◆ colorConnectedNodes()

void DotNode::colorConnectedNodes ( int curColor )

Definition at line 894 of file dotnode.cpp.

{
  for (const auto &cn : m_children)
  {
    if (cn->subgraphId()==-1) // uncolored child node
    {
      cn->setSubgraphId(curColor);
      cn->markAsVisible();
      cn->colorConnectedNodes(curColor);
      //printf("coloring node %s (%p): %d\n",qPrint(cn->label()),cn,cn->subgraphId());
    }
  }
 
  for (const auto &pn : m_parents)
  {
    if (pn->subgraphId()==-1) // uncolored parent node
    {
      pn->setSubgraphId(curColor);
      pn->markAsVisible();
      pn->colorConnectedNodes(curColor);
      //printf("coloring node %s (%p): %d\n",qPrint(pn->label()),pn,pn->subgraphId());
    }
  }
}

References m_children, and m_parents.

◆ convertLabel()

QCString DotNode::convertLabel	(	const QCString &	l,
		LabelStyle	style = LabelStyle::Plain )

static

Definition at line 196 of file dotnode.cpp.

{
  QCString bBefore("\\_/<({[: =-+@%#~?$"); // break before character set
  QCString bAfter(">]),:;|");              // break after  character set
  if (l.isEmpty()) return QCString();
  QCString result;
  char pc=0;
  uint32_t idx = 0;
  int charsLeft=static_cast<int>(l.length());
  int sinceLast=0;
  int foldLen = Config_getInt(DOT_WRAP_THRESHOLD); // ideal text length
  QCString br;
  QCString br1;
  if (style==LabelStyle::Table)
  {
    result += "<<TABLE CELLBORDER=\"0\" BORDER=\"0\"><TR><TD VALIGN=\"top\" ALIGN=\"LEFT\" CELLPADDING=\"1\" CELLSPACING=\"0\">";
  }
  if (style==LabelStyle::List)
  {
    br = "<BR ALIGN=\"LEFT\"/>";
  }
  else if (style==LabelStyle::Table)
  {
    br1 = "</TD></TR>\n<TR><TD VALIGN=\"top\" ALIGN=\"LEFT\" CELLPADDING=\"1\" CELLSPACING=\"0\">";
    br = br1 + "&nbsp;&nbsp;";
  }
  else // style==LabelStyle::Plain
  {
    br = "\\l";
  }
  while (idx < l.length())
  {
    char c = l[idx++];
    char cs[2] = { c, 0 };
    const char *replacement = cs;
    if (style!=LabelStyle::Plain)
    {
      switch(c)
      {
        case '\\': replacement="\\\\";   break;
        case '\n': replacement="\\n";    break;
        case '<':  replacement="&lt;";   break;
        case '>':  replacement="&gt;";   break;
        case '"':  replacement="&quot;"; break;
        case '\'': replacement="&apos;"; break;
        case '&':  replacement="&amp;";  break;
      }
    }
    else // style==LabelStyle::Plain
    {
      switch(c)
      {
        case '\\': replacement="\\\\"; break;
        case '\n': replacement="\\n";  break;
        case '<':  replacement="\\<";  break;
        case '>':  replacement="\\>";  break;
        case '"':  replacement="\\\""; break;
        case '|':  replacement="\\|";  break;
        case '{':  replacement="\\{";  break;
        case '}':  replacement="\\}";  break;
      }
    }
    // Some heuristics to insert newlines to prevent too long
    // boxes and at the same time prevent ugly breaks
    if (c=='\n')
    {
      if (style==LabelStyle::Table)
      {
        result+=br1;
      }
      else
      {
        result+=replacement;
      }
      foldLen = (3*foldLen+sinceLast+2)/4;
      sinceLast=1;
    }
    else if ((pc!=':' || c!=':') && charsLeft>foldLen/3 && sinceLast>foldLen && bBefore.contains(c))
    {
      result+=br;
      result+=replacement;
      foldLen = (foldLen+sinceLast+1)/2;
      sinceLast=1;
    }
    else if (charsLeft>1+foldLen/4 && sinceLast>foldLen+foldLen/3 &&
      !isupper(c) && isupper(l[idx]))
    {
      result+=replacement;
      result+=br;
      foldLen = (foldLen+sinceLast+1)/2;
      sinceLast=0;
    }
    else if (charsLeft>foldLen/3 && sinceLast>foldLen && bAfter.contains(c) && (c!=':' || l[idx]!=':'))
    {
      result+=replacement;
      result+=br;
      foldLen = (foldLen+sinceLast+1)/2;
      sinceLast=0;
    }
    else
    {
      result+=replacement;
      sinceLast++;
    }
    charsLeft--;
    pc=c;
  }
  if (style==LabelStyle::List)
  {
     result = result.stripWhiteSpace();
  }
  if (style==LabelStyle::Table)
  {
    result += "</TD></TR>\n</TABLE>>";
  }
  return result;
}

References Config_getInt, QCString::contains(), QCString::isEmpty(), QCString::length(), List, Plain, QCString::stripWhiteSpace(), and Table.

Referenced by drawClusterOpening(), drawDirectory(), DotGroupCollaboration::Edge::write(), writeArrow(), writeBoxMemberList(), and writeLabel().

◆ deleteNode()

void DotNode::deleteNode ( DotNodeRefVector & deletedList )

Definition at line 372 of file dotnode.cpp.

{
  if (m_deleted) return; // avoid recursive loops in case the graph has cycles
  m_deleted=TRUE;
  // delete all parent nodes of this node
  for (const auto &pn : m_parents)
  {
    pn->deleteNode(deletedList);
  }
  // delete all child nodes of this node
  for (const auto &cn : m_children)
  {
    cn->deleteNode(deletedList);
  }
  // add this node to the list of deleted nodes.
  deletedList.push_back(this);
}

References m_children, m_deleted, m_parents, and TRUE.

Referenced by deleteNodes().

◆ deleteNodes()

void DotNode::deleteNodes ( DotNode * node )

static

helper function that deletes all nodes in a connected graph, given one of the graph's nodes

Definition at line 404 of file dotnode.cpp.

{
  DotNodeRefVector deletedNodes;
  node->deleteNode(deletedNodes); // collect nodes to be deleted.
  for (const auto &dotNode : deletedNodes)
  {
    delete dotNode;
  }
}

References deleteNode(), and DotNode().

Referenced by DotCallGraph::~DotCallGraph(), DotClassGraph::~DotClassGraph(), and DotInclDepGraph::~DotInclDepGraph().

◆ distance()

int DotNode::distance ( ) const

inline

Definition at line 107 of file dotnode.h.

107{ return m_distance; }

DotNode::m_distance

int m_distance

shortest path to the root node

Definition dotnode.h:144

References m_distance.

Referenced by DotCallGraph::determineVisibleNodes(), DotClassGraph::determineVisibleNodes(), DotInclDepGraph::determineVisibleNodes(), and setDistance().

◆ edgeInfo()

const EdgeInfoVector & DotNode::edgeInfo ( ) const

inline

Definition at line 125 of file dotnode.h.

125{ return m_edgeInfo; }

References m_edgeInfo.

Referenced by writeDEF(), writeDocbook(), and writeXML().

◆ findParent()

int DotNode::findParent ( DotNode * n )

inline

Definition at line 395 of file dotnode.cpp.

{
  auto it = std::find(m_parents.begin(),m_parents.end(),n);
  return it!=m_parents.end() ? static_cast<int>(it-m_parents.begin()) : -1;
}

References DotNode(), and m_parents.

◆ hasDocumentation()

bool DotNode::hasDocumentation ( ) const

inline

Definition at line 110 of file dotnode.h.

110{ return m_hasDoc; }

DotNode::m_hasDoc

bool m_hasDoc

used to mark a node as documented

Definition dotnode.h:139

References m_hasDoc.

◆ isRenumbered()

bool DotNode::isRenumbered ( ) const

inline

Definition at line 109 of file dotnode.h.

109{ return m_renumbered; }

DotNode::m_renumbered

bool m_renumbered

indicates if the node has been renumbered (to prevent endless loops)

Definition dotnode.h:145

References m_renumbered.

Referenced by renumberNodes().

◆ isTruncated()

TruncState DotNode::isTruncated ( ) const

inline

Definition at line 106 of file dotnode.h.

106{ return m_truncated; }

DotNode::m_truncated

TruncState m_truncated

does the node have non-visible children/parents

Definition dotnode.h:143

References m_truncated.

Referenced by DotCallGraph::determineTruncatedNodes(), DotClassGraph::determineTruncatedNodes(), and DotInclDepGraph::determineTruncatedNodes().

◆ isVisible()

bool DotNode::isVisible ( ) const

inline

Definition at line 105 of file dotnode.h.

105{ return m_visible; }

DotNode::m_visible

bool m_visible

is the node visible in the output

Definition dotnode.h:142

References m_visible.

Referenced by DotCallGraph::determineTruncatedNodes(), DotClassGraph::determineTruncatedNodes(), DotInclDepGraph::determineTruncatedNodes(), DotCallGraph::determineVisibleNodes(), DotClassGraph::determineVisibleNodes(), and DotInclDepGraph::determineVisibleNodes().

◆ isWritten()

bool DotNode::isWritten ( ) const

inline

Definition at line 111 of file dotnode.h.

111{ return m_written; }

References m_written.

◆ label()

QCString DotNode::label ( ) const

inline

Definition at line 103 of file dotnode.h.

103{ return m_label; }

References m_label.

Referenced by DotClassGraph::determineVisibleNodes().

◆ markAsTruncated()

DotNode & DotNode::markAsTruncated ( bool b = TRUE )

inline

Definition at line 122 of file dotnode.h.

122{ m_truncated=b ? Truncated : Untruncated; return *this;}

References DotNode(), m_truncated, TRUE, Truncated, and Untruncated.

Referenced by DotCallGraph::determineTruncatedNodes(), DotClassGraph::determineTruncatedNodes(), and DotInclDepGraph::determineTruncatedNodes().

◆ markAsVisible()

void DotNode::markAsVisible ( bool b = TRUE )

inline

Definition at line 121 of file dotnode.h.

121{ m_visible=b; }

References m_visible, and TRUE.

Referenced by DotGroupCollaboration::addCollaborationMember(), DotGroupCollaboration::buildGraph(), DotCallGraph::determineVisibleNodes(), DotClassGraph::determineVisibleNodes(), and DotInclDepGraph::determineVisibleNodes().

◆ markHasDocumentation()

DotNode & DotNode::markHasDocumentation ( )

inline

Definition at line 116 of file dotnode.h.

116{ m_hasDoc = true; return *this;}

References DotNode(), and m_hasDoc.

◆ markRenumbered()

void DotNode::markRenumbered ( )

inline

Definition at line 115 of file dotnode.h.

115{ m_renumbered = true; }

References m_renumbered.

Referenced by renumberNodes().

◆ number()

int DotNode::number ( ) const

inline

Definition at line 104 of file dotnode.h.

104{ return m_number; }

References m_number.

Referenced by renumberNodes(), setNodeId(), and writeArrow().

◆ parents()

const DotNodeRefVector & DotNode::parents ( ) const

inline

Definition at line 124 of file dotnode.h.

124{ return m_parents; }

References m_parents.

Referenced by DotGraph::computeGraph(), DotClassGraph::determineTruncatedNodes(), and DotClassGraph::determineVisibleNodes().

◆ removeChild()

void DotNode::removeChild ( DotNode * n )

Definition at line 360 of file dotnode.cpp.

{
  auto it = std::find(m_children.begin(),m_children.end(),n);
  if (it!=m_children.end()) m_children.erase(it);
}

References DotNode(), and m_children.

◆ removeParent()

void DotNode::removeParent ( DotNode * n )

Definition at line 366 of file dotnode.cpp.

{
  auto it = std::find(m_parents.begin(),m_parents.end(),n);
  if (it!=m_parents.end()) m_parents.erase(it);
}

References DotNode(), and m_parents.

◆ renumberNodes()

void DotNode::renumberNodes ( int & number )

Definition at line 921 of file dotnode.cpp.

{
  if (!isRenumbered())
  {
#if DEBUG_RENUMBERING
    static int level = 0;
    printf("%3d: ",subgraphId());
    for (int i = 0; i < level; i++) printf("  ");
    printf("> %s old = %d new = %d\n",qPrint(m_label),m_number,number);
    level++;
#endif
    m_number = number++;
    markRenumbered();
    for (const auto &cn : m_children)
    {
      cn->renumberNodes(number);
    }
    for (const auto &pn : m_parents)
    {
      pn->renumberNodes(number);
    }
#if DEBUG_RENUMBERING
    level--;
    printf("%3d: ",subgraphId());
    for (int i = 0; i < level; i++) printf("  ");
    printf("< %s assigned = %d\n",qPrint(m_label),m_number);
#endif
  }
}

References isRenumbered(), m_children, m_label, m_number, m_parents, markRenumbered(), number(), qPrint(), and subgraphId().

◆ setDistance()

void DotNode::setDistance ( int distance )

Definition at line 390 of file dotnode.cpp.

{
  if (distance<m_distance) m_distance = distance;
}

References distance(), and m_distance.

Referenced by DotClassGraph::addClass(), DotCallGraph::buildGraph(), and DotInclDepGraph::buildGraph().

◆ setNodeId()

DotNode & DotNode::setNodeId ( int number )

inline

Definition at line 126 of file dotnode.h.

126{ m_number=number; return *this; }

References DotNode(), m_number, and number().

◆ setSubgraphId()

void DotNode::setSubgraphId ( int id )

inline

Definition at line 117 of file dotnode.h.

117{ m_subgraphId = id; }

DotNode::m_subgraphId

int m_subgraphId

Definition dotnode.h:146

References m_subgraphId.

◆ subgraphId()

int DotNode::subgraphId ( ) const

inline

Definition at line 108 of file dotnode.h.

108{ return m_subgraphId; }

References m_subgraphId.

Referenced by renumberNodes().

◆ write()

void DotNode::write	(	TextStream &	t,
		GraphType	gt,
		GraphOutputFormat	f,
		bool	topDown,
		bool	toChildren,
		bool	backArrows )

Definition at line 654 of file dotnode.cpp.

{
  //printf("DotNode::write(%d) name=%s this=%p written=%d visible=%d\n",m_distance,qPrint(m_label),this,m_written,m_visible);
  if (m_written) return; // node already written to the output
  if (!m_visible) return; // node is not visible
  writeBox(t,gt,format,m_truncated==Truncated);
  m_written=TRUE;
  if (toChildren)
  {
    auto it = m_edgeInfo.begin();
    for (const auto &cn : m_children)
    {
      if (cn->isVisible())
      {
        //printf("write arrow %s%s%s\n",qPrint(label()),backArrows?"<-":"->",qPrint(cn->label()));
        writeArrow(t,gt,format,cn,&(*it),topDown,backArrows);
      }
      cn->write(t,gt,format,topDown,toChildren,backArrows);
      ++it;
    }
  }
  else // render parents
  {
    for (const auto &pn : m_parents)
    {
      if (pn->isVisible())
      {
        const auto &children = pn->children();
        auto child_it = std::find(children.begin(),children.end(),this);
        size_t index = child_it - children.begin();
        //printf("write arrow %s%s%s\n",qPrint(label()),backArrows?"<-":"->",qPrint(pn->label()));
        writeArrow(t,
          gt,
          format,
          pn,
          &pn->edgeInfo()[index],
          FALSE,
          backArrows
        );
      }
      pn->write(t,gt,format,TRUE,FALSE,backArrows);
    }
  }
  //printf("end DotNode::write(%d) name=%s\n",distance,qPrint(m_label));
}

References children(), FALSE, m_children, m_edgeInfo, m_parents, m_truncated, m_visible, m_written, TRUE, Truncated, writeArrow(), and writeBox().

Referenced by DotGraph::computeGraph().

◆ writeArrow()

void DotNode::writeArrow	(	TextStream &	t,
		GraphType	gt,
		GraphOutputFormat	f,
		const DotNode *	cn,
		const EdgeInfo *	ei,
		bool	topDown,
		bool	pointBack = TRUE ) const

Definition at line 603 of file dotnode.cpp.

{
  t << "  Node";
  if (topDown)
    t << cn->number();
  else
    t << m_number;
  t << " -> Node";
  if (topDown)
    t << m_number;
  else
    t << cn->number();
  t << " [";
 
  const EdgeProperties *eProps = Config_getBool(UML_LOOK) ? &umlEdgeProps : &normalEdgeProps;
  QCString aStyle = eProps->arrowStyleMap[ei->color()];
  bool umlUseArrow = aStyle=="odiamond";
 
  t << "id=\"edge" << m_graph->getNextEdgeNumber() <<
       "_Node" << QCString().sprintf("%06d",m_number) <<
       "_Node" << QCString().sprintf("%06d",cn->number()) << "\",";
  if (pointBack && !umlUseArrow) t << "dir=\"back\",";
  t << "color=\"" << eProps->edgeColorMap[ei->color()] << "\",";
  t << "style=\"" << eProps->edgeStyleMap[ei->style()] << "\"";
  t << ",tooltip=\" \""; // space in tooltip is required otherwise still something like 'Node0 -> Node1' is used
  if (!ei->label().isEmpty())
  {
    t << ",label=" << convertLabel(ei->label(),LabelStyle::Table) << " ,fontcolor=\"grey\" ";
  }
  if (Config_getBool(UML_LOOK) &&
    eProps->arrowStyleMap[ei->color()] &&
    (gt==GraphType::Inheritance || gt==GraphType::Collaboration)
    )
  {
    bool rev = pointBack;
    if (umlUseArrow) rev=!rev; // UML use relates has arrow on the start side
    if (rev)
      t << ",arrowtail=\"" << eProps->arrowStyleMap[ei->color()] << "\"";
    else
      t << ",arrowhead=\"" << eProps->arrowStyleMap[ei->color()] << "\"";
  }
 
  t << "];\n";
}

References EdgeProperties::arrowStyleMap, Collaboration, EdgeInfo::color(), Config_getBool, convertLabel(), DotNode(), EdgeProperties::edgeColorMap, EdgeProperties::edgeStyleMap, Inheritance, QCString::isEmpty(), EdgeInfo::label(), m_graph, m_number, normalEdgeProps, number(), QCString::sprintf(), EdgeInfo::style(), Table, and umlEdgeProps.

Referenced by DotGraph::computeGraph(), and write().

◆ writeBox()

void DotNode::writeBox	(	TextStream &	t,
		GraphType	gt,
		GraphOutputFormat	f,
		bool	hasNonReachableChildren ) const

Definition at line 539 of file dotnode.cpp.

{
  const char *labCol = nullptr;
  const char *fillCol = "white";
  if (m_classDef)
  {
    if (m_classDef->hasDocumentation() && hasNonReachableChildren)
    {
      labCol = "red";
      fillCol = "#FFF0F0";
    }
    else if (m_classDef->hasDocumentation() && !hasNonReachableChildren)
    {
      labCol = "gray40";
    }
    else if (!m_classDef->hasDocumentation() && hasNonReachableChildren)
    {
      labCol = "orangered";
    }
    else // (!m_classDef->hasDocumentation() && !hasNonReachableChildren)
    {
      labCol = "grey75";
      if (m_classDef->templateMaster() && m_classDef->isImplicitTemplateInstance() && m_classDef->templateMaster()->hasDocumentation())
      {
        labCol = "gray40";
      }
    }
  }
  else
  {
    labCol = m_url.isEmpty() ? "grey60" :  // non link
    (hasNonReachableChildren ? "red" : "grey40");
    fillCol = m_url.isEmpty() ? "#E0E0E0" :
    (hasNonReachableChildren ? "#FFF0F0" : "white");
  }
  t << "  Node" << m_number << " [";
  t << "id=\"Node" << QCString().sprintf("%06d",m_number) << "\",";
  writeLabel(t,gt);
  t << ",height=0.2,width=0.4";
  if (m_isRoot)
  {
    t << ",color=\"gray40\", fillcolor=\"grey60\", style=\"filled\", fontcolor=\"black\"";
  }
  else
  {
    t << ",color=\"" << labCol << "\"";
    t << ", fillcolor=\"" << fillCol << "\"";
    t << ", style=\"filled\"";
    writeUrl(t);
  }
  if (!m_tooltip.isEmpty())
  {
    t << ",tooltip=\"" << escapeTooltip(m_tooltip) << "\"";
  }
  else
  {
    t << ",tooltip=\" \""; // space in tooltip is required otherwise still something like 'Node0' is used
  }
  t << "];\n";
}

References escapeTooltip(), m_classDef, m_isRoot, m_number, m_tooltip, m_url, QCString::sprintf(), writeLabel(), and writeUrl().

Referenced by write().

◆ writeDEF()

void DotNode::writeDEF ( TextStream & t ) const

Definition at line 830 of file dotnode.cpp.

{
  const char* nodePrefix = "        node-";
 
  t << "      node = {\n";
  t << nodePrefix << "id    = " << m_number << ";\n";
  t << nodePrefix << "label = '" << m_label << "';\n";
 
  if (!m_url.isEmpty())
  {
    QCString url(m_url);
    int dollarPos = url.find('$');
    if (dollarPos!=-1)
    {
      t << nodePrefix << "link = {\n" << "  "
        << nodePrefix << "link-id = '" << url.mid(dollarPos+1) << "';\n";
      if (dollarPos>0)
      {
        t << "  " << nodePrefix << "link-external = '"
          << url.left(dollarPos) << "';\n";
      }
      t << "        };\n";
    }
  }
  auto it = m_edgeInfo.begin();
  for (const auto &childNode : m_children)
  {
    const EdgeInfo &edgeInfo = *it;
    t << "        node-child = {\n";
    t << "          child-id = '" << childNode->number() << "';\n";
    t << "          relation = ";
 
    switch (edgeInfo.color())
    {
      case EdgeInfo::Blue:    t << "public-inheritance"; break;
      case EdgeInfo::Green:   t << "protected-inheritance"; break;
      case EdgeInfo::Red:     t << "private-inheritance"; break;
      case EdgeInfo::Purple:  t << "usage"; break;
      case EdgeInfo::Orange:  t << "template-instance"; break;
      case EdgeInfo::Orange2: t << "type-constraint"; break;
      case EdgeInfo::Grey:    ASSERT(0); break;
    }
    t << ";\n";
 
    if (!edgeInfo.label().isEmpty())
    {
      t << "          edgelabel = <<_EnD_oF_dEf_TeXt_\n"
        << edgeInfo.label() << "\n"
        << "_EnD_oF_dEf_TeXt_;\n";
    }
    t << "        }; /* node-child */\n";
    ++it;
  }
  t << "      }; /* node */\n";
}

References ASSERT, EdgeInfo::Blue, edgeInfo(), QCString::find(), EdgeInfo::Green, EdgeInfo::Grey, QCString::left(), m_children, m_edgeInfo, m_label, m_number, m_url, QCString::mid(), EdgeInfo::Orange, EdgeInfo::Orange2, EdgeInfo::Purple, and EdgeInfo::Red.

◆ writeDocbook()

void DotNode::writeDocbook	(	TextStream &	t,
		bool	isClassGraph ) const

Definition at line 767 of file dotnode.cpp.

{
  t << "      <node id=\"" << m_number << "\">\n";
  t << "        <label>" << convertToXML(m_label) << "</label>\n";
  if (!m_url.isEmpty())
  {
    QCString url(m_url);
    int dollarPos = url.find('$');
    if (dollarPos!=-1)
    {
      t << "        <link refid=\"" << convertToXML(url.mid(dollarPos+1)) << "\"";
      if (dollarPos>0)
      {
        t << " external=\"" << convertToXML(url.left(dollarPos)) << "\"";
      }
      t << "/>\n";
    }
  }
  auto it = m_edgeInfo.begin();
  for (const auto &childNode : m_children)
  {
    const EdgeInfo &edgeInfo = *it;
    t << "        <childnode refid=\"" << childNode->number() << "\" relation=\"";
    if (isClassGraph)
    {
      switch(edgeInfo.color())
      {
      case EdgeInfo::Blue:    t << "public-inheritance"; break;
      case EdgeInfo::Green:   t << "protected-inheritance"; break;
      case EdgeInfo::Red:     t << "private-inheritance"; break;
      case EdgeInfo::Purple:  t << "usage"; break;
      case EdgeInfo::Orange:  t << "template-instance"; break;
      case EdgeInfo::Orange2: t << "type-constraint"; break;
      case EdgeInfo::Grey:    ASSERT(0); break;
      }
    }
    else // include graph
    {
      t << "include";
    }
    t << "\">\n";
    if (!edgeInfo.label().isEmpty())
    {
      int p=0;
      int ni=0;
      while ((ni=edgeInfo.label().find('\n',p))!=-1)
      {
        t << "          <edgelabel>"
          << convertToXML(edgeInfo.label().mid(p,ni-p))
          << "</edgelabel>\n";
        p=ni+1;
      }
      t << "          <edgelabel>"
        << convertToXML(edgeInfo.label().right(edgeInfo.label().length()-p))
        << "</edgelabel>\n";
    }
    t << "        </childnode>\n";
    ++it;
  }
  t << "      </node>\n";
}

References ASSERT, EdgeInfo::Blue, convertToXML(), edgeInfo(), QCString::find(), EdgeInfo::Green, EdgeInfo::Grey, QCString::left(), m_children, m_edgeInfo, m_label, m_number, m_url, QCString::mid(), EdgeInfo::Orange, EdgeInfo::Orange2, EdgeInfo::Purple, and EdgeInfo::Red.

◆ writeLabel()

void DotNode::writeLabel	(	TextStream &	t,
		GraphType	gt ) const

Definition at line 414 of file dotnode.cpp.

{
  if (m_classDef && Config_getBool(UML_LOOK) && (gt==GraphType::Inheritance || gt==GraphType::Collaboration))
  {
    // Set shape to the plain type.
    // the UML properties and methods are rendered using dot' HTML like table format
    t << "shape=plain,label=";
    // add names shown as relations to a set, so we don't show
    // them as attributes as well
    StringUnorderedSet arrowNames;
    // for each edge
    for (const auto &ei : m_edgeInfo)
    {
      if (!ei.label().isEmpty()) // labels joined by \n
      {
        int i=0;
        int p=0;
        QCString lab;
        while ((i=ei.label().find('\n',p))!=-1)
        {
          lab = stripProtectionPrefix(ei.label().mid(p,i-p));
          arrowNames.insert(lab.str());
          p=i+1;
        }
        lab = stripProtectionPrefix(ei.label().right(ei.label().length()-p));
        arrowNames.insert(lab.str());
      }
    }
 
    constexpr auto hr_start = "<TR><TD COLSPAN=\"2\" CELLPADDING=\"1\" CELLSPACING=\"0\">";
    constexpr auto hr_end = "</TD></TR>\n";
    constexpr auto sep = "<HR/>\n";
    constexpr auto empty_line = "<TR><TD COLSPAN=\"2\" CELLPADDING=\"1\" CELLSPACING=\"0\">&nbsp;</TD></TR>\n";
    //printf("DotNode::writeBox for %s\n",qPrint(m_classDef->name()));
    t << "<<TABLE CELLBORDER=\"0\" BORDER=\"1\">";
    t << hr_start << convertLabel(m_label,LabelStyle::List) << hr_end;
    auto dotUmlDetails = Config_getEnum(DOT_UML_DETAILS);
    if (dotUmlDetails!=DOT_UML_DETAILS_t::NONE)
    {
      bool lineWritten = false;
      t << sep;
      writeBoxMemberList(t,'+',m_classDef->getMemberList(MemberListType::PubAttribs()),m_classDef,lineWritten,FALSE,&arrowNames);
      writeBoxMemberList(t,'+',m_classDef->getMemberList(MemberListType::PubStaticAttribs()),m_classDef,lineWritten,TRUE,&arrowNames);
      writeBoxMemberList(t,'+',m_classDef->getMemberList(MemberListType::Properties()),m_classDef,lineWritten,FALSE,&arrowNames);
      writeBoxMemberList(t,'~',m_classDef->getMemberList(MemberListType::PacAttribs()),m_classDef,lineWritten,FALSE,&arrowNames);
      writeBoxMemberList(t,'~',m_classDef->getMemberList(MemberListType::PacStaticAttribs()),m_classDef,lineWritten,TRUE,&arrowNames);
      writeBoxMemberList(t,'#',m_classDef->getMemberList(MemberListType::ProAttribs()),m_classDef,lineWritten,FALSE,&arrowNames);
      writeBoxMemberList(t,'#',m_classDef->getMemberList(MemberListType::ProStaticAttribs()),m_classDef,lineWritten,TRUE,&arrowNames);
      if (Config_getBool(EXTRACT_PRIVATE))
      {
        writeBoxMemberList(t,'-',m_classDef->getMemberList(MemberListType::PriAttribs()),m_classDef,lineWritten,FALSE,&arrowNames);
        writeBoxMemberList(t,'-',m_classDef->getMemberList(MemberListType::PriStaticAttribs()),m_classDef,lineWritten,TRUE,&arrowNames);
      }
      if (!lineWritten) t << empty_line;
      t << sep;
      lineWritten = false;
      writeBoxMemberList(t,'+',m_classDef->getMemberList(MemberListType::PubMethods()),m_classDef,lineWritten);
      writeBoxMemberList(t,'+',m_classDef->getMemberList(MemberListType::PubStaticMethods()),m_classDef,lineWritten,TRUE);
      writeBoxMemberList(t,'+',m_classDef->getMemberList(MemberListType::PubSlots()),m_classDef,lineWritten);
      writeBoxMemberList(t,'~',m_classDef->getMemberList(MemberListType::PacMethods()),m_classDef,lineWritten);
      writeBoxMemberList(t,'~',m_classDef->getMemberList(MemberListType::PacStaticMethods()),m_classDef,lineWritten,TRUE);
      writeBoxMemberList(t,'#',m_classDef->getMemberList(MemberListType::ProMethods()),m_classDef,lineWritten);
      writeBoxMemberList(t,'#',m_classDef->getMemberList(MemberListType::ProStaticMethods()),m_classDef,lineWritten,TRUE);
      writeBoxMemberList(t,'#',m_classDef->getMemberList(MemberListType::ProSlots()),m_classDef,lineWritten);
      if (Config_getBool(EXTRACT_PRIVATE))
      {
        writeBoxMemberList(t,'-',m_classDef->getMemberList(MemberListType::PriMethods()),m_classDef,lineWritten);
        writeBoxMemberList(t,'-',m_classDef->getMemberList(MemberListType::PriStaticMethods()),m_classDef,lineWritten,TRUE);
        writeBoxMemberList(t,'-',m_classDef->getMemberList(MemberListType::PriSlots()),m_classDef,lineWritten);
      }
      if (m_classDef->getLanguage()!=SrcLangExt::Fortran)
      {
        for (const auto &mg : m_classDef->getMemberGroups())
        {
          if (!mg->members().empty())
          {
            writeBoxMemberList(t,'*',&mg->members(),m_classDef,lineWritten,FALSE,&arrowNames);
          }
        }
      }
      if (!lineWritten) t << empty_line;
    }
    t << "</TABLE>>\n";
  }
  else if (Config_getString(DOT_NODE_ATTR).contains("shape=plain"))
  {
    t << "label=";
    if (m_isRoot)
      t << "<<b>" << convertToXML(m_label) << "</b>>";
    else if (m_truncated == Truncated)
      t << "<<i>" << convertToXML(m_label) << "</i>>";
    else
      t << '"' << convertLabel(m_label,LabelStyle::Plain) << '"';
  }
  else // standard look
  {
    t << "label=" << '"' << convertLabel(m_label,LabelStyle::Plain) << '"';
  }
}

References Collaboration, Config_getBool, Config_getEnum, Config_getString, convertLabel(), convertToXML(), FALSE, Inheritance, List, m_classDef, m_edgeInfo, m_isRoot, m_label, m_truncated, Plain, QCString::str(), stripProtectionPrefix(), TRUE, Truncated, and writeBoxMemberList().

Referenced by writeBox().

◆ writeUrl()

void DotNode::writeUrl ( TextStream & t ) const

Definition at line 514 of file dotnode.cpp.

{
  if (m_url.isEmpty() || m_url == DotNode::placeholderUrl) return;
  int tagPos = m_url.findRev('$');
  t << ",URL=\"";
  QCString noTagURL = m_url;
  if (tagPos!=-1)
  {
    t << m_url.left(tagPos);
    noTagURL = m_url.mid(tagPos);
  }
  int anchorPos = noTagURL.findRev('#');
  if (anchorPos==-1)
  {
    addHtmlExtensionIfMissing(noTagURL);
    t << noTagURL << "\"";
  }
  else // insert extensiom before anchor
  {
    QCString fn = noTagURL.left(anchorPos);
    addHtmlExtensionIfMissing(fn);
    t << fn << noTagURL.right(noTagURL.length() - anchorPos) << "\"";
  }
}

References addHtmlExtensionIfMissing(), QCString::findRev(), QCString::left(), QCString::length(), m_url, placeholderUrl, and QCString::right().

Referenced by writeBox().

◆ writeXML()

void DotNode::writeXML	(	TextStream &	t,
		bool	isClassGraph ) const

Definition at line 705 of file dotnode.cpp.

{
  t << "      <node id=\"" << m_number << "\">\n";
  t << "        <label>" << convertToXML(m_label) << "</label>\n";
  if (!m_url.isEmpty())
  {
    QCString url(m_url);
    int dollarPos = url.find('$');
    if (dollarPos!=-1)
    {
      t << "        <link refid=\"" << convertToXML(url.mid(dollarPos+1)) << "\"";
      if (dollarPos>0)
      {
        t << " external=\"" << convertToXML(url.left(dollarPos)) << "\"";
      }
      t << "/>\n";
    }
  }
  auto it = m_edgeInfo.begin();
  for (const auto &childNode : m_children)
  {
    const EdgeInfo &edgeInfo = *it;
    t << "        <childnode refid=\"" << childNode->number() << "\" relation=\"";
    if (isClassGraph)
    {
      switch(edgeInfo.color())
      {
      case EdgeInfo::Blue:    t << "public-inheritance"; break;
      case EdgeInfo::Green:   t << "protected-inheritance"; break;
      case EdgeInfo::Red:     t << "private-inheritance"; break;
      case EdgeInfo::Purple:  t << "usage"; break;
      case EdgeInfo::Orange:  t << "template-instance"; break;
      case EdgeInfo::Orange2: t << "type-constraint"; break;
      case EdgeInfo::Grey:    ASSERT(0); break;
      }
    }
    else // include graph
    {
      t << "include";
    }
    t << "\">\n";
    if (!edgeInfo.label().isEmpty())
    {
      int p=0;
      int ni=0;
      while ((ni=edgeInfo.label().find('\n',p))!=-1)
      {
        t << "          <edgelabel>"
          << convertToXML(edgeInfo.label().mid(p,ni-p))
          << "</edgelabel>\n";
        p=ni+1;
      }
      t << "          <edgelabel>"
        << convertToXML(edgeInfo.label().right(edgeInfo.label().length()-p))
        << "</edgelabel>\n";
    }
    t << "        </childnode>\n";
    ++it;
  }
  t << "      </node>\n";
}

References ASSERT, EdgeInfo::Blue, convertToXML(), edgeInfo(), QCString::find(), EdgeInfo::Green, EdgeInfo::Grey, QCString::left(), m_children, m_edgeInfo, m_label, m_number, m_url, QCString::mid(), EdgeInfo::Orange, EdgeInfo::Orange2, EdgeInfo::Purple, and EdgeInfo::Red.

Member Data Documentation

◆ m_children

DotNodeRefVector DotNode::m_children

private

list of child nodes (outgoing arrows)

Definition at line 135 of file dotnode.h.

Referenced by addChild(), children(), clearWriteFlag(), colorConnectedNodes(), deleteNode(), removeChild(), renumberNodes(), write(), writeDEF(), writeDocbook(), and writeXML().

◆ m_classDef

const ClassDef* DotNode::m_classDef

private

class representing this node (can be 0)

Definition at line 141 of file dotnode.h.

Referenced by DotNode(), writeBox(), and writeLabel().

◆ m_deleted

bool DotNode::m_deleted = false

private

used to mark a node as deleted

Definition at line 137 of file dotnode.h.

Referenced by deleteNode().

◆ m_distance

int DotNode::m_distance = 1000

private

shortest path to the root node

Definition at line 144 of file dotnode.h.

Referenced by distance(), and setDistance().

◆ m_edgeInfo

EdgeInfoVector DotNode::m_edgeInfo

private

edge info for each child

Definition at line 136 of file dotnode.h.

Referenced by addChild(), edgeInfo(), write(), writeDEF(), writeDocbook(), writeLabel(), and writeXML().

◆ m_graph

DotGraph* DotNode::m_graph

private

Definition at line 129 of file dotnode.h.

Referenced by DotNode(), and writeArrow().

◆ m_hasDoc

bool DotNode::m_hasDoc = false

private

used to mark a node as documented

Definition at line 139 of file dotnode.h.

Referenced by hasDocumentation(), and markHasDocumentation().

◆ m_isRoot

bool DotNode::m_isRoot

private

indicates if this is a root node

Definition at line 140 of file dotnode.h.

Referenced by DotNode(), writeBox(), and writeLabel().

◆ m_label

QCString DotNode::m_label

private

label text

Definition at line 131 of file dotnode.h.

Referenced by DotNode(), label(), renumberNodes(), writeDEF(), writeDocbook(), writeLabel(), and writeXML().

◆ m_number

int DotNode::m_number

private

Definition at line 130 of file dotnode.h.

Referenced by DotNode(), number(), renumberNodes(), setNodeId(), writeArrow(), writeBox(), writeDEF(), writeDocbook(), and writeXML().

◆ m_parents

DotNodeRefVector DotNode::m_parents

private

list of parent nodes (incoming arrows)

Definition at line 134 of file dotnode.h.

Referenced by addParent(), clearWriteFlag(), colorConnectedNodes(), deleteNode(), findParent(), parents(), removeParent(), renumberNodes(), and write().

◆ m_renumbered

bool DotNode::m_renumbered = false

private

indicates if the node has been renumbered (to prevent endless loops)

Definition at line 145 of file dotnode.h.

Referenced by isRenumbered(), and markRenumbered().

◆ m_subgraphId

int DotNode::m_subgraphId = -1

private

Definition at line 146 of file dotnode.h.

Referenced by setSubgraphId(), and subgraphId().

◆ m_tooltip

QCString DotNode::m_tooltip

private

node's tooltip

Definition at line 132 of file dotnode.h.

Referenced by DotNode(), and writeBox().

◆ m_truncated

TruncState DotNode::m_truncated = Unknown

private

does the node have non-visible children/parents

Definition at line 143 of file dotnode.h.

Referenced by isTruncated(), markAsTruncated(), write(), and writeLabel().

◆ m_url

QCString DotNode::m_url

private

url of the node (format: remote$local)

Definition at line 133 of file dotnode.h.

Referenced by DotNode(), writeBox(), writeDEF(), writeDocbook(), writeUrl(), and writeXML().

◆ m_visible

bool DotNode::m_visible = false

private

is the node visible in the output

Definition at line 142 of file dotnode.h.

Referenced by isVisible(), markAsVisible(), and write().

◆ m_written

bool DotNode::m_written = false

private

used to mark a node as written

Definition at line 138 of file dotnode.h.

Referenced by clearWriteFlag(), isWritten(), and write().

◆ placeholderUrl

auto DotNode::placeholderUrl = "-"

staticconstexpr

Definition at line 71 of file dotnode.h.

Referenced by DotLegendGraph::computeTheGraph(), and writeUrl().

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

src/dotnode.h
src/dotnode.cpp

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ LabelStyle

◆ TruncState

Constructor & Destructor Documentation

◆ DotNode()

Member Function Documentation

◆ addChild()

◆ addParent()

◆ children()

◆ clearWriteFlag()

◆ colorConnectedNodes()

◆ convertLabel()

◆ deleteNode()

◆ deleteNodes()

◆ distance()

◆ edgeInfo()

◆ findParent()

◆ hasDocumentation()

◆ isRenumbered()

◆ isTruncated()

◆ isVisible()

◆ isWritten()

◆ label()

◆ markAsTruncated()

◆ markAsVisible()

◆ markHasDocumentation()

◆ markRenumbered()

◆ number()

◆ parents()

◆ removeChild()

◆ removeParent()

◆ renumberNodes()

◆ setDistance()

◆ setNodeId()

◆ setSubgraphId()

◆ subgraphId()

◆ write()

◆ writeArrow()

◆ writeBox()

◆ writeDEF()

◆ writeDocbook()

◆ writeLabel()

◆ writeUrl()

◆ writeXML()

Member Data Documentation

◆ m_children

◆ m_classDef

◆ m_deleted

◆ m_distance

◆ m_edgeInfo

◆ m_graph

◆ m_hasDoc

◆ m_isRoot

◆ m_label

◆ m_number

◆ m_parents

◆ m_renumbered

◆ m_subgraphId

◆ m_tooltip

◆ m_truncated

◆ m_url

◆ m_visible

◆ m_written

◆ placeholderUrl