autodoc/source/display/idl/hi_main.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef ADC_DISPLAY_HFIDMAIN_HXX
  21 #define ADC_DISPLAY_HFIDMAIN_HXX
  22
  23
  24
  25 // USED SERVICES
  26     // BASE CLASSES
  27 #include <cosv/tpl/processor.hxx>
  28     // COMPONENTS
  29 #include "hi_factory.hxx"
  30     // PARAMETERS
  31
  32
  33 class HtmlEnvironment_Idl;
  34 class HtmlFactory_Idl;
  35 class DocuFile_Html;
  36
  37 namespace ary
  38 {
  39 namespace idl
  40 {
  41
  42     class Module;
  43     class Service;
  44     class SglIfcService;
  45     class Interface;
  46     class Struct;
  47     class Exception;
  48     class Enum;
  49     class Typedef;
  50     class ConstantsGroup;
  51     class Singleton;
  52     class SglIfcSingleton;
  53
  54 }   // namespace idl
  55 }   // namespace ary
  56
  57
  58 class MainDisplay_Idl : public csv::ProcessorIfc,
  59                         public csv::ConstProcessor<ary::idl::Module>,
  60                         public csv::ConstProcessor<ary::idl::Service>,
  61                         public csv::ConstProcessor<ary::idl::SglIfcService>,
  62                         public csv::ConstProcessor<ary::idl::Interface>,
  63                         public csv::ConstProcessor<ary::idl::Struct>,
  64                         public csv::ConstProcessor<ary::idl::Exception>,
  65                         public csv::ConstProcessor<ary::idl::Enum>,
  66                         public csv::ConstProcessor<ary::idl::Typedef>,
  67                         public csv::ConstProcessor<ary::idl::ConstantsGroup>,
  68                         public csv::ConstProcessor<ary::idl::Singleton>,
  69                         public csv::ConstProcessor<ary::idl::SglIfcSingleton>
  70 {
  71   public:
  72                         MainDisplay_Idl(
  73                             HtmlEnvironment_Idl &
  74                                                 io_rEnv );
  75     virtual             ~MainDisplay_Idl();
  76
  77     void                WriteGlobalIndices();
  78
  79     void                Display_NamedEntityHierarchy();
  80
  81   private:
  82     // Interface csv::ProcessorIfc:
  83     virtual void        do_Process(
  84                             const ary::idl::Module  &     i_client );
  85     virtual void        do_Process(
  86                             const ary::idl::Service &     i_client );
  87     virtual void        do_Process(
  88                             const ary::idl::SglIfcService &
  89                                                           i_client );
  90     virtual void        do_Process(
  91                             const ary::idl::Interface &   i_client );
  92     virtual void        do_Process(
  93                             const ary::idl::Struct  &     i_client );
  94     virtual void        do_Process(
  95                             const ary::idl::Exception &   i_client );
  96     virtual void        do_Process(
  97                             const ary::idl::Enum &        i_client );
  98     virtual void        do_Process(
  99                             const ary::idl::Typedef &     i_client );
 100     virtual void        do_Process(
 101                             const ary::idl::ConstantsGroup &
 102                                                 i_client );
 103     virtual void        do_Process(
 104                             const ary::idl::Singleton &   i_client );
 105     virtual void        do_Process(
 106                             const ary::idl::SglIfcSingleton &
 107                                                 i_client );
 108     // Locals
 109     void                do_ServiceDescr(
 110                             const ary::idl::CodeEntity &
 111                                                 i_rData );
 112     void                do_SglIfcServiceDescr(
 113                             const ary::idl::CodeEntity &
 114                                                 i_rData );
 115     void                do_InterfaceDescr(
 116                             const ary::idl::CodeEntity &
 117                                                 i_rData );
 118     void                do_StructDescr(
 119                             const ary::idl::CodeEntity &
 120                                                 i_rData );
 121     void                do_ExceptionDescr(
 122                             const ary::idl::CodeEntity &
 123                                                 i_rData );
 124     void                do_EnumDescr(
 125                             const ary::idl::CodeEntity &
 126                                                 i_rData );
 127     void                do_TypedefDescr(
 128                             const ary::idl::CodeEntity &
 129                                                 i_rData );
 130     void                do_SingletonDescr(
 131                             const ary::idl::CodeEntity &
 132                                                 i_rData );
 133     void                do_Service2s(
 134                             const ary::idl::CodeEntity &
 135                                                 i_rData );
 136     void                do_Interface2s(
 137                             const ary::idl::CodeEntity &
 138                                                 i_rData );
 139     void                do_Struct2s(
 140                             const ary::idl::CodeEntity &
 141                                                 i_rData );
 142     void                do_Exception2s(
 143                             const ary::idl::CodeEntity &
 144                                                 i_rData );
 145     void                do_Enum2s(
 146                             const ary::idl::CodeEntity &
 147                                                 i_rData );
 148     void                do_Typedef2s(
 149                             const ary::idl::CodeEntity &
 150                                                 i_rData );
 151     void                do_Singleton2s(
 152                             const ary::idl::CodeEntity &
 153                                                 i_rData );
 154
 155     const HtmlEnvironment_Idl &
 156                         Env() const             { return *pEnv; }
 157     HtmlEnvironment_Idl &
 158                         Env()                   { return *pEnv; }
 159     Xml::Element &      CurHtmlOut()            { return pCurFactory->CurOut(); }
 160
 161     // DATA
 162     HtmlEnvironment_Idl *
 163                         pEnv;
 164     Dyn<DocuFile_Html>  pMyFile;
 165     HtmlFactory_Idl *   pCurFactory;
 166 };
 167
 168
 169
 170 #endif
 171
 172 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */