The MemberListType Class Reference

Wrapper class for the MemberListType type. More...

Declaration

class MemberListType { ... }

Included Headers

#include <src/types.h>

Enumerations Index

enum	CategoryBits { ... }
enum	TypeName { ... }

Friends Index

bool	operator==
bool	operator!=

Private Constructors Index

	MemberListType (int t)

Public Member Functions Index

constexpr bool	isInvalid () const
ML_TYPES constexpr bool	isPublic () const
constexpr bool	isOnlyPublic () const
constexpr bool	isProtected () const
constexpr bool	isPackage () const
constexpr bool	isPrivate () const
constexpr bool	isDetailed () const
constexpr bool	isDeclaration () const
constexpr bool	isDocumentation () const
std::string	to_string () const
int	to_int () const
constexpr const char *	toLabel () const
constexpr const char *	toXML () const
MemberListType	toPublic () const
MemberListType	toProtected () const

Private Member Functions Index

std::string	bits_to_string () const
constexpr TypeName	type () const

Private Member Attributes Index

int	m_type = static_cast<int>(Invalid_)

Public Static Functions Index

static MemberListType	Invalid ()

Description

Wrapper class for the MemberListType type.

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

Definition at line 345 of file types.h.

Enumerations

CategoryBits

enum MemberListType::CategoryBits

Enumeration values

Public	(= (1<<16))
Protected	(= (1<<17))
Package	(= (1<<18))
Private	(= (1<<19))
OnlyPublic	(= (1<<20))
Detailed	(= (1<<21))
Declaration	(= (1<<22))
Documentation	(= (1<<23))
TypeMask	(= 0x0000FFFF)
CategoryMask	(= 0xFFFF0000)

Definition at line 347 of file types.h.

348 {

349 Public = (1<<16),

350 Protected = (1<<17),

351 Package = (1<<18),

352 Private = (1<<19),

353 OnlyPublic = (1<<20),

354 Detailed = (1<<21),

355 Declaration = (1<<22),

356 Documentation = (1<<23),

357 TypeMask = 0x0000FFFF,

358 CategoryMask = 4294901760

359 };

TypeName

enum MemberListType::TypeName

Enumeration values

Invalid_	(= -1)
ML_TYPES

Definition at line 361 of file types.h.

362 {

363 Invalid_ = -1,

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

365 x##_,

366 ML_TYPES

367#undef ML_TYPE

368 };

Friends

operator!=

friend bool const MemberListType & t1, const MemberListType & t2

inline

Definition at line 451 of file types.h.

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

References MemberListType and operator==.

operator==

friend bool const MemberListType & t1, const MemberListType & t2

inline

Definition at line 450 of file types.h.

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

References m_type and MemberListType.

Referenced by operator!=.

Private Constructors

MemberListType()

MemberListType::MemberListType (int t)

inline explicit

Definition at line 454 of file types.h.

454 explicit MemberListType(int t) : m_type(t) {}

Reference m_type.

Referenced by Invalid, operator!=, operator==, toProtected and toPublic.

Public Member Functions

isDeclaration()

bool MemberListType::isDeclaration ()

inline constexpr

Definition at line 384 of file types.h.

384 constexpr bool isDeclaration() const { return (m_type & Declaration)!=0; }

References Declaration and m_type.

Referenced by generateSqlite3ForFile, generateSqlite3ForGroup, generateSqlite3ForModule, generateSqlite3ForNamespace, generateXMLForFile, generateXMLForGroup, generateXMLForModule and generateXMLForNamespace.

isDetailed()

bool MemberListType::isDetailed ()

inline constexpr

Definition at line 383 of file types.h.

383 constexpr bool isDetailed() const { return (m_type & Detailed)!=0; }

References Detailed and m_type.

Referenced by generateSqlite3ForClass and generateXMLForClass.

isDocumentation()

bool MemberListType::isDocumentation ()

inline constexpr

Definition at line 385 of file types.h.

385 constexpr bool isDocumentation() const { return (m_type & Documentation)!=0; }

References Documentation and m_type.

isInvalid()

bool MemberListType::isInvalid ()

inline constexpr

Definition at line 372 of file types.h.

372 constexpr bool isInvalid() const { return m_type==Invalid_; }

References Invalid_ and m_type.

Referenced by ClassDefImpl::countInheritedDecMembers, ClassDefImpl::countMemberDeclarations and ClassDefImpl::writeInheritedMemberDeclarations.

isOnlyPublic()

bool MemberListType::isOnlyPublic ()

inline constexpr

Definition at line 379 of file types.h.

379 constexpr bool isOnlyPublic() const { return (m_type & OnlyPublic)!=0; }

References m_type and OnlyPublic.

isPackage()

bool MemberListType::isPackage ()

inline constexpr

Definition at line 381 of file types.h.

381 constexpr bool isPackage() const { return (m_type & Package)!=0; }

References m_type and Package.

isPrivate()

bool MemberListType::isPrivate ()

inline constexpr

Definition at line 382 of file types.h.

382 constexpr bool isPrivate() const { return (m_type & Private)!=0; }

References m_type and Private.

Referenced by convertProtectionLevel.

isProtected()

bool MemberListType::isProtected ()

inline constexpr

Definition at line 380 of file types.h.

380 constexpr bool isProtected() const { return (m_type & Protected)!=0; }

References m_type and Protected.

Referenced by convertProtectionLevel.

isPublic()

ML_TYPES constexpr bool MemberListType::isPublic ()

inline constexpr

Definition at line 378 of file types.h.

378 constexpr bool isPublic() const { return (m_type & Public)!=0; }

References m_type and Public.

Referenced by convertProtectionLevel.

to_int()

int MemberListType::to_int ()

inline

Definition at line 398 of file types.h.

398 int to_int() const

399 {

400 return m_type!=Invalid_ ? m_type&TypeMask : -1;

401 }

References Invalid_, m_type and TypeMask.

to_string()

std::string MemberListType::to_string ()

inline

Definition at line 386 of file types.h.

386 std::string to_string() const

387 {

388 switch (type())

389 {

390 case Invalid_: return "[Invalid]";

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

392 case x##_ : return "["+std::string(#x)+bits_to_string()+"]";

393 ML_TYPES

394#undef ML_TYPE

395 }

396 return "[unknown]";

397 }

References Invalid_, ML_TYPES and type.

Referenced by fmt::formatter< MemberListType >::format.

toLabel()

const char * MemberListType::toLabel ()

inline constexpr

Definition at line 402 of file types.h.

402 constexpr const char *toLabel() const

403 {

404 switch (type())

405 {

406 case Invalid_: return "";

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

408 case x##_ : return label;

409 ML_TYPES

410#undef ML_TYPE

411 }

412 return "";

413 }

References Invalid_, ML_TYPES and type.

Referenced by MemberList::writeDeclarations, ClassDefImpl::writeMemberDocumentation, FileDefImpl::writeMemberDocumentation, GroupDefImpl::writeMemberDocumentation, ModuleDefImpl::writeMemberDocumentation, NamespaceDefImpl::writeMemberDocumentation, ClassDefImpl::writeSummaryLinks, FileDefImpl::writeSummaryLinks, GroupDefImpl::writeSummaryLinks, ModuleDefImpl::writeSummaryLinks, NamespaceDefImpl::writeSummaryLinks and VhdlDocGen::writeVHDLDeclarations.

toProtected()

MemberListType MemberListType::toProtected ()

inline

Definition at line 438 of file types.h.

438 MemberListType toProtected() const

439 {

440 switch (type())

441 {

442 case Invalid_: return Invalid();

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

444 case x##_ : return to_prot();

445 ML_TYPES

446#undef ML_TYPE

447 }

448 return Invalid();

449 }

References Invalid, Invalid_, MemberListType, ML_TYPES and type.

Referenced by convertProtectionLevel.

toPublic()

MemberListType MemberListType::toPublic ()

inline

Definition at line 426 of file types.h.

426 MemberListType toPublic() const

427 {

428 switch (type())

429 {

430 case Invalid_: return Invalid();

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

432 case x##_ : return to_pub();

433 ML_TYPES

434#undef ML_TYPE

435 }

436 return Invalid();

437 }

References Invalid, Invalid_, MemberListType, ML_TYPES and type.

Referenced by convertProtectionLevel.

toXML()

const char * MemberListType::toXML ()

inline constexpr

Definition at line 414 of file types.h.

414 constexpr const char *toXML() const

415 {

416 switch (type())

417 {

418 case Invalid_: return "";

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

420 case x##_ : return xml_str;

421 ML_TYPES

422#undef ML_TYPE

423 }

424 return "";

425 }

References Invalid_, ML_TYPES and type.

Referenced by generateXMLForClass, generateXMLForFile, generateXMLForGroup, generateXMLForModule and generateXMLForNamespace.

Private Member Functions

bits_to_string()

std::string MemberListType::bits_to_string ()

inline

Definition at line 455 of file types.h.

455 std::string bits_to_string() const

456 {

457 std::string result;

458 if (m_type&Public) result+=",Public";

459 if (m_type&Protected) result+=",Protected";

460 if (m_type&Package) result+=",Package";

461 if (m_type&Private) result+=",Private";

462 if (m_type&OnlyPublic) result+=",OnlyPublic";

463 if (m_type&Detailed) result+=",Detailed";

464 if (m_type&Documentation) result+=",Documentation";

465 return result;

466 }

References Detailed, Documentation, m_type, OnlyPublic, Package, Private, Protected and Public.

type()

TypeName MemberListType::type ()

inline constexpr

Definition at line 467 of file types.h.

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

References m_type and TypeMask.

Referenced by to_string, toLabel, toProtected, toPublic and toXML.

Private Member Attributes

m_type

int MemberListType::m_type = static_cast<int>(Invalid_)

Definition at line 468 of file types.h.

468 int m_type = static_cast<int>(Invalid_);

Referenced by bits_to_string, isDeclaration, isDetailed, isDocumentation, isInvalid, isOnlyPublic, isPackage, isPrivate, isProtected, isPublic, MemberListType, operator==, to_int and type.

Public Static Functions

Invalid()

MemberListType MemberListType::Invalid ()

inline static

Definition at line 371 of file types.h.

371 static MemberListType Invalid() { return MemberListType(Invalid_); }

References Invalid_ and MemberListType.

Referenced by convertProtectionLevel, ClassDefImpl::countInheritedDecMembers, toProtected, toPublic, ClassDefImpl::writeAdditionalInheritedMembers, ClassDefImpl::writeInheritedMemberDeclarations, ClassDef::writeMemberDeclarations and ClassDefAliasImpl::writeMemberDeclarations.

---

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

• types.h

---

Generated via doxygen2docusaurus by Doxygen 1.14.0.