xref: /aoo42x/main/autodoc/inc/ary/idl/i_module.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_MODULE_HXX
25cdf0e10cSrcweir #define ARY_IDL_I_MODULE_HXX
26cdf0e10cSrcweir 
27cdf0e10cSrcweir // BASE CLASSES
28cdf0e10cSrcweir #include <ary/idl/i_ce.hxx>
29cdf0e10cSrcweir 
30cdf0e10cSrcweir // USED SERVICES
31cdf0e10cSrcweir #include <ary/stdconstiter.hxx>
32cdf0e10cSrcweir 
33cdf0e10cSrcweir 
34cdf0e10cSrcweir 
35cdf0e10cSrcweir 
36cdf0e10cSrcweir namespace ary
37cdf0e10cSrcweir {
38cdf0e10cSrcweir     template <class> class NameTreeNode;
39cdf0e10cSrcweir 
40cdf0e10cSrcweir namespace idl
41cdf0e10cSrcweir {
42cdf0e10cSrcweir namespace ifc_module
43cdf0e10cSrcweir {
44cdf0e10cSrcweir     struct attr;
45cdf0e10cSrcweir }
46cdf0e10cSrcweir     class Gate;
47cdf0e10cSrcweir 
48cdf0e10cSrcweir 
49cdf0e10cSrcweir /** Represents an IDL module.
50cdf0e10cSrcweir 
51cdf0e10cSrcweir     "Name" in methods means all code entities which belong into
52cdf0e10cSrcweir     this namespace (not in a subnamespace of this one), but not
53cdf0e10cSrcweir     to the subnamespaces.
54cdf0e10cSrcweir 
55cdf0e10cSrcweir     "SubNamespace" in method names refers to all direct subnamespaces.
56cdf0e10cSrcweir */
57cdf0e10cSrcweir class Module : public CodeEntity
58cdf0e10cSrcweir {
59cdf0e10cSrcweir   public:
60cdf0e10cSrcweir     enum E_ClassId { class_id = 2000 };
61cdf0e10cSrcweir 
62cdf0e10cSrcweir         // LIFECYCLE
63cdf0e10cSrcweir                         Module();
64cdf0e10cSrcweir                         Module(
65cdf0e10cSrcweir                             const String &      i_sName,
66cdf0e10cSrcweir                             const Module &      i_rParent );
67cdf0e10cSrcweir                         ~Module();
68cdf0e10cSrcweir     // OPERATIONS
69cdf0e10cSrcweir     void                Add_Name(
70cdf0e10cSrcweir                             const String &      i_sName,
71cdf0e10cSrcweir                             Ce_id               i_nId );
72cdf0e10cSrcweir     // INQUIRY
73cdf0e10cSrcweir     Ce_id               Search_Name(
74cdf0e10cSrcweir                             const String &      i_sName ) const;
75cdf0e10cSrcweir     void                Get_Names(
76cdf0e10cSrcweir                             Dyn_StdConstIterator<Ce_id> &
77cdf0e10cSrcweir                                                 o_rResult ) const;
78cdf0e10cSrcweir   private:
79cdf0e10cSrcweir     // Interface csv::ConstProcessorClient:
80cdf0e10cSrcweir     virtual void        do_Accept(
81cdf0e10cSrcweir                             csv::ProcessorIfc & io_processor ) const;
82cdf0e10cSrcweir     // Interface ary::Object:
83cdf0e10cSrcweir     virtual ClassId     get_AryClass() const;
84cdf0e10cSrcweir 
85cdf0e10cSrcweir     // Interface CodeEntity
86cdf0e10cSrcweir     virtual const String &  inq_LocalName() const;
87cdf0e10cSrcweir     virtual Ce_id           inq_NameRoom() const;
88cdf0e10cSrcweir     virtual Ce_id           inq_Owner() const;
89cdf0e10cSrcweir     virtual E_SightLevel    inq_SightLevel() const;
90cdf0e10cSrcweir 
91cdf0e10cSrcweir     friend struct ifc_module::attr;
92cdf0e10cSrcweir 
93cdf0e10cSrcweir     // DATA
94cdf0e10cSrcweir     Dyn< NameTreeNode<Ce_id> >
95cdf0e10cSrcweir                             pImpl;
96cdf0e10cSrcweir };
97cdf0e10cSrcweir 
98cdf0e10cSrcweir 
99cdf0e10cSrcweir inline bool
is_Module(const CodeEntity & i_rCe)100cdf0e10cSrcweir is_Module( const CodeEntity & i_rCe )
101cdf0e10cSrcweir {
102cdf0e10cSrcweir     return i_rCe.AryClass() == Module::class_id;
103cdf0e10cSrcweir }
104cdf0e10cSrcweir 
105cdf0e10cSrcweir 
106cdf0e10cSrcweir 
107cdf0e10cSrcweir 
108cdf0e10cSrcweir }   // namespace idl
109cdf0e10cSrcweir }   // namespace ary
110cdf0e10cSrcweir #endif
111