EntryType Class Reference

Wrapper class for the Entry type. More...

#include <src/types.h>

Public Member Functions
ENTRY_TYPES constexpr bool	isCompound () const noexcept
constexpr bool	isScope () const noexcept
constexpr bool	isFile () const noexcept
constexpr bool	isCompoundDoc () const noexcept
constexpr bool	isDoc () const noexcept
std::string	to_string () const

Static Public Member Functions
static EntryType	guessSection (const DString &name)

Private Types
enum	TypeName { ENTRY_TYPES }
enum	CategoryBits {   None = 0 , Compound = (1<<16) , Scope = (1<<17) , File = (1<<18) ,   CompoundDoc = (1<<19) , Doc = (1<<20) , TypeMask = 0x0000FFFF , CategoryMask = 0xFFFF0000 }

Private Member Functions
constexpr	EntryType (int t) noexcept
std::string	bits_to_string () const
constexpr TypeName	type () const noexcept

Private Attributes
unsigned int	m_type = Empty

Friends
bool	operator== (const EntryType &t1, const EntryType &t2)
bool	operator!= (const EntryType &t1, const EntryType &t2)

Detailed Description

Wrapper class for the Entry type.

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

Definition at line 855 of file types.h.

Member Enumeration Documentation

CategoryBits

enum EntryType::CategoryBits

private

Enumerator
None
Compound
Scope
File
CompoundDoc
Doc
TypeMask
CategoryMask

Definition at line 893 of file types.h.

    {
      None        = 0,
      Compound    = (1<<16),
      Scope       = (1<<17),
      File        = (1<<18),
      CompoundDoc = (1<<19),
      Doc         = (1<<20),
      TypeMask      = 0x0000FFFF,
      CategoryMask  = 0xFFFF0000
    };

TypeName

enum EntryType::TypeName

private

Enumerator
ENTRY_TYPES

Definition at line 885 of file types.h.

    {
#define ETYPE(x,bits)                                                   \
      x,
      ENTRY_TYPES
#undef ETYPE
    };

Constructor & Destructor Documentation

EntryType()

EntryType::EntryType ( int t )

inlineexplicitconstexprprivatenoexcept

Definition at line 904 of file types.h.

: m_type(t) {}

Referenced by guessSection(), operator!=, and operator==.

Member Function Documentation

bits_to_string()

std::string EntryType::bits_to_string ( ) const

inlineprivate

Definition at line 905 of file types.h.

    {
      std::string result;
      if (m_type&Compound) result+=",Compound";
      if (m_type&Scope) result+=",Scope";
      if (m_type&File) result+=",File";
      if (m_type&CompoundDoc) result+=",CompoundDoc";
      return result;
    }

References Compound, CompoundDoc, File, m_type, and Scope.

guessSection()

EntryType EntryType::guessSection ( const DString & name )

static

Definition at line 22 of file types.cpp.

{
  DString n=name.lower();
  static const std::unordered_set<std::string> sourceExt = {
     "c","cc","cxx","cpp","c++","cppm","ccm","cxxm","c++m",   // C/C++
     "java",                       // Java
     "cs",                         // C#
     "m","mm",                     // Objective-C
     "ii","ixx","ipp","i++","inl", // C/C++ inline
     "xml","lex","sql"             // others
  };
  static const std::unordered_set<std::string> headerExt = {
     "h", "hh", "hxx", "hpp", "h++", "ixx", // C/C++ header
     "idl", "ddl", "pidl", "ice"    // IDL like
  };
  size_t lastDot = n.rfind('.');
  if (lastDot!=DString::npos)
  {
    DString extension = n.mid(lastDot+1); // part after the last dot
    if (sourceExt.find(extension.str())!=sourceExt.end())
    {
      return EntryType::makeSource();
    }
    if (headerExt.find(extension.str())!=headerExt.end())
    {
      return EntryType::makeHeader();
    }
  }
  else
  {
    if (getLanguageFromFileName(name,SrcLangExt::Unknown) == SrcLangExt::Cpp) return EntryType::makeHeader();
  }
  return EntryType::makeEmpty();
}

References EntryType(), getLanguageFromFileName(), DString::lower(), DString::mid(), DString::npos, DString::rfind(), and DString::str().

Referenced by addIncludeFile(), anonymous_namespace{tagreader.cpp}::TagFileParser::buildLists(), ClassDefImpl::ClassDefImpl(), computeClassRelations(), FileDefImpl::FileDefImpl(), FileDefImpl::generateSourceFile(), parseMain(), parseMain(), Preprocessor::processFile(), setFileName(), and warnUndocumentedNamespaces().

isCompound()

ENTRY_TYPES constexpr bool EntryType::isCompound ( ) const

inlineconstexprnoexcept

Definition at line 863 of file types.h.

{ 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 ( ) const

inlineconstexprnoexcept

Definition at line 866 of file types.h.

{ return (m_type & CompoundDoc)!=0; }

References CompoundDoc, and m_type.

Referenced by buildClassDocList(), and isClassSection().

isDoc()

bool EntryType::isDoc ( ) const

inlineconstexprnoexcept

Definition at line 867 of file types.h.

{ return (m_type & Doc)!=0;         }

References Doc, and m_type.

Referenced by addMemberDocs().

isFile()

bool EntryType::isFile ( ) const

inlineconstexprnoexcept

Definition at line 865 of file types.h.

{ return (m_type & File)!=0;        }

References File, and m_type.

Referenced by buildFileList().

isScope()

bool EntryType::isScope ( ) const

inlineconstexprnoexcept

Definition at line 864 of file types.h.

{ 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 ( ) const

inline

Definition at line 868 of file types.h.

    {
      switch (type())
      {
#define ETYPE(x,bits)                                                   \
        case x : return "["+std::string(#x)+bits_to_string()+"]";
        ENTRY_TYPES
#undef ETYPE
      }
      return "[unknown]";
    }

References ENTRY_TYPES, and type().

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

type()

TypeName EntryType::type ( ) const

inlineconstexprprivatenoexcept

Definition at line 914 of file types.h.

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

References m_type, and TypeMask.

Referenced by to_string().

Friends And Related Symbol Documentation

operator!=

bool operator!= ( const EntryType & t1, const EntryType & t2 )

friend

Definition at line 880 of file types.h.

{ return !(operator==(t1,t2)); }

References EntryType(), and operator==.

operator==

bool operator== ( const EntryType & t1, const EntryType & t2 )

friend

Definition at line 879 of file types.h.

{ return t1.m_type==t2.m_type; }

References EntryType(), and m_type.

Referenced by operator!=.

Member Data Documentation

m_type

unsigned int EntryType::m_type = Empty

private

Definition at line 915 of file types.h.

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

---

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

• src/types.h
• src/types.cpp