autodoc/source/display/html/hd_docu.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: hd_docu.hxx,v $
  10  * $Revision: 1.5 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef ADC_DISPLAY_HTML_HD_DOCU_HXX
  32 #define ADC_DISPLAY_HTML_HD_DOCU_HXX
  33
  34 // BASE CLASSES
  35 #include <ary/ary_disp.hxx>
  36 #include <ary/info/infodisp.hxx>
  37 #include <cosv/tpl/processor.hxx>
  38 #include "hdimpl.hxx"
  39
  40 namespace ary
  41 {
  42     namespace cpp
  43     {
  44         class Namespace;
  45         class Class;
  46         class Enum;
  47         class Typedef;
  48         class Function;
  49         class Variable;
  50     }
  51
  52     namespace doc
  53     {
  54          class Documentation;
  55     }
  56     namespace info
  57     {
  58         class DocuText;
  59     }
  60
  61     class QualifiedName;
  62 }
  63
  64 class OuputPage_Environment;
  65
  66
  67 class Docu_Display : public ary::Display,
  68                      public csv::ConstProcessor<ary::cpp::Namespace>,
  69                      public csv::ConstProcessor<ary::cpp::Class>,
  70                      public csv::ConstProcessor<ary::cpp::Enum>,
  71                      public csv::ConstProcessor<ary::cpp::Typedef>,
  72                      public csv::ConstProcessor<ary::cpp::Function>,
  73                      public csv::ConstProcessor<ary::cpp::Variable>,
  74                      public csv::ConstProcessor<ary::doc::Documentation>,
  75                      public ary::info::DocuDisplay,
  76                      private HtmlDisplay_Impl
  77 {
  78   public:
  79                         Docu_Display(
  80                             OuputPage_Environment &
  81                                                 io_rEnv );
  82     virtual                             ~Docu_Display();
  83
  84     void                Assign_Out(
  85                             csi::xml::Element & o_rOut );
  86     void                Unassign_Out();
  87
  88     virtual void        Display_StdTag(
  89                             const ary::info::StdTag &
  90                                                 i_rData );
  91     virtual void        Display_BaseTag(
  92                             const ary::info::BaseTag &
  93                                                 i_rData );
  94     virtual void        Display_ExceptionTag(
  95                             const ary::info::ExceptionTag &
  96                                                 i_rData );
  97     virtual void        Display_ImplementsTag(
  98                             const ary::info::ImplementsTag &
  99                                                 i_rData );
 100     virtual void        Display_KeywordTag(
 101                             const ary::info::KeywordTag &
 102                                                 i_rData );
 103     virtual void        Display_ParameterTag(
 104                             const ary::info::ParameterTag &
 105                                                 i_rData );
 106     virtual void        Display_SeeTag(
 107                             const ary::info::SeeTag &
 108                                                 i_rData );
 109     virtual void        Display_TemplateTag(
 110                             const ary::info::TemplateTag &
 111                                                 i_rData );
 112     virtual void        Display_LabelTag(
 113                             const ary::info::LabelTag &
 114                                                 i_rData );
 115     virtual void        Display_SinceTag(
 116                             const ary::info::SinceTag &
 117                                                 i_rData );
 118
 119     virtual void        Display_DT_Text(
 120                             const ary::info::DT_Text &
 121                                                 i_rData );
 122     virtual void        Display_DT_MaybeLink(
 123                             const ary::info::DT_MaybeLink &
 124                                                 i_rData );
 125     virtual void        Display_DT_Whitespace(
 126                             const ary::info::DT_Whitespace &
 127                                                 i_rData );
 128     virtual void        Display_DT_Eol(
 129                             const ary::info::DT_Eol &
 130                                                 i_rData );
 131     virtual void        Display_DT_Xml(
 132                             const ary::info::DT_Xml &
 133                                                 i_rData );
 134
 135     using csv::ConstProcessor<ary::doc::Documentation>::Process;
 136
 137   private:
 138     // Interface csv::ConstProcessor<>:
 139     virtual void                do_Process(
 140                             const ary::cpp::Namespace &
 141                                                 i_rData );
 142     virtual void                do_Process(
 143                             const ary::cpp::Class &
 144                                                 i_rData );
 145     virtual void                do_Process(
 146                             const ary::cpp::Enum &
 147                                                 i_rData );
 148     virtual void                do_Process(
 149                             const ary::cpp::Typedef &
 150                                                 i_rData );
 151     virtual void                do_Process(
 152                             const ary::cpp::Function &
 153                                                 i_rData );
 154     virtual void                do_Process(
 155                             const ary::cpp::Variable &
 156                                                 i_rData );
 157     virtual void                do_Process(
 158                             const ary::doc::Documentation &
 159                                                 i_rData );
 160     // Interface ary::Display:
 161     virtual const ary::cpp::Gate *
 162                         inq_Get_ReFinder() const;
 163     // Locals
 164     void                Start_DocuBlock();
 165     void                Finish_DocuBlock();
 166
 167     void                Write_TagTitle(
 168                             const char *        i_sText,
 169                             const char *        i_nFontSize = "+0" );
 170     void                Write_TagContents(
 171                             const ary::info::DocuText &
 172                                                 i_rDocuText );
 173     void                Write_Text(
 174                             const ary::info::DocuText &
 175                                                 i_rDocuText );
 176     void                Write_TextToken(
 177                             const String  &     i_sText );
 178     void                Write_LinkableText(
 179                             const ary::QualifiedName &
 180                                                 i_sQuName );
 181     void                Write_QualifiedName(
 182                             const ary::QualifiedName &
 183                                                 i_sQuName );
 184
 185     // DATA
 186     bool                bUseHtmlInDocuTokens;
 187
 188     /** This is used, if a class documentation is displayed,
 189         because for links to members then the "current class"
 190         is not the parent, but this class itself.
 191     */
 192     const ary::cpp::Class *
 193                         pCurClassOverwrite;
 194 };
 195
 196
 197
 198
 199 #endif