xref: /trunk/main/autodoc/inc/ary/idl/i_types4idl.hxx (revision 1c78a5d6)
1 /**************************************************************
2  *
3  * Licensed to the Apache Software Foundation (ASF) under one
4  * or more contributor license agreements.  See the NOTICE file
5  * distributed with this work for additional information
6  * regarding copyright ownership.  The ASF licenses this file
7  * to you under the Apache License, Version 2.0 (the
8  * "License"); you may not use this file except in compliance
9  * with the License.  You may obtain a copy of the License at
10  *
11  *   http://www.apache.org/licenses/LICENSE-2.0
12  *
13  * Unless required by applicable law or agreed to in writing,
14  * software distributed under the License is distributed on an
15  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16  * KIND, either express or implied.  See the License for the
17  * specific language governing permissions and limitations
18  * under the License.
19  *
20  *************************************************************/
21 
22 
23 
24 #ifndef ARY_IDL_I_TYPES4IDL_HXX
25 #define ARY_IDL_I_TYPES4IDL_HXX
26 
27 // USED SERVICES
28 #include <ary/types.hxx>
29 
30 
31 
32 
33 namespace ary
34 {
35 namespace idl
36 {
37     class Module;
38     class CodeEntity;
39     class Type;
40     class Gate;
41     class CePilot;
42     class TypePilot;
43 
44 
45 typedef TypedId<CodeEntity>         Ce_id;
46 typedef TypedId<Type>               Type_id;
47 
48 
49 /** This is used when an ->ary::idl::ExplicitType
50     represents a templated struct and is sorted into the
51     dictionary of an ->ary::idl::XNameRoom.
52     Then local type name and template type id are concatenated
53     to one string with this char as delimiter.
54 */
55 const char C_cTemplateDelimiter = '<';
56 
57 typedef std::vector<Ce_id>          Ce_idList;
58 
59 
60 enum E_ParameterDirection
61 {
62     param_in,
63     param_out,
64     param_inout
65 };
66 
67 
68 enum E_SightLevel
69 {
70     sl_Module,          // not file bound entities, like modules
71     sl_File,            // entities on top level within one file, like interface or enum
72     sl_Member           // member entities, like enumvalue or function
73 };
74 
75 inline Ce_id
Ce_id_Null()76 Ce_id_Null()
77 {
78     return Ce_id(0);
79 }
80 
81 inline void
NullPush_IdList(Ce_idList * o_pList)82 NullPush_IdList(Ce_idList * o_pList)
83 {
84     if (o_pList)
85         o_pList->push_back( Ce_id_Null() );
86 }
87 
88 inline void
NullPush_IdList_2(Ce_idList * o_pList)89 NullPush_IdList_2(Ce_idList * o_pList)
90 {
91     if (o_pList)
92     {
93         o_pList->push_back( Ce_id_Null() );
94         o_pList->push_back( Ce_id_Null() );
95     }
96 }
97 
98 namespace alphabetical_index
99 {
100     enum E_Letter
101     {
102         a = int('a'),
103         b,
104         c,
105         d,
106         e,
107         f,
108         g,
109         h,
110         i,
111         j,
112         k,
113         l,
114         m,
115         n,
116         o,
117         p,
118         q,
119         r,
120         s,
121         t,
122         u,
123         v,
124         w,
125         x,
126         y,
127         z,
128         non_alpha = int('_'),
129         MAX
130     };
131 }
132 
133 
134 
135 
136 }   // namespace idl
137 }   // namespace ary
138 #endif
139