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 ARY_IDL_IP_CE_HXX 25cdf0e10cSrcweir #define ARY_IDL_IP_CE_HXX 26cdf0e10cSrcweir 27cdf0e10cSrcweir // USED SERVICES 28cdf0e10cSrcweir #include <ary/idl/i_types4idl.hxx> 29cdf0e10cSrcweir #include <ary/idl/i_property.hxx> 30cdf0e10cSrcweir 31cdf0e10cSrcweir 32cdf0e10cSrcweir 33cdf0e10cSrcweir 34cdf0e10cSrcweir namespace ary 35cdf0e10cSrcweir { 36cdf0e10cSrcweir namespace idl 37cdf0e10cSrcweir { 38cdf0e10cSrcweir class Module; 39cdf0e10cSrcweir 40cdf0e10cSrcweir class ConstantsGroup; 41cdf0e10cSrcweir class Enum; 42cdf0e10cSrcweir class Exception; 43cdf0e10cSrcweir class Interface; 44cdf0e10cSrcweir class Service; 45cdf0e10cSrcweir class SglIfcService; 46cdf0e10cSrcweir class Singleton; 47cdf0e10cSrcweir class SglIfcSingleton; 48cdf0e10cSrcweir class Struct; 49cdf0e10cSrcweir class Typedef; 50cdf0e10cSrcweir 51cdf0e10cSrcweir class Attribute; 52cdf0e10cSrcweir class Constant; 53cdf0e10cSrcweir class EnumValue; 54cdf0e10cSrcweir class Function; 55cdf0e10cSrcweir class Property; 56cdf0e10cSrcweir class StructElement; 57cdf0e10cSrcweir class Variable; 58cdf0e10cSrcweir 59cdf0e10cSrcweir class NameLookup; 60cdf0e10cSrcweir 61cdf0e10cSrcweir 62cdf0e10cSrcweir /** Provides the access logic for all code entities. 63cdf0e10cSrcweir */ 64cdf0e10cSrcweir class CePilot 65cdf0e10cSrcweir { 66cdf0e10cSrcweir public: 67cdf0e10cSrcweir // LIFECYCLE ~CePilot()68cdf0e10cSrcweir virtual ~CePilot() {} 69cdf0e10cSrcweir 70cdf0e10cSrcweir // OPERATIONS 71cdf0e10cSrcweir virtual Module & CheckIn_Module( 72cdf0e10cSrcweir Ce_id i_nParentId, 73cdf0e10cSrcweir const String & i_sName ) = 0; 74cdf0e10cSrcweir virtual Service & Store_Service( 75cdf0e10cSrcweir Ce_id i_nOwner, 76cdf0e10cSrcweir const String & i_sName ) = 0; 77cdf0e10cSrcweir virtual SglIfcService & 78cdf0e10cSrcweir Store_SglIfcService( 79cdf0e10cSrcweir Ce_id i_nOwner, 80cdf0e10cSrcweir const String & i_sName, 81cdf0e10cSrcweir Type_id i_nBaseInterface ) = 0; 82cdf0e10cSrcweir virtual Interface & Store_Interface( 83cdf0e10cSrcweir Ce_id i_nOwner, 84cdf0e10cSrcweir const String & i_sName, 85cdf0e10cSrcweir Type_id i_nBase ) = 0; 86cdf0e10cSrcweir virtual Struct & Store_Struct( 87cdf0e10cSrcweir Ce_id i_nOwner, 88cdf0e10cSrcweir const String & i_sName, 89cdf0e10cSrcweir Type_id i_nBase, 90cdf0e10cSrcweir const String & i_sTemplateParam = String::Null_() ) = 0; 91cdf0e10cSrcweir virtual Exception & Store_Exception( 92cdf0e10cSrcweir Ce_id i_nOwner, 93cdf0e10cSrcweir const String & i_sName, 94cdf0e10cSrcweir Type_id i_nBase ) = 0; 95cdf0e10cSrcweir virtual Enum & Store_Enum( 96cdf0e10cSrcweir Ce_id i_nOwner, 97cdf0e10cSrcweir const String & i_sName ) = 0; 98cdf0e10cSrcweir virtual Typedef & Store_Typedef( 99cdf0e10cSrcweir Ce_id i_nOwner, 100cdf0e10cSrcweir const String & i_sName, 101cdf0e10cSrcweir Type_id i_nDefiningType ) = 0; 102cdf0e10cSrcweir virtual ConstantsGroup & 103cdf0e10cSrcweir Store_ConstantsGroup( 104cdf0e10cSrcweir Ce_id i_nOwner, 105cdf0e10cSrcweir const String & i_sName ) = 0; 106cdf0e10cSrcweir virtual Singleton & Store_Singleton( 107cdf0e10cSrcweir Ce_id i_nOwner, 108cdf0e10cSrcweir const String & i_sName ) = 0; 109cdf0e10cSrcweir virtual SglIfcSingleton & 110cdf0e10cSrcweir Store_SglIfcSingleton( 111cdf0e10cSrcweir Ce_id i_nOwner, 112cdf0e10cSrcweir const String & i_sName, 113cdf0e10cSrcweir Type_id i_nBaseInterface ) = 0; 114cdf0e10cSrcweir 115cdf0e10cSrcweir virtual Constant & Store_Constant( 116cdf0e10cSrcweir Ce_id i_nOwner, 117cdf0e10cSrcweir const String & i_sName, 118cdf0e10cSrcweir Type_id i_nType, 119cdf0e10cSrcweir const String & i_sValue ) = 0; 120cdf0e10cSrcweir virtual Property & Store_Property( 121cdf0e10cSrcweir Ce_id i_nOwner, 122cdf0e10cSrcweir const String & i_sName, 123cdf0e10cSrcweir Type_id i_nType, 124cdf0e10cSrcweir Property::Stereotypes 125cdf0e10cSrcweir i_stereotypes ) = 0; 126cdf0e10cSrcweir virtual Function & Store_Function( 127cdf0e10cSrcweir Ce_id i_nOwner, 128cdf0e10cSrcweir const String & i_sName, 129cdf0e10cSrcweir Type_id i_nReturnType, 130cdf0e10cSrcweir bool i_bOneWay ) = 0; 131cdf0e10cSrcweir virtual Function & Store_ServiceConstructor( 132cdf0e10cSrcweir Ce_id i_nOwner, 133cdf0e10cSrcweir const String & i_sName ) = 0; 134cdf0e10cSrcweir virtual StructElement & 135cdf0e10cSrcweir Store_StructMember( 136cdf0e10cSrcweir Ce_id i_nOwner, 137cdf0e10cSrcweir const String & i_sName, 138cdf0e10cSrcweir Type_id i_nType ) = 0; 139cdf0e10cSrcweir virtual StructElement & 140cdf0e10cSrcweir Store_ExceptionMember( 141cdf0e10cSrcweir Ce_id i_nOwner, 142cdf0e10cSrcweir const String & i_sName, 143cdf0e10cSrcweir Type_id i_nType ) = 0; 144cdf0e10cSrcweir virtual EnumValue & Store_EnumValue( 145cdf0e10cSrcweir Ce_id i_nOwner, 146cdf0e10cSrcweir const String & i_sName, 147cdf0e10cSrcweir const String & i_sValue ) = 0; 148cdf0e10cSrcweir virtual Attribute & Store_Attribute( 149cdf0e10cSrcweir Ce_id i_nOwner, 150cdf0e10cSrcweir const String & i_sName, 151cdf0e10cSrcweir Type_id i_nType, 152cdf0e10cSrcweir bool i_bReadOnly, 153cdf0e10cSrcweir bool i_bBound ) = 0; 154cdf0e10cSrcweir // INQUIRY 155cdf0e10cSrcweir virtual const Module & 156cdf0e10cSrcweir GlobalNamespace() const = 0; 157cdf0e10cSrcweir virtual const CodeEntity & 158cdf0e10cSrcweir Find_Ce( 159cdf0e10cSrcweir Ce_id i_nId ) const = 0; 160cdf0e10cSrcweir 161cdf0e10cSrcweir virtual const Module & 162cdf0e10cSrcweir Find_Module( 163cdf0e10cSrcweir Ce_id i_nId ) const = 0; 164cdf0e10cSrcweir virtual const Module * 165cdf0e10cSrcweir Search_Module( 166cdf0e10cSrcweir Ce_id i_nId ) const = 0; 167cdf0e10cSrcweir virtual const Function & 168cdf0e10cSrcweir Find_Function( 169cdf0e10cSrcweir Ce_id i_nId ) const = 0; 170cdf0e10cSrcweir virtual const Property & 171cdf0e10cSrcweir Find_Property( 172cdf0e10cSrcweir Ce_id i_nId ) const = 0; 173cdf0e10cSrcweir virtual const EnumValue & 174cdf0e10cSrcweir Find_EnumValue( 175cdf0e10cSrcweir Ce_id i_nId ) const = 0; 176cdf0e10cSrcweir virtual const Constant & 177cdf0e10cSrcweir Find_Constant( 178cdf0e10cSrcweir Ce_id i_nId ) const = 0; 179cdf0e10cSrcweir virtual const StructElement & 180cdf0e10cSrcweir Find_StructElement( 181cdf0e10cSrcweir Ce_id i_nId ) const = 0; 182cdf0e10cSrcweir virtual void Get_Text( 183cdf0e10cSrcweir StringVector & o_module, 184cdf0e10cSrcweir String & o_ce, 185cdf0e10cSrcweir String & o_member, 186cdf0e10cSrcweir const CodeEntity & i_ce ) const = 0; 187cdf0e10cSrcweir virtual const NameLookup & 188cdf0e10cSrcweir NameDictionary() const = 0; 189cdf0e10cSrcweir virtual void Get_AlphabeticalIndex( 190cdf0e10cSrcweir std::vector<Ce_id> & 191cdf0e10cSrcweir o_rResult, 192cdf0e10cSrcweir alphabetical_index::E_Letter 193cdf0e10cSrcweir i_cLetter) const = 0; 194cdf0e10cSrcweir // ACCESS 195cdf0e10cSrcweir virtual Module & GlobalNamespace() = 0; 196cdf0e10cSrcweir virtual CodeEntity & 197cdf0e10cSrcweir Find_Ce( 198cdf0e10cSrcweir Ce_id i_nId ) = 0; 199cdf0e10cSrcweir }; 200cdf0e10cSrcweir 201cdf0e10cSrcweir 202cdf0e10cSrcweir 203cdf0e10cSrcweir 204cdf0e10cSrcweir } // namespace idl 205cdf0e10cSrcweir } // namespace ary 206cdf0e10cSrcweir #endif 207