autodoc/inc/ary/idl/i_struct.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * This file is part of OpenOffice.org.
  11  *
  12  * OpenOffice.org is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU Lesser General Public License version 3
  14  * only, as published by the Free Software Foundation.
  15  *
  16  * OpenOffice.org is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Lesser General Public License version 3 for more details
  20  * (a copy is included in the LICENSE file that accompanied this code).
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * version 3 along with OpenOffice.org.  If not, see
  24  * <http://www.openoffice.org/license.html>
  25  * for a copy of the LGPLv3 License.
  26  *
  27  ************************************************************************/
  28
  29 #ifndef ARY_IDL_I_STRUCT_HXX
  30 #define ARY_IDL_I_STRUCT_HXX
  31
  32 // BASE CLASSES
  33 #include <ary/idl/i_ce.hxx>
  34
  35
  36
  37
  38 namespace ary
  39 {
  40 namespace idl
  41 {
  42 namespace ifc_struct
  43 {
  44     struct attr;
  45 }
  46
  47
  48 /** Represents an IDL struct.
  49 */
  50 class Struct : public CodeEntity
  51 {
  52   public:
  53     enum E_ClassId { class_id = 2008 };
  54
  55     // LIFECYCLE
  56                         Struct(
  57                             const String &      i_sName,
  58                             Ce_id               i_nOwner,
  59                             Type_id             i_nBase,
  60                             const String &      i_sTemplateParameter,
  61                             Type_id             i_nTemplateParameterType );
  62                         ~Struct();
  63     // INQUIRY
  64     Type_id             Base() const;
  65     String              TemplateParameter() const;
  66     Type_id             TemplateParameterType() const;
  67
  68     // ACCESS
  69     void                Add_Member(
  70                             Ce_id               i_nMember );
  71   private:
  72     // Interface csv::ConstProcessorClient:
  73     virtual void        do_Accept(
  74                             csv::ProcessorIfc & io_processor ) const;
  75     // Interface ary::Object:
  76     virtual ClassId     get_AryClass() const;
  77
  78     // Interface CodeEntity
  79     virtual const String &  inq_LocalName() const;
  80     virtual Ce_id           inq_NameRoom() const;
  81     virtual Ce_id           inq_Owner() const;
  82     virtual E_SightLevel    inq_SightLevel() const;
  83
  84     // Locals
  85     typedef std::vector<Ce_id>     ElementList;
  86     friend struct ifc_struct::attr;
  87
  88     // DATA
  89     String              sName;
  90     Ce_id               nOwner;
  91
  92     Type_id             nBase;
  93     String              sTemplateParameter;
  94     Type_id             nTemplateParameterType;
  95     ElementList         aElements;
  96 };
  97
  98
  99
 100
 101 // IMPLEMENTATION
 102 inline Type_id
 103 Struct::Base() const
 104 {
 105     return nBase;
 106 }
 107
 108 inline String
 109 Struct::TemplateParameter() const
 110 {
 111     return sTemplateParameter;
 112 }
 113
 114 inline Type_id
 115 Struct::TemplateParameterType() const
 116 {
 117     return nTemplateParameterType;
 118 }
 119
 120 inline void
 121 Struct::Add_Member( Ce_id i_nMember )
 122 {
 123     aElements.push_back(i_nMember);
 124 }
 125
 126
 127
 128
 129 }   // namespace idl
 130 }   // namespace ary
 131 #endif
 132
 133 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */