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
|
/*************************************************************************
*
* OpenOffice.org - a multi-platform office productivity suite
*
* $RCSfile: hdimpl.hxx,v $
*
* $Revision: 1.2 $
*
* last change: $Author: rt $ $Date: 2005-09-07 17:29:50 $
*
* The Contents of this file are made available subject to
* the terms of GNU Lesser General Public License Version 2.1.
*
*
* GNU Lesser General Public License Version 2.1
* =============================================
* Copyright 2005 by Sun Microsystems, Inc.
* 901 San Antonio Road, Palo Alto, CA 94303, USA
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License version 2.1, as published by the Free Software Foundation.
*
* This library 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 for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
* MA 02111-1307 USA
*
************************************************************************/
#ifndef ADC_DISPLAY_HDIMPL_HXX
#define ADC_DISPLAY_HDIMPL_HXX
// USED SERVICES
// BASE CLASSES
#include <udm/html/htmlitem.hxx>
// COMPONENTS
#include "easywri.hxx"
// PARAMETERS
#include <cosv/bstream.hxx>
#include <ary/ids.hxx>
#include <ary/ary_disp.hxx>
#include <ary/cpp/c_namesp.hxx>
#include <ary/ce.hxx>
#include <ary/info/codeinfo.hxx>
#include "aryattrs.hxx" // For compatibility with earlier times, when those funtions were in this header.
namespace ary
{
namespace cpp
{
class Class;
class DisplayGate;
class Function;
class CppDefinition;
}
class CodeEntity;
class QualifiedName;
}
namespace csi
{
namespace xml
{
class Element;
}
namespace html
{
class Table;
}
}
namespace adcdisp
{
class ParameterTable;
}
class OuputPage_Environment;
class Docu_Display;
class HtmlDisplay_Impl
{
public:
~HtmlDisplay_Impl();
const OuputPage_Environment &
Env() const { return *pEnv; }
// ACCESS
OuputPage_Environment &
Env() { return *pEnv; }
EasyWriter & Easy() { return aWriteHelper; }
csi::xml::Element & CurOut() { return aWriteHelper.Out(); }
protected:
HtmlDisplay_Impl(
OuputPage_Environment &
io_rEnv );
private:
// DATA
OuputPage_Environment *
pEnv;
EasyWriter aWriteHelper;
};
namespace dshelp
{
void DisplaySlot(
ary::Display & o_rDisplay,
const ary::AryGroup &
i_rGroup,
ary::SlotAccessId i_nSlot );
const char * PathUp(
uintt i_nLevels );
const char * PathPerLevelsUp(
uintt i_nLevels,
const char * i_nPathBelowDestinationLevel );
const char * PathPerRoot(
const OuputPage_Environment &
i_rEnv,
const char * i_sPathFromRootDir );
const char * PathPerNamespace(
const OuputPage_Environment &
i_rEnv,
const char * i_sPathFromNamespaceDir );
csi::html::Table & Create_ChildListTable(
csi::xml::Element & o_rParentElement,
const char * i_sTitle,
const char * i_sLabel );
void Create_ChildListLabel(
csi::xml::Element & o_rParentElement,
const char * i_sLabel );
DYN csi::html::Table &
Create_ChildListTable(
const char * i_sTitle );
const char * HtmlFileName(
const char * i_sPrefix,
const char * i_sEntityName );
inline const char *
ClassFileName( const char * i_sClassLocalName )
{ return HtmlFileName( "c-", i_sClassLocalName); }
inline const char *
EnumFileName( const char * i_sEnumLocalName )
{ return HtmlFileName( "e-", i_sEnumLocalName); }
inline const char *
TypedefFileName( const char * i_sTypedefLocalName )
{ return HtmlFileName( "t-", i_sTypedefLocalName); }
inline const char *
FileFileName( const char * i_sFileLocalName )
{ return HtmlFileName( "f-", i_sFileLocalName); }
const char * Path2Class(
uintt i_nLevelsUp,
const char * i_sClassLocalName );
const char * Path2Child(
const char * i_sFileName,
const char * i_sSubDir = 0 );
const char * Path2ChildNamespace(
const char * i_sLocalName );
const char * OperationLink(
const udmstri & i_sOpName,
ary::OSid i_nSignature,
const char * i_sPrePath = "" );
const char * DataLink(
const udmstri & i_sLocalName,
const char * i_sPrePath = "" );
inline const char *
OperationLabel( const udmstri & i_sOpName,
ary::OSid i_nSignature )
{ return OperationLink(i_sOpName, i_nSignature) + 1; } // Skip '#' in front.
inline const char *
DataLabel( const udmstri & i_sLocalName )
{ return DataLink(i_sLocalName) + 1; } // Skip '#' in front.
void Get_LinkedTypeText(
csi::xml::Element & o_rOut,
const OuputPage_Environment &
i_rEnv,
ary::Tid i_nId,
bool i_bWithAbsolutifier = true );
const char * Link2Ce(
const OuputPage_Environment &
i_rEnv,
const ary::CodeEntity & i_rCe );
const char * Link2CppDefinition(
const OuputPage_Environment &
i_rEnv,
const ary::cpp::CppDefinition &
i_rDef );
const ary::CodeEntity *
FindUnambiguousCe(
const OuputPage_Environment &
i_rEnv,
const ary::QualifiedName &
i_rQuName,
const ary::cpp::Class * i_pJustDocumentedClass );
void ShowDocu_On(
csi::xml::Element & o_rOut,
Docu_Display & io_rDisplay,
const ary::RepositoryEntity &
i_rRE );
void WriteOut_TokenList(
csi::xml::Element & o_rOut,
const StringVector & i_rTokens,
const char * i_sSeparator );
void EraseLeadingSpace(
udmstri & io_rStr );
/** @param o_bIsConst
*o_bIsConst will be set to true, if o_bIsConst != 0 and function is const.
If the function is not const, *o_bIsConst remains unchanged!
@param o_bIsVirtual
The same as o_bIsConst.
*/
void WriteOut_LinkedFunctionText(
csi::xml::Element & o_rTitleOut,
adcdisp::ParameterTable &
o_rParameters,
const ary::cpp::Function &
i_rFunction,
const OuputPage_Environment &
i_rEnv,
bool * o_bIsConst = 0,
bool * o_bIsVirtual = 0 );
} // namespace dshelp
using namespace dshelp;
#endif
|
