autodoc/inc/ary/idl/i_struct.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_struct.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_STRUCT_HXX
  32 #define ARY_IDL_I_STRUCT_HXX
  33
  34 // BASE CLASSES
  35 #include <ary/idl/i_ce.hxx>
  36
  37
  38
  39
  40 namespace ary
  41 {
  42 namespace idl
  43 {
  44 namespace ifc_struct
  45 {
  46     struct attr;
  47 }
  48
  49
  50 /** Represents an IDL struct.
  51 */
  52 class Struct : public CodeEntity
  53 {
  54   public:
  55     enum E_ClassId { class_id = 2008 };
  56
  57     // LIFECYCLE
  58                         Struct(
  59                             const String &      i_sName,
  60                             Ce_id               i_nOwner,
  61                             Type_id             i_nBase,
  62                             const String &      i_sTemplateParameter,
  63                             Type_id             i_nTemplateParameterType );
  64                         ~Struct();
  65     // INQUIRY
  66     Type_id             Base() const;
  67     String              TemplateParameter() const;
  68     Type_id             TemplateParameterType() const;
  69
  70     // ACCESS
  71     void                Add_Member(
  72                             Ce_id               i_nMember );
  73   private:
  74     // Interface csv::ConstProcessorClient:
  75     virtual void        do_Accept(
  76                             csv::ProcessorIfc & io_processor ) const;
  77     // Interface ary::Object:
  78     virtual ClassId     get_AryClass() const;
  79
  80     // Interface CodeEntity
  81     virtual const String &  inq_LocalName() const;
  82     virtual Ce_id           inq_NameRoom() const;
  83     virtual Ce_id           inq_Owner() const;
  84     virtual E_SightLevel    inq_SightLevel() const;
  85
  86     // Locals
  87     typedef std::vector<Ce_id>     ElementList;
  88     friend struct ifc_struct::attr;
  89
  90     // DATA
  91     String              sName;
  92     Ce_id               nOwner;
  93
  94     Type_id             nBase;
  95     String              sTemplateParameter;
  96     Type_id             nTemplateParameterType;
  97     ElementList         aElements;
  98 };
  99
 100
 101
 102
 103 // IMPLEMENTATION
 104 inline Type_id
 105 Struct::Base() const
 106 {
 107     return nBase;
 108 }
 109
 110 inline String
 111 Struct::TemplateParameter() const
 112 {
 113     return sTemplateParameter;
 114 }
 115
 116 inline Type_id
 117 Struct::TemplateParameterType() const
 118 {
 119     return nTemplateParameterType;
 120 }
 121
 122 inline void
 123 Struct::Add_Member( Ce_id i_nMember )
 124 {
 125     aElements.push_back(i_nMember);
 126 }
 127
 128
 129
 130
 131 }   // namespace idl
 132 }   // namespace ary
 133 #endif