diff -r 000000000000 -r 42188c7ea2d9 Orb/Doxygen/src/mangen.h --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/Orb/Doxygen/src/mangen.h Thu Jan 21 17:29:01 2010 +0000 @@ -0,0 +1,245 @@ +/****************************************************************************** + * + * + * + * Copyright (C) 1997-2008 by Dimitri van Heesch. + * + * Permission to use, copy, modify, and distribute this software and its + * documentation under the terms of the GNU General Public License is hereby + * granted. No representations are made about the suitability of this software + * for any purpose. It is provided "as is" without express or implied warranty. + * See the GNU General Public License for more details. + * + * Documents produced by Doxygen are derivative works derived from the + * input used in their production; they are not affected by this license. + * + */ + +#ifndef MANGEN_H +#define MANGEN_H + +#include "outputgen.h" + +class QFile; + +class ManGenerator : public OutputGenerator +{ + public: + ManGenerator(); + ~ManGenerator(); + + //OutputGenerator *copy() { return new ManGenerator; } + //OutputGenerator *clone() { return new ManGenerator(*this); } + //void append(const OutputGenerator *o); + void enable() + { if (genStack->top()) active=*genStack->top(); else active=TRUE; } + void disable() { active=FALSE; } + void enableIf(OutputType o) { if (o==Man) active=TRUE; } + void disableIf(OutputType o) { if (o==Man) active=FALSE; } + void disableIfNot(OutputType o) { if (o!=Man) active=FALSE; } + bool isEnabled(OutputType o) { return (o==Man && active); } + OutputGenerator *get(OutputType o) { return (o==Man) ? this : 0; } + + void printDoc(DocNode *,const char *); + + static void init(); + void startFile(const char *name,const char *manName,const char *title); + void writeFooter() {} + void endFile(); + void clearBuffer(); + + void startIndexSection(IndexSections) {} + void endIndexSection(IndexSections) {} + void writePageLink(const char *,bool) {} + void startProjectNumber() {} + void endProjectNumber() {} + void writeStyleInfo(int) {} + void startTitleHead(const char *) {} + void endTitleHead(const char *,const char *); + void startTitle(); + void endTitle(); + + void newParagraph(); + void startParagraph(); + void endParagraph(); + void writeString(const char *text); + void startIndexListItem() {} + void endIndexListItem() {} + void startIndexList() {} + void endIndexList() { newParagraph(); } + void startIndexKey() {} + void endIndexKey() {} + void startIndexValue(bool) {} + void endIndexValue(const char *,bool) {} + void startItemList() {} + void endItemList() { newParagraph(); } + void startIndexItem(const char *ref,const char *file); + void endIndexItem(const char *ref,const char *file); + void docify(const char *text); + void codify(const char *text); + void writeObjectLink(const char *ref,const char *file, + const char *anchor,const char *name); + void writeCodeLink(const char *ref,const char *file, + const char *anchor,const char *name, + const char *tooltip); + void startTextLink(const char *,const char *) {} + void endTextLink() {} + void startHtmlLink(const char *url); + void endHtmlLink(); + void startTypewriter() { t << "\\fC"; firstCol=FALSE; } + void endTypewriter() { t << "\\fP"; firstCol=FALSE; } + void startGroupHeader(); + void endGroupHeader(); + void startMemberSections() {} + void endMemberSections() {} + void startMemberHeader(); + void endMemberHeader(); + void insertMemberAlign(bool) {} + void startMemberSubtitle() {} + void endMemberSubtitle() {} + //void writeListItem(); + void startItemListItem(); + void endItemListItem(); + void startMemberDocList() {} + void endMemberDocList() {} + void startMemberList(); + void endMemberList(); + void startAnonTypeScope(int); + void endAnonTypeScope(int); + void startMemberItem(int); + void endMemberItem(); + void startMemberTemplateParams() {} + void endMemberTemplateParams() {} + + void startMemberGroupHeader(bool); + void endMemberGroupHeader(); + void startMemberGroupDocs(); + void endMemberGroupDocs(); + void startMemberGroup(); + void endMemberGroup(bool); + + void writeRuler() {} + void writeAnchor(const char *,const char *) {} + void startCodeFragment(); + void endCodeFragment(); + void writeLineNumber(const char *,const char *,const char *,int l) { t << l << " "; } + void startCodeLine() {} + void endCodeLine() { codify("\n"); col=0; } + void startEmphasis() { t << "\\fI"; firstCol=FALSE; } + void endEmphasis() { t << "\\fP"; firstCol=FALSE; } + void startBold() { t << "\\fB"; firstCol=FALSE; } + void endBold() { t << "\\fP"; firstCol=FALSE; } + void startDescription() {} + void endDescription() {} + void startDescItem(); + void endDescItem(); + void lineBreak(const char *) { t << "\n.br" << endl; } + void writeChar(char c); + void startMemberDoc(const char *,const char *,const char *,const char *); + void endMemberDoc(bool); + void startDoxyAnchor(const char *,const char *,const char *,const char *,const char *); + void endDoxyAnchor(const char *,const char *) {} + void startCodeAnchor(const char *) {} + void endCodeAnchor() {} + void writeLatexSpacing() {} + void writeStartAnnoItem(const char *type,const char *file, + const char *path,const char *name); + void writeEndAnnoItem(const char *) { t << endl; firstCol=TRUE; } + void startSubsection(); + void endSubsection(); + void startSubsubsection(); + void endSubsubsection(); + void startCenter() {} + void endCenter() {} + void startSmall() {} + void endSmall() {} + void startMemberDescription() { t << "\n.RI \"\\fI"; firstCol=FALSE; } + void endMemberDescription() { t << "\\fP\""; firstCol=FALSE; } + void startDescList(SectionTypes); + void endDescList() {} + void startSimpleSect(SectionTypes,const char *,const char *,const char *); + void endSimpleSect(); + void startParamList(ParamListTypes,const char *title); + void endParamList(); + //void writeDescItem(); + void startDescForItem(); + void endDescForItem(); + void startSection(const char *,const char *,SectionInfo::SectionType); + void endSection(const char *,SectionInfo::SectionType); + void addIndexItem(const char *,const char *) {} + void startIndent() {} + void endIndent() {} + void writeSynopsis(); + void startClassDiagram() {} + void endClassDiagram(const ClassDiagram &,const char *,const char *) {} + void startPageRef() {} + void endPageRef(const char *,const char *) {} + void startQuickIndices() {} + void endQuickIndices() {} + void writeQuickLinks(bool,HighlightedItem) {} + void startContents() {} + void endContents() {} + void writeNonBreakableSpace(int n) { int i; for (i=0;i