Doxygen
Loading...
Searching...
No Matches
Classes | Macros | Enumerations | Functions
types.h File Reference

This file contains a number of basic enums and types. More...

#include "qcstring.h"
+ Include dependency graph for types.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

struct  Grouping
 Grouping info. More...
 
class  MemberListType
 Wrapper class for the MemberListType type. More...
 
class  LocalToc
 
class  TypeSpecifier
 Wrapper class for a number of boolean properties. More...
 
class  EntryType
 Wrapper class for the Entry type. More...
 

Macros

#define ML_TYPES
 
#define ML_TYPE(x, bits, to_pub, to_prot, label, xml_str)
 
#define ML_TYPE(x, bits, to_pub, to_prot, label, xml_str)
 
#define ML_TYPE(x, bits, to_pub, to_prot, label, xml_str)
 
#define ML_TYPE(x, bits, to_pub, to_prot, label, xml_str)
 
#define ML_TYPE(x, bits, to_pub, to_prot, label, xml_str)
 
#define ML_TYPE(x, bits, to_pub, to_prot, label, xml_str)
 
#define ML_TYPE(x, bits, to_pub, to_prot, label, xml_str)
 
#define TYPE_SPECIFIERS
 
#define TSPEC(x)
 
#define TSPEC(x)
 
#define TSPEC(x)
 
#define TSPEC(x)
 
#define ENTRY_TYPES
 
#define ETYPE(x, bits)
 
#define ETYPE(x, bits)
 
#define ETYPE(x, bits)
 

Enumerations

enum class  Protection { Public , Protected , Private , Package }
 Protection level of members. More...
 
enum class  Specifier { Normal , Virtual , Pure }
 Virtualness of a member. More...
 
enum class  MethodTypes {
  Method , Signal , Slot , DCOP ,
  Property , Event
}
 Kind of method. More...
 
enum class  RelatesType { Simple , Duplicate , MemberOf }
 Type of member relation. More...
 
enum class  Relationship { Member , Related , Foreign }
 Kind of member relationship. More...
 
enum class  SrcLangExt {
  Unknown = 0x00000 , IDL = 0x00008 , Java = 0x00010 , CSharp = 0x00020 ,
  D = 0x00040 , PHP = 0x00080 , ObjC = 0x00100 , Cpp = 0x00200 ,
  JS = 0x00400 , Python = 0x00800 , Fortran = 0x01000 , VHDL = 0x02000 ,
  XML = 0x04000 , Markdown = 0x10000 , SQL = 0x20000 , Slice = 0x40000 ,
  Lex = 0x80000
}
 Language as given by extension. More...
 
enum class  MemberListContainer {
  File , Namespace , Group , Class ,
  Module
}
 
enum class  CodeSymbolType {
  Default , Class , Struct , Union ,
  Interface , Protocol , Category , Exception ,
  Service , Singleton , Concept , Namespace ,
  Package , Module , Define , Function ,
  Variable , Typedef , EnumValue , Enumeration ,
  Signal , Slot , Friend , DCOP ,
  Property , Event , Sequence , Dictionary
}
 
enum class  MemberType {
  Define , Function , Variable , Typedef ,
  Enumeration , EnumValue , Signal , Slot ,
  Friend , DCOP , Property , Event ,
  Interface , Service , Sequence , Dictionary
}
 
enum class  FortranFormat { Unknown , Free , Fixed }
 
enum class  VhdlSpecifier {
  UNKNOWN =0 , LIBRARY , ENTITY , PACKAGE_BODY ,
  ARCHITECTURE , PACKAGE , ATTRIBUTE , SIGNAL ,
  COMPONENT , CONSTANT , TYPE , SUBTYPE ,
  FUNCTION , RECORD , PROCEDURE , USE ,
  PROCESS , PORT , UNITS , GENERIC ,
  INSTANTIATION , GROUP , VFILE , SHAREDVARIABLE ,
  CONFIG , ALIAS , MISCELLANEOUS , UCF_CONST
}
 

Functions

constexpr const char * codeSymbolType2Str (CodeSymbolType type)
 

Detailed Description

This file contains a number of basic enums and types.

Definition in file types.h.

Macro Definition Documentation

◆ ENTRY_TYPES

#define ENTRY_TYPES

Definition at line 581 of file types.h.

581#define ENTRY_TYPES \
582 ETYPE(Empty, None) \
583 ETYPE(Class, Compound|Scope) \
584 ETYPE(Namespace, Scope) \
585 ETYPE(Concept, None) \
586 ETYPE(ClassDoc, CompoundDoc|Doc) \
587 ETYPE(StructDoc, CompoundDoc|Doc) \
588 ETYPE(UnionDoc, CompoundDoc|Doc) \
589 ETYPE(ExceptionDoc, CompoundDoc|Doc) \
590 ETYPE(InterfaceDoc, CompoundDoc|Doc) \
591 ETYPE(ProtocolDoc, CompoundDoc|Doc) \
592 ETYPE(CategoryDoc, CompoundDoc|Doc) \
593 ETYPE(ServiceDoc, CompoundDoc|Doc) \
594 ETYPE(SingletonDoc, CompoundDoc|Doc) \
595 ETYPE(Source, File) \
596 ETYPE(Header, File) \
597 ETYPE(ModuleDoc, Doc) \
598 ETYPE(ConceptDoc, Doc) \
599 ETYPE(NamespaceDoc, Doc) \
600 ETYPE(EnumDoc, Doc) \
601 ETYPE(PageDoc, Doc) \
602 ETYPE(MemberDoc, Doc) \
603 ETYPE(OverloadDoc, Doc) \
604 ETYPE(Example, Doc) \
605 ETYPE(VariableDoc, Doc) \
606 ETYPE(FileDoc, Doc) \
607 ETYPE(DefineDoc, Doc) \
608 ETYPE(GroupDoc, Doc) \
609 ETYPE(MainpageDoc, Doc) \
610 ETYPE(MemberGrp, Doc) \
611 ETYPE(PackageDoc, Doc) \
612 ETYPE(DirDoc, Doc) \
613 ETYPE(Variable, None) \
614 ETYPE(Function, None) \
615 ETYPE(Typedef, None) \
616 ETYPE(Include, None) \
617 ETYPE(Enum, None) \
618 ETYPE(Define, None) \
619 ETYPE(UsingDir, None) \
620 ETYPE(UsingDecl, None) \
621 ETYPE(Package, None) \
622 ETYPE(ObjcImpl, None) \
623 ETYPE(ExportedInterface, None) \
624 ETYPE(IncludedService, None) \
625 ETYPE(ExampleLineno, None) \
626

◆ ETYPE [1/3]

#define ETYPE ( x,
bits )
Value:
static EntryType make##x() { return EntryType(static_cast<int>(x)|static_cast<int>(bits)); } \
bool is##x() const { return (m_type&TypeMask)==x; }

Definition at line 633 of file types.h.

633#define ETYPE(x,bits) \
634 static EntryType make##x() { return EntryType(static_cast<int>(x)|static_cast<int>(bits)); } \
635 bool is##x() const { return (m_type&TypeMask)==x; }

◆ ETYPE [2/3]

#define ETYPE ( x,
bits )
Value:
case x : return "["+std::string(#x)+bits_to_string()+"]";

Definition at line 633 of file types.h.

633#define ETYPE(x,bits) \
634 static EntryType make##x() { return EntryType(static_cast<int>(x)|static_cast<int>(bits)); } \
635 bool is##x() const { return (m_type&TypeMask)==x; }

◆ ETYPE [3/3]

#define ETYPE ( x,
bits )
Value:
x,

Definition at line 633 of file types.h.

633#define ETYPE(x,bits) \
634 static EntryType make##x() { return EntryType(static_cast<int>(x)|static_cast<int>(bits)); } \
635 bool is##x() const { return (m_type&TypeMask)==x; }

◆ ML_TYPE [1/7]

#define ML_TYPE ( x,
bits,
to_pub,
to_prot,
label,
xml_str )
Value:
x##_,

Definition at line 202 of file types.h.

202#define ML_TYPE(x,bits,to_pub,to_prot,label,xml_str) \
203 x##_,

◆ ML_TYPE [2/7]

#define ML_TYPE ( x,
bits,
to_pub,
to_prot,
label,
xml_str )
Value:
static MemberListType x() { return MemberListType(static_cast<int>(x##_)|static_cast<int>(bits)); } \
bool is##x() const { return (m_type&TypeMask)==x##_; }

Definition at line 202 of file types.h.

202#define ML_TYPE(x,bits,to_pub,to_prot,label,xml_str) \
203 x##_,

◆ ML_TYPE [3/7]

#define ML_TYPE ( x,
bits,
to_pub,
to_prot,
label,
xml_str )
Value:
case x##_ : return "["+std::string(#x)+bits_to_string()+"]";

Definition at line 202 of file types.h.

202#define ML_TYPE(x,bits,to_pub,to_prot,label,xml_str) \
203 x##_,

◆ ML_TYPE [4/7]

#define ML_TYPE ( x,
bits,
to_pub,
to_prot,
label,
xml_str )
Value:
case x##_ : return label;

Definition at line 202 of file types.h.

202#define ML_TYPE(x,bits,to_pub,to_prot,label,xml_str) \
203 x##_,

◆ ML_TYPE [5/7]

#define ML_TYPE ( x,
bits,
to_pub,
to_prot,
label,
xml_str )
Value:
case x##_ : return xml_str;

Definition at line 202 of file types.h.

202#define ML_TYPE(x,bits,to_pub,to_prot,label,xml_str) \
203 x##_,

◆ ML_TYPE [6/7]

#define ML_TYPE ( x,
bits,
to_pub,
to_prot,
label,
xml_str )
Value:
case x##_ : return to_pub();

Definition at line 202 of file types.h.

202#define ML_TYPE(x,bits,to_pub,to_prot,label,xml_str) \
203 x##_,

◆ ML_TYPE [7/7]

#define ML_TYPE ( x,
bits,
to_pub,
to_prot,
label,
xml_str )
Value:
case x##_ : return to_prot();

Definition at line 202 of file types.h.

202#define ML_TYPE(x,bits,to_pub,to_prot,label,xml_str) \
203 x##_,

◆ ML_TYPES

#define ML_TYPES

Definition at line 101 of file types.h.

101#define ML_TYPES \
102 ML_TYPE(PubMethods, Public, Invalid, Invalid, "pub-methods", "public-func" ) \
103 ML_TYPE(ProMethods, Protected, PubMethods, Invalid, "pro-methods", "protected-func" ) \
104 ML_TYPE(PacMethods, Package, Invalid, Invalid, "pac-methods", "package-func" ) \
105 ML_TYPE(PriMethods, Private, PubMethods, ProMethods, "pri-methods", "private-func" ) \
106 ML_TYPE(PubStaticMethods, Public, Invalid, Invalid, "pub-static-methods", "public-static-func" ) \
107 ML_TYPE(ProStaticMethods, Protected, PubStaticMethods, Invalid, "pro-static-methods", "protected-static-func" ) \
108 ML_TYPE(PacStaticMethods, Package, Invalid, Invalid, "pac-static-methods", "package-static-func" ) \
109 ML_TYPE(PriStaticMethods, Private, PubStaticMethods, ProStaticMethods, "pri-static-methods", "private-static-func" ) \
110 ML_TYPE(PubSlots, Public, Invalid, Invalid, "pub-slots", "public-slot" ) \
111 ML_TYPE(ProSlots, Protected, PubSlots, Invalid, "pro-slots", "protected-slot" ) \
112 ML_TYPE(PriSlots, Private, PubSlots, ProSlots, "pri-slots", "private-slot" ) \
113 ML_TYPE(PubAttribs, Public, Invalid, Invalid, "pub-attribs", "public-attrib" ) \
114 ML_TYPE(ProAttribs, Protected, PubAttribs, Invalid, "pro-attribs", "protected-attrib" ) \
115 ML_TYPE(PacAttribs, Package, Invalid, Invalid, "pac-attribs", "package-attrib" ) \
116 ML_TYPE(PriAttribs, Private, PubAttribs, ProAttribs, "pri-attribs", "private-attrib" ) \
117 ML_TYPE(PubStaticAttribs, Public, Invalid, Invalid, "pub-static-attribs", "public-static-attrib" ) \
118 ML_TYPE(ProStaticAttribs, Protected, PubStaticAttribs, Invalid, "pro-static-attribs", "protected-static-attrib" ) \
119 ML_TYPE(PacStaticAttribs, Package, Invalid, Invalid, "pac-static-attribs", "package-static-attrib" ) \
120 ML_TYPE(PriStaticAttribs, Private, PubStaticAttribs, ProStaticAttribs, "pri-static-attribs", "private-static-attrib" ) \
121 ML_TYPE(PubTypes, Public, Invalid, Invalid, "pub-types", "public-type" ) \
122 ML_TYPE(ProTypes, Protected, PubTypes, Invalid, "pro-types", "protected-type" ) \
123 ML_TYPE(PacTypes, Package, Invalid, Invalid, "pac-types", "package-type" ) \
124 ML_TYPE(PriTypes, Private, PubTypes, ProTypes, "pri-types", "private-type" ) \
125 ML_TYPE(Related, OnlyPublic, Invalid, Invalid, "related", "related" ) \
126 ML_TYPE(Signals, OnlyPublic, Invalid, Invalid, "signals", "signal" ) \
127 ML_TYPE(Friends, OnlyPublic, Invalid, Invalid, "friends", "friend" ) \
128 ML_TYPE(DcopMethods, OnlyPublic, Invalid, Invalid, "dcop-methods", "dcop-func" ) \
129 ML_TYPE(Properties, OnlyPublic, Invalid, Invalid, "properties", "property" ) \
130 ML_TYPE(Events, OnlyPublic, Invalid, Invalid, "events", "event" ) \
131 ML_TYPE(AllMembersList, OnlyPublic, Invalid, Invalid, "", "" ) \
132 ML_TYPE(EnumFields, OnlyPublic, Invalid, Invalid, "enum-fields", "" ) \
133 ML_TYPE(MemberGroup, OnlyPublic, Invalid, Invalid, "", "" ) \
134 ML_TYPE(Interfaces, OnlyPublic, Invalid, Invalid, "interfaces", "interfaces" ) \
135 ML_TYPE(Services, OnlyPublic, Invalid, Invalid, "services", "services" ) \
136 ML_TYPE(DecDefineMembers, Declaration, Invalid, Invalid, "define-members", "define" ) \
137 ML_TYPE(DecProtoMembers, Declaration, Invalid, Invalid, "proto-members", "prototype" ) \
138 ML_TYPE(DecTypedefMembers, Declaration, Invalid, Invalid, "typedef-members", "typedef" ) \
139 ML_TYPE(DecEnumMembers, Declaration, Invalid, Invalid, "enum-members", "enum" ) \
140 ML_TYPE(DecFuncMembers, Declaration, Invalid, Invalid, "func-members", "func" ) \
141 ML_TYPE(DecVarMembers, Declaration, Invalid, Invalid, "var-members", "var" ) \
142 ML_TYPE(DecEnumValMembers, Declaration, Invalid, Invalid, "enumval-members", "" ) \
143 ML_TYPE(DecPubSlotMembers, Declaration, Invalid, Invalid, "pub-slot-members", "" ) \
144 ML_TYPE(DecProSlotMembers, Declaration, Invalid, Invalid, "pro-slot-members", "" ) \
145 ML_TYPE(DecPriSlotMembers, Declaration, Invalid, Invalid, "pri-slot-members", "" ) \
146 ML_TYPE(DecSignalMembers, Declaration, Invalid, Invalid, "signal-members", "" ) \
147 ML_TYPE(DecEventMembers, Declaration, Invalid, Invalid, "event-members", "" ) \
148 ML_TYPE(DecFriendMembers, Declaration, Invalid, Invalid, "friend-members", "" ) \
149 ML_TYPE(DecPropMembers, Declaration, Invalid, Invalid, "prop-members", "" ) \
150 ML_TYPE(DecSequenceMembers, Declaration, Invalid, Invalid, "sequence-members", "sequence" ) \
151 ML_TYPE(DecDictionaryMembers,Declaration, Invalid, Invalid, "dictionary-members", "dictionary" ) \
152 ML_TYPE(TypedefMembers, Detailed, Invalid, Invalid, "", "" ) \
153 ML_TYPE(EnumMembers, Detailed, Invalid, Invalid, "", "" ) \
154 ML_TYPE(EnumValMembers, Detailed, Invalid, Invalid, "", "" ) \
155 ML_TYPE(FunctionMembers, Detailed, Invalid, Invalid, "", "" ) \
156 ML_TYPE(RelatedMembers, Detailed, Invalid, Invalid, "", "" ) \
157 ML_TYPE(VariableMembers, Detailed, Invalid, Invalid, "", "" ) \
158 ML_TYPE(PropertyMembers, Detailed, Invalid, Invalid, "", "" ) \
159 ML_TYPE(EventMembers, Detailed, Invalid, Invalid, "", "" ) \
160 ML_TYPE(Constructors, Detailed, Invalid, Invalid, "", "" ) \
161 ML_TYPE(InterfaceMembers, Detailed, Invalid, Invalid, "interface-members", "" ) \
162 ML_TYPE(ServiceMembers, Detailed, Invalid, Invalid, "service-members", "" ) \
163 ML_TYPE(DocDefineMembers, Documentation,Invalid, Invalid, "", "" ) \
164 ML_TYPE(DocProtoMembers, Documentation,Invalid, Invalid, "", "" ) \
165 ML_TYPE(DocTypedefMembers, Documentation,Invalid, Invalid, "", "" ) \
166 ML_TYPE(DocEnumMembers, Documentation,Invalid, Invalid, "", "" ) \
167 ML_TYPE(DocFuncMembers, Documentation,Invalid, Invalid, "", "" ) \
168 ML_TYPE(DocVarMembers, Documentation,Invalid, Invalid, "", "" ) \
169 ML_TYPE(DocEnumValMembers, Documentation,Invalid, Invalid, "", "" ) \
170 ML_TYPE(DocPubSlotMembers, Documentation,Invalid, Invalid, "", "" ) \
171 ML_TYPE(DocProSlotMembers, Documentation,Invalid, Invalid, "", "" ) \
172 ML_TYPE(DocPriSlotMembers, Documentation,Invalid, Invalid, "", "" ) \
173 ML_TYPE(DocSignalMembers, Documentation,Invalid, Invalid, "", "" ) \
174 ML_TYPE(DocEventMembers, Documentation,Invalid, Invalid, "", "" ) \
175 ML_TYPE(DocFriendMembers, Documentation,Invalid, Invalid, "", "" ) \
176 ML_TYPE(DocPropMembers, Documentation,Invalid, Invalid, "", "" ) \
177 ML_TYPE(DocSequenceMembers, Documentation,Invalid, Invalid, "", "" ) \
178 ML_TYPE(DocDictionaryMembers,Documentation,Invalid, Invalid, "", "" ) \
179

◆ TSPEC [1/4]

#define TSPEC ( x)
Value:
m_is##x = m_is##x || other.is##x();

Definition at line 536 of file types.h.

536#define TSPEC(x) \
537 public: \
538 TypeSpecifier &set##x(bool b) { m_is##x = b; return *this; } \
539 bool is##x() const { return m_is##x; } \
540 private: \
541 bool m_is##x : 1;

◆ TSPEC [2/4]

#define TSPEC ( x)
Value:
eq = eq && (t1.m_is##x == t2.m_is##x);

Definition at line 536 of file types.h.

536#define TSPEC(x) \
537 public: \
538 TypeSpecifier &set##x(bool b) { m_is##x = b; return *this; } \
539 bool is##x() const { return m_is##x; } \
540 private: \
541 bool m_is##x : 1;

◆ TSPEC [3/4]

#define TSPEC ( x)
Value:
if (m_is##x) { \
if (!first) result+=","; \
result+=#x; first=false; \
}

Definition at line 536 of file types.h.

536#define TSPEC(x) \
537 public: \
538 TypeSpecifier &set##x(bool b) { m_is##x = b; return *this; } \
539 bool is##x() const { return m_is##x; } \
540 private: \
541 bool m_is##x : 1;

◆ TSPEC [4/4]

#define TSPEC ( x)
Value:
public: \
TypeSpecifier &set##x(bool b) { m_is##x = b; return *this; } \
bool is##x() const { return m_is##x; } \
private: \
bool m_is##x : 1;

Definition at line 536 of file types.h.

536#define TSPEC(x) \
537 public: \
538 TypeSpecifier &set##x(bool b) { m_is##x = b; return *this; } \
539 bool is##x() const { return m_is##x; } \
540 private: \
541 bool m_is##x : 1;

◆ TYPE_SPECIFIERS

#define TYPE_SPECIFIERS
Value:
/* 0 */ TSPEC(Template) TSPEC(Generic) TSPEC(Ref) TSPEC(Value) TSPEC(Interface) \
/* 5 */ TSPEC(Struct) TSPEC(Union) TSPEC(Exception) TSPEC(Protocol) TSPEC(Category) \
/* 10 */ TSPEC(SealedClass) TSPEC(AbstractClass) TSPEC(Enum) TSPEC(Service) TSPEC(Singleton) \
/* 15 */ TSPEC(ForwardDecl) TSPEC(Local) TSPEC(EnumStruct) TSPEC(ConstExpr) TSPEC(PrivateGettable) \
/* 20 */ TSPEC(ProtectedGettable) TSPEC(PrivateSettable) TSPEC(ProtectedSettable) TSPEC(Inline) TSPEC(Explicit) \
/* 25 */ TSPEC(Mutable) TSPEC(Settable) TSPEC(Gettable) TSPEC(Readable) TSPEC(Writable) \
/* 30 */ TSPEC(Final) TSPEC(Abstract) TSPEC(Addable) TSPEC(Removable) TSPEC(Raisable) \
/* 35 */ TSPEC(Override) TSPEC(New) TSPEC(Sealed) TSPEC(Initonly) TSPEC(Optional) \
/* 40 */ TSPEC(Required) TSPEC(NonAtomic) TSPEC(Copy) TSPEC(Retain) TSPEC(Assign) \
/* 45 */ TSPEC(Strong) TSPEC(Weak) TSPEC(Unretained) TSPEC(Alias) TSPEC(ConstExp) \
/* 50 */ TSPEC(Default) TSPEC(Delete) TSPEC(NoExcept) TSPEC(Attribute) TSPEC(Property) \
/* 55 */ TSPEC(Readonly) TSPEC(Bound) TSPEC(Constrained) TSPEC(Transient) TSPEC(MaybeVoid) \
/* 60 */ TSPEC(MaybeDefault) TSPEC(MaybeAmbiguous) TSPEC(Published) TSPEC(ConstEval) TSPEC(ConstInit) \
/* 65 */ TSPEC(NoDiscard)
CommandSpacing::Inline
@ Inline
command appears inline in the output which can be a brief description.
Definition commentscan.l:186
MethodTypes::Property
@ Property
Definition types.h:32
TSPEC
#define TSPEC(x)
Definition types.h:536

Definition at line 472 of file types.h.

472#define TYPE_SPECIFIERS \
473/* 0 */ TSPEC(Template) TSPEC(Generic) TSPEC(Ref) TSPEC(Value) TSPEC(Interface) \
474/* 5 */ TSPEC(Struct) TSPEC(Union) TSPEC(Exception) TSPEC(Protocol) TSPEC(Category) \
475/* 10 */ TSPEC(SealedClass) TSPEC(AbstractClass) TSPEC(Enum) TSPEC(Service) TSPEC(Singleton) \
476/* 15 */ TSPEC(ForwardDecl) TSPEC(Local) TSPEC(EnumStruct) TSPEC(ConstExpr) TSPEC(PrivateGettable) \
477/* 20 */ TSPEC(ProtectedGettable) TSPEC(PrivateSettable) TSPEC(ProtectedSettable) TSPEC(Inline) TSPEC(Explicit) \
478/* 25 */ TSPEC(Mutable) TSPEC(Settable) TSPEC(Gettable) TSPEC(Readable) TSPEC(Writable) \
479/* 30 */ TSPEC(Final) TSPEC(Abstract) TSPEC(Addable) TSPEC(Removable) TSPEC(Raisable) \
480/* 35 */ TSPEC(Override) TSPEC(New) TSPEC(Sealed) TSPEC(Initonly) TSPEC(Optional) \
481/* 40 */ TSPEC(Required) TSPEC(NonAtomic) TSPEC(Copy) TSPEC(Retain) TSPEC(Assign) \
482/* 45 */ TSPEC(Strong) TSPEC(Weak) TSPEC(Unretained) TSPEC(Alias) TSPEC(ConstExp) \
483/* 50 */ TSPEC(Default) TSPEC(Delete) TSPEC(NoExcept) TSPEC(Attribute) TSPEC(Property) \
484/* 55 */ TSPEC(Readonly) TSPEC(Bound) TSPEC(Constrained) TSPEC(Transient) TSPEC(MaybeVoid) \
485/* 60 */ TSPEC(MaybeDefault) TSPEC(MaybeAmbiguous) TSPEC(Published) TSPEC(ConstEval) TSPEC(ConstInit) \
486/* 65 */ TSPEC(NoDiscard)

Referenced by TypeSpecifier::merge(), TypeSpecifier::operator==, and TypeSpecifier::to_string().

Enumeration Type Documentation

◆ CodeSymbolType

enum class CodeSymbolType
strong
Enumerator
Default 
Class 
Struct 
Union 
Interface 
Protocol 
Category 
Exception 
Service 
Singleton 
Concept 
Namespace 
Package 
Module 
Define 
Function 
Variable 
Typedef 
EnumValue 
Enumeration 
Signal 
Slot 
Friend 
DCOP 
Property 
Event 
Sequence 
Dictionary 

Definition at line 318 of file types.h.

319{
320 Default,
321 // Class types
322 Class,
323 Struct,
324 Union,
325 Interface,
326 Protocol,
327 Category,
328 Exception,
329 Service,
330 Singleton,
331 // Other container types
332 Concept,
333 Namespace,
334 Package,
335 Module,
336 // Member types
337 Define,
338 Function,
339 Variable,
340 Typedef,
341 EnumValue,
342 Enumeration,
343 Signal,
344 Slot,
345 Friend,
346 DCOP,
347 Property,
348 Event,
349 Sequence,
350 Dictionary
351};

◆ FortranFormat

enum class FortranFormat
strong
Enumerator
Unknown 
Free 
Fixed 

Definition at line 409 of file types.h.

410{
411 Unknown,
412 Free,
413 Fixed
414};

◆ MemberListContainer

enum class MemberListContainer
strong
Enumerator
File 
Namespace 
Group 
Class 
Module 

Definition at line 309 of file types.h.

310{
311 File,
312 Namespace,
313 Group,
314 Class,
315 Module
316};

◆ MemberType

enum class MemberType
strong
Enumerator
Define 
Function 
Variable 
Typedef 
Enumeration 
EnumValue 
Signal 
Slot 
Friend 
DCOP 
Property 
Event 
Interface 
Service 
Sequence 
Dictionary 

Definition at line 389 of file types.h.

390{
391 Define,
392 Function,
393 Variable,
394 Typedef,
395 Enumeration,
396 EnumValue,
397 Signal,
398 Slot,
399 Friend,
400 DCOP,
401 Property,
402 Event,
403 Interface,
404 Service,
405 Sequence,
406 Dictionary
407};
MemberType::Enumeration
@ Enumeration
Definition types.h:395
MemberType::EnumValue
@ EnumValue
Definition types.h:396
MemberType::Dictionary
@ Dictionary
Definition types.h:406
MemberType::Interface
@ Interface
Definition types.h:403
MemberType::Sequence
@ Sequence
Definition types.h:405
MemberType::Variable
@ Variable
Definition types.h:393
MemberType::Property
@ Property
Definition types.h:401
MemberType::Typedef
@ Typedef
Definition types.h:394
MemberType::Function
@ Function
Definition types.h:392
MemberType::Service
@ Service
Definition types.h:404

◆ MethodTypes

enum class MethodTypes
strong

Kind of method.

Enumerator
Method 
Signal 
Slot 
DCOP 
Property 
Event 

Definition at line 32 of file types.h.

32{ Method, Signal, Slot, DCOP, Property, Event };

◆ Protection

enum class Protection
strong

Protection level of members.

Enumerator
Public 
Protected 
Private 
Package 

Definition at line 26 of file types.h.

26{ Public, Protected, Private, Package } ;
Protection::Package
@ Package
Definition types.h:26
Protection::Public
@ Public
Definition types.h:26
Protection::Private
@ Private
Definition types.h:26
Protection::Protected
@ Protected
Definition types.h:26

◆ RelatesType

enum class RelatesType
strong

Type of member relation.

Enumerator
Simple 
Duplicate 
MemberOf 

Definition at line 35 of file types.h.

35{ Simple, Duplicate, MemberOf };
RelatesType::MemberOf
@ MemberOf
Definition types.h:35
RelatesType::Duplicate
@ Duplicate
Definition types.h:35

◆ Relationship

enum class Relationship
strong

Kind of member relationship.

Enumerator
Member 
Related 
Foreign 

Definition at line 38 of file types.h.

38{ Member, Related, Foreign };

◆ Specifier

enum class Specifier
strong

Virtualness of a member.

Enumerator
Normal 
Virtual 
Pure 

Definition at line 29 of file types.h.

29{ Normal, Virtual, Pure } ;
Specifier::Virtual
@ Virtual
Definition types.h:29
Specifier::Normal
@ Normal
Definition types.h:29
Specifier::Pure
@ Pure
Definition types.h:29

◆ SrcLangExt

enum class SrcLangExt
strong

Language as given by extension.

Enumerator
Unknown 
IDL 
Java 
CSharp 
D 
PHP 
ObjC 
Cpp 
JS 
Python 
Fortran 
VHDL 
XML 
Markdown 
SQL 
Slice 
Lex 

Definition at line 41 of file types.h.

42{
43 Unknown = 0x00000,
44 IDL = 0x00008,
45 Java = 0x00010,
46 CSharp = 0x00020,
47 D = 0x00040,
48 PHP = 0x00080,
49 ObjC = 0x00100,
50 Cpp = 0x00200,
51 JS = 0x00400,
52 Python = 0x00800,
53 Fortran = 0x01000,
54 VHDL = 0x02000,
55 XML = 0x04000,
56 //Tcl = 0x08000, // no longer supported
57 Markdown = 0x10000,
58 SQL = 0x20000,
59 Slice = 0x40000,
60 Lex = 0x80000
61};
SrcLangExt::Markdown
@ Markdown
Definition types.h:57
SrcLangExt::CSharp
@ CSharp
Definition types.h:46
SrcLangExt::Fortran
@ Fortran
Definition types.h:53
SrcLangExt::Unknown
@ Unknown
Definition types.h:43
SrcLangExt::Python
@ Python
Definition types.h:52
SrcLangExt::Slice
@ Slice
Definition types.h:59

◆ VhdlSpecifier

enum class VhdlSpecifier
strong
Enumerator
UNKNOWN 
LIBRARY 
ENTITY 
PACKAGE_BODY 
ARCHITECTURE 
PACKAGE 
ATTRIBUTE 
SIGNAL 
COMPONENT 
CONSTANT 
TYPE 
SUBTYPE 
FUNCTION 
RECORD 
PROCEDURE 
USE 
PROCESS 
PORT 
UNITS 
GENERIC 
INSTANTIATION 
GROUP 
VFILE 
SHAREDVARIABLE 
CONFIG 
ALIAS 
MISCELLANEOUS 
UCF_CONST 

Definition at line 547 of file types.h.

548{
549 UNKNOWN=0,
550 LIBRARY,
551 ENTITY,
552 PACKAGE_BODY,
553 ARCHITECTURE,
554 PACKAGE,
555 ATTRIBUTE,
556 SIGNAL,
557 COMPONENT,
558 CONSTANT,
559 TYPE,
560 SUBTYPE,
561 FUNCTION,
562 RECORD,
563 PROCEDURE,
564 USE,
565 PROCESS,
566 PORT,
567 UNITS,
568 GENERIC,
569 INSTANTIATION,
570 GROUP,
571 VFILE,
572 SHAREDVARIABLE,
573 CONFIG,
574 ALIAS,
575 MISCELLANEOUS,
576 UCF_CONST
577};
VhdlSpecifier::INSTANTIATION
@ INSTANTIATION
Definition types.h:569
VhdlSpecifier::MISCELLANEOUS
@ MISCELLANEOUS
Definition types.h:575
VhdlSpecifier::SHAREDVARIABLE
@ SHAREDVARIABLE
Definition types.h:572

Function Documentation

◆ codeSymbolType2Str()

const char * codeSymbolType2Str ( CodeSymbolType type)
constexpr

Definition at line 353 of file types.h.

354{
355 switch (type)
356 {
357 case CodeSymbolType::Class: return "class";
358 case CodeSymbolType::Struct: return "struct";
359 case CodeSymbolType::Union: return "union";
360 case CodeSymbolType::Interface: return "interface";
361 case CodeSymbolType::Protocol: return "protocol";
362 case CodeSymbolType::Category: return "category";
363 case CodeSymbolType::Exception: return "exception";
364 case CodeSymbolType::Service: return "service";
365 case CodeSymbolType::Singleton: return "singleton";
366 case CodeSymbolType::Concept: return "concept";
367 case CodeSymbolType::Namespace: return "namespace";
368 case CodeSymbolType::Package: return "package";
369 case CodeSymbolType::Define: return "define";
370 case CodeSymbolType::Function: return "function";
371 case CodeSymbolType::Variable: return "variable";
372 case CodeSymbolType::Typedef: return "typedef";
373 case CodeSymbolType::EnumValue: return "enumvalue";
374 case CodeSymbolType::Enumeration: return "enumeration";
375 case CodeSymbolType::Signal: return "signal";
376 case CodeSymbolType::Slot: return "slot";
377 case CodeSymbolType::Friend: return "friend";
378 case CodeSymbolType::DCOP: return "dcop";
379 case CodeSymbolType::Property: return "property";
380 case CodeSymbolType::Event: return "event";
381 case CodeSymbolType::Sequence: return "sequence";
382 case CodeSymbolType::Dictionary: return "dictionary";
383 default:
384 return nullptr;
385 }
386}

References Category, Class, Concept, DCOP, Define, Dictionary, Enumeration, EnumValue, Event, Exception, Friend, Function, Interface, Namespace, Package, Property, Protocol, Sequence, Service, Signal, Singleton, Slot, Struct, Typedef, Union, and Variable.

Referenced by HtmlCodeGenerator::writeCodeLink().