#include "dotdirdeps.h"
#include "util.h"
#include "doxygen.h"
#include "config.h"
#include "image.h"
#include <algorithm>
#include <iterator>
#include <utility>
#include <cstdint>
#include <math.h>
#include <cassert>
#include <map>
#include <memory>
#include <string>
#include <vector>

dotdirdeps.cpp 的引用(Include)关系图:

类
struct	DotDirProperty
	Properties are used to format the directories in the graph distinctively. 更多...

class	DotDirPropertyBuilder
	Builder helper to create instances of the DotDirProperty struct 更多...

类型定义
using	DirDefMap = std::map< std::string, const DirDef * >

typedef std::vector< std::pair< std::unique_ptr< DirRelation >, bool > >	DirRelations
	Elements consist of (1) directory relation and (2) whether it is pointing only to inherited dependees. 更多...

函数
static QCString	getDirectoryBackgroundColor (int depthIndex)
	Returns a DOT color name according to the directory depth. 更多...

static const char *	getDirectoryBorderColor (const DotDirProperty &property)
	Returns a DOT color name according to the directory properties. 更多...

static std::string	getDirectoryBorderStyle (const DotDirProperty &property)
	Returns a DOT node style according to the directory properties. 更多...

static void	drawDirectory (TextStream &t, const DirDef *const directory, const DotDirProperty &property, DirDefMap &directoriesInGraph, int startLevel)
	Puts DOT code for drawing directory to stream and adds it to the list. 更多...

static bool	isAtMaxDepth (const DirDef *const directory, const int startLevel)
	Checks, if the directory is a the maximum drawn directory level. 更多...

static void	drawClusterOpening (TextStream &outputStream, const DirDef *const directory, const DotDirProperty &directoryProperty, DirDefMap &directoriesInGraph, const bool isAncestor, int startLevel)
	Writes DOT code for opening a cluster subgraph to stream. 更多...

static void	drawClusterClosing (TextStream &t)

static void	addDependencies (DirRelations &dependencies, const DirDef *const srcDir, bool isLeaf)
	Assembles a list of the directory relations and whether or not they result from "inheritance". 更多...

static void	drawTree (DirRelations &dependencies, TextStream &t, const DirDef *const directory, int startLevel, DirDefMap &directoriesInGraph, const bool isTreeRoot)
	Recursively draws directory tree. 更多...

void	writeDotDirDepGraph (TextStream &t, const DirDef *dd, bool linkRelations)
	Write DOT code for directory dependency graph. 更多...

类型定义说明

◆ DirDefMap

using DirDefMap = std::map<std::string,const DirDef *>

在文件 dotdirdeps.cpp 第 33 行定义.

◆ DirRelations

typedef std::vector< std::pair< std::unique_ptr<DirRelation>, bool> > DirRelations

Elements consist of (1) directory relation and (2) whether it is pointing only to inherited dependees.

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

函数说明

◆ addDependencies()

static void addDependencies	(	DirRelations &	dependencies,
		const DirDef *const	srcDir,
		bool	isLeaf
	)

static

Assembles a list of the directory relations and whether or not they result from "inheritance".

参数

dependencies	Array to add the dependencies to.
srcDir	is the source of the dependency.
isLeaf	true, if no children are drawn for this directory.

在文件 dotdirdeps.cpp 第 212 行定义.

 {
   for (const auto &usedDirectory : srcDir->usedDirs())
   {
     const auto dstDir = usedDirectory->dir();
     if (!dstDir->isParentOf(srcDir) && (isLeaf || usedDirectory->hasDirectSrcDeps()))
     {
       QCString relationName;
       relationName.sprintf("dir_%06d_%06d", srcDir->dirCount(), dstDir->dirCount());
       bool directRelation = isLeaf ? usedDirectory->hasDirectDstDeps() : usedDirectory->hasDirectDeps();
       auto &&dependency = std::make_unique<DirRelation>(relationName, srcDir, usedDirectory.get());
       auto &&pair = std::make_pair(std::move(dependency),directRelation);
       dependencies.emplace_back(std::move(pair));
     }
   }
 }

引用了 DirDef::dirCount(), QCString::sprintf() , 以及 DirDef::usedDirs().

被这些函数引用 drawTree().

◆ drawClusterClosing()

static void drawClusterClosing ( TextStream & t )

static

在文件 dotdirdeps.cpp 第 201 行定义.

 {
   t << "  }\n";
 }

被这些函数引用 drawTree().

◆ drawClusterOpening()

static void drawClusterOpening	(	TextStream &	outputStream,
		const DirDef *const	directory,
		const DotDirProperty &	directoryProperty,
		DirDefMap &	directoriesInGraph,
		const bool	isAncestor,
		int	startLevel
	)

static

Writes DOT code for opening a cluster subgraph to stream.

Ancestor clusters directly get a label. Other clusters get a plain text node with a label instead. This is because the plain text node can be used to draw dependency relationships.

在文件 dotdirdeps.cpp 第 174 行定义.

 {
   outputStream << "  subgraph cluster" << directory->getOutputFileBase() << " {\n"
       "    graph [ "
       "bgcolor=\""  << getDirectoryBackgroundColor(directory->level()-startLevel) << "\", "
       "pencolor=\"" << getDirectoryBorderColor(directoryProperty) << "\", "
       "style=\""    << getDirectoryBorderStyle(directoryProperty) << "\", "
       "label=\"";
   if (isAncestor)
   {
     outputStream << directory->shortName();
   }
   outputStream << "\", "
       "fontname=\"" << Config_getString(DOT_FONTNAME) << "\", "
       "fontsize=\"" << Config_getInt(DOT_FONTSIZE) << "\", "
       "URL=\"" << addHtmlExtensionIfMissing(directory->getOutputFileBase()) << "\""
       "]\n";
   if (!isAncestor)
   {
     outputStream << "    " << directory->getOutputFileBase() << " [shape=plaintext, "
         "label=\"" << directory->shortName() << "\""
         "];\n";
     directoriesInGraph.insert(std::make_pair(directory->getOutputFileBase().str(), directory));
   }
 }

引用了 addHtmlExtensionIfMissing(), Config_getInt, Config_getString, getDirectoryBackgroundColor(), getDirectoryBorderColor(), getDirectoryBorderStyle(), DirDef::getOutputFileBase(), QCString::insert(), DirDef::level(), DirDef::shortName() , 以及 QCString::str().

被这些函数引用 drawTree() , 以及 writeDotDirDepGraph().

◆ drawDirectory()

static void drawDirectory	(	TextStream &	t,
		const DirDef *const	directory,
		const DotDirProperty &	property,
		DirDefMap &	directoriesInGraph,
		int	startLevel
	)

static

Puts DOT code for drawing directory to stream and adds it to the list.

参数

[in,out]	t	stream to which the DOT code is written to
[in]	directory	will be mapped to a node in DOT code
[in]	property	are evaluated for formatting
[in,out]	directoriesInGraph	lists the directories which have been written to the output stream
[in]	startLevel	current level to calculate relative distances from to determine the background color

在文件 dotdirdeps.cpp 第 148 行定义.

 {
   t << "  " << directory->getOutputFileBase() << " ["
       "shape=box, "
       "label=\""     << directory->shortName()                                       << "\", "
       "style=\""     << getDirectoryBorderStyle(property)                            << "\", "
       "fillcolor=\"" << getDirectoryBackgroundColor(directory->level()-startLevel)   << "\", "
       "color=\""     << getDirectoryBorderColor(property)                            << "\", "
       "URL=\""       << addHtmlExtensionIfMissing(directory->getOutputFileBase())    << "\""
       "];\n";
   directoriesInGraph.insert(std::make_pair(directory->getOutputFileBase().str(), directory));
 }

引用了 addHtmlExtensionIfMissing(), getDirectoryBackgroundColor(), getDirectoryBorderColor(), getDirectoryBorderStyle(), DirDef::getOutputFileBase(), QCString::insert(), DirDef::level(), DirDef::shortName() , 以及 QCString::str().

被这些函数引用 drawTree().

◆ drawTree()

static void drawTree	(	DirRelations &	dependencies,
		TextStream &	t,
		const DirDef *const	directory,
		int	startLevel,
		DirDefMap &	directoriesInGraph,
		const bool	isTreeRoot
	)

static

Recursively draws directory tree.

在文件 dotdirdeps.cpp 第 230 行定义.

 {
   if (!directory->hasSubdirs())
   {
     const DotDirProperty directoryProperty = DotDirPropertyBuilder().makeOriginal(isTreeRoot);
     drawDirectory(t, directory, directoryProperty, directoriesInGraph,startLevel);
     addDependencies(dependencies, directory, true);
   }
   else
   {
     if (isAtMaxDepth(directory, startLevel)) // maximum nesting level reached
     {
       const DotDirProperty directoryProperty = DotDirPropertyBuilder().makeOriginal(isTreeRoot);
       drawDirectory(t, directory, directoryProperty, directoriesInGraph,startLevel);
       addDependencies(dependencies, directory, true);
     }
     else // start a new nesting level
     {
       // open cluster
       {
         const DotDirProperty directoryProperty = DotDirPropertyBuilder().makeOriginal(isTreeRoot);
         drawClusterOpening(t, directory, directoryProperty, directoriesInGraph, false, startLevel);
         addDependencies(dependencies, directory, false);
       }
  
       // process all sub directories
       for (const auto subDirectory : directory->subDirs())
       {
         drawTree(dependencies, t, subDirectory, startLevel, directoriesInGraph, false);
       }
  
       // close cluster
       {
         drawClusterClosing(t);
       }
     }
   }
 }

引用了 addDependencies(), drawClusterClosing(), drawClusterOpening(), drawDirectory(), DirDef::hasSubdirs(), isAtMaxDepth(), DotDirPropertyBuilder::makeOriginal() , 以及 DirDef::subDirs().

◆ getDirectoryBackgroundColor()

static QCString getDirectoryBackgroundColor ( int depthIndex )

static

Returns a DOT color name according to the directory depth.

在文件 dotdirdeps.cpp 第 63 行定义.

 {
   static int hue   = Config_getInt(HTML_COLORSTYLE_HUE);
   static int sat   = Config_getInt(HTML_COLORSTYLE_SAT);
   static int gamma = Config_getInt(HTML_COLORSTYLE_GAMMA);
   assert(depthIndex>=0 && depthIndex<=Config_getInt(DIR_GRAPH_MAX_DEPTH));
   float fraction = (float)depthIndex/(float)Config_getInt(DIR_GRAPH_MAX_DEPTH);
   const char hex[] = "0123456789abcdef";
   int range = 0x40; // range from darkest color to lightest color
   int luma   = 0xef-(int)(fraction*range); // interpolation
   double r,g,b;
   ColoredImage::hsl2rgb(hue/360.0,sat/255.0,
                         pow(luma/255.0,gamma/100.0),&r,&g,&b);
   int red   = (int)(r*255.0);
   int green = (int)(g*255.0);
   int blue  = (int)(b*255.0);
   assert(red>=0   && red<=255);
   assert(green>=0 && green<=255);
   assert(blue>=0  && blue<=255);
   char colStr[8];
   colStr[0]='#';
   colStr[1]=hex[red>>4];
   colStr[2]=hex[red&0xf];
   colStr[3]=hex[green>>4];
   colStr[4]=hex[green&0xf];
   colStr[5]=hex[blue>>4];
   colStr[6]=hex[blue&0xf];
   colStr[7]=0;
   //printf("i=%d max=%d fraction=%f luma=%d %02x %02x %02x -> color=%s\n",
   //    depthIndex,Config_getInt(DIR_GRAPH_MAX_DEPTH),fraction,luma,red,green,blue,colStr);
   return colStr;
 }

引用了 Config_getInt, hex , 以及 ColoredImage::hsl2rgb().

被这些函数引用 drawClusterOpening() , 以及 drawDirectory().

◆ getDirectoryBorderColor()

static const char* getDirectoryBorderColor ( const DotDirProperty & property )

static

Returns a DOT color name according to the directory properties.

在文件 dotdirdeps.cpp 第 97 行定义.

 {
   if (property.isTruncated && property.isOrphaned)
   {
     return "red";
   }
   else if (property.isTruncated)
   {
     return "red";
   }
   else if (property.isOrphaned)
   {
     return "grey50";
   }
   else
   {
     return "grey25";
   }
 }

引用了 DotDirProperty::isOrphaned , 以及 DotDirProperty::isTruncated.

被这些函数引用 drawClusterOpening() , 以及 drawDirectory().

◆ getDirectoryBorderStyle()

static std::string getDirectoryBorderStyle ( const DotDirProperty & property )

static

Returns a DOT node style according to the directory properties.

在文件 dotdirdeps.cpp 第 118 行定义.

 {
   std::string style;
   if (!property.isPeripheral)
   {
     style += "filled,";
   }
   if (property.isOriginal)
   {
     style += "bold,";
   }
   if (property.isIncomplete)
   {
     style += "dashed,";
   }
   else if (property.isTruncated && property.isOrphaned)
   {
     style += "dashed,";
   }
   return style;
 }

引用了 DotDirProperty::isIncomplete, DotDirProperty::isOriginal, DotDirProperty::isOrphaned, DotDirProperty::isPeripheral , 以及 DotDirProperty::isTruncated.

被这些函数引用 drawClusterOpening() , 以及 drawDirectory().

◆ isAtMaxDepth()

static bool isAtMaxDepth	(	const DirDef *const	directory,
		const int	startLevel
	)

static

Checks, if the directory is a the maximum drawn directory level.

在文件 dotdirdeps.cpp 第 163 行定义.

 {
   return (directory->level() - startLevel) >= Config_getInt(DIR_GRAPH_MAX_DEPTH);
 }

引用了 Config_getInt , 以及 DirDef::level().

被这些函数引用 drawTree().

◆ writeDotDirDepGraph()

void writeDotDirDepGraph	(	TextStream &	t,
		const DirDef *	dd,
		bool	linkRelations
	)

Write DOT code for directory dependency graph.

Code is generated for a directory. Successors (sub-directories) of this directory are recursively drawn. Recursion is limited by DIR_GRAPH_MAX_DEPTH. The dependencies of those directories are drawn.

If a dependee is not part of directory tree above, then the dependency is drawn to the first parent of the dependee, whose parent is an ancestor (sub-directory) of the original directory.

参数

t	stream where the DOT code is written to
dd	directory for which the graph is generated for
linkRelations	if true, hyperlinks to the list of file dependencies are added

在文件 dotdirdeps.cpp 第 284 行定义.

 {
   DirDefMap dirsInGraph;
  
   dirsInGraph.insert(std::make_pair(dd->getOutputFileBase().str(),dd));
  
   std::vector<const DirDef *> usedDirsNotDrawn, usedDirsDrawn;
   for (const auto& usedDir : dd->usedDirs())
   {
     usedDirsNotDrawn.push_back(usedDir->dir());
   }
  
   auto moveDrawnDirs = [&usedDirsDrawn,&usedDirsNotDrawn](const std::vector<const DirDef *>::iterator &newEnd)
   {
     // usedDirsNotDrawn is split into two segments: [begin()....newEnd-1] and [newEnd....end()]
     // where the second segment starting at newEnd has been drawn, so append this segment to the usedDirsDrawn list and
     // remove it from the usedDirsNotDrawn list.
     std::move(newEnd, std::end(usedDirsNotDrawn), std::back_inserter(usedDirsDrawn));
     usedDirsNotDrawn.erase(newEnd, usedDirsNotDrawn.end());
   };
  
   // if dd has a parent draw it as the outer layer
   const auto parent = dd->parent();
   if (parent)
   {
     const DotDirProperty parentDirProperty = DotDirPropertyBuilder().
                                              makeIncomplete().
                                              makeOrphaned(parent->parent()!=nullptr);
     drawClusterOpening(t, parent, parentDirProperty, dirsInGraph, true, parent->level());
  
     {
       // draw all directories which have `dd->parent()` as parent and `dd` as dependent
       const auto newEnd = std::stable_partition(usedDirsNotDrawn.begin(), usedDirsNotDrawn.end(),
         [&](const DirDef *const usedDir)
         {
           if (dd!=usedDir && dd->parent()==usedDir->parent()) // usedDir and dd share the same parent
           {
             const DotDirProperty usedDirProperty = DotDirPropertyBuilder().makeTruncated(usedDir->hasSubdirs());
             drawDirectory(t, usedDir, usedDirProperty, dirsInGraph, parent->level());
             return false; // part of the drawn partition
           }
           return true; // part of the not-drawn partition
         });
       moveDrawnDirs(newEnd);
     }
   }
  
   // draw the directory tree with dd as root
   DirRelations dependencies;
   drawTree(dependencies, t, dd, dd->level(), dirsInGraph, true);
  
   if (parent)
   {
     drawClusterClosing(t);
   }
  
   // add nodes for other used directories (i.e. outside of the cluster of directories directly connected to dd)
   {
     const auto newEnd = std::stable_partition(usedDirsNotDrawn.begin(), usedDirsNotDrawn.end(),
      [&](const DirDef *const usedDir) // for each used dir (=directly used or a parent of a directly used dir)
      {
        const DirDef *dir=dd;
        while (dir)
        {
          if (dir!=usedDir && dir->parent()==usedDir->parent()) // include if both have the same parent (or no parent)
          {
            const DotDirProperty usedDirProperty = DotDirPropertyBuilder().
                                                   makeOrphaned(usedDir->parent()!=nullptr).
                                                   makeTruncated(usedDir->hasSubdirs()).
                                                   makePeripheral();
            drawDirectory(t, usedDir, usedDirProperty, dirsInGraph, dir->level());
            return false; // part of the drawn partition
          }
          dir=dir->parent();
        }
        return true; // part of the not-drawn partition
      });
     moveDrawnDirs(newEnd);
   }
  
   // add relations between all selected directories
   {
     for (const auto &relationPair : dependencies)
     {
       const auto &relation         = relationPair.first;
       const bool directRelation    = relationPair.second;
       const auto udir              = relation->destination();
       const auto usedDir           = udir->dir();
       const bool destIsSibling     = std::find(std::begin(usedDirsDrawn), std::end(usedDirsDrawn), usedDir) != std::end(usedDirsDrawn);
       const bool destIsDrawn       = dirsInGraph.find(usedDir->getOutputFileBase().str())!=dirsInGraph.end(); // only point to nodes that are in the graph
       const bool atMaxDepth        = isAtMaxDepth(usedDir, dd->level());
  
       if (destIsSibling || (destIsDrawn && (directRelation || atMaxDepth)))
       {
         const auto relationName = relation->getOutputFileBase();
         const auto dir = relation->source();
         Doxygen::dirRelations.add(relationName,
             std::make_unique<DirRelation>(
                relationName,dir,udir));
         size_t nrefs = udir->filePairs().size();
         t << "  " << dir->getOutputFileBase() << "->"
           << usedDir->getOutputFileBase();
         t << " [headlabel=\"" << (uint)nrefs << "\", labeldistance=1.5";
         if (linkRelations)
         {
           t << " headhref=\"" << addHtmlExtensionIfMissing(relationName) << "\"";
         }
         t << "];\n";
       }
     }
   }
 }

引用了 drawClusterOpening(), end(), DirDef::getOutputFileBase(), DirDef::parent(), QCString::str() , 以及 DirDef::usedDirs().

被这些函数引用 DotDirDeps::computeTheGraph().