outputlist.h
Go to the documentation of this file.
1 /******************************************************************************
2  *
3  *
4  *
5  * Copyright (C) 1997-2015 by Dimitri van Heesch.
6  *
7  * Permission to use, copy, modify, and distribute this software and its
8  * documentation under the terms of the GNU General Public License is hereby
9  * granted. No representations are made about the suitability of this software
10  * for any purpose. It is provided "as is" without express or implied warranty.
11  * See the GNU General Public License for more details.
12  *
13  * Documents produced by Doxygen are derivative works derived from the
14  * input used in their production; they are not affected by this license.
15  *
16  */
17 
18 #ifndef OUTPUTLIST_H
19 #define OUTPUTLIST_H
20 
21 #include <qlist.h>
22 #include "index.h" // for IndexSections
23 #include "outputgen.h"
24 
25 #define FORALLPROTO1(arg1) \
26  void forall(void (OutputGenerator::*func)(arg1),arg1)
27 #define FORALLPROTO2(arg1,arg2) \
28  void forall(void (OutputGenerator::*func)(arg1,arg2),arg1,arg2)
29 #define FORALLPROTO3(arg1,arg2,arg3) \
30  void forall(void (OutputGenerator::*func)(arg1,arg2,arg3),arg1,arg2,arg3)
31 #define FORALLPROTO4(arg1,arg2,arg3,arg4) \
32  void forall(void (OutputGenerator::*func)(arg1,arg2,arg3,arg4),arg1,arg2,arg3,arg4)
33 #define FORALLPROTO5(arg1,arg2,arg3,arg4,arg5) \
34  void forall(void (OutputGenerator::*func)(arg1,arg2,arg3,arg4,arg5),arg1,arg2,arg3,arg4,arg5)
35 #define FORALLPROTO6(arg1,arg2,arg3,arg4,arg5,arg6) \
36  void forall(void (OutputGenerator::*func)(arg1,arg2,arg3,arg4,arg5,arg6),arg1,arg2,arg3,arg4,arg5,arg6)
37 #define FORALLPROTO7(arg1,arg2,arg3,arg4,arg5,arg6,arg7) \
38  void forall(void (OutputGenerator::*func)(arg1,arg2,arg3,arg4,arg5,arg6,arg7),arg1,arg2,arg3,arg4,arg5,arg6,arg7)
39 #define FORALLPROTO8(arg1,arg2,arg3,arg4,arg5,arg6,arg7,arg8) \
40  void forall(void (OutputGenerator::*func)(arg1,arg2,arg3,arg4,arg5,arg6,arg7,arg8),arg1,arg2,arg3,arg4,arg5,arg6,arg7,arg8)
41 
42 class ClassDiagram;
43 class DotClassGraph;
44 class DotDirDeps;
45 class DotInclDepGraph;
47 class SectionDict;
49 class DocRoot;
50 
51 /** Class representing a list of output generators that are written to
52  * in parallel.
53  */
55 {
56  public:
57  OutputList(bool);
58  virtual ~OutputList();
59 
60  void add(const OutputGenerator *);
61  uint count() const { return m_outputs.count(); }
62 
64  void enableAll();
65  void disableAll();
69  void pushGeneratorState();
70  void popGeneratorState();
71 
72 
73  //////////////////////////////////////////////////
74  // OutputDocInterface implementation
75  //////////////////////////////////////////////////
76 
77  bool generateDoc(const char *fileName,int startLine,
78  Definition *ctx,MemberDef *md,const QCString &docStr,
79  bool indexWords,bool isExample,const char *exampleName=0,
80  bool singleLine=FALSE,bool linkFromIndex=FALSE);
81  void writeDoc(DocRoot *root,Definition *ctx,MemberDef *md);
82  bool parseText(const QCString &textStr);
83 
84 
89  void writePageLink(const char *name,bool first)
90  { forall(&OutputGenerator::writePageLink,name,first); }
95  void writeStyleInfo(int part)
97  void startFile(const char *name,const char *manName,const char *title)
98  { forall(&OutputGenerator::startFile,name,manName,title); }
101  void writeFooter(const char *navPath)
102  { forall(&OutputGenerator::writeFooter,navPath); }
103  void endFile()
105  void startTitleHead(const char *fileName)
107  void endTitleHead(const char *fileName,const char *name)
108  { forall(&OutputGenerator::endTitleHead,fileName,name); }
109  void startTitle()
111  void endTitle()
113  //void newParagraph()
114  //{ forall(&OutputGenerator::newParagraph); }
117  void endParagraph()
119  void writeString(const char *text)
127  void endIndexList()
131  void endIndexKey()
133  void startIndexValue(bool b)
135  void endIndexValue(const char *name,bool b)
139  void endItemList()
141  void startIndexItem(const char *ref,const char *file)
143  void endIndexItem(const char *ref,const char *file)
144  { forall(&OutputGenerator::endIndexItem,ref,file); }
145  void docify(const char *s)
147  void codify(const char *s)
149  void writeObjectLink(const char *ref,const char *file,
150  const char *anchor, const char *name)
151  { forall(&OutputGenerator::writeObjectLink,ref,file,anchor,name); }
152  void writeCodeLink(const char *ref,const char *file,
153  const char *anchor,const char *name,
154  const char *tooltip)
155  { forall(&OutputGenerator::writeCodeLink,ref,file,anchor,name,tooltip); }
156  void writeTooltip(const char *id, const DocLinkInfo &docInfo, const char *decl,
157  const char *desc, const SourceLinkInfo &defInfo, const SourceLinkInfo &declInfo)
158  { forall(&OutputGenerator::writeTooltip,id,docInfo,decl,desc,defInfo,declInfo); }
159  void startTextLink(const char *file,const char *anchor)
160  { forall(&OutputGenerator::startTextLink,file,anchor); }
161  void endTextLink()
163  void startHtmlLink(const char *url)
165  void endHtmlLink()
167  void writeStartAnnoItem(const char *type,const char *file,
168  const char *path,const char *name)
169  { forall(&OutputGenerator::writeStartAnnoItem,type,file,path,name); }
170  void writeEndAnnoItem(const char *name)
176  void startGroupHeader(int extraLevels=0)
177  { forall(&OutputGenerator::startGroupHeader,extraLevels); }
178  void endGroupHeader(int extraLevels=0)
179  { forall(&OutputGenerator::endGroupHeader,extraLevels); }
180  //void writeListItem()
181  //{ forall(&OutputGenerator::writeListItem); }
194  void startMemberHeader(const char *anchor)
214  void startAnonTypeScope(int i1)
216  void endAnonTypeScope(int i1)
218  void startMemberItem(const char *anchor,int i1,const char *id=0)
219  { forall(&OutputGenerator::startMemberItem,anchor,i1,id); }
224  void endMemberTemplateParams(const char *anchor,const char *inheritId)
225  { forall(&OutputGenerator::endMemberTemplateParams,anchor,inheritId); }
236  void endMemberGroup(bool last)
238  void insertMemberAlign(bool templ=FALSE)
240  void writeRuler()
242  void writeAnchor(const char *fileName,const char *name)
243  { forall(&OutputGenerator::writeAnchor,fileName,name); }
248  void startCodeLine(bool hasLineNumbers)
249  { forall(&OutputGenerator::startCodeLine,hasLineNumbers); }
250  void endCodeLine()
252  void writeLineNumber(const char *ref,const char *file,const char *anchor,
253  int lineNumber)
254  { forall(&OutputGenerator::writeLineNumber,ref,file,anchor,lineNumber); }
257  void endEmphasis()
259  void writeChar(char c)
261  void startMemberDoc(const char *clName,const char *memName,
262  const char *anchor,const char *title,bool showInline)
263  { forall(&OutputGenerator::startMemberDoc,clName,memName,anchor,title,showInline); }
264  void endMemberDoc(bool hasArgs)
266  void startDoxyAnchor(const char *fName,const char *manName,
267  const char *anchor, const char *name,
268  const char *args)
269  { forall(&OutputGenerator::startDoxyAnchor,fName,manName,anchor,name,args); }
270  void endDoxyAnchor(const char *fn,const char *anchor)
271  { forall(&OutputGenerator::endDoxyAnchor,fn,anchor); }
280  void endDescItem()
294  void startCenter()
296  void endCenter()
298  void startSmall()
300  void endSmall()
302  void lineBreak(const char *style=0)
304  void startBold()
306  void endBold()
308  void startMemberDescription(const char *anchor,const char *inheritId=0)
309  { forall(&OutputGenerator::startMemberDescription,anchor,inheritId); }
314  void endMemberDeclaration(const char *anchor,const char *inheritId)
315  { forall(&OutputGenerator::endMemberDeclaration,anchor,inheritId); }
316  void writeInheritedSectionTitle(const char *id, const char *ref,
317  const char *file, const char *anchor,
318  const char *title,const char *name)
320  file,anchor,title,name); }
321  void startSimpleSect(SectionTypes t,const char *file,const char *anchor,
322  const char *title)
323  { forall(&OutputGenerator::startSimpleSect,t,file,anchor,title); }
328  void endParamList()
330  void startIndent()
332  void endIndent()
334  void startSection(const char *lab,const char *title,SectionInfo::SectionType t)
335  { forall(&OutputGenerator::startSection,lab,title,t); }
336  void endSection(const char *lab,SectionInfo::SectionType t)
338  void addIndexItem(const char *s1,const char *s2)
344  void endClassDiagram(const ClassDiagram &d,const char *f,const char *n)
348  void endPageRef(const char *c,const char *a)
354  void writeSplitBar(const char *name)
356  void writeNavigationPath(const char *s)
358  void writeLogo()
360  void writeQuickLinks(bool compact,HighlightedItem hli,const char *file)
361  { forall(&OutputGenerator::writeQuickLinks,compact,hli,file); }
362  void writeSummaryLink(const char *file,const char *anchor,const char *title,bool first)
363  { forall(&OutputGenerator::writeSummaryLink,file,anchor,title,first); }
366  void endContents()
370  void startDescTable(const char *title)
404  void startTextBlock(bool dense=FALSE)
406  void endTextBlock(bool paraBreak=FALSE)
407  { forall(&OutputGenerator::endTextBlock,paraBreak); }
418  void startParameterType(bool first,const char *key)
422  void startParameterName(bool one)
424  void endParameterName(bool last,bool one,bool bracket)
425  { forall(&OutputGenerator::endParameterName,last,one,bracket); }
426  void startParameterList(bool openBracket)
430  void exceptionEntry(const char* prefix,bool closeBracket)
431  { forall(&OutputGenerator::exceptionEntry,prefix,closeBracket); }
432 
433  void startConstraintList(const char *header)
449 
466 
467  void startLabels()
469  void writeLabel(const char *l,bool isLast)
470  { forall(&OutputGenerator::writeLabel,l,isLast); }
471  void endLabels()
473 
474  void startFontClass(const char *c)
478  void writeCodeAnchor(const char *name)
480  void setCurrentDoc(Definition *context,const char *anchor,bool isSourceFile)
481  { forall(&OutputGenerator::setCurrentDoc,context,anchor,isSourceFile); }
482  void addWord(const char *word,bool hiPriority)
483  { forall(&OutputGenerator::addWord,word,hiPriority); }
484 
485  void startPlainFile(const char *name)
486  {
488  OutputGenerator *og;
489  for (;(og=it.current());++it)
490  {
491  if (og->isEnabled()) (og->startPlainFile)(name);
492  }
493  }
495  {
497  OutputGenerator *og;
498  for (;(og=it.current());++it)
499  {
500  if (og->isEnabled()) (og->endPlainFile)();
501  }
502  }
503 
504  private:
505  void debug();
506  void clear();
507 
508  void forall(void (OutputGenerator::*func)());
509  FORALLPROTO1(const char *);
510  FORALLPROTO1(char);
512  FORALLPROTO1(int);
513  FORALLPROTO1(const DotClassGraph &);
514  FORALLPROTO1(const DotInclDepGraph &);
515  FORALLPROTO1(const DotCallGraph &);
517  FORALLPROTO1(const DotDirDeps &);
520 #if defined(HAS_BOOL_TYPE) || defined(Q_HAS_BOOL_TYPE)
521  FORALLPROTO1(bool);
522  FORALLPROTO2(bool,int);
523  FORALLPROTO2(bool,bool);
524  FORALLPROTO2(const char *,bool);
525  FORALLPROTO4(const char *,const char *,const char *,int);
526 #endif
527  FORALLPROTO2(int,bool);
528  FORALLPROTO2(bool,const char *);
529  FORALLPROTO2(ParamListTypes,const char *);
530  FORALLPROTO2(const char *,const char *);
531  FORALLPROTO2(const char *,int);
533  FORALLPROTO3(bool,HighlightedItem,const char *);
534  FORALLPROTO3(bool,bool,bool);
535  FORALLPROTO3(const char *,const char *,bool);
536  FORALLPROTO3(const char *,int,const char *);
537  FORALLPROTO3(const char *,const char *,SectionInfo::SectionType);
539  FORALLPROTO3(const char *,const char *,const char *);
540  FORALLPROTO3(const ClassDiagram &,const char *,const char *);
541  FORALLPROTO3(Definition*,const char *,bool);
542  FORALLPROTO4(SectionTypes,const char *,const char *,const char *);
543  FORALLPROTO4(const char *,const char *,const char *,const char *);
544  FORALLPROTO4(const char *,const char *,const char *,bool);
545  FORALLPROTO5(const char *,const char *,const char *,const char *,const char *);
546  FORALLPROTO5(const char *,const char *,const char *,const char *,bool);
547  FORALLPROTO6(const char *,const char *,const char *,const char *,const char *,const char *);
548  FORALLPROTO6(const char *,const DocLinkInfo &,const char *,const char *,const SourceLinkInfo &,const SourceLinkInfo &);
549 
550  OutputList(const OutputList &ol);
552 };
553 
554 #endif
static QCString name
Definition: declinfo.cpp:673
virtual void endMemberDocPrefixItem()=0
void endMemberGroupDocs()
Definition: outputlist.h:232
void endIndexItem(const char *ref, const char *file)
Definition: outputlist.h:143
void startMemberItem(const char *anchor, int i1, const char *id=0)
Definition: outputlist.h:218
void startParameterType(bool first, const char *key)
Definition: outputlist.h:418
void writeRuler()
Definition: outputlist.h:240
void endIndexValue(const char *name, bool b)
Definition: outputlist.h:135
virtual void startMemberDocSimple()=0
void endMemberDeclaration(const char *anchor, const char *inheritId)
Definition: outputlist.h:314
void startDotGraph()
Definition: outputlist.h:382
void writeLatexSpacing()
Definition: outputlist.h:272
FORALLPROTO4(SectionTypes, const char *, const char *, const char *)
void endPlainFile()
Definition: outputgen.cpp:55
virtual bool isEnabled(OutputType o)=0
virtual void endProjectNumber()=0
uint count() const
Definition: outputlist.h:61
virtual void startParameterName(bool)=0
virtual void endMemberSections()=0
void startMemberDocList()
Definition: outputlist.h:202
void codify(const char *s)
Definition: outputlist.h:147
void writeLogo()
Definition: outputlist.h:358
void writeStartAnnoItem(const char *type, const char *file, const char *path, const char *name)
Definition: outputlist.h:167
virtual void endMemberDoc(bool)=0
virtual void endInlineMemberDoc()=0
virtual void endConstraintParam()=0
void endMemberItem()
Definition: outputlist.h:220
void endGroupHeader(int extraLevels=0)
Definition: outputlist.h:178
virtual void endTitle()=0
void startMemberDocSimple()
Definition: outputlist.h:450
virtual void endIndexValue(const char *, bool)=0
virtual void endMemberGroupDocs()=0
void startItemListItem()
Definition: outputlist.h:182
virtual void writeNonBreakableSpace(int)=0
virtual void startInclDepGraph()=0
virtual void endConstraintList()=0
virtual void endIndexListItem()=0
void clear()
virtual void endQuickIndices()=0
FORALLPROTO6(const char *, const char *, const char *, const char *, const char *, const char *)
static constexpr double g
Definition: Units.h:144
virtual void endMemberSubtitle()=0
void endIndexSection(IndexSections is)
Definition: outputlist.h:87
virtual void endParameterType()=0
void endLabels()
Definition: outputlist.h:471
virtual void writeLineNumber(const char *ref, const char *file, const char *anchor, int lineNumber)=0
void endInlineHeader()
Definition: outputlist.h:212
virtual void startHtmlLink(const char *url)=0
virtual void endTextBlock(bool)=0
void startDescTableTitle()
Definition: outputlist.h:374
void startConstraintDocs()
Definition: outputlist.h:443
virtual void endConstraintType()=0
virtual void writeEndAnnoItem(const char *name)=0
virtual void endCodeFragment()=0
virtual void startBold()=0
void startGroupCollaboration()
Definition: outputlist.h:398
void endCodeLine()
Definition: outputlist.h:250
virtual void startMemberGroup()=0
void writeLineNumber(const char *ref, const char *file, const char *anchor, int lineNumber)
Definition: outputlist.h:252
virtual void startDescTable(const char *title)=0
void writeGraphicalHierarchy(const DotGfxHierarchyTable &g)
Definition: outputlist.h:402
virtual void writeSynopsis()=0
FORALLPROTO5(const char *, const char *, const char *, const char *, const char *)
void endHeaderSection()
Definition: outputlist.h:192
void writeString(const char *text)
Definition: outputlist.h:119
void startCodeFragment()
Definition: outputlist.h:244
virtual void endSubsection()=0
bool generateDoc(const char *fileName, int startLine, Definition *ctx, MemberDef *md, const QCString &docStr, bool indexWords, bool isExample, const char *exampleName=0, bool singleLine=FALSE, bool linkFromIndex=FALSE)
Definition: outputlist.cpp:131
void writeNonBreakableSpace(int num)
Definition: outputlist.h:368
void startIndent()
Definition: outputlist.h:330
void disableAllBut(OutputGenerator::OutputType o)
Definition: outputlist.cpp:49
void startParagraph()
Definition: outputlist.h:115
void lineBreak(const char *style=0)
Definition: outputlist.h:302
void endTitleHead(const char *fileName, const char *name)
Definition: outputlist.h:107
virtual void startIndexValue(bool)=0
virtual void startParameterList(bool)=0
virtual void addIndexItem(const char *s1, const char *s2)=0
void startSubsubsection()
Definition: outputlist.h:290
void startInlineMemberDoc()
Definition: outputlist.h:462
void addIndexItem(const char *s1, const char *s2)
Definition: outputlist.h:338
void writeSearchInfo()
Definition: outputlist.h:99
void startIndexValue(bool b)
Definition: outputlist.h:133
virtual void startTextBlock(bool)=0
void endInlineMemberDoc()
Definition: outputlist.h:464
IndexSections
Definition: index.h:157
void endDescForItem()
Definition: outputlist.h:284
const bool FALSE
Definition: qglobal.h:370
void startHeaderSection()
Definition: outputlist.h:190
virtual void endFontClass()=0
void endConstraintDocs()
Definition: outputlist.h:445
FORALLPROTO2(int, bool)
virtual void startFontClass(const char *clsName)=0
virtual void writeStartAnnoItem(const char *type, const char *file, const char *path, const char *name)=0
void startMemberDescription(const char *anchor, const char *inheritId=0)
Definition: outputlist.h:308
void endEmphasis()
Definition: outputlist.h:257
void endInlineMemberType()
Definition: outputlist.h:456
void startDescription()
Definition: outputlist.h:274
void startEmphasis()
Definition: outputlist.h:255
virtual void startInlineMemberDoc()=0
void endFontClass()
Definition: outputlist.h:476
virtual void startDoxyAnchor(const char *fName, const char *manName, const char *anchor, const char *name, const char *args)=0
void startMemberSections()
Definition: outputlist.h:186
void startQuickIndices()
Definition: outputlist.h:350
void writeLabel(const char *l, bool isLast)
Definition: outputlist.h:469
virtual void startHeaderSection()=0
virtual void startCodeFragment()=0
virtual void endItemList()=0
bool isEnabled(OutputGenerator::OutputType o)
Definition: outputlist.cpp:99
virtual void endDirDepGraph(const DotDirDeps &g)=0
void endMemberGroup(bool last)
Definition: outputlist.h:236
void endConstraintParam()
Definition: outputlist.h:437
void startIndexKey()
Definition: outputlist.h:129
virtual void endGroupHeader(int)=0
void endSmall()
Definition: outputlist.h:300
virtual void endIndexItem(const char *ref, const char *file)=0
void exceptionEntry(const char *prefix, bool closeBracket)
Definition: outputlist.h:430
virtual void startSimpleSect(SectionTypes t, const char *file, const char *anchor, const char *title)=0
void endDescription()
Definition: outputlist.h:276
virtual void startConstraintList(const char *)=0
virtual void endClassDiagram(const ClassDiagram &, const char *, const char *)=0
virtual void endHtmlLink()=0
virtual void startMemberDeclaration()=0
virtual void endTypewriter()=0
void startMemberList()
Definition: outputlist.h:206
virtual ~OutputList()
Definition: outputlist.cpp:39
void startAnonTypeScope(int i1)
Definition: outputlist.h:214
static QCString args
Definition: declinfo.cpp:674
virtual void startDirDepGraph()=0
static QStrList * l
Definition: config.cpp:1044
virtual void endHeaderSection()=0
virtual void endParameterList()=0
virtual void endMemberDeclaration(const char *anchor, const char *inheritId)=0
virtual void endTitleHead(const char *fileName, const char *name)=0
virtual void endSimpleSect()=0
virtual void startMemberGroupDocs()=0
virtual void startDescForItem()=0
virtual void writeSummaryLink(const char *file, const char *anchor, const char *title, bool first)=0
virtual void writeAnchor(const char *fileName, const char *name)=0
void startTextLink(const char *file, const char *anchor)
Definition: outputlist.h:159
void startParameterName(bool one)
Definition: outputlist.h:422
virtual void startDescTableData()=0
void endFile()
Definition: outputlist.h:103
virtual void endDescForItem()=0
virtual void exceptionEntry(const char *, bool)=0
virtual void startSection(const char *, const char *, SectionInfo::SectionType)=0
virtual void writeGraphicalHierarchy(const DotGfxHierarchyTable &g)=0
void startInlineMemberType()
Definition: outputlist.h:454
unsigned char uchar
Definition: nybbler.cc:11
bool parseText(const QCString &textStr)
Definition: outputlist.cpp:175
void endParameterName(bool last, bool one, bool bracket)
Definition: outputlist.h:424
void endGroupCollaboration(const DotGroupCollaboration &g)
Definition: outputlist.h:400
virtual void startMemberTemplateParams()=0
virtual void startMemberHeader(const char *anchor)=0
virtual void writeLabel(const char *, bool)=0
virtual void setCurrentDoc(Definition *context, const char *anchor, bool isSourceFile)=0
void endCodeFragment()
Definition: outputlist.h:246
virtual void writeStyleInfo(int part)=0
void startIndexList()
Definition: outputlist.h:125
void endProjectNumber()
Definition: outputlist.h:93
void endDotGraph(const DotClassGraph &g)
Definition: outputlist.h:384
virtual void writeString(const char *text)=0
virtual void startCallGraph()=0
void writeCodeLink(const char *ref, const char *file, const char *anchor, const char *name, const char *tooltip)
Definition: outputlist.h:152
void startMemberGroup()
Definition: outputlist.h:234
virtual void startLabels()=0
virtual void endBold()=0
void endMemberDocPrefixItem()
Definition: outputlist.h:412
void popGeneratorState()
Definition: outputlist.cpp:121
void endMemberHeader()
Definition: outputlist.h:196
virtual void startMemberSubtitle()=0
void endIndexKey()
Definition: outputlist.h:131
void endDescTable()
Definition: outputlist.h:372
void endBold()
Definition: outputlist.h:306
void endCallGraph(const DotCallGraph &g)
Definition: outputlist.h:392
uint count() const
Definition: qlist.h:66
virtual void startItemList()=0
virtual void endMemberDocList()=0
virtual void writeTooltip(const char *id, const DocLinkInfo &docInfo, const char *decl, const char *desc, const SourceLinkInfo &defInfo, const SourceLinkInfo &declInfo)=0
void setCurrentDoc(Definition *context, const char *anchor, bool isSourceFile)
Definition: outputlist.h:480
virtual void startClassDiagram()=0
QAsciiDict< Entry > fn
void endParameterType()
Definition: outputlist.h:420
void endParagraph()
Definition: outputlist.h:117
virtual void startSmall()=0
void startSmall()
Definition: outputlist.h:298
virtual void endTextLink()=0
void startPlainFile(const char *name)
Definition: outputlist.h:485
void startPlainFile(const char *name)
Definition: outputgen.cpp:42
virtual void endMemberList()=0
virtual void endMemberDocName()=0
void endInlineMemberName()
Definition: outputlist.h:460
void writeSummaryLink(const char *file, const char *anchor, const char *title, bool first)
Definition: outputlist.h:362
void writeSplitBar(const char *name)
Definition: outputlist.h:354
void startCenter()
Definition: outputlist.h:294
fileName
Definition: dumpTree.py:9
virtual void writeFooter(const char *navPath)=0
void startFontClass(const char *c)
Definition: outputlist.h:474
virtual void endSection(const char *, SectionInfo::SectionType)=0
void pushGeneratorState()
Definition: outputlist.cpp:111
void startMemberDeclaration()
Definition: outputlist.h:312
virtual void startDescription()=0
def key(type, name=None)
Definition: graph.py:13
virtual void startMemberDoc(const char *, const char *, const char *, const char *, bool)=0
virtual void writeQuickLinks(bool compact, HighlightedItem hli, const char *file)=0
virtual void writeCodeLink(const char *ref, const char *file, const char *anchor, const char *name, const char *tooltip)=0
virtual void startTypewriter()=0
std::void_t< T > n
void startDescForItem()
Definition: outputlist.h:282
virtual void endEmphasis()=0
virtual void writeSearchInfo()=0
virtual void endPageRef(const char *, const char *)=0
const double a
virtual void endDoxyAnchor(const char *fileName, const char *anchor)=0
virtual void startIndexKey()=0
void writeTooltip(const char *id, const DocLinkInfo &docInfo, const char *decl, const char *desc, const SourceLinkInfo &defInfo, const SourceLinkInfo &declInfo)
Definition: outputlist.h:156
void startSubsection()
Definition: outputlist.h:286
void endIndexList()
Definition: outputlist.h:127
void writeChar(char c)
Definition: outputlist.h:259
void endHtmlLink()
Definition: outputlist.h:165
virtual void endDescription()=0
void startDescTableData()
Definition: outputlist.h:378
virtual void startGroupCollaboration()=0
virtual void docify(const char *s)=0
void startConstraintParam()
Definition: outputlist.h:435
virtual void lineBreak(const char *style)=0
virtual void startMemberDescription(const char *anchor, const char *inheritId)=0
virtual void addWord(const char *word, bool hiPriority)=0
void writeStyleInfo(int part)
Definition: outputlist.h:95
void addWord(const char *word, bool hiPriority)
Definition: outputlist.h:482
void startDescTable(const char *title)
Definition: outputlist.h:370
virtual void endMemberDocSimple()=0
virtual void startConstraintType()=0
virtual void endDescItem()=0
virtual void startSubsection()=0
virtual void endFile()=0
void disable(OutputGenerator::OutputType o)
Definition: outputlist.cpp:79
void endDescTableTitle()
Definition: outputlist.h:376
void writeInheritedSectionTitle(const char *id, const char *ref, const char *file, const char *anchor, const char *title, const char *name)
Definition: outputlist.h:316
void endIndexListItem()
Definition: outputlist.h:123
void startParameterList(bool openBracket)
Definition: outputlist.h:426
virtual void endMemberHeader()=0
type * current() const
Definition: qlist.h:146
void endParameterList()
Definition: outputlist.h:428
void startMemberGroupDocs()
Definition: outputlist.h:230
virtual void writeRuler()=0
virtual void writePageLink(const char *, bool)=0
void writeSynopsis()
Definition: outputlist.h:340
void writeDoc(DocRoot *root, Definition *ctx, MemberDef *md)
Definition: outputlist.cpp:162
virtual void writeCodeAnchor(const char *name)=0
void startConstraintType()
Definition: outputlist.h:439
void enable(OutputGenerator::OutputType o)
Definition: outputlist.cpp:89
virtual void startParameterType(bool, const char *key)=0
virtual void endParameterName(bool, bool, bool)=0
virtual void startContents()=0
virtual void writeChar(char c)=0
virtual void startMemberDocName(bool)=0
void endConstraintType()
Definition: outputlist.h:441
virtual void endMemberTemplateParams(const char *, const char *)=0
void startMemberSubtitle()
Definition: outputlist.h:198
virtual void startAnonTypeScope(int)=0
virtual void endDescTableData()=0
void startCodeLine(bool hasLineNumbers)
Definition: outputlist.h:248
void startBold()
Definition: outputlist.h:304
void endParamList()
Definition: outputlist.h:328
void startSimpleSect(SectionTypes t, const char *file, const char *anchor, const char *title)
Definition: outputlist.h:321
virtual void endParagraph()=0
virtual void lastIndexPage()=0
virtual void writeObjectLink(const char *ref, const char *file, const char *anchor, const char *name)=0
virtual void startFile(const char *name, const char *manName, const char *title)=0
void endPageRef(const char *c, const char *a)
Definition: outputlist.h:348
virtual void startIndexSection(IndexSections)=0
FORALLPROTO1(const char *)
virtual void endInlineMemberName()=0
void startDoxyAnchor(const char *fName, const char *manName, const char *anchor, const char *name, const char *args)
Definition: outputlist.h:266
virtual void startCenter()=0
void debug()
void endMemberDocList()
Definition: outputlist.h:204
void startMemberDoc(const char *clName, const char *memName, const char *anchor, const char *title, bool showInline)
Definition: outputlist.h:261
virtual void endInlineMemberType()=0
void startGroupHeader(int extraLevels=0)
Definition: outputlist.h:176
virtual void endCallGraph(const DotCallGraph &g)=0
void endQuickIndices()
Definition: outputlist.h:352
void endContents()
Definition: outputlist.h:366
virtual void insertMemberAlign(bool)=0
virtual void startInlineHeader()=0
virtual void startIndexListItem()=0
virtual void endMemberGroupHeader()=0
virtual void startIndexItem(const char *ref, const char *file)=0
virtual void startMemberSections()=0
void endMemberDoc(bool hasArgs)
Definition: outputlist.h:264
virtual void codify(const char *s)=0
void endCenter()
Definition: outputlist.h:296
void endSection(const char *lab, SectionInfo::SectionType t)
Definition: outputlist.h:336
void startIndexListItem()
Definition: outputlist.h:121
virtual void writeLatexSpacing()=0
void endItemListItem()
Definition: outputlist.h:184
virtual void endSmall()=0
virtual void endIndent()=0
void writeNavigationPath(const char *s)
Definition: outputlist.h:356
void startInlineMemberName()
Definition: outputlist.h:458
virtual void endMemberItem()=0
virtual void startParagraph()=0
void startDirDepGraph()
Definition: outputlist.h:394
virtual void startPageRef()=0
virtual void startGroupHeader(int)=0
FORALLPROTO3(bool, HighlightedItem, const char *)
virtual void startIndent()=0
void writeQuickLinks(bool compact, HighlightedItem hli, const char *file)
Definition: outputlist.h:360
void startIndexSection(IndexSections is)
Definition: outputlist.h:85
void startMemberTemplateParams()
Definition: outputlist.h:222
void endTitle()
Definition: outputlist.h:111
void startTypewriter()
Definition: outputlist.h:172
virtual void startEmphasis()=0
virtual void startDescTableTitle()=0
virtual void endLabels()=0
void endDoxyAnchor(const char *fn, const char *anchor)
Definition: outputlist.h:270
virtual void startCodeLine(bool hasLineNumbers)=0
OutputList(bool)
Definition: outputlist.cpp:33
void lastIndexPage()
Definition: outputlist.h:408
void endItemList()
Definition: outputlist.h:139
void add(const OutputGenerator *)
Definition: outputlist.cpp:44
void startTextBlock(bool dense=FALSE)
Definition: outputlist.h:404
virtual void startTitleHead(const char *)=0
void endMemberDocName()
Definition: outputlist.h:416
void startInlineHeader()
Definition: outputlist.h:210
void enableAll()
Definition: outputlist.cpp:59
virtual void startMemberItem(const char *, int, const char *)=0
virtual void startMemberDocList()=0
virtual void startMemberDocPrefixItem()=0
void endInclDepGraph(const DotInclDepGraph &g)
Definition: outputlist.h:388
void endClassDiagram(const ClassDiagram &d, const char *f, const char *n)
Definition: outputlist.h:344
def func()
Definition: docstring.py:7
void startClassDiagram()
Definition: outputlist.h:342
void writeAnchor(const char *fileName, const char *name)
Definition: outputlist.h:242
void endAnonTypeScope(int i1)
Definition: outputlist.h:216
virtual void writeSplitBar(const char *)=0
virtual void endItemListItem()=0
void startParamList(ParamListTypes t, const char *title)
Definition: outputlist.h:326
void endIndent()
Definition: outputlist.h:332
void endMemberDescription()
Definition: outputlist.h:310
static bool * b
Definition: config.cpp:1043
void endSubsubsection()
Definition: outputlist.h:292
void endDirDepGraph(const DotDirDeps &g)
Definition: outputlist.h:396
void endSimpleSect()
Definition: outputlist.h:324
void startHtmlLink(const char *url)
Definition: outputlist.h:163
void endTextBlock(bool paraBreak=FALSE)
Definition: outputlist.h:406
virtual void startDescItem()=0
void startConstraintList(const char *header)
Definition: outputlist.h:433
void endSubsection()
Definition: outputlist.h:288
virtual void endMemberDescription()=0
void endMemberSections()
Definition: outputlist.h:188
virtual void endMemberGroup(bool)=0
virtual void endContents()=0
void endMemberDocSimple()
Definition: outputlist.h:452
HighlightedItem
Definition: index.h:180
void startTitleHead(const char *fileName)
Definition: outputlist.h:105
virtual void writeLogo()=0
static QCString align(DocHtmlCell *cell)
virtual void startInlineMemberName()=0
virtual void startMemberList()=0
virtual void endDotGraph(const DotClassGraph &g)=0
virtual void writeNavigationPath(const char *)=0
virtual void endDescTableTitle()=0
virtual void endInclDepGraph(const DotInclDepGraph &g)=0
void endDescTableData()
Definition: outputlist.h:380
virtual void endCodeLine()=0
virtual void endDescTable()=0
virtual void startTextLink(const char *file, const char *anchor)=0
void writeFooter(const char *navPath)
Definition: outputlist.h:101
void endPlainFile()
Definition: outputlist.h:494
void startMemberHeader(const char *anchor)
Definition: outputlist.h:194
void endMemberSubtitle()
Definition: outputlist.h:200
void docify(const char *s)
Definition: outputlist.h:145
void insertMemberAlign(bool templ=FALSE)
Definition: outputlist.h:238
void endDescItem()
Definition: outputlist.h:280
virtual void startDotGraph()=0
virtual void endInlineHeader()=0
void startSection(const char *lab, const char *title, SectionInfo::SectionType t)
Definition: outputlist.h:334
virtual void endIndexSection(IndexSections)=0
virtual void endSubsubsection()=0
void writeObjectLink(const char *ref, const char *file, const char *anchor, const char *name)
Definition: outputlist.h:149
virtual void endParamList()=0
virtual void startConstraintDocs()=0
void forall(void(OutputGenerator::*func)())
Definition: outputlist.cpp:207
void startItemList()
Definition: outputlist.h:137
void writePageLink(const char *name, bool first)
Definition: outputlist.h:89
void startProjectNumber()
Definition: outputlist.h:91
void writeEndAnnoItem(const char *name)
Definition: outputlist.h:170
unsigned uint
Definition: qglobal.h:351
virtual void endIndexKey()=0
virtual void startTitle()=0
virtual void endConstraintDocs()=0
virtual void endCenter()=0
virtual void writeInheritedSectionTitle(const char *id, const char *ref, const char *file, const char *anchor, const char *title, const char *name)=0
void endConstraintList()
Definition: outputlist.h:447
void endTextLink()
Definition: outputlist.h:161
virtual void startMemberGroupHeader(bool)=0
virtual void startConstraintParam()=0
void endMemberTemplateParams(const char *anchor, const char *inheritId)
Definition: outputlist.h:224
static QCString * s
Definition: config.cpp:1042
void endMemberGroupHeader()
Definition: outputlist.h:228
virtual void startQuickIndices()=0
union ptb::content::word::word word
void endMemberList()
Definition: outputlist.h:208
virtual void endGroupCollaboration(const DotGroupCollaboration &g)=0
void startTitle()
Definition: outputlist.h:109
virtual void startIndexList()=0
void writeCodeAnchor(const char *name)
Definition: outputlist.h:478
virtual void startInlineMemberType()=0
virtual void startProjectNumber()=0
virtual void endIndexList()=0
void startContents()
Definition: outputlist.h:364
void startPageRef()
Definition: outputlist.h:346
virtual void startSubsubsection()=0
void startFile(const char *name, const char *manName, const char *title)
Definition: outputlist.h:97
void startMemberDocPrefixItem()
Definition: outputlist.h:410
void startLabels()
Definition: outputlist.h:467
void startCallGraph()
Definition: outputlist.h:390
void startIndexItem(const char *ref, const char *file)
Definition: outputlist.h:141
void startMemberGroupHeader(bool b)
Definition: outputlist.h:226
virtual void startItemListItem()=0
void disableAll()
Definition: outputlist.cpp:69
void endTypewriter()
Definition: outputlist.h:174
void startInclDepGraph()
Definition: outputlist.h:386
virtual void startParamList(ParamListTypes t, const char *title)=0
virtual void endAnonTypeScope(int)=0
void startDescItem()
Definition: outputlist.h:278
QList< OutputGenerator > m_outputs
Definition: outputlist.h:551
void startMemberDocName(bool align)
Definition: outputlist.h:414