My Project
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
types.h
Go to the documentation of this file.
1 /******************************************************************************
2  *
3  * Copyright (C) 1997-2015 by Dimitri van Heesch.
4  *
5  * Permission to use, copy, modify, and distribute this software and its
6  * documentation under the terms of the GNU General Public License is hereby
7  * granted. No representations are made about the suitability of this software
8  * for any purpose. It is provided "as is" without express or implied warranty.
9  * See the GNU General Public License for more details.
10  *
11  * Documents produced by Doxygen are derivative works derived from the
12  * input used in their production; they are not affected by this license.
13  *
14  */
15 
16 #ifndef TYPES_H
17 #define TYPES_H
18 
19 #include <qcstring.h>
20 
26 enum Protection { Public, Protected, Private, Package } ;
27 
29 enum Specifier { Normal, Virtual, Pure } ;
30 
32 enum MethodTypes { Method, Signal, Slot, DCOP, Property, Event };
33 
35 enum RelatesType { Simple, Duplicate, MemberOf };
36 
38 enum Relationship { Member, Related, Foreign };
39 
41 enum SrcLangExt
42 {
43  SrcLangExt_Unknown = 0x00000,
44  SrcLangExt_IDL = 0x00008,
45  SrcLangExt_Java = 0x00010,
46  SrcLangExt_CSharp = 0x00020,
47  SrcLangExt_D = 0x00040,
48  SrcLangExt_PHP = 0x00080,
49  SrcLangExt_ObjC = 0x00100,
50  SrcLangExt_Cpp = 0x00200,
51  SrcLangExt_JS = 0x00400,
52  SrcLangExt_Python = 0x00800,
53  SrcLangExt_Fortran = 0x01000,
54  SrcLangExt_VHDL = 0x02000,
55  SrcLangExt_XML = 0x04000,
56  SrcLangExt_Tcl = 0x08000,
57  SrcLangExt_Markdown = 0x10000
58 };
59 
61 struct Grouping
62 {
64  enum GroupPri_t
65  {
66  GROUPING_LOWEST,
67  GROUPING_AUTO_WEAK = GROUPING_LOWEST,
68  GROUPING_AUTO_ADD,
69  GROUPING_AUTO_DEF,
70  GROUPING_AUTO_HIGHEST = GROUPING_AUTO_DEF,
71  GROUPING_INGROUP,
72  GROUPING_HIGHEST = GROUPING_INGROUP
73  };
74 
75  static const char *getGroupPriName( GroupPri_t priority )
76  {
77  switch( priority )
78  {
79  case GROUPING_AUTO_WEAK:
80  return "@weakgroup";
81  case GROUPING_AUTO_ADD:
82  return "@addtogroup";
83  case GROUPING_AUTO_DEF:
84  return "@defgroup";
85  case GROUPING_INGROUP:
86  return "@ingroup";
87  }
88  return "???";
89  }
90 
91  Grouping( const char *gn, GroupPri_t p ) : groupname(gn), pri(p) {}
92  Grouping( const Grouping &g ) : groupname(g.groupname), pri(g.pri) {}
93  QCString groupname;
94  GroupPri_t pri;
95 
96 };
97 
98 struct ListItemInfo
99 {
100  QCString type;
101  int itemId;
102 };
103 
104 enum MemberListType
105 {
106  MemberListType_privateLists = 0x0800,
107  MemberListType_detailedLists = 0x1000,
108  MemberListType_declarationLists = 0x2000,
109  MemberListType_documentationLists = 0x4000,
110 
111  MemberListType_pubMethods = 0,
112  MemberListType_proMethods = 1,
113  MemberListType_pacMethods = 2,
114  MemberListType_priMethods = 3 + MemberListType_privateLists,
115  MemberListType_pubStaticMethods = 4,
116  MemberListType_proStaticMethods = 5,
117  MemberListType_pacStaticMethods = 6,
118  MemberListType_priStaticMethods = 7 + MemberListType_privateLists,
119  MemberListType_pubSlots = 8,
120  MemberListType_proSlots = 9,
121  MemberListType_priSlots = 10 + MemberListType_privateLists,
122  MemberListType_pubAttribs = 11,
123  MemberListType_proAttribs = 12,
124  MemberListType_pacAttribs = 13,
125  MemberListType_priAttribs = 14 + MemberListType_privateLists,
126  MemberListType_pubStaticAttribs = 15,
127  MemberListType_proStaticAttribs = 16,
128  MemberListType_pacStaticAttribs = 17,
129  MemberListType_priStaticAttribs = 18 + MemberListType_privateLists,
130  MemberListType_pubTypes = 19,
131  MemberListType_proTypes = 20,
132  MemberListType_pacTypes = 21,
133  MemberListType_priTypes = 22 + MemberListType_privateLists,
134  MemberListType_related = 23,
135  MemberListType_signals = 24,
136  MemberListType_friends = 25,
137  MemberListType_dcopMethods = 26,
138  MemberListType_properties = 27,
139  MemberListType_events = 28,
140 
141  MemberListType_typedefMembers = 29 + MemberListType_detailedLists,
142  MemberListType_enumMembers = 30 + MemberListType_detailedLists,
143  MemberListType_enumValMembers = 31 + MemberListType_detailedLists,
144  MemberListType_functionMembers = 32 + MemberListType_detailedLists,
145  MemberListType_relatedMembers = 33 + MemberListType_detailedLists,
146  MemberListType_variableMembers = 34 + MemberListType_detailedLists,
147  MemberListType_propertyMembers = 35 + MemberListType_detailedLists,
148  MemberListType_eventMembers = 36 + MemberListType_detailedLists,
149  MemberListType_constructors = 37 + MemberListType_detailedLists,
150 
151  MemberListType_allMembersList = 38,
152 
153  MemberListType_decDefineMembers = 39 + MemberListType_declarationLists,
154  MemberListType_decProtoMembers = 40 + MemberListType_declarationLists,
155  MemberListType_decTypedefMembers = 41 + MemberListType_declarationLists,
156  MemberListType_decEnumMembers = 42 + MemberListType_declarationLists,
157  MemberListType_decFuncMembers = 43 + MemberListType_declarationLists,
158  MemberListType_decVarMembers = 44 + MemberListType_declarationLists,
159  MemberListType_decEnumValMembers = 45 + MemberListType_declarationLists,
160  MemberListType_decPubSlotMembers = 46 + MemberListType_declarationLists,
161  MemberListType_decProSlotMembers = 47 + MemberListType_declarationLists,
162  MemberListType_decPriSlotMembers = 48 + MemberListType_declarationLists,
163  MemberListType_decSignalMembers = 49 + MemberListType_declarationLists,
164  MemberListType_decEventMembers = 50 + MemberListType_declarationLists,
165  MemberListType_decFriendMembers = 51 + MemberListType_declarationLists,
166  MemberListType_decPropMembers = 52 + MemberListType_declarationLists,
167 
168  MemberListType_docDefineMembers = 53 + MemberListType_documentationLists,
169  MemberListType_docProtoMembers = 54 + MemberListType_documentationLists,
170  MemberListType_docTypedefMembers = 55 + MemberListType_documentationLists,
171  MemberListType_docEnumMembers = 56 + MemberListType_documentationLists,
172  MemberListType_docFuncMembers = 57 + MemberListType_documentationLists,
173  MemberListType_docVarMembers = 58 + MemberListType_documentationLists,
174  MemberListType_docEnumValMembers = 59 + MemberListType_documentationLists,
175  MemberListType_docPubSlotMembers = 60 + MemberListType_documentationLists,
176  MemberListType_docProSlotMembers = 61 + MemberListType_documentationLists,
177  MemberListType_docPriSlotMembers = 62 + MemberListType_documentationLists,
178  MemberListType_docSignalMembers = 63 + MemberListType_documentationLists,
179  MemberListType_docEventMembers = 64 + MemberListType_documentationLists,
180  MemberListType_docFriendMembers = 65 + MemberListType_documentationLists,
181  MemberListType_docPropMembers = 66 + MemberListType_documentationLists,
182 
183  MemberListType_redefinedBy = 67,
184  MemberListType_enumFields = 68,
185  MemberListType_memberGroup = 69,
186 
187  // this one is for the summary section on the class page
188  MemberListType_interfaces = 70,
189  // this one is for the detailed section on the class page
190  MemberListType_interfaceMembers = 71 + MemberListType_detailedLists,
191  MemberListType_services = 72,
192  MemberListType_serviceMembers = 73 + MemberListType_detailedLists,
193 };
194 
195 enum MemberType
196 {
197  MemberType_Define,
198  MemberType_Function,
199  MemberType_Variable,
200  MemberType_Typedef,
201  MemberType_Enumeration,
202  MemberType_EnumValue,
203  MemberType_Signal,
204  MemberType_Slot,
205  MemberType_Friend,
206  MemberType_DCOP,
207  MemberType_Property,
208  MemberType_Event,
209  MemberType_Interface,
210  MemberType_Service,
211 };
212 
213 enum FortranFormat
214 {
215  FortranFormat_Unknown,
216  FortranFormat_Free,
217  FortranFormat_Fixed
218 };
219 
220 #endif