1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
|
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#include <precomp.h>
#include "hfi_module.hxx"
// NOT FULLY DEFINED SERVICES
#include <ary/idl/i_ce.hxx>
#include <ary/idl/i_module.hxx>
#include <ary/idl/ik_module.hxx>
#include <ary/doc/d_oldidldocu.hxx>
#include <ary/getncast.hxx>
#include <toolkit/hf_docentry.hxx>
#include <toolkit/hf_linachain.hxx>
#include <toolkit/hf_navi_sub.hxx>
#include <toolkit/hf_title.hxx>
#include "hfi_doc.hxx"
#include "hfi_navibar.hxx"
#include "hfi_tag.hxx"
#include "hfi_typetext.hxx"
#include "hi_linkhelper.hxx"
extern const String
C_sCePrefix_Module("module");
namespace
{
const String
C_sList_NestedModules("Nested Modules");
const String
C_sList_NestedModules_Label("NestedModules");
const String
C_sList_Services("Services");
const String
C_sList_Singletons("Singletons");
const String
C_sList_Interfaces("Interfaces");
const String
C_sList_Structs("Structs");
const String
C_sList_Exceptions("Exceptions");
const String
C_sList_Enums("Enums");
const String
C_sList_Typedefs("Typedefs");
const String
C_sList_ConstGroups("Constant Groups");
const String
C_sList_ConstGroups_Label("ConstantGroups");
enum E_SubListIndices
{ // In case of changes, also adapt make_Navibar() !!
sli_NestedModules = 0,
sli_Services = 1,
sli_Singletons = 2,
sli_Interfaces = 3,
sli_Structs = 4,
sli_Exceptions = 5,
sli_Enums = 6,
sli_Typedefs = 7,
sli_ConstGroups = 8
};
} //anonymous namespace
HF_IdlModule::HF_IdlModule( Environment & io_rEnv,
Xml::Element & o_rOut )
: HtmlFactory_Idl(io_rEnv, &o_rOut)
{
}
HF_IdlModule::~HF_IdlModule()
{
}
typedef ary::idl::ifc_module::attr ModuleAttr;
void
HF_IdlModule::Produce_byData( const client & i_ce ) const
{
Dyn<HF_NaviSubRow>
pNaviSubRow( &make_Navibar(i_ce) );
HF_TitleTable
aTitle(CurOut());
HF_LinkedNameChain
aNameChain(aTitle.Add_Row());
if ( Env().CurPosition().Depth() > 0 )
{
aNameChain.Produce_CompleteChain_forModule(Env().CurPosition(), nameChainLinker);
StreamLock
sl(200);
aTitle.Produce_Title( sl()
<< C_sCePrefix_Module
<< " "
<< i_ce.LocalName()
<< c_str );
}
else
{
aTitle.Produce_Title( "Global Module" );
}
write_Docu(aTitle.Add_Row(), i_ce);
CurOut() << new Html::HorizontalLine();
// Write children lists:
ce_ptr_list aNestedModules;
ce_ptr_list aServices;
ce_ptr_list aInterfaces;
ce_ptr_list aStructs;
ce_ptr_list aExceptions;
ce_ptr_list aEnums;
ce_ptr_list aTypedefs;
ce_ptr_list aConstantGroups;
ce_ptr_list aSingletons;
ModuleAttr::Get_AllChildrenSeparated(
aNestedModules,
aServices,
aInterfaces,
aStructs,
aExceptions,
aEnums,
aTypedefs,
aConstantGroups,
aSingletons,
Env().Data().Ces(),
i_ce );
// Has this to be in the order of enum E_SubListIndices ???
if (produce_ChildList(C_sList_NestedModules, C_sList_NestedModules_Label, aNestedModules ))
pNaviSubRow->SwitchOn(sli_NestedModules);
if (produce_ChildList(C_sList_Services, C_sList_Services, aServices))
pNaviSubRow->SwitchOn(sli_Services);
if (produce_ChildList(C_sList_Singletons, C_sList_Singletons, aSingletons))
pNaviSubRow->SwitchOn(sli_Singletons);
if (produce_ChildList(C_sList_Interfaces, C_sList_Interfaces, aInterfaces))
pNaviSubRow->SwitchOn(sli_Interfaces);
if (produce_ChildList(C_sList_Structs, C_sList_Structs, aStructs))
pNaviSubRow->SwitchOn(sli_Structs);
if (produce_ChildList(C_sList_Exceptions, C_sList_Exceptions, aExceptions))
pNaviSubRow->SwitchOn(sli_Exceptions);
if (produce_ChildList(C_sList_Enums, C_sList_Enums, aEnums))
pNaviSubRow->SwitchOn(sli_Enums);
if (produce_ChildList(C_sList_Typedefs, C_sList_Typedefs, aTypedefs))
pNaviSubRow->SwitchOn(sli_Typedefs);
if (produce_ChildList(C_sList_ConstGroups, C_sList_ConstGroups_Label, aConstantGroups))
pNaviSubRow->SwitchOn(sli_ConstGroups);
pNaviSubRow->Produce_Row();
}
DYN HF_NaviSubRow &
HF_IdlModule::make_Navibar( const client & i_ce ) const
{
HF_IdlNavigationBar
aNaviBar(Env(), CurOut());
aNaviBar.Produce_ModuleMainRow(i_ce);
DYN HF_NaviSubRow &
ret = aNaviBar.Add_SubRow();
// Has to be in the order of E_SubListIndices:
ret.AddItem(C_sList_NestedModules, C_sList_NestedModules_Label, false);
ret.AddItem(C_sList_Services, C_sList_Services, false);
ret.AddItem(C_sList_Singletons, C_sList_Singletons, false);
ret.AddItem(C_sList_Interfaces, C_sList_Interfaces, false);
ret.AddItem(C_sList_Structs, C_sList_Structs, false);
ret.AddItem(C_sList_Exceptions, C_sList_Exceptions, false);
ret.AddItem(C_sList_Enums, C_sList_Enums, false);
ret.AddItem(C_sList_Typedefs, C_sList_Typedefs, false);
ret.AddItem(C_sList_ConstGroups, C_sList_ConstGroups_Label, false);
CurOut() << new Html::HorizontalLine();
return ret;
}
bool
HF_IdlModule::produce_ChildList( const String & i_sName,
const String & i_sLabel,
const ce_ptr_list & i_list ) const
{
if ( i_list.size() == 0 )
return false;
HF_SubTitleTable
aTable( CurOut(),
i_sLabel,
i_sName,
2 );
ce_ptr_list::const_iterator
itEnd = i_list.end();
for ( ce_ptr_list::const_iterator it = i_list.begin();
it != itEnd;
++it )
{
Xml::Element &
rRow = aTable.Add_Row();
produce_Link(rRow, *it);
produce_LinkDoc(rRow, *it);
} // end for
return true;
}
void
HF_IdlModule::produce_Link( Xml::Element & o_row,
const client * i_ce ) const
{
csv_assert(i_ce != 0);
Xml::Element &
rCell = o_row
>> *new Html::TableCell
<< new Html::ClassAttr(C_sCellStyle_SummaryLeft);
if ( NOT ary::is_type<ary::idl::Module>(*i_ce) )
{
HF_IdlTypeText
aText(Env(), rCell, true);
aText.Produce_byData(i_ce->CeId());
}
else
{
StreamLock slBuf(100);
rCell
>> *new Html::Link( slBuf() << i_ce->LocalName()
<< "/module-ix.html"
<< c_str )
<< i_ce->LocalName();
}
}
void
HF_IdlModule::produce_LinkDoc( Xml::Element & o_row,
const client * i_ce ) const
{
csv_assert(i_ce != 0);
// We need the cell in any case, because, the rendering may be hurt else.
Xml::Element &
rCell = o_row
>> *new Html::TableCell
<< new Html::ClassAttr(C_sCellStyle_SummaryRight);
const client &
rCe = *i_ce;
const ce_info *
pShort = Get_IdlDocu(rCe.Docu());
if ( pShort == 0 )
return;
if (pShort->IsDeprecated())
{
rCell << "[ DEPRECATED ]" << new Html::LineBreak;
}
if (pShort->IsOptional())
{
rCell << "[ OPTIONAL ]" << new Html::LineBreak;
}
HF_IdlDocuTextDisplay
aShortDisplay(Env(), &rCell, *i_ce);
pShort->Short().DisplayAt(aShortDisplay);
}
|
