#include "diagram.h"
#include <cstdio>
#include <algorithm>
#include "classdef.h"
#include "config.h"
#include "dir.h"
#include "doxygen.h"
#include "image.h"
#include "indexlist.h"
#include "message.h"
#include "portable.h"
#include "textstream.h"
#include "util.h"

Include dependency graph for diagram.cpp:

Classes
class	DiagramItem
	Class representing a single node in the built-in class diagram. More...
class	DiagramRow
	Class representing a row in the built-in class diagram. More...
class	TreeDiagram
	Class representing the tree layout for the built-in class diagram. More...
class	DualDirIterator< C, I >
	helper class representing an iterator that can iterate forwards or backwards More...
struct	ClassDiagram::Private

Macros
#define	IMAGE_EXT ".png"

Typedefs
using	DiagramItemList = std::vector<DiagramItem*>

Functions
static uint32_t	protToMask (Protection p)
static uint8_t	protToColor (Protection p)
static DString	protToString (Protection p)
static uint32_t	virtToMask (Specifier p)
static DString	convertToPSString (const DString &s)
static Protection	getMinProtectionLevel (const DiagramItemList &dil)
static void	writeBitmapBox (DiagramItem di, Image image, uint32_t x, uint32_t y, uint32_t w, uint32_t h, bool firstRow, bool hasDocs, bool children=false)
static void	writeVectorBox (TextStream &t, DiagramItem *di, float x, float y, bool children=false)
static void	writeMapArea (TextStream &t, const ClassDef *cd, DString relPath, uint32_t x, uint32_t y, uint32_t w, uint32_t h)

Variables
const uint32_t	maxTreeWidth = 8
const uint32_t	gridWidth = 100
const uint32_t	gridHeight = 100
const uint32_t	labelHorSpacing = 10
const uint32_t	labelVertSpacing = 32
const uint32_t	labelHorMargin = 6
const uint32_t	fontHeight = 12

Macro Definition Documentation

◆ IMAGE_EXT

#define IMAGE_EXT ".png"

Referenced by ClassDiagram::writeImage().

Typedef Documentation

◆ DiagramItemList

using DiagramItemList = std::vector<DiagramItem*>

Definition at line 39 of file diagram.cpp.

Function Documentation

◆ convertToPSString()

DString convertToPSString ( const DString & s )

static

Definition at line 194 of file diagram.cpp.

{
  if (s.empty()) return s;
  DString result;
  result.reserve(s.length()+8);
  const char *p=s.data();
  char c=0;
  while ((c=*p++))
  {
    switch (c)
    {
      case '(':  result+="\\("; break;
      case ')':  result+="\\)"; break;
      default:   result+=c;     break;
    }
  }
  return result;
}

References DString::data(), DString::empty(), DString::length(), and DString::reserve().

Referenced by ClassDiagram::writeFigure(), and writeVectorBox().

◆ getMinProtectionLevel()

Protection getMinProtectionLevel ( const DiagramItemList & dil )

static

Definition at line 214 of file diagram.cpp.

{
  auto it = dil.begin();
  Protection result = Protection::Private;
  if (it!=dil.end())
  {
    result=(*it)->protection();
    for (++it;it!=dil.end();++it)
    {
      Protection p=(*it)->protection();
      if (p!=result)
      {
        if (result==Protection::Protected && p==Protection::Public) result=p;
        else if (result==Protection::Private) result=p;
      }
    }
  }
  return result;
}

Referenced by TreeDiagram::drawConnectors().

◆ protToColor()

uint8_t protToColor ( Protection p )

static

Definition at line 159 of file diagram.cpp.

{
  switch(p)
  {
    case Protection::Public:    return 6;
    case Protection::Package: // package is not possible!
    case Protection::Protected: return 5;
    case Protection::Private:   return 4;
  }
  return 0;
}

Referenced by TreeDiagram::drawConnectors().

◆ protToMask()

uint32_t protToMask ( Protection p )

static

Definition at line 147 of file diagram.cpp.

{
  switch(p)
  {
    case Protection::Public:    return 0xffffffff;
    case Protection::Package: // package is not possible!
    case Protection::Protected: return 0xcccccccc;
    case Protection::Private:   return 0xaaaaaaaa;
  }
  return 0;
}

Referenced by TreeDiagram::drawConnectors().

◆ protToString()

DString protToString ( Protection p )

static

Definition at line 171 of file diagram.cpp.

{
  switch(p)
  {
    case Protection::Public:    return "solid";
    case Protection::Package: // package is not possible!
    case Protection::Protected: return "dashed";
    case Protection::Private:   return "dotted";
  }
  return DString();
}

Referenced by TreeDiagram::drawConnectors().

◆ virtToMask()

uint32_t virtToMask ( Specifier p )

static

Definition at line 183 of file diagram.cpp.

{
  switch(p)
  {
    case Specifier::Normal:    return 0xffffffff;
    case Specifier::Virtual:   return 0xf0f0f0f0;
    default:        break;
  }
  return 0;
}

Referenced by writeBitmapBox().

◆ writeBitmapBox()

void writeBitmapBox	(	DiagramItem *	di,
		Image *	image,
		uint32_t	x,
		uint32_t	y,
		uint32_t	w,
		uint32_t	h,
		bool	firstRow,
		bool	hasDocs,
		bool	children = false )

static

Definition at line 234 of file diagram.cpp.

{
  uint8_t colFill = hasDocs ? (firstRow ? 8 : 2) : 7;
  uint8_t colBorder = (firstRow || !hasDocs) ? 1 : 3;
  uint32_t l = Image::stringLength(di->label());
  uint32_t mask=virtToMask(di->virtualness());
  image->fillRect(x+1,y+1,w-2,h-2,colFill,mask);
  image->drawRect(x,y,w,h,colBorder,mask);
  image->writeString(x+(w-l)/2, y+(h-fontHeight)/2, di->label(),1);
  if (children)
  {
    for (uint32_t i=0;i<5;i++)
    {
      image->drawHorzLine(y+h+i-6,x+w-2-i,x+w-2,firstRow?1:3,0xffffffff);
    }
  }
}

References Image::drawHorzLine(), Image::drawRect(), Image::fillRect(), fontHeight, DiagramItem::label(), Image::stringLength, virtToMask(), DiagramItem::virtualness(), and Image::writeString().

Referenced by TreeDiagram::drawBoxes().

◆ writeMapArea()

void writeMapArea	(	TextStream &	t,
		const ClassDef *	cd,
		DString	relPath,
		uint32_t	x,
		uint32_t	y,
		uint32_t	w,
		uint32_t	h )

static

Definition at line 263 of file diagram.cpp.

{
  if (cd->isLinkable())
  {
    DString ref=cd->getReference();
    t << "<area ";
    if (!ref.empty())
    {
      t << externalLinkTarget(true);
    }
    t << "href=\"";
    t << externalRef(relPath,ref);
    DString fn = cd->getOutputFileBase();
    addHtmlExtensionIfMissing(fn);
    t << fn;
    if (!cd->anchor().empty())
    {
      t << "#" << cd->anchor();
    }
    t << "\" ";
    DString tooltip = cd->briefDescriptionAsTooltip();
    if (!tooltip.empty())
    {
      t << "title=\"" << convertToHtml(tooltip) << "\" ";
    }
    t << "alt=\"" << convertToXML(cd->displayName());
    t << "\" shape=\"rect\" coords=\"" << x << "," << y << ",";
    t << (x+w) << "," << (y+h) << "\"/>\n";
  }
}

References addHtmlExtensionIfMissing(), Definition::anchor(), Definition::briefDescriptionAsTooltip(), convertToHtml(), convertToXML(), Definition::displayName(), DString::empty(), externalLinkTarget(), externalRef(), Definition::getOutputFileBase(), Definition::getReference(), and Definition::isLinkable().

Referenced by TreeDiagram::drawBoxes().

◆ writeVectorBox()

void writeVectorBox	(	TextStream &	t,
		DiagramItem *	di,
		float	x,
		float	y,
		bool	children = false )

static

Definition at line 254 of file diagram.cpp.

{
  if (di->virtualness()==Specifier::Virtual) t << "dashed\n";
  t << " (" << convertToPSString(di->label()) << ") " << x << " " << y << " box\n";
  if (children) t << x << " " << y << " mark\n";
  if (di->virtualness()==Specifier::Virtual) t << "solid\n";
}