| /************************************************************** |
| * |
| * Licensed to the Apache Software Foundation (ASF) under one |
| * or more contributor license agreements. See the NOTICE file |
| * distributed with this work for additional information |
| * regarding copyright ownership. The ASF licenses this file |
| * to you under the Apache License, Version 2.0 (the |
| * "License"); you may not use this file except in compliance |
| * with the License. You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, |
| * software distributed under the License is distributed on an |
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| * KIND, either express or implied. See the License for the |
| * specific language governing permissions and limitations |
| * under the License. |
| * |
| *************************************************************/ |
| |
| |
| |
| #ifndef ARY_IDL_I_FUNCTION_HXX |
| #define ARY_IDL_I_FUNCTION_HXX |
| |
| // BASE CLASSES |
| #include <ary/idl/i_ce.hxx> |
| |
| // USED SERVICES |
| #include <ary/idl/i_param.hxx> |
| #include <ary/idl/ik_function.hxx> |
| #include <ary/stdconstiter.hxx> |
| |
| |
| |
| |
| namespace ary |
| { |
| namespace idl |
| { |
| |
| |
| /** Represents an IDL function. |
| |
| Special case constructor: |
| Constructors have return type "0". |
| */ |
| class Function : public CodeEntity |
| { |
| public: |
| enum E_ClassId { class_id = 2002 }; |
| |
| typedef std::vector< Parameter > ParamList; |
| typedef std::vector< Type_id > ExceptionList; |
| |
| // LIFECYCLE |
| /// Normal function |
| Function( |
| const String & i_sName, |
| Ce_id i_nOwner, |
| Ce_id i_nNameRoom, |
| Type_id i_nReturnType, |
| bool i_bOneWay ); |
| /// Constructor |
| Function( |
| const String & i_sName, |
| Ce_id i_nOwner, |
| Ce_id i_nNameRoom ); |
| ~Function(); |
| |
| // OPERATIONS |
| void Add_Parameter( |
| const String & i_sName, |
| Type_id i_nType, |
| E_ParameterDirection |
| i_eDirection ); |
| /// The function's parameter list ends with the ellipse "..." . |
| void Set_Ellipse(); |
| void Add_Exception( |
| Type_id i_nException ); |
| |
| // INQUIRY |
| Type_id ReturnType() const; |
| const ParamList & Parameters() const { return aParameters; } |
| const ExceptionList & |
| Exceptions() const { return aExceptions; } |
| bool IsOneway() const; |
| bool HasEllipse() const { return bEllipse; } |
| |
| private: |
| // Interface csv::ConstProcessorClient: |
| virtual void do_Accept( |
| csv::ProcessorIfc & io_processor ) const; |
| // Interface ary::Object: |
| virtual ClassId get_AryClass() const; |
| |
| // Interface CodeEntity |
| virtual const String & inq_LocalName() const; |
| virtual Ce_id inq_NameRoom() const; |
| virtual Ce_id inq_Owner() const; |
| virtual E_SightLevel inq_SightLevel() const; |
| |
| // Locals |
| friend struct ifc_function::attr; |
| |
| // DATA |
| String sName; |
| Ce_id nOwner; |
| Ce_id nNameRoom; |
| |
| Type_id nReturnType; |
| ParamList aParameters; |
| ExceptionList aExceptions; |
| bool bOneWay; |
| bool bEllipse; |
| }; |
| |
| |
| |
| |
| // IMPLEMENTATION |
| inline void |
| Function::Add_Parameter( const String & i_sName, |
| Type_id i_nType, |
| E_ParameterDirection i_eDirection ) |
| { |
| aParameters.push_back( Parameter(i_sName,i_nType,i_eDirection) ); |
| } |
| |
| inline void |
| Function::Set_Ellipse() |
| { |
| bEllipse = true; |
| } |
| |
| inline void |
| Function::Add_Exception( Type_id i_nException ) |
| { |
| aExceptions.push_back(i_nException); |
| } |
| |
| inline Type_id |
| Function::ReturnType() const |
| { return nReturnType; } |
| |
| inline bool |
| Function::IsOneway() const |
| { return bOneWay; } |
| |
| |
| |
| |
| } // namespace idl |
| } // namespace ary |
| #endif |
