xref: /aoo41x/main/autodoc/inc/ary/idl/ip_ce.hxx (revision cdf0e10c)
1*cdf0e10cSrcweir /*************************************************************************
2*cdf0e10cSrcweir  *
3*cdf0e10cSrcweir  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4*cdf0e10cSrcweir  *
5*cdf0e10cSrcweir  * Copyright 2000, 2010 Oracle and/or its affiliates.
6*cdf0e10cSrcweir  *
7*cdf0e10cSrcweir  * OpenOffice.org - a multi-platform office productivity suite
8*cdf0e10cSrcweir  *
9*cdf0e10cSrcweir  * This file is part of OpenOffice.org.
10*cdf0e10cSrcweir  *
11*cdf0e10cSrcweir  * OpenOffice.org is free software: you can redistribute it and/or modify
12*cdf0e10cSrcweir  * it under the terms of the GNU Lesser General Public License version 3
13*cdf0e10cSrcweir  * only, as published by the Free Software Foundation.
14*cdf0e10cSrcweir  *
15*cdf0e10cSrcweir  * OpenOffice.org is distributed in the hope that it will be useful,
16*cdf0e10cSrcweir  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17*cdf0e10cSrcweir  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18*cdf0e10cSrcweir  * GNU Lesser General Public License version 3 for more details
19*cdf0e10cSrcweir  * (a copy is included in the LICENSE file that accompanied this code).
20*cdf0e10cSrcweir  *
21*cdf0e10cSrcweir  * You should have received a copy of the GNU Lesser General Public License
22*cdf0e10cSrcweir  * version 3 along with OpenOffice.org.  If not, see
23*cdf0e10cSrcweir  * <http://www.openoffice.org/license.html>
24*cdf0e10cSrcweir  * for a copy of the LGPLv3 License.
25*cdf0e10cSrcweir  *
26*cdf0e10cSrcweir  ************************************************************************/
27*cdf0e10cSrcweir 
28*cdf0e10cSrcweir #ifndef ARY_IDL_IP_CE_HXX
29*cdf0e10cSrcweir #define ARY_IDL_IP_CE_HXX
30*cdf0e10cSrcweir 
31*cdf0e10cSrcweir // USED SERVICES
32*cdf0e10cSrcweir #include <ary/idl/i_types4idl.hxx>
33*cdf0e10cSrcweir #include <ary/idl/i_property.hxx>
34*cdf0e10cSrcweir 
35*cdf0e10cSrcweir 
36*cdf0e10cSrcweir 
37*cdf0e10cSrcweir 
38*cdf0e10cSrcweir namespace ary
39*cdf0e10cSrcweir {
40*cdf0e10cSrcweir namespace idl
41*cdf0e10cSrcweir {
42*cdf0e10cSrcweir     class Module;
43*cdf0e10cSrcweir 
44*cdf0e10cSrcweir     class ConstantsGroup;
45*cdf0e10cSrcweir     class Enum;
46*cdf0e10cSrcweir     class Exception;
47*cdf0e10cSrcweir     class Interface;
48*cdf0e10cSrcweir     class Service;
49*cdf0e10cSrcweir     class SglIfcService;
50*cdf0e10cSrcweir     class Singleton;
51*cdf0e10cSrcweir     class SglIfcSingleton;
52*cdf0e10cSrcweir     class Struct;
53*cdf0e10cSrcweir     class Typedef;
54*cdf0e10cSrcweir 
55*cdf0e10cSrcweir     class Attribute;
56*cdf0e10cSrcweir     class Constant;
57*cdf0e10cSrcweir     class EnumValue;
58*cdf0e10cSrcweir     class Function;
59*cdf0e10cSrcweir     class Property;
60*cdf0e10cSrcweir     class StructElement;
61*cdf0e10cSrcweir     class Variable;
62*cdf0e10cSrcweir 
63*cdf0e10cSrcweir     class NameLookup;
64*cdf0e10cSrcweir 
65*cdf0e10cSrcweir 
66*cdf0e10cSrcweir /** Provides the access logic for all code entities.
67*cdf0e10cSrcweir */
68*cdf0e10cSrcweir class CePilot
69*cdf0e10cSrcweir {
70*cdf0e10cSrcweir   public:
71*cdf0e10cSrcweir     // LIFECYCLE
72*cdf0e10cSrcweir     virtual             ~CePilot() {}
73*cdf0e10cSrcweir 
74*cdf0e10cSrcweir     // OPERATIONS
75*cdf0e10cSrcweir     virtual Module &    CheckIn_Module(
76*cdf0e10cSrcweir                             Ce_id               i_nParentId,
77*cdf0e10cSrcweir                             const String &      i_sName ) = 0;
78*cdf0e10cSrcweir     virtual Service &   Store_Service(
79*cdf0e10cSrcweir                             Ce_id               i_nOwner,
80*cdf0e10cSrcweir                             const String &      i_sName ) = 0;
81*cdf0e10cSrcweir     virtual SglIfcService &
82*cdf0e10cSrcweir                         Store_SglIfcService(
83*cdf0e10cSrcweir                             Ce_id               i_nOwner,
84*cdf0e10cSrcweir                             const String &      i_sName,
85*cdf0e10cSrcweir                             Type_id             i_nBaseInterface ) = 0;
86*cdf0e10cSrcweir     virtual Interface & Store_Interface(
87*cdf0e10cSrcweir                             Ce_id               i_nOwner,
88*cdf0e10cSrcweir                             const String &      i_sName,
89*cdf0e10cSrcweir                             Type_id             i_nBase ) = 0;
90*cdf0e10cSrcweir     virtual Struct &    Store_Struct(
91*cdf0e10cSrcweir                             Ce_id               i_nOwner,
92*cdf0e10cSrcweir                             const String &      i_sName,
93*cdf0e10cSrcweir                             Type_id             i_nBase,
94*cdf0e10cSrcweir                             const String &      i_sTemplateParam = String::Null_() ) = 0;
95*cdf0e10cSrcweir     virtual Exception & Store_Exception(
96*cdf0e10cSrcweir                             Ce_id               i_nOwner,
97*cdf0e10cSrcweir                             const String &      i_sName,
98*cdf0e10cSrcweir                             Type_id             i_nBase ) = 0;
99*cdf0e10cSrcweir     virtual Enum &      Store_Enum(
100*cdf0e10cSrcweir                             Ce_id               i_nOwner,
101*cdf0e10cSrcweir                             const String &      i_sName ) = 0;
102*cdf0e10cSrcweir     virtual Typedef &   Store_Typedef(
103*cdf0e10cSrcweir                             Ce_id               i_nOwner,
104*cdf0e10cSrcweir                             const String &      i_sName,
105*cdf0e10cSrcweir                             Type_id             i_nDefiningType ) = 0;
106*cdf0e10cSrcweir     virtual ConstantsGroup &
107*cdf0e10cSrcweir                         Store_ConstantsGroup(
108*cdf0e10cSrcweir                             Ce_id               i_nOwner,
109*cdf0e10cSrcweir                             const String &      i_sName ) = 0;
110*cdf0e10cSrcweir     virtual Singleton & Store_Singleton(
111*cdf0e10cSrcweir                             Ce_id               i_nOwner,
112*cdf0e10cSrcweir                             const String &      i_sName ) = 0;
113*cdf0e10cSrcweir     virtual SglIfcSingleton &
114*cdf0e10cSrcweir                         Store_SglIfcSingleton(
115*cdf0e10cSrcweir                             Ce_id               i_nOwner,
116*cdf0e10cSrcweir                             const String &      i_sName,
117*cdf0e10cSrcweir                             Type_id             i_nBaseInterface ) = 0;
118*cdf0e10cSrcweir 
119*cdf0e10cSrcweir     virtual Constant &  Store_Constant(
120*cdf0e10cSrcweir                             Ce_id               i_nOwner,
121*cdf0e10cSrcweir                             const String &      i_sName,
122*cdf0e10cSrcweir                             Type_id             i_nType,
123*cdf0e10cSrcweir                             const String &      i_sValue ) = 0;
124*cdf0e10cSrcweir     virtual Property &  Store_Property(
125*cdf0e10cSrcweir                             Ce_id               i_nOwner,
126*cdf0e10cSrcweir                             const String &      i_sName,
127*cdf0e10cSrcweir                             Type_id             i_nType,
128*cdf0e10cSrcweir                             Property::Stereotypes
129*cdf0e10cSrcweir                                                 i_stereotypes ) = 0;
130*cdf0e10cSrcweir     virtual Function &  Store_Function(
131*cdf0e10cSrcweir                             Ce_id               i_nOwner,
132*cdf0e10cSrcweir                             const String &      i_sName,
133*cdf0e10cSrcweir                             Type_id             i_nReturnType,
134*cdf0e10cSrcweir                             bool                i_bOneWay ) = 0;
135*cdf0e10cSrcweir     virtual Function &  Store_ServiceConstructor(
136*cdf0e10cSrcweir                             Ce_id               i_nOwner,
137*cdf0e10cSrcweir                             const String &      i_sName ) = 0;
138*cdf0e10cSrcweir     virtual StructElement &
139*cdf0e10cSrcweir                         Store_StructMember(
140*cdf0e10cSrcweir                             Ce_id               i_nOwner,
141*cdf0e10cSrcweir                             const String &      i_sName,
142*cdf0e10cSrcweir                             Type_id             i_nType ) = 0;
143*cdf0e10cSrcweir     virtual StructElement &
144*cdf0e10cSrcweir                         Store_ExceptionMember(
145*cdf0e10cSrcweir                             Ce_id               i_nOwner,
146*cdf0e10cSrcweir                             const String &      i_sName,
147*cdf0e10cSrcweir                             Type_id             i_nType ) = 0;
148*cdf0e10cSrcweir     virtual EnumValue & Store_EnumValue(
149*cdf0e10cSrcweir                             Ce_id               i_nOwner,
150*cdf0e10cSrcweir                             const String &      i_sName,
151*cdf0e10cSrcweir                             const String &      i_sValue ) = 0;
152*cdf0e10cSrcweir     virtual Attribute & Store_Attribute(
153*cdf0e10cSrcweir                             Ce_id               i_nOwner,
154*cdf0e10cSrcweir                             const String &      i_sName,
155*cdf0e10cSrcweir                             Type_id             i_nType,
156*cdf0e10cSrcweir                             bool                i_bReadOnly,
157*cdf0e10cSrcweir                             bool                i_bBound ) = 0;
158*cdf0e10cSrcweir     // INQUIRY
159*cdf0e10cSrcweir     virtual const Module &
160*cdf0e10cSrcweir                         GlobalNamespace() const = 0;
161*cdf0e10cSrcweir     virtual const CodeEntity &
162*cdf0e10cSrcweir                         Find_Ce(
163*cdf0e10cSrcweir                             Ce_id               i_nId ) const = 0;
164*cdf0e10cSrcweir 
165*cdf0e10cSrcweir     virtual const Module &
166*cdf0e10cSrcweir                         Find_Module(
167*cdf0e10cSrcweir                             Ce_id               i_nId ) const = 0;
168*cdf0e10cSrcweir     virtual const Module *
169*cdf0e10cSrcweir                         Search_Module(
170*cdf0e10cSrcweir                             Ce_id               i_nId ) const = 0;
171*cdf0e10cSrcweir     virtual const Function &
172*cdf0e10cSrcweir                         Find_Function(
173*cdf0e10cSrcweir                             Ce_id               i_nId ) const = 0;
174*cdf0e10cSrcweir     virtual const Property &
175*cdf0e10cSrcweir                         Find_Property(
176*cdf0e10cSrcweir                             Ce_id               i_nId ) const = 0;
177*cdf0e10cSrcweir     virtual const EnumValue &
178*cdf0e10cSrcweir                         Find_EnumValue(
179*cdf0e10cSrcweir                             Ce_id               i_nId ) const = 0;
180*cdf0e10cSrcweir     virtual const Constant &
181*cdf0e10cSrcweir                         Find_Constant(
182*cdf0e10cSrcweir                             Ce_id               i_nId ) const = 0;
183*cdf0e10cSrcweir     virtual const StructElement &
184*cdf0e10cSrcweir                         Find_StructElement(
185*cdf0e10cSrcweir                             Ce_id               i_nId ) const = 0;
186*cdf0e10cSrcweir     virtual void        Get_Text(
187*cdf0e10cSrcweir                             StringVector &      o_module,
188*cdf0e10cSrcweir                             String &            o_ce,
189*cdf0e10cSrcweir                             String &            o_member,
190*cdf0e10cSrcweir                             const CodeEntity &  i_ce ) const = 0;
191*cdf0e10cSrcweir     virtual const NameLookup &
192*cdf0e10cSrcweir                         NameDictionary() const = 0;
193*cdf0e10cSrcweir     virtual void        Get_AlphabeticalIndex(
194*cdf0e10cSrcweir                             std::vector<Ce_id> &
195*cdf0e10cSrcweir                                                 o_rResult,
196*cdf0e10cSrcweir                             alphabetical_index::E_Letter
197*cdf0e10cSrcweir                                                 i_cLetter) const = 0;
198*cdf0e10cSrcweir     // ACCESS
199*cdf0e10cSrcweir     virtual Module &    GlobalNamespace() = 0;
200*cdf0e10cSrcweir     virtual CodeEntity &
201*cdf0e10cSrcweir                         Find_Ce(
202*cdf0e10cSrcweir                             Ce_id               i_nId ) = 0;
203*cdf0e10cSrcweir };
204*cdf0e10cSrcweir 
205*cdf0e10cSrcweir 
206*cdf0e10cSrcweir 
207*cdf0e10cSrcweir 
208*cdf0e10cSrcweir }   // namespace idl
209*cdf0e10cSrcweir }   // namespace ary
210*cdf0e10cSrcweir #endif
211