1*1c78a5d6SAndrew Rist /**************************************************************
2cdf0e10cSrcweir *
3*1c78a5d6SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one
4*1c78a5d6SAndrew Rist * or more contributor license agreements. See the NOTICE file
5*1c78a5d6SAndrew Rist * distributed with this work for additional information
6*1c78a5d6SAndrew Rist * regarding copyright ownership. The ASF licenses this file
7*1c78a5d6SAndrew Rist * to you under the Apache License, Version 2.0 (the
8*1c78a5d6SAndrew Rist * "License"); you may not use this file except in compliance
9*1c78a5d6SAndrew Rist * with the License. You may obtain a copy of the License at
10*1c78a5d6SAndrew Rist *
11*1c78a5d6SAndrew Rist * http://www.apache.org/licenses/LICENSE-2.0
12*1c78a5d6SAndrew Rist *
13*1c78a5d6SAndrew Rist * Unless required by applicable law or agreed to in writing,
14*1c78a5d6SAndrew Rist * software distributed under the License is distributed on an
15*1c78a5d6SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*1c78a5d6SAndrew Rist * KIND, either express or implied. See the License for the
17*1c78a5d6SAndrew Rist * specific language governing permissions and limitations
18*1c78a5d6SAndrew Rist * under the License.
19*1c78a5d6SAndrew Rist *
20*1c78a5d6SAndrew Rist *************************************************************/
21*1c78a5d6SAndrew Rist
22*1c78a5d6SAndrew Rist
23cdf0e10cSrcweir
24cdf0e10cSrcweir #ifndef ADC_CPP_PEV_HXX
25cdf0e10cSrcweir #define ADC_CPP_PEV_HXX
26cdf0e10cSrcweir
27cdf0e10cSrcweir
28cdf0e10cSrcweir
29cdf0e10cSrcweir // USED SERVICES
30cdf0e10cSrcweir // BASE CLASSES
31cdf0e10cSrcweir #include <tokens/tokproct.hxx>
32cdf0e10cSrcweir // COMPONENTS
33cdf0e10cSrcweir // PARAMETERS
34cdf0e10cSrcweir #include <ary/cpp/c_types4cpp.hxx>
35cdf0e10cSrcweir
36cdf0e10cSrcweir namespace ary
37cdf0e10cSrcweir {
38cdf0e10cSrcweir namespace cpp
39cdf0e10cSrcweir {
40cdf0e10cSrcweir class Gate;
41cdf0e10cSrcweir class InputContext;
42cdf0e10cSrcweir
43cdf0e10cSrcweir class Namespace;
44cdf0e10cSrcweir class Class;
45cdf0e10cSrcweir class Enum;
46cdf0e10cSrcweir class Typedef;
47cdf0e10cSrcweir class Function;
48cdf0e10cSrcweir class Variable;
49cdf0e10cSrcweir class EnumValue;
50cdf0e10cSrcweir
51cdf0e10cSrcweir class DefineEntity;
52cdf0e10cSrcweir }
53cdf0e10cSrcweir
54cdf0e10cSrcweir class Documentation;
55cdf0e10cSrcweir }
56cdf0e10cSrcweir
57cdf0e10cSrcweir
58cdf0e10cSrcweir namespace cpp
59cdf0e10cSrcweir {
60cdf0e10cSrcweir
61cdf0e10cSrcweir
62cdf0e10cSrcweir class PeEnvironment : protected TokenProcessing_Types
63cdf0e10cSrcweir {
64cdf0e10cSrcweir public:
65cdf0e10cSrcweir // INQUIRY
~PeEnvironment()66cdf0e10cSrcweir virtual ~PeEnvironment() {}
67cdf0e10cSrcweir
68cdf0e10cSrcweir // OPERATIONS
69cdf0e10cSrcweir // Token results
70cdf0e10cSrcweir void SetTokenResult(
71cdf0e10cSrcweir E_TokenDone i_eDone,
72cdf0e10cSrcweir E_EnvStackAction i_eWhat2DoWithEnvStack,
73cdf0e10cSrcweir ParseEnvironment * i_pParseEnv2Push = 0 );
74cdf0e10cSrcweir
75cdf0e10cSrcweir // Owner stack
76cdf0e10cSrcweir void OpenNamespace(
77cdf0e10cSrcweir ary::cpp::Namespace &
78cdf0e10cSrcweir io_rOpenedNamespace );
79cdf0e10cSrcweir void OpenExternC(
80cdf0e10cSrcweir bool i_bOnlyForOneDeclaration = false );
81cdf0e10cSrcweir void OpenClass(
82cdf0e10cSrcweir ary::cpp::Class & io_rOpenedClass );
83cdf0e10cSrcweir void OpenEnum(
84cdf0e10cSrcweir ary::cpp::Enum & io_rOpenedEnum );
85cdf0e10cSrcweir void CloseBlock(); /// Handles a '}' on file scope.
86cdf0e10cSrcweir void CloseClass();
87cdf0e10cSrcweir void CloseEnum();
88cdf0e10cSrcweir void SetCurProtection( /// Handles 'public:', 'protected:' and 'private:' on class scope.
89cdf0e10cSrcweir ary::cpp::E_Protection
90cdf0e10cSrcweir i_eProtection );
91cdf0e10cSrcweir void OpenTemplate(
92cdf0e10cSrcweir const StringVector &
93cdf0e10cSrcweir i_rParameters );
94cdf0e10cSrcweir /// Removes parameters from this object.
95cdf0e10cSrcweir DYN StringVector * Get_CurTemplateParameters();
96cdf0e10cSrcweir /// Checks, if a template is still open, and if yes, closes it.
97cdf0e10cSrcweir void Close_OpenTemplate();
98cdf0e10cSrcweir
99cdf0e10cSrcweir // Special events
100cdf0e10cSrcweir void Event_Class_FinishedBase(
101cdf0e10cSrcweir const String & i_sParameterName );
102cdf0e10cSrcweir
103cdf0e10cSrcweir void Event_Store_Typedef(
104cdf0e10cSrcweir ary::cpp::Typedef & io_rTypedef );
105cdf0e10cSrcweir void Event_Store_EnumValue(
106cdf0e10cSrcweir ary::cpp::EnumValue &
107cdf0e10cSrcweir io_rEnumValue );
108cdf0e10cSrcweir void Event_Store_CppDefinition(
109cdf0e10cSrcweir ary::cpp::DefineEntity &
110cdf0e10cSrcweir io_rDefinition );
111cdf0e10cSrcweir
112cdf0e10cSrcweir void Event_EnterFunction_ParameterList();
113cdf0e10cSrcweir void Event_Function_FinishedParameter(
114cdf0e10cSrcweir const String & i_sParameterName );
115cdf0e10cSrcweir void Event_LeaveFunction_ParameterList();
116cdf0e10cSrcweir void Event_EnterFunction_Implementation();
117cdf0e10cSrcweir void Event_LeaveFunction_Implementation();
118cdf0e10cSrcweir
119cdf0e10cSrcweir void Event_Store_Function(
120cdf0e10cSrcweir ary::cpp::Function &
121cdf0e10cSrcweir io_rFunction );
122cdf0e10cSrcweir void Event_Store_Variable(
123cdf0e10cSrcweir ary::cpp::Variable &
124cdf0e10cSrcweir io_rVariable );
125cdf0e10cSrcweir // Error recovery
126cdf0e10cSrcweir void StartWaitingFor_Recovery();
127cdf0e10cSrcweir
128cdf0e10cSrcweir // INQUIRY
129cdf0e10cSrcweir ary::cpp::Gate & AryGate() const;
130cdf0e10cSrcweir const ary::cpp::InputContext &
131cdf0e10cSrcweir Context() const;
132cdf0e10cSrcweir String CurFileName() const;
133cdf0e10cSrcweir uintt LineCount() const;
134cdf0e10cSrcweir bool IsWaitingFor_Recovery() const;
135cdf0e10cSrcweir bool IsExternC() const;
136cdf0e10cSrcweir
137cdf0e10cSrcweir private:
138cdf0e10cSrcweir virtual void do_SetTokenResult(
139cdf0e10cSrcweir E_TokenDone i_eDone,
140cdf0e10cSrcweir E_EnvStackAction i_eWhat2DoWithEnvStack,
141cdf0e10cSrcweir ParseEnvironment * i_pParseEnv2Push ) = 0;
142cdf0e10cSrcweir virtual void do_OpenNamespace(
143cdf0e10cSrcweir ary::cpp::Namespace &
144cdf0e10cSrcweir io_rOpenedNamespace ) = 0;
145cdf0e10cSrcweir virtual void do_OpenExternC(
146cdf0e10cSrcweir bool i_bOnlyForOneDeclaration ) = 0;
147cdf0e10cSrcweir virtual void do_OpenClass(
148cdf0e10cSrcweir ary::cpp::Class & io_rOpenedClass ) = 0;
149cdf0e10cSrcweir virtual void do_OpenEnum(
150cdf0e10cSrcweir ary::cpp::Enum & io_rOpenedEnum ) = 0;
151cdf0e10cSrcweir virtual void do_CloseBlock() = 0;
152cdf0e10cSrcweir virtual void do_CloseClass() = 0;
153cdf0e10cSrcweir virtual void do_CloseEnum() = 0;
154cdf0e10cSrcweir virtual void do_SetCurProtection(
155cdf0e10cSrcweir ary::cpp::E_Protection
156cdf0e10cSrcweir i_eProtection ) = 0;
157cdf0e10cSrcweir virtual void do_OpenTemplate(
158cdf0e10cSrcweir const StringVector &
159cdf0e10cSrcweir i_rParameters ) = 0;
160cdf0e10cSrcweir virtual DYN StringVector *
161cdf0e10cSrcweir do_Get_CurTemplateParameters() = 0;
162cdf0e10cSrcweir virtual void do_Close_OpenTemplate() = 0;
163cdf0e10cSrcweir virtual void do_Event_Class_FinishedBase(
164cdf0e10cSrcweir const String & i_sBaseName ) = 0;
165cdf0e10cSrcweir
166cdf0e10cSrcweir virtual void do_Event_Store_Typedef(
167cdf0e10cSrcweir ary::cpp::Typedef & io_rTypedef ) = 0;
168cdf0e10cSrcweir virtual void do_Event_Store_EnumValue(
169cdf0e10cSrcweir ary::cpp::EnumValue &
170cdf0e10cSrcweir io_rEnumValue ) = 0;
171cdf0e10cSrcweir virtual void do_Event_Store_CppDefinition(
172cdf0e10cSrcweir ary::cpp::DefineEntity &
173cdf0e10cSrcweir io_rDefinition ) = 0;
174cdf0e10cSrcweir virtual void do_Event_EnterFunction_ParameterList() = 0;
175cdf0e10cSrcweir virtual void do_Event_Function_FinishedParameter(
176cdf0e10cSrcweir const String & i_sParameterName ) = 0;
177cdf0e10cSrcweir virtual void do_Event_LeaveFunction_ParameterList() = 0;
178cdf0e10cSrcweir virtual void do_Event_EnterFunction_Implementation() = 0;
179cdf0e10cSrcweir virtual void do_Event_LeaveFunction_Implementation() = 0;
180cdf0e10cSrcweir virtual void do_Event_Store_Function(
181cdf0e10cSrcweir ary::cpp::Function &
182cdf0e10cSrcweir io_rFunction ) = 0;
183cdf0e10cSrcweir virtual void do_Event_Store_Variable(
184cdf0e10cSrcweir ary::cpp::Variable &
185cdf0e10cSrcweir io_rVariable ) = 0;
186cdf0e10cSrcweir virtual void do_StartWaitingFor_Recovery() = 0;
187cdf0e10cSrcweir virtual ary::cpp::Gate &
188cdf0e10cSrcweir inq_AryGate() const = 0;
189cdf0e10cSrcweir virtual const ary::cpp::InputContext &
190cdf0e10cSrcweir inq_Context() const = 0;
191cdf0e10cSrcweir virtual String inq_CurFileName() const = 0;
192cdf0e10cSrcweir virtual uintt inq_LineCount() const = 0;
193cdf0e10cSrcweir virtual bool inq_IsWaitingFor_Recovery() const = 0;
194cdf0e10cSrcweir virtual bool inq_IsExternC() const = 0;
195cdf0e10cSrcweir };
196cdf0e10cSrcweir
197cdf0e10cSrcweir
198cdf0e10cSrcweir
199cdf0e10cSrcweir // IMPLEMENTATION
200cdf0e10cSrcweir
201cdf0e10cSrcweir inline void
SetTokenResult(E_TokenDone i_eDone,E_EnvStackAction i_eWhat2DoWithEnvStack,ParseEnvironment * i_pParseEnv2Push)202cdf0e10cSrcweir PeEnvironment::SetTokenResult( E_TokenDone i_eDone,
203cdf0e10cSrcweir E_EnvStackAction i_eWhat2DoWithEnvStack,
204cdf0e10cSrcweir ParseEnvironment * i_pParseEnv2Push )
205cdf0e10cSrcweir { do_SetTokenResult(i_eDone, i_eWhat2DoWithEnvStack, i_pParseEnv2Push); }
206cdf0e10cSrcweir inline void
OpenNamespace(ary::cpp::Namespace & io_rOpenedNamespace)207cdf0e10cSrcweir PeEnvironment::OpenNamespace( ary::cpp::Namespace & io_rOpenedNamespace )
208cdf0e10cSrcweir { do_OpenNamespace(io_rOpenedNamespace); }
209cdf0e10cSrcweir inline void
OpenExternC(bool i_bOnlyForOneDeclaration)210cdf0e10cSrcweir PeEnvironment::OpenExternC( bool i_bOnlyForOneDeclaration )
211cdf0e10cSrcweir { do_OpenExternC(i_bOnlyForOneDeclaration); }
212cdf0e10cSrcweir inline void
OpenClass(ary::cpp::Class & io_rOpenedClass)213cdf0e10cSrcweir PeEnvironment::OpenClass( ary::cpp::Class & io_rOpenedClass )
214cdf0e10cSrcweir { do_OpenClass(io_rOpenedClass); }
215cdf0e10cSrcweir inline void
OpenEnum(ary::cpp::Enum & io_rOpenedEnum)216cdf0e10cSrcweir PeEnvironment::OpenEnum( ary::cpp::Enum & io_rOpenedEnum )
217cdf0e10cSrcweir { do_OpenEnum(io_rOpenedEnum); }
218cdf0e10cSrcweir inline void
CloseBlock()219cdf0e10cSrcweir PeEnvironment::CloseBlock()
220cdf0e10cSrcweir { do_CloseBlock(); }
221cdf0e10cSrcweir inline void
CloseClass()222cdf0e10cSrcweir PeEnvironment::CloseClass()
223cdf0e10cSrcweir { do_CloseClass(); }
224cdf0e10cSrcweir inline void
CloseEnum()225cdf0e10cSrcweir PeEnvironment::CloseEnum()
226cdf0e10cSrcweir { do_CloseEnum(); }
227cdf0e10cSrcweir inline void
SetCurProtection(ary::cpp::E_Protection i_eProtection)228cdf0e10cSrcweir PeEnvironment::SetCurProtection( ary::cpp::E_Protection i_eProtection )
229cdf0e10cSrcweir { do_SetCurProtection(i_eProtection); }
230cdf0e10cSrcweir inline void
OpenTemplate(const StringVector & i_rParameters)231cdf0e10cSrcweir PeEnvironment::OpenTemplate( const StringVector & i_rParameters )
232cdf0e10cSrcweir { do_OpenTemplate(i_rParameters); }
233cdf0e10cSrcweir inline DYN StringVector *
Get_CurTemplateParameters()234cdf0e10cSrcweir PeEnvironment::Get_CurTemplateParameters()
235cdf0e10cSrcweir { return do_Get_CurTemplateParameters(); }
236cdf0e10cSrcweir inline void
Close_OpenTemplate()237cdf0e10cSrcweir PeEnvironment::Close_OpenTemplate()
238cdf0e10cSrcweir { do_Close_OpenTemplate(); }
239cdf0e10cSrcweir inline void
Event_Class_FinishedBase(const String & i_sBaseName)240cdf0e10cSrcweir PeEnvironment::Event_Class_FinishedBase( const String & i_sBaseName )
241cdf0e10cSrcweir { do_Event_Class_FinishedBase(i_sBaseName); }
242cdf0e10cSrcweir inline void
Event_Store_Typedef(ary::cpp::Typedef & io_rTypedef)243cdf0e10cSrcweir PeEnvironment::Event_Store_Typedef( ary::cpp::Typedef & io_rTypedef )
244cdf0e10cSrcweir { do_Event_Store_Typedef(io_rTypedef); }
245cdf0e10cSrcweir inline void
Event_Store_EnumValue(ary::cpp::EnumValue & io_rEnumValue)246cdf0e10cSrcweir PeEnvironment::Event_Store_EnumValue( ary::cpp::EnumValue & io_rEnumValue )
247cdf0e10cSrcweir { do_Event_Store_EnumValue(io_rEnumValue); }
248cdf0e10cSrcweir inline void
Event_Store_CppDefinition(ary::cpp::DefineEntity & io_rDefinition)249cdf0e10cSrcweir PeEnvironment::Event_Store_CppDefinition( ary::cpp::DefineEntity & io_rDefinition )
250cdf0e10cSrcweir { do_Event_Store_CppDefinition(io_rDefinition); }
251cdf0e10cSrcweir inline void
Event_EnterFunction_ParameterList()252cdf0e10cSrcweir PeEnvironment::Event_EnterFunction_ParameterList()
253cdf0e10cSrcweir { do_Event_EnterFunction_ParameterList(); }
254cdf0e10cSrcweir inline void
Event_Function_FinishedParameter(const String & i_sParameterName)255cdf0e10cSrcweir PeEnvironment::Event_Function_FinishedParameter( const String & i_sParameterName )
256cdf0e10cSrcweir { do_Event_Function_FinishedParameter(i_sParameterName); }
257cdf0e10cSrcweir inline void
Event_LeaveFunction_ParameterList()258cdf0e10cSrcweir PeEnvironment::Event_LeaveFunction_ParameterList()
259cdf0e10cSrcweir { do_Event_LeaveFunction_ParameterList(); }
260cdf0e10cSrcweir inline void
Event_EnterFunction_Implementation()261cdf0e10cSrcweir PeEnvironment::Event_EnterFunction_Implementation()
262cdf0e10cSrcweir { do_Event_EnterFunction_Implementation(); }
263cdf0e10cSrcweir inline void
Event_LeaveFunction_Implementation()264cdf0e10cSrcweir PeEnvironment::Event_LeaveFunction_Implementation()
265cdf0e10cSrcweir { do_Event_LeaveFunction_Implementation(); }
266cdf0e10cSrcweir inline void
Event_Store_Function(ary::cpp::Function & io_rFunction)267cdf0e10cSrcweir PeEnvironment::Event_Store_Function( ary::cpp::Function & io_rFunction )
268cdf0e10cSrcweir { do_Event_Store_Function(io_rFunction); }
269cdf0e10cSrcweir inline void
Event_Store_Variable(ary::cpp::Variable & io_rVariable)270cdf0e10cSrcweir PeEnvironment::Event_Store_Variable( ary::cpp::Variable & io_rVariable )
271cdf0e10cSrcweir { do_Event_Store_Variable(io_rVariable); }
272cdf0e10cSrcweir inline void
StartWaitingFor_Recovery()273cdf0e10cSrcweir PeEnvironment::StartWaitingFor_Recovery()
274cdf0e10cSrcweir { do_StartWaitingFor_Recovery(); }
275cdf0e10cSrcweir inline ary::cpp::Gate &
AryGate() const276cdf0e10cSrcweir PeEnvironment::AryGate() const
277cdf0e10cSrcweir { return inq_AryGate(); }
278cdf0e10cSrcweir inline const ary::cpp::InputContext &
Context() const279cdf0e10cSrcweir PeEnvironment::Context() const
280cdf0e10cSrcweir { return inq_Context(); }
281cdf0e10cSrcweir inline String
CurFileName() const282cdf0e10cSrcweir PeEnvironment::CurFileName() const
283cdf0e10cSrcweir { return inq_CurFileName(); }
284cdf0e10cSrcweir inline uintt
LineCount() const285cdf0e10cSrcweir PeEnvironment::LineCount() const
286cdf0e10cSrcweir { return inq_LineCount(); }
287cdf0e10cSrcweir inline bool
IsWaitingFor_Recovery() const288cdf0e10cSrcweir PeEnvironment::IsWaitingFor_Recovery() const
289cdf0e10cSrcweir { return inq_IsWaitingFor_Recovery(); }
290cdf0e10cSrcweir inline bool
IsExternC() const291cdf0e10cSrcweir PeEnvironment::IsExternC() const
292cdf0e10cSrcweir { return inq_IsExternC(); }
293cdf0e10cSrcweir
294cdf0e10cSrcweir
295cdf0e10cSrcweir
296cdf0e10cSrcweir } // namespace cpp
297cdf0e10cSrcweir
298cdf0e10cSrcweir
299cdf0e10cSrcweir #endif
300cdf0e10cSrcweir
301