autodoc/inc/ary/idl/i_interface.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_interface.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_INTERFACE_HXX
  32 #define ARY_IDL_I_INTERFACE_HXX
  33
  34 // BASE CLASSES
  35 #include <ary/idl/i_ce.hxx>
  36
  37 // USED SERVICES
  38 #include <ary/idl/i_comrela.hxx>
  39 #include <ary/stdconstiter.hxx>
  40
  41
  42
  43
  44 namespace ary
  45 {
  46 namespace idl
  47 {
  48 namespace ifc_interface
  49 {
  50     struct attr;
  51 }
  52     class Interface_2s;
  53
  54
  55 /** Represents an IDL interface.
  56 */
  57 class Interface : public CodeEntity
  58 {
  59   public:
  60     enum E_ClassId { class_id = 2001 };
  61
  62     // LIFECYCLE
  63                         Interface(
  64                             const String &      i_sName,
  65                             Ce_id               i_nOwner );
  66                         ~Interface();
  67     // INQUIRY
  68     bool                HasBase() const;
  69
  70     // ACCESS
  71     void                Add_Function(
  72                             Ce_id               i_nId );
  73     void                Add_Attribute(
  74                             Ce_id               i_nId );
  75     void                Add_Base(
  76                             Type_id             i_nInterface,
  77                             DYN doc::OldIdlDocu *
  78                                                 pass_dpDocu );
  79
  80   private:
  81     // Interface csv::ConstProcessorClient:
  82     virtual void        do_Accept(
  83                             csv::ProcessorIfc & io_processor ) const;
  84     // Interface ary::Object:
  85     virtual ClassId     get_AryClass() const;
  86
  87     // Interface CodeEntity:
  88     virtual const String &  inq_LocalName() const;
  89     virtual Ce_id           inq_NameRoom() const;
  90     virtual Ce_id           inq_Owner() const;
  91     virtual E_SightLevel    inq_SightLevel() const;
  92
  93     // Local
  94     typedef std::vector< CommentedRelation >    RelationList;
  95     typedef std::vector<Ce_id>                  MemberList;
  96     friend struct ifc_interface::attr;
  97
  98     // DATA
  99     String              sName;
 100     Ce_id               nOwner;
 101     RelationList        aBases;
 102     MemberList          aFunctions;
 103     MemberList          aAttributes;
 104     Dyn<Interface_2s>   p2s;
 105 };
 106
 107
 108
 109
 110 // IMPLEMENTATION
 111 inline bool
 112 Interface::HasBase() const
 113     { return aBases.size() > 0; }
 114 inline void
 115 Interface::Add_Function( Ce_id i_nId )
 116     { aFunctions.push_back(i_nId); }
 117 inline void
 118 Interface::Add_Attribute( Ce_id i_nId )
 119     { aAttributes.push_back(i_nId); }
 120 inline void
 121 Interface::Add_Base( Type_id                i_nInterface,
 122                      DYN doc::OldIdlDocu *  pass_dpDocu )
 123     { aBases.push_back( CommentedRelation(i_nInterface, pass_dpDocu) ); }
 124
 125
 126
 127
 128 }   // namespace idl
 129 }   // namespace ary
 130 #endif