Add configuration options to set rankdir for dot graphs #11440

ulmus-scott · 2025-02-20T08:16:43Z

These commits add configuration options to set rankdir for dot graphs.

References #4453 see DOT_GRAPH_ATTR
References #9869 see DOT_RANKDIR_CLASS

I'm not sure what config.xml is supposed to include and setting a defval for DOT_GRAPH_ATTR caused it to print it in the generated doxyfile, but without the preceding newline and "# The default value is: ".

I kept the inverse behavior of the call graphs and the strange switching to LR with DotClassGraph.

The final commit is optional and changes VHDL flow charts, applying the other global attributes to the dot graph.

For quick testing I created a simple class hierarchy:
doxygen-test-rankdir.tar.gz

I started getting a nonsense warning from gcc after adding DOT_RANKDIR_DIR_DEP:

In file included from /home/scott/build/doxygen/src/types.h:19,
                 from /home/scott/build/doxygen/src/definition.h:21,
                 from /home/scott/build/doxygen/src/namespacedef.h:22,
                 from /home/scott/build/doxygen/src/namespacedef.cpp:18:
In function ‘int qstrcmp(const char*, const char*)’,
    inlined from ‘bool operator==(const QCString&, const char*)’ at /home/scott/build/doxygen/src/qcstring.h:611:17,
    inlined from ‘virtual bool NamespaceDefImpl::isLinkableInProject() const’ at /home/scott/build/doxygen/src/namespacedef.cpp:1537:23:
/home/scott/build/doxygen/src/qcstring.h:70:33: warning: ‘int strcmp(const char*, const char*)’ of a string of length 20 and an array of size 16 evaluates to nonzero [-Wstring-compare]
   70 | { return (str1 && str2) ? strcmp(str1,str2) :     // both non-empty
      |                           ~~~~~~^~~~~~~~~~~
/home/scott/build/doxygen/src/namespacedef.cpp: In member function ‘virtual bool NamespaceDefImpl::isLinkableInProject() const’:
/home/scott/build/doxygen/src/namespacedef.cpp:1536:21: note: in this expression
 1536 |   if (extractAnonNs &&                             // extract anonymous ns
      |       ~~~~~~~~~~~~~~^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 1537 |       name().mid(i,20)=="anonymous_namespace{"     // correct prefix
      |       ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

I have not investigated, and am not planning on it, but it would also be nice if there were doxygen commands to be able to set the rankdir on a per graph basis, e.g. some graphs in the same category may be more compact LR, others TB.

based on Krysl@306f286

DOT_RANKDIR_GROUP_COLLABORATION is too long (31 > 23 characters).

and DotGraph::writeGraphFooter(). This applies the DOT_GRAPH_ATTR, DOT_COMMON_ATTR, DOT_EDGE_ATTR, and DOT_NODE_ATTR to the VHDL flowcharts.

albert-github · 2025-02-20T09:03:43Z

Thanks for the efforts.
The way doxygen handles PRs etc in respect to closing issues etc. is in such a way that the issues are kept open when a PR is merged until the next official release, as you used the sentence with "closes issue_number" GitHub has the (for doxygen bad) intelligence to add an automatic issue close on complete:

Please remove these 2 links (hitting the "wheel" and removing the check marks will probably do).

Regarding the compilation warning, strange. I don't see at first glance what could be wrong.

which compiler and compiler version did you use?

The code itself, I have to study it a bit and will write comments to the code later on.

Regarding:

I have not investigated, and am not planning on it, but it would also be nice if there were doxygen commands to be able to set the rankdir on a per graph basis, e.g. some graphs in the same category may be more compact LR, others TB.

No there is no no doxygen command to set any attribute on a per graph base, would probably be a nice enhancement but quite difficult seen the different possibilities for all graphs (especially inheritance / collaboration graphs). I think the command should not be limited to just the rankdir but also have other attribute possibilities (and maybe even the possibility of setting the maximum number of nodes of a particular graph, which is now a global settings number). I think these remarks might also be valid for the settings as done here which is limited to just the rankdir. This will need some serious thinking and definition I think.

albert-github

I'm not a fan of this many extra settings. I already made some comments about this in #11440 (comment) and the total concept of handling the attributes for dot should in my opinion be reconsidered.

albert-github · 2025-02-20T13:44:45Z

src/config.xml

+ \c DOT_GRAPH_ATTR is common attributes for graphs.
+ For details please see
+ <a href="https://graphviz.org/doc/info/attrs.html">Node, Edge and Graph Attributes specification</a>.
+ <br>The default value is:<br>


Text for the default value is generated automatically, so sentence should not be here.

Except when I run doxygen -g, the sentence isn't generated but the value is inserted (with a period after and no space or new line).

I think the behavior is different since this is type='list' not type='string'.

albert-github · 2025-02-20T13:47:54Z

src/config.xml

@@ -3802,6 +3802,130 @@ where `loc1` and `loc2` can be relative or absolute paths or URLs.
 ]]>
      </docs>
    </option>
+    <option type='list' id='DOT_GRAPH_ATTR' format='string' depends='HAVE_DOT'
+      defval='bgcolor=\"transparent\"'>


I don't think the double quotes should be escaped (\"), it is not necssary as the string is embedded in single quotes , probably the double quotes can removed all together (see e.g. DOT_COMMON_ATTR)

Escaping the double quotes is necessary to create the same output as before:

bgcolor="transparent";

I think having un-escaped " would confuse the parsing of the doxyfile?

You are correct that dot also accepts bgcolor=transparent, but I was trying to keep the output the same.

albert-github · 2025-02-20T13:50:04Z

src/config.xml

+      </docs>
+      <value name='bgcolor=\"transparent\"'/>
+    </option>
+    <option type='string' id='DOT_RANKDIR_CALL' format='string' depends='HAVE_DOT' defval='LR'>


Shouldn't the default be the empty string?

If DotCallGraph::m_inverse was false, rankdir was "LR". I am trying to preserve the previous behavior.

albert-github · 2025-02-20T13:52:00Z

src/dotcallgraph.cpp

+  QCString rankdir = Config_getString(DOT_RANKDIR_CALL);
+  if (rankdir.size() >= 2 && m_inverse)
+  {
+    std::swap(rankdir[0], rankdir[1]);
+  }


How would you get 2 or more values on the rankdir part?
What happens with the values 3, 4, ...

rankdir is supposed to be only "TB", "BT", "LR", or "RL"; this is supposed to swap the characters in the string: "TB" becomes "BT", etc.

My version of dot appeared to reset to its default (TB) if given an invalid string, e.g. "foo", so I saw no reason to explicitly check and replace when swapping does the same thing.

Which version of dot do you use?

dot -V dot - graphviz version 2.43.0 (0)

I had tested the behavior with an invalid rankdir using a valid rankdir in DOT_GRAPH_ATTR and setting an invalid DOT_RANKDIR_INCLUDE.

ulmus-scott · 2025-02-20T20:04:33Z

Thanks for the efforts. The way doxygen handles PRs etc in respect to closing issues etc. is in such a way that the issues are kept open when a PR is merged until the next official release, as you used the sentence with "closes issue_number" GitHub has the (for doxygen bad) intelligence to add an automatic issue close on complete:
* Please remove these 2 links (hitting the "wheel" and removing the check marks will probably do).

I did not see the gear icon, but replacing "closes" with "references" in the comment appears to have removed it.

Regarding the compilation warning, strange. I don't see at first glance what could be wrong.
* which compiler and compiler version did you use?

gcc --version
gcc (Ubuntu 13.3.0-6ubuntu2~24.04) 13.3.0

The code itself, I have to study it a bit and will write comments to the code later on.

Regarding:

I have not investigated, and am not planning on it, but it would also be nice if there were doxygen commands to be able to set the rankdir on a per graph basis, e.g. some graphs in the same category may be more compact LR, others TB.

No there is no no doxygen command to set any attribute on a per graph base, would probably be a nice enhancement but quite difficult seen the different possibilities for all graphs (especially inheritance / collaboration graphs). I think the command should not be limited to just the rankdir but also have other attribute possibilities (and maybe even the possibility of setting the maximum number of nodes of a particular graph, which is now a global settings number). I think these remarks might also be valid for the settings as done here which is limited to just the rankdir. This will need some serious thinking and definition I think.

Adding commands to supply dot statements that would be inserted at the end of DotGraph::writeGraphHeader(), probably replacing the new rankdir parameter and similar to how DOT_GRAPH_ATTR works, would probably work. I don't know how the maximum number of nodes is set, so that may also be possible via the same proposed commands.

Generalizing this from rankdir to any graph attribute would probably require changes to how DotClassGraph and DotCallGraph behave.

With DotClassGraph's unique dynamic selection of rankdir, it would be easiest to remove, but maybe something like:

auto attributes = getConfig(DOT_ATTR_CLASS);
if (!attributes.contains("rankdir") && m_lrRank)
{
    attributes.append("rankdir=\"LR\"");
}

DotCallGraph's inverse direction may be achieved with appending edge [dir=back] (https://graphviz.org/docs/attrs/dir/), but I would need to test it to be sure.

I'm not a fan of this many extra settings. I already made some comments about this in #11440 (comment) and the total concept of handling the attributes for dot should in my opinion be reconsidered.

I don't think this is significantly different to how the dot graphs are already handled. See https://www.doxygen.nl/manual/commands.html#cmdgroupgraph, etc.; and the configuration options: CLASS_GRAPH, COLLABORATION_GRAPH, GROUP_GRAPHS, TEMPLATE_RELATIONS, INCLUDE_GRAPH, INCLUDED_BY_GRAPH, CALL_GRAPH, CALLER_GRAPH, GRAPHICAL_HIERARCHY, and DIRECTORY_GRAPH.

ulmus-scott · 2025-02-22T03:37:48Z

DotCallGraph's inverse direction may be achieved with appending edge [dir=back] (https://graphviz.org/docs/attrs/dir/), but I would need to test it to be sure.

edge [dir=back] only reverses the direction of the arrows, i.e. A->B shows as A<-B, the position of the nodes in the rendered graph remain the same, so extracting rankdir from the attribute list would be required to reverse/mirror it.

ulmus-scott · 2025-02-22T03:50:08Z

doxygen-test-rankdir_with-call-graphs.tar.gz
If you set DOT_RANKDIR_CALL = foo in Doxyfile, the call graphs will all be TB (default) and the .dot files will show either rankdir="foo"; (e.g. structLevel0_a6116ba32d0d153509eb40e6b95b50345_cgraph.dot) or rankdir="ofo"; (e.g. structLevel0_a6116ba32d0d153509eb40e6b95b50345_icgraph.dot). Of course, it also works correctly as expected with the valid LR, RL, TB, and BT rankdirs.

ulmus-scott added 11 commits February 17, 2025 15:58

DotGraph::writeGraphHeader(): add rankdir parameter

d9ca5cc

add DOT_GRAPH_ATTR configuration option

f828b69

based on Krysl@306f286

add DOT_RANKDIR_INCLUDE configuration option

9b85d27

add DOT_RANKDIR_GROUP_COL configuration option

0488370

DOT_RANKDIR_GROUP_COLLABORATION is too long (31 > 23 characters).

add DOT_RANKDIR_HIERARCHY configuration option

0e8e067

add DOT_RANKDIR_DIR_DEP configuration option

0135897

add DOT_RANKDIR_CLASS configuration option

673fc4d

add DOT_RANKDIR_CALL configuration option

ec00420

DotGraph::writeGraphHeader(): remove default parameter values

78d17f7

add DOT_RANKDIR_VHDL configuration option

be91b32

FlowChart::startDot(): use DotGraph::writeGraphHeader()

175e5a6

and DotGraph::writeGraphFooter(). This applies the DOT_GRAPH_ATTR, DOT_COMMON_ATTR, DOT_EDGE_ATTR, and DOT_NODE_ATTR to the VHDL flowcharts.

albert-github reviewed Feb 20, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add configuration options to set rankdir for dot graphs #11440

Add configuration options to set rankdir for dot graphs #11440

ulmus-scott commented Feb 20, 2025 •

edited

Loading

albert-github commented Feb 20, 2025

albert-github left a comment

albert-github Feb 20, 2025

ulmus-scott Feb 20, 2025

ulmus-scott Feb 20, 2025

albert-github Feb 20, 2025

ulmus-scott Feb 20, 2025

albert-github Feb 20, 2025

ulmus-scott Feb 20, 2025

albert-github Feb 20, 2025

ulmus-scott Feb 20, 2025

albert-github Feb 21, 2025

ulmus-scott Feb 22, 2025

ulmus-scott commented Feb 20, 2025

ulmus-scott commented Feb 22, 2025

ulmus-scott commented Feb 22, 2025

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Add configuration options to set rankdir for dot graphs #11440

Are you sure you want to change the base?

Add configuration options to set rankdir for dot graphs #11440

Conversation

ulmus-scott commented Feb 20, 2025 • edited Loading

albert-github commented Feb 20, 2025

albert-github left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ulmus-scott commented Feb 20, 2025

ulmus-scott commented Feb 22, 2025

ulmus-scott commented Feb 22, 2025

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

ulmus-scott commented Feb 20, 2025 •

edited

Loading