xref: /aoo42x/main/autodoc/inc/ary/idl/i_struct.hxx (revision 1c78a5d6)
1*1c78a5d6SAndrew Rist /**************************************************************
2cdf0e10cSrcweir  *
3*1c78a5d6SAndrew Rist  * Licensed to the Apache Software Foundation (ASF) under one
4*1c78a5d6SAndrew Rist  * or more contributor license agreements.  See the NOTICE file
5*1c78a5d6SAndrew Rist  * distributed with this work for additional information
6*1c78a5d6SAndrew Rist  * regarding copyright ownership.  The ASF licenses this file
7*1c78a5d6SAndrew Rist  * to you under the Apache License, Version 2.0 (the
8*1c78a5d6SAndrew Rist  * "License"); you may not use this file except in compliance
9*1c78a5d6SAndrew Rist  * with the License.  You may obtain a copy of the License at
10*1c78a5d6SAndrew Rist  *
11*1c78a5d6SAndrew Rist  *   http://www.apache.org/licenses/LICENSE-2.0
12*1c78a5d6SAndrew Rist  *
13*1c78a5d6SAndrew Rist  * Unless required by applicable law or agreed to in writing,
14*1c78a5d6SAndrew Rist  * software distributed under the License is distributed on an
15*1c78a5d6SAndrew Rist  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*1c78a5d6SAndrew Rist  * KIND, either express or implied.  See the License for the
17*1c78a5d6SAndrew Rist  * specific language governing permissions and limitations
18*1c78a5d6SAndrew Rist  * under the License.
19*1c78a5d6SAndrew Rist  *
20*1c78a5d6SAndrew Rist  *************************************************************/
21*1c78a5d6SAndrew Rist 
22*1c78a5d6SAndrew Rist 
23cdf0e10cSrcweir 
24cdf0e10cSrcweir #ifndef ARY_IDL_I_STRUCT_HXX
25cdf0e10cSrcweir #define ARY_IDL_I_STRUCT_HXX
26cdf0e10cSrcweir 
27cdf0e10cSrcweir // BASE CLASSES
28cdf0e10cSrcweir #include <ary/idl/i_ce.hxx>
29cdf0e10cSrcweir 
30cdf0e10cSrcweir 
31cdf0e10cSrcweir 
32cdf0e10cSrcweir 
33cdf0e10cSrcweir namespace ary
34cdf0e10cSrcweir {
35cdf0e10cSrcweir namespace idl
36cdf0e10cSrcweir {
37cdf0e10cSrcweir namespace ifc_struct
38cdf0e10cSrcweir {
39cdf0e10cSrcweir     struct attr;
40cdf0e10cSrcweir }
41cdf0e10cSrcweir 
42cdf0e10cSrcweir 
43cdf0e10cSrcweir /** Represents an IDL struct.
44cdf0e10cSrcweir */
45cdf0e10cSrcweir class Struct : public CodeEntity
46cdf0e10cSrcweir {
47cdf0e10cSrcweir   public:
48cdf0e10cSrcweir     enum E_ClassId { class_id = 2008 };
49cdf0e10cSrcweir 
50cdf0e10cSrcweir     // LIFECYCLE
51cdf0e10cSrcweir                         Struct(
52cdf0e10cSrcweir                             const String &      i_sName,
53cdf0e10cSrcweir                             Ce_id               i_nOwner,
54cdf0e10cSrcweir                             Type_id             i_nBase,
55cdf0e10cSrcweir                             const String &      i_sTemplateParameter,
56cdf0e10cSrcweir                             Type_id             i_nTemplateParameterType );
57cdf0e10cSrcweir                         ~Struct();
58cdf0e10cSrcweir     // INQUIRY
59cdf0e10cSrcweir     Type_id             Base() const;
60cdf0e10cSrcweir     String              TemplateParameter() const;
61cdf0e10cSrcweir     Type_id             TemplateParameterType() const;
62cdf0e10cSrcweir 
63cdf0e10cSrcweir     // ACCESS
64cdf0e10cSrcweir     void                Add_Member(
65cdf0e10cSrcweir                             Ce_id               i_nMember );
66cdf0e10cSrcweir   private:
67cdf0e10cSrcweir     // Interface csv::ConstProcessorClient:
68cdf0e10cSrcweir     virtual void        do_Accept(
69cdf0e10cSrcweir                             csv::ProcessorIfc & io_processor ) const;
70cdf0e10cSrcweir     // Interface ary::Object:
71cdf0e10cSrcweir     virtual ClassId     get_AryClass() const;
72cdf0e10cSrcweir 
73cdf0e10cSrcweir     // Interface CodeEntity
74cdf0e10cSrcweir     virtual const String &  inq_LocalName() const;
75cdf0e10cSrcweir     virtual Ce_id           inq_NameRoom() const;
76cdf0e10cSrcweir     virtual Ce_id           inq_Owner() const;
77cdf0e10cSrcweir     virtual E_SightLevel    inq_SightLevel() const;
78cdf0e10cSrcweir 
79cdf0e10cSrcweir     // Locals
80cdf0e10cSrcweir     typedef std::vector<Ce_id>     ElementList;
81cdf0e10cSrcweir     friend struct ifc_struct::attr;
82cdf0e10cSrcweir 
83cdf0e10cSrcweir     // DATA
84cdf0e10cSrcweir     String              sName;
85cdf0e10cSrcweir     Ce_id               nOwner;
86cdf0e10cSrcweir 
87cdf0e10cSrcweir     Type_id             nBase;
88cdf0e10cSrcweir     String              sTemplateParameter;
89cdf0e10cSrcweir     Type_id             nTemplateParameterType;
90cdf0e10cSrcweir     ElementList         aElements;
91cdf0e10cSrcweir };
92cdf0e10cSrcweir 
93cdf0e10cSrcweir 
94cdf0e10cSrcweir 
95cdf0e10cSrcweir 
96cdf0e10cSrcweir // IMPLEMENTATION
97cdf0e10cSrcweir inline Type_id
Base() const98cdf0e10cSrcweir Struct::Base() const
99cdf0e10cSrcweir {
100cdf0e10cSrcweir     return nBase;
101cdf0e10cSrcweir }
102cdf0e10cSrcweir 
103cdf0e10cSrcweir inline String
TemplateParameter() const104cdf0e10cSrcweir Struct::TemplateParameter() const
105cdf0e10cSrcweir {
106cdf0e10cSrcweir     return sTemplateParameter;
107cdf0e10cSrcweir }
108cdf0e10cSrcweir 
109cdf0e10cSrcweir inline Type_id
TemplateParameterType() const110cdf0e10cSrcweir Struct::TemplateParameterType() const
111cdf0e10cSrcweir {
112cdf0e10cSrcweir     return nTemplateParameterType;
113cdf0e10cSrcweir }
114cdf0e10cSrcweir 
115cdf0e10cSrcweir inline void
Add_Member(Ce_id i_nMember)116cdf0e10cSrcweir Struct::Add_Member( Ce_id i_nMember )
117cdf0e10cSrcweir {
118cdf0e10cSrcweir     aElements.push_back(i_nMember);
119cdf0e10cSrcweir }
120cdf0e10cSrcweir 
121cdf0e10cSrcweir 
122cdf0e10cSrcweir 
123cdf0e10cSrcweir 
124cdf0e10cSrcweir }   // namespace idl
125cdf0e10cSrcweir }   // namespace ary
126cdf0e10cSrcweir #endif
127