#include <stdio.h>
#include <stdlib.h>
#include <algorithm>
#include "diagram.h"
#include "image.h"
#include "classdef.h"
#include "config.h"
#include "message.h"
#include "util.h"
#include "doxygen.h"
#include "portable.h"
#include "indexlist.h"
#include "classlist.h"
#include "textstream.h"
#include "growbuf.h"
#include "dir.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 QCString	protToString (Protection p)

static uint32_t	virtToMask (Specifier p)

static QCString	convertToPSString (const QCString &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, QCString 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 38 of file diagram.cpp.

Function Documentation

◆ convertToPSString()

static QCString convertToPSString ( const QCString & s )

static

Definition at line 195 of file diagram.cpp.

{
  if (s.isEmpty()) return s;
  GrowBuf growBuf;
  const char *p=s.data();
  char c=0;
  while ((c=*p++))
  {
    switch (c)
    {
      case '(':  growBuf.addStr("\\("); break;
      case ')': growBuf.addStr("\\)"); break;
      default:   growBuf.addChar(c);   break;
    }
  }
  growBuf.addChar(0);
  return growBuf.get();
}

References GrowBuf::addChar(), GrowBuf::addStr(), QCString::data(), GrowBuf::get(), and QCString::isEmpty().

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

◆ getMinProtectionLevel()

static Protection getMinProtectionLevel ( const DiagramItemList & dil )

static

Definition at line 215 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;
}

References Private, Protected, and Public.

Referenced by TreeDiagram::drawConnectors().

◆ protToColor()

static uint8_t protToColor ( Protection p )

static

Definition at line 160 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;
}

References Package, Private, Protected, and Public.

Referenced by TreeDiagram::drawConnectors().

◆ protToMask()

static uint32_t protToMask ( Protection p )

static

Definition at line 148 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;
}

References Package, Private, Protected, and Public.

Referenced by TreeDiagram::drawConnectors().

◆ protToString()

static QCString protToString ( Protection p )

static

Definition at line 172 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 QCString();
}

References Package, Private, Protected, and Public.

Referenced by TreeDiagram::drawConnectors().

◆ virtToMask()

static uint32_t virtToMask ( Specifier p )

static

Definition at line 184 of file diagram.cpp.

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

References Normal, and Virtual.

Referenced by writeBitmapBox().

◆ writeBitmapBox()

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

Definition at line 235 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(), FALSE, Image::fillRect(), fontHeight, DiagramItem::label(), Image::stringLength, virtToMask(), DiagramItem::virtualness(), and Image::writeString().

Referenced by TreeDiagram::drawBoxes().

◆ writeMapArea()

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

static

Definition at line 264 of file diagram.cpp.

{
  if (cd->isLinkable())
  {
    QCString ref=cd->getReference();
    t << "<area ";
    if (!ref.isEmpty())
    {
      t << externalLinkTarget(true);
    }
    t << "href=\"";
    t << externalRef(relPath,ref,TRUE);
    QCString fn = cd->getOutputFileBase();
    addHtmlExtensionIfMissing(fn);
    t << fn;
    if (!cd->anchor().isEmpty())
    {
      t << "#" << cd->anchor();
    }
    t << "\" ";
    QCString tooltip = cd->briefDescriptionAsTooltip();
    if (!tooltip.isEmpty())
    {
      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(), externalLinkTarget(), externalRef(), Definition::getOutputFileBase(), Definition::getReference(), QCString::isEmpty(), Definition::isLinkable(), and TRUE.

Referenced by TreeDiagram::drawBoxes().

◆ writeVectorBox()

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

static

Definition at line 255 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";
}