src/rtfdocvisitor.h

   1 /******************************************************************************
   2  *
   3  * $Id: $
   4  *
   5  *
   6  * Copyright (C) 1997-2012 by Dimitri van Heesch.
   7  *
   8  * Permission to use, copy, modify, and distribute this software and its
   9  * documentation under the terms of the GNU General Public License is hereby
  10  * granted. No representations are made about the suitability of this software
  11  * for any purpose. It is provided "as is" without express or implied warranty.
  12  * See the GNU General Public License for more details.
  13  *
  14  * Documents produced by Doxygen are derivative works derived from the
  15  * input used in their production; they are not affected by this license.
  16  *
  17  */
  18
  19 #ifndef _RTFDOCVISITOR_H
  20 #define _RTFDOCVISITOR_H
  21
  22 #include "docvisitor.h"
  23 #include <qstack.h>
  24 #include <qcstring.h>
  25
  26 class FTextStream;
  27 class CodeOutputInterface;
  28
  29 /*! @brief Concrete visitor implementation for RTF output. */
  30 class RTFDocVisitor : public DocVisitor
  31 {
  32   public:
  33     RTFDocVisitor(FTextStream &t,CodeOutputInterface &ci,const char *langExt);
  34
  35     //--------------------------------------
  36     // visitor functions for leaf nodes
  37     //--------------------------------------
  38
  39     void visit(DocWord *);
  40     void visit(DocLinkedWord *);
  41     void visit(DocWhiteSpace *);
  42     void visit(DocSymbol *);
  43     void visit(DocURL *);
  44     void visit(DocLineBreak *);
  45     void visit(DocHorRuler *);
  46     void visit(DocStyleChange *);
  47     void visit(DocVerbatim *);
  48     void visit(DocAnchor *);
  49     void visit(DocInclude *);
  50     void visit(DocIncOperator *);
  51     void visit(DocFormula *);
  52     void visit(DocIndexEntry *);
  53     void visit(DocSimpleSectSep *);
  54     void visit(DocCite *);
  55
  56     //--------------------------------------
  57     // visitor functions for compound nodes
  58     //--------------------------------------
  59
  60     void visitPre(DocAutoList *);
  61     void visitPost(DocAutoList *);
  62     void visitPre(DocAutoListItem *);
  63     void visitPost(DocAutoListItem *);
  64     void visitPre(DocPara *);
  65     void visitPost(DocPara *);
  66     void visitPre(DocRoot *);
  67     void visitPost(DocRoot *);
  68     void visitPre(DocSimpleSect *);
  69     void visitPost(DocSimpleSect *);
  70     void visitPre(DocTitle *);
  71     void visitPost(DocTitle *);
  72     void visitPre(DocSimpleList *);
  73     void visitPost(DocSimpleList *);
  74     void visitPre(DocSimpleListItem *);
  75     void visitPost(DocSimpleListItem *);
  76     void visitPre(DocSection *s);
  77     void visitPost(DocSection *);
  78     void visitPre(DocHtmlList *s);
  79     void visitPost(DocHtmlList *s);
  80     void visitPre(DocHtmlListItem *);
  81     void visitPost(DocHtmlListItem *);
  82     //void visitPre(DocHtmlPre *);
  83     //void visitPost(DocHtmlPre *);
  84     void visitPre(DocHtmlDescList *);
  85     void visitPost(DocHtmlDescList *);
  86     void visitPre(DocHtmlDescTitle *);
  87     void visitPost(DocHtmlDescTitle *);
  88     void visitPre(DocHtmlDescData *);
  89     void visitPost(DocHtmlDescData *);
  90     void visitPre(DocHtmlTable *t);
  91     void visitPost(DocHtmlTable *t);
  92     void visitPre(DocHtmlCaption *);
  93     void visitPost(DocHtmlCaption *);
  94     void visitPre(DocHtmlRow *);
  95     void visitPost(DocHtmlRow *) ;
  96     void visitPre(DocHtmlCell *);
  97     void visitPost(DocHtmlCell *);
  98     void visitPre(DocInternal *);
  99     void visitPost(DocInternal *);
 100     void visitPre(DocHRef *);
 101     void visitPost(DocHRef *);
 102     void visitPre(DocHtmlHeader *);
 103     void visitPost(DocHtmlHeader *) ;
 104     void visitPre(DocImage *);
 105     void visitPost(DocImage *);
 106     void visitPre(DocDotFile *);
 107     void visitPost(DocDotFile *);
 108     void visitPre(DocMscFile *);
 109     void visitPost(DocMscFile *);
 110     void visitPre(DocLink *);
 111     void visitPost(DocLink *);
 112     void visitPre(DocRef *ref);
 113     void visitPost(DocRef *);
 114     void visitPre(DocSecRefItem *);
 115     void visitPost(DocSecRefItem *);
 116     void visitPre(DocSecRefList *);
 117     void visitPost(DocSecRefList *);
 118     void visitPre(DocParamSect *);
 119     void visitPost(DocParamSect *);
 120     void visitPre(DocParamList *);
 121     void visitPost(DocParamList *);
 122     void visitPre(DocXRefItem *);
 123     void visitPost(DocXRefItem *);
 124     void visitPre(DocInternalRef *);
 125     void visitPost(DocInternalRef *);
 126     void visitPre(DocCopy *);
 127     void visitPost(DocCopy *);
 128     void visitPre(DocText *);
 129     void visitPost(DocText *);
 130     void visitPre(DocHtmlBlockQuote *);
 131     void visitPost(DocHtmlBlockQuote *);
 132
 133   private:
 134
 135     //--------------------------------------
 136     // helper functions
 137     //--------------------------------------
 138
 139     void filter(const char *str,bool verbatim=FALSE);
 140     void startLink(const QCString &ref,const QCString &file,
 141                    const QCString &anchor);
 142     void endLink(const QCString &ref);
 143     QCString getStyle(const char *name);
 144     void incIndentLevel();
 145     void decIndentLevel();
 146
 147     void pushEnabled();
 148     void popEnabled();
 149     void writeDotFile(const QCString &fileName);
 150     void writeMscFile(const QCString &fileName);
 151
 152     //--------------------------------------
 153     // state variables
 154     //--------------------------------------
 155
 156     FTextStream &m_t;
 157     CodeOutputInterface &m_ci;
 158     bool m_insidePre;
 159     bool m_hide;
 160     int m_indentLevel;
 161     QStack<bool> m_enabled;
 162     bool m_lastIsPara;
 163     QCString m_langExt;
 164 };
 165
 166 #endif