1 /**************************************************************
2  *
3  * Licensed to the Apache Software Foundation (ASF) under one
4  * or more contributor license agreements.  See the NOTICE file
5  * distributed with this work for additional information
6  * regarding copyright ownership.  The ASF licenses this file
7  * to you under the Apache License, Version 2.0 (the
8  * "License"); you may not use this file except in compliance
9  * with the License.  You may obtain a copy of the License at
10  *
11  *   http://www.apache.org/licenses/LICENSE-2.0
12  *
13  * Unless required by applicable law or agreed to in writing,
14  * software distributed under the License is distributed on an
15  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16  * KIND, either express or implied.  See the License for the
17  * specific language governing permissions and limitations
18  * under the License.
19  *
20  *************************************************************/
21 
22 
23 
24 #ifndef ADC_DISPLAY_HI_DISPLAY_HXX
25 #define ADC_DISPLAY_HI_DISPLAY_HXX
26 
27 
28 
29 // USED SERVICES
30     // BASE CLASSES
31 #include <autodoc/dsp_html_std.hxx>
32     // COMPONENTS
33 #include <cosv/ploc.hxx>
34     // PARAMETERS
35 
36 
37 
38 namespace ary
39 {
40     namespace idl
41     {
42         class Module;
43         class CodeEntity;
44     }   // namspace idl
45 }   // namspace csi
46 
47 
48 class MainDisplay_Idl;
49 class HtmlEnvironment_Idl;
50 
51 class HtmlDisplay_Idl : public autodoc::HtmlDisplay_Idl_Ifc
52 {
53   public:
54                         HtmlDisplay_Idl();
55                         ~HtmlDisplay_Idl();
56   private:
57     // Interface HtmlDisplay_Idl_Ifc:
58     virtual void        do_Run(
59                             const char *        i_sOutputDirectory,
60                             const ary::idl::Gate &
61                                                 i_rAryGate,
62                             const display::CorporateFrame &
63                                                 i_rLayout );
64     void                SetRunData(
65                             const char *        i_sOutputDirectory,
66                             const ary::idl::Gate &
67                                                 i_rAryGate,
68                             const display::CorporateFrame &
69                                                 i_rLayout );
70     void                Create_StartFile();
71     void                Create_FilesInNameTree();
72     void                Create_IndexFiles();
73     void                Create_FilesInProjectTree();
74     void                Create_PackageList();
75     void                Create_HelpFile();
76     void                Create_CssFile();
77 
78     /** @descr
79         - makes sure, the module's directory exists
80         - creates the module's docu file
81         - creates docu files for all members of the module
82         - does the same recursive for all sub-modules.
83     */
84     void                RecursiveDisplay_Module(
85                             const ary::idl::Module &
86                                                 i_rNamespace );
87     bool                IsModule(
88                             const ary::idl::CodeEntity &
89                                                 i_ce ) const;
90     const ary::idl::Module &
91                         Module_Cast(            /// @precond Cast must be valid.
92                             const ary::idl::CodeEntity &
93                                                 i_ce ) const;
94     // DATA
95     Dyn<HtmlEnvironment_Idl>
96                         pCurPageEnv;
97     Dyn<MainDisplay_Idl>
98                         pMainDisplay;
99 };
100 
101 
102 
103 // IMPLEMENTATION
104 
105 
106 #endif
107 
108