autodoc/inc/ary/idl/i_function.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: i_function.hxx,v $
  10  * $Revision: 1.5 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef ARY_IDL_I_FUNCTION_HXX
  32 #define ARY_IDL_I_FUNCTION_HXX
  33
  34 // BASE CLASSES
  35 #include <ary/idl/i_ce.hxx>
  36
  37 // USED SERVICES
  38 #include <ary/idl/i_param.hxx>
  39 #include <ary/idl/ik_function.hxx>
  40 #include <ary/stdconstiter.hxx>
  41
  42
  43
  44
  45 namespace ary
  46 {
  47 namespace idl
  48 {
  49
  50
  51 /** Represents an IDL function.
  52
  53     Special case constructor:
  54     Constructors have return type "0".
  55 */
  56 class Function : public CodeEntity
  57 {
  58   public:
  59     enum E_ClassId { class_id = 2002 };
  60
  61     typedef std::vector< Parameter >    ParamList;
  62     typedef std::vector< Type_id >      ExceptionList;
  63
  64     // LIFECYCLE
  65     /// Normal function
  66                         Function(
  67                             const String &      i_sName,
  68                             Ce_id               i_nOwner,
  69                             Ce_id               i_nNameRoom,
  70                             Type_id             i_nReturnType,
  71                             bool                i_bOneWay );
  72     /// Constructor
  73                         Function(
  74                             const String &      i_sName,
  75                             Ce_id               i_nOwner,
  76                             Ce_id               i_nNameRoom );
  77                         ~Function();
  78
  79     // OPERATIONS
  80     void                Add_Parameter(
  81                             const String &      i_sName,
  82                             Type_id             i_nType,
  83                             E_ParameterDirection
  84                                                 i_eDirection );
  85     /// The function's parameter list ends with the ellipse "..." .
  86     void                Set_Ellipse();
  87     void                Add_Exception(
  88                             Type_id             i_nException );
  89
  90     // INQUIRY
  91     Type_id             ReturnType() const;
  92     const ParamList &   Parameters() const      { return aParameters; }
  93     const ExceptionList &
  94                         Exceptions() const      { return aExceptions; }
  95     bool                IsOneway() const;
  96     bool                HasEllipse() const      { return bEllipse; }
  97
  98   private:
  99     // Interface csv::ConstProcessorClient:
 100     virtual void        do_Accept(
 101                             csv::ProcessorIfc & io_processor ) const;
 102     // Interface ary::Object:
 103     virtual ClassId     get_AryClass() const;
 104
 105     // Interface CodeEntity
 106     virtual const String &  inq_LocalName() const;
 107     virtual Ce_id           inq_NameRoom() const;
 108     virtual Ce_id           inq_Owner() const;
 109     virtual E_SightLevel    inq_SightLevel() const;
 110
 111     // Locals
 112     friend struct ifc_function::attr;
 113
 114     // DATA
 115     String              sName;
 116     Ce_id               nOwner;
 117     Ce_id               nNameRoom;
 118
 119     Type_id             nReturnType;
 120     ParamList           aParameters;
 121     ExceptionList       aExceptions;
 122     bool                bOneWay;
 123     bool                bEllipse;
 124 };
 125
 126
 127
 128
 129 // IMPLEMENTATION
 130 inline void
 131 Function::Add_Parameter( const String &         i_sName,
 132                          Type_id                i_nType,
 133                          E_ParameterDirection   i_eDirection )
 134 {
 135     aParameters.push_back( Parameter(i_sName,i_nType,i_eDirection) );
 136 }
 137
 138 inline void
 139 Function::Set_Ellipse()
 140 {
 141     bEllipse = true;
 142 }
 143
 144 inline void
 145 Function::Add_Exception( Type_id i_nException )
 146 {
 147     aExceptions.push_back(i_nException);
 148 }
 149
 150 inline Type_id
 151 Function::ReturnType() const
 152     { return nReturnType; }
 153
 154 inline bool
 155 Function::IsOneway() const
 156     { return bOneWay; }
 157
 158
 159
 160
 161 }   // namespace idl
 162 }   // namespace ary
 163 #endif