autodoc/source/display/html/pagemake.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: pagemake.hxx,v $
  10  * $Revision: 1.4 $
  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_PAGEMAKE_HXX
  32 #define ADC_DISPLAY_HTML_PAGEMAKE_HXX
  33
  34
  35
  36 // USED SERVICES
  37     // BASE CLASSES
  38 #include <ary/ary_disp.hxx>
  39 #include <cosv/tpl/processor.hxx>
  40 #include "hdimpl.hxx"
  41     // COMPONENTS
  42     // PARAMETERS
  43 #include <ary/cpp/c_namesp.hxx>
  44
  45 namespace ary
  46 {
  47     namespace cpp
  48     {
  49         class Namespace;
  50         class Class;
  51         class Enum;
  52         class Typedef;
  53     }
  54     namespace loc
  55     {
  56         class File;
  57     }
  58 }
  59
  60
  61 class OuputPage_Environment;
  62 class HtmlDocuFile;
  63
  64
  65
  66 class PageDisplay : public ary::Display,
  67                     public csv::ConstProcessor<ary::cpp::Class>,
  68                     public csv::ConstProcessor<ary::cpp::Enum>,
  69                     public csv::ConstProcessor<ary::cpp::Typedef>,
  70                     public HtmlDisplay_Impl
  71 {
  72   public:
  73                         PageDisplay(
  74                             OuputPage_Environment &
  75                                                 io_rEnv );
  76     virtual                             ~PageDisplay();
  77
  78     void                Create_OverviewFile();
  79     void                Create_AllDefsFile();
  80     void                Create_IndexFiles();
  81     void                Create_HelpFile();
  82
  83     void                Create_NamespaceFile();
  84
  85     void                Setup_OperationsFile_for(
  86                             const ary::loc::File &
  87                                                 i_rFile );
  88     void                Setup_OperationsFile_for(
  89                             const ary::cpp::Class &
  90                                                 i_rClass );
  91     void                Setup_DataFile_for(
  92                             const ary::loc::File &
  93                                                 i_rFile );
  94     void                Setup_DataFile_for(
  95                             const ary::cpp::Class &
  96                                                 i_rClass );
  97     /// Used with Setup_OperatonsFile_for().
  98     void                Create_File();
  99
 100
 101     // Interface for Children of SpecializedPageMaker:
 102     void                Write_NameChainWithLinks(
 103                             const ary::cpp::CodeEntity &
 104                                                 i_rCe );
 105
 106     // Necessary, to call Process() on this class.
 107     using csv::ConstProcessor<ary::cpp::Class>::Process;
 108     using csv::ConstProcessor<ary::cpp::Enum>::Process;
 109     using csv::ConstProcessor<ary::cpp::Typedef>::Process;
 110
 111  private:
 112     // Interface csv::ConstProcessor<>:
 113     virtual void                do_Process(
 114                             const ary::cpp::Class &
 115                                                 i_rData );
 116     virtual void                do_Process(
 117                             const ary::cpp::Enum &
 118                                                 i_rData );
 119     virtual void                do_Process(
 120                             const ary::cpp::Typedef &
 121                                                 i_rData );
 122     // Interface ary::cpp::Display:
 123     virtual const ary::cpp::Gate *
 124                         inq_Get_ReFinder() const;
 125     // Locals
 126     HtmlDocuFile &      File()                  { return *pMyFile; }
 127     void                RecursiveWrite_NamespaceLink(
 128                             const ary::cpp::Namespace *
 129                                                 i_pNamespace );
 130     void                RecursiveWrite_ClassLink(
 131                             const ary::cpp::Class *
 132                                                 i_pClass,
 133                             uintt               i_nLevelDistance );
 134     void                SetupFileOnCurEnv(
 135                             const char *        i_sTitle );
 136     void                Write_NavBar_Enum(
 137                             const ary::cpp::Enum &
 138                                                 i_rData );
 139     void                Write_TopArea_Enum(
 140                             const ary::cpp::Enum &
 141                                                 i_rData );
 142     void                Write_DocuArea_Enum(
 143                             const ary::cpp::Enum &
 144                                                 i_rData );
 145     void                Write_ChildList_Enum(
 146                             const ary::cpp::Enum &
 147                                                 i_rData );
 148     void                Write_NavBar_Typedef(
 149                             const ary::cpp::Typedef &
 150                                                 i_rData );
 151     void                Write_TopArea_Typedef(
 152                             const ary::cpp::Typedef &
 153                                                 i_rData );
 154     void                Write_DocuArea_Typedef(
 155                             const ary::cpp::Typedef &
 156                                                 i_rData );
 157     void                Create_IndexFile(
 158                             int                 i_nLetter );
 159
 160     // DATA
 161     Dyn<HtmlDocuFile>   pMyFile;
 162 };
 163
 164
 165
 166
 167 #endif