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	PROTECTION_SPECIFICATIONS
	Protection level of members.
#define	PROTSPEC(x, y, z)
#define	PROTSPEC(x, y, z)
#define	PROTSPEC(x, y, z)
#define	PROTSPEC(x, y, z)
#define	SPECIFIER_SPECIFICATIONS
	Virtualness of a member.
#define	SPECSPEC(x, y)
#define	SPECSPEC(x, y)
#define	SPECSPEC(x, y)
#define	METHODTYPE_SPECIFICATIONS
	Kind of method.
#define	MTSPEC(x)
#define	MTSPEC(x)
#define	RELATESTYPE_SPECIFICATIONS
	Type of member relation.
#define	RTSPEC(x)
#define	RTSPEC(x)
#define	RELATIONSHIP_SPECIFICATIONS
	Kind of member relationship.
#define	RSSPEC(x)
#define	RSSPEC(x)
#define	SRCLANGEXT_SPECIFICATIONS
	Language as given by extension.
#define	SRCLANGEXT(x, v, z)
#define	SRCLANGEXT(x, v, z)
#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 { PROTECTION_SPECIFICATIONS }
enum class	Specifier { SPECIFIER_SPECIFICATIONS }
enum class	MethodTypes { METHODTYPE_SPECIFICATIONS }
enum class	RelatesType { RELATESTYPE_SPECIFICATIONS }
enum class	Relationship { RELATIONSHIP_SPECIFICATIONS }
enum class	SrcLangExt { SRCLANGEXT_SPECIFICATIONS }
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
static const char *	to_string (Protection prot)
static const char *	to_string_lower (Protection prot)
static const char *	to_string_lower_class (Protection prot)
static const char *	to_string (Specifier spec)
static const char *	to_string_lower (Specifier spec)
static const char *	to_string (MethodTypes mt)
static const char *	to_string (RelatesType rt)
static const char *	to_string (Relationship rs)
static const char *	to_string (SrcLangExt sle)
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 743 of file types.h.

#define ENTRY_TYPES                         \
 ETYPE(Empty,              None)            \
 ETYPE(Class,              Compound|Scope)  \
 ETYPE(Namespace,          Scope)           \
 ETYPE(Concept,            None)            \
 ETYPE(ClassDoc,           CompoundDoc|Doc) \
 ETYPE(StructDoc,          CompoundDoc|Doc) \
 ETYPE(UnionDoc,           CompoundDoc|Doc) \
 ETYPE(ExceptionDoc,       CompoundDoc|Doc) \
 ETYPE(InterfaceDoc,       CompoundDoc|Doc) \
 ETYPE(ProtocolDoc,        CompoundDoc|Doc) \
 ETYPE(CategoryDoc,        CompoundDoc|Doc) \
 ETYPE(ServiceDoc,         CompoundDoc|Doc) \
 ETYPE(SingletonDoc,       CompoundDoc|Doc) \
 ETYPE(Source,             File)            \
 ETYPE(Header,             File)            \
 ETYPE(ModuleDoc,          Doc)             \
 ETYPE(ConceptDoc,         Doc)             \
 ETYPE(NamespaceDoc,       Doc)             \
 ETYPE(EnumDoc,            Doc)             \
 ETYPE(PageDoc,            Doc)             \
 ETYPE(MemberDoc,          Doc)             \
 ETYPE(OverloadDoc,        Doc)             \
 ETYPE(Example,            Doc)             \
 ETYPE(VariableDoc,        Doc)             \
 ETYPE(FileDoc,            Doc)             \
 ETYPE(DefineDoc,          Doc)             \
 ETYPE(GroupDoc,           Doc)             \
 ETYPE(MainpageDoc,        Doc)             \
 ETYPE(MemberGrp,          Doc)             \
 ETYPE(PackageDoc,         Doc)             \
 ETYPE(DirDoc,             Doc)             \
 ETYPE(Variable,           None)            \
 ETYPE(Function,           None)            \
 ETYPE(Typedef,            None)            \
 ETYPE(Include,            None)            \
 ETYPE(Enum,               None)            \
 ETYPE(Define,             None)            \
 ETYPE(UsingDir,           None)            \
 ETYPE(UsingDecl,          None)            \
 ETYPE(Package,            None)            \
 ETYPE(ObjcImpl,           None)            \
 ETYPE(ExportedInterface,  None)            \
 ETYPE(IncludedService,    None)            \
 ETYPE(ExampleLineno,      None)            \
 

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 795 of file types.h.

#define ETYPE(x,bits)                                                                            \
    static EntryType make##x() { return EntryType(static_cast<int>(x)|static_cast<int>(bits)); } \
    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 795 of file types.h.

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

ETYPE [3/3]

#define ETYPE	(		x,
			bits )

Value:

      x,

Definition at line 795 of file types.h.

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

METHODTYPE_SPECIFICATIONS

#define METHODTYPE_SPECIFICATIONS

Value:

  MTSPEC(Method) \
  MTSPEC(Signal) \
  MTSPEC(Slot) \
  MTSPEC(DCOP) \
  MTSPEC(Property) \
  MTSPEC(Event)

Kind of method.

Definition at line 111 of file types.h.

#define METHODTYPE_SPECIFICATIONS \
  MTSPEC(Method) \
  MTSPEC(Signal) \
  MTSPEC(Slot) \
  MTSPEC(DCOP) \
  MTSPEC(Property) \
  MTSPEC(Event)

Referenced by to_string().

ML_TYPE [1/7]

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

Value:

      x##_,

Definition at line 364 of file types.h.

#define ML_TYPE(x,bits,to_pub,to_prot,label,xml_str) \
      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 364 of file types.h.

#define ML_TYPE(x,bits,to_pub,to_prot,label,xml_str) \
      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 364 of file types.h.

#define ML_TYPE(x,bits,to_pub,to_prot,label,xml_str) \
      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 364 of file types.h.

#define ML_TYPE(x,bits,to_pub,to_prot,label,xml_str) \
      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 364 of file types.h.

#define ML_TYPE(x,bits,to_pub,to_prot,label,xml_str) \
      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 364 of file types.h.

#define ML_TYPE(x,bits,to_pub,to_prot,label,xml_str) \
      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 364 of file types.h.

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

ML_TYPES

#define ML_TYPES

Definition at line 263 of file types.h.

#define ML_TYPES \
  ML_TYPE(PubMethods,          Public,       Invalid,           Invalid,          "pub-methods",           "public-func"             ) \
  ML_TYPE(ProMethods,          Protected,    PubMethods,        Invalid,          "pro-methods",           "protected-func"          ) \
  ML_TYPE(PacMethods,          Package,      Invalid,           Invalid,          "pac-methods",           "package-func"            ) \
  ML_TYPE(PriMethods,          Private,      PubMethods,        ProMethods,       "pri-methods",           "private-func"            ) \
  ML_TYPE(PubStaticMethods,    Public,       Invalid,           Invalid,          "pub-static-methods",    "public-static-func"      ) \
  ML_TYPE(ProStaticMethods,    Protected,    PubStaticMethods,  Invalid,          "pro-static-methods",    "protected-static-func"   ) \
  ML_TYPE(PacStaticMethods,    Package,      Invalid,           Invalid,          "pac-static-methods",    "package-static-func"     ) \
  ML_TYPE(PriStaticMethods,    Private,      PubStaticMethods,  ProStaticMethods, "pri-static-methods",    "private-static-func"     ) \
  ML_TYPE(PubSlots,            Public,       Invalid,           Invalid,          "pub-slots",             "public-slot"             ) \
  ML_TYPE(ProSlots,            Protected,    PubSlots,          Invalid,          "pro-slots",             "protected-slot"          ) \
  ML_TYPE(PriSlots,            Private,      PubSlots,          ProSlots,         "pri-slots",             "private-slot"            ) \
  ML_TYPE(PubAttribs,          Public,       Invalid,           Invalid,          "pub-attribs",           "public-attrib"           ) \
  ML_TYPE(ProAttribs,          Protected,    PubAttribs,        Invalid,          "pro-attribs",           "protected-attrib"        ) \
  ML_TYPE(PacAttribs,          Package,      Invalid,           Invalid,          "pac-attribs",           "package-attrib"          ) \
  ML_TYPE(PriAttribs,          Private,      PubAttribs,        ProAttribs,       "pri-attribs",           "private-attrib"          ) \
  ML_TYPE(PubStaticAttribs,    Public,       Invalid,           Invalid,          "pub-static-attribs",    "public-static-attrib"    ) \
  ML_TYPE(ProStaticAttribs,    Protected,    PubStaticAttribs,  Invalid,          "pro-static-attribs",    "protected-static-attrib" ) \
  ML_TYPE(PacStaticAttribs,    Package,      Invalid,           Invalid,          "pac-static-attribs",    "package-static-attrib"   ) \
  ML_TYPE(PriStaticAttribs,    Private,      PubStaticAttribs,  ProStaticAttribs, "pri-static-attribs",    "private-static-attrib"   ) \
  ML_TYPE(PubTypes,            Public,       Invalid,           Invalid,          "pub-types",             "public-type"             ) \
  ML_TYPE(ProTypes,            Protected,    PubTypes,          Invalid,          "pro-types",             "protected-type"          ) \
  ML_TYPE(PacTypes,            Package,      Invalid,           Invalid,          "pac-types",             "package-type"            ) \
  ML_TYPE(PriTypes,            Private,      PubTypes,          ProTypes,         "pri-types",             "private-type"            ) \
  ML_TYPE(Related,             OnlyPublic,   Invalid,           Invalid,          "related",               "related"                 ) \
  ML_TYPE(Signals,             OnlyPublic,   Invalid,           Invalid,          "signals",               "signal"                  ) \
  ML_TYPE(Friends,             OnlyPublic,   Invalid,           Invalid,          "friends",               "friend"                  ) \
  ML_TYPE(DcopMethods,         OnlyPublic,   Invalid,           Invalid,          "dcop-methods",          "dcop-func"               ) \
  ML_TYPE(Properties,          OnlyPublic,   Invalid,           Invalid,          "properties",            "property"                ) \
  ML_TYPE(Events,              OnlyPublic,   Invalid,           Invalid,          "events",                "event"                   ) \
  ML_TYPE(AllMembersList,      OnlyPublic,   Invalid,           Invalid,          "",                      ""                        ) \
  ML_TYPE(EnumFields,          OnlyPublic,   Invalid,           Invalid,          "enum-fields",           ""                        ) \
  ML_TYPE(MemberGroup,         OnlyPublic,   Invalid,           Invalid,          "",                      ""                        ) \
  ML_TYPE(Interfaces,          OnlyPublic,   Invalid,           Invalid,          "interfaces",            "interfaces"              ) \
  ML_TYPE(Services,            OnlyPublic,   Invalid,           Invalid,          "services",              "services"                ) \
  ML_TYPE(DecDefineMembers,    Declaration,  Invalid,           Invalid,          "define-members",        "define"                  ) \
  ML_TYPE(DecProtoMembers,     Declaration,  Invalid,           Invalid,          "proto-members",         "prototype"               ) \
  ML_TYPE(DecTypedefMembers,   Declaration,  Invalid,           Invalid,          "typedef-members",       "typedef"                 ) \
  ML_TYPE(DecEnumMembers,      Declaration,  Invalid,           Invalid,          "enum-members",          "enum"                    ) \
  ML_TYPE(DecFuncMembers,      Declaration,  Invalid,           Invalid,          "func-members",          "func"                    ) \
  ML_TYPE(DecVarMembers,       Declaration,  Invalid,           Invalid,          "var-members",           "var"                     ) \
  ML_TYPE(DecEnumValMembers,   Declaration,  Invalid,           Invalid,          "enumval-members",       ""                        ) \
  ML_TYPE(DecPubSlotMembers,   Declaration,  Invalid,           Invalid,          "pub-slot-members",      ""                        ) \
  ML_TYPE(DecProSlotMembers,   Declaration,  Invalid,           Invalid,          "pro-slot-members",      ""                        ) \
  ML_TYPE(DecPriSlotMembers,   Declaration,  Invalid,           Invalid,          "pri-slot-members",      ""                        ) \
  ML_TYPE(DecSignalMembers,    Declaration,  Invalid,           Invalid,          "signal-members",        ""                        ) \
  ML_TYPE(DecEventMembers,     Declaration,  Invalid,           Invalid,          "event-members",         ""                        ) \
  ML_TYPE(DecFriendMembers,    Declaration,  Invalid,           Invalid,          "friend-members",        ""                        ) \
  ML_TYPE(DecPropMembers,      Declaration,  Invalid,           Invalid,          "prop-members",          ""                        ) \
  ML_TYPE(DecSequenceMembers,  Declaration,  Invalid,           Invalid,          "sequence-members",      "sequence"                ) \
  ML_TYPE(DecDictionaryMembers,Declaration,  Invalid,           Invalid,          "dictionary-members",    "dictionary"              ) \
  ML_TYPE(TypedefMembers,      Detailed,     Invalid,           Invalid,          "",                      ""                        ) \
  ML_TYPE(EnumMembers,         Detailed,     Invalid,           Invalid,          "",                      ""                        ) \
  ML_TYPE(EnumValMembers,      Detailed,     Invalid,           Invalid,          "",                      ""                        ) \
  ML_TYPE(FunctionMembers,     Detailed,     Invalid,           Invalid,          "",                      ""                        ) \
  ML_TYPE(RelatedMembers,      Detailed,     Invalid,           Invalid,          "",                      ""                        ) \
  ML_TYPE(VariableMembers,     Detailed,     Invalid,           Invalid,          "",                      ""                        ) \
  ML_TYPE(PropertyMembers,     Detailed,     Invalid,           Invalid,          "",                      ""                        ) \
  ML_TYPE(EventMembers,        Detailed,     Invalid,           Invalid,          "",                      ""                        ) \
  ML_TYPE(Constructors,        Detailed,     Invalid,           Invalid,          "",                      ""                        ) \
  ML_TYPE(InterfaceMembers,    Detailed,     Invalid,           Invalid,          "interface-members",     ""                        ) \
  ML_TYPE(ServiceMembers,      Detailed,     Invalid,           Invalid,          "service-members",       ""                        ) \
  ML_TYPE(DocDefineMembers,    Documentation,Invalid,           Invalid,          "",                      ""                        ) \
  ML_TYPE(DocProtoMembers,     Documentation,Invalid,           Invalid,          "",                      ""                        ) \
  ML_TYPE(DocTypedefMembers,   Documentation,Invalid,           Invalid,          "",                      ""                        ) \
  ML_TYPE(DocEnumMembers,      Documentation,Invalid,           Invalid,          "",                      ""                        ) \
  ML_TYPE(DocFuncMembers,      Documentation,Invalid,           Invalid,          "",                      ""                        ) \
  ML_TYPE(DocVarMembers,       Documentation,Invalid,           Invalid,          "",                      ""                        ) \
  ML_TYPE(DocEnumValMembers,   Documentation,Invalid,           Invalid,          "",                      ""                        ) \
  ML_TYPE(DocPubSlotMembers,   Documentation,Invalid,           Invalid,          "",                      ""                        ) \
  ML_TYPE(DocProSlotMembers,   Documentation,Invalid,           Invalid,          "",                      ""                        ) \
  ML_TYPE(DocPriSlotMembers,   Documentation,Invalid,           Invalid,          "",                      ""                        ) \
  ML_TYPE(DocSignalMembers,    Documentation,Invalid,           Invalid,          "",                      ""                        ) \
  ML_TYPE(DocEventMembers,     Documentation,Invalid,           Invalid,          "",                      ""                        ) \
  ML_TYPE(DocFriendMembers,    Documentation,Invalid,           Invalid,          "",                      ""                        ) \
  ML_TYPE(DocPropMembers,      Documentation,Invalid,           Invalid,          "",                      ""                        ) \
  ML_TYPE(DocSequenceMembers,  Documentation,Invalid,           Invalid,          "",                      ""                        ) \
  ML_TYPE(DocDictionaryMembers,Documentation,Invalid,           Invalid,          "",                      ""                        ) \
 

MTSPEC [1/2]

#define MTSPEC

(

x

)

Value:

x,

Definition at line 120 of file types.h.

MTSPEC [2/2]

#define MTSPEC

(

x

)

Value:

case MethodTypes::x: result = #x; break;

Definition at line 120 of file types.h.

PROTECTION_SPECIFICATIONS

#define PROTECTION_SPECIFICATIONS

Value:

  PROTSPEC(Public,public,public) \
  PROTSPEC(Protected,protected,protected) \
  PROTSPEC(Private,private,private) \
  PROTSPEC(Package,package,protected)

Protection level of members.

Definition at line 26 of file types.h.

#define PROTECTION_SPECIFICATIONS \
  PROTSPEC(Public,public,public) \
  PROTSPEC(Protected,protected,protected) \
  PROTSPEC(Private,private,private) \
  PROTSPEC(Package,package,protected)

Referenced by to_string(), to_string_lower(), and to_string_lower_class().

PROTSPEC [1/4]

#define PROTSPEC	(		x,
			y,
			z )

Value:

x,

Definition at line 33 of file types.h.

PROTSPEC [2/4]

#define PROTSPEC	(		x,
			y,
			z )

Value:

case Protection::x: result = #x; break;

Definition at line 33 of file types.h.

PROTSPEC [3/4]

#define PROTSPEC	(		x,
			y,
			z )

Value:

case Protection::x: result = #y; break;

Definition at line 33 of file types.h.

PROTSPEC [4/4]

#define PROTSPEC	(		x,
			y,
			z )

Value:

case Protection::x: result = #z; break;

Definition at line 33 of file types.h.

RELATESTYPE_SPECIFICATIONS

#define RELATESTYPE_SPECIFICATIONS

Value:

  RTSPEC(Simple) \
  RTSPEC(Duplicate) \
  RTSPEC(MemberOf)

Type of member relation.

Definition at line 138 of file types.h.

#define RELATESTYPE_SPECIFICATIONS \
  RTSPEC(Simple) \
  RTSPEC(Duplicate) \
  RTSPEC(MemberOf)

Referenced by to_string().

RELATIONSHIP_SPECIFICATIONS

#define RELATIONSHIP_SPECIFICATIONS

Value:

  RSSPEC(Member) \
  RSSPEC(Related) \
  RSSPEC(Foreign)

Kind of member relationship.

Definition at line 162 of file types.h.

#define RELATIONSHIP_SPECIFICATIONS \
  RSSPEC(Member) \
  RSSPEC(Related) \
  RSSPEC(Foreign)

Referenced by to_string().

RSSPEC [1/2]

#define RSSPEC

(

x

)

Value:

x,

Definition at line 168 of file types.h.

RSSPEC [2/2]

#define RSSPEC

(

x

)

Value:

case Relationship::x: result = #x; break;

Definition at line 168 of file types.h.

RTSPEC [1/2]

#define RTSPEC

(

x

)

Value:

x,

Definition at line 144 of file types.h.

RTSPEC [2/2]

#define RTSPEC

(

x

)

Value:

case RelatesType::x: result = #x; break;

Definition at line 144 of file types.h.

SPECIFIER_SPECIFICATIONS

#define SPECIFIER_SPECIFICATIONS

Value:

  SPECSPEC(Normal,non-virtual) \
  SPECSPEC(Virtual,virtual) \
  SPECSPEC(Pure,pure-virtual)

Virtualness of a member.

Definition at line 75 of file types.h.

#define SPECIFIER_SPECIFICATIONS \
  SPECSPEC(Normal,non-virtual) \
  SPECSPEC(Virtual,virtual) \
  SPECSPEC(Pure,pure-virtual)

Referenced by to_string(), and to_string_lower().

SPECSPEC [1/3]

#define SPECSPEC	(		x,
			y )

Value:

x,

Definition at line 81 of file types.h.

SPECSPEC [2/3]

#define SPECSPEC	(		x,
			y )

Value:

case Specifier::x: result = #x; break;

Definition at line 81 of file types.h.

SPECSPEC [3/3]

#define SPECSPEC	(		x,
			y )

Value:

case Specifier::x: result = #y; break;

Definition at line 81 of file types.h.

SRCLANGEXT [1/2]

#define SRCLANGEXT	(		x,
			v,
			z )

Value:

x = v,

Definition at line 208 of file types.h.

SRCLANGEXT [2/2]

#define SRCLANGEXT	(		x,
			v,
			z )

Value:

case SrcLangExt::x: result = #z; break;

Definition at line 208 of file types.h.

SRCLANGEXT_SPECIFICATIONS

#define SRCLANGEXT_SPECIFICATIONS

Value:

  SRCLANGEXT(Unknown  , 0x00000, Unknown) \
  SRCLANGEXT(IDL      , 0x00008, IDL) \
  SRCLANGEXT(Java     , 0x00010, Java) \
  SRCLANGEXT(CSharp   , 0x00020, C#) \
  SRCLANGEXT(D        , 0x00040, D) \
  SRCLANGEXT(PHP      , 0x00080, PHP) \
  SRCLANGEXT(ObjC     , 0x00100, Objective-C) \
  SRCLANGEXT(Cpp      , 0x00200, C++) \
  SRCLANGEXT(JS       , 0x00400, Javascript) \
  SRCLANGEXT(Python   , 0x00800, Python) \
  SRCLANGEXT(Fortran  , 0x01000, Fortran) \
  SRCLANGEXT(VHDL     , 0x02000, VHDL) \
  SRCLANGEXT(XML      , 0x04000, XML) \
  SRCLANGEXT(Markdown , 0x10000, Markdown) \
  SRCLANGEXT(SQL      , 0x20000, SQL) \
  SRCLANGEXT(Slice    , 0x40000, Slice) \
  SRCLANGEXT(Lex      , 0x80000, Lex)

Language as given by extension.

Definition at line 186 of file types.h.

#define SRCLANGEXT_SPECIFICATIONS \
  SRCLANGEXT(Unknown  , 0x00000, Unknown) \
  SRCLANGEXT(IDL      , 0x00008, IDL) \
  SRCLANGEXT(Java     , 0x00010, Java) \
  SRCLANGEXT(CSharp   , 0x00020, C#) \
  SRCLANGEXT(D        , 0x00040, D) \
  SRCLANGEXT(PHP      , 0x00080, PHP) \
  SRCLANGEXT(ObjC     , 0x00100, Objective-C) \
  SRCLANGEXT(Cpp      , 0x00200, C++) \
  SRCLANGEXT(JS       , 0x00400, Javascript) \
  SRCLANGEXT(Python   , 0x00800, Python) \
  SRCLANGEXT(Fortran  , 0x01000, Fortran) \
  SRCLANGEXT(VHDL     , 0x02000, VHDL) \
  SRCLANGEXT(XML      , 0x04000, XML) \
  SRCLANGEXT(Markdown , 0x10000, Markdown) \
  SRCLANGEXT(SQL      , 0x20000, SQL) \
  SRCLANGEXT(Slice    , 0x40000, Slice) \
  SRCLANGEXT(Lex      , 0x80000, Lex)

Referenced by to_string().

TSPEC [1/4]

#define TSPEC

(

x

)

Value:

m_is##x = m_is##x || other.is##x();

Definition at line 698 of file types.h.

#define TSPEC(x)                                                          \
    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;

TSPEC [2/4]

#define TSPEC

(

x

)

Value:

eq = eq && (t1.m_is##x == t2.m_is##x);

Definition at line 698 of file types.h.

#define TSPEC(x)                                                          \
    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;

TSPEC [3/4]

#define TSPEC

(

x

)

Value:

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

Definition at line 698 of file types.h.

#define TSPEC(x)                                                          \
    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;

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 698 of file types.h.

#define TSPEC(x)                                                          \
    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;

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)

Definition at line 634 of file types.h.

#define TYPE_SPECIFIERS                                                                                                         \
/*  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)

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 480 of file types.h.

{
  Default,
  // Class types
  Class,
  Struct,
  Union,
  Interface,
  Protocol,
  Category,
  Exception,
  Service,
  Singleton,
  // Other container types
  Concept,
  Namespace,
  Package,
  Module,
  // Member types
  Define,
  Function,
  Variable,
  Typedef,
  EnumValue,
  Enumeration,
  Signal,
  Slot,
  Friend,
  DCOP,
  Property,
  Event,
  Sequence,
  Dictionary
};

FortranFormat

enum class FortranFormat

strong

Enumerator
Unknown
Free
Fixed

Definition at line 571 of file types.h.

{
  Unknown,
  Free,
  Fixed
};

MemberListContainer

enum class MemberListContainer

strong

Enumerator
File
Namespace
Group
Class
Module

Definition at line 471 of file types.h.

{
  File,
  Namespace,
  Group,
  Class,
  Module
};

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 551 of file types.h.

{
  Define,
  Function,
  Variable,
  Typedef,
  Enumeration,
  EnumValue,
  Signal,
  Slot,
  Friend,
  DCOP,
  Property,
  Event,
  Interface,
  Service,
  Sequence,
  Dictionary
};

MethodTypes

enum class MethodTypes

strong

Enumerator
METHODTYPE_SPECIFICATIONS

Definition at line 119 of file types.h.

                         {
#define MTSPEC(x) x,
  METHODTYPE_SPECIFICATIONS
#undef MTSPEC
};

Protection

enum class Protection

strong

Enumerator
PROTECTION_SPECIFICATIONS

Definition at line 32 of file types.h.

                        {
#define PROTSPEC(x,y,z) x,
  PROTECTION_SPECIFICATIONS
#undef PROTSPEC
};

RelatesType

enum class RelatesType

strong

Enumerator
RELATESTYPE_SPECIFICATIONS

Definition at line 143 of file types.h.

                         {
#define RTSPEC(x) x,
  RELATESTYPE_SPECIFICATIONS
#undef RTSPEC
};

Relationship

enum class Relationship

strong

Enumerator
RELATIONSHIP_SPECIFICATIONS

Definition at line 167 of file types.h.

                          {
#define RSSPEC(x) x,
  RELATIONSHIP_SPECIFICATIONS
#undef RSSPEC
};

Specifier

enum class Specifier

strong

Enumerator
SPECIFIER_SPECIFICATIONS

Definition at line 80 of file types.h.

                       {
#define SPECSPEC(x,y) x,
  SPECIFIER_SPECIFICATIONS
#undef SPECSPEC
};

SrcLangExt

enum class SrcLangExt

strong

Enumerator
SRCLANGEXT_SPECIFICATIONS

Definition at line 207 of file types.h.

                      {
#define SRCLANGEXT(x, v, z) x = v,
  SRCLANGEXT_SPECIFICATIONS
#undef SRCLANGEXT
};

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 709 of file types.h.

{
  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
};

Function Documentation

codeSymbolType2Str()

const char * codeSymbolType2Str ( CodeSymbolType type )

constexpr

Definition at line 515 of file types.h.

{
  switch (type)
  {
    case CodeSymbolType::Class:       return "class";
    case CodeSymbolType::Struct:      return "struct";
    case CodeSymbolType::Union:       return "union";
    case CodeSymbolType::Interface:   return "interface";
    case CodeSymbolType::Protocol:    return "protocol";
    case CodeSymbolType::Category:    return "category";
    case CodeSymbolType::Exception:   return "exception";
    case CodeSymbolType::Service:     return "service";
    case CodeSymbolType::Singleton:   return "singleton";
    case CodeSymbolType::Concept:     return "concept";
    case CodeSymbolType::Namespace:   return "namespace";
    case CodeSymbolType::Package:     return "package";
    case CodeSymbolType::Define:      return "define";
    case CodeSymbolType::Function:    return "function";
    case CodeSymbolType::Variable:    return "variable";
    case CodeSymbolType::Typedef:     return "typedef";
    case CodeSymbolType::EnumValue:   return "enumvalue";
    case CodeSymbolType::Enumeration: return "enumeration";
    case CodeSymbolType::Signal:      return "signal";
    case CodeSymbolType::Slot:        return "slot";
    case CodeSymbolType::Friend:      return "friend";
    case CodeSymbolType::DCOP:        return "dcop";
    case CodeSymbolType::Property:    return "property";
    case CodeSymbolType::Event:       return "event";
    case CodeSymbolType::Sequence:    return "sequence";
    case CodeSymbolType::Dictionary:  return "dictionary";
    default:
      return nullptr;
  }
}

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().

to_string() [1/6]

const char * to_string ( MethodTypes mt )

static

Definition at line 125 of file types.h.

{
  const char *result = "ERROR";
  switch (mt)
  {
#define MTSPEC(x) case MethodTypes::x: result = #x; break;
    METHODTYPE_SPECIFICATIONS
#undef MTSPEC
  }
  return result;
}

References METHODTYPE_SPECIFICATIONS.

to_string() [2/6]

const char * to_string ( Protection prot )

static

Definition at line 38 of file types.h.

{
  const char *result = "ERROR";
  switch (prot)
  {
#define PROTSPEC(x,y,z) case Protection::x: result = #x; break;
    PROTECTION_SPECIFICATIONS
#undef PROTSPEC
  }
  return result;
}

References PROTECTION_SPECIFICATIONS.

Referenced by fmt::formatter< MethodTypes >::format(), fmt::formatter< Protection >::format(), fmt::formatter< RelatesType >::format(), fmt::formatter< Relationship >::format(), fmt::formatter< Specifier >::format(), fmt::formatter< SrcLangExt >::format(), and langToString().

to_string() [3/6]

const char * to_string ( RelatesType rt )

static

Definition at line 149 of file types.h.

{
  const char *result = "ERROR";
  switch (rt)
  {
#define RTSPEC(x) case RelatesType::x: result = #x; break;
    RELATESTYPE_SPECIFICATIONS
#undef RTSPEC
  }
  return result;
}

References RELATESTYPE_SPECIFICATIONS.

to_string() [4/6]

const char * to_string ( Relationship rs )

static

Definition at line 173 of file types.h.

{
  const char *result = "ERROR";
  switch (rs)
  {
#define RSSPEC(x) case Relationship::x: result = #x; break;
    RELATIONSHIP_SPECIFICATIONS
#undef RSSPEC
  }
  return result;
}

References RELATIONSHIP_SPECIFICATIONS.

to_string() [5/6]

const char * to_string ( Specifier spec )

static

Definition at line 86 of file types.h.

{
  const char *result = "ERROR";
  switch (spec)
  {
#define SPECSPEC(x,y) case Specifier::x: result = #x; break;
    SPECIFIER_SPECIFICATIONS
#undef SPECSPEC
  }
  return result;
}

References SPECIFIER_SPECIFICATIONS.

to_string() [6/6]

const char * to_string ( SrcLangExt sle )

static

Definition at line 213 of file types.h.

{
  const char *result = "ERROR";
  switch (sle)
  {
#define SRCLANGEXT(x,v,z) case SrcLangExt::x: result = #z; break;
    SRCLANGEXT_SPECIFICATIONS
#undef SRCLANGEXT
  }
  return result;
}

References SRCLANGEXT_SPECIFICATIONS.

to_string_lower() [1/2]

const char * to_string_lower ( Protection prot )

static

Definition at line 50 of file types.h.

{
  const char *result = "error";
  switch (prot)
  {
#define PROTSPEC(x,y,z) case Protection::x: result = #y; break;
    PROTECTION_SPECIFICATIONS
#undef PROTSPEC
  }
  return result;
}

References PROTECTION_SPECIFICATIONS.

Referenced by generateDEFForClass(), generateDEFForMember(), generateXMLForClass(), generateXMLForMember(), getProtectionName(), getVirtualnessName(), writeInnerClasses(), and writeListOfAllMembers().

to_string_lower() [2/2]

const char * to_string_lower ( Specifier spec )

static

Definition at line 98 of file types.h.

{
  const char *result = "error";
  switch (spec)
  {
#define SPECSPEC(x,y) case Specifier::x: result = #y; break;
  SPECIFIER_SPECIFICATIONS
#undef SPECSPEC
  }
  return result;
}

References SPECIFIER_SPECIFICATIONS.

to_string_lower_class()

const char * to_string_lower_class ( Protection prot )

static

Definition at line 62 of file types.h.

{
  const char *result = "error";
  switch (prot)
  {
#define PROTSPEC(x,y,z) case Protection::x: result = #z; break;
    PROTECTION_SPECIFICATIONS
#undef PROTSPEC
  }
  return result;
}

References PROTECTION_SPECIFICATIONS.

Referenced by generateDEFForClass().