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_CPP_C_FUNCT_HXX
25cdf0e10cSrcweir #define ARY_CPP_C_FUNCT_HXX
26cdf0e10cSrcweir
27cdf0e10cSrcweir
28cdf0e10cSrcweir
29cdf0e10cSrcweir // USED SERVICES
30cdf0e10cSrcweir // BASE CLASSES
31cdf0e10cSrcweir #include <ary/cpp/c_ce.hxx>
32cdf0e10cSrcweir // OTHER
33cdf0e10cSrcweir #include <ary/cessentl.hxx>
34cdf0e10cSrcweir #include <ary/cpp/c_types4cpp.hxx>
35cdf0e10cSrcweir #include <ary/cpp/c_slntry.hxx>
36cdf0e10cSrcweir #include <ary/cpp/c_vfflag.hxx>
37cdf0e10cSrcweir #include <ary/cpp/c_osigna.hxx>
38cdf0e10cSrcweir
39cdf0e10cSrcweir
40cdf0e10cSrcweir
41cdf0e10cSrcweir
42cdf0e10cSrcweir namespace ary
43cdf0e10cSrcweir {
44cdf0e10cSrcweir namespace cpp
45cdf0e10cSrcweir {
46cdf0e10cSrcweir
47cdf0e10cSrcweir
48cdf0e10cSrcweir
49cdf0e10cSrcweir /** A C++ function declaration.
50cdf0e10cSrcweir */
51cdf0e10cSrcweir class Function : public CodeEntity
52cdf0e10cSrcweir {
53cdf0e10cSrcweir public:
54cdf0e10cSrcweir enum E_ClassId { class_id = 1004 };
55cdf0e10cSrcweir
56cdf0e10cSrcweir Function(
57cdf0e10cSrcweir const String & i_sLocalName,
58cdf0e10cSrcweir Ce_id i_nOwner,
59cdf0e10cSrcweir E_Protection i_eProtection,
60cdf0e10cSrcweir loc::Le_id i_nFile,
61cdf0e10cSrcweir Type_id i_nReturnType,
62cdf0e10cSrcweir const std::vector<S_Parameter> &
63cdf0e10cSrcweir i_parameters,
64cdf0e10cSrcweir E_ConVol i_conVol,
65cdf0e10cSrcweir E_Virtuality i_eVirtuality,
66cdf0e10cSrcweir FunctionFlags i_aFlags,
67cdf0e10cSrcweir bool i_bThrowExists,
68cdf0e10cSrcweir const std::vector<Type_id> &
69cdf0e10cSrcweir i_rExceptions );
70cdf0e10cSrcweir ~Function();
71cdf0e10cSrcweir
72cdf0e10cSrcweir
73cdf0e10cSrcweir // OPERATIONS
74cdf0e10cSrcweir void Add_TemplateParameterType(
75cdf0e10cSrcweir const String & i_sLocalName,
76cdf0e10cSrcweir Type_id i_nIdAsType );
77cdf0e10cSrcweir
78cdf0e10cSrcweir // INQUIRY
79cdf0e10cSrcweir const OperationSignature &
80cdf0e10cSrcweir Signature() const;
81cdf0e10cSrcweir Type_id ReturnType() const;
Protection() const82cdf0e10cSrcweir E_Protection Protection() const { return eProtection; }
Virtuality() const83cdf0e10cSrcweir E_Virtuality Virtuality() const { return eVirtuality; }
84cdf0e10cSrcweir const FunctionFlags &
Flags() const85cdf0e10cSrcweir Flags() const { return aFlags; }
86cdf0e10cSrcweir const StringVector &
ParamInfos() const87cdf0e10cSrcweir ParamInfos() const { return aParameterInfos; }
88cdf0e10cSrcweir const std::vector<Type_id> *
Exceptions() const89cdf0e10cSrcweir Exceptions() const { return pExceptions.Ptr(); }
90cdf0e10cSrcweir
91cdf0e10cSrcweir const List_TplParam &
TemplateParameters() const92cdf0e10cSrcweir TemplateParameters() const
93cdf0e10cSrcweir { return aTemplateParameterTypes; }
94cdf0e10cSrcweir bool IsIdentical(
95cdf0e10cSrcweir const Function & i_f ) const;
96cdf0e10cSrcweir
97cdf0e10cSrcweir private:
98cdf0e10cSrcweir // Interface csv::ConstProcessorClient
99cdf0e10cSrcweir virtual void do_Accept(
100cdf0e10cSrcweir csv::ProcessorIfc & io_processor ) const;
101cdf0e10cSrcweir
102cdf0e10cSrcweir // Interface ary::cpp::CodeEntity
103cdf0e10cSrcweir virtual const String &
104cdf0e10cSrcweir inq_LocalName() const;
105cdf0e10cSrcweir virtual Cid inq_Owner() const;
106cdf0e10cSrcweir virtual Lid inq_Location() const;
107cdf0e10cSrcweir
108cdf0e10cSrcweir // Interface ary::cpp::CppEntity
109cdf0e10cSrcweir virtual ClassId get_AryClass() const;
110cdf0e10cSrcweir
111cdf0e10cSrcweir // Local Types
112cdf0e10cSrcweir typedef StringVector ParameterInfoList;
113cdf0e10cSrcweir typedef std::vector<Type_id> ExceptionTypeList;
114cdf0e10cSrcweir
115cdf0e10cSrcweir // DATA
116cdf0e10cSrcweir CeEssentials aEssentials;
117cdf0e10cSrcweir List_TplParam aTemplateParameterTypes;
118cdf0e10cSrcweir OperationSignature aSignature;
119cdf0e10cSrcweir Type_id nReturnType;
120cdf0e10cSrcweir E_Protection eProtection;
121cdf0e10cSrcweir E_Virtuality eVirtuality;
122cdf0e10cSrcweir FunctionFlags aFlags;
123cdf0e10cSrcweir ParameterInfoList aParameterInfos;
124cdf0e10cSrcweir Dyn<ExceptionTypeList>
125cdf0e10cSrcweir pExceptions; // if (NOT pExceptions) there is no throw,
126cdf0e10cSrcweir // else, there is one, but the list still may be empty.
127cdf0e10cSrcweir };
128cdf0e10cSrcweir
129cdf0e10cSrcweir
130cdf0e10cSrcweir
131cdf0e10cSrcweir
132cdf0e10cSrcweir // IMPLEMENTATION
133cdf0e10cSrcweir inline const OperationSignature &
Signature() const134cdf0e10cSrcweir Function::Signature() const
135cdf0e10cSrcweir { return aSignature; }
136cdf0e10cSrcweir inline Type_id
ReturnType() const137cdf0e10cSrcweir Function::ReturnType() const
138cdf0e10cSrcweir { return nReturnType; }
139cdf0e10cSrcweir
140cdf0e10cSrcweir
141cdf0e10cSrcweir
142cdf0e10cSrcweir
143cdf0e10cSrcweir } // namespace cpp
144cdf0e10cSrcweir } // namespace ary
145cdf0e10cSrcweir #endif
146