summaryrefslogtreecommitdiffstats
path: root/src/docbookgen.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/docbookgen.h')
-rw-r--r--src/docbookgen.h347
1 files changed, 346 insertions, 1 deletions
diff --git a/src/docbookgen.h b/src/docbookgen.h
index 866d056..3fafff1 100644
--- a/src/docbookgen.h
+++ b/src/docbookgen.h
@@ -15,6 +15,351 @@
#ifndef DOCBOOKGEN_H
#define DOCBOOKGEN_H
-void generateDocbook();
+#include "outputgen.h"
+
+void generateDocbook_v1();
+
+class DocbookCodeGenerator : public CodeOutputInterface
+{
+ public:
+ DocbookCodeGenerator(FTextStream &t);
+ DocbookCodeGenerator();
+ virtual ~DocbookCodeGenerator();
+ void setTextStream(FTextStream &t)
+ {
+ m_streamSet = t.device()!=0;
+ m_t.setDevice(t.device());
+ }
+ void setRelativePath(const QCString &path) { m_relPath = path; }
+ void setSourceFileName(const QCString &sourceFileName) { m_sourceFileName = sourceFileName; }
+ QCString sourceFileName() { return m_sourceFileName; }
+
+ void codify(const char *text);
+ void writeCodeLink(const char *ref,const char *file,
+ const char *anchor,const char *name,
+ const char *tooltip);
+ void writeCodeLinkLine(const char *ref,const char *file,
+ const char *anchor,const char *name,
+ const char *tooltip);
+ void writeTooltip(const char *, const DocLinkInfo &, const char *,
+ const char *, const SourceLinkInfo &, const SourceLinkInfo &
+ );
+ void startCodeLine(bool);
+ void endCodeLine();
+ void startFontClass(const char *colorClass);
+ void endFontClass();
+ void writeCodeAnchor(const char *);
+ void writeLineNumber(const char *extRef,const char *compId,
+ const char *anchorId,int l);
+ void setCurrentDoc(Definition *,const char *,bool);
+ void addWord(const char *,bool);
+ void finish();
+ void startCodeFragment();
+ void endCodeFragment();
+
+ private:
+ FTextStream m_t;
+ bool m_streamSet;
+ QCString m_refId;
+ QCString m_external;
+ int m_lineNumber;
+ int m_col;
+ bool m_insideCodeLine;
+ bool m_insideSpecialHL;
+ QCString m_relPath;
+ QCString m_sourceFileName;
+ bool m_prettyCode;
+};
+
+
+#if 0
+// define for cases that have been implemented with an empty body
+#define DB_GEN_EMPTY t << "<!-- DBG_GEN_head_check " << __LINE__ << " -->\n";
+#else
+#define DB_GEN_EMPTY
+#endif
+
+#if 0
+// Generic debug statements
+#define DB_GEN_H DB_GEN_H1(t)
+#define DB_GEN_H1(x) x << "<!-- DBG_GEN_head " << __LINE__ << " -->\n";
+#define DB_GEN_H2(y) DB_GEN_H2a(t,y)
+#define DB_GEN_H2a(x,y) x << "<!-- DBG_GEN_head " << __LINE__ << " " << y << " -->\n";
+// define for cases that have NOT yet been implemented / considered
+#define DB_GEN_NEW fprintf(stderr,"DBG_GEN_head %d\n",__LINE__); DB_GEN_H
+#else
+#define DB_GEN_H
+#define DB_GEN_H1(x)
+#define DB_GEN_H2(y)
+#define DB_GEN_H2a(x,y)
+#define DB_GEN_NEW
+#endif
+
+class DocbookGenerator : public OutputGenerator
+{
+ public:
+ DocbookGenerator();
+ ~DocbookGenerator();
+ static void init();
+
+ ///////////////////////////////////////////////////////////////
+ // generic generator methods
+ ///////////////////////////////////////////////////////////////
+ void enable()
+ { if (genStack->top()) active=*genStack->top(); else active=TRUE; }
+ void disable() { active=FALSE; }
+ void enableIf(OutputType o) { if (o==Docbook) enable(); }
+ void disableIf(OutputType o) { if (o==Docbook) disable(); }
+ void disableIfNot(OutputType o) { if (o!=Docbook) disable(); }
+ bool isEnabled(OutputType o) { return (o==Docbook && active); }
+ OutputGenerator *get(OutputType o) { return (o==Docbook) ? this : 0; }
+
+ // --- CodeOutputInterface
+ void codify(const char *text)
+ { m_codeGen.codify(text); }
+ void writeCodeLink(const char *ref, const char *file,
+ const char *anchor,const char *name,
+ const char *tooltip)
+ { m_codeGen.writeCodeLink(ref,file,anchor,name,tooltip); }
+ void writeLineNumber(const char *ref,const char *file,const char *anchor,int lineNumber)
+ { m_codeGen.writeLineNumber(ref,file,anchor,lineNumber); }
+ void writeTooltip(const char *id, const DocLinkInfo &docInfo, const char *decl,
+ const char *desc, const SourceLinkInfo &defInfo, const SourceLinkInfo &declInfo
+ )
+ { m_codeGen.writeTooltip(id,docInfo,decl,desc,defInfo,declInfo); }
+ void startCodeLine(bool hasLineNumbers)
+ { m_codeGen.startCodeLine(hasLineNumbers); }
+ void endCodeLine()
+ { m_codeGen.endCodeLine(); }
+ void startFontClass(const char *s)
+ { m_codeGen.startFontClass(s); }
+ void endFontClass()
+ { m_codeGen.endFontClass(); }
+ void writeCodeAnchor(const char *anchor)
+ { m_codeGen.writeCodeAnchor(anchor); }
+ // ---------------------------
+
+ void writeDoc(DocNode *,Definition *ctx,MemberDef *md);
+
+ ///////////////////////////////////////////////////////////////
+ // structural output interface
+ ///////////////////////////////////////////////////////////////
+ void startFile(const char *name,const char *manName,
+ const char *title);
+ void writeSearchInfo(){DB_GEN_EMPTY};
+ void writeFooter(const char *navPath){DB_GEN_NEW};
+ void endFile();
+ void startIndexSection(IndexSections);
+ void endIndexSection(IndexSections);
+ void writePageLink(const char *,bool);
+ void startProjectNumber(){DB_GEN_NEW};
+ void endProjectNumber(){DB_GEN_NEW};
+ void writeStyleInfo(int part){DB_GEN_EMPTY};
+ void startTitleHead(const char *);
+ void endTitleHead(const char *fileName,const char *name);
+ void startIndexListItem(){DB_GEN_NEW};
+ void endIndexListItem(){DB_GEN_NEW};
+ void startIndexList(){DB_GEN_NEW};
+ void endIndexList(){DB_GEN_NEW};
+ void startIndexKey(){DB_GEN_NEW};
+ void endIndexKey(){DB_GEN_NEW};
+ void startIndexValue(bool){DB_GEN_NEW};
+ void endIndexValue(const char *,bool){DB_GEN_NEW};
+ void startItemList() {DB_GEN_EMPTY};
+ void endItemList() {DB_GEN_EMPTY};
+
+ void startIndexItem(const char *ref,const char *file){DB_GEN_NEW};
+ void endIndexItem(const char *ref,const char *file){DB_GEN_NEW};
+ void startItemListItem() {DB_GEN_EMPTY};
+ void endItemListItem() {DB_GEN_EMPTY};
+ void docify(const char *text);
+ void writeChar(char);
+ void writeString(const char *);
+ void startParagraph(const char *);
+ void endParagraph(void);
+ void writeObjectLink(const char *,const char *,const char *,const char *);
+ void startHtmlLink(const char *){DB_GEN_NEW};
+ void endHtmlLink(void){DB_GEN_NEW};
+ void startBold(void);
+ void endBold(void);
+ void startTypewriter(void);
+ void endTypewriter(void);
+ void startEmphasis(void){DB_GEN_NEW};
+ void endEmphasis(void){DB_GEN_NEW};
+ void startCodeFragment(void);
+ void endCodeFragment(void);
+ void writeRuler(void);
+ void startDescription(void){DB_GEN_NEW};
+ void endDescription(void){DB_GEN_NEW};
+ void startDescItem(void){DB_GEN_NEW};
+ void startDescForItem(void){DB_GEN_EMPTY};
+ void endDescForItem(void){DB_GEN_EMPTY};
+ void endDescItem(void){DB_GEN_NEW};
+ void startCenter(void){DB_GEN_NEW};
+ void endCenter(void){DB_GEN_NEW};
+ void startSmall(void){DB_GEN_NEW};
+ void endSmall(void){DB_GEN_NEW};
+ void startExamples(void);
+ void endExamples(void);
+ void startParamList(BaseOutputDocInterface::ParamListTypes,const char *){DB_GEN_NEW};
+ void endParamList(void){DB_GEN_NEW};
+ void startTitle(void){DB_GEN_NEW};
+ void endTitle(void){DB_GEN_NEW};
+ void writeAnchor(const char *,const char *){DB_GEN_EMPTY};
+ void startSection(const char *,const char *,SectionInfo::SectionType);
+ void endSection(const char *,SectionInfo::SectionType);
+ void lineBreak(const char *);
+ void addIndexItem(const char *,const char *);
+ void writeNonBreakableSpace(int);
+ void startDescTable(const char *);
+ void endDescTable(void);
+ void startDescTableRow(void);
+ void endDescTableRow(void);
+ void startDescTableTitle(void);
+ void endDescTableTitle(void);
+ void startDescTableData(void);
+ void endDescTableData(void);
+ void startTextLink(const char *,const char *){DB_GEN_NEW};
+ void endTextLink(void){DB_GEN_NEW};
+ void startPageRef(void){DB_GEN_NEW};
+ void endPageRef(const char *,const char *){DB_GEN_NEW};
+ void startSubsection(void){DB_GEN_NEW};
+ void endSubsection(void){DB_GEN_NEW};
+ void startSubsubsection(void);
+ void endSubsubsection(void);
+
+
+ void startGroupHeader(int);
+ void endGroupHeader(int);
+ void startMemberSections(){DB_GEN_EMPTY};
+ void endMemberSections(){DB_GEN_EMPTY};
+ void startHeaderSection(){DB_GEN_EMPTY};
+ void endHeaderSection(){DB_GEN_EMPTY};
+ void startMemberHeader(const char *anchor, int typ);
+ void endMemberHeader();
+ void startMemberSubtitle(){DB_GEN_EMPTY};
+ void endMemberSubtitle(){DB_GEN_EMPTY};
+ void startMemberDocList();
+ void endMemberDocList();
+ void startMemberList();
+ void endMemberList();
+ void startInlineHeader(){DB_GEN_NEW};
+ void endInlineHeader(){DB_GEN_NEW};
+ void startAnonTypeScope(int){DB_GEN_EMPTY};
+ void endAnonTypeScope(int){DB_GEN_EMPTY};
+ void startMemberItem(const char *,int,const char *);
+ void endMemberItem();
+ void startMemberTemplateParams();
+ void endMemberTemplateParams(const char *,const char *);
+ void startMemberGroupHeader(bool);
+ void endMemberGroupHeader();
+ void startMemberGroupDocs(){DB_GEN_EMPTY};
+ void endMemberGroupDocs(){DB_GEN_EMPTY};
+ void startMemberGroup();
+ void endMemberGroup(bool);
+ void insertMemberAlign(bool){DB_GEN_EMPTY};
+ void insertMemberAlignLeft(int,bool){DB_GEN_EMPTY};
+ void startMemberDoc(const char *,const char *,
+ const char *,const char *,int,int,bool);
+ void endMemberDoc(bool);
+ void startDoxyAnchor(const char *fName,const char *manName,
+ const char *anchor,const char *name,
+ const char *args);
+ void endDoxyAnchor(const char *fileName,const char *anchor);
+ void writeLatexSpacing(){DB_GEN_EMPTY}
+ void writeStartAnnoItem(const char *type,const char *file,
+ const char *path,const char *name){DB_GEN_NEW};
+ void writeEndAnnoItem(const char *name){DB_GEN_NEW};
+ void startMemberDescription(const char *anchor,const char *inheritId, bool typ){DB_GEN_EMPTY};
+ void endMemberDescription(){DB_GEN_EMPTY};
+ void startMemberDeclaration(){DB_GEN_EMPTY};
+ void endMemberDeclaration(const char *anchor,const char *inheritId){DB_GEN_EMPTY};
+ void writeInheritedSectionTitle(const char *id,const char *ref,
+ const char *file,const char *anchor,
+ const char *title,const char *name){DB_GEN_NEW};
+ void startIndent(){DB_GEN_EMPTY};
+ void endIndent(){DB_GEN_EMPTY};
+ void writeSynopsis(){DB_GEN_EMPTY};
+ void startClassDiagram();
+ void endClassDiagram(const ClassDiagram &,const char *,const char *);
+ void startDotGraph();
+ void endDotGraph(const DotClassGraph &g);
+ void startInclDepGraph();
+ void endInclDepGraph(const DotInclDepGraph &g);
+ void startGroupCollaboration();
+ void endGroupCollaboration(const DotGroupCollaboration &g);
+ void startCallGraph();
+ void endCallGraph(const DotCallGraph &g);
+ void startDirDepGraph();
+ void endDirDepGraph(const DotDirDeps &g);
+ void writeGraphicalHierarchy(const DotGfxHierarchyTable &g){DB_GEN_NEW};
+ void startQuickIndices(){DB_GEN_EMPTY};
+ void endQuickIndices(){DB_GEN_EMPTY};
+ void writeSplitBar(const char *){DB_GEN_EMPTY};
+ void writeNavigationPath(const char *){DB_GEN_NEW};
+ void writeLogo(){DB_GEN_NEW};
+ void writeQuickLinks(bool compact,HighlightedItem hli,const char *file){DB_GEN_EMPTY};
+ void writeSummaryLink(const char *file,const char *anchor,const char *title,bool first){DB_GEN_EMPTY};
+ void startContents(){DB_GEN_EMPTY};
+ void endContents(){DB_GEN_EMPTY};
+ void startPageDoc(const char *pageTitle){DB_GEN_EMPTY}
+ void endPageDoc() {DB_GEN_EMPTY}
+ void startTextBlock(bool);
+ void endTextBlock(bool);
+ void lastIndexPage(){DB_GEN_EMPTY};
+ void startMemberDocPrefixItem();
+ void endMemberDocPrefixItem();
+ void startMemberDocName(bool);
+ void endMemberDocName();
+ void startParameterType(bool,const char *key){DB_GEN_EMPTY};
+ void endParameterType(){DB_GEN_EMPTY};
+ void startParameterName(bool);
+ void endParameterName(bool,bool,bool);
+ void startParameterList(bool);
+ void endParameterList();
+ void exceptionEntry(const char*,bool);
+
+ void startConstraintList(const char *);
+ void startConstraintParam();
+ void endConstraintParam();
+ void startConstraintType();
+ void endConstraintType();
+ void startConstraintDocs();
+ void endConstraintDocs();
+ void endConstraintList();
+
+ void startMemberDocSimple(bool){DB_GEN_NEW};
+ void endMemberDocSimple(bool){DB_GEN_NEW};
+ void startInlineMemberType(){DB_GEN_NEW};
+ void endInlineMemberType(){DB_GEN_NEW};
+ void startInlineMemberName(){DB_GEN_NEW};
+ void endInlineMemberName(){DB_GEN_NEW};
+ void startInlineMemberDoc(){DB_GEN_NEW};
+ void endInlineMemberDoc(){DB_GEN_NEW};
+
+ void startLabels();
+ void writeLabel(const char *,bool);
+ void endLabels();
+
+ void setCurrentDoc(Definition *,const char *,bool) {DB_GEN_EMPTY}
+ void addWord(const char *,bool) {DB_GEN_EMPTY}
+
+private:
+ DocbookGenerator(const DocbookGenerator &o);
+ DocbookGenerator &operator=(const DocbookGenerator &o);
+
+ QCString relPath;
+ DocbookCodeGenerator m_codeGen;
+ bool m_prettyCode = FALSE;
+ bool m_denseText = FALSE;
+ bool m_inGroup = FALSE;
+ bool m_inDetail = FALSE;
+ int m_levelListItem = 0;
+ bool m_inListItem[20];
+ bool m_inSimpleSect[20];
+ bool m_descTable = FALSE;
+ int m_inLevel = -1;
+ bool m_firstMember = FALSE;
+};
#endif