Public Types | Public Member Functions | Protected Attributes | Private Member Functions | List of all members
OutputGenerator Class Referenceabstract

#include <outputgen.h>

Inheritance diagram for OutputGenerator:
BaseOutputDocInterface CodeOutputInterface HtmlGenerator LatexGenerator ManGenerator RTFGenerator

Public Types

enum  OutputType {
  Html, Latex, Man, RTF,
  XML, DEF, Perl
}
 
- Public Types inherited from BaseOutputDocInterface
enum  ParamListTypes { Param, RetVal, Exception }
 
enum  SectionTypes { EnumValues, Examples }
 

Public Member Functions

 OutputGenerator ()
 
virtual ~OutputGenerator ()
 
virtual void enable ()=0
 
virtual void disable ()=0
 
virtual void enableIf (OutputType o)=0
 
virtual void disableIf (OutputType o)=0
 
virtual void disableIfNot (OutputType o)=0
 
virtual bool isEnabled (OutputType o)=0
 
virtual OutputGenerator * get (OutputType o)=0
 
void startPlainFile (const char *name)
 
void endPlainFile ()
 
bool isEnabled () const
 
void pushGeneratorState ()
 
void popGeneratorState ()
 
virtual void writeDoc (DocNode *, Definition *ctx, MemberDef *md)=0
 
virtual void startFile (const char *name, const char *manName, const char *title)=0
 
virtual void writeSearchInfo ()=0
 
virtual void writeFooter (const char *navPath)=0
 
virtual void endFile ()=0
 
virtual void startIndexSection (IndexSections)=0
 
virtual void endIndexSection (IndexSections)=0
 
virtual void writePageLink (const char *, bool)=0
 
virtual void startProjectNumber ()=0
 
virtual void endProjectNumber ()=0
 
virtual void writeStyleInfo (int part)=0
 
virtual void startTitleHead (const char *)=0
 
virtual void endTitleHead (const char *fileName, const char *name)=0
 
virtual void startIndexListItem ()=0
 
virtual void endIndexListItem ()=0
 
virtual void startIndexList ()=0
 
virtual void endIndexList ()=0
 
virtual void startIndexKey ()=0
 
virtual void endIndexKey ()=0
 
virtual void startIndexValue (bool)=0
 
virtual void endIndexValue (const char *, bool)=0
 
virtual void startIndexItem (const char *ref, const char *file)=0
 
virtual void endIndexItem (const char *ref, const char *file)=0
 
virtual void startGroupHeader (int)=0
 
virtual void endGroupHeader (int)=0
 
virtual void startMemberSections ()=0
 
virtual void endMemberSections ()=0
 
virtual void startHeaderSection ()=0
 
virtual void endHeaderSection ()=0
 
virtual void startMemberHeader (const char *anchor)=0
 
virtual void endMemberHeader ()=0
 
virtual void startMemberSubtitle ()=0
 
virtual void endMemberSubtitle ()=0
 
virtual void startMemberDocList ()=0
 
virtual void endMemberDocList ()=0
 
virtual void startMemberList ()=0
 
virtual void endMemberList ()=0
 
virtual void startInlineHeader ()=0
 
virtual void endInlineHeader ()=0
 
virtual void startAnonTypeScope (int)=0
 
virtual void endAnonTypeScope (int)=0
 
virtual void startMemberItem (const char *, int, const char *)=0
 
virtual void endMemberItem ()=0
 
virtual void startMemberTemplateParams ()=0
 
virtual void endMemberTemplateParams (const char *, const char *)=0
 
virtual void startMemberGroupHeader (bool)=0
 
virtual void endMemberGroupHeader ()=0
 
virtual void startMemberGroupDocs ()=0
 
virtual void endMemberGroupDocs ()=0
 
virtual void startMemberGroup ()=0
 
virtual void endMemberGroup (bool)=0
 
virtual void insertMemberAlign (bool)=0
 
virtual void startMemberDoc (const char *, const char *, const char *, const char *, bool)=0
 
virtual void endMemberDoc (bool)=0
 
virtual void startDoxyAnchor (const char *fName, const char *manName, const char *anchor, const char *name, const char *args)=0
 
virtual void endDoxyAnchor (const char *fileName, const char *anchor)=0
 
virtual void writeLatexSpacing ()=0
 
virtual void writeStartAnnoItem (const char *type, const char *file, const char *path, const char *name)=0
 
virtual void writeEndAnnoItem (const char *name)=0
 
virtual void startMemberDescription (const char *anchor, const char *inheritId)=0
 
virtual void endMemberDescription ()=0
 
virtual void startMemberDeclaration ()=0
 
virtual void endMemberDeclaration (const char *anchor, const char *inheritId)=0
 
virtual void writeInheritedSectionTitle (const char *id, const char *ref, const char *file, const char *anchor, const char *title, const char *name)=0
 
virtual void startIndent ()=0
 
virtual void endIndent ()=0
 
virtual void writeSynopsis ()=0
 
virtual void startClassDiagram ()=0
 
virtual void endClassDiagram (const ClassDiagram &, const char *, const char *)=0
 
virtual void startDotGraph ()=0
 
virtual void endDotGraph (const DotClassGraph &g)=0
 
virtual void startInclDepGraph ()=0
 
virtual void endInclDepGraph (const DotInclDepGraph &g)=0
 
virtual void startGroupCollaboration ()=0
 
virtual void endGroupCollaboration (const DotGroupCollaboration &g)=0
 
virtual void startCallGraph ()=0
 
virtual void endCallGraph (const DotCallGraph &g)=0
 
virtual void startDirDepGraph ()=0
 
virtual void endDirDepGraph (const DotDirDeps &g)=0
 
virtual void writeGraphicalHierarchy (const DotGfxHierarchyTable &g)=0
 
virtual void startQuickIndices ()=0
 
virtual void endQuickIndices ()=0
 
virtual void writeSplitBar (const char *)=0
 
virtual void writeNavigationPath (const char *)=0
 
virtual void writeLogo ()=0
 
virtual void writeQuickLinks (bool compact, HighlightedItem hli, const char *file)=0
 
virtual void writeSummaryLink (const char *file, const char *anchor, const char *title, bool first)=0
 
virtual void startContents ()=0
 
virtual void endContents ()=0
 
virtual void startTextBlock (bool)=0
 
virtual void endTextBlock (bool)=0
 
virtual void lastIndexPage ()=0
 
virtual void startMemberDocPrefixItem ()=0
 
virtual void endMemberDocPrefixItem ()=0
 
virtual void startMemberDocName (bool)=0
 
virtual void endMemberDocName ()=0
 
virtual void startParameterType (bool, const char *key)=0
 
virtual void endParameterType ()=0
 
virtual void startParameterName (bool)=0
 
virtual void endParameterName (bool, bool, bool)=0
 
virtual void startParameterList (bool)=0
 
virtual void endParameterList ()=0
 
virtual void exceptionEntry (const char *, bool)=0
 
virtual void startConstraintList (const char *)=0
 
virtual void startConstraintParam ()=0
 
virtual void endConstraintParam ()=0
 
virtual void startConstraintType ()=0
 
virtual void endConstraintType ()=0
 
virtual void startConstraintDocs ()=0
 
virtual void endConstraintDocs ()=0
 
virtual void endConstraintList ()=0
 
virtual void startMemberDocSimple ()=0
 
virtual void endMemberDocSimple ()=0
 
virtual void startInlineMemberType ()=0
 
virtual void endInlineMemberType ()=0
 
virtual void startInlineMemberName ()=0
 
virtual void endInlineMemberName ()=0
 
virtual void startInlineMemberDoc ()=0
 
virtual void endInlineMemberDoc ()=0
 
virtual void startLabels ()=0
 
virtual void writeLabel (const char *, bool)=0
 
virtual void endLabels ()=0
 
- Public Member Functions inherited from BaseOutputDocInterface
virtual ~BaseOutputDocInterface ()
 
virtual bool parseText (const QCString &s)
 
virtual void startItemList ()=0
 
virtual void startItemListItem ()=0
 
virtual void endItemListItem ()=0
 
virtual void endItemList ()=0
 
virtual void docify (const char *s)=0
 
virtual void writeChar (char c)=0
 
virtual void writeString (const char *text)=0
 
virtual void startParagraph ()=0
 
virtual void endParagraph ()=0
 
virtual void writeObjectLink (const char *ref, const char *file, const char *anchor, const char *name)=0
 
virtual void startHtmlLink (const char *url)=0
 
virtual void endHtmlLink ()=0
 
virtual void startBold ()=0
 
virtual void endBold ()=0
 
virtual void startTypewriter ()=0
 
virtual void endTypewriter ()=0
 
virtual void startEmphasis ()=0
 
virtual void endEmphasis ()=0
 
virtual void startCodeFragment ()=0
 
virtual void endCodeFragment ()=0
 
virtual void writeRuler ()=0
 
virtual void startDescription ()=0
 
virtual void endDescription ()=0
 
virtual void startDescItem ()=0
 
virtual void startDescForItem ()=0
 
virtual void endDescForItem ()=0
 
virtual void endDescItem ()=0
 
virtual void startCenter ()=0
 
virtual void endCenter ()=0
 
virtual void startSmall ()=0
 
virtual void endSmall ()=0
 
virtual void startSimpleSect (SectionTypes t, const char *file, const char *anchor, const char *title)=0
 
virtual void endSimpleSect ()=0
 
virtual void startParamList (ParamListTypes t, const char *title)=0
 
virtual void endParamList ()=0
 
virtual void startTitle ()=0
 
virtual void endTitle ()=0
 
virtual void writeAnchor (const char *fileName, const char *name)=0
 
virtual void startSection (const char *, const char *, SectionInfo::SectionType)=0
 
virtual void endSection (const char *, SectionInfo::SectionType)=0
 
virtual void lineBreak (const char *style)=0
 
virtual void addIndexItem (const char *s1, const char *s2)=0
 
virtual void writeNonBreakableSpace (int)=0
 
virtual void startDescTable (const char *title)=0
 
virtual void endDescTable ()=0
 
virtual void startDescTableTitle ()=0
 
virtual void endDescTableTitle ()=0
 
virtual void startDescTableData ()=0
 
virtual void endDescTableData ()=0
 
virtual void startTextLink (const char *file, const char *anchor)=0
 
virtual void endTextLink ()=0
 
virtual void startPageRef ()=0
 
virtual void endPageRef (const char *, const char *)=0
 
virtual void startSubsection ()=0
 
virtual void endSubsection ()=0
 
virtual void startSubsubsection ()=0
 
virtual void endSubsubsection ()=0
 
- Public Member Functions inherited from CodeOutputInterface
virtual ~CodeOutputInterface ()
 
virtual void codify (const char *s)=0
 
virtual void writeCodeLink (const char *ref, const char *file, const char *anchor, const char *name, const char *tooltip)=0
 
virtual void writeLineNumber (const char *ref, const char *file, const char *anchor, int lineNumber)=0
 
virtual void writeTooltip (const char *id, const DocLinkInfo &docInfo, const char *decl, const char *desc, const SourceLinkInfo &defInfo, const SourceLinkInfo &declInfo)=0
 
virtual void startCodeLine (bool hasLineNumbers)=0
 
virtual void endCodeLine ()=0
 
virtual void startFontClass (const char *clsName)=0
 
virtual void endFontClass ()=0
 
virtual void writeCodeAnchor (const char *name)=0
 
virtual void setCurrentDoc (Definition *context, const char *anchor, bool isSourceFile)=0
 
virtual void addWord (const char *word, bool hiPriority)=0
 

Protected Attributes

FTextStream t
 
QFile * file
 
QCString fileName
 
QCString dir
 
bool active
 
QStack< bool > * genStack
 

Private Member Functions

 OutputGenerator (const OutputGenerator &o)
 
OutputGenerator & operator= (const OutputGenerator &o)
 

Detailed Description

Abstract output generator.

Subclass this class to add support for a new output format

Definition at line 320 of file outputgen.h.

Member Enumeration Documentation

enum OutputGenerator::OutputType
Enumerator
Html 
Latex 
Man 
RTF 
XML 
DEF 
Perl 

Definition at line 323 of file outputgen.h.

323 { Html, Latex, Man, RTF, XML, DEF, Perl };

Constructor & Destructor Documentation

OutputGenerator::OutputGenerator ( )

Definition at line 26 of file outputgen.cpp.

27 {
28  //printf("OutputGenerator::OutputGenerator()\n");
29  file=0;
30  active=TRUE;
31  genStack = new QStack<bool>;
32  genStack->setAutoDelete(TRUE);
33 }
QStack::setAutoDelete
void setAutoDelete(bool del)
Definition: qstack.h:55
OutputGenerator::genStack
QStack< bool > * genStack
Definition: outputgen.h:491
OutputGenerator::file
QFile * file
Definition: outputgen.h:487
TRUE
const bool TRUE
Definition: qglobal.h:371
OutputGenerator::~OutputGenerator ( )
virtual

Definition at line 35 of file outputgen.cpp.

36 {
37  //printf("OutputGenerator::~OutputGenerator()\n");
38  delete file;
39  delete genStack;
40 }
OutputGenerator::genStack
QStack< bool > * genStack
Definition: outputgen.h:491
OutputGenerator::file
QFile * file
Definition: outputgen.h:487
OutputGenerator::OutputGenerator ( const OutputGenerator &  o)
private

Member Function Documentation

virtual void OutputGenerator::disable ( )
pure virtual

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

virtual void OutputGenerator::disableIf ( OutputType  o)
pure virtual

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

virtual void OutputGenerator::disableIfNot ( OutputType  o)
pure virtual

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

virtual void OutputGenerator::enable ( )
pure virtual

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

virtual void OutputGenerator::enableIf ( OutputType  o)
pure virtual

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

virtual void OutputGenerator::endAnonTypeScope ( int  )
pure virtual

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

virtual void OutputGenerator::endCallGraph ( const DotCallGraph &  g)
pure virtual

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

virtual void OutputGenerator::endClassDiagram ( const ClassDiagram &  ,
const char *  ,
const char *   
)
pure virtual

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

virtual void OutputGenerator::endConstraintDocs ( )
pure virtual

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

virtual void OutputGenerator::endConstraintList ( )
pure virtual

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

virtual void OutputGenerator::endConstraintParam ( )
pure virtual

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

virtual void OutputGenerator::endConstraintType ( )
pure virtual

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

virtual void OutputGenerator::endContents ( )
pure virtual

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

virtual void OutputGenerator::endDirDepGraph ( const DotDirDeps &  g)
pure virtual

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

virtual void OutputGenerator::endDotGraph ( const DotClassGraph &  g)
pure virtual

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

virtual void OutputGenerator::endDoxyAnchor ( const char *  fileName,
const char *  anchor 
)
pure virtual

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

virtual void OutputGenerator::endFile ( )
pure virtual

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

virtual void OutputGenerator::endGroupCollaboration ( const DotGroupCollaboration &  g)
pure virtual

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

virtual void OutputGenerator::endGroupHeader ( int  )
pure virtual

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

virtual void OutputGenerator::endHeaderSection ( )
pure virtual

Implemented in HtmlGenerator, LatexGenerator, RTFGenerator, and ManGenerator.

virtual void OutputGenerator::endInclDepGraph ( const DotInclDepGraph &  g)
pure virtual

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

virtual void OutputGenerator::endIndent ( )
pure virtual

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

virtual void OutputGenerator::endIndexItem ( const char *  ref,
const char *  file 
)
pure virtual

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

virtual void OutputGenerator::endIndexKey ( )
pure virtual

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

virtual void OutputGenerator::endIndexList ( )
pure virtual

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

virtual void OutputGenerator::endIndexListItem ( )
pure virtual

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

virtual void OutputGenerator::endIndexSection ( IndexSections  )
pure virtual

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

virtual void OutputGenerator::endIndexValue ( const char *  ,
bool   
)
pure virtual

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

virtual void OutputGenerator::endInlineHeader ( )
pure virtual

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

virtual void OutputGenerator::endInlineMemberDoc ( )
pure virtual

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

virtual void OutputGenerator::endInlineMemberName ( )
pure virtual

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

virtual void OutputGenerator::endInlineMemberType ( )
pure virtual

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

virtual void OutputGenerator::endLabels ( )
pure virtual

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

virtual void OutputGenerator::endMemberDeclaration ( const char *  anchor,
const char *  inheritId 
)
pure virtual

Implemented in LatexGenerator, HtmlGenerator, ManGenerator, and RTFGenerator.

virtual void OutputGenerator::endMemberDescription ( )
pure virtual

Implemented in LatexGenerator, HtmlGenerator, ManGenerator, and RTFGenerator.

virtual void OutputGenerator::endMemberDoc ( bool  )
pure virtual

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

virtual void OutputGenerator::endMemberDocList ( )
pure virtual

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

virtual void OutputGenerator::endMemberDocName ( )
pure virtual

Implemented in HtmlGenerator, LatexGenerator, RTFGenerator, and ManGenerator.

virtual void OutputGenerator::endMemberDocPrefixItem ( )
pure virtual

Implemented in HtmlGenerator, LatexGenerator, RTFGenerator, and ManGenerator.

virtual void OutputGenerator::endMemberDocSimple ( )
pure virtual

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

virtual void OutputGenerator::endMemberGroup ( bool  )
pure virtual

Implemented in RTFGenerator, HtmlGenerator, LatexGenerator, and ManGenerator.

virtual void OutputGenerator::endMemberGroupDocs ( )
pure virtual

Implemented in RTFGenerator, HtmlGenerator, LatexGenerator, and ManGenerator.

virtual void OutputGenerator::endMemberGroupHeader ( )
pure virtual

Implemented in RTFGenerator, HtmlGenerator, LatexGenerator, and ManGenerator.

virtual void OutputGenerator::endMemberHeader ( )
pure virtual

Implemented in HtmlGenerator, LatexGenerator, RTFGenerator, and ManGenerator.

virtual void OutputGenerator::endMemberItem ( )
pure virtual

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

virtual void OutputGenerator::endMemberList ( )
pure virtual

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

virtual void OutputGenerator::endMemberSections ( )
pure virtual

Implemented in HtmlGenerator, LatexGenerator, RTFGenerator, and ManGenerator.

virtual void OutputGenerator::endMemberSubtitle ( )
pure virtual

Implemented in HtmlGenerator, LatexGenerator, RTFGenerator, and ManGenerator.

virtual void OutputGenerator::endMemberTemplateParams ( const char *  ,
const char *   
)
pure virtual

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

virtual void OutputGenerator::endParameterList ( )
pure virtual

Implemented in HtmlGenerator, LatexGenerator, RTFGenerator, and ManGenerator.

virtual void OutputGenerator::endParameterName ( bool  ,
bool  ,
bool   
)
pure virtual

Implemented in HtmlGenerator, LatexGenerator, RTFGenerator, and ManGenerator.

virtual void OutputGenerator::endParameterType ( )
pure virtual

Implemented in HtmlGenerator, LatexGenerator, RTFGenerator, and ManGenerator.

void OutputGenerator::endPlainFile ( )

Definition at line 55 of file outputgen.cpp.

56 {
57  t.unsetDevice();
58  delete file;
59  file=0;
60  fileName.resize(0);
61 }
QCString::resize
bool resize(uint newlen)
Definition: qcstring.h:225
FTextStream::unsetDevice
void unsetDevice()
Definition: ftextstream.cpp:192
OutputGenerator::file
QFile * file
Definition: outputgen.h:487
OutputGenerator::fileName
QCString fileName
Definition: outputgen.h:488
OutputGenerator::t
FTextStream t
Definition: outputgen.h:486
virtual void OutputGenerator::endProjectNumber ( )
pure virtual

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

virtual void OutputGenerator::endQuickIndices ( )
pure virtual

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

virtual void OutputGenerator::endTextBlock ( bool  )
pure virtual

Implemented in HtmlGenerator, LatexGenerator, RTFGenerator, and ManGenerator.

virtual void OutputGenerator::endTitleHead ( const char *  fileName,
const char *  name 
)
pure virtual

Implemented in HtmlGenerator, LatexGenerator, RTFGenerator, and ManGenerator.

virtual void OutputGenerator::exceptionEntry ( const char *  ,
bool   
)
pure virtual

Implemented in HtmlGenerator, LatexGenerator, RTFGenerator, and ManGenerator.

virtual OutputGenerator* OutputGenerator::get ( OutputType  o)
pure virtual

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

virtual void OutputGenerator::insertMemberAlign ( bool  )
pure virtual

Implemented in HtmlGenerator, LatexGenerator, RTFGenerator, and ManGenerator.

virtual bool OutputGenerator::isEnabled ( OutputType  o)
pure virtual

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

bool OutputGenerator::isEnabled ( ) const
inline

Definition at line 341 of file outputgen.h.

341 { return active; }
virtual void OutputGenerator::lastIndexPage ( )
pure virtual

Implemented in HtmlGenerator, LatexGenerator, RTFGenerator, and ManGenerator.

OutputGenerator& OutputGenerator::operator= ( const OutputGenerator &  o)
private
void OutputGenerator::popGeneratorState ( )

Definition at line 69 of file outputgen.cpp.

70 {
71  //printf("%p:popGeneratorState(%d) enabled=%d\n",this,genStack->count(),isEnabled());
72  bool *lb = genStack->pop();
73  ASSERT(lb!=0);
74  if (lb==0) return; // for some robustness against superfluous \endhtmlonly commands.
75  if (*lb) enable(); else disable();
76  delete lb;
77 }
OutputGenerator::enable
virtual void enable()=0
OutputGenerator::genStack
QStack< bool > * genStack
Definition: outputgen.h:491
QStack::pop
type * pop()
Definition: qstack.h:59
OutputGenerator::disable
virtual void disable()=0
ASSERT
#define ASSERT(x)
Definition: qglobal.h:590
void OutputGenerator::pushGeneratorState ( )

Definition at line 63 of file outputgen.cpp.

64 {
65  genStack->push(new bool(isEnabled()));
66  //printf("%p:pushGeneratorState(%d) enabled=%d\n",this,genStack->count(),isEnabled());
67 }
QStack::push
void push(const type *d)
Definition: qstack.h:58
OutputGenerator::genStack
QStack< bool > * genStack
Definition: outputgen.h:491
OutputGenerator::isEnabled
bool isEnabled() const
Definition: outputgen.h:341
virtual void OutputGenerator::startAnonTypeScope ( int  )
pure virtual

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

virtual void OutputGenerator::startCallGraph ( )
pure virtual

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

virtual void OutputGenerator::startClassDiagram ( )
pure virtual

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

virtual void OutputGenerator::startConstraintDocs ( )
pure virtual

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

virtual void OutputGenerator::startConstraintList ( const char *  )
pure virtual

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

virtual void OutputGenerator::startConstraintParam ( )
pure virtual

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

virtual void OutputGenerator::startConstraintType ( )
pure virtual

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

virtual void OutputGenerator::startContents ( )
pure virtual

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

virtual void OutputGenerator::startDirDepGraph ( )
pure virtual

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

virtual void OutputGenerator::startDotGraph ( )
pure virtual

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

virtual void OutputGenerator::startDoxyAnchor ( const char *  fName,
const char *  manName,
const char *  anchor,
const char *  name,
const char *  args 
)
pure virtual

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

virtual void OutputGenerator::startFile ( const char *  name,
const char *  manName,
const char *  title 
)
pure virtual

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

virtual void OutputGenerator::startGroupCollaboration ( )
pure virtual

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

virtual void OutputGenerator::startGroupHeader ( int  )
pure virtual

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

virtual void OutputGenerator::startHeaderSection ( )
pure virtual

Implemented in HtmlGenerator, LatexGenerator, RTFGenerator, and ManGenerator.

virtual void OutputGenerator::startInclDepGraph ( )
pure virtual

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

virtual void OutputGenerator::startIndent ( )
pure virtual

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

virtual void OutputGenerator::startIndexItem ( const char *  ref,
const char *  file 
)
pure virtual

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

virtual void OutputGenerator::startIndexKey ( )
pure virtual

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

virtual void OutputGenerator::startIndexList ( )
pure virtual

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

virtual void OutputGenerator::startIndexListItem ( )
pure virtual

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

virtual void OutputGenerator::startIndexSection ( IndexSections  )
pure virtual

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

virtual void OutputGenerator::startIndexValue ( bool  )
pure virtual

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

virtual void OutputGenerator::startInlineHeader ( )
pure virtual

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

virtual void OutputGenerator::startInlineMemberDoc ( )
pure virtual

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

virtual void OutputGenerator::startInlineMemberName ( )
pure virtual

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

virtual void OutputGenerator::startInlineMemberType ( )
pure virtual

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

virtual void OutputGenerator::startLabels ( )
pure virtual

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

virtual void OutputGenerator::startMemberDeclaration ( )
pure virtual

Implemented in LatexGenerator, HtmlGenerator, ManGenerator, and RTFGenerator.

virtual void OutputGenerator::startMemberDescription ( const char *  anchor,
const char *  inheritId 
)
pure virtual

Implemented in LatexGenerator, HtmlGenerator, ManGenerator, and RTFGenerator.

virtual void OutputGenerator::startMemberDoc ( const char *  ,
const char *  ,
const char *  ,
const char *  ,
bool   
)
pure virtual

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

virtual void OutputGenerator::startMemberDocList ( )
pure virtual

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

virtual void OutputGenerator::startMemberDocName ( bool  )
pure virtual

Implemented in HtmlGenerator, LatexGenerator, RTFGenerator, and ManGenerator.

virtual void OutputGenerator::startMemberDocPrefixItem ( )
pure virtual

Implemented in HtmlGenerator, LatexGenerator, RTFGenerator, and ManGenerator.

virtual void OutputGenerator::startMemberDocSimple ( )
pure virtual

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

virtual void OutputGenerator::startMemberGroup ( )
pure virtual

Implemented in RTFGenerator, HtmlGenerator, LatexGenerator, and ManGenerator.

virtual void OutputGenerator::startMemberGroupDocs ( )
pure virtual

Implemented in RTFGenerator, HtmlGenerator, LatexGenerator, and ManGenerator.

virtual void OutputGenerator::startMemberGroupHeader ( bool  )
pure virtual

Implemented in RTFGenerator, HtmlGenerator, LatexGenerator, and ManGenerator.

virtual void OutputGenerator::startMemberHeader ( const char *  anchor)
pure virtual

Implemented in HtmlGenerator, LatexGenerator, RTFGenerator, and ManGenerator.

virtual void OutputGenerator::startMemberItem ( const char *  ,
int  ,
const char *   
)
pure virtual

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

virtual void OutputGenerator::startMemberList ( )
pure virtual

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

virtual void OutputGenerator::startMemberSections ( )
pure virtual

Implemented in HtmlGenerator, LatexGenerator, RTFGenerator, and ManGenerator.

virtual void OutputGenerator::startMemberSubtitle ( )
pure virtual

Implemented in HtmlGenerator, LatexGenerator, RTFGenerator, and ManGenerator.

virtual void OutputGenerator::startMemberTemplateParams ( )
pure virtual

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

virtual void OutputGenerator::startParameterList ( bool  )
pure virtual

Implemented in HtmlGenerator, LatexGenerator, RTFGenerator, and ManGenerator.

virtual void OutputGenerator::startParameterName ( bool  )
pure virtual

Implemented in HtmlGenerator, LatexGenerator, RTFGenerator, and ManGenerator.

virtual void OutputGenerator::startParameterType ( bool  ,
const char *  key 
)
pure virtual

Implemented in HtmlGenerator, LatexGenerator, RTFGenerator, and ManGenerator.

void OutputGenerator::startPlainFile ( const char *  name)

Definition at line 42 of file outputgen.cpp.

43 {
44  //printf("startPlainFile(%s)\n",name);
45  fileName=dir+"/"+name;
46  file = new QFile(fileName);
47  if (!file->open(IO_WriteOnly))
48  {
49  err("Could not open file %s for writing\n",fileName.data());
50  exit(1);
51  }
52  t.setDevice(file);
53 }
name
static QCString name
Definition: declinfo.cpp:673
IO_WriteOnly
#define IO_WriteOnly
Definition: qiodevice.h:62
FTextStream::setDevice
void setDevice(QIODevice *)
Definition: ftextstream.cpp:182
QFile::open
bool open(int)
Definition: qfile_unix.cpp:134
QCString::data
const char * data() const
Definition: qcstring.h:207
OutputGenerator::file
QFile * file
Definition: outputgen.h:487
err
void err(const char *fmt,...)
Definition: message.cpp:226
QFile
The QFile class is an I/O device that operates on files.
Definition: qfile.h:50
OutputGenerator::fileName
QCString fileName
Definition: outputgen.h:488
OutputGenerator::dir
QCString dir
Definition: outputgen.h:489
OutputGenerator::t
FTextStream t
Definition: outputgen.h:486
virtual void OutputGenerator::startProjectNumber ( )
pure virtual

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

virtual void OutputGenerator::startQuickIndices ( )
pure virtual

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

virtual void OutputGenerator::startTextBlock ( bool  )
pure virtual

Implemented in HtmlGenerator, LatexGenerator, RTFGenerator, and ManGenerator.

virtual void OutputGenerator::startTitleHead ( const char *  )
pure virtual

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

virtual void OutputGenerator::writeDoc ( DocNode *  ,
Definition *  ctx,
MemberDef *  md 
)
pure virtual

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

virtual void OutputGenerator::writeEndAnnoItem ( const char *  name)
pure virtual

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

virtual void OutputGenerator::writeFooter ( const char *  navPath)
pure virtual

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

virtual void OutputGenerator::writeGraphicalHierarchy ( const DotGfxHierarchyTable &  g)
pure virtual

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

virtual void OutputGenerator::writeInheritedSectionTitle ( const char *  id,
const char *  ref,
const char *  file,
const char *  anchor,
const char *  title,
const char *  name 
)
pure virtual

Implemented in LatexGenerator, HtmlGenerator, ManGenerator, and RTFGenerator.

virtual void OutputGenerator::writeLabel ( const char *  ,
bool   
)
pure virtual

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

virtual void OutputGenerator::writeLatexSpacing ( )
pure virtual

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

virtual void OutputGenerator::writeLogo ( )
pure virtual

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

virtual void OutputGenerator::writeNavigationPath ( const char *  )
pure virtual

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

virtual void OutputGenerator::writePageLink ( const char *  ,
bool   
)
pure virtual

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

virtual void OutputGenerator::writeQuickLinks ( bool  compact,
HighlightedItem  hli,
const char *  file 
)
pure virtual

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

virtual void OutputGenerator::writeSearchInfo ( )
pure virtual

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

virtual void OutputGenerator::writeSplitBar ( const char *  )
pure virtual

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

virtual void OutputGenerator::writeStartAnnoItem ( const char *  type,
const char *  file,
const char *  path,
const char *  name 
)
pure virtual

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

virtual void OutputGenerator::writeStyleInfo ( int  part)
pure virtual

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

virtual void OutputGenerator::writeSummaryLink ( const char *  file,
const char *  anchor,
const char *  title,
bool  first 
)
pure virtual

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

virtual void OutputGenerator::writeSynopsis ( )
pure virtual

Implemented in HtmlGenerator, LatexGenerator, ManGenerator, and RTFGenerator.

Member Data Documentation

bool OutputGenerator::active
protected

Definition at line 490 of file outputgen.h.

QCString OutputGenerator::dir
protected

Definition at line 489 of file outputgen.h.

QFile* OutputGenerator::file
protected

Definition at line 487 of file outputgen.h.

QCString OutputGenerator::fileName
protected

Definition at line 488 of file outputgen.h.

QStack<bool>* OutputGenerator::genStack
protected

Definition at line 491 of file outputgen.h.

FTextStream OutputGenerator::t
protected

Definition at line 486 of file outputgen.h.

The documentation for this class was generated from the following files:
Generated by   doxygen 1.8.11