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_I_FUNCTION_HXX
25*b1cdbd2cSJim Jagielski #define ARY_IDL_I_FUNCTION_HXX
26*b1cdbd2cSJim Jagielski
27*b1cdbd2cSJim Jagielski // BASE CLASSES
28*b1cdbd2cSJim Jagielski #include <ary/idl/i_ce.hxx>
29*b1cdbd2cSJim Jagielski
30*b1cdbd2cSJim Jagielski // USED SERVICES
31*b1cdbd2cSJim Jagielski #include <ary/idl/i_param.hxx>
32*b1cdbd2cSJim Jagielski #include <ary/idl/ik_function.hxx>
33*b1cdbd2cSJim Jagielski #include <ary/stdconstiter.hxx>
34*b1cdbd2cSJim Jagielski
35*b1cdbd2cSJim Jagielski
36*b1cdbd2cSJim Jagielski
37*b1cdbd2cSJim Jagielski
38*b1cdbd2cSJim Jagielski namespace ary
39*b1cdbd2cSJim Jagielski {
40*b1cdbd2cSJim Jagielski namespace idl
41*b1cdbd2cSJim Jagielski {
42*b1cdbd2cSJim Jagielski
43*b1cdbd2cSJim Jagielski
44*b1cdbd2cSJim Jagielski /** Represents an IDL function.
45*b1cdbd2cSJim Jagielski
46*b1cdbd2cSJim Jagielski Special case constructor:
47*b1cdbd2cSJim Jagielski Constructors have return type "0".
48*b1cdbd2cSJim Jagielski */
49*b1cdbd2cSJim Jagielski class Function : public CodeEntity
50*b1cdbd2cSJim Jagielski {
51*b1cdbd2cSJim Jagielski public:
52*b1cdbd2cSJim Jagielski enum E_ClassId { class_id = 2002 };
53*b1cdbd2cSJim Jagielski
54*b1cdbd2cSJim Jagielski typedef std::vector< Parameter > ParamList;
55*b1cdbd2cSJim Jagielski typedef std::vector< Type_id > ExceptionList;
56*b1cdbd2cSJim Jagielski
57*b1cdbd2cSJim Jagielski // LIFECYCLE
58*b1cdbd2cSJim Jagielski /// Normal function
59*b1cdbd2cSJim Jagielski Function(
60*b1cdbd2cSJim Jagielski const String & i_sName,
61*b1cdbd2cSJim Jagielski Ce_id i_nOwner,
62*b1cdbd2cSJim Jagielski Ce_id i_nNameRoom,
63*b1cdbd2cSJim Jagielski Type_id i_nReturnType,
64*b1cdbd2cSJim Jagielski bool i_bOneWay );
65*b1cdbd2cSJim Jagielski /// Constructor
66*b1cdbd2cSJim Jagielski Function(
67*b1cdbd2cSJim Jagielski const String & i_sName,
68*b1cdbd2cSJim Jagielski Ce_id i_nOwner,
69*b1cdbd2cSJim Jagielski Ce_id i_nNameRoom );
70*b1cdbd2cSJim Jagielski ~Function();
71*b1cdbd2cSJim Jagielski
72*b1cdbd2cSJim Jagielski // OPERATIONS
73*b1cdbd2cSJim Jagielski void Add_Parameter(
74*b1cdbd2cSJim Jagielski const String & i_sName,
75*b1cdbd2cSJim Jagielski Type_id i_nType,
76*b1cdbd2cSJim Jagielski E_ParameterDirection
77*b1cdbd2cSJim Jagielski i_eDirection );
78*b1cdbd2cSJim Jagielski /// The function's parameter list ends with the ellipse "..." .
79*b1cdbd2cSJim Jagielski void Set_Ellipse();
80*b1cdbd2cSJim Jagielski void Add_Exception(
81*b1cdbd2cSJim Jagielski Type_id i_nException );
82*b1cdbd2cSJim Jagielski
83*b1cdbd2cSJim Jagielski // INQUIRY
84*b1cdbd2cSJim Jagielski Type_id ReturnType() const;
Parameters() const85*b1cdbd2cSJim Jagielski const ParamList & Parameters() const { return aParameters; }
86*b1cdbd2cSJim Jagielski const ExceptionList &
Exceptions() const87*b1cdbd2cSJim Jagielski Exceptions() const { return aExceptions; }
88*b1cdbd2cSJim Jagielski bool IsOneway() const;
HasEllipse() const89*b1cdbd2cSJim Jagielski bool HasEllipse() const { return bEllipse; }
90*b1cdbd2cSJim Jagielski
91*b1cdbd2cSJim Jagielski private:
92*b1cdbd2cSJim Jagielski // Interface csv::ConstProcessorClient:
93*b1cdbd2cSJim Jagielski virtual void do_Accept(
94*b1cdbd2cSJim Jagielski csv::ProcessorIfc & io_processor ) const;
95*b1cdbd2cSJim Jagielski // Interface ary::Object:
96*b1cdbd2cSJim Jagielski virtual ClassId get_AryClass() const;
97*b1cdbd2cSJim Jagielski
98*b1cdbd2cSJim Jagielski // Interface CodeEntity
99*b1cdbd2cSJim Jagielski virtual const String & inq_LocalName() const;
100*b1cdbd2cSJim Jagielski virtual Ce_id inq_NameRoom() const;
101*b1cdbd2cSJim Jagielski virtual Ce_id inq_Owner() const;
102*b1cdbd2cSJim Jagielski virtual E_SightLevel inq_SightLevel() const;
103*b1cdbd2cSJim Jagielski
104*b1cdbd2cSJim Jagielski // Locals
105*b1cdbd2cSJim Jagielski friend struct ifc_function::attr;
106*b1cdbd2cSJim Jagielski
107*b1cdbd2cSJim Jagielski // DATA
108*b1cdbd2cSJim Jagielski String sName;
109*b1cdbd2cSJim Jagielski Ce_id nOwner;
110*b1cdbd2cSJim Jagielski Ce_id nNameRoom;
111*b1cdbd2cSJim Jagielski
112*b1cdbd2cSJim Jagielski Type_id nReturnType;
113*b1cdbd2cSJim Jagielski ParamList aParameters;
114*b1cdbd2cSJim Jagielski ExceptionList aExceptions;
115*b1cdbd2cSJim Jagielski bool bOneWay;
116*b1cdbd2cSJim Jagielski bool bEllipse;
117*b1cdbd2cSJim Jagielski };
118*b1cdbd2cSJim Jagielski
119*b1cdbd2cSJim Jagielski
120*b1cdbd2cSJim Jagielski
121*b1cdbd2cSJim Jagielski
122*b1cdbd2cSJim Jagielski // IMPLEMENTATION
123*b1cdbd2cSJim Jagielski inline void
Add_Parameter(const String & i_sName,Type_id i_nType,E_ParameterDirection i_eDirection)124*b1cdbd2cSJim Jagielski Function::Add_Parameter( const String & i_sName,
125*b1cdbd2cSJim Jagielski Type_id i_nType,
126*b1cdbd2cSJim Jagielski E_ParameterDirection i_eDirection )
127*b1cdbd2cSJim Jagielski {
128*b1cdbd2cSJim Jagielski aParameters.push_back( Parameter(i_sName,i_nType,i_eDirection) );
129*b1cdbd2cSJim Jagielski }
130*b1cdbd2cSJim Jagielski
131*b1cdbd2cSJim Jagielski inline void
Set_Ellipse()132*b1cdbd2cSJim Jagielski Function::Set_Ellipse()
133*b1cdbd2cSJim Jagielski {
134*b1cdbd2cSJim Jagielski bEllipse = true;
135*b1cdbd2cSJim Jagielski }
136*b1cdbd2cSJim Jagielski
137*b1cdbd2cSJim Jagielski inline void
Add_Exception(Type_id i_nException)138*b1cdbd2cSJim Jagielski Function::Add_Exception( Type_id i_nException )
139*b1cdbd2cSJim Jagielski {
140*b1cdbd2cSJim Jagielski aExceptions.push_back(i_nException);
141*b1cdbd2cSJim Jagielski }
142*b1cdbd2cSJim Jagielski
143*b1cdbd2cSJim Jagielski inline Type_id
ReturnType() const144*b1cdbd2cSJim Jagielski Function::ReturnType() const
145*b1cdbd2cSJim Jagielski { return nReturnType; }
146*b1cdbd2cSJim Jagielski
147*b1cdbd2cSJim Jagielski inline bool
IsOneway() const148*b1cdbd2cSJim Jagielski Function::IsOneway() const
149*b1cdbd2cSJim Jagielski { return bOneWay; }
150*b1cdbd2cSJim Jagielski
151*b1cdbd2cSJim Jagielski
152*b1cdbd2cSJim Jagielski
153*b1cdbd2cSJim Jagielski
154*b1cdbd2cSJim Jagielski } // namespace idl
155*b1cdbd2cSJim Jagielski } // namespace ary
156*b1cdbd2cSJim Jagielski #endif
157