summaryrefslogtreecommitdiff
path: root/autodoc/inc/ary/idl/ip_ce.hxx
blob: 8db79d12622ba93859fd81c438ee4b5195d2eb63 (plain)
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
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
/*************************************************************************
 *
 *  $RCSfile: ip_ce.hxx,v $
 *
 *  $Revision: 1.1 $
 *
 *  last change: $Author: np $ $Date: 2002-11-01 17:12:10 $
 *
 *  The Contents of this file are made available subject to the terms of
 *  either of the following licenses
 *
 *         - GNU Lesser General Public License Version 2.1
 *         - Sun Industry Standards Source License Version 1.1
 *
 *  Sun Microsystems Inc., October, 2000
 *
 *  GNU Lesser General Public License Version 2.1
 *  =============================================
 *  Copyright 2000 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
 *
 *
 *  Sun Industry Standards Source License Version 1.1
 *  =================================================
 *  The contents of this file are subject to the Sun Industry Standards
 *  Source License Version 1.1 (the "License"); You may not use this file
 *  except in compliance with the License. You may obtain a copy of the
 *  License at http://www.openoffice.org/license.html.
 *
 *  Software provided under this License is provided on an "AS IS" basis,
 *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
 *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
 *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
 *  See the License for the specific provisions governing your rights and
 *  obligations concerning the Software.
 *
 *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
 *
 *  Copyright: 2000 by Sun Microsystems, Inc.
 *
 *  All Rights Reserved.
 *
 *  Contributor(s): _______________________________________
 *
 *
 ************************************************************************/

#ifndef ARY_IDL_IP_CE_HXX
#define ARY_IDL_IP_CE_HXX


// USED SERVICES
    // BASE CLASSES
    // COMPONENTS
    // PARAMETERS
#include <ary/idl/i_language.hxx>
#include <ary/idl/i_property.hxx>


namespace ary
{

class QualifiedName;

namespace idl
{
    class Module;

    class ConstantsGroup;
    class Enum;
    class Exception;
    class Interface;
    class Service;
    class Singleton;
    class Struct;
    class Typedef;

    class Attribute;
    class Constant;
    class EnumValue;
    class Function;
    class Property;
    class StructElement;
    class Variable;


/** @resp
    Provides the access logic for all code entities.

    @interface
*/
class CePilot
{
  public:
    // LIFECYCLE
    virtual             ~CePilot() {}

    // OPERATIONS
    Module &            CheckIn_Module(
                            Ce_id               i_nParentId,
                            const String &      i_sName );
    Service &           Store_Service(
                            Ce_id               i_nOwner,
                            const String &      i_sName );
    Interface &         Store_Interface(
                            Ce_id               i_nOwner,
                            const String &      i_sName,
                            Type_id             i_nBase );
    Struct &            Store_Struct(
                            Ce_id               i_nOwner,
                            const String &      i_sName,
                            Type_id             i_nBase );
    Exception &         Store_Exception(
                            Ce_id               i_nOwner,
                            const String &      i_sName,
                            Type_id             i_nBase );
    Enum &              Store_Enum(
                            Ce_id               i_nOwner,
                            const String &      i_sName );
    Typedef &           Store_Typedef(
                            Ce_id               i_nOwner,
                            const String &      i_sName,
                            Type_id             i_nDefiningType );
    ConstantsGroup &    Store_ConstantsGroup(
                            Ce_id               i_nOwner,
                            const String &      i_sName );
    Singleton &         Store_Singleton(
                            Ce_id               i_nOwner,
                            const String &      i_sName );

    Constant &          Store_Constant(
                            Ce_id               i_nOwner,
                            const String &      i_sName,
                            Type_id             i_nType,
                            const String &      i_sValue );
    Property &          Store_Property(
                            Ce_id               i_nOwner,
                            const String &      i_sName,
                            Type_id             i_nType,
                            Property::Stereotypes
                                                i_stereotypes );
    Function &          Store_Function(
                            Ce_id               i_nOwner,
                            const String &      i_sName,
                            Type_id             i_nReturnType,
                            bool                i_bOneWay,
                            bool                i_bConst );
    StructElement &     Store_StructMember(
                            Ce_id               i_nOwner,
                            const String &      i_sName,
                            Type_id             i_nType );
    StructElement &     Store_ExceptionMember(
                            Ce_id               i_nOwner,
                            const String &      i_sName,
                            Type_id             i_nType );
    EnumValue &         Store_EnumValue(
                            Ce_id               i_nOwner,
                            const String &      i_sName,
                            const String &      i_sValue );
    Attribute &         Store_Attribute(
                            Ce_id               i_nOwner,
                            const String &      i_sName,
                            Type_id             i_nType,
                            bool                i_bReadOnly );
    // INQUIRY
    const Module &      GlobalNamespace() const;
    const CodeEntity &  Find_Ce(
                            Ce_id               i_nId ) const;

    const Module &      Find_Module(
                            Ce_id               i_nId ) const;
    const Module *      Search_Module(
                            Ce_id               i_nId ) const;
    const Function &    Find_Function(
                            Ce_id               i_nId ) const;
    const Property &    Find_Property(
                            Ce_id               i_nId ) const;
    const EnumValue &   Find_EnumValue(
                            Ce_id               i_nId ) const;
    const Constant &    Find_Constant(
                            Ce_id               i_nId ) const;
    const StructElement &
                        Find_StructElement(
                            Ce_id               i_nId ) const;
    void                Get_Text(
                            StringVector &      o_module,
                            String &            o_ce,
                            String &            o_member,
                            const CodeEntity &  i_ce ) const;
    // ACCESS
    Module &            GlobalNamespace();
    CodeEntity &        Find_Ce(
                            Ce_id               i_nId );

  private:
    // Locals
    virtual Module &    do_CheckIn_Module(
                            Ce_id               i_nParentId,
                            const String &      i_sName ) = 0;
    virtual Service &   do_Store_Service(
                            Ce_id               i_nOwner,
                            const String &      i_sName ) = 0;
    virtual Interface & do_Store_Interface(
                            Ce_id               i_nOwner,
                            const String &      i_sName,
                            Type_id             i_nBase ) = 0;
    virtual Struct &    do_Store_Struct(
                            Ce_id               i_nOwner,
                            const String &      i_sName,
                            Type_id             i_nBase ) = 0;
    virtual Exception & do_Store_Exception(
                            Ce_id               i_nOwner,
                            const String &      i_sName,
                            Type_id             i_nBase ) = 0;
    virtual Enum &      do_Store_Enum(
                            Ce_id               i_nOwner,
                            const String &      i_sName ) = 0;
    virtual Typedef &   do_Store_Typedef(
                            Ce_id               i_nOwner,
                            const String &      i_sName,
                            Type_id             i_nDefiningType ) = 0;
    virtual ConstantsGroup &
                        do_Store_ConstantsGroup(
                            Ce_id               i_nOwner,
                            const String &      i_sName ) = 0;
    virtual Singleton & do_Store_Singleton(
                            Ce_id               i_nOwner,
                            const String &      i_sName ) = 0;

    virtual Constant &  do_Store_Constant(
                            Ce_id               i_nOwner,
                            const String &      i_sName,
                            Type_id             i_nType,
                            const String &      i_sValue ) = 0;
    virtual Property &  do_Store_Property(
                            Ce_id               i_nOwner,
                            const String &      i_sName,
                            Type_id             i_nType,
                            Property::Stereotypes
                                                i_stereotypes ) = 0;
    virtual Function &  do_Store_Function(
                            Ce_id               i_nOwner,
                            const String &      i_sName,
                            Type_id             i_nReturnType,
                            bool                i_bOneWay,
                            bool                i_bConst ) = 0;
    virtual StructElement &
                        do_Store_StructMember(
                            Ce_id               i_nOwner,
                            const String &      i_sName,
                            Type_id             i_nType ) = 0;
    virtual StructElement &
                        do_Store_ExceptionMember(
                            Ce_id               i_nOwner,
                            const String &      i_sName,
                            Type_id             i_nType ) = 0;
    virtual EnumValue & do_Store_EnumValue(
                            Ce_id               i_nOwner,
                            const String &      i_sName,
                            const String &      i_sValue ) = 0;
    virtual Attribute & do_Store_Attribute(
                            Ce_id               i_nOwner,
                            const String &      i_sName,
                            Type_id             i_nType,
                            bool                i_bReadOnly ) = 0;

    virtual const Module &
                        inq_GlobalNamespace() const = 0;
    virtual const CodeEntity &
                        inq_Find_Ce(
                            Ce_id               i_nId ) const = 0;

    virtual const Module &
                        inq_Find_Module(
                            Ce_id               i_nId ) const = 0;
    virtual const Module *
                        inq_Search_Module(
                            Ce_id               i_nId ) const = 0;
    virtual const Function &
                        inq_Find_Function(
                            Ce_id               i_nId ) const = 0;
    virtual const Property &
                        inq_Find_Property(
                            Ce_id               i_nId ) const = 0;
    virtual const EnumValue &
                        inq_Find_EnumValue(
                            Ce_id               i_nId ) const = 0;
    virtual const Constant &
                        inq_Find_Constant(
                            Ce_id               i_nId ) const = 0;
    virtual const StructElement &
                        inq_Find_StructElement(
                            Ce_id               i_nId ) const = 0;
    virtual void        inq_Get_Text(
                            StringVector &      o_module,
                            String &            o_ce,
                            String &            o_member,
                            const CodeEntity &  i_ce ) const = 0;
    // ACCESS
    virtual Module &    access_GlobalNamespace() = 0;
    virtual CodeEntity &
                        access_Find_Ce(
                            Ce_id               i_nId ) = 0;
};


// IMPLEMENTATION

inline Module &
CePilot::CheckIn_Module(    Ce_id               i_nParentId,
                            const String &      i_sName )
    { return do_CheckIn_Module(i_nParentId, i_sName); }

inline Service &
CePilot::Store_Service(     Ce_id               i_nOwner,
                            const String &      i_sName )
    { return do_Store_Service(i_nOwner,i_sName); }

inline Interface &
CePilot::Store_Interface(   Ce_id               i_nOwner,
                            const String &      i_sName,
                            Type_id             i_nBase )
    { return do_Store_Interface(i_nOwner,i_sName,i_nBase); }

inline Struct &
CePilot::Store_Struct(      Ce_id               i_nOwner,
                            const String &      i_sName,
                            Type_id             i_nBase )
    { return do_Store_Struct(i_nOwner,i_sName,i_nBase); }

inline Exception &
CePilot::Store_Exception(   Ce_id               i_nOwner,
                            const String &      i_sName,
                            Type_id             i_nBase )
    { return do_Store_Exception(i_nOwner,i_sName,i_nBase); }

inline Enum &
CePilot::Store_Enum(        Ce_id               i_nOwner,
                            const String &      i_sName )
    { return do_Store_Enum(i_nOwner,i_sName); }

inline Typedef &
CePilot::Store_Typedef(     Ce_id               i_nOwner,
                            const String &      i_sName,
                            Type_id             i_nDefiningType )
    { return do_Store_Typedef(i_nOwner,i_sName,i_nDefiningType); }

inline ConstantsGroup &
CePilot::Store_ConstantsGroup(  Ce_id               i_nOwner,
                                const String &      i_sName )
    { return do_Store_ConstantsGroup(i_nOwner,i_sName); }

inline Singleton &
CePilot::Store_Singleton( Ce_id               i_nOwner,
                          const String &      i_sName )
    { return do_Store_Singleton(i_nOwner,i_sName); }

inline Constant &
CePilot::Store_Constant(    Ce_id               i_nOwner,
                            const String &      i_sName,
                            Type_id             i_nType,
                            const String &      i_sValue )
    { return do_Store_Constant(i_nOwner,i_sName,i_nType,i_sValue); }

inline Property &
CePilot::Store_Property(    Ce_id               i_nOwner,
                            const String &      i_sName,
                            Type_id             i_nType,
                            ary::idl::Property::Stereotypes
                                                i_stereotypes )
    { return do_Store_Property(i_nOwner,i_sName,i_nType,i_stereotypes); }

inline Function &
CePilot::Store_Function(    Ce_id               i_nOwner,
                            const String &      i_sName,
                            Type_id             i_nReturnType,
                            bool                i_bOneWay,
                            bool                i_bConst )
    { return do_Store_Function(i_nOwner,i_sName,i_nReturnType,i_bOneWay,i_bConst); }

inline StructElement &
CePilot::Store_StructMember(   Ce_id               i_nOwner,
                               const String &      i_sName,
                               Type_id             i_nType )
    { return do_Store_StructMember(i_nOwner,i_sName,i_nType); }

inline StructElement &
CePilot::Store_ExceptionMember( Ce_id               i_nOwner,
                                const String &      i_sName,
                                Type_id             i_nType )
    { return do_Store_ExceptionMember(i_nOwner,i_sName,i_nType); }

inline EnumValue &
CePilot::Store_EnumValue(   Ce_id               i_nOwner,
                            const String &      i_sName,
                            const String &      i_sValue )
    { return do_Store_EnumValue(i_nOwner,i_sName,i_sValue); }

inline Attribute &
CePilot::Store_Attribute( Ce_id               i_nOwner,
                          const String &      i_sName,
                          Type_id             i_nType,
                          bool                i_bReadOnly )
    { return do_Store_Attribute(i_nOwner, i_sName, i_nType, i_bReadOnly); }

inline const Module &
CePilot::GlobalNamespace() const
    { return inq_GlobalNamespace(); }
inline const CodeEntity &
CePilot::Find_Ce( Ce_id i_nId ) const
    { return inq_Find_Ce(i_nId); }
inline const Module &
CePilot::Find_Module( Ce_id i_nId ) const
    { return inq_Find_Module(i_nId); }
inline const Module *
CePilot::Search_Module( Ce_id i_nId ) const
    { return inq_Search_Module(i_nId); }
inline const Function &
CePilot::Find_Function( Ce_id i_nId ) const
    { return inq_Find_Function(i_nId); }
inline const Property &
CePilot::Find_Property( Ce_id i_nId ) const
    { return inq_Find_Property(i_nId); }
inline const EnumValue &
CePilot::Find_EnumValue( Ce_id i_nId ) const
    { return inq_Find_EnumValue(i_nId); }
inline const Constant &
CePilot::Find_Constant( Ce_id i_nId ) const
    { return inq_Find_Constant(i_nId); }

inline const StructElement &
CePilot::Find_StructElement( Ce_id i_nId ) const
    { return inq_Find_StructElement(i_nId); }
inline void
CePilot::Get_Text( StringVector &      o_module,
                   String &            o_ce,
                   String &            o_member,
                   const CodeEntity &  i_ce ) const
    { inq_Get_Text(o_module, o_ce, o_member, i_ce);  }


inline Module &
CePilot::GlobalNamespace()
    { return access_GlobalNamespace(); }
inline CodeEntity &
CePilot::Find_Ce( Ce_id i_nId )
    { return access_Find_Ce(i_nId); }


}   // namespace idl
}   // namespace ary


#endif