Skip to main content

The diagram.cpp File Reference

Included Headers​

#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"

Classes Index​

classDiagramItem

Class representing a single node in the built-in class diagram. More...

classDiagramRow

Class representing a row in the built-in class diagram. More...

classTreeDiagram

Class representing the tree layout for the built-in class diagram. More...

classDualDirIterator<C, I>

helper class representing an iterator that can iterate forwards or backwards More...

structPrivate

Typedefs Index​

usingDiagramItemList = std::vector< DiagramItem * >

Functions Index​

static uint32_tprotToMask (Protection p)
static uint8_tprotToColor (Protection p)
static QCStringprotToString (Protection p)
static uint32_tvirtToMask (Specifier p)
static QCStringconvertToPSString (const QCString &s)
static ProtectiongetMinProtectionLevel (const DiagramItemList &dil)
static voidwriteBitmapBox (DiagramItem *di, Image *image, uint32_t x, uint32_t y, uint32_t w, uint32_t h, bool firstRow, bool hasDocs, bool children=FALSE)
static voidwriteVectorBox (TextStream &t, DiagramItem *di, float x, float y, bool children=FALSE)
static voidwriteMapArea (TextStream &t, const ClassDef *cd, QCString relPath, uint32_t x, uint32_t y, uint32_t w, uint32_t h)

Variables Index​

const uint32_tmaxTreeWidth = 8
const uint32_tgridWidth = 100
const uint32_tgridHeight = 100
const uint32_tlabelHorSpacing = 10
const uint32_tlabelVertSpacing = 32
const uint32_tlabelHorMargin = 6
const uint32_tfontHeight = 12

Macro Definitions Index​

#defineIMAGE_EXT   ".png"

Typedefs​

DiagramItemList​

using DiagramItemList = std::vector<DiagramItem*>

Definition at line 38 of file diagram.cpp.

38using DiagramItemList = std::vector<DiagramItem*>;

Functions​

convertToPSString()​

QCString convertToPSString (const QCString & s)
 static

Definition at line 195 of file diagram.cpp.

195static QCString convertToPSString(const QCString &s)
196{
197 if (s.isEmpty()) return s;
198 GrowBuf growBuf;
199 const char *p=s.data();
200 char c=0;
201 while ((c=*p++))
202 {
203 switch (c)
204 {
205 case '(': growBuf.addStr("\\("); break;
206 case ')': growBuf.addStr("\\)"); break;
207 default: growBuf.addChar(c); break;
208 }
209 }
210 growBuf.addChar(0);
211 return growBuf.get();
212}

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

Referenced by ClassDiagram::writeFigure and writeVectorBox.

getMinProtectionLevel()​

Protection getMinProtectionLevel (const DiagramItemList & dil)
 static

Definition at line 215 of file diagram.cpp.

215static Protection getMinProtectionLevel(const DiagramItemList &dil)
216{
217 auto it = dil.begin();
218 Protection result = Protection::Private;
219 if (it!=dil.end())
220 {
221 result=(*it)->protection();
222 for (++it;it!=dil.end();++it)
223 {
224 Protection p=(*it)->protection();
225 if (p!=result)
226 {
227 if (result==Protection::Protected && p==Protection::Public) result=p;
228 else if (result==Protection::Private) result=p;
229 }
230 }
231 }
232 return result;
233}

Referenced by TreeDiagram::drawConnectors.

protToColor()​

uint8_t protToColor (Protection p)
 static

Definition at line 160 of file diagram.cpp.

160static uint8_t protToColor(Protection p)
161{
162 switch(p)
163 {
164 case Protection::Public: return 6;
165 case Protection::Package: // package is not possible!
166 case Protection::Protected: return 5;
167 case Protection::Private: return 4;
168 }
169 return 0;
170}

Referenced by TreeDiagram::drawConnectors.

protToMask()​

uint32_t protToMask (Protection p)
 static

Definition at line 148 of file diagram.cpp.

148static uint32_t protToMask(Protection p)
149{
150 switch(p)
151 {
152 case Protection::Public: return 0xffffffff;
153 case Protection::Package: // package is not possible!
154 case Protection::Protected: return 0xcccccccc;
155 case Protection::Private: return 0xaaaaaaaa;
156 }
157 return 0;
158}

Referenced by TreeDiagram::drawConnectors.

protToString()​

QCString protToString (Protection p)
 static

Definition at line 172 of file diagram.cpp.

172static QCString protToString(Protection p)
173{
174 switch(p)
175 {
176 case Protection::Public: return "solid";
177 case Protection::Package: // package is not possible!
178 case Protection::Protected: return "dashed";
179 case Protection::Private: return "dotted";
180 }
181 return QCString();
182}

Referenced by TreeDiagram::drawConnectors.

virtToMask()​

uint32_t virtToMask (Specifier p)
 static

Definition at line 184 of file diagram.cpp.

184static uint32_t virtToMask(Specifier p)
185{
186 switch(p)
187 {
188 case Specifier::Normal: return 0xffffffff;
189 case Specifier::Virtual: return 0xf0f0f0f0;
190 default: break;
191 }
192 return 0;
193}

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 235 of file diagram.cpp.

235static void writeBitmapBox(DiagramItem *di,Image *image,
236 uint32_t x,uint32_t y,uint32_t w,uint32_t h,bool firstRow,
237 bool hasDocs,bool children=FALSE)
238{
239 uint8_t colFill = hasDocs ? (firstRow ? 8 : 2) : 7;
240 uint8_t colBorder = (firstRow || !hasDocs) ? 1 : 3;
241 uint32_t l = Image::stringLength(di->label());
242 uint32_t mask=virtToMask(di->virtualness());
243 image->fillRect(x+1,y+1,w-2,h-2,colFill,mask);
244 image->drawRect(x,y,w,h,colBorder,mask);
245 image->writeString(x+(w-l)/2, y+(h-fontHeight)/2, di->label(),1);
246 if (children)
247 {
248 for (uint32_t i=0;i<5;i++)
249 {
250 image->drawHorzLine(y+h+i-6,x+w-2-i,x+w-2,firstRow?1:3,0xffffffff);
251 }
252 }
253}

References Image::drawHorzLine, Image::drawRect, FALSE, 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, QCString relPath, uint32_t x, uint32_t y, uint32_t w, uint32_t h)
 static

Definition at line 264 of file diagram.cpp.

264static void writeMapArea(TextStream &t,const ClassDef *cd,QCString relPath,
265 uint32_t x,uint32_t y,uint32_t w,uint32_t h)
266{
267 if (cd->isLinkable())
268 {
269 QCString ref=cd->getReference();
270 t << "<area ";
271 if (!ref.isEmpty())
272 {
273 t << externalLinkTarget(true);
274 }
275 t << "href=\"";
276 t << externalRef(relPath,ref,TRUE);
277 QCString fn = cd->getOutputFileBase();
278 addHtmlExtensionIfMissing(fn);
279 t << fn;
280 if (!cd->anchor().isEmpty())
281 {
282 t << "#" << cd->anchor();
283 }
284 t << "\" ";
285 QCString tooltip = cd->briefDescriptionAsTooltip();
286 if (!tooltip.isEmpty())
287 {
288 t << "title=\"" << convertToHtml(tooltip) << "\" ";
289 }
290 t << "alt=\"" << convertToXML(cd->displayName());
291 t << "\" shape=\"rect\" coords=\"" << x << "," << y << ",";
292 t << (x+w) << "," << (y+h) << "\"/>\n";
293 }
294}

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()​

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

Definition at line 255 of file diagram.cpp.

255static void writeVectorBox(TextStream &t,DiagramItem *di,
256 float x,float y,bool children=FALSE)
257{
258 if (di->virtualness()==Specifier::Virtual) t << "dashed\n";
259 t << " (" << convertToPSString(di->label()) << ") " << x << " " << y << " box\n";
260 if (children) t << x << " " << y << " mark\n";
261 if (di->virtualness()==Specifier::Virtual) t << "solid\n";
262}

References convertToPSString, FALSE, DiagramItem::label and DiagramItem::virtualness.

Referenced by TreeDiagram::drawBoxes.

Variables​

fontHeight​

const uint32_t fontHeight = 12

Definition at line 146 of file diagram.cpp.

146const uint32_t fontHeight = 12; // height of a character

Referenced by writeBitmapBox and ClassDiagram::writeImage.

gridHeight​

const uint32_t gridHeight = 100

Definition at line 141 of file diagram.cpp.

141const uint32_t gridHeight = 100;

Referenced by TreeDiagram::drawBoxes, TreeDiagram::drawConnectors and DiagramRow::insertClass.

gridWidth​

const uint32_t gridWidth = 100

Definition at line 140 of file diagram.cpp.

140const uint32_t gridWidth = 100;

Referenced by TreeDiagram::computeLayout, TreeDiagram::drawBoxes, TreeDiagram::drawConnectors, DiagramRow::insertClass, ClassDiagram::writeFigure and ClassDiagram::writeImage.

labelHorMargin​

const uint32_t labelHorMargin = 6

Definition at line 145 of file diagram.cpp.

145const uint32_t labelHorMargin = 6; // horiz. spacing between label and box

Referenced by ClassDiagram::writeImage.

labelHorSpacing​

const uint32_t labelHorSpacing = 10

Definition at line 143 of file diagram.cpp.

143const uint32_t labelHorSpacing = 10; // horizontal distance between labels

Referenced by TreeDiagram::drawBoxes, TreeDiagram::drawConnectors and ClassDiagram::writeImage.

labelVertSpacing​

const uint32_t labelVertSpacing = 32

Definition at line 144 of file diagram.cpp.

144const uint32_t labelVertSpacing = 32; // vertical distance between labels

Referenced by TreeDiagram::drawBoxes, TreeDiagram::drawConnectors and ClassDiagram::writeImage.

maxTreeWidth​

const uint32_t maxTreeWidth = 8

Definition at line 139 of file diagram.cpp.

139const uint32_t maxTreeWidth = 8;

Referenced by TreeDiagram::computeLayout.

Macro Definitions​

IMAGE_EXT​

#define IMAGE_EXT   ".png"

Definition at line 1396 of file diagram.cpp.

Referenced by ClassDiagram::writeImage.

Generated via doxygen2docusaurus by Doxygen 1.14.0.