xref: /aoo4110/main/autodoc/inc/ary/idl/ip_ce.hxx (revision b1cdbd2c)
1*b1cdbd2cSJim Jagielski /**************************************************************
2*b1cdbd2cSJim Jagielski  *
3*b1cdbd2cSJim Jagielski  * Licensed to the Apache Software Foundation (ASF) under one
4*b1cdbd2cSJim Jagielski  * or more contributor license agreements.  See the NOTICE file
5*b1cdbd2cSJim Jagielski  * distributed with this work for additional information
6*b1cdbd2cSJim Jagielski  * regarding copyright ownership.  The ASF licenses this file
7*b1cdbd2cSJim Jagielski  * to you under the Apache License, Version 2.0 (the
8*b1cdbd2cSJim Jagielski  * "License"); you may not use this file except in compliance
9*b1cdbd2cSJim Jagielski  * with the License.  You may obtain a copy of the License at
10*b1cdbd2cSJim Jagielski  *
11*b1cdbd2cSJim Jagielski  *   http://www.apache.org/licenses/LICENSE-2.0
12*b1cdbd2cSJim Jagielski  *
13*b1cdbd2cSJim Jagielski  * Unless required by applicable law or agreed to in writing,
14*b1cdbd2cSJim Jagielski  * software distributed under the License is distributed on an
15*b1cdbd2cSJim Jagielski  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*b1cdbd2cSJim Jagielski  * KIND, either express or implied.  See the License for the
17*b1cdbd2cSJim Jagielski  * specific language governing permissions and limitations
18*b1cdbd2cSJim Jagielski  * under the License.
19*b1cdbd2cSJim Jagielski  *
20*b1cdbd2cSJim Jagielski  *************************************************************/
21*b1cdbd2cSJim Jagielski 
22*b1cdbd2cSJim Jagielski 
23*b1cdbd2cSJim Jagielski 
24*b1cdbd2cSJim Jagielski #ifndef ARY_IDL_IP_CE_HXX
25*b1cdbd2cSJim Jagielski #define ARY_IDL_IP_CE_HXX
26*b1cdbd2cSJim Jagielski 
27*b1cdbd2cSJim Jagielski // USED SERVICES
28*b1cdbd2cSJim Jagielski #include <ary/idl/i_types4idl.hxx>
29*b1cdbd2cSJim Jagielski #include <ary/idl/i_property.hxx>
30*b1cdbd2cSJim Jagielski 
31*b1cdbd2cSJim Jagielski 
32*b1cdbd2cSJim Jagielski 
33*b1cdbd2cSJim Jagielski 
34*b1cdbd2cSJim Jagielski namespace ary
35*b1cdbd2cSJim Jagielski {
36*b1cdbd2cSJim Jagielski namespace idl
37*b1cdbd2cSJim Jagielski {
38*b1cdbd2cSJim Jagielski     class Module;
39*b1cdbd2cSJim Jagielski 
40*b1cdbd2cSJim Jagielski     class ConstantsGroup;
41*b1cdbd2cSJim Jagielski     class Enum;
42*b1cdbd2cSJim Jagielski     class Exception;
43*b1cdbd2cSJim Jagielski     class Interface;
44*b1cdbd2cSJim Jagielski     class Service;
45*b1cdbd2cSJim Jagielski     class SglIfcService;
46*b1cdbd2cSJim Jagielski     class Singleton;
47*b1cdbd2cSJim Jagielski     class SglIfcSingleton;
48*b1cdbd2cSJim Jagielski     class Struct;
49*b1cdbd2cSJim Jagielski     class Typedef;
50*b1cdbd2cSJim Jagielski 
51*b1cdbd2cSJim Jagielski     class Attribute;
52*b1cdbd2cSJim Jagielski     class Constant;
53*b1cdbd2cSJim Jagielski     class EnumValue;
54*b1cdbd2cSJim Jagielski     class Function;
55*b1cdbd2cSJim Jagielski     class Property;
56*b1cdbd2cSJim Jagielski     class StructElement;
57*b1cdbd2cSJim Jagielski     class Variable;
58*b1cdbd2cSJim Jagielski 
59*b1cdbd2cSJim Jagielski     class NameLookup;
60*b1cdbd2cSJim Jagielski 
61*b1cdbd2cSJim Jagielski 
62*b1cdbd2cSJim Jagielski /** Provides the access logic for all code entities.
63*b1cdbd2cSJim Jagielski */
64*b1cdbd2cSJim Jagielski class CePilot
65*b1cdbd2cSJim Jagielski {
66*b1cdbd2cSJim Jagielski   public:
67*b1cdbd2cSJim Jagielski     // LIFECYCLE
~CePilot()68*b1cdbd2cSJim Jagielski     virtual             ~CePilot() {}
69*b1cdbd2cSJim Jagielski 
70*b1cdbd2cSJim Jagielski     // OPERATIONS
71*b1cdbd2cSJim Jagielski     virtual Module &    CheckIn_Module(
72*b1cdbd2cSJim Jagielski                             Ce_id               i_nParentId,
73*b1cdbd2cSJim Jagielski                             const String &      i_sName ) = 0;
74*b1cdbd2cSJim Jagielski     virtual Service &   Store_Service(
75*b1cdbd2cSJim Jagielski                             Ce_id               i_nOwner,
76*b1cdbd2cSJim Jagielski                             const String &      i_sName ) = 0;
77*b1cdbd2cSJim Jagielski     virtual SglIfcService &
78*b1cdbd2cSJim Jagielski                         Store_SglIfcService(
79*b1cdbd2cSJim Jagielski                             Ce_id               i_nOwner,
80*b1cdbd2cSJim Jagielski                             const String &      i_sName,
81*b1cdbd2cSJim Jagielski                             Type_id             i_nBaseInterface ) = 0;
82*b1cdbd2cSJim Jagielski     virtual Interface & Store_Interface(
83*b1cdbd2cSJim Jagielski                             Ce_id               i_nOwner,
84*b1cdbd2cSJim Jagielski                             const String &      i_sName,
85*b1cdbd2cSJim Jagielski                             Type_id             i_nBase ) = 0;
86*b1cdbd2cSJim Jagielski     virtual Struct &    Store_Struct(
87*b1cdbd2cSJim Jagielski                             Ce_id               i_nOwner,
88*b1cdbd2cSJim Jagielski                             const String &      i_sName,
89*b1cdbd2cSJim Jagielski                             Type_id             i_nBase,
90*b1cdbd2cSJim Jagielski                             const String &      i_sTemplateParam = String::Null_() ) = 0;
91*b1cdbd2cSJim Jagielski     virtual Exception & Store_Exception(
92*b1cdbd2cSJim Jagielski                             Ce_id               i_nOwner,
93*b1cdbd2cSJim Jagielski                             const String &      i_sName,
94*b1cdbd2cSJim Jagielski                             Type_id             i_nBase ) = 0;
95*b1cdbd2cSJim Jagielski     virtual Enum &      Store_Enum(
96*b1cdbd2cSJim Jagielski                             Ce_id               i_nOwner,
97*b1cdbd2cSJim Jagielski                             const String &      i_sName ) = 0;
98*b1cdbd2cSJim Jagielski     virtual Typedef &   Store_Typedef(
99*b1cdbd2cSJim Jagielski                             Ce_id               i_nOwner,
100*b1cdbd2cSJim Jagielski                             const String &      i_sName,
101*b1cdbd2cSJim Jagielski                             Type_id             i_nDefiningType ) = 0;
102*b1cdbd2cSJim Jagielski     virtual ConstantsGroup &
103*b1cdbd2cSJim Jagielski                         Store_ConstantsGroup(
104*b1cdbd2cSJim Jagielski                             Ce_id               i_nOwner,
105*b1cdbd2cSJim Jagielski                             const String &      i_sName ) = 0;
106*b1cdbd2cSJim Jagielski     virtual Singleton & Store_Singleton(
107*b1cdbd2cSJim Jagielski                             Ce_id               i_nOwner,
108*b1cdbd2cSJim Jagielski                             const String &      i_sName ) = 0;
109*b1cdbd2cSJim Jagielski     virtual SglIfcSingleton &
110*b1cdbd2cSJim Jagielski                         Store_SglIfcSingleton(
111*b1cdbd2cSJim Jagielski                             Ce_id               i_nOwner,
112*b1cdbd2cSJim Jagielski                             const String &      i_sName,
113*b1cdbd2cSJim Jagielski                             Type_id             i_nBaseInterface ) = 0;
114*b1cdbd2cSJim Jagielski 
115*b1cdbd2cSJim Jagielski     virtual Constant &  Store_Constant(
116*b1cdbd2cSJim Jagielski                             Ce_id               i_nOwner,
117*b1cdbd2cSJim Jagielski                             const String &      i_sName,
118*b1cdbd2cSJim Jagielski                             Type_id             i_nType,
119*b1cdbd2cSJim Jagielski                             const String &      i_sValue ) = 0;
120*b1cdbd2cSJim Jagielski     virtual Property &  Store_Property(
121*b1cdbd2cSJim Jagielski                             Ce_id               i_nOwner,
122*b1cdbd2cSJim Jagielski                             const String &      i_sName,
123*b1cdbd2cSJim Jagielski                             Type_id             i_nType,
124*b1cdbd2cSJim Jagielski                             Property::Stereotypes
125*b1cdbd2cSJim Jagielski                                                 i_stereotypes ) = 0;
126*b1cdbd2cSJim Jagielski     virtual Function &  Store_Function(
127*b1cdbd2cSJim Jagielski                             Ce_id               i_nOwner,
128*b1cdbd2cSJim Jagielski                             const String &      i_sName,
129*b1cdbd2cSJim Jagielski                             Type_id             i_nReturnType,
130*b1cdbd2cSJim Jagielski                             bool                i_bOneWay ) = 0;
131*b1cdbd2cSJim Jagielski     virtual Function &  Store_ServiceConstructor(
132*b1cdbd2cSJim Jagielski                             Ce_id               i_nOwner,
133*b1cdbd2cSJim Jagielski                             const String &      i_sName ) = 0;
134*b1cdbd2cSJim Jagielski     virtual StructElement &
135*b1cdbd2cSJim Jagielski                         Store_StructMember(
136*b1cdbd2cSJim Jagielski                             Ce_id               i_nOwner,
137*b1cdbd2cSJim Jagielski                             const String &      i_sName,
138*b1cdbd2cSJim Jagielski                             Type_id             i_nType ) = 0;
139*b1cdbd2cSJim Jagielski     virtual StructElement &
140*b1cdbd2cSJim Jagielski                         Store_ExceptionMember(
141*b1cdbd2cSJim Jagielski                             Ce_id               i_nOwner,
142*b1cdbd2cSJim Jagielski                             const String &      i_sName,
143*b1cdbd2cSJim Jagielski                             Type_id             i_nType ) = 0;
144*b1cdbd2cSJim Jagielski     virtual EnumValue & Store_EnumValue(
145*b1cdbd2cSJim Jagielski                             Ce_id               i_nOwner,
146*b1cdbd2cSJim Jagielski                             const String &      i_sName,
147*b1cdbd2cSJim Jagielski                             const String &      i_sValue ) = 0;
148*b1cdbd2cSJim Jagielski     virtual Attribute & Store_Attribute(
149*b1cdbd2cSJim Jagielski                             Ce_id               i_nOwner,
150*b1cdbd2cSJim Jagielski                             const String &      i_sName,
151*b1cdbd2cSJim Jagielski                             Type_id             i_nType,
152*b1cdbd2cSJim Jagielski                             bool                i_bReadOnly,
153*b1cdbd2cSJim Jagielski                             bool                i_bBound ) = 0;
154*b1cdbd2cSJim Jagielski     // INQUIRY
155*b1cdbd2cSJim Jagielski     virtual const Module &
156*b1cdbd2cSJim Jagielski                         GlobalNamespace() const = 0;
157*b1cdbd2cSJim Jagielski     virtual const CodeEntity &
158*b1cdbd2cSJim Jagielski                         Find_Ce(
159*b1cdbd2cSJim Jagielski                             Ce_id               i_nId ) const = 0;
160*b1cdbd2cSJim Jagielski 
161*b1cdbd2cSJim Jagielski     virtual const Module &
162*b1cdbd2cSJim Jagielski                         Find_Module(
163*b1cdbd2cSJim Jagielski                             Ce_id               i_nId ) const = 0;
164*b1cdbd2cSJim Jagielski     virtual const Module *
165*b1cdbd2cSJim Jagielski                         Search_Module(
166*b1cdbd2cSJim Jagielski                             Ce_id               i_nId ) const = 0;
167*b1cdbd2cSJim Jagielski     virtual const Function &
168*b1cdbd2cSJim Jagielski                         Find_Function(
169*b1cdbd2cSJim Jagielski                             Ce_id               i_nId ) const = 0;
170*b1cdbd2cSJim Jagielski     virtual const Property &
171*b1cdbd2cSJim Jagielski                         Find_Property(
172*b1cdbd2cSJim Jagielski                             Ce_id               i_nId ) const = 0;
173*b1cdbd2cSJim Jagielski     virtual const EnumValue &
174*b1cdbd2cSJim Jagielski                         Find_EnumValue(
175*b1cdbd2cSJim Jagielski                             Ce_id               i_nId ) const = 0;
176*b1cdbd2cSJim Jagielski     virtual const Constant &
177*b1cdbd2cSJim Jagielski                         Find_Constant(
178*b1cdbd2cSJim Jagielski                             Ce_id               i_nId ) const = 0;
179*b1cdbd2cSJim Jagielski     virtual const StructElement &
180*b1cdbd2cSJim Jagielski                         Find_StructElement(
181*b1cdbd2cSJim Jagielski                             Ce_id               i_nId ) const = 0;
182*b1cdbd2cSJim Jagielski     virtual void        Get_Text(
183*b1cdbd2cSJim Jagielski                             StringVector &      o_module,
184*b1cdbd2cSJim Jagielski                             String &            o_ce,
185*b1cdbd2cSJim Jagielski                             String &            o_member,
186*b1cdbd2cSJim Jagielski                             const CodeEntity &  i_ce ) const = 0;
187*b1cdbd2cSJim Jagielski     virtual const NameLookup &
188*b1cdbd2cSJim Jagielski                         NameDictionary() const = 0;
189*b1cdbd2cSJim Jagielski     virtual void        Get_AlphabeticalIndex(
190*b1cdbd2cSJim Jagielski                             std::vector<Ce_id> &
191*b1cdbd2cSJim Jagielski                                                 o_rResult,
192*b1cdbd2cSJim Jagielski                             alphabetical_index::E_Letter
193*b1cdbd2cSJim Jagielski                                                 i_cLetter) const = 0;
194*b1cdbd2cSJim Jagielski     // ACCESS
195*b1cdbd2cSJim Jagielski     virtual Module &    GlobalNamespace() = 0;
196*b1cdbd2cSJim Jagielski     virtual CodeEntity &
197*b1cdbd2cSJim Jagielski                         Find_Ce(
198*b1cdbd2cSJim Jagielski                             Ce_id               i_nId ) = 0;
199*b1cdbd2cSJim Jagielski };
200*b1cdbd2cSJim Jagielski 
201*b1cdbd2cSJim Jagielski 
202*b1cdbd2cSJim Jagielski 
203*b1cdbd2cSJim Jagielski 
204*b1cdbd2cSJim Jagielski }   // namespace idl
205*b1cdbd2cSJim Jagielski }   // namespace ary
206*b1cdbd2cSJim Jagielski #endif
207