Skip to main content

The EntryType Class Reference

Wrapper class for the Entry type. More...

Declaration​

class EntryType { ... }

Included Headers​

#include <src/types.h>

Enumerations Index​

enumTypeName { ... }
enumCategoryBits { ... }

Friends Index​

booloperator==
booloperator!=

Private Constructors Index​

EntryType (int t)

Public Member Functions Index​

ENTRY_TYPES boolisCompound () const
boolisScope () const
boolisFile () const
boolisCompoundDoc () const
boolisDoc () const
std::stringto_string () const

Private Member Functions Index​

std::stringbits_to_string () const
TypeNametype () const

Private Member Attributes Index​

unsigned intm_type = Empty

Description​

Wrapper class for the Entry type.

Can be set only during construction. Packs the type together with category flags.

Definition at line 792 of file types.h.

Enumerations​

CategoryBits​

enum EntryType::CategoryBits
Enumeration values
None (= 0)
Compound (= (1<<16))
Scope (= (1<<17))
File (= (1<<18))
CompoundDoc (= (1<<19))
Doc (= (1<<20))
TypeMask (= 0x0000FFFF)
CategoryMask (= 0xFFFF0000)

Definition at line 828 of file types.h.

829 {
830 None = 0,
831 Compound = (1<<16),
832 Scope = (1<<17),
833 File = (1<<18),
834 CompoundDoc = (1<<19),
835 Doc = (1<<20),
836 TypeMask = 0x0000FFFF,
837 CategoryMask = 4294901760
838 };

TypeName​

enum EntryType::TypeName
Enumeration values
ENTRY_TYPES

Definition at line 820 of file types.h.

821 {
822#define ETYPE(x,bits) \
823 x,
824 ENTRY_TYPES
825#undef ETYPE
826 };

Friends​

operator!=​

friend bool const EntryType & t1, const EntryType & t2
 inline

Definition at line 817 of file types.h.

817 friend inline bool operator!=(const EntryType &t1,const EntryType &t2) { return !(operator==(t1,t2)); }

References EntryType and operator==.

operator==​

friend bool const EntryType & t1, const EntryType & t2
 inline

Definition at line 816 of file types.h.

816 friend inline bool operator==(const EntryType &t1,const EntryType &t2) { return t1.m_type==t2.m_type; }

References EntryType and m_type.

Referenced by operator!=.

Private Constructors​

EntryType()​

EntryType::EntryType (int t)
 inline explicit

Definition at line 839 of file types.h.

839 explicit EntryType(int t) : m_type(t) {}

Reference m_type.

Referenced by operator!= and operator==.

Public Member Functions​

isCompound()​

ENTRY_TYPES bool EntryType::isCompound ()
 inline

Definition at line 800 of file types.h.

800 bool isCompound() const { return (m_type & Compound)!=0; }

References Compound and m_type.

Referenced by addClassToContext, buildClassList, buildFunctionList, buildListOfUsingDecls, findUsingDeclarations, findUsingDeclImports, isClassSection and isVarWithConstructor.

isCompoundDoc()​

bool EntryType::isCompoundDoc ()
 inline

Definition at line 803 of file types.h.

803 bool isCompoundDoc() const { return (m_type & CompoundDoc)!=0; }

References CompoundDoc and m_type.

Referenced by buildClassDocList and isClassSection.

isDoc()​

bool EntryType::isDoc ()
 inline

Definition at line 804 of file types.h.

804 bool isDoc() const { return (m_type & Doc)!=0; }

References Doc and m_type.

Referenced by addMemberDocs.

isFile()​

bool EntryType::isFile ()
 inline

Definition at line 802 of file types.h.

802 bool isFile() const { return (m_type & File)!=0; }

References File and m_type.

Referenced by buildFileList.

isScope()​

bool EntryType::isScope ()
 inline

Definition at line 801 of file types.h.

801 bool isScope() const { return (m_type & Scope)!=0; }

References m_type and Scope.

Referenced by addClassToContext, addConceptToContext, addEnumValuesToEnums, addVariable, findEnumDocumentation, findEnums and findMember.

to_string()​

std::string EntryType::to_string ()
 inline

Definition at line 805 of file types.h.

805 std::string to_string() const
806 {
807 switch (type())
808 {
809#define ETYPE(x,bits) \
810 case x : return "["+std::string(#x)+bits_to_string()+"]";
811 ENTRY_TYPES
812#undef ETYPE
813 }
814 return "[unknown]";
815 }

References ENTRY_TYPES and type.

Referenced by fmt::formatter< EntryType >::format and printNavTree.

Private Member Functions​

bits_to_string()​

std::string EntryType::bits_to_string ()
 inline

Definition at line 840 of file types.h.

840 std::string bits_to_string() const
841 {
842 std::string result;
843 if (m_type&Compound) result+=",Compound";
844 if (m_type&Scope) result+=",Scope";
845 if (m_type&File) result+=",File";
846 if (m_type&CompoundDoc) result+=",CompoundDoc";
847 return result;
848 }

References Compound, CompoundDoc, File, m_type and Scope.

type()​

TypeName EntryType::type ()
 inline

Definition at line 849 of file types.h.

849 TypeName type() const { return static_cast<TypeName>(m_type & TypeMask); }

References m_type and TypeMask.

Referenced by to_string.

Private Member Attributes​

m_type​

unsigned int EntryType::m_type = Empty

Definition at line 850 of file types.h.

850 unsigned int m_type = Empty;

Referenced by bits_to_string, EntryType, isCompound, isCompoundDoc, isDoc, isFile, isScope, operator== and type.

The documentation for this class was generated from the following file:

Generated via doxygen2docusaurus by Doxygen 1.14.0.