Line data    Source code

       1             : /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
       2             : /*
       3             :  * This file is part of the LibreOffice project.
       4             :  *
       5             :  * This Source Code Form is subject to the terms of the Mozilla Public
       6             :  * License, v. 2.0. If a copy of the MPL was not distributed with this
       7             :  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
       8             :  *
       9             :  * This file incorporates work covered by the following license notice:
      10             :  *
      11             :  *   Licensed to the Apache Software Foundation (ASF) under one or more
      12             :  *   contributor license agreements. See the NOTICE file distributed
      13             :  *   with this work for additional information regarding copyright
      14             :  *   ownership. The ASF licenses this file to you under the Apache
      15             :  *   License, Version 2.0 (the "License"); you may not use this file
      16             :  *   except in compliance with the License. You may obtain a copy of
      17             :  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
      18             :  */
      19             : 
      20             : #ifndef ARY_IDL_I_FUNCTION_HXX
      21             : #define ARY_IDL_I_FUNCTION_HXX
      22             : 
      23             : // BASE CLASSES
      24             : #include <ary/idl/i_ce.hxx>
      25             : 
      26             : // USED SERVICES
      27             : #include <ary/idl/i_param.hxx>
      28             : #include <ary/idl/ik_function.hxx>
      29             : #include <ary/stdconstiter.hxx>
      30             : 
      31             : 
      32             : 
      33             : 
      34             : namespace ary
      35             : {
      36             : namespace idl
      37             : {
      38             : 
      39             : 
      40             : /** Represents an IDL function.
      41             : 
      42             :     Special case constructor:
      43             :     Constructors have return type "0".
      44             : */
      45             : class Function : public CodeEntity
      46             : {
      47             :   public:
      48             :     enum E_ClassId { class_id = 2002 };
      49             : 
      50             :     typedef std::vector< Parameter >    ParamList;
      51             :     typedef std::vector< Type_id >      ExceptionList;
      52             : 
      53             :     // LIFECYCLE
      54             :     /// Normal function
      55             :                         Function(
      56             :                             const String &      i_sName,
      57             :                             Ce_id               i_nOwner,
      58             :                             Ce_id               i_nNameRoom,
      59             :                             Type_id             i_nReturnType,
      60             :                             bool                i_bOneWay );
      61             :     /// Constructor
      62             :                         Function(
      63             :                             const String &      i_sName,
      64             :                             Ce_id               i_nOwner,
      65             :                             Ce_id               i_nNameRoom );
      66             :                         ~Function();
      67             : 
      68             :     // OPERATIONS
      69             :     void                Add_Parameter(
      70             :                             const String &      i_sName,
      71             :                             Type_id             i_nType,
      72             :                             E_ParameterDirection
      73             :                                                 i_eDirection );
      74             :     /// The function's parameter list ends with the ellipse "..." .
      75             :     void                Set_Ellipse();
      76             :     void                Add_Exception(
      77             :                             Type_id             i_nException );
      78             : 
      79             :     // INQUIRY
      80             :     Type_id             ReturnType() const;
      81       16848 :     const ParamList &   Parameters() const      { return aParameters; }
      82             :     const ExceptionList &
      83       13863 :                         Exceptions() const      { return aExceptions; }
      84             :     bool                IsOneway() const;
      85             :     bool                HasEllipse() const      { return bEllipse; }
      86             : 
      87             :   private:
      88             :     // Interface csv::ConstProcessorClient:
      89             :     virtual void        do_Accept(
      90             :                             csv::ProcessorIfc & io_processor ) const;
      91             :     // Interface ary::Object:
      92             :     virtual ClassId     get_AryClass() const;
      93             : 
      94             :     // Interface CodeEntity
      95             :     virtual const String &  inq_LocalName() const;
      96             :     virtual Ce_id           inq_NameRoom() const;
      97             :     virtual Ce_id           inq_Owner() const;
      98             :     virtual E_SightLevel    inq_SightLevel() const;
      99             : 
     100             :     // Locals
     101             :     friend struct ifc_function::attr;
     102             : 
     103             :     // DATA
     104             :     String              sName;
     105             :     Ce_id               nOwner;
     106             :     Ce_id               nNameRoom;
     107             : 
     108             :     Type_id             nReturnType;
     109             :     ParamList           aParameters;
     110             :     ExceptionList       aExceptions;
     111             :     bool                bOneWay;
     112             :     bool                bEllipse;
     113             : };
     114             : 
     115             : 
     116             : 
     117             : 
     118             : // IMPLEMENTATION
     119             : inline void
     120        5658 : Function::Add_Parameter( const String &         i_sName,
     121             :                          Type_id                i_nType,
     122             :                          E_ParameterDirection   i_eDirection )
     123             : {
     124        5658 :     aParameters.push_back( Parameter(i_sName,i_nType,i_eDirection) );
     125        5658 : }
     126             : 
     127             : inline void
     128           0 : Function::Set_Ellipse()
     129             : {
     130           0 :     bEllipse = true;
     131           0 : }
     132             : 
     133             : inline void
     134        2673 : Function::Add_Exception( Type_id i_nException )
     135             : {
     136        2673 :     aExceptions.push_back(i_nException);
     137        2673 : }
     138             : 
     139             : inline Type_id
     140        5595 : Function::ReturnType() const
     141        5595 :     { return nReturnType; }
     142             : 
     143             : inline bool
     144             : Function::IsOneway() const
     145             :     { return bOneWay; }
     146             : 
     147             : 
     148             : 
     149             : 
     150             : }   // namespace idl
     151             : }   // namespace ary
     152             : #endif
     153             : 
     154             : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */