autodoc/inc/ary/idl/i_struct.hxx

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