Doxygen
Loading...
Searching...
No Matches
MemberDefImpl Class Referencefinal
Inheritance diagram for MemberDefImpl:
Collaboration diagram for MemberDefImpl:

Public Member Functions

 MemberDefImpl (const DString &defFileName, int defLine, size_t defColumn, const DString &type, const DString &name, const DString &args, const DString &excp, Protection prot, Specifier virt, bool stat, Relationship related, MemberType t, const ArgumentList &tal, const ArgumentList &al, const DString &metaData)
 ~MemberDefImpl () override=default
DefType definitionType () const override
MemberDef * resolveAlias () override
const MemberDef * resolveAlias () const override
CodeSymbolType codeSymbolType () const override
std::unique_ptr< MemberDef > deepCopy () const override
void moveTo (Definition *) override
DString getOutputFileBase () const override
DString getReference () const override
DString anchor () const override
DString declaration () const override
DString definition () const override
DString typeString () const override
DString argsString () const override
DString excpString () const override
DString bitfieldString () const override
DString extraTypeChars () const override
const DString & initializer () const override
int initializerLines () const override
TypeSpecifier getMemberSpecifiers () const override
VhdlSpecifier getVhdlSpecifiers () const override
const MemberList * getSectionList (const Definition *) const override
DString displayDefinition () const override
const ClassDef * getClassDef () const override
ClassDef * getClassDef () override
const FileDef * getFileDef () const override
FileDef * getFileDef () override
const NamespaceDef * getNamespaceDef () const override
NamespaceDef * getNamespaceDef () override
const GroupDef * getGroupDef () const override
GroupDef * getGroupDef () override
const ModuleDef * getModuleDef () const override
DString getReadAccessor () const override
DString getWriteAccessor () const override
Grouping::GroupPri_t getGroupPri () const override
DString getGroupFileName () const override
int getGroupStartLine () const override
bool getGroupHasDocs () const override
DString qualifiedName () const override
DString objCMethodName (bool localLink, bool showStatic) const override
Protection protection () const override
Specifier virtualness (int count=0) const override
MemberType memberType () const override
DString memberTypeName () const override
bool isSignal () const override
bool isSlot () const override
bool isVariable () const override
bool isEnumerate () const override
bool isEnumValue () const override
bool isTypedef () const override
bool isSequence () const override
bool isDictionary () const override
bool isFunction () const override
bool isFunctionPtr () const override
bool isDefine () const override
bool isFriend () const override
bool isDCOP () const override
bool isProperty () const override
bool isEvent () const override
bool isRelated () const override
bool isForeign () const override
bool isStatic () const override
bool isInline () const override
bool isExplicit () const override
bool isMutable () const override
bool isThreadLocal () const override
bool isGettable () const override
bool isPrivateGettable () const override
bool isProtectedGettable () const override
bool isSettable () const override
bool isPrivateSettable () const override
bool isProtectedSettable () const override
bool isReadable () const override
bool isWritable () const override
bool isAddable () const override
bool isRemovable () const override
bool isRaisable () const override
bool isFinal () const override
bool isAbstract () const override
bool isOverride () const override
bool isInitonly () const override
bool isOptional () const override
bool isRequired () const override
bool isNonAtomic () const override
bool isCopy () const override
bool isAssign () const override
bool isRetain () const override
bool isWeak () const override
bool isStrong () const override
bool isEnumStruct () const override
bool isUnretained () const override
bool isNew () const override
bool isSealed () const override
bool isImplementation () const override
bool isExternal () const override
bool isTypeAlias () const override
bool isDefault () const override
bool isDelete () const override
bool isNoExcept () const override
bool isAttribute () const override
bool isUNOProperty () const override
bool isReadonly () const override
bool isBound () const override
bool isConstrained () const override
bool isTransient () const override
bool isMaybeVoid () const override
bool isMaybeDefault () const override
bool isMaybeAmbiguous () const override
bool isPublished () const override
bool isTemplateSpecialization () const override
bool isObjCMethod () const override
bool isObjCProperty () const override
bool isCSharpProperty () const override
bool isConstructor () const override
bool isDestructor () const override
bool hasOneLineInitializer () const override
bool hasMultiLineInitializer () const override
bool isCallable () const override
bool isStrongEnumValue () const override
bool livesInsideEnum () const override
bool isSliceLocal () const override
bool isNoDiscard () const override
bool isConstExpr () const override
bool isConstEval () const override
bool isConstInit () const override
int numberOfFlowKeyWords () const override
bool isFriendToHide () const override
bool isNotFriend () const override
bool isFunctionOrSignalSlot () const override
bool isRelatedOrFriend () const override
bool isLinkableInProject () const override
bool isLinkable () const override
bool hasDocumentation () const override
bool hasUserDocumentation () const override
bool isDeleted () const override
bool isBriefSectionVisible () const override
bool isDetailedSectionVisible (MemberListContainer container) const override
bool hasDetailedDescription () const override
bool isFriendClass () const override
bool isDocumentedFriendClass () const override
const MemberDef * reimplements () const override
const MemberVector & reimplementedBy () const override
bool isReimplementedBy (const ClassDef *cd) const override
ClassDef * relatedAlso () const override
bool hasDocumentedEnumValues () const override
const MemberDef * getAnonymousEnumType () const override
const MemberDef * anonymousMemberForDeclaration () const override
const MemberDef * anonymousMemberForDetails () const override
bool isDocsForDefinition () const override
const MemberDef * getEnumScope () const override
const MemberVector & enumFieldList () const override
void setEnumBaseType (const DString &type) override
DString enumBaseType () const override
bool hasExamples () const override
const ExampleList & getExamples () const override
bool isPrototype () const override
const ArgumentList & argumentList () const override
const ArgumentList & declArgumentList () const override
const ArgumentList & templateArguments () const override
const ArgumentLists & definitionTemplateParameterLists () const override
std::optional< ArgumentList > formalTemplateArguments () const override
int getMemberGroupId () const override
MemberGroup * getMemberGroup () const override
bool hasCallGraph () const override
bool hasCallerGraph () const override
bool hasReferencesRelation () const override
bool hasReferencedByRelation () const override
bool hasEnumValues () const override
bool hasInlineSource () const override
bool isDocTransferDone () const override
DString sourceRefName () const override
const MemberDef * templateMaster () const override
DString getScopeString () const override
const ClassDef * getClassDefOfAnonymousType () const override
bool isTypedefValCached () const override
const ClassDef * getCachedTypedefVal () const override
DString getCachedTypedefTemplSpec () const override
DString getCachedResolvedTypedef () const override
MemberDef * memberDefinition () const override
MemberDef * memberDeclaration () const override
const MemberDef * inheritsDocsFrom () const override
const MemberDef * getGroupAlias () const override
ClassDef * category () const override
const MemberDef * categoryRelation () const override
DString displayName (bool=true) const override
DString getDeclType () const override
StringVector getLabels (const Definition *container) const override
const ArgumentList & typeConstraints () const override
DString requiresClause () const override
DString documentation () const override
DString briefDescription (bool abbr=false) const override
DString fieldType () const override
bool isReference () const override
DString getDeclFileName () const override
int getDeclLine () const override
size_t getDeclColumn () const override
void setMemberType (MemberType t) override
void setDefinition (const DString &d) override
void setFileDef (FileDef *fd) override
void setAnchor () override
void setProtection (Protection p) override
void setMemberSpecifiers (TypeSpecifier s) override
void setVhdlSpecifiers (VhdlSpecifier s) override
void mergeMemberSpecifiers (TypeSpecifier s) override
void setInitializer (const DString &i) override
void setBitfields (const DString &s) override
void setMaxInitLines (int lines) override
void setMemberClass (ClassDef *cd) override
void setSectionList (const Definition *container, const MemberList *sl) override
void setGroupDef (GroupDef *gd, Grouping::GroupPri_t pri, const DString &fileName, int startLine, bool hasDocs, MemberDef *member=nullptr) override
void setReadAccessor (const DString &r) override
void setWriteAccessor (const DString &w) override
void setTemplateSpecialization (bool b) override
void makeRelated () override
void makeForeign () override
void setInheritsDocsFrom (const MemberDef *md) override
void setTagInfo (const TagInfo *i) override
void setArgsString (const DString &as) override
void setReimplements (MemberDef *md) override
void insertReimplementedBy (MemberDef *md) override
void setRelatedAlso (ClassDef *cd) override
void insertEnumField (MemberDef *md) override
void setEnumScope (MemberDef *md, bool livesInsideEnum=false) override
void setEnumClassScope (ClassDef *cd) override
void setDocumentedEnumValues (bool value) override
void setAnonymousEnumType (const MemberDef *md) override
void setAnonymousMemberForDeclaration (const MemberDef *md) override
void setAnonymousMemberForDetails (const MemberDef *md) override
bool addExample (const DString &anchor, const DString &name, const DString &file) override
void setPrototype (bool p, const DString &df, int line, size_t column) override
void setExplicitExternal (bool b, const DString &df, int line, size_t column) override
void setDeclFile (const DString &df, int line, size_t column) override
void moveArgumentList (std::unique_ptr< ArgumentList > al) override
void moveDeclArgumentList (std::unique_ptr< ArgumentList > al) override
void setDefinitionTemplateParameterLists (const ArgumentLists &lists) override
void setTypeConstraints (const ArgumentList &al) override
void setType (const DString &t) override
void setNamespace (NamespaceDef *nd) override
void setMemberGroup (MemberGroup *grp) override
void setMemberGroupId (int id) override
void makeImplementationDetail () override
void overrideCallGraph (bool e) override
void overrideCallerGraph (bool e) override
void overrideReferencedByRelation (bool e) override
void overrideReferencesRelation (bool e) override
void overrideEnumValues (bool e) override
void overrideInlineSource (bool e) override
void setTemplateMaster (const MemberDef *mt) override
void setFormalTemplateArguments (const ArgumentList &al) override
void addListReference (const Definition *) override
void addRequirementReferences (const Definition *) override
void setDocsForDefinition (bool b) override
void setGroupAlias (const MemberDef *md) override
void cacheTypedefVal (const ClassDef *val, const DString &templSpec, const DString &resolvedType) override
void invalidateTypedefValCache () override
void invalidateCachedArgumentTypes () override
void setMemberDefinition (MemberDef *md) override
void setMemberDeclaration (MemberDef *md) override
void copyArgumentNames (const MemberDef *bmd) override
void setCategory (ClassDef *) override
void setCategoryRelation (const MemberDef *) override
void setDocumentation (const DString &d, const DString &docFile, int docLine, bool stripWhiteSpace=true) override
void setBriefDescription (const DString &b, const DString &briefFile, int briefLine) override
void setInbodyDocumentation (const DString &d, const DString &inbodyFile, int inbodyLine) override
void setHidden (bool b) override
void setDocTransferDone () override
void setExplicitInherited (bool b) override
void setRequiresClause (const DString &req) override
void incrementFlowKeyWordCount () override
void writeDeclaration (OutputList &ol, const ClassDef *cd, const NamespaceDef *nd, const FileDef *fd, const GroupDef *gd, const ModuleDef *mod, bool inGroup, int indentLevel, const ClassDef *inheritFrom=nullptr, const DString &inheritId=DString(), const DString &declAnchor=DString()) const override
void writeDocumentation (const MemberList *ml, int memCount, int memTotal, OutputList &ol, const DString &scopeName, const Definition *container, bool inGroup, bool showEnumValues=false, bool showInline=false) const override
void writeMemberDocSimple (OutputList &ol, const Definition *container) const override
void writeEnumDeclaration (OutputList &typeDecl, const ClassDef *cd, const NamespaceDef *nd, const FileDef *fd, const GroupDef *gd, const ModuleDef *mod) const override
void writeTagFile (TextStream &, bool useQualifiedName, bool showNamespaceMembers) const override
void warnIfUndocumented () const override
void warnIfUndocumentedParams () const override
bool visibleInIndex () const override
void detectUndocumentedParams (bool hasParamCommand, bool hasReturnCommand) const override
std::unique_ptr< MemberDef > createTemplateInstanceMember (const ArgumentList &formalArgs, const std::unique_ptr< ArgumentList > &actualArgs) const override
void findSectionsInDocumentation () override
void writeLink (OutputList &ol, const ClassDef *cd, const NamespaceDef *nd, const FileDef *fd, const GroupDef *gd, const ModuleDef *mod, bool onlyText=false) const override
void resolveUnnamedParameters (const MemberDef *md) override
void addQualifiers (const StringVector &qualifiers) override
StringVector getQualifiers () const override
ClassDefMutable * getClassDefMutable () override
void setModuleDef (ModuleDef *mod) override
int redefineCount () const override
void setRedefineCount (int) override
void setClassDefOfAnonymousType (const ClassDef *cd) override
void setIncludeFile (FileDef *fd, const DString &incName, bool local, bool force) override
Public Member Functions inherited from DefinitionMixin< MemberDefMutable >
 DefinitionMixin (const DString &defFileName, int defLine, size_t defColumn, const DString &name, const char *b=nullptr, const char *d=nullptr, bool isSymbol=true)
DefinitionMixin & operator= (const DefinitionMixin &other)
 ~DefinitionMixin () override=default
bool isAlias () const override
const DString & name () const override
bool isAnonymous () const override
const DString & localName () const override
DString symbolName () const override
DString getSourceFileBase () const override
DString getSourceAnchor () const override
int docLine () const override
DString docFile () const override
DString briefDescriptionAsTooltip () const override
int briefLine () const override
DString inbodyDocumentation () const override
DString inbodyFile () const override
int inbodyLine () const override
DString briefFile () const override
DString getDefFileName () const override
DString getDefFileExtension () const override
int getDefLine () const override
size_t getDefColumn () const override
bool isVisibleInProject () const override
bool isVisible () const override
bool isHidden () const override
bool isArtificial () const override
bool isExported () const override
DString externalReference (const DString &relPath) const override
int getStartDefLine () const override
int getStartBodyLine () const override
int getEndBodyLine () const override
const FileDef * getBodyDef () const override
SrcLangExt getLanguage () const override
const GroupList & partOfGroups () const override
bool isLinkableViaGroup () const override
const RefItemVector & xrefListItems () const override
const RequirementRefs & requirementReferences () const override
const Definition * findInnerCompound (const DString &name) const override
Definition * getOuterScope () const override
const MemberVector & getReferencesMembers () const override
const MemberVector & getReferencedByMembers () const override
bool hasSections () const override
bool hasSources () const override
bool hasBriefDescription () const override
DString id () const override
const SectionRefs & getSectionRefs () const override
void setName (const DString &name) override
void setId (const DString &name) override
void setDefFile (const DString &df, int defLine, size_t defColumn) override
void setReference (const DString &r) override
void addSectionsToDefinition (const std::vector< const SectionInfo * > &anchorList) override
void setBodySegment (int defLine, int bls, int ble) override
void setBodyDef (const FileDef *fd) override
void addSourceReferencedBy (MemberDef *md, const DString &sourceRefName) override
void addSourceReferences (MemberDef *md, const DString &sourceRefName) override
void setRefItems (const RefItemVector &sli) override
void setRequirementReferences (const RequirementRefs &rqli) override
void mergeRefItems (Definition *def) override
void mergeReferences (const Definition *other) override
void mergeReferencedBy (const Definition *other) override
void addInnerCompound (Definition *def) override
void setOuterScope (Definition *def) override
void setArtificial (bool b) override
void setExported (bool b) override
void setLanguage (SrcLangExt lang) override
void writeSourceDef (OutputList &ol) const override
void writeInlineCode (OutputList &ol, const DString &scopeName) const override
bool hasSourceRefs () const override
bool hasSourceReffedBy () const override
void writeSourceRefs (OutputList &ol, const DString &scopeName) const override
void writeSourceReffedBy (OutputList &ol, const DString &scopeName) const override
bool hasRequirementRefs () const override
void writeRequirementRefs (OutputList &ol) const override
void makePartOfGroup (GroupDef *gd) override
void writeNavigationPath (OutputList &ol) const override
DString navigationPathAsString () const override
void writeQuickMemberLinks (OutputList &ol, const MemberDef *md) const override
void writeSummaryLinks (OutputList &ol) const override
void writePageNavigation (OutputList &ol) const override
DString pathFragment () const override
void writeDocAnchorsToTagFile (TextStream &fs) const override
void setLocalName (const DString &name) override
void writeToc (OutputList &ol, const LocalToc &lt) const override
void computeTooltip () override
void _setSymbolName (const DString &name) override
DString _symbolName () const override

Private Member Functions

void _computeLinkableInProject ()
void _computeIsConstructor ()
void _computeIsDestructor ()
void _writeGroupInclude (OutputList &ol, bool inGroup) const
void _writeMultiLineInitializer (OutputList &ol, const DString &scopeName) const
void _writeCallGraph (OutputList &ol) const
void _writeCallerGraph (OutputList &ol) const
void _writeReimplements (OutputList &ol) const
bool _isReimplements () const
void _writeReimplementedBy (OutputList &ol) const
size_t _countReimplementedBy () const
void _writeExamples (OutputList &ol) const
void _writeTypeConstraints (OutputList &ol) const
void _writeEnumValues (OutputList &ol, const Definition *container, const DString &cfname, const DString &ciname, const DString &cname) const
void _writeCategoryRelation (OutputList &ol) const
void _writeTagData (const DefType) const
void _writeTemplatePrefix (OutputList &ol, const Definition *def, const ArgumentList &al, bool writeReqClause=true) const
bool _hasVisibleCallGraph () const
bool _hasVisibleCallerGraph () const
bool _isAnonymousBitField () const
void init (Definition *def, const DString &t, const DString &a, const DString &e, Protection p, Specifier v, bool s, Relationship r, MemberType mt, const ArgumentList &tal, const ArgumentList &al, const DString &meta)

Private Attributes

uint8_t m_isLinkableCached
uint8_t m_isConstructorCached
uint8_t m_isDestructorCached
ClassDef * m_classDef = nullptr
FileDef * m_fileDef = nullptr
NamespaceDef * m_nspace = nullptr
ModuleDef * m_moduleDef = nullptr
const MemberDef * m_enumScope = nullptr
bool m_livesInsideEnum = false
const MemberDef * m_annEnumType = nullptr
MemberVector m_enumFields
const MemberDef * m_annMemberForDecl = nullptr
const MemberDef * m_annMemberForDetails = nullptr
MemberDef * m_redefines = nullptr
MemberVector m_redefinedBy
MemberDef * m_memDef = nullptr
MemberDef * m_memDec = nullptr
ClassDef * m_relatedAlso = nullptr
std::unique_ptr< IncludeInfo > m_incInfo
ExampleList m_examples
DString m_type
DString m_args
DString m_def
DString m_anc
Specifier m_virt = Specifier::Normal
Protection m_prot = Protection::Public
DString m_decl
DString m_bitfields
DString m_read
DString m_write
DString m_exception
DString m_initializer
DString m_extraTypeChars
DString m_enumBaseType
DString m_requiresClause
int m_initLines = 0
bool m_docTransferDone = false
TypeSpecifier m_memSpec
VhdlSpecifier m_vhdlSpec
MemberType m_mtype = MemberType::Define
int m_maxInitLines = 0
int m_userInitLines = 0
ArgumentList m_defArgList
ArgumentList m_declArgList
ArgumentList m_tArgList
ArgumentList m_typeConstraints
const MemberDef * m_templateMaster = nullptr
std::optional< ArgumentList > m_formalTemplateArguments
ArgumentLists m_defTmpArgLists
DString m_metaData
const ClassDef * m_anonymousType = nullptr
std::map< const Definition *, const MemberList * > m_sectionMap
const MemberDef * m_groupAlias = nullptr
int m_grpId = 0
MemberGroup * m_memberGroup = nullptr
GroupDef * m_group = nullptr
Grouping::GroupPri_t m_grouppri = Grouping::GROUPING_AUTO_DEF
DString m_groupFileName
int m_groupStartLine = 0
MemberDef * m_groupMember = nullptr
bool m_isTypedefValCached = false
const ClassDef * m_cachedTypedefValue = nullptr
DString m_cachedTypedefTemplSpec
DString m_cachedResolvedType
const MemberDef * m_docProvider = nullptr
DString m_explicitOutputFileBase
bool m_explicitInherited = false
StringVector m_qualifiers
bool m_implOnly = false
bool m_hasDocumentedParams = false
bool m_hasDocumentedReturnType = false
bool m_isDMember = false
Relationship m_related = Relationship::Member
bool m_stat = false
bool m_proto = false
bool m_docEnumValues = false
bool m_hasDetailedDescriptionCached = false
bool m_detailedDescriptionCachedValue = false
bool m_hasCallGraph = false
bool m_hasCallerGraph = false
bool m_hasReferencedByRelation = false
bool m_hasReferencesRelation = false
bool m_hasInlineSource = false
bool m_hasEnumValues = false
bool m_explExt = false
bool m_tspec = false
bool m_groupHasDocs = false
bool m_docsForDefinition = false
ClassDef * m_category = nullptr
const MemberDef * m_categoryRelation = nullptr
DString m_declFileName
int m_declLine = -1
size_t m_declColumn = 1
int m_numberOfFlowKW = 0
int m_redefineCount = 0

Additional Inherited Members

Public Types inherited from Definition
enum  DefType {
  TypeClass = 0 , TypeFile = 1 , TypeNamespace = 2 , TypeModule = 3 ,
  TypeMember = 4 , TypeGroup = 5 , TypePackage = 6 , TypePage = 7 ,
  TypeDir = 8 , TypeConcept = 9
}

Detailed Description

Definition at line 53 of file memberdef.cpp.

Constructor & Destructor Documentation

◆ MemberDefImpl()

MemberDefImpl::MemberDefImpl ( const DString & df,
int dl,
size_t dc,
const DString & t,
const DString & na,
const DString & a,
const DString & e,
Protection p,
Specifier v,
bool s,
Relationship r,
MemberType mt,
const ArgumentList & tal,
const ArgumentList & al,
const DString & meta )

Creates a new member definition.

Parameters
dfFile containing the definition of this member.
dlLine at which the member definition was found.
dcColumn at which the member definition was found.
tA string representing the type of the member.
naA string representing the name of the member.
aA string representing the arguments of the member.
eA string representing the throw clause of the members.
pThe protection context of the member, possible values are: Public, Protected, Private.
vThe degree of 'virtualness' of the member, possible values are: Normal, Virtual, Pure.
sA boolean that is true iff the member is static.
rThe relationship between the class and the member.
mtThe kind of member. See MemberType for a list of all types.
talThe template arguments of this member.
alThe arguments of this member. This is a structured form of the string past as argument a.
metaSlice metadata.

Definition at line 1477 of file memberdef.cpp.

1482{
1483 //printf("MemberDefImpl::MemberDef(%s)\n",qPrint(na));
1484 init(this,t,a,e,p,v,s,r,mt,tal,al,meta);
1488}
DefinitionMixin(const DString &defFileName, int defLine, size_t defColumn, const DString &name, const char *b=nullptr, const char *d=nullptr, bool isSymbol=true)
uint8_t m_isConstructorCached
uint8_t m_isDestructorCached
void init(Definition *def, const DString &t, const DString &a, const DString &e, Protection p, Specifier v, bool s, Relationship r, MemberType mt, const ArgumentList &tal, const ArgumentList &al, const DString &meta)
uint8_t m_isLinkableCached
DString removeRedundantWhiteSpace(const DString &s)
Definition util.cpp:427

References DefinitionMixin< MemberDefMutable >::DefinitionMixin(), init(), m_isConstructorCached, m_isDestructorCached, m_isLinkableCached, and removeRedundantWhiteSpace().

Referenced by deepCopy(), isConstructor(), isDestructor(), isLinkableInProject(), and ~MemberDefImpl().

◆ ~MemberDefImpl()

MemberDefImpl::~MemberDefImpl ( )
overridedefault

References MemberDefImpl().

Member Function Documentation

◆ _computeIsConstructor()

void MemberDefImpl::_computeIsConstructor ( )
private

Definition at line 4739 of file memberdef.cpp.

4740{
4741 m_isConstructorCached=1; // false
4742 if (getClassDef())
4743 {
4744 if (m_isDMember) // for D
4745 {
4746 m_isConstructorCached = name()=="this" ? 2 : 1;
4747 return;
4748 }
4749 else if (getLanguage()==SrcLangExt::PHP) // for PHP
4750 {
4751 m_isConstructorCached = name()=="__construct" ? 2 : 1;
4752 return;
4753 }
4754 else if (name()=="__init__" &&
4755 getLanguage()==SrcLangExt::Python) // for Python
4756 {
4757 m_isConstructorCached = 2; // true
4758 return;
4759 }
4760 else // for other languages
4761 {
4762 DString locName = getClassDef()->localName();
4763 size_t i=locName.find('<');
4764 if (i==DString::npos) // not a template class
4765 {
4766 m_isConstructorCached = name()==locName ? 2 : 1;
4767 }
4768 else
4769 {
4770 m_isConstructorCached = name()==locName.left(i) ? 2 : 1;
4771 }
4772 return;
4773 }
4774 }
4775}
static constexpr size_t npos
value used to indicate 'not found' or 'to the end of the string', matching std::string::npos
Definition dstring.h:178
size_t find(char c, size_t pos=0) const
Definition dstring.h:239
DString left(size_t len) const
Definition dstring.h:306
virtual const DString & localName() const =0
const DString & name() const override
SrcLangExt getLanguage() const override
const ClassDef * getClassDef() const override

References DString::find(), getClassDef(), DefinitionMixin< MemberDefMutable >::getLanguage(), DString::left(), Definition::localName(), m_isConstructorCached, m_isDMember, DefinitionMixin< MemberDefMutable >::name(), and DString::npos.

Referenced by isConstructor().

◆ _computeIsDestructor()

void MemberDefImpl::_computeIsDestructor ( )
private

Definition at line 4789 of file memberdef.cpp.

4790{
4791 bool isDestructor = false;
4792 if (m_isDMember) // for D
4793 {
4794 isDestructor = name()=="~this";
4795 }
4796 else if (getLanguage()==SrcLangExt::PHP) // for PHP
4797 {
4798 isDestructor = name()=="__destruct";
4799 }
4800 else if (name()=="__del__" &&
4801 getLanguage()==SrcLangExt::Python) // for Python
4802 {
4803 isDestructor = true;
4804 }
4805 else if (getLanguage()==SrcLangExt::Fortran) // for Fortran
4806 {
4807 isDestructor = typeString()=="final";
4808 }
4809 else // other languages
4810 {
4811 isDestructor =
4812 (name().find('~')!=DString::npos || name().find('!')!=DString::npos) // The ! is for C++/CLI
4813 && name().find("operator")==DString::npos;
4814 }
4816}
bool isDestructor() const override
DString typeString() const override

References DString::find(), DefinitionMixin< MemberDefMutable >::getLanguage(), isDestructor(), m_isDestructorCached, m_isDMember, DefinitionMixin< MemberDefMutable >::name(), DString::npos, and typeString().

Referenced by isDestructor().

◆ _computeLinkableInProject()

void MemberDefImpl::_computeLinkableInProject ( )
private

Definition at line 1838 of file memberdef.cpp.

1839{
1840 AUTO_TRACE("name={}",qualifiedName());
1841 bool extractStatic = Config_getBool(EXTRACT_STATIC);
1842 bool extractPrivateVirtual = Config_getBool(EXTRACT_PRIV_VIRTUAL);
1843 m_isLinkableCached = 2; // linkable
1844 //printf("MemberDefImpl::isLinkableInProject(name=%s)\n",qPrint(name()));
1845 if (isHidden())
1846 {
1847 AUTO_TRACE_ADD("is hidden");
1849 return;
1850 }
1851 if (templateMaster())
1852 {
1853 AUTO_TRACE_ADD("has master template");
1855 return;
1856 }
1857 if (isAnonymous())
1858 {
1859 AUTO_TRACE_ADD("name invalid");
1860 m_isLinkableCached = 1; // not a valid or a dummy name
1861 return;
1862 }
1863 if (!hasDocumentation() || isReference())
1864 {
1865 AUTO_TRACE_ADD("no docs or reference");
1866 m_isLinkableCached = 1; // no documentation
1867 return;
1868 }
1869 const GroupDef *groupDef = getGroupDef();
1870 const ClassDef *classDef = getClassDef();
1871 if (groupDef && !groupDef->isLinkableInProject())
1872 {
1873 AUTO_TRACE_ADD("in not linkable group");
1874 m_isLinkableCached = 1; // group but group not linkable
1875 return;
1876 }
1877 if (!groupDef && classDef && !classDef->isLinkableInProject())
1878 {
1879 AUTO_TRACE_ADD("in not linkable class");
1880 m_isLinkableCached = 1; // in class but class not linkable
1881 return;
1882 }
1883 const NamespaceDef *nspace = getNamespaceDef();
1884 const FileDef *fileDef = getFileDef();
1885 if (!groupDef && nspace /*&& m_related==Relationship::Member*/ && !nspace->isLinkableInProject()
1886 && (fileDef==nullptr || !fileDef->isLinkableInProject()))
1887 {
1888 AUTO_TRACE_ADD("in not linkable namespace");
1889 m_isLinkableCached = 1; // in namespace but namespace not linkable
1890 return;
1891 }
1892 if (!groupDef && !nspace &&
1893 /*m_related==Relationship::Member &&*/ !classDef &&
1894 fileDef && !fileDef->isLinkableInProject())
1895 {
1896 AUTO_TRACE_ADD("in not linkable file");
1897 m_isLinkableCached = 1; // in file (and not in namespace) but file not linkable
1898 return;
1899 }
1900 if ((!protectionLevelVisible(m_prot) && m_mtype!=MemberType::Friend) &&
1901 !(m_prot==Protection::Private && (m_virt!=Specifier::Normal || isOverride() || isFinal()) && extractPrivateVirtual))
1902 {
1903 AUTO_TRACE_ADD("private and invisible");
1904 m_isLinkableCached = 1; // hidden due to protection
1905 return;
1906 }
1907 if (m_stat && classDef==nullptr && !extractStatic)
1908 {
1909 AUTO_TRACE_ADD("static and invisible");
1910 m_isLinkableCached = 1; // hidden due to staticness
1911 return;
1912 }
1913 AUTO_TRACE_ADD("linkable");
1914 return; // linkable!
1915}
virtual bool isLinkableInProject() const =0
MemberType m_mtype
const NamespaceDef * getNamespaceDef() const override
Specifier m_virt
bool isReference() const override
Protection m_prot
const GroupDef * getGroupDef() const override
const MemberDef * templateMaster() const override
DString qualifiedName() const override
bool isFinal() const override
bool hasDocumentation() const override
const FileDef * getFileDef() const override
bool isOverride() const override
#define Config_getBool(name)
Definition config.h:33
#define AUTO_TRACE_ADD(...)
Definition docnode.cpp:54
#define AUTO_TRACE(...)
Definition docnode.cpp:53
bool protectionLevelVisible(Protection prot)
Definition util.cpp:4684

References AUTO_TRACE, AUTO_TRACE_ADD, Config_getBool, getClassDef(), getFileDef(), getGroupDef(), getNamespaceDef(), hasDocumentation(), DefinitionMixin< MemberDefMutable >::isAnonymous(), isFinal(), DefinitionMixin< MemberDefMutable >::isHidden(), Definition::isLinkableInProject(), isOverride(), isReference(), m_isLinkableCached, m_mtype, m_prot, m_stat, m_virt, protectionLevelVisible(), qualifiedName(), and templateMaster().

Referenced by isLinkableInProject().

◆ _countReimplementedBy()

size_t MemberDefImpl::_countReimplementedBy ( ) const
private

Definition at line 3035 of file memberdef.cpp.

3036{
3037 const MemberVector &bml=reimplementedBy();
3038 size_t count=0;
3039 for (const auto &bmd : bml)
3040 {
3041 const ClassDef *bcd=bmd->getClassDef();
3042 // count the members that directly inherit from md and for
3043 // which the member and class are visible in the docs.
3044 if ( bcd && bmd->isLinkable() && bcd->isLinkable() )
3045 {
3046 count++;
3047 }
3048 }
3049 return count;
3050}
virtual bool isLinkable() const =0
const MemberVector & reimplementedBy() const override

References Definition::isLinkable(), and reimplementedBy().

Referenced by _writeReimplementedBy(), and hasDetailedDescription().

◆ _hasVisibleCallerGraph()

bool MemberDefImpl::_hasVisibleCallerGraph ( ) const
private

Definition at line 5765 of file memberdef.cpp.

5766{
5767 bool enabled = m_hasCallerGraph &&
5768 (isFunction() || isSlot() || isSignal()) &&
5769 Config_getBool(HAVE_DOT);
5770 if (enabled)
5771 {
5772 bool trivial = DotCallGraph::isTrivial(this,true);
5773 return !trivial;
5774 }
5775 return false;
5776}
bool isTrivial() const
bool isFunction() const override
bool m_hasCallerGraph
bool isSlot() const override
bool isSignal() const override

References Config_getBool, isFunction(), isSignal(), isSlot(), DotCallGraph::isTrivial(), and m_hasCallerGraph.

Referenced by _writeCallerGraph(), and hasDetailedDescription().

◆ _hasVisibleCallGraph()

bool MemberDefImpl::_hasVisibleCallGraph ( ) const
private

Definition at line 5747 of file memberdef.cpp.

5748{
5749 bool enabled = m_hasCallGraph &&
5750 (isFunction() || isSlot() || isSignal()) &&
5751 Config_getBool(HAVE_DOT);
5752 if (enabled)
5753 {
5754 bool trivial = DotCallGraph::isTrivial(this,false);
5755 return !trivial;
5756 }
5757 return false;
5758}

References Config_getBool, isFunction(), isSignal(), isSlot(), DotCallGraph::isTrivial(), and m_hasCallGraph.

Referenced by _writeCallGraph(), and hasDetailedDescription().

◆ _isAnonymousBitField()

bool MemberDefImpl::_isAnonymousBitField ( ) const
private

Definition at line 2228 of file memberdef.cpp.

2229{
2230 return !m_bitfields.empty() && name().startsWith("__pad"); // anonymous bitfield
2231}
bool empty() const
Returns true iff the string is empty (std::string compatible alias for isEmpty()).
Definition dstring.h:148
bool startsWith(const char *s) const
Definition dstring.h:600
DString m_bitfields

References DString::empty(), m_bitfields, DefinitionMixin< MemberDefMutable >::name(), and DString::startsWith().

Referenced by warnIfUndocumented(), and writeDeclaration().

◆ _isReimplements()

bool MemberDefImpl::_isReimplements ( ) const
private

Definition at line 2963 of file memberdef.cpp.

2964{
2965 const MemberDef *bmd=reimplements();
2966 const ClassDef *bcd=nullptr;
2967 if (bmd && (bcd=bmd->getClassDef()))
2968 {
2969 // write class that contains a member that is reimplemented by this one
2970 if (bcd->isLinkable())
2971 {
2972 return true;
2973 }
2974 }
2975 return false;
2976}
virtual const ClassDef * getClassDef() const =0
const MemberDef * reimplements() const override

References MemberDef::getClassDef(), Definition::isLinkable(), and reimplements().

Referenced by hasDetailedDescription().

◆ _writeCallerGraph()

void MemberDefImpl::_writeCallerGraph ( OutputList & ol) const
private

Definition at line 2941 of file memberdef.cpp.

2942{
2944 {
2945 DotCallGraph callerGraph(this, true);
2946 if (callerGraph.isTooBig())
2947 {
2948 warn_uncond("Caller graph for '{}' not generated, too many nodes ({}), threshold is {}. Consider increasing DOT_GRAPH_MAX_NODES.\n",
2949 qualifiedName(), callerGraph.numNodes(), Config_getInt(DOT_GRAPH_MAX_NODES));
2950 }
2951 else if (!callerGraph.isTrivial())
2952 {
2953 msg("Generating caller graph for function {}\n",qualifiedName());
2955 ol.startCallGraph();
2957 ol.endCallGraph(callerGraph);
2958 ol.enableAll();
2959 }
2960 }
2961}
bool _hasVisibleCallerGraph() const
void parseText(const DString &textStr)
void disable(OutputType o)
void startCallGraph()
Definition outputlist.h:652
void endCallGraph(DotCallGraph &g)
Definition outputlist.h:654
void enableAll()
virtual DString trCallerGraph()=0
#define Config_getInt(name)
Definition config.h:34
Translator * theTranslator
Definition language.cpp:76
#define warn_uncond(fmt,...)
Definition message.h:122
#define msg(fmt,...)
Definition message.h:94

References _hasVisibleCallerGraph(), Config_getInt, OutputList::disable(), OutputList::enableAll(), OutputList::endCallGraph(), DotCallGraph::isTooBig(), DotCallGraph::isTrivial(), Man, msg, DotCallGraph::numNodes(), OutputList::parseText(), qualifiedName(), OutputList::startCallGraph(), theTranslator, Translator::trCallerGraph(), and warn_uncond.

Referenced by writeDocumentation().

◆ _writeCallGraph()

void MemberDefImpl::_writeCallGraph ( OutputList & ol) const
private

Definition at line 2918 of file memberdef.cpp.

2919{
2920 // write call graph
2922 {
2923 DotCallGraph callGraph(this,false);
2924 if (callGraph.isTooBig())
2925 {
2926 warn_uncond("Call graph for '{}' not generated, too many nodes ({}), threshold is {}. Consider increasing DOT_GRAPH_MAX_NODES.\n",
2927 qualifiedName(), callGraph.numNodes(), Config_getInt(DOT_GRAPH_MAX_NODES));
2928 }
2929 else if (!callGraph.isTrivial())
2930 {
2931 msg("Generating call graph for function {}\n",qualifiedName());
2933 ol.startCallGraph();
2935 ol.endCallGraph(callGraph);
2936 ol.enableAll();
2937 }
2938 }
2939}
bool _hasVisibleCallGraph() const
virtual DString trCallGraph()=0

References _hasVisibleCallGraph(), Config_getInt, OutputList::disable(), OutputList::enableAll(), OutputList::endCallGraph(), DotCallGraph::isTooBig(), DotCallGraph::isTrivial(), Man, msg, DotCallGraph::numNodes(), OutputList::parseText(), qualifiedName(), OutputList::startCallGraph(), theTranslator, Translator::trCallGraph(), and warn_uncond.

Referenced by writeDocumentation().

◆ _writeCategoryRelation()

void MemberDefImpl::_writeCategoryRelation ( OutputList & ol) const
private

Definition at line 3111 of file memberdef.cpp.

3112{
3113 if (getClassDef()) // this should be a member of a class/category
3114 {
3115 //printf("%s: category %s relation %s class=%s categoryOf=%s\n",
3116 // qPrint(name()),
3117 // m_category ? qPrint(m_category->name()) : "<none>",
3118 // m_categoryRelation ? qPrint(m_categoryRelation->name()) : "<none>",
3119 // qPrint(m_classDef->name()),
3120 // m_classDef->categoryOf() ? qPrint(m_classDef->categoryOf()->name()) : "<none>"
3121 // );
3122 DString text;
3123 DString ref;
3124 DString file;
3125 DString anc;
3126 DString name;
3127 size_t i=DString::npos;
3129 {
3130 if (m_category)
3131 {
3132 // this member is in a normal class and implements method categoryRelation from category
3133 // so link to method 'categoryRelation' with 'provided by category 'category' text.
3136 }
3137 else if (getClassDef()->categoryOf())
3138 {
3139 // this member is part of a category so link to the corresponding class member of the class we extend
3140 // so link to method 'categoryRelation' with 'extends class 'classDef->categoryOf()'
3141 text = theTranslator->trExtendsClass();
3143 }
3144 i=text.find("@0");
3145 if (i!=DString::npos)
3146 {
3147 const MemberDef *md = m_categoryRelation;
3148 ref = md->getReference();
3149 file = md->getOutputFileBase();
3150 anc = md->anchor();
3151 }
3152 }
3153 if (i!=DString::npos && !name.empty())
3154 {
3155 ol.startParagraph();
3156 ol.parseText(text.left(i));
3157 ol.writeObjectLink(ref,file,anc,name);
3158 ol.parseText(text.mid(i+2));
3159 ol.endParagraph();
3160 }
3161 }
3162}
virtual ClassDef * categoryOf() const =0
Returns the class of which this is a category (Objective-C only).
DString mid(size_t index, size_t len=npos) const
Definition dstring.h:318
virtual const DString & name() const =0
virtual DString displayName(bool includeScope=true) const =0
virtual DString anchor() const =0
virtual DString getReference() const =0
virtual DString getOutputFileBase() const =0
const MemberDef * m_categoryRelation
ClassDef * m_category
void startParagraph(const DString &classDef=DString())
Definition outputlist.h:403
void writeObjectLink(const DString &ref, const DString &file, const DString &anchor, const DString &name)
Definition outputlist.h:435
void endParagraph()
Definition outputlist.h:405
virtual DString trProvidedByCategory()=0
virtual DString trExtendsClass()=0

References Definition::anchor(), ClassDef::categoryOf(), Definition::displayName(), OutputList::endParagraph(), DString::find(), getClassDef(), Definition::getOutputFileBase(), Definition::getReference(), Definition::isLinkable(), DString::left(), m_category, m_categoryRelation, DString::mid(), DefinitionMixin< MemberDefMutable >::name(), DString::npos, OutputList::parseText(), OutputList::startParagraph(), theTranslator, Translator::trExtendsClass(), Translator::trProvidedByCategory(), and OutputList::writeObjectLink().

Referenced by writeDocumentation().

◆ _writeEnumValues()

void MemberDefImpl::_writeEnumValues ( OutputList & ol,
const Definition * container,
const DString & cfname,
const DString & ciname,
const DString & cname ) const
private

Definition at line 3185 of file memberdef.cpp.

3188{
3189 // For enum, we also write the documented enum values
3190 if (isEnumerate())
3191 {
3192 bool first=true;
3193 //printf("** %s: enum values=%zu\n",qPrint(name()),enumFieldList().size());
3194 bool hasInits = false;
3195 if (hasEnumValues())
3196 {
3197 for (const auto &fmd : enumFieldList())
3198 {
3199 if (fmd->isLinkable())
3200 {
3201 if (!fmd->initializer().empty())
3202 {
3203 hasInits = true;
3204 break;
3205 }
3206 }
3207 }
3208 }
3209 for (const auto &fmd : enumFieldList())
3210 {
3211 //printf("Enum %p: isLinkable()=%d\n",fmd,fmd->isLinkable());
3212 if (fmd->isLinkable())
3213 {
3214 if (first)
3215 {
3217 first=false;
3218 }
3219
3220 ol.startDescTableRow();
3221 ol.addIndexItem(fmd->name(),ciname);
3222 ol.addIndexItem(ciname,fmd->name());
3223
3225 ol.startDoxyAnchor(cfname,cname,fmd->anchor(),fmd->name(),fmd->argsString());
3226 ol.addLabel(cfname,fmd->anchor());
3227 ol.docify(fmd->name());
3229 ol.writeString(" ");
3230 ol.enableAll();
3231 ol.endDoxyAnchor(cfname,fmd->anchor());
3232 ol.endDescTableTitle();
3233 if (hasInits)
3234 {
3235 ol.startDescTableInit();
3236 if (!fmd->initializer().empty())
3237 {
3238 DString initStr = fmd->initializer().stripWhiteSpace();
3239 if (initStr.startsWith("=")) initStr = initStr.mid(1).stripWhiteSpace();
3241 ol.writeString("(");
3242 ol.enableAll();
3243 ol.docify(initStr);
3245 ol.writeString(")");
3246 ol.enableAll();
3247 }
3248 ol.endDescTableInit();
3249 }
3250 ol.startDescTableData();
3251
3252 bool hasBrief = !fmd->briefDescription().empty();
3253 bool hasDetails = !fmd->documentation().empty();
3254
3255 if (hasBrief)
3256 {
3257 ol.generateDoc(fmd->briefFile(),
3258 fmd->briefLine(),
3259 getOuterScope()?getOuterScope():container,
3260 fmd,
3261 fmd->briefDescription(),
3262 DocOptions()
3263 .setIndexWords(true));
3264 }
3265 if (hasDetails)
3266 {
3267 ol.generateDoc(fmd->docFile(),
3268 fmd->docLine(),
3269 getOuterScope()?getOuterScope():container,
3270 fmd,
3271 fmd->documentation()+"\n",
3272 DocOptions()
3273 .setIndexWords(true));
3274 }
3275 ol.endDescTableData();
3276 ol.endDescTableRow();
3277 }
3278 }
3279 if (!first)
3280 {
3281 ol.endDescTable();
3282 }
3283 }
3284}
DString stripWhiteSpace() const
returns a copy of this string with leading and trailing whitespace removed
Definition dstring.h:337
virtual DString briefDescription(bool abbreviate=false) const =0
virtual DString documentation() const =0
virtual Definition * getOuterScope() const =0
Definition * getOuterScope() const override
bool isEnumerate() const override
bool hasEnumValues() const override
const MemberVector & enumFieldList() const override
void endDescTableRow()
Definition outputlist.h:630
void startDescTableInit()
Definition outputlist.h:636
void addIndexItem(const DString &s1, const DString &s2)
Definition outputlist.h:586
void endDescTable()
Definition outputlist.h:626
void docify(const DString &s)
Definition outputlist.h:433
void endDescTableTitle()
Definition outputlist.h:634
void writeString(const DString &text)
Definition outputlist.h:407
void endDoxyAnchor(const DString &fn, const DString &anchor)
Definition outputlist.h:537
void startDescTable(const DString &title, const bool hasInits)
Definition outputlist.h:624
void endDescTableData()
Definition outputlist.h:642
void startDescTableTitle()
Definition outputlist.h:632
void addLabel(const DString &fName, const DString &anchor)
Definition outputlist.h:539
void startDescTableData()
Definition outputlist.h:640
void disableAllBut(OutputType o)
void generateDoc(const DString &fileName, int startLine, const Definition *ctx, const MemberDef *md, const DString &docStr, const DocOptions &options)
void startDoxyAnchor(const DString &fName, const DString &manName, const DString &anchor, const DString &name, const DString &args)
Definition outputlist.h:533
void endDescTableInit()
Definition outputlist.h:638
void startDescTableRow()
Definition outputlist.h:628
virtual DString trEnumerationValues()=0

References OutputList::addIndexItem(), OutputList::addLabel(), Definition::briefDescription(), OutputList::disableAllBut(), OutputList::docify(), Definition::documentation(), OutputList::enableAll(), OutputList::endDescTable(), OutputList::endDescTableData(), OutputList::endDescTableInit(), OutputList::endDescTableRow(), OutputList::endDescTableTitle(), OutputList::endDoxyAnchor(), enumFieldList(), OutputList::generateDoc(), DefinitionMixin< MemberDefMutable >::getOuterScope(), hasEnumValues(), isEnumerate(), Man, DString::mid(), OutputList::startDescTable(), OutputList::startDescTableData(), OutputList::startDescTableInit(), OutputList::startDescTableRow(), OutputList::startDescTableTitle(), OutputList::startDoxyAnchor(), DString::startsWith(), DString::stripWhiteSpace(), theTranslator, Translator::trEnumerationValues(), and OutputList::writeString().

Referenced by writeDocumentation().

◆ _writeExamples()

void MemberDefImpl::_writeExamples ( OutputList & ol) const
private

Definition at line 3164 of file memberdef.cpp.

3165{
3166 // write the list of examples that use this member
3167 if (hasExamples())
3168 {
3169 ol.startExamples();
3170 ol.startDescForItem();
3172 ol.endDescForItem();
3173 ol.endExamples();
3174 }
3175}
ExampleList m_examples
bool hasExamples() const override
void endDescForItem()
Definition outputlist.h:545
void endExamples()
Definition outputlist.h:576
void startExamples()
Definition outputlist.h:574
void startDescForItem()
Definition outputlist.h:543
void writeExamples(OutputList &ol, const ExampleList &list)
Definition util.cpp:809

References OutputList::endDescForItem(), OutputList::endExamples(), hasExamples(), m_examples, OutputList::startDescForItem(), OutputList::startExamples(), and writeExamples().

Referenced by writeDocumentation().

◆ _writeGroupInclude()

void MemberDefImpl::_writeGroupInclude ( OutputList & ol,
bool inGroup ) const
private

Definition at line 3372 of file memberdef.cpp.

3373{
3374 SrcLangExt lang = getLanguage();
3375 bool written = false;
3376 if (m_incInfo) // explicit \headerfile command
3377 {
3378 DString nm=m_incInfo->includeName.empty() ?
3379 (m_incInfo->fileDef ?
3380 m_incInfo->fileDef->docName() : DString()
3381 ) : m_incInfo->includeName;
3382 if (!nm.empty())
3383 {
3384 ol.startParagraph();
3385 ol.startTypewriter();
3386 ol.docify(::includeStatement(lang,m_incInfo->kind));
3387 ol.docify(::includeOpen(lang,m_incInfo->kind));
3388 ol.pushGeneratorState();
3390 ol.docify(nm);
3393 if (m_incInfo->fileDef)
3394 {
3395 ol.writeObjectLink(DString(),m_incInfo->fileDef->includeName(),DString(),nm);
3396 }
3397 else
3398 {
3399 ol.docify(nm);
3400 }
3401 ol.popGeneratorState();
3402 ol.docify(::includeClose(lang,m_incInfo->kind));
3403 ol.endTypewriter();
3404 ol.endParagraph();
3405 written = true;
3406 }
3407 }
3408 if (!written) // only write out the include file if this is not part of a class or file definition
3409 {
3410 bool showGroupedMembInc = Config_getBool(SHOW_GROUPED_MEMB_INC);
3411 bool forceLocalIncludes = Config_getBool(FORCE_LOCAL_INCLUDES);
3412 const FileDef *fd = getFileDef();
3413 DString nm;
3414 if (inGroup && fd && showGroupedMembInc)
3415 {
3416 if (!Config_getList(STRIP_FROM_INC_PATH).empty())
3417 {
3419 }
3420 else
3421 {
3422 nm = fd->name();
3423 }
3424 }
3425 if (!nm.empty())
3426 {
3427 ol.startParagraph();
3428 ol.startTypewriter();
3429 bool isIDLorJava = lang==SrcLangExt::IDL || lang==SrcLangExt::Java;
3430 if (isIDLorJava)
3431 {
3432 ol.docify("import ");
3433 }
3434 else
3435 {
3436 ol.docify("#include ");
3437 }
3438
3439 if (isIDLorJava || forceLocalIncludes) ol.docify("\""); else ol.docify("<");
3440
3441 if (fd && fd->isLinkable())
3442 {
3443 ol.writeObjectLink(fd->getReference(),fd->getOutputFileBase(),fd->anchor(),nm);
3444 }
3445 else
3446 {
3447 ol.docify(nm);
3448 }
3449
3450 if (isIDLorJava || forceLocalIncludes) ol.docify("\""); else ol.docify(">");
3451
3452 ol.endTypewriter();
3453 ol.endParagraph();
3454 }
3455 }
3456}
virtual DString absFilePath() const =0
std::unique_ptr< IncludeInfo > m_incInfo
void enable(OutputType o)
void startTypewriter()
Definition outputlist.h:445
void pushGeneratorState()
void popGeneratorState()
void endTypewriter()
Definition outputlist.h:447
#define Config_getList(name)
Definition config.h:38
DString includeClose(SrcLangExt lang, IncludeKind kind)
Definition filedef.cpp:82
DString includeOpen(SrcLangExt lang, IncludeKind kind)
Definition filedef.cpp:69
DString includeStatement(SrcLangExt lang, IncludeKind kind)
Definition filedef.cpp:52
SrcLangExt
Definition types.h:207
DString stripFromIncludePath(const DString &path)
Definition util.cpp:227

References FileDef::absFilePath(), Definition::anchor(), Config_getBool, Config_getList, OutputList::disable(), OutputList::disableAllBut(), OutputList::docify(), DString::empty(), OutputList::enable(), OutputList::endParagraph(), OutputList::endTypewriter(), getFileDef(), DefinitionMixin< MemberDefMutable >::getLanguage(), Definition::getOutputFileBase(), Definition::getReference(), Html, includeClose(), includeOpen(), includeStatement(), Definition::isLinkable(), m_incInfo, Definition::name(), OutputList::popGeneratorState(), OutputList::pushGeneratorState(), OutputList::startParagraph(), OutputList::startTypewriter(), stripFromIncludePath(), and OutputList::writeObjectLink().

Referenced by writeDocumentation().

◆ _writeMultiLineInitializer()

void MemberDefImpl::_writeMultiLineInitializer ( OutputList & ol,
const DString & scopeName ) const
private

Definition at line 3458 of file memberdef.cpp.

3459{
3460 //printf("md=%s initLines=%d init='%s'\n",qPrint(name()),initLines,qPrint(init));
3461 ol.startBold();
3462 if (m_mtype==MemberType::Define)
3464 else
3466 ol.endBold();
3467 DString langCorrected = getDefFileExtension();
3469 if (srcLangExt == SrcLangExt::Lex)
3470 {
3471 langCorrected = ".doxygen_lex_c";
3472 srcLangExt = SrcLangExt::Cpp;
3473 }
3474 auto intf = Doxygen::parserManager->getCodeParser(langCorrected);
3475 intf->resetCodeParserState();
3476 auto &codeOL = ol.codeGenerators();
3477 codeOL.startCodeFragment("DoxyCode");
3478 intf->parseCode(codeOL,scopeName,m_initializer,srcLangExt,Config_getBool(STRIP_CODE_COMMENTS),
3479 CodeParserOptions()
3481 .setInlineFragment(true)
3482 .setMemberDef(this)
3483 .setShowLineNumbers(false)
3484 .setSearchCtx(this)
3485 );
3486 codeOL.endCodeFragment("DoxyCode");
3487}
DString getDefFileExtension() const override
static ParserManager * parserManager
Definition doxygen.h:122
void setFileDef(FileDef *fd) override
DString m_initializer
void startCodeFragment(const DString &style)
Definition outputlist.h:276
const OutputCodeList & codeGenerators() const
Definition outputlist.h:354
void startBold()
Definition outputlist.h:557
void endBold()
Definition outputlist.h:559
std::unique_ptr< CodeParserInterface > getCodeParser(const DString &extension)
Gets the interface to the parser associated with a given extension.
Definition parserintf.h:253
virtual DString trDefineValue()=0
virtual DString trInitialValue()=0
SrcLangExt getLanguageFromFileName(const DString &fileName, SrcLangExt defLang)
Definition util.cpp:4177

References OutputList::codeGenerators(), Config_getBool, OutputList::endBold(), ParserManager::getCodeParser(), DefinitionMixin< MemberDefMutable >::getDefFileExtension(), getFileDef(), getLanguageFromFileName(), m_initializer, m_mtype, Doxygen::parserManager, OutputList::parseText(), setFileDef(), OutputList::startBold(), OutputCodeList::startCodeFragment(), theTranslator, Translator::trDefineValue(), and Translator::trInitialValue().

Referenced by writeDocumentation().

◆ _writeReimplementedBy()

void MemberDefImpl::_writeReimplementedBy ( OutputList & ol) const
private

Definition at line 3052 of file memberdef.cpp.

3053{
3054 const MemberVector &bml=reimplementedBy();
3055 size_t count = _countReimplementedBy();
3056 if (count>0)
3057 {
3058 auto replaceFunc = [&bml,&ol](size_t entryIndex)
3059 {
3060 size_t cnt=0;
3061 auto it = bml.begin();
3062 // find the entryIndex-th documented entry in the inheritance list.
3063 const MemberDef *bmd = nullptr;
3064 const ClassDef *bcd = nullptr;
3065 while (it!=bml.end())
3066 {
3067 bmd = *it;
3068 bcd = bmd->getClassDef();
3069 if ( bmd->isLinkable() && bcd->isLinkable())
3070 {
3071 if (cnt==entryIndex) break;
3072 cnt++;
3073 }
3074 ++it;
3075 }
3076
3077 if (bcd && bmd) // write link for marker
3078 {
3079 //ol.writeObjectLink(bcd->getReference(),bcd->getOutputFileBase(),
3080 // bmd->anchor(),bcd->name());
3082 bmd->anchor(),bcd->displayName());
3083
3084 if (bmd->isLinkableInProject() )
3085 {
3086 writePageRef(ol,bmd->getOutputFileBase(),bmd->anchor());
3087 }
3088 }
3089 };
3090
3091 DString reimplInLine;
3092 if (m_virt==Specifier::Pure || (getClassDef() && getClassDef()->compoundType()==ClassDef::Interface))
3093 {
3094 reimplInLine = theTranslator->trImplementedInList(static_cast<int>(count));
3095 }
3096 else
3097 {
3098 reimplInLine = theTranslator->trReimplementedInList(static_cast<int>(count));
3099 }
3100
3101 // write the list of classes that overwrite this member
3102 ol.startParagraph();
3103 writeMarkerList(ol,
3104 reimplInLine.str(),
3105 count,
3106 replaceFunc);
3107 ol.endParagraph();
3108 }
3109}
@ Interface
Definition classdef.h:109
const std::string & str() const
Definition dstring.h:645
size_t _countReimplementedBy() const
iterator end() noexcept
Definition memberlist.h:57
iterator begin() noexcept
Definition memberlist.h:55
virtual DString trImplementedInList(int numEntries)=0
virtual DString trReimplementedInList(int numEntries)=0
static void writePageRef(OutputList &ol, const DString &cn, const DString &mn)
void writeMarkerList(OutputList &ol, const std::string &markerText, size_t numMarkers, std::function< void(size_t)> replaceFunc)
Definition util.cpp:758

References _countReimplementedBy(), Definition::anchor(), MemberVector::begin(), Definition::displayName(), MemberVector::end(), OutputList::endParagraph(), MemberDef::getClassDef(), getClassDef(), Definition::getOutputFileBase(), Definition::getReference(), ClassDef::Interface, Definition::isLinkable(), Definition::isLinkableInProject(), m_virt, reimplementedBy(), OutputList::startParagraph(), DString::str(), theTranslator, Translator::trImplementedInList(), Translator::trReimplementedInList(), writeMarkerList(), OutputList::writeObjectLink(), and writePageRef().

Referenced by writeDocumentation().

◆ _writeReimplements()

void MemberDefImpl::_writeReimplements ( OutputList & ol) const
private

Definition at line 2977 of file memberdef.cpp.

2978{
2979 const MemberDef *bmd=reimplements();
2980 const ClassDef *bcd=nullptr;
2981 if (bmd && (bcd=bmd->getClassDef()))
2982 {
2983 // write class that contains a member that is reimplemented by this one
2984 if (bcd->isLinkable())
2985 {
2986 ol.startParagraph();
2987 DString reimplFromLine;
2988 if (bmd->virtualness()!=Specifier::Pure && bcd->compoundType()!=ClassDef::Interface)
2989 {
2990 reimplFromLine = theTranslator->trReimplementedFromList(1);
2991 }
2992 else
2993 {
2994 reimplFromLine = theTranslator->trImplementedFromList(1);
2995 }
2996 if (size_t markerPos = reimplFromLine.find("@0"); markerPos!=DString::npos) // should always pass this.
2997 {
2998 ol.parseText(reimplFromLine.left(markerPos)); //text left from marker
2999 if (bmd->isLinkable()) // replace marker with link
3000 {
3001 //Definition *bd=bmd->group;
3002 //if (bd==0) bd=bcd;
3004 bmd->anchor(),bcd->displayName());
3005
3006 //ol.writeObjectLink(bcd->getReference(),bcd->getOutputFileBase(),
3007 // bmd->anchor(),bcd->name());
3008 if ( bmd->isLinkableInProject() )
3009 {
3010 writePageRef(ol,bmd->getOutputFileBase(),bmd->anchor());
3011 }
3012 }
3013 else
3014 {
3016 DString(),bcd->displayName());
3017 if (bcd->isLinkableInProject()/* && !Config_getBool(PDF_HYPERLINKS)*/ )
3018 {
3019 writePageRef(ol,bcd->getOutputFileBase(),bcd->anchor());
3020 }
3021 }
3022 ol.parseText(reimplFromLine.right(
3023 reimplFromLine.length()-markerPos-2)); // text right from marker
3024
3025 }
3026 else
3027 {
3028 err("translation error: no marker in trReimplementsFromList()\n");
3029 }
3030 ol.endParagraph();
3031 }
3032 }
3033}
virtual CompoundType compoundType() const =0
Returns the type of compound this is, i.e. class/struct/union/...
DString right(size_t len) const
Definition dstring.h:311
size_t length() const
Returns the length of the string, not counting the 0-terminator.
Definition dstring.h:151
virtual Specifier virtualness(int count=0) const =0
virtual DString trReimplementedFromList(int numEntries)=0
virtual DString trImplementedFromList(int numEntries)=0
#define err(fmt,...)
Definition message.h:127

References Definition::anchor(), ClassDef::compoundType(), Definition::displayName(), OutputList::endParagraph(), err, DString::find(), MemberDef::getClassDef(), Definition::getOutputFileBase(), Definition::getReference(), ClassDef::Interface, Definition::isLinkable(), Definition::isLinkableInProject(), DString::left(), DString::length(), DString::npos, OutputList::parseText(), reimplements(), DString::right(), OutputList::startParagraph(), theTranslator, Translator::trImplementedFromList(), Translator::trReimplementedFromList(), MemberDef::virtualness(), OutputList::writeObjectLink(), and writePageRef().

Referenced by writeDocumentation().

◆ _writeTagData()

void MemberDefImpl::_writeTagData ( const DefType ) const
private

◆ _writeTemplatePrefix()

void MemberDefImpl::_writeTemplatePrefix ( OutputList & ol,
const Definition * def,
const ArgumentList & al,
bool writeReqClause = true ) const
private

Definition at line 2185 of file memberdef.cpp.

2187{
2188 ol.docify("template<");
2189 LinkifyTextOptions options;
2190 options.setScope(def).setFileScope(getFileDef()).setSelf(this);
2191 for (auto it = al.begin(); it!=al.end();)
2192 {
2193 Argument a = *it;
2194 linkifyText(TextGeneratorOLImpl(ol),a.type,options);
2195 if (!a.name.empty())
2196 {
2197 ol.docify(" ");
2198 ol.docify(a.name);
2199 }
2200 if (!a.defval.empty())
2201 {
2202 ol.docify(" = ");
2203 ol.docify(a.defval);
2204 }
2205 ++it;
2206 if (it!=al.end()) ol.docify(", ");
2207 }
2208 ol.docify("> ");
2209 if (writeReqClause && !m_requiresClause.empty())
2210 {
2211 ol.lineBreak();
2212 ol.docify("requires ");
2213 linkifyText(TextGeneratorOLImpl(ol), // out
2214 m_requiresClause, // text
2215 LinkifyTextOptions(options).setAutoBreak(true).setBreakThreshold(120));
2216 }
2217}
DString defval
Definition arguments.h:47
DString name
Definition arguments.h:45
DString type
Definition arguments.h:43
iterator end()
Definition arguments.h:95
iterator begin()
Definition arguments.h:94
DString m_requiresClause
void lineBreak(const DString &style=DString())
Definition outputlist.h:555
void linkifyText(const TextGeneratorIntf &out, const DString &text, const LinkifyTextOptions &options)
LinkifyTextOptions & setScope(const Definition *scope)
Definition linkifytext.h:60
LinkifyTextOptions & setSelf(const Definition *self)
Definition linkifytext.h:66
LinkifyTextOptions & setFileScope(const FileDef *fileScope)
Definition linkifytext.h:63

References ArgumentList::begin(), Argument::defval, OutputList::docify(), DString::empty(), ArgumentList::end(), getFileDef(), OutputList::lineBreak(), linkifyText(), m_requiresClause, Argument::name, LinkifyTextOptions::setFileScope(), LinkifyTextOptions::setScope(), LinkifyTextOptions::setSelf(), and Argument::type.

Referenced by writeDeclaration(), and writeDocumentation().

◆ _writeTypeConstraints()

void MemberDefImpl::_writeTypeConstraints ( OutputList & ol) const
private

Definition at line 3177 of file memberdef.cpp.

3178{
3180 {
3182 }
3183}
bool hasParameters() const
Definition arguments.h:77
ArgumentList m_typeConstraints
void writeTypeConstraints(OutputList &ol, const Definition *d, const ArgumentList &al)
Definition util.cpp:4292

References ArgumentList::hasParameters(), m_typeConstraints, and writeTypeConstraints().

Referenced by writeDocumentation().

◆ addExample()

bool MemberDefImpl::addExample ( const DString & anchor,
const DString & name,
const DString & file )
overridevirtual

Implements MemberDefMutable.

Definition at line 1672 of file memberdef.cpp.

1673{
1674 //printf("%s::addExample(%s,%s,%s)\n",qPrint(name()),anchor,nameStr,file);
1675 return m_examples.inSort(Example(anchor,nameStr,file));
1676}
bool inSort(const Example &ex)
Definition example.h:39
DString anchor() const override

References anchor(), ExampleList::inSort(), and m_examples.

◆ addListReference()

void MemberDefImpl::addListReference ( const Definition * )
overridevirtual

Implements MemberDefMutable.

Definition at line 4590 of file memberdef.cpp.

4591{
4592 bool optimizeOutputForC = Config_getBool(OPTIMIZE_OUTPUT_FOR_C);
4593 SrcLangExt lang = getLanguage();
4594 if (!isLinkableInProject()) return;
4595 DString memLabel;
4596 if (optimizeOutputForC)
4597 {
4598 memLabel=theTranslator->trGlobal(true,true);
4599 }
4600 else if (lang==SrcLangExt::Fortran)
4601 {
4602 memLabel=theTranslator->trSubprogram(true,true);
4603 }
4604 else
4605 {
4606 memLabel=theTranslator->trMember(true,true);
4607 }
4608 DString memName = name();
4609 Definition *pd=getOuterScope();
4610 DString pdName = pd->definitionType()==Definition::TypeClass ?
4611 (toClassDef(pd))->displayName() : pd->name();
4612 DString sep = getLanguageSpecificSeparator(lang,true);
4613 DString memArgs;
4614 if (!isRelated())
4615 {
4616 if (isObjCMethod())
4617 {
4618 memName = "[" + pd->name() + " " + name() + "]";
4619 }
4620 else
4621 {
4622 if (pd!=Doxygen::globalScope) memName.prepend(pdName+sep);
4623 memArgs = argsString();
4624 }
4625 }
4626 const RefItemVector &xrefItems = xrefListItems();
4627 if (sep!="::")
4628 {
4629 memName = substitute(memName,"::",sep);
4630 }
4631 addRefItem(xrefItems,
4632 qualifiedName()+argsString(), // argsString is needed for overloaded functions (see bug 609624)
4633 memLabel,
4634 getOutputFileBase()+"#"+anchor(),memName,memArgs,pd);
4635}
DString & prepend(const char *s)
Definition dstring.h:515
virtual DefType definitionType() const =0
const RefItemVector & xrefListItems() const override
static NamespaceDefMutable * globalScope
Definition doxygen.h:114
bool isObjCMethod() const override
bool isLinkableInProject() const override
bool isRelated() const override
DString argsString() const override
DString displayName(bool=true) const override
DString getOutputFileBase() const override
virtual DString trSubprogram(bool first_capital, bool singular)=0
virtual DString trMember(bool first_capital, bool singular)=0
virtual DString trGlobal(bool first_capital, bool singular)=0
ClassDef * toClassDef(Definition *d)
DString substitute(const DString &s, const DString &src, const DString &dst)
substitute all occurrences of src in s by dst
Definition dstring.cpp:485
void addRefItem(const RefItemVector &sli, const DString &key, const DString &prefix, const DString &name, const DString &title, const DString &args, const Definition *scope)
Definition reflist.h:136
std::vector< RefItem * > RefItemVector
Definition reflist.h:134
DString getLanguageSpecificSeparator(SrcLangExt lang, bool classScope)
Definition util.cpp:4642

References addRefItem(), anchor(), argsString(), Config_getBool, Definition::definitionType(), displayName(), DefinitionMixin< MemberDefMutable >::getLanguage(), getLanguageSpecificSeparator(), DefinitionMixin< MemberDefMutable >::getOuterScope(), getOutputFileBase(), Doxygen::globalScope, isLinkableInProject(), isObjCMethod(), isRelated(), Definition::name(), DefinitionMixin< MemberDefMutable >::name(), DString::prepend(), qualifiedName(), substitute(), theTranslator, toClassDef(), Translator::trGlobal(), Translator::trMember(), Translator::trSubprogram(), Definition::TypeClass, and DefinitionMixin< MemberDefMutable >::xrefListItems().

◆ addQualifiers()

void MemberDefImpl::addQualifiers ( const StringVector & qualifiers)
overridevirtual

Implements MemberDefMutable.

Definition at line 5917 of file memberdef.cpp.

5918{
5919 for (const auto &sx : qualifiers)
5920 {
5921 bool alreadyAdded = std::find(m_qualifiers.begin(), m_qualifiers.end(), sx) != m_qualifiers.end();
5922 if (!alreadyAdded)
5923 {
5924 m_qualifiers.push_back(sx);
5925 }
5926 }
5927}
StringVector m_qualifiers

References m_qualifiers.

◆ addRequirementReferences()

void MemberDefImpl::addRequirementReferences ( const Definition * )
overridevirtual

Implements MemberDefMutable.

Definition at line 4637 of file memberdef.cpp.

4638{
4640}
static RequirementManager & instance()
void addRequirementRefsForSymbol(const Definition *symbol)

References RequirementManager::addRequirementRefsForSymbol(), and RequirementManager::instance().

◆ anchor()

DString MemberDefImpl::anchor ( ) const
overridevirtual

Returns the anchor within a page where this item can be found

Implements Definition.

Definition at line 1814 of file memberdef.cpp.

1815{
1816 DString result=m_anc;
1817 if (m_groupAlias) return m_groupAlias->anchor();
1820 if (m_enumScope && m_enumScope!=this) // avoid recursion for C#'s public enum E { E, F }
1821 {
1822 result.prepend(m_enumScope->anchor());
1823 }
1824 if (getGroupDef())
1825 {
1826 if (m_groupMember)
1827 {
1828 result=m_groupMember->anchor();
1829 }
1830 else if (getReference().empty())
1831 {
1832 result.prepend("g");
1833 }
1834 }
1835 return result;
1836}
DString getReference() const override
const MemberDef * m_enumScope
const MemberDef * m_groupAlias
const MemberDef * anonymousMemberForDetails() const override
const MemberDef * m_templateMaster
MemberDef * m_groupMember

References Definition::anchor(), anonymousMemberForDetails(), getGroupDef(), getReference(), m_anc, m_enumScope, m_groupAlias, m_groupMember, m_templateMaster, and DString::prepend().

Referenced by addExample(), addListReference(), getOutputFileBase(), writeDeclaration(), writeDocumentation(), writeLink(), writeMemberDocSimple(), and writeTagFile().

◆ anonymousMemberForDeclaration()

const MemberDef * MemberDefImpl::anonymousMemberForDeclaration ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5599 of file memberdef.cpp.

5600{
5601 return m_annMemberForDecl;
5602}
const MemberDef * m_annMemberForDecl

References m_annMemberForDecl.

◆ anonymousMemberForDetails()

const MemberDef * MemberDefImpl::anonymousMemberForDetails ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5604 of file memberdef.cpp.

5605{
5606 return m_annMemberForDetails;
5607}
const MemberDef * m_annMemberForDetails

References m_annMemberForDetails.

Referenced by anchor(), and getOutputFileBase().

◆ argsString()

DString MemberDefImpl::argsString ( ) const
overridevirtual

◆ argumentList()

const ArgumentList & MemberDefImpl::argumentList ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5664 of file memberdef.cpp.

5665{
5666 return m_defArgList;
5667}
ArgumentList m_defArgList

References m_defArgList.

Referenced by detectUndocumentedParams(), and warnIfUndocumentedParams().

◆ bitfieldString()

DString MemberDefImpl::bitfieldString ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5114 of file memberdef.cpp.

5115{
5116 return m_bitfields;
5117}

References m_bitfields.

◆ briefDescription()

DString MemberDefImpl::briefDescription ( bool abbreviate = false) const
overridevirtual

Returns the brief description of this definition. This can include commands.

Reimplemented from DefinitionMixin< MemberDefMutable >.

Definition at line 6454 of file memberdef.cpp.

6455{
6456 if (m_templateMaster)
6457 {
6458 return m_templateMaster->briefDescription(abbr);
6459 }
6460 else
6461 {
6463 }
6464}
DString briefDescription(bool abbreviate=false) const override

References Definition::briefDescription(), DefinitionMixin< Base >::briefDescription(), and m_templateMaster.

Referenced by findSectionsInDocumentation(), hasDetailedDescription(), writeDeclaration(), writeDocumentation(), and writeMemberDocSimple().

◆ cacheTypedefVal()

void MemberDefImpl::cacheTypedefVal ( const ClassDef * val,
const DString & templSpec,
const DString & resolvedType )
overridevirtual

Implements MemberDefMutable.

Definition at line 6130 of file memberdef.cpp.

6131{
6134 m_cachedTypedefTemplSpec=templSpec;
6135 m_cachedResolvedType=resolvedType;
6136 //printf("MemberDefImpl::cacheTypedefVal=%s m_impl=%p\n",qPrint(m_cachedResolvedType),m_impl);
6137}
DString m_cachedResolvedType
bool m_isTypedefValCached
const ClassDef * m_cachedTypedefValue
DString m_cachedTypedefTemplSpec

References m_cachedResolvedType, m_cachedTypedefTemplSpec, m_cachedTypedefValue, and m_isTypedefValCached.

◆ category()

ClassDef * MemberDefImpl::category ( ) const
overridevirtual

Implements MemberDef.

Definition at line 6090 of file memberdef.cpp.

6091{
6092 return m_category;
6093}

References m_category.

◆ categoryRelation()

const MemberDef * MemberDefImpl::categoryRelation ( ) const
overridevirtual

Implements MemberDef.

Definition at line 6100 of file memberdef.cpp.

6101{
6102 return m_categoryRelation;
6103}

References m_categoryRelation.

◆ codeSymbolType()

CodeSymbolType MemberDefImpl::codeSymbolType ( ) const
overridevirtual

Used for syntax highlighting symbol class

Implements Definition.

Definition at line 6541 of file memberdef.cpp.

6542{
6543 switch (memberType())
6544 {
6545 case MemberType::Define: return CodeSymbolType::Define;
6546 case MemberType::Function: return CodeSymbolType::Function;
6547 case MemberType::Variable: return CodeSymbolType::Variable;
6548 case MemberType::Typedef: return CodeSymbolType::Typedef;
6549 case MemberType::Enumeration: return CodeSymbolType::Enumeration;
6550 case MemberType::EnumValue: return CodeSymbolType::EnumValue;
6551 case MemberType::Signal: return CodeSymbolType::Signal;
6552 case MemberType::Slot: return CodeSymbolType::Slot;
6553 case MemberType::Friend: return CodeSymbolType::Friend;
6554 case MemberType::DCOP: return CodeSymbolType::DCOP;
6555 case MemberType::Property: return CodeSymbolType::Property;
6556 case MemberType::Event: return CodeSymbolType::Event;
6557 case MemberType::Interface: return CodeSymbolType::Interface;
6558 case MemberType::Service: return CodeSymbolType::Service;
6559 case MemberType::Sequence: return CodeSymbolType::Sequence;
6560 case MemberType::Dictionary: return CodeSymbolType::Dictionary;
6561 }
6563}
MemberType memberType() const override

References DCOP, Default, Define, Dictionary, Enumeration, EnumValue, Event, Friend, Function, Interface, memberType(), Property, Sequence, Service, Signal, Slot, Typedef, and Variable.

◆ copyArgumentNames()

void MemberDefImpl::copyArgumentNames ( const MemberDef * bmd)
overridevirtual

Implements MemberDefMutable.

Definition at line 6139 of file memberdef.cpp.

6140{
6141 {
6142 const ArgumentList &srcAl = bmd->argumentList();
6143 ArgumentList &dstAl = m_defArgList;
6144 auto srcIt = srcAl.begin();
6145 auto dstIt = dstAl.begin();
6146 while ( srcIt!=srcAl.end() && dstIt!=dstAl.end())
6147 {
6148 Argument &argDst = *dstIt;
6149 const Argument &argSrc = *srcIt;
6150 if (!argSrc.name.empty())
6151 {
6152 argDst.name = argSrc.name;
6153 }
6154 argDst.docs = argSrc.docs;
6155 ++srcIt;
6156 ++dstIt;
6157 }
6158 }
6159
6160 {
6161 const ArgumentList &srcAl = bmd->declArgumentList();
6162 ArgumentList &dstAl = m_declArgList;
6163 auto srcIt = srcAl.begin();
6164 auto dstIt = dstAl.begin();
6165
6166 while ( srcIt!=srcAl.end() && dstIt!=dstAl.end())
6167 {
6168 Argument &argDst = *dstIt;
6169 const Argument &argSrc = *srcIt;
6170 if (!argSrc.name.empty())
6171 {
6172 argDst.name = argSrc.name;
6173 }
6174 argDst.docs = argSrc.docs;
6175 ++srcIt;
6176 ++dstIt;
6177 }
6178 }
6179}
DString docs
Definition arguments.h:48
virtual const ArgumentList & argumentList() const =0
virtual const ArgumentList & declArgumentList() const =0
ArgumentList m_declArgList

References MemberDef::argumentList(), ArgumentList::begin(), MemberDef::declArgumentList(), Argument::docs, DString::empty(), ArgumentList::end(), m_declArgList, m_defArgList, and Argument::name.

◆ createTemplateInstanceMember()

std::unique_ptr< MemberDef > MemberDefImpl::createTemplateInstanceMember ( const ArgumentList & formalArgs,
const std::unique_ptr< ArgumentList > & actualArgs ) const
overridevirtual

Implements MemberDef.

Definition at line 4511 of file memberdef.cpp.

4513{
4514 //printf(" Member %s %s %s\n",qPrint(typeString()),qPrint(name()),qPrint(argsString()));
4515 std::unique_ptr<ArgumentList> actualArgList = std::make_unique<ArgumentList>(m_defArgList);
4516 if (!m_defArgList.empty())
4517 {
4518 // replace formal arguments with actuals
4519 for (Argument &arg : *actualArgList)
4520 {
4521 arg.type = substituteTemplateArgumentsInString(arg.type,formalArgs,actualArgs.get());
4522 }
4523 actualArgList->setTrailingReturnType(
4524 substituteTemplateArgumentsInString(actualArgList->trailingReturnType(),formalArgs,actualArgs.get()));
4525 }
4526
4527 DString methodName=name();
4528 if (methodName.startsWith("operator ")) // conversion operator
4529 {
4530 methodName=substituteTemplateArgumentsInString(methodName,formalArgs,actualArgs.get());
4531 }
4532
4533 auto imd = createMemberDef(
4535 substituteTemplateArgumentsInString(m_type,formalArgs,actualArgs.get()),
4536 methodName,
4537 substituteTemplateArgumentsInString(m_args,formalArgs,actualArgs.get()),
4540 ArgumentList(), ArgumentList(), ""
4541 );
4542 auto mmd = toMemberDefMutable(imd.get());
4543 mmd->moveArgumentList(std::move(actualArgList));
4544 mmd->setDefinition(substituteTemplateArgumentsInString(m_def,formalArgs,actualArgs.get()));
4545 mmd->setBodyDef(getBodyDef());
4546 mmd->setBodySegment(getDefLine(),getStartBodyLine(),getEndBodyLine());
4547 mmd->setFormalTemplateArguments(formalArgs);
4548
4549 // TODO: init other member variables (if needed).
4550 // TODO: reimplemented info
4551 return imd;
4552}
bool empty() const
Definition arguments.h:100
size_t getDefColumn() const override
DString getDefFileName() const override
const FileDef * getBodyDef() const override
DString m_exception
Relationship m_related
std::unique_ptr< MemberDef > createMemberDef(const DString &defFileName, int defLine, size_t defColumn, const DString &type, const DString &name, const DString &args, const DString &excp, Protection prot, Specifier virt, bool stat, Relationship related, MemberType t, const ArgumentList &tal, const ArgumentList &al, const DString &metaData)
Factory method to create a new instance of a MemberDef.
MemberDefMutable * toMemberDefMutable(Definition *d)
DString substituteTemplateArgumentsInString(const DString &nm, const ArgumentList &formalArgs, const ArgumentList *actualArgs)
Definition util.cpp:3533

References createMemberDef(), ArgumentList::empty(), DefinitionMixin< MemberDefMutable >::getBodyDef(), DefinitionMixin< MemberDefMutable >::getDefColumn(), DefinitionMixin< MemberDefMutable >::getDefFileName(), DefinitionMixin< MemberDefMutable >::getDefLine(), DefinitionMixin< MemberDefMutable >::getEndBodyLine(), DefinitionMixin< MemberDefMutable >::getStartBodyLine(), m_args, m_def, m_defArgList, m_exception, m_mtype, m_prot, m_related, m_stat, m_type, m_virt, DefinitionMixin< MemberDefMutable >::name(), DString::startsWith(), substituteTemplateArgumentsInString(), and toMemberDefMutable().

◆ declaration()

DString MemberDefImpl::declaration ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5084 of file memberdef.cpp.

5085{
5086 return m_decl;
5087}

References m_decl.

◆ declArgumentList()

const ArgumentList & MemberDefImpl::declArgumentList ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5669 of file memberdef.cpp.

5670{
5671 return m_declArgList;
5672}

References m_declArgList.

Referenced by detectUndocumentedParams(), and warnIfUndocumentedParams().

◆ deepCopy()

std::unique_ptr< MemberDef > MemberDefImpl::deepCopy ( ) const
overridevirtual

Implements MemberDef.

Definition at line 1490 of file memberdef.cpp.

1491{
1492 std::unique_ptr<MemberDefImpl> result(new MemberDefImpl(
1495 // first copy base members
1496 result->DefinitionMixin<MemberDefMutable>::operator=(*this);
1497 // then copy other members
1498 result->m_typeConstraints = m_typeConstraints ;
1499 result->m_declArgList = m_declArgList ;
1500 result->m_classDef = m_classDef ;
1501 result->m_fileDef = m_fileDef ;
1502 result->m_moduleDef = m_moduleDef ;
1503 result->m_nspace = m_nspace ;
1504 result->m_enumScope = m_enumScope ;
1505 result->m_livesInsideEnum = m_livesInsideEnum ;
1506 result->m_annEnumType = m_annEnumType ;
1507 result->m_annMemberForDecl = m_annMemberForDecl ;
1508 result->m_annMemberForDetails = m_annMemberForDetails ;
1509 result->m_enumFields = m_enumFields ;
1510 result->m_redefines = m_redefines ;
1511 result->m_redefinedBy = m_redefinedBy ;
1512 result->m_memDef = m_memDef ;
1513 result->m_memDec = m_memDec ;
1514 result->m_relatedAlso = m_relatedAlso ;
1515 result->m_examples = m_examples ;
1516 result->m_def = m_def ;
1517 result->m_anc = m_anc ;
1518 result->m_decl = m_decl ;
1519 result->m_bitfields = m_bitfields ;
1520 result->m_read = m_read ;
1521 result->m_write = m_write ;
1522 result->m_exception = m_exception ;
1523 result->m_initializer = m_initializer ;
1524 result->m_extraTypeChars = m_extraTypeChars ;
1525 result->m_enumBaseType = m_enumBaseType ;
1526 result->m_requiresClause = m_requiresClause ;
1527 result->m_initLines = m_initLines ;
1528 result->m_memSpec = m_memSpec ;
1529 result->m_vhdlSpec = m_vhdlSpec ;
1530 result->m_maxInitLines = m_maxInitLines ;
1531 result->m_userInitLines = m_userInitLines ;
1532 result->m_defArgList = m_defArgList ;
1533 result->m_declArgList = m_declArgList ;
1534 result->m_tArgList = m_tArgList ;
1535 result->m_typeConstraints = m_typeConstraints ;
1536 result->m_templateMaster = m_templateMaster ;
1537 result->m_formalTemplateArguments = m_formalTemplateArguments ;
1538 result->m_defTmpArgLists = m_defTmpArgLists ;
1539 result->m_anonymousType = m_anonymousType ;
1540 result->m_sectionMap = m_sectionMap ;
1541 result->m_groupAlias = m_groupAlias ;
1542 result->m_grpId = m_grpId ;
1543 result->m_memberGroup = m_memberGroup ;
1544 result->m_group = m_group ;
1545 result->m_grouppri = m_grouppri ;
1546 result->m_groupFileName = m_groupFileName ;
1547 result->m_groupStartLine = m_groupStartLine ;
1548 result->m_groupMember = m_groupMember ;
1549 result->m_isTypedefValCached = m_isTypedefValCached ;
1550 result->m_cachedTypedefValue = m_cachedTypedefValue ;
1551 result->m_cachedTypedefTemplSpec = m_cachedTypedefTemplSpec ;
1552 result->m_cachedResolvedType = m_cachedResolvedType ;
1553 result->m_docProvider = m_docProvider ;
1554 result->m_explicitOutputFileBase = m_explicitOutputFileBase ;
1555 result->m_qualifiers = m_qualifiers ;
1556 result->m_implOnly = m_implOnly ;
1557 result->m_hasDocumentedParams = m_hasDocumentedParams ;
1558 result->m_hasDocumentedReturnType = m_hasDocumentedReturnType ;
1559 result->m_isDMember = m_isDMember ;
1560 result->m_proto = m_proto ;
1561 result->m_docEnumValues = m_docEnumValues ;
1562 result->m_hasDetailedDescriptionCached = m_hasDetailedDescriptionCached ;
1563 result->m_detailedDescriptionCachedValue = m_detailedDescriptionCachedValue ;
1564 result->m_hasCallGraph = m_hasCallGraph ;
1565 result->m_hasCallerGraph = m_hasCallerGraph ;
1566 result->m_hasReferencedByRelation = m_hasReferencedByRelation ;
1567 result->m_hasReferencesRelation = m_hasReferencesRelation ;
1568 result->m_hasEnumValues = m_hasEnumValues ;
1569 result->m_hasInlineSource = m_hasInlineSource ;
1570 result->m_explExt = m_explExt ;
1571 result->m_tspec = m_tspec ;
1572 result->m_groupHasDocs = m_groupHasDocs ;
1573 result->m_docsForDefinition = m_docsForDefinition ;
1574 result->m_category = m_category ;
1575 result->m_categoryRelation = m_categoryRelation ;
1576 result->m_declFileName = m_declFileName ;
1577 result->m_declLine = m_declLine ;
1578 result->m_declColumn = m_declColumn ;
1579 result->m_numberOfFlowKW = m_numberOfFlowKW ;
1580 result->setDefinitionTemplateParameterLists(m_defTmpArgLists);
1581 if (m_incInfo)
1582 {
1583 result->m_incInfo = std::make_unique<IncludeInfo>();
1584 *(result->m_incInfo) = *m_incInfo;
1585 }
1586
1587 result->m_isLinkableCached = 0;
1588 result->m_isConstructorCached = 0;
1589 result->m_isDestructorCached = 0;
1590 return result;
1591}
const DString & localName() const override
VhdlSpecifier m_vhdlSpec
bool m_detailedDescriptionCachedValue
ArgumentLists m_defTmpArgLists
bool m_hasReferencedByRelation
MemberDef * m_memDec
std::map< const Definition *, const MemberList * > m_sectionMap
bool m_hasDocumentedReturnType
DString m_groupFileName
size_t m_declColumn
DString m_enumBaseType
bool m_hasDocumentedParams
ModuleDef * m_moduleDef
bool m_hasReferencesRelation
bool m_hasInlineSource
NamespaceDef * m_nspace
bool m_docsForDefinition
DString m_write
std::optional< ArgumentList > m_formalTemplateArguments
MemberDef * m_redefines
const ClassDef * m_anonymousType
DString m_metaData
ClassDef * m_classDef
DString m_explicitOutputFileBase
MemberGroup * m_memberGroup
MemberVector m_redefinedBy
DString m_declFileName
DString m_extraTypeChars
GroupDef * m_group
TypeSpecifier m_memSpec
bool m_hasDetailedDescriptionCached
MemberDefImpl(const DString &defFileName, int defLine, size_t defColumn, const DString &type, const DString &name, const DString &args, const DString &excp, Protection prot, Specifier virt, bool stat, Relationship related, MemberType t, const ArgumentList &tal, const ArgumentList &al, const DString &metaData)
ClassDef * m_relatedAlso
const MemberDef * m_annEnumType
Grouping::GroupPri_t m_grouppri
MemberDef * m_memDef
bool m_livesInsideEnum
MemberVector m_enumFields
FileDef * m_fileDef
ArgumentList m_tArgList
const MemberDef * m_docProvider

References DefinitionMixin< MemberDefMutable >::getDefColumn(), DefinitionMixin< MemberDefMutable >::getDefFileName(), DefinitionMixin< MemberDefMutable >::getDefLine(), DefinitionMixin< MemberDefMutable >::localName(), m_anc, m_annEnumType, m_annMemberForDecl, m_annMemberForDetails, m_anonymousType, m_args, m_bitfields, m_cachedResolvedType, m_cachedTypedefTemplSpec, m_cachedTypedefValue, m_category, m_categoryRelation, m_classDef, m_decl, m_declArgList, m_declColumn, m_declFileName, m_declLine, m_def, m_defArgList, m_defTmpArgLists, m_detailedDescriptionCachedValue, m_docEnumValues, m_docProvider, m_docsForDefinition, m_enumBaseType, m_enumFields, m_enumScope, m_examples, m_exception, m_explExt, m_explicitOutputFileBase, m_extraTypeChars, m_fileDef, m_formalTemplateArguments, m_group, m_groupAlias, m_groupFileName, m_groupHasDocs, m_groupMember, m_grouppri, m_groupStartLine, m_grpId, m_hasCallerGraph, m_hasCallGraph, m_hasDetailedDescriptionCached, m_hasDocumentedParams, m_hasDocumentedReturnType, m_hasEnumValues, m_hasInlineSource, m_hasReferencedByRelation, m_hasReferencesRelation, m_implOnly, m_incInfo, m_initializer, m_initLines, m_isDMember, m_isTypedefValCached, m_livesInsideEnum, m_maxInitLines, m_memberGroup, m_memDec, m_memDef, m_memSpec, m_metaData, m_moduleDef, m_mtype, m_nspace, m_numberOfFlowKW, m_prot, m_proto, m_qualifiers, m_read, m_redefinedBy, m_redefines, m_related, m_relatedAlso, m_requiresClause, m_sectionMap, m_stat, m_tArgList, m_templateMaster, m_tspec, m_type, m_typeConstraints, m_userInitLines, m_vhdlSpec, m_virt, m_write, and MemberDefImpl().

◆ definition()

DString MemberDefImpl::definition ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5089 of file memberdef.cpp.

5090{
5091 return m_def;
5092}

References m_def.

Referenced by displayDefinition(), setAnchor(), and writeDocumentation().

◆ definitionTemplateParameterLists()

const ArgumentLists & MemberDefImpl::definitionTemplateParameterLists ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5727 of file memberdef.cpp.

5728{
5729 return m_defTmpArgLists;
5730}

References m_defTmpArgLists.

◆ definitionType()

DefType MemberDefImpl::definitionType ( ) const
inlineoverridevirtual

Use this for dynamic inspection of the type of the derived class

Implements Definition.

Definition at line 64 of file memberdef.cpp.

64{ return TypeMember; }

References definitionType(), and Definition::TypeMember.

Referenced by definitionType().

◆ detectUndocumentedParams()

void MemberDefImpl::detectUndocumentedParams ( bool hasParamCommand,
bool hasReturnCommand ) const
overridevirtual

Implements MemberDef.

Definition at line 4272 of file memberdef.cpp.

4273{
4274 //printf("%s:detectUndocumentedParams(%d,%d)\n",qPrint(name()),hasParamCommand,hasReturnCommand);
4275 bool isPython = getLanguage()==SrcLangExt::Python;
4276
4277 // this function is called while parsing the documentation. A member can have multiple
4278 // documentation blocks, which could be handled by multiple threads, hence this guard.
4279 std::lock_guard<std::mutex> lock(g_detectUndocumentedParamsMutex);
4280
4282 {
4283 //printf("%s:hasDocumentedParams=true;\n",qPrint(name()));
4284 m_hasDocumentedParams = true;
4285 }
4286 else if (!m_hasDocumentedParams)
4287 {
4288 const ArgumentList &al = argumentList();
4289 const ArgumentList &declAl = declArgumentList();
4290 bool allDoc=true; // no parameter => all parameters are documented
4291 if ( // member has parameters
4292 al.hasParameters() // with at least one parameter (that is not void)
4293 )
4294 {
4295 // see if all parameters have documentation
4296 for (auto it = al.begin(); it!=al.end() && allDoc; ++it)
4297 {
4298 const Argument &a = *it;
4299 if (!a.name.empty() && a.type!="void" && a.name!="..." &&
4300 !(isPython && (a.name=="self" || a.name=="cls"))
4301 )
4302 {
4303 allDoc = !a.docs.empty();
4304 }
4305 //printf("a.type=%s a.name=%s doc=%s\n",
4306 // qPrint(a.type),qPrint(a.name),qPrint(a.docs));
4307 }
4308 if (!allDoc && declAl.empty()) // try declaration arguments as well
4309 {
4310 allDoc=true;
4311 for (auto it = al.begin(); it!=al.end() && allDoc; ++it)
4312 {
4313 const Argument &a = *it;
4314 if (!a.name.empty() && a.type!="void" && a.name!="..." &&
4315 !(isPython && (a.name=="self" || a.name=="cls"))
4316 )
4317 {
4318 allDoc = !a.docs.empty();
4319 }
4320 //printf("a.name=%s doc=%s\n",qPrint(a.name),qPrint(a.docs));
4321 }
4322 }
4323 }
4324 if (allDoc)
4325 {
4326 //printf("%s:hasDocumentedParams=true;\n",qPrint(name()));
4327 m_hasDocumentedParams = true;
4328 }
4329 }
4330
4331 //printf("Member %s hasDocumentedReturnType=%d hasReturnCommand=%d\n",
4332 // qPrint(name()),m_hasDocumentedReturnType,hasReturnCommand);
4334}
const ArgumentList & argumentList() const override
const ArgumentList & declArgumentList() const override
static std::mutex g_detectUndocumentedParamsMutex
static bool hasParamCommand(const DString &doc)

References argumentList(), ArgumentList::begin(), declArgumentList(), Argument::docs, ArgumentList::empty(), DString::empty(), ArgumentList::end(), g_detectUndocumentedParamsMutex, DefinitionMixin< MemberDefMutable >::getLanguage(), hasParamCommand(), ArgumentList::hasParameters(), m_hasDocumentedParams, m_hasDocumentedReturnType, Argument::name, and Argument::type.

◆ displayDefinition()

DString MemberDefImpl::displayDefinition ( ) const
overridevirtual

Implements MemberDef.

Definition at line 3289 of file memberdef.cpp.

3290{
3291 DString ldef = definition();
3292 DString title = name();
3293 if (isEnumerate())
3294 {
3295 if (isAnonymous())
3296 {
3297 ldef = title = "anonymous enum";
3298 if (!m_enumBaseType.empty())
3299 {
3300 ldef+=" : "+m_enumBaseType;
3301 }
3302 }
3303 else
3304 {
3305 ldef.prepend("enum ");
3306 if (isSliceLocal())
3307 {
3308 ldef.prepend("local ");
3309 }
3310 }
3311 }
3312 else if (isEnumValue())
3313 {
3314 if (isAnonymous())
3315 {
3316 ldef=ldef.mid(2);
3317 }
3318 }
3319
3320 std::string sdef = ldef.str();
3321 reg::Match match;
3322 if (reg::search(sdef,match,reAnonymous))
3323 {
3324 const ClassDef *annoClassDef=getClassDefOfAnonymousType();
3325 if (annoClassDef)
3326 {
3327 static const reg::Ex ar(R"([\w@:]*@\d+[\w@:]*)");
3328 reg::Match amatch;
3329 reg::search(sdef,amatch,ar);
3330 ldef = amatch.prefix().str() + annoClassDef->displayName() + amatch.suffix().str();
3331 }
3332 else
3333 {
3334 ldef = match.prefix().str() + " { ... } " + removeAnonymousScopes(match.suffix().str());
3335 }
3336 }
3337
3338 const ClassDef *cd=getClassDef();
3339 if (cd && cd->isObjectiveC())
3340 {
3341 // strip scope name
3342 if (size_t ep = ldef.find("::"); ep!=DString::npos)
3343 {
3344 if (size_t sp=ldef.rfind(' ',ep); sp!=DString::npos)
3345 {
3346 ldef=ldef.left(sp+1)+ldef.mid(ep+2);
3347 }
3348 }
3349 // strip keywords
3350 if (size_t dp = ldef.find(':'); dp!=DString::npos)
3351 {
3352 ldef=ldef.left(dp+1);
3353 }
3354 int l=static_cast<int>(ldef.length());
3355 //printf("start >%s<\n",qPrint(ldef));
3356 int i=l-1;
3357 while (i>=0 && (isId(ldef.at(i)) || ldef.at(i)==':')) i--;
3358 while (i>=0 && isspace(static_cast<uint8_t>(ldef.at(i)))) i--;
3359 if (i>0)
3360 {
3361 // insert branches around the type
3362 ldef = "("+ldef.left(i+1)+")"+ldef.mid(i+1);
3363 }
3364 //printf("end >%s< i=%d\n",qPrint(ldef),i);
3365 if (isStatic()) ldef.prepend("+ "); else ldef.prepend("- ");
3366 }
3367 SrcLangExt lang = getLanguage();
3368 DString sep = getLanguageSpecificSeparator(lang,true);
3369 return substitute(ldef,"::",sep);
3370}
virtual bool isObjectiveC() const =0
Returns true if this class is implemented in Objective-C.
size_t rfind(char c, size_t pos=npos) const
Definition dstring.h:244
char & at(size_t i)
Returns a reference to the character at index i.
Definition dstring.h:686
bool isSliceLocal() const override
DString definition() const override
bool isEnumValue() const override
bool isStatic() const override
const ClassDef * getClassDefOfAnonymousType() const override
SubMatch prefix() const
Return the part of the string before the match.
Definition regex.h:175
SubMatch suffix() const
Return the part of the string after the match.
Definition regex.h:178
std::string str() const
Returns the matching part as a string.
Definition regex.h:138
bool isId(char c)
Returns true if c is a valid character for an identifier.
Definition dstring.h:895
static const reg::Ex reAnonymous(R"([\w:@]*@\d+)")
bool search(std::string_view str, Match &match, const Ex &re, size_t pos)
Search in a given string str starting at position pos for a match against regular expression re.
Definition regex.cpp:850
bool match(std::string_view str, Match &match, const Ex &re)
Matches a given string str for a match against regular expression re.
Definition regex.cpp:861
DString removeAnonymousScopes(const DString &str)
Definition util.cpp:98

References DString::at(), definition(), Definition::displayName(), DString::empty(), DString::find(), getClassDef(), getClassDefOfAnonymousType(), DefinitionMixin< MemberDefMutable >::getLanguage(), getLanguageSpecificSeparator(), DefinitionMixin< MemberDefMutable >::isAnonymous(), isEnumerate(), isEnumValue(), isId(), ClassDef::isObjectiveC(), isSliceLocal(), isStatic(), DString::left(), DString::length(), m_enumBaseType, DString::mid(), DefinitionMixin< MemberDefMutable >::name(), DString::npos, reg::Match::prefix(), DString::prepend(), reAnonymous, removeAnonymousScopes(), DString::rfind(), reg::search(), DString::str(), reg::SubMatch::str(), substitute(), and reg::Match::suffix().

◆ displayName()

DString MemberDefImpl::displayName ( bool includeScope = true) const
overridevirtual

Returns the name of the definition as it appears in the output

Implements Definition.

Definition at line 6207 of file memberdef.cpp.

6208{
6209 return DefinitionMixin::name();
6210}

References DefinitionMixin< Base >::name().

Referenced by addListReference(), and writeDocumentation().

◆ documentation()

DString MemberDefImpl::documentation ( ) const
overridevirtual

Returns the detailed description of this definition

Reimplemented from DefinitionMixin< MemberDefMutable >.

Definition at line 6466 of file memberdef.cpp.

6467{
6468 if (m_templateMaster)
6469 {
6471 }
6472 else
6473 {
6475 }
6476}
DString documentation() const override

References Definition::documentation(), DefinitionMixin< Base >::documentation(), and m_templateMaster.

Referenced by findSectionsInDocumentation(), hasDetailedDescription(), isBriefSectionVisible(), writeDocumentation(), and writeMemberDocSimple().

◆ enumBaseType()

DString MemberDefImpl::enumBaseType ( ) const
overridevirtual

Implements MemberDef.

Definition at line 6115 of file memberdef.cpp.

6116{
6117 return m_enumBaseType;
6118}

References m_enumBaseType.

◆ enumFieldList()

const MemberVector & MemberDefImpl::enumFieldList ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5649 of file memberdef.cpp.

5650{
5651 return m_enumFields;
5652}

References m_enumFields.

Referenced by _writeEnumValues(), and warnIfUndocumented().

◆ excpString()

DString MemberDefImpl::excpString ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5109 of file memberdef.cpp.

5110{
5111 return m_exception;
5112}

References m_exception.

Referenced by writeDeclaration(), and writeDocumentation().

◆ extraTypeChars()

DString MemberDefImpl::extraTypeChars ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5094 of file memberdef.cpp.

5095{
5096 return m_extraTypeChars;
5097}

References m_extraTypeChars.

◆ fieldType()

DString MemberDefImpl::fieldType ( ) const
overridevirtual

Implements MemberDef.

Definition at line 4045 of file memberdef.cpp.

4046{
4047 DString type = m_type;
4048 if (isTypedef() && getLanguage() != SrcLangExt::Slice) type.prepend("typedef ");
4049 return simplifyTypeForTable(type);
4050}
bool isTypedef() const override
static DString simplifyTypeForTable(const DString &s)

References DefinitionMixin< MemberDefMutable >::getLanguage(), isTypedef(), m_type, DString::prepend(), and simplifyTypeForTable().

Referenced by writeMemberDocSimple().

◆ findSectionsInDocumentation()

void MemberDefImpl::findSectionsInDocumentation ( )
overridevirtual

Implements MemberDefMutable.

Definition at line 4973 of file memberdef.cpp.

4974{
4978}
DString docFile() const override
DString inbodyDocumentation() const override
DString documentation() const override
DString briefDescription(bool abbr=false) const override
void docFindSections(const DString &input, const Definition *d, const DString &fileName)

References briefDescription(), DefinitionMixin< MemberDefMutable >::docFile(), docFindSections(), documentation(), and DefinitionMixin< MemberDefMutable >::inbodyDocumentation().

◆ formalTemplateArguments()

std::optional< ArgumentList > MemberDefImpl::formalTemplateArguments ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5803 of file memberdef.cpp.

5804{
5806}

References m_formalTemplateArguments.

◆ getAnonymousEnumType()

const MemberDef * MemberDefImpl::getAnonymousEnumType ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5594 of file memberdef.cpp.

5595{
5596 return m_annEnumType;
5597}

References m_annEnumType.

Referenced by writeDeclaration(), and writeDocumentation().

◆ getCachedResolvedTypedef()

DString MemberDefImpl::getCachedResolvedTypedef ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5823 of file memberdef.cpp.

5824{
5825 //printf("MemberDefImpl::getCachedResolvedTypedef()=%s\n",qPrint(m_cachedResolvedType));
5826 return m_cachedResolvedType;
5827}

References m_cachedResolvedType.

◆ getCachedTypedefTemplSpec()

DString MemberDefImpl::getCachedTypedefTemplSpec ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5818 of file memberdef.cpp.

5819{
5821}

References m_cachedTypedefTemplSpec.

◆ getCachedTypedefVal()

const ClassDef * MemberDefImpl::getCachedTypedefVal ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5813 of file memberdef.cpp.

5814{
5815 return m_cachedTypedefValue;
5816}

References m_cachedTypedefValue.

◆ getClassDef() [1/2]

◆ getClassDef() [2/2]

ClassDef * MemberDefImpl::getClassDef ( )
overridevirtual

Implements MemberDef.

Definition at line 5149 of file memberdef.cpp.

5150{
5151 return m_classDef;
5152}

References m_classDef.

◆ getClassDefMutable()

ClassDefMutable * MemberDefImpl::getClassDefMutable ( )
overridevirtual

Implements MemberDefMutable.

Definition at line 5154 of file memberdef.cpp.

5155{
5157}
ClassDefMutable * toClassDefMutable(Definition *d)

References m_classDef, and toClassDefMutable().

◆ getClassDefOfAnonymousType()

const ClassDef * MemberDefImpl::getClassDefOfAnonymousType ( ) const
overridevirtual

If this member has an anonymous class/struct/union as its type, then this method will return the ClassDef that describes this return type.

Implements MemberDef.

Definition at line 2041 of file memberdef.cpp.

2042{
2043 return m_anonymousType;
2044}

References m_anonymousType.

Referenced by displayDefinition(), writeDeclaration(), writeDocumentation(), and writeMemberDocSimple().

◆ getDeclColumn()

size_t MemberDefImpl::getDeclColumn ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5859 of file memberdef.cpp.

5860{
5861 return m_declColumn;
5862}

References m_declColumn.

◆ getDeclFileName()

DString MemberDefImpl::getDeclFileName ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5849 of file memberdef.cpp.

5850{
5851 return m_declFileName;
5852}

References m_declFileName.

◆ getDeclLine()

int MemberDefImpl::getDeclLine ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5854 of file memberdef.cpp.

5855{
5856 return m_declLine;
5857}

References m_declLine.

◆ getDeclType()

DString MemberDefImpl::getDeclType ( ) const
overridevirtual

Implements MemberDef.

Definition at line 2138 of file memberdef.cpp.

2139{
2140 SrcLangExt lang = getLanguage();
2141 DString ltype(m_type);
2142 if (lang==SrcLangExt::Cpp && isEnumerate() && isStrong())
2143 {
2144 if (isEnumStruct())
2145 {
2146 ltype+=" struct";
2147 }
2148 else
2149 {
2150 ltype+=" class";
2151 }
2152 }
2153 if (isTypedef() && getLanguage() != SrcLangExt::Slice)
2154 {
2155 ltype.prepend("typedef ");
2156 }
2157 if (isTypeAlias())
2158 {
2159 if (lang==SrcLangExt::Python)
2160 {
2161 ltype="type";
2162 }
2163 else
2164 {
2165 ltype="using";
2166 }
2167 }
2168 // strip 'friend' keyword from ltype
2169 ltype.stripPrefix("friend ");
2170 if (ltype=="@") // rename type from enum values
2171 {
2172 ltype="";
2173 }
2174 else
2175 {
2176 if (isObjCMethod())
2177 {
2178 ltype.prepend("(");
2179 ltype.append(")");
2180 }
2181 }
2182 return ltype;
2183}
bool isStrong() const override
bool isTypeAlias() const override
bool isEnumStruct() const override

References DString::append(), DefinitionMixin< MemberDefMutable >::getLanguage(), isEnumerate(), isEnumStruct(), isObjCMethod(), isStrong(), isTypeAlias(), isTypedef(), m_type, DString::prepend(), and DString::stripPrefix().

◆ getEnumScope()

const MemberDef * MemberDefImpl::getEnumScope ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5614 of file memberdef.cpp.

5615{
5616 return m_enumScope;
5617}

References m_enumScope.

Referenced by getOutputFileBase(), and writeLink().

◆ getExamples()

const ExampleList & MemberDefImpl::getExamples ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5654 of file memberdef.cpp.

5655{
5656 return m_examples;
5657}

References m_examples.

◆ getFileDef() [1/2]

◆ getFileDef() [2/2]

FileDef * MemberDefImpl::getFileDef ( )
overridevirtual

Implements MemberDef.

Definition at line 5164 of file memberdef.cpp.

5165{
5166 return m_fileDef;
5167}

References m_fileDef.

◆ getGroupAlias()

const MemberDef * MemberDefImpl::getGroupAlias ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5844 of file memberdef.cpp.

5845{
5846 return m_groupAlias;
5847}

References m_groupAlias.

◆ getGroupDef() [1/2]

const GroupDef * MemberDefImpl::getGroupDef ( ) const
overridevirtual

◆ getGroupDef() [2/2]

GroupDef * MemberDefImpl::getGroupDef ( )
overridevirtual

Implements MemberDef.

Definition at line 5194 of file memberdef.cpp.

5195{
5196 return m_group;
5197}

References m_group.

◆ getGroupFileName()

DString MemberDefImpl::getGroupFileName ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5209 of file memberdef.cpp.

5210{
5211 return m_groupFileName;
5212}

References m_groupFileName.

◆ getGroupHasDocs()

bool MemberDefImpl::getGroupHasDocs ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5219 of file memberdef.cpp.

5220{
5221 return m_groupHasDocs;
5222}

References m_groupHasDocs.

◆ getGroupPri()

Grouping::GroupPri_t MemberDefImpl::getGroupPri ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5204 of file memberdef.cpp.

5205{
5206 return m_grouppri;
5207}

References m_grouppri.

◆ getGroupStartLine()

int MemberDefImpl::getGroupStartLine ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5214 of file memberdef.cpp.

5215{
5216 return m_groupStartLine;
5217}

References m_groupStartLine.

◆ getLabels()

StringVector MemberDefImpl::getLabels ( const Definition * container) const
overridevirtual

Implements MemberDef.

Definition at line 2781 of file memberdef.cpp.

2782{
2783 StringVector sl;
2784 bool inlineInfo = Config_getBool(INLINE_INFO);
2785 bool inherited = getClassDef() &&
2786 (getClassDef()!=container || m_explicitInherited) &&
2787 container->definitionType()==TypeClass &&
2788 !isRelated();
2789 Specifier lvirt=virtualness();
2790 if ((!isObjCMethod() || isOptional() || isRequired()) &&
2791 (protection()!=Protection::Public || lvirt!=Specifier::Normal ||
2792 isFriend() || isRelated() ||
2793 (isInline() && inlineInfo) ||
2794 isSignal() || isSlot() ||
2795 isStatic() || isExternal() ||
2796 isExported() ||
2797 inherited ||
2798 TypeSpecifier(m_memSpec).setInline(false)!=TypeSpecifier()
2799 )
2800 )
2801 {
2802 // write the member specifier list
2803 //ol.writeLatexSpacing();
2804 //ol.startTypewriter();
2805 //ol.docify(" [");
2806 SrcLangExt lang = getLanguage();
2807 bool optVhdl = lang==SrcLangExt::VHDL;
2808 bool extractPrivate = Config_getBool(EXTRACT_PRIVATE);
2809 if (optVhdl)
2810 {
2811 sl.push_back(theTranslator->trVhdlType(getVhdlSpecifiers(),true).str());
2812 }
2813 else
2814 {
2815 if (isFriend()) sl.emplace_back("friend");
2816 else if (isRelated()) sl.emplace_back("related");
2817 else
2818 {
2819 if (isExternal()) sl.emplace_back("extern");
2820 if (inlineInfo && isInline()) sl.emplace_back("inline");
2821 if (isExplicit()) sl.emplace_back("explicit");
2822 if (isMutable()) sl.emplace_back("mutable");
2823 if (isThreadLocal()) sl.emplace_back("thread_local");
2824 if (isStatic()) sl.emplace_back("static");
2825 if (isGettable()) sl.emplace_back("get");
2826 if (isProtectedGettable()) sl.emplace_back("protected get");
2827 if (isSettable()) sl.emplace_back("set");
2828 if (isProtectedSettable()) sl.emplace_back("protected set");
2829 if (isProperty() && isInitonly()) sl.emplace_back("init");
2830 if (extractPrivate)
2831 {
2832 if (isPrivateGettable()) sl.emplace_back("private get");
2833 if (isPrivateSettable()) sl.emplace_back("private set");
2834 }
2835 if (isNoDiscard()) sl.emplace_back("nodiscard");
2836 if (isConstExpr()) sl.emplace_back("constexpr");
2837 if (isConstEval()) sl.emplace_back("consteval");
2838 if (isConstInit()) sl.emplace_back("constinit");
2839 if (isAddable()) sl.emplace_back("add");
2840 if (!isUNOProperty() && isRemovable()) sl.emplace_back("remove");
2841 if (isRaisable()) sl.emplace_back("raise");
2842 if (isReadable()) sl.emplace_back("read");
2843 if (isWritable()) sl.emplace_back("write");
2844 if (isFinal()) sl.emplace_back("final");
2845 if (isAbstract()) sl.emplace_back("abstract");
2846 if (isOverride()) sl.emplace_back("override");
2847 if (!isProperty() && isInitonly()) sl.emplace_back("initonly");
2848 if (isSealed()) sl.emplace_back("sealed");
2849 if (isNew()) sl.emplace_back("new");
2850 if (isOptional()) sl.emplace_back("optional");
2851 if (isRequired()) sl.emplace_back("required");
2852 if (isExported()) sl.emplace_back("export");
2853
2854 if (isNonAtomic()) sl.emplace_back("nonatomic");
2855 else if (isObjCProperty()) sl.emplace_back("atomic");
2856
2857 // mutual exclusive Objective 2.0 property attributes
2858 if (isAssign()) sl.emplace_back("assign");
2859 else if (isCopy()) sl.emplace_back("copy");
2860 else if (isRetain()) sl.emplace_back("retain");
2861 else if (isWeak()) sl.emplace_back("weak");
2862 else if (lang!=SrcLangExt::CSharp && isStrong()) sl.emplace_back("strong");
2863 else if (isUnretained()) sl.emplace_back("unsafe_unretained");
2864
2865 if (!isObjCMethod())
2866 {
2867 if (protection()==Protection::Protected) sl.emplace_back("protected");
2868 else if (protection()==Protection::Private) sl.emplace_back("private");
2869 else if (protection()==Protection::Package) sl.emplace_back("package");
2870
2871 if (lvirt==Specifier::Virtual) sl.emplace_back("virtual");
2872 else if (lvirt==Specifier::Pure) sl.emplace_back("pure virtual");
2873 if (isSignal()) sl.emplace_back("signal");
2874 if (isSlot()) sl.emplace_back("slot");
2875 if (isDefault()) sl.emplace_back("default");
2876 if (isDelete()) sl.emplace_back("delete");
2877 if (isNoExcept()) sl.emplace_back("noexcept");
2878 if (isAttribute()) sl.emplace_back("attribute");
2879 if (isUNOProperty()) sl.emplace_back("property");
2880 if (isReadonly()) sl.emplace_back("readonly");
2881 if (isBound()) sl.emplace_back("bound");
2882 if (isUNOProperty() && isRemovable()) sl.emplace_back("removable");
2883 if (isConstrained()) sl.emplace_back("constrained");
2884 if (isTransient()) sl.emplace_back("transient");
2885 if (isMaybeVoid()) sl.emplace_back("maybevoid");
2886 if (isMaybeDefault()) sl.emplace_back("maybedefault");
2887 if (isMaybeAmbiguous()) sl.emplace_back("maybeambiguous");
2888 if (isPublished()) sl.emplace_back("published"); // enum
2889 }
2891 {
2892 sl.emplace_back("implementation");
2893 }
2894 }
2895 if (inherited)
2896 {
2897 sl.emplace_back("inherited");
2898 }
2899 }
2900 }
2901 else if (isObjCMethod() && isImplementation())
2902 {
2903 sl.emplace_back("implementation");
2904 }
2905
2906 for (const auto &sx : m_qualifiers)
2907 {
2908 bool alreadyAdded = std::find(sl.begin(), sl.end(), sx) != sl.end();
2909 if (!alreadyAdded)
2910 {
2911 sl.push_back(sx);
2912 }
2913 }
2914
2915 return sl;
2916}
bool isProperty() const override
bool isInline() const override
bool isOptional() const override
VhdlSpecifier getVhdlSpecifiers() const override
bool isNew() const override
bool isUnretained() const override
bool isGettable() const override
Specifier virtualness(int count=0) const override
bool isRaisable() const override
bool m_explicitInherited
bool isMutable() const override
bool isPublished() const override
bool isProtectedSettable() const override
bool isUNOProperty() const override
bool isRequired() const override
bool isMaybeDefault() const override
bool isTransient() const override
bool isInitonly() const override
bool isAddable() const override
Protection protection() const override
bool isCopy() const override
bool isReadonly() const override
bool isAttribute() const override
bool isRetain() const override
bool isConstEval() const override
bool isExplicit() const override
bool isImplementation() const override
bool isDelete() const override
bool isNoExcept() const override
bool isWeak() const override
bool isNoDiscard() const override
bool isConstInit() const override
bool isProtectedGettable() const override
bool isWritable() const override
bool isSealed() const override
bool isAbstract() const override
bool isPrivateSettable() const override
bool isThreadLocal() const override
bool isMaybeVoid() const override
bool isMaybeAmbiguous() const override
bool isAssign() const override
bool isRemovable() const override
bool isFriend() const override
bool isConstExpr() const override
bool isExternal() const override
bool isNonAtomic() const override
bool isPrivateGettable() const override
bool isObjCProperty() const override
bool isConstrained() const override
bool isReadable() const override
bool isDefault() const override
bool isSettable() const override
bool isBound() const override
virtual DString trVhdlType(VhdlSpecifier type, bool single)=0
std::vector< std::string > StringVector
Definition containers.h:33
Specifier
Definition types.h:80

References Config_getBool, Definition::definitionType(), getClassDef(), DefinitionMixin< MemberDefMutable >::getLanguage(), getVhdlSpecifiers(), isAbstract(), isAddable(), isAssign(), isAttribute(), isBound(), isConstEval(), isConstExpr(), isConstInit(), isConstrained(), isCopy(), isDefault(), isDelete(), isExplicit(), DefinitionMixin< MemberDefMutable >::isExported(), isExternal(), isFinal(), isFriend(), isGettable(), isImplementation(), isInitonly(), isInline(), isMaybeAmbiguous(), isMaybeDefault(), isMaybeVoid(), isMutable(), isNew(), isNoDiscard(), isNoExcept(), isNonAtomic(), isObjCMethod(), isObjCProperty(), isOptional(), isOverride(), isPrivateGettable(), isPrivateSettable(), isProperty(), isProtectedGettable(), isProtectedSettable(), isPublished(), isRaisable(), isReadable(), isReadonly(), isRelated(), isRemovable(), isRequired(), isRetain(), isSealed(), isSettable(), isSignal(), isSlot(), isStatic(), isStrong(), isThreadLocal(), isTransient(), isUNOProperty(), isUnretained(), isWeak(), isWritable(), m_explicitInherited, m_memSpec, m_qualifiers, protection(), theTranslator, Translator::trVhdlType(), Definition::TypeClass, and virtualness().

Referenced by writeDocumentation().

◆ getMemberGroup()

MemberGroup * MemberDefImpl::getMemberGroup ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5737 of file memberdef.cpp.

5738{
5739 return m_memberGroup;
5740}

References m_memberGroup.

◆ getMemberGroupId()

int MemberDefImpl::getMemberGroupId ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5732 of file memberdef.cpp.

5733{
5734 return m_grpId;
5735}

References m_grpId.

◆ getMemberSpecifiers()

TypeSpecifier MemberDefImpl::getMemberSpecifiers ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5134 of file memberdef.cpp.

5135{
5136 return m_memSpec;
5137}

References m_memSpec.

◆ getModuleDef()

const ModuleDef * MemberDefImpl::getModuleDef ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5199 of file memberdef.cpp.

5200{
5201 return m_moduleDef;
5202}

References m_moduleDef.

Referenced by getOutputFileBase(), getReference(), hasDetailedDescription(), and writeDocumentation().

◆ getNamespaceDef() [1/2]

const NamespaceDef * MemberDefImpl::getNamespaceDef ( ) const
overridevirtual

◆ getNamespaceDef() [2/2]

NamespaceDef * MemberDefImpl::getNamespaceDef ( )
overridevirtual

Implements MemberDef.

Definition at line 5174 of file memberdef.cpp.

5175{
5176 return m_nspace;
5177}

References m_nspace.

◆ getOutputFileBase()

DString MemberDefImpl::getOutputFileBase ( ) const
overridevirtual

Returns the base file name (without extension) of this definition. as it is referenced to/written to disk.

Implements Definition.

Definition at line 1703 of file memberdef.cpp.

1704{
1705 bool separateMemberPages = Config_getBool(SEPARATE_MEMBER_PAGES);
1706 bool inlineSimpleClasses = Config_getBool(INLINE_SIMPLE_STRUCTS);
1707 DString baseName;
1708
1709 //printf("Member: %s: templateMaster=%p group=%p classDef=%p nspace=%p fileDef=%p\n",
1710 // qPrint(name()),m_templateMaster,m_group,m_classDef,
1711 // m_nspace,m_fileDef);
1712 const NamespaceDef *nspace = getNamespaceDef();
1713 const FileDef *fileDef = getFileDef();
1714 const ClassDef *classDef = getClassDef();
1715 const ModuleDef *moduleDef = getModuleDef();
1716 const GroupDef *groupDef = getGroupDef();
1718 {
1720 }
1721 else if (templateMaster() && (classDef==nullptr || classDef->isImplicitTemplateInstance()))
1722 {
1724 }
1725 else if (anonymousMemberForDetails())
1726 {
1728 }
1729 else if (groupDef)
1730 {
1731 baseName=groupDef->getOutputFileBase();
1732 }
1733 else if (classDef)
1734 {
1735 baseName=classDef->getOutputFileBase();
1736 if (inlineSimpleClasses && classDef->isSimple())
1737 {
1738 return baseName;
1739 }
1740 }
1741 else if (nspace && (nspace->isLinkable() || nspace->isAnonymous()))
1742 {
1743 baseName=nspace->getOutputFileBase();
1744 }
1745 else if (fileDef)
1746 {
1747 baseName=fileDef->getOutputFileBase();
1748 }
1749 else if (moduleDef)
1750 {
1751 baseName=moduleDef->getOutputFileBase();
1752 }
1753
1754 if (baseName.empty())
1755 {
1757 "Internal inconsistency: member {} does not belong to any container!",name()
1758 );
1759 return "dummy";
1760 }
1761 else if (separateMemberPages && hasDetailedDescription())
1762 {
1763 if (getEnumScope()) // enum value, which is part of enum's documentation
1764 {
1765 baseName+="_"+getEnumScope()->anchor();
1766 }
1767 else
1768 {
1769 baseName+="_"+anchor();
1770 }
1771 }
1772 return baseName;
1773}
virtual bool isSimple() const =0
virtual bool isImplicitTemplateInstance() const =0
virtual bool isAnonymous() const =0
bool hasDetailedDescription() const override
const MemberDef * getEnumScope() const override
const ModuleDef * getModuleDef() const override
#define warn(file, line, fmt,...)
Definition message.h:97

References Definition::anchor(), anchor(), anonymousMemberForDetails(), Config_getBool, DString::empty(), getClassDef(), DefinitionMixin< MemberDefMutable >::getDefFileName(), DefinitionMixin< MemberDefMutable >::getDefLine(), getEnumScope(), getFileDef(), getGroupDef(), getModuleDef(), getNamespaceDef(), Definition::getOutputFileBase(), hasDetailedDescription(), Definition::isAnonymous(), ClassDef::isImplicitTemplateInstance(), Definition::isLinkable(), ClassDef::isSimple(), m_explicitOutputFileBase, DefinitionMixin< MemberDefMutable >::name(), templateMaster(), and warn.

Referenced by addListReference(), writeDeclaration(), writeDocumentation(), writeLink(), writeMemberDocSimple(), and writeTagFile().

◆ getQualifiers()

StringVector MemberDefImpl::getQualifiers ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5912 of file memberdef.cpp.

5913{
5914 return m_qualifiers;
5915}

References m_qualifiers.

◆ getReadAccessor()

DString MemberDefImpl::getReadAccessor ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5179 of file memberdef.cpp.

5180{
5181 return m_read;
5182}

References m_read.

◆ getReference()

DString MemberDefImpl::getReference ( ) const
overridevirtual

If this definition was imported via a tag file, this function returns the tagfile for the external project. This can be translated into an external link target via Doxygen::tagDestinationDict

Reimplemented from DefinitionMixin< MemberDefMutable >.

Definition at line 1775 of file memberdef.cpp.

1776{
1777 DString ref = DefinitionMixin::getReference();
1778 if (!ref.empty())
1779 {
1780 return ref;
1781 }
1782 const NamespaceDef *nspace = getNamespaceDef();
1783 const FileDef *fileDef = getFileDef();
1784 const ClassDef *classDef = getClassDef();
1785 const ModuleDef *moduleDef = getModuleDef();
1786 const GroupDef *groupDef = getGroupDef();
1787 if (templateMaster())
1788 {
1789 return templateMaster()->getReference();
1790 }
1791 else if (groupDef)
1792 {
1793 return groupDef->getReference();
1794 }
1795 else if (classDef)
1796 {
1797 return classDef->getReference();
1798 }
1799 else if (nspace)
1800 {
1801 return nspace->getReference();
1802 }
1803 else if (moduleDef)
1804 {
1805 return moduleDef->getReference();
1806 }
1807 else if (fileDef)
1808 {
1809 return fileDef->getReference();
1810 }
1811 return "";
1812}
DString getReference() const override

References DString::empty(), getClassDef(), getFileDef(), getGroupDef(), getModuleDef(), getNamespaceDef(), Definition::getReference(), DefinitionMixin< Base >::getReference(), and templateMaster().

Referenced by anchor(), and writeLink().

◆ getScopeString()

DString MemberDefImpl::getScopeString ( ) const
overridevirtual

Implements MemberDef.

Definition at line 4421 of file memberdef.cpp.

4422{
4423 DString result;
4424 if (isStrong()) result=name();
4425 else if (getClassDef()) result=getClassDef()->displayName();
4426 else if (getNamespaceDef()) result=getNamespaceDef()->displayName();
4427 return result;
4428}

References Definition::displayName(), getClassDef(), getNamespaceDef(), isStrong(), and DefinitionMixin< MemberDefMutable >::name().

Referenced by sourceRefName(), and writeDocumentation().

◆ getSectionList()

const MemberList * MemberDefImpl::getSectionList ( const Definition * container) const
overridevirtual

Implements MemberDef.

Definition at line 4642 of file memberdef.cpp.

4643{
4644 auto it = m_sectionMap.find(container);
4645 return it!=m_sectionMap.end() ? it->second : nullptr;
4646}

References m_sectionMap.

◆ getVhdlSpecifiers()

VhdlSpecifier MemberDefImpl::getVhdlSpecifiers ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5139 of file memberdef.cpp.

5140{
5141 return m_vhdlSpec;
5142}

References m_vhdlSpec.

Referenced by getLabels().

◆ getWriteAccessor()

DString MemberDefImpl::getWriteAccessor ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5184 of file memberdef.cpp.

5185{
5186 return m_write;
5187}

References m_write.

◆ hasCallerGraph()

bool MemberDefImpl::hasCallerGraph ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5760 of file memberdef.cpp.

5761{
5762 return m_hasCallerGraph;
5763}

References m_hasCallerGraph.

◆ hasCallGraph()

bool MemberDefImpl::hasCallGraph ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5742 of file memberdef.cpp.

5743{
5744 return m_hasCallGraph;
5745}

References m_hasCallGraph.

◆ hasDetailedDescription()

bool MemberDefImpl::hasDetailedDescription ( ) const
overridevirtual

Implements MemberDef.

Definition at line 2643 of file memberdef.cpp.

2644{
2645 std::lock_guard<std::mutex> lock(g_hasDetailedDescriptionMutex);
2646 //printf(">hasDetailedDescription(cached=%d)\n",m_hasDetailedDescriptionCached);
2648 {
2649 bool extractAll = Config_getBool(EXTRACT_ALL);
2650 bool alwaysDetailedSec = Config_getBool(ALWAYS_DETAILED_SEC);
2651 bool repeatBrief = Config_getBool(REPEAT_BRIEF);
2652 bool briefMemberDesc = Config_getBool(BRIEF_MEMBER_DESC);
2653 bool hideUndocMembers = Config_getBool(HIDE_UNDOC_MEMBERS);
2654 bool extractStatic = Config_getBool(EXTRACT_STATIC);
2655 bool extractPrivateVirtual = Config_getBool(EXTRACT_PRIV_VIRTUAL);
2656 bool inlineSources = hasInlineSource();
2657 bool includes = Config_getBool(SHOW_INCLUDE_FILES) && m_incInfo!=nullptr;
2658
2659 // the member has detailed documentation because the user added some comments
2660 bool docFilter =
2661 // extract all is enabled
2662 extractAll ||
2663 // has detailed docs
2664 !documentation().empty() ||
2665 // has inbody docs
2667 // is an enum with values that are documented
2669 // is documented enum value
2670 (m_mtype==MemberType::EnumValue && !briefDescription().empty()) ||
2671 // has brief description that is part of the detailed description
2672 (!briefDescription().empty() && // has brief docs
2673 (alwaysDetailedSec && // they are visible in
2674 (repeatBrief || // detailed section or
2675 !briefMemberDesc // they are explicitly not
2676 ) // shown in brief section
2677 )
2678 ) ||
2679 // has one or more documented arguments
2684 m_templateMaster->templateArguments().hasTemplateDocumentation() :
2686 // user-specified qualifiers
2687 !m_qualifiers.empty();
2688
2689 // generate function guard
2690 // ================== =======
2691 // _writeGroupInclude -> ignored in calculation
2692 // multiLineInitializer() -> hasMultiLineInitializer()
2693 // _writeReimplements -> _isReimplements()
2694 // _writeReimplementedBy -> _countReimplementedBy()>0
2695 // _writeExamples -> hasExamples()
2696 // _writeTypeConstraints -> m_typeConstraints.hasParameters()
2697 // writeSourceDef -> !getSourceFileBase().empty();
2698 // writeInlineCode -> hasInlineSource() && hasSources()
2699 // writeSourceRefs -> hasReferencesRelation() && hasSourceRefs()
2700 // writeSourceReffedBy -> hasReferencedByRelation() && hasSourceReffedBy()
2701 // _writeCallGraph -> _hasVisibleCallGraph()
2702 // _writeCallerGraph -> _hasVisibleCallerGraph()
2703
2704 // the member has detailed documentation because there is some generated info
2705 bool docInfo =
2706 // has a multi-line initialization block
2708 // reimplements / reimplemented by
2710 // examples
2711 hasExamples() ||
2712 // type constraints
2714 // has source definition
2715 !getSourceFileBase().empty() ||
2716 // has inline sources
2717 (inlineSources && hasSources()) ||
2718 // has references
2721 // call graph
2723 // caller graph
2725 // requirement references
2727 // has \headerfile command
2728 includes;
2729
2730 if (!hideUndocMembers) // if HIDE_UNDOC_MEMBERS is NO we also show the detailed section
2731 // if there is only some generated info
2732 {
2733 docFilter = docFilter || docInfo;
2734 }
2735
2736 // this is not a global static or global statics should be extracted
2737 bool staticFilter = getClassDef()!=nullptr || !isStatic() || extractStatic;
2738
2739 // a module does not contain details for members, so either the namespace or file should be linkable
2740 bool moduleFilter = getModuleDef()==nullptr || (getFileDef() && getFileDef()->isLinkable()) ||
2743
2744 // only include members that are non-private unless EXTRACT_PRIVATE is
2745 // set to YES or the member is part of a group
2746 bool privateFilter = protectionLevelVisible(protection()) || m_mtype==MemberType::Friend ||
2747 (m_prot==Protection::Private && (m_virt!=Specifier::Normal || isOverride() || isFinal()) && extractPrivateVirtual);
2748
2749 // hide friend (class|struct|union) member if HIDE_FRIEND_COMPOUNDS
2750 // is true
2751 bool friendCompoundFilter = !(Config_getBool(HIDE_FRIEND_COMPOUNDS) && isFriend());
2752
2754 (docFilter && staticFilter && moduleFilter && privateFilter && friendCompoundFilter && !isHidden());
2755 //printf("docFilter=%d docInfo=%d staticFilter=%d privateFilter=%d friendCompoundFilter=%d !isHidden()=%d",
2756 // docFilter,docInfo,staticFilter,privateFilter,friendCompoundFilter,!isHidden());
2758 }
2759 //printf("<hasDetailedDescription(cached=%d)\n",m_hasDetailedDescriptionCached);
2761}
bool hasDocumentation(bool allowEmptyNames=false) const
Definition arguments.cpp:26
bool hasTemplateDocumentation() const
Definition arguments.cpp:34
bool hasRequirementRefs() const override
bool hasSourceReffedBy() const override
DString getSourceFileBase() const override
virtual const ArgumentList & templateArguments() const =0
bool _isReimplements() const
bool hasMultiLineInitializer() const override
bool hasInlineSource() const override
bool hasReferencesRelation() const override
bool hasReferencedByRelation() const override
bool isLinkable() const override
bool hasDocumentedEnumValues() const override
static std::mutex g_hasDetailedDescriptionMutex

References _countReimplementedBy(), _hasVisibleCallerGraph(), _hasVisibleCallGraph(), _isReimplements(), MemberDef::argumentList(), briefDescription(), Config_getBool, documentation(), DString::empty(), g_hasDetailedDescriptionMutex, getClassDef(), getFileDef(), getGroupDef(), getModuleDef(), getNamespaceDef(), DefinitionMixin< MemberDefMutable >::getSourceFileBase(), ArgumentList::hasDocumentation(), hasDocumentation(), hasDocumentedEnumValues(), hasExamples(), hasInlineSource(), hasMultiLineInitializer(), ArgumentList::hasParameters(), hasReferencedByRelation(), hasReferencesRelation(), DefinitionMixin< MemberDefMutable >::hasRequirementRefs(), DefinitionMixin< MemberDefMutable >::hasSourceReffedBy(), DefinitionMixin< MemberDefMutable >::hasSourceRefs(), DefinitionMixin< MemberDefMutable >::hasSources(), ArgumentList::hasTemplateDocumentation(), DefinitionMixin< MemberDefMutable >::inbodyDocumentation(), isEnumerate(), isFinal(), isFriend(), DefinitionMixin< MemberDefMutable >::isHidden(), Definition::isLinkable(), isLinkable(), isOverride(), isStatic(), m_defArgList, m_detailedDescriptionCachedValue, m_hasDetailedDescriptionCached, m_incInfo, m_mtype, m_prot, m_qualifiers, m_tArgList, m_templateMaster, m_typeConstraints, m_virt, protection(), protectionLevelVisible(), and MemberDef::templateArguments().

Referenced by getOutputFileBase(), isDetailedSectionVisible(), warnIfUndocumented(), writeDeclaration(), and writeLink().

◆ hasDocumentation()

bool MemberDefImpl::hasDocumentation ( ) const
overridevirtual

Returns true iff the definition is documented (which could be generated documentation)

See also
hasUserDocumentation()

Reimplemented from DefinitionMixin< MemberDefMutable >.

Definition at line 4408 of file memberdef.cpp.

4409{
4411 (m_mtype==MemberType::Enumeration && m_docEnumValues) || // has enum values
4412 (m_defArgList.hasDocumentation()|| m_tArgList.hasTemplateDocumentation()); // has doc (template) arguments
4413}
bool hasDocumentation() const override

References ArgumentList::hasDocumentation(), DefinitionMixin< Base >::hasDocumentation(), ArgumentList::hasTemplateDocumentation(), m_defArgList, m_docEnumValues, m_mtype, and m_tArgList.

Referenced by _computeLinkableInProject(), hasDetailedDescription(), isBriefSectionVisible(), visibleInIndex(), warnIfUndocumentedParams(), and writeDeclaration().

◆ hasDocumentedEnumValues()

bool MemberDefImpl::hasDocumentedEnumValues ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5589 of file memberdef.cpp.

5590{
5591 return m_docEnumValues;
5592}

References m_docEnumValues.

Referenced by hasDetailedDescription(), and writeEnumDeclaration().

◆ hasEnumValues()

bool MemberDefImpl::hasEnumValues ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5793 of file memberdef.cpp.

5794{
5795 return m_hasEnumValues;
5796}

References m_hasEnumValues.

Referenced by _writeEnumValues().

◆ hasExamples()

bool MemberDefImpl::hasExamples ( ) const
overridevirtual

Implements MemberDef.

Definition at line 1678 of file memberdef.cpp.

1679{
1680 return !m_examples.empty();
1681}

References m_examples.

Referenced by _writeExamples(), and hasDetailedDescription().

◆ hasInlineSource()

bool MemberDefImpl::hasInlineSource ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5788 of file memberdef.cpp.

5789{
5790 return m_hasInlineSource;
5791}

References m_hasInlineSource.

Referenced by hasDetailedDescription().

◆ hasMultiLineInitializer()

bool MemberDefImpl::hasMultiLineInitializer ( ) const
overridevirtual

Implements MemberDef.

Definition at line 4565 of file memberdef.cpp.

4566{
4567 //printf("initLines=%d userInitLines=%d maxInitLines=%d\n",
4568 // initLines,userInitLines,maxInitLines);
4569 bool isFuncLikeMacro = m_mtype==MemberType::Define && m_defArgList.hasParameters();
4570 return (m_initLines>0 || (!m_initializer.empty() && isFuncLikeMacro)) &&
4571 ((m_initLines<m_maxInitLines && m_userInitLines==-1) // implicitly enabled
4572 || m_initLines<m_userInitLines // explicitly enabled
4573 );
4574}

References DString::empty(), ArgumentList::hasParameters(), m_defArgList, m_initializer, m_initLines, m_maxInitLines, m_mtype, and m_userInitLines.

Referenced by hasDetailedDescription(), and writeDocumentation().

◆ hasOneLineInitializer()

bool MemberDefImpl::hasOneLineInitializer ( ) const
overridevirtual

Implements MemberDef.

Definition at line 4554 of file memberdef.cpp.

4555{
4556 //printf("%s: init=%s, initLines=%d maxInitLines=%d userInitLines=%d\n",
4557 // qPrint(name()),qPrint(m_initializer),m_initLines,
4558 // m_maxInitLines,m_userInitLines);
4559 bool isFuncLikeMacro = m_mtype==MemberType::Define && m_defArgList.hasParameters();
4560 return !m_initializer.empty() && m_initLines==0 && // one line initializer
4561 !isFuncLikeMacro &&
4562 ((m_maxInitLines>0 && m_userInitLines==-1) || m_userInitLines>0); // enabled by default or explicitly
4563}

References DString::empty(), ArgumentList::hasParameters(), m_defArgList, m_initializer, m_initLines, m_maxInitLines, m_mtype, and m_userInitLines.

Referenced by writeDeclaration(), writeDocumentation(), and writeMemberDocSimple().

◆ hasReferencedByRelation()

bool MemberDefImpl::hasReferencedByRelation ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5778 of file memberdef.cpp.

5779{
5781}

References m_hasReferencedByRelation.

Referenced by hasDetailedDescription(), and writeDocumentation().

◆ hasReferencesRelation()

bool MemberDefImpl::hasReferencesRelation ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5783 of file memberdef.cpp.

5784{
5786}

References m_hasReferencesRelation.

Referenced by hasDetailedDescription(), and writeDocumentation().

◆ hasUserDocumentation()

bool MemberDefImpl::hasUserDocumentation ( ) const
overridevirtual

Returns true iff the definition is documented by the user.

Reimplemented from DefinitionMixin< MemberDefMutable >.

Definition at line 6478 of file memberdef.cpp.

6479{
6480 if (m_templateMaster)
6481 {
6483 }
6484 else
6485 {
6487 }
6488}
virtual bool hasUserDocumentation() const =0
bool hasUserDocumentation() const override

References Definition::hasUserDocumentation(), DefinitionMixin< Base >::hasUserDocumentation(), and m_templateMaster.

Referenced by warnIfUndocumented().

◆ incrementFlowKeyWordCount()

void MemberDefImpl::incrementFlowKeyWordCount ( )
overridevirtual

Implements MemberDefMutable.

Definition at line 6195 of file memberdef.cpp.

6196{
6198}

References m_numberOfFlowKW.

◆ inheritsDocsFrom()

const MemberDef * MemberDefImpl::inheritsDocsFrom ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5839 of file memberdef.cpp.

5840{
5841 return m_docProvider;
5842}

References m_docProvider.

◆ init()

void MemberDefImpl::init ( Definition * def,
const DString & t,
const DString & a,
const DString & e,
Protection p,
Specifier v,
bool s,
Relationship r,
MemberType mt,
const ArgumentList & tal,
const ArgumentList & al,
const DString & meta )
private

Definition at line 1367 of file memberdef.cpp.

1373{
1374 m_classDef=nullptr;
1375 m_fileDef=nullptr;
1376 m_moduleDef=nullptr;
1377 m_redefines=nullptr;
1378 m_relatedAlso=nullptr;
1379 m_nspace=nullptr;
1380 m_memDef=nullptr;
1381 m_memDec=nullptr;
1382 m_group=nullptr;
1383 m_grpId=-1;
1384 m_enumScope=nullptr;
1385 m_livesInsideEnum=false;
1386 m_hasCallGraph = Config_getBool(CALL_GRAPH);
1387 m_hasCallerGraph = Config_getBool(CALLER_GRAPH);
1388 m_hasReferencedByRelation = Config_getBool(REFERENCED_BY_RELATION);
1389 m_hasReferencesRelation = Config_getBool(REFERENCES_RELATION);
1390 m_hasEnumValues = Config_getBool(SHOW_ENUM_VALUES);
1391 m_hasInlineSource = Config_getBool(INLINE_SOURCES);
1392 m_initLines=0;
1393 m_type=t;
1394 if (mt==MemberType::Typedef) m_type.stripPrefix("typedef ");
1395 // type.stripPrefix("struct ");
1396 // type.stripPrefix("record ");
1397 // type.stripPrefix("class " );
1398 // type.stripPrefix("union " );
1400 m_args=a;
1402 if (m_type.empty()) m_decl=d->name()+m_args; else m_decl=m_type+" "+d->name()+m_args;
1403
1404 m_memberGroup=nullptr;
1405 m_virt=v;
1406 m_prot=p;
1407 m_related=r;
1408 m_stat=s;
1409 m_mtype=mt;
1410 m_exception=e;
1411 m_proto=false;
1412 m_memSpec=TypeSpecifier();
1414 m_annEnumType=nullptr;
1415 m_annMemberForDecl=nullptr;
1416 m_annMemberForDetails=nullptr;
1417 m_groupAlias=nullptr;
1418 m_explExt=false;
1419 m_tspec=false;
1420 m_anonymousType=nullptr;
1421 m_maxInitLines=Config_getInt(MAX_INITIALIZER_LINES);
1422 m_userInitLines=-1;
1423 m_docEnumValues=false;
1424 // copy function template arguments (if any)
1425 m_tArgList = tal;
1426 //printf("new member al=%p\n",al);
1427 // copy function definition arguments (if any)
1428 m_defArgList = al;
1429 // convert function declaration arguments (if any)
1430 if (!m_args.empty())
1431 {
1433 //printf("setDeclArgList %s to %s const=%d\n",qPrint(args),
1434 // qPrint(argListToString(declArgList)),declArgList->constSpecifier);
1435 }
1436 m_metaData = meta;
1437 m_templateMaster = nullptr;
1438 m_docsForDefinition = true;
1439 m_isTypedefValCached = false;
1440 m_cachedTypedefValue = nullptr;
1441 m_implOnly=false;
1442 m_groupMember = nullptr;
1443 m_hasDocumentedParams = false;
1445 m_docProvider = nullptr;
1446 m_isDMember = d->getDefFileName().lower().endsWith(".d");
1447}
bool stripPrefix(const DString &prefix)
Definition dstring.h:290
std::unique_ptr< ArgumentList > stringToArgumentList(SrcLangExt lang, const DString &argsString, DString *extraTypeChars=nullptr)
Definition defargs.l:822

References Config_getBool, Config_getInt, DString::empty(), DString::endsWith(), Definition::getDefFileName(), Definition::getLanguage(), DString::lower(), m_annEnumType, m_annMemberForDecl, m_annMemberForDetails, m_anonymousType, m_args, m_cachedTypedefValue, m_classDef, m_decl, m_declArgList, m_defArgList, m_docEnumValues, m_docProvider, m_docsForDefinition, m_enumScope, m_exception, m_explExt, m_extraTypeChars, m_fileDef, m_group, m_groupAlias, m_groupMember, m_grpId, m_hasCallerGraph, m_hasCallGraph, m_hasDocumentedParams, m_hasDocumentedReturnType, m_hasEnumValues, m_hasInlineSource, m_hasReferencedByRelation, m_hasReferencesRelation, m_implOnly, m_initLines, m_isDMember, m_isTypedefValCached, m_livesInsideEnum, m_maxInitLines, m_memberGroup, m_memDec, m_memDef, m_memSpec, m_metaData, m_moduleDef, m_mtype, m_nspace, m_prot, m_proto, m_redefines, m_related, m_relatedAlso, m_stat, m_tArgList, m_templateMaster, m_tspec, m_type, m_userInitLines, m_vhdlSpec, m_virt, Definition::name(), removeRedundantWhiteSpace(), stringToArgumentList(), DString::stripPrefix(), and UNKNOWN.

Referenced by MemberDefImpl(), and writeDocumentation().

◆ initializer()

const DString & MemberDefImpl::initializer ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5119 of file memberdef.cpp.

5120{
5121 return m_initializer;
5122}

References m_initializer.

Referenced by setInitializer().

◆ initializerLines()

int MemberDefImpl::initializerLines ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5124 of file memberdef.cpp.

5125{
5126 return m_initLines;
5127}

References m_initLines.

◆ insertEnumField()

void MemberDefImpl::insertEnumField ( MemberDef * md)
overridevirtual

Implements MemberDefMutable.

Definition at line 1667 of file memberdef.cpp.

1668{
1670}
void push_back(const T &value)
Definition memberlist.h:49

References m_enumFields, and MemberVector::push_back().

◆ insertReimplementedBy()

void MemberDefImpl::insertReimplementedBy ( MemberDef * md)
overridevirtual

Implements MemberDefMutable.

Definition at line 1622 of file memberdef.cpp.

1623{
1624 if (m_templateMaster)
1625 {
1626 MemberDefMutable *mdm = toMemberDefMutable(const_cast<MemberDef *>(m_templateMaster));
1627 if (mdm)
1628 {
1629 mdm->insertReimplementedBy(md);
1630 }
1631 }
1632 if (!m_redefinedBy.contains(md))
1633 {
1635 }
1636}
virtual void insertReimplementedBy(MemberDef *md)=0
bool contains(const MemberDef *md) const
Definition memberlist.h:90
void inSort(MemberDef *md)
Definition memberlist.h:81

References MemberVector::contains(), MemberDefMutable::insertReimplementedBy(), MemberVector::inSort(), m_redefinedBy, m_templateMaster, and toMemberDefMutable().

◆ invalidateCachedArgumentTypes()

void MemberDefImpl::invalidateCachedArgumentTypes ( )
overridevirtual

Implements MemberDefMutable.

Definition at line 6189 of file memberdef.cpp.

6190{
6193}
static void invalidateCachedTypesInArgumentList(ArgumentList &al)

References invalidateCachedTypesInArgumentList(), m_declArgList, and m_defArgList.

◆ invalidateTypedefValCache()

void MemberDefImpl::invalidateTypedefValCache ( )
overridevirtual

Implements MemberDefMutable.

Definition at line 6075 of file memberdef.cpp.

6076{
6078}

References m_isTypedefValCached.

◆ isAbstract()

bool MemberDefImpl::isAbstract ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5425 of file memberdef.cpp.

5426{
5427 return m_memSpec.isAbstract();
5428}

References m_memSpec.

Referenced by getLabels().

◆ isAddable()

bool MemberDefImpl::isAddable ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5375 of file memberdef.cpp.

5376{
5377 return m_memSpec.isAddable();
5378}

References m_memSpec.

Referenced by getLabels(), and writeDeclaration().

◆ isAssign()

bool MemberDefImpl::isAssign ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5450 of file memberdef.cpp.

5451{
5452 return m_memSpec.isAssign();
5453}

References m_memSpec.

Referenced by getLabels().

◆ isAttribute()

bool MemberDefImpl::isAttribute ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5507 of file memberdef.cpp.

5508{
5509 return m_memSpec.isAttribute();
5510}

References m_memSpec.

Referenced by getLabels().

◆ isBound()

bool MemberDefImpl::isBound ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5522 of file memberdef.cpp.

5523{
5524 return m_memSpec.isBound();
5525}

References m_memSpec.

Referenced by getLabels().

◆ isBriefSectionVisible()

bool MemberDefImpl::isBriefSectionVisible ( ) const
overridevirtual

This methods returns true iff the brief section (also known as declaration section) is visible in the documentation.

Implements MemberDef.

Definition at line 2049 of file memberdef.cpp.

2050{
2051 bool extractStatic = Config_getBool(EXTRACT_STATIC);
2052 bool extractPrivateVirtual = Config_getBool(EXTRACT_PRIV_VIRTUAL);
2053 bool hideUndocMembers = Config_getBool(HIDE_UNDOC_MEMBERS);
2054 bool briefMemberDesc = Config_getBool(BRIEF_MEMBER_DESC);
2055 bool repeatBrief = Config_getBool(REPEAT_BRIEF);
2056 bool hideFriendCompounds = Config_getBool(HIDE_FRIEND_COMPOUNDS);
2057
2058 //printf("Member %s grpId=%d docs=%s file=%s args=%s\n",
2059 // qPrint(name()),
2060 // 0,"", //grpId,grpId==-1?"<none>":Doxygen::memberDocDict[grpId]->data(),
2061 // "", //qPrint(getFileDef()->name()),
2062 // argsString());
2063
2064 bool hasDocs = hasDocumentation();
2065
2066 // only include static members with file/namespace scope if
2067 // explicitly enabled in the config file
2068 bool visibleIfStatic = !(getClassDef()==nullptr &&
2069 isStatic() &&
2070 !extractStatic
2071 );
2072
2073 // only include members is the are documented or
2074 // HIDE_UNDOC_MEMBERS is NO in the config file
2075 bool visibleIfDocumented = (!hideUndocMembers ||
2076 hasDocs ||
2078 );
2079
2080 // hide members with no detailed description and brief descriptions
2081 // explicitly disabled.
2082 bool visibleIfEnabled = !(hideUndocMembers &&
2083 documentation().empty() &&
2084 !briefMemberDesc &&
2085 !repeatBrief
2086 );
2087
2088 // Hide friend (class|struct|union) declarations if HIDE_FRIEND_COMPOUNDS is true
2089 bool visibleIfFriendCompound = !(hideFriendCompounds &&
2090 isFriend()
2091 );
2092
2093 // only include members that are non-private unless EXTRACT_PRIVATE is
2094 // set to YES or the member is part of a group. And as a special case,
2095 // private *documented* virtual members are shown if EXTRACT_PRIV_VIRTUAL
2096 // is set to YES
2097 bool visibleIfPrivate = (protectionLevelVisible(protection()) ||
2098 m_mtype==MemberType::Friend ||
2099 (m_prot==Protection::Private &&
2100 (m_virt!=Specifier::Normal || isOverride() || isFinal()) && extractPrivateVirtual && hasDocs)
2101 );
2102
2103 // hide member if it overrides a member in a superclass and has no
2104 // documentation of its own
2105 //bool visibleIfDocVirtual = !reimplements() ||
2106 // !Config_getBool(INHERIT_DOCS) ||
2107 // hasDocs;
2108
2109 // true if this member is a constructor or destructor
2110 bool cOrDTor = isConstructor() || isDestructor();
2111
2112 // hide default constructors or destructors (no args) without
2113 // documentation
2114 bool visibleIfNotDefaultCDTor = !(cOrDTor &&
2115 (m_defArgList.empty() ||
2116 m_defArgList.front().type == "void"
2117 ) &&
2118 !hasDocs
2119 );
2120
2121
2122 //printf("visibleIfStatic=%d visibleIfDocumented=%d visibleIfEnabled=%d "
2123 // "visibleIfPrivate=%d visibleIfNotDefaultCDTor=%d "
2124 // "visibleIfFriendCompound=%d\n",
2125 // visibleIfStatic,visibleIfDocumented,
2126 // visibleIfEnabled,visibleIfPrivate,visibleIfNotDefaultCDTor,
2127 // visibleIfFriendCompound);
2128
2129 bool visible = visibleIfStatic && visibleIfDocumented &&
2130 visibleIfEnabled && visibleIfPrivate &&
2131 /*visibleIfDocVirtual &&*/ visibleIfNotDefaultCDTor &&
2132 visibleIfFriendCompound &&
2133 !isHidden();
2134 //printf("MemberDefImpl::isBriefSectionVisible() %d\n",visible);
2135 return visible;
2136}
Argument & front()
Definition arguments.h:106
bool isConstructor() const override
bool isDocumentedFriendClass() const override

References Config_getBool, documentation(), ArgumentList::empty(), DString::empty(), ArgumentList::front(), getClassDef(), hasDocumentation(), isConstructor(), isDestructor(), isDocumentedFriendClass(), isFinal(), isFriend(), DefinitionMixin< MemberDefMutable >::isHidden(), isOverride(), isStatic(), m_defArgList, m_mtype, m_prot, m_virt, protection(), protectionLevelVisible(), and Argument::type.

Referenced by writeEnumDeclaration().

◆ isCallable()

bool MemberDefImpl::isCallable ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5573 of file memberdef.cpp.

5574{
5575 return isFunction() ||
5576 isSlot() ||
5577 isSignal() ||
5578 isConstructor() ||
5579 isDestructor() ||
5580 isObjCMethod() ||
5581 isFriend();
5582}

References isConstructor(), isDestructor(), isFriend(), isFunction(), isObjCMethod(), isSignal(), and isSlot().

Referenced by sourceRefName().

◆ isConstEval()

bool MemberDefImpl::isConstEval ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5639 of file memberdef.cpp.

5640{
5641 return m_memSpec.isConstEval();
5642}

References m_memSpec.

Referenced by getLabels().

◆ isConstExpr()

bool MemberDefImpl::isConstExpr ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5634 of file memberdef.cpp.

5635{
5636 return m_memSpec.isConstExpr();
5637}

References m_memSpec.

Referenced by getLabels().

◆ isConstInit()

bool MemberDefImpl::isConstInit ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5644 of file memberdef.cpp.

5645{
5646 return m_memSpec.isConstInit();
5647}

References m_memSpec.

Referenced by getLabels().

◆ isConstrained()

bool MemberDefImpl::isConstrained ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5527 of file memberdef.cpp.

5528{
5529 return m_memSpec.isConstrained();
5530}

References m_memSpec.

Referenced by getLabels().

◆ isConstructor()

bool MemberDefImpl::isConstructor ( ) const
overridevirtual

Implements MemberDef.

Definition at line 4777 of file memberdef.cpp.

4778{
4779 if (m_isConstructorCached==0)
4780 {
4781 MemberDefImpl *that = const_cast<MemberDefImpl*>(this);
4782 that->_computeIsConstructor();
4783 }
4785 return m_isConstructorCached==2;
4786
4787}
void _computeIsConstructor()
#define ASSERT(x)
Definition message.h:142

References _computeIsConstructor(), ASSERT, m_isConstructorCached, and MemberDefImpl().

Referenced by isBriefSectionVisible(), isCallable(), and warnIfUndocumentedParams().

◆ isCopy()

bool MemberDefImpl::isCopy ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5445 of file memberdef.cpp.

5446{
5447 return m_memSpec.isCopy();
5448}

References m_memSpec.

Referenced by getLabels().

◆ isCSharpProperty()

bool MemberDefImpl::isCSharpProperty ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5026 of file memberdef.cpp.

5027{
5028 if (getClassDef() && getClassDef()->isCSharp() && isProperty()) return true;
5029 return false;
5030}

References getClassDef(), and isProperty().

◆ isDCOP()

bool MemberDefImpl::isDCOP ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5295 of file memberdef.cpp.

5296{
5297 return m_mtype==MemberType::DCOP;
5298}

References m_mtype.

◆ isDefault()

bool MemberDefImpl::isDefault ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5492 of file memberdef.cpp.

5493{
5494 return m_memSpec.isDefault();
5495}

References m_memSpec.

Referenced by getLabels().

◆ isDefine()

bool MemberDefImpl::isDefine ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5285 of file memberdef.cpp.

5286{
5287 return m_mtype==MemberType::Define;
5288}

References m_mtype.

Referenced by writeDeclaration(), writeDocumentation(), and writeMemberDocSimple().

◆ isDelete()

bool MemberDefImpl::isDelete ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5497 of file memberdef.cpp.

5498{
5499 return m_memSpec.isDelete();
5500}

References m_memSpec.

Referenced by getLabels().

◆ isDeleted()

bool MemberDefImpl::isDeleted ( ) const
overridevirtual

Implements MemberDef.

Definition at line 4403 of file memberdef.cpp.

4404{
4405 return m_defArgList.isDeleted();
4406}
bool isDeleted() const
Definition arguments.h:116

References ArgumentList::isDeleted(), and m_defArgList.

Referenced by warnIfUndocumented(), and warnIfUndocumentedParams().

◆ isDestructor()

bool MemberDefImpl::isDestructor ( ) const
overridevirtual

Implements MemberDef.

Definition at line 4818 of file memberdef.cpp.

4819{
4820 if (m_isDestructorCached==0)
4821 {
4822 MemberDefImpl *that=const_cast<MemberDefImpl*>(this);
4823 that->_computeIsDestructor();
4824 }
4826 return m_isDestructorCached==2;
4827}
void _computeIsDestructor()

References _computeIsDestructor(), ASSERT, m_isDestructorCached, and MemberDefImpl().

Referenced by _computeIsDestructor(), isBriefSectionVisible(), isCallable(), and warnIfUndocumentedParams().

◆ isDetailedSectionVisible()

bool MemberDefImpl::isDetailedSectionVisible ( MemberListContainer container) const
overridevirtual

Implements MemberDef.

Definition at line 2763 of file memberdef.cpp.

2764{
2765 bool separateMemPages = Config_getBool(SEPARATE_MEMBER_PAGES);
2766 bool inlineSimpleStructs = Config_getBool(INLINE_SIMPLE_STRUCTS);
2767 bool hideUndocMembers = Config_getBool(HIDE_UNDOC_MEMBERS);
2768 bool groupFilter = getGroupDef()==nullptr || container==MemberListContainer::Group || separateMemPages;
2769 bool fileFilter = getNamespaceDef()==nullptr || !getNamespaceDef()->isLinkable() || container!=MemberListContainer::File;
2770 bool simpleFilter = (hasBriefDescription() || !hideUndocMembers) && inlineSimpleStructs &&
2771 getClassDef()!=nullptr && getClassDef()->isSimple();
2772
2773 bool visible = hasDetailedDescription() && groupFilter && fileFilter &&
2774 !isReference();
2775 bool result = visible || simpleFilter;
2776 //printf("%s::isDetailedSectionVisible: %d groupFilter=%d fileFilter=%d\n",
2777 // qPrint(name()),result,groupFilter,fileFilter);
2778 return result;
2779}
bool hasBriefDescription() const override

References Config_getBool, File, getClassDef(), getGroupDef(), getNamespaceDef(), Group, DefinitionMixin< MemberDefMutable >::hasBriefDescription(), hasDetailedDescription(), Definition::isLinkable(), isReference(), and ClassDef::isSimple().

◆ isDictionary()

bool MemberDefImpl::isDictionary ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5269 of file memberdef.cpp.

5270{
5271 return m_mtype==MemberType::Dictionary;
5272}

References m_mtype.

◆ isDocsForDefinition()

bool MemberDefImpl::isDocsForDefinition ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5609 of file memberdef.cpp.

5610{
5611 return m_docsForDefinition;
5612}

References m_docsForDefinition.

Referenced by warnIfUndocumentedParams().

◆ isDocTransferDone()

bool MemberDefImpl::isDocTransferDone ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5129 of file memberdef.cpp.

5130{
5131 return m_docTransferDone;
5132}
bool m_docTransferDone

References m_docTransferDone.

◆ isDocumentedFriendClass()

bool MemberDefImpl::isDocumentedFriendClass ( ) const
overridevirtual

Implements MemberDef.

Definition at line 4394 of file memberdef.cpp.

4395{
4396 ClassDef *fcd=nullptr;
4397 DString baseName=name();
4398 if (size_t i=baseName.find('<'); i!=DString::npos) baseName=baseName.left(i);
4399 return (isFriendClass() &&
4400 (fcd=getClass(baseName)) && fcd->isLinkable());
4401}
bool isFriendClass() const override
ClassDef * getClass(const DString &n)

References DString::find(), getClass(), isFriendClass(), Definition::isLinkable(), DString::left(), DefinitionMixin< MemberDefMutable >::name(), and DString::npos.

Referenced by isBriefSectionVisible(), and writeDeclaration().

◆ isEnumerate()

bool MemberDefImpl::isEnumerate ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5249 of file memberdef.cpp.

5250{
5251 return m_mtype==MemberType::Enumeration;
5252}

References m_mtype.

Referenced by _writeEnumValues(), displayDefinition(), getDeclType(), hasDetailedDescription(), warnIfUndocumented(), and writeDocumentation().

◆ isEnumStruct()

bool MemberDefImpl::isEnumStruct ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5470 of file memberdef.cpp.

5471{
5472 return m_memSpec.isEnumStruct();
5473}

References m_memSpec.

Referenced by getDeclType(), and writeDocumentation().

◆ isEnumValue()

bool MemberDefImpl::isEnumValue ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5254 of file memberdef.cpp.

5255{
5256 return m_mtype==MemberType::EnumValue;
5257}

References m_mtype.

Referenced by displayDefinition(), and writeDocumentation().

◆ isEvent()

bool MemberDefImpl::isEvent ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5305 of file memberdef.cpp.

5306{
5307 return m_mtype==MemberType::Event;
5308}

References m_mtype.

Referenced by writeDeclaration().

◆ isExplicit()

bool MemberDefImpl::isExplicit ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5330 of file memberdef.cpp.

5331{
5332 return m_memSpec.isExplicit();
5333}

References m_memSpec.

Referenced by getLabels().

◆ isExternal()

bool MemberDefImpl::isExternal ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5563 of file memberdef.cpp.

5564{
5565 return m_explExt;
5566}

References m_explExt.

Referenced by getLabels().

◆ isFinal()

bool MemberDefImpl::isFinal ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5400 of file memberdef.cpp.

5401{
5402 return m_memSpec.isFinal();
5403}

References m_memSpec.

Referenced by _computeLinkableInProject(), getLabels(), hasDetailedDescription(), isBriefSectionVisible(), and writeDeclaration().

◆ isForeign()

bool MemberDefImpl::isForeign ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5315 of file memberdef.cpp.

5316{
5317 return m_related == Relationship::Foreign;
5318}

References m_related.

Referenced by isRelatedOrFriend().

◆ isFriend()

bool MemberDefImpl::isFriend ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5290 of file memberdef.cpp.

5291{
5292 return m_mtype==MemberType::Friend;
5293}

References m_mtype.

Referenced by getLabels(), hasDetailedDescription(), isBriefSectionVisible(), isCallable(), isFriendClass(), isNotFriend(), isRelatedOrFriend(), and warnIfUndocumentedParams().

◆ isFriendClass()

bool MemberDefImpl::isFriendClass ( ) const
overridevirtual

Implements MemberDef.

Definition at line 6514 of file memberdef.cpp.

6515{
6516 return isFriend() && isTypeAClassFriend(m_type);
6517}
bool isTypeAClassFriend(const DString &type)
Definition types.h:923

References isFriend(), isTypeAClassFriend(), and m_type.

Referenced by isDocumentedFriendClass(), and warnIfUndocumented().

◆ isFriendToHide()

bool MemberDefImpl::isFriendToHide ( ) const
overridevirtual

Implements MemberDef.

Definition at line 6507 of file memberdef.cpp.

6508{
6509 bool hideFriendCompounds = Config_getBool(HIDE_FRIEND_COMPOUNDS);
6510 bool isFriendToHide = hideFriendCompounds && isTypeAClassFriend(m_type);
6511 return isFriendToHide;
6512}
bool isFriendToHide() const override

References Config_getBool, isFriendToHide(), isTypeAClassFriend(), and m_type.

Referenced by isFriendToHide(), isNotFriend(), and isRelatedOrFriend().

◆ isFunction()

bool MemberDefImpl::isFunction ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5274 of file memberdef.cpp.

5275{
5276 return m_mtype==MemberType::Function;
5277}

References m_mtype.

Referenced by _hasVisibleCallerGraph(), _hasVisibleCallGraph(), isCallable(), isFunctionOrSignalSlot(), isObjCMethod(), warnIfUndocumentedParams(), and writeDocumentation().

◆ isFunctionOrSignalSlot()

bool MemberDefImpl::isFunctionOrSignalSlot ( ) const
overridevirtual

Implements MemberDef.

Definition at line 6525 of file memberdef.cpp.

6526{
6527 return isFunction() || isSlot() || isSignal();
6528}

References isFunction(), isSignal(), and isSlot().

◆ isFunctionPtr()

bool MemberDefImpl::isFunctionPtr ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5279 of file memberdef.cpp.

5280{
5281 return m_mtype==MemberType::Variable &&
5282 DString(argsString()).find(")(")!=DString::npos;
5283}

References argsString(), DString::find(), m_mtype, and DString::npos.

Referenced by writeMemberDocSimple().

◆ isGettable()

bool MemberDefImpl::isGettable ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5345 of file memberdef.cpp.

5346{
5347 return m_memSpec.isGettable();
5348}

References m_memSpec.

Referenced by getLabels(), and writeDeclaration().

◆ isImplementation()

bool MemberDefImpl::isImplementation ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5558 of file memberdef.cpp.

5559{
5560 return m_implOnly;
5561}

References m_implOnly.

Referenced by getLabels(), and writeDeclaration().

◆ isInitonly()

bool MemberDefImpl::isInitonly ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5420 of file memberdef.cpp.

5421{
5422 return m_memSpec.isInitonly();
5423}

References m_memSpec.

Referenced by getLabels(), and writeDeclaration().

◆ isInline()

bool MemberDefImpl::isInline ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5325 of file memberdef.cpp.

5326{
5327 return m_memSpec.isInline();
5328}

References m_memSpec.

Referenced by getLabels().

◆ isLinkable()

bool MemberDefImpl::isLinkable ( ) const
overridevirtual

Returns true iff it is possible to link to this item. This can be a link to another project imported via a tag file.

Implements Definition.

Definition at line 1962 of file memberdef.cpp.

1963{
1964 if (m_templateMaster)
1965 {
1966 return m_templateMaster->isLinkable();
1967 }
1968 else
1969 {
1970 return isLinkableInProject() || isReference();
1971 }
1972}

References Definition::isLinkable(), isLinkableInProject(), isReference(), and m_templateMaster.

Referenced by hasDetailedDescription(), visibleInIndex(), writeDocumentation(), and writeLink().

◆ isLinkableInProject()

bool MemberDefImpl::isLinkableInProject ( ) const
overridevirtual

Returns true iff it is possible to link to this item within this project.

Implements Definition.

Definition at line 1951 of file memberdef.cpp.

1952{
1953 if (m_isLinkableCached==0)
1954 {
1955 MemberDefImpl *that = const_cast<MemberDefImpl*>(this);
1957 }
1959 return m_isLinkableCached==2;
1960}
void _computeLinkableInProject()

References _computeLinkableInProject(), ASSERT, m_isLinkableCached, and MemberDefImpl().

Referenced by addListReference(), isLinkable(), writeEnumDeclaration(), and writeTagFile().

◆ isMaybeAmbiguous()

bool MemberDefImpl::isMaybeAmbiguous ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5547 of file memberdef.cpp.

5548{
5549 return m_memSpec.isMaybeAmbiguous();
5550}

References m_memSpec.

Referenced by getLabels().

◆ isMaybeDefault()

bool MemberDefImpl::isMaybeDefault ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5542 of file memberdef.cpp.

5543{
5544 return m_memSpec.isMaybeDefault();
5545}

References m_memSpec.

Referenced by getLabels().

◆ isMaybeVoid()

bool MemberDefImpl::isMaybeVoid ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5537 of file memberdef.cpp.

5538{
5539 return m_memSpec.isMaybeVoid();
5540}

References m_memSpec.

Referenced by getLabels().

◆ isMutable()

bool MemberDefImpl::isMutable ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5335 of file memberdef.cpp.

5336{
5337 return m_memSpec.isMutable();
5338}

References m_memSpec.

Referenced by getLabels().

◆ isNew()

bool MemberDefImpl::isNew ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5405 of file memberdef.cpp.

5406{
5407 return m_memSpec.isNew();
5408}

References m_memSpec.

Referenced by getLabels().

◆ isNoDiscard()

bool MemberDefImpl::isNoDiscard ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5629 of file memberdef.cpp.

5630{
5631 return m_memSpec.isNoDiscard();
5632}

References m_memSpec.

Referenced by getLabels().

◆ isNoExcept()

bool MemberDefImpl::isNoExcept ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5502 of file memberdef.cpp.

5503{
5504 return m_memSpec.isNoExcept();
5505}

References m_memSpec.

Referenced by getLabels().

◆ isNonAtomic()

bool MemberDefImpl::isNonAtomic ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5440 of file memberdef.cpp.

5441{
5442 return m_memSpec.isNonAtomic();
5443}

References m_memSpec.

Referenced by getLabels().

◆ isNotFriend()

bool MemberDefImpl::isNotFriend ( ) const
overridevirtual

Implements MemberDef.

Definition at line 6520 of file memberdef.cpp.

6521{
6522 return !(isFriend() && isFriendToHide());
6523}

References isFriend(), and isFriendToHide().

◆ isObjCMethod()

bool MemberDefImpl::isObjCMethod ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5014 of file memberdef.cpp.

5015{
5016 if (getClassDef() && getClassDef()->isObjectiveC() && isFunction()) return true;
5017 return false;
5018}

References getClassDef(), and isFunction().

Referenced by addListReference(), getDeclType(), getLabels(), isCallable(), qualifiedName(), writeDeclaration(), writeDocumentation(), writeLink(), and writeMemberDocSimple().

◆ isObjCProperty()

bool MemberDefImpl::isObjCProperty ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5020 of file memberdef.cpp.

5021{
5022 if (getClassDef() && getClassDef()->isObjectiveC() && isProperty()) return true;
5023 return false;
5024}

References getClassDef(), and isProperty().

Referenced by getLabels(), and writeDeclaration().

◆ isOptional()

bool MemberDefImpl::isOptional ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5430 of file memberdef.cpp.

5431{
5432 return m_memSpec.isOptional();
5433}

References m_memSpec.

Referenced by getLabels().

◆ isOverride()

bool MemberDefImpl::isOverride ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5415 of file memberdef.cpp.

5416{
5417 return m_memSpec.isOverride();
5418}

References m_memSpec.

Referenced by _computeLinkableInProject(), getLabels(), hasDetailedDescription(), isBriefSectionVisible(), and writeDeclaration().

◆ isPrivateGettable()

bool MemberDefImpl::isPrivateGettable ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5350 of file memberdef.cpp.

5351{
5352 return m_memSpec.isPrivateGettable();
5353}

References m_memSpec.

Referenced by getLabels(), and writeDeclaration().

◆ isPrivateSettable()

bool MemberDefImpl::isPrivateSettable ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5365 of file memberdef.cpp.

5366{
5367 return m_memSpec.isPrivateSettable();
5368}

References m_memSpec.

Referenced by getLabels(), and writeDeclaration().

◆ isProperty()

bool MemberDefImpl::isProperty ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5300 of file memberdef.cpp.

5301{
5302 return m_mtype==MemberType::Property;
5303}

References m_mtype.

Referenced by getLabels(), isCSharpProperty(), isObjCProperty(), and writeDeclaration().

◆ isProtectedGettable()

bool MemberDefImpl::isProtectedGettable ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5355 of file memberdef.cpp.

5356{
5357 return m_memSpec.isProtectedGettable();
5358}

References m_memSpec.

Referenced by getLabels(), and writeDeclaration().

◆ isProtectedSettable()

bool MemberDefImpl::isProtectedSettable ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5370 of file memberdef.cpp.

5371{
5372 return m_memSpec.isProtectedSettable();
5373}

References m_memSpec.

Referenced by getLabels(), and writeDeclaration().

◆ isPrototype()

bool MemberDefImpl::isPrototype ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5659 of file memberdef.cpp.

5660{
5661 return m_proto;
5662}

References m_proto.

◆ isPublished()

bool MemberDefImpl::isPublished ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5552 of file memberdef.cpp.

5553{
5554 return m_memSpec.isPublished();
5555}

References m_memSpec.

Referenced by getLabels().

◆ isRaisable()

bool MemberDefImpl::isRaisable ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5385 of file memberdef.cpp.

5386{
5387 return m_memSpec.isRaisable();
5388}

References m_memSpec.

Referenced by getLabels(), and writeDeclaration().

◆ isReadable()

bool MemberDefImpl::isReadable ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5390 of file memberdef.cpp.

5391{
5392 return m_memSpec.isReadable();
5393}

References m_memSpec.

Referenced by getLabels().

◆ isReadonly()

bool MemberDefImpl::isReadonly ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5517 of file memberdef.cpp.

5518{
5519 return m_memSpec.isReadonly();
5520}

References m_memSpec.

Referenced by getLabels().

◆ isReference()

bool MemberDefImpl::isReference ( ) const
overridevirtual

Returns true if this definition is imported via a tag file.

Reimplemented from DefinitionMixin< MemberDefMutable >.

Definition at line 6535 of file memberdef.cpp.

6536{
6539}
virtual bool isReference() const =0
bool isReference() const override

References Definition::isReference(), DefinitionMixin< Base >::isReference(), and m_templateMaster.

Referenced by _computeLinkableInProject(), isDetailedSectionVisible(), isLinkable(), warnIfUndocumented(), warnIfUndocumentedParams(), and writeDeclaration().

◆ isReimplementedBy()

bool MemberDefImpl::isReimplementedBy ( const ClassDef * cd) const
overridevirtual

Implements MemberDef.

Definition at line 1648 of file memberdef.cpp.

1649{
1650 if (cd)
1651 {
1652 for (const auto &md : m_redefinedBy)
1653 {
1654 const ClassDef *mcd = md->getClassDef();
1655 if (mcd)
1656 {
1657 if (cd==mcd || cd->isBaseClass(mcd,true))
1658 {
1659 return true;
1660 }
1661 }
1662 }
1663 }
1664 return false;
1665}
virtual int isBaseClass(const ClassDef *bcd, bool followInstances, const DString &templSpec=DString()) const =0
Returns true iff bcd is a direct or indirect base class of this class.

References ClassDef::isBaseClass(), and m_redefinedBy.

◆ isRelated()

bool MemberDefImpl::isRelated ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5310 of file memberdef.cpp.

5311{
5312 return m_related == Relationship::Related;
5313}

References m_related.

Referenced by addListReference(), getLabels(), isRelatedOrFriend(), and writeLink().

◆ isRelatedOrFriend()

bool MemberDefImpl::isRelatedOrFriend ( ) const
overridevirtual

Implements MemberDef.

Definition at line 6530 of file memberdef.cpp.

6531{
6532 return isRelated() || isForeign() || (isFriend() && !isFriendToHide());
6533}
bool isForeign() const override

References isForeign(), isFriend(), isFriendToHide(), and isRelated().

◆ isRemovable()

bool MemberDefImpl::isRemovable ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5380 of file memberdef.cpp.

5381{
5382 return m_memSpec.isRemovable();
5383}

References m_memSpec.

Referenced by getLabels(), and writeDeclaration().

◆ isRequired()

bool MemberDefImpl::isRequired ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5435 of file memberdef.cpp.

5436{
5437 return m_memSpec.isRequired();
5438}

References m_memSpec.

Referenced by getLabels().

◆ isRetain()

bool MemberDefImpl::isRetain ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5455 of file memberdef.cpp.

5456{
5457 return m_memSpec.isRetain();
5458}

References m_memSpec.

Referenced by getLabels().

◆ isSealed()

bool MemberDefImpl::isSealed ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5410 of file memberdef.cpp.

5411{
5412 return m_memSpec.isSealed();
5413}

References m_memSpec.

Referenced by getLabels().

◆ isSequence()

bool MemberDefImpl::isSequence ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5264 of file memberdef.cpp.

5265{
5266 return m_mtype==MemberType::Sequence;
5267}

References m_mtype.

◆ isSettable()

bool MemberDefImpl::isSettable ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5360 of file memberdef.cpp.

5361{
5362 return m_memSpec.isSettable();
5363}

References m_memSpec.

Referenced by getLabels(), and writeDeclaration().

◆ isSignal()

bool MemberDefImpl::isSignal ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5234 of file memberdef.cpp.

5235{
5236 return m_mtype==MemberType::Signal;
5237}

References m_mtype.

Referenced by _hasVisibleCallerGraph(), _hasVisibleCallGraph(), getLabels(), isCallable(), and isFunctionOrSignalSlot().

◆ isSliceLocal()

bool MemberDefImpl::isSliceLocal ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5624 of file memberdef.cpp.

5625{
5626 return m_memSpec.isLocal();
5627}

References m_memSpec.

Referenced by displayDefinition(), and writeDocumentation().

◆ isSlot()

bool MemberDefImpl::isSlot ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5239 of file memberdef.cpp.

5240{
5241 return m_mtype==MemberType::Slot;
5242}

References m_mtype.

Referenced by _hasVisibleCallerGraph(), _hasVisibleCallGraph(), getLabels(), isCallable(), and isFunctionOrSignalSlot().

◆ isStatic()

bool MemberDefImpl::isStatic ( ) const
overridevirtual

◆ isStrong()

bool MemberDefImpl::isStrong ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5465 of file memberdef.cpp.

5466{
5467 return m_memSpec.isStrong();
5468}

References m_memSpec.

Referenced by getDeclType(), getLabels(), getScopeString(), writeDocumentation(), and writeTagFile().

◆ isStrongEnumValue()

bool MemberDefImpl::isStrongEnumValue ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5475 of file memberdef.cpp.

5476{
5477 return m_mtype==MemberType::EnumValue &&
5478 m_enumScope &&
5480}
virtual bool isStrong() const =0

References MemberDef::isStrong(), m_enumScope, and m_mtype.

◆ isTemplateSpecialization()

bool MemberDefImpl::isTemplateSpecialization ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5568 of file memberdef.cpp.

5569{
5570 return m_tspec;
5571}

References m_tspec.

Referenced by writeDocumentation().

◆ isThreadLocal()

bool MemberDefImpl::isThreadLocal ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5340 of file memberdef.cpp.

5341{
5342 return m_memSpec.isThreadLocal();
5343}

References m_memSpec.

Referenced by getLabels().

◆ isTransient()

bool MemberDefImpl::isTransient ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5532 of file memberdef.cpp.

5533{
5534 return m_memSpec.isTransient();
5535}

References m_memSpec.

Referenced by getLabels().

◆ isTypeAlias()

bool MemberDefImpl::isTypeAlias ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5487 of file memberdef.cpp.

5488{
5489 return m_memSpec.isAlias();
5490}

References m_memSpec.

Referenced by getDeclType(), writeDeclaration(), and writeDocumentation().

◆ isTypedef()

bool MemberDefImpl::isTypedef ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5259 of file memberdef.cpp.

5260{
5261 return m_mtype==MemberType::Typedef;
5262}

References m_mtype.

Referenced by fieldType(), getDeclType(), writeDeclaration(), and writeDocumentation().

◆ isTypedefValCached()

bool MemberDefImpl::isTypedefValCached ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5808 of file memberdef.cpp.

5809{
5810 return m_isTypedefValCached;
5811}

References m_isTypedefValCached.

◆ isUNOProperty()

bool MemberDefImpl::isUNOProperty ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5512 of file memberdef.cpp.

5513{
5514 return m_memSpec.isProperty();
5515}

References m_memSpec.

Referenced by getLabels().

◆ isUnretained()

bool MemberDefImpl::isUnretained ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5482 of file memberdef.cpp.

5483{
5484 return m_memSpec.isUnretained();
5485}

References m_memSpec.

Referenced by getLabels().

◆ isVariable()

bool MemberDefImpl::isVariable ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5244 of file memberdef.cpp.

5245{
5246 return m_mtype==MemberType::Variable;
5247}

References m_mtype.

Referenced by writeDocumentation(), and writeMemberDocSimple().

◆ isWeak()

bool MemberDefImpl::isWeak ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5460 of file memberdef.cpp.

5461{
5462 return m_memSpec.isWeak();
5463}

References m_memSpec.

Referenced by getLabels().

◆ isWritable()

bool MemberDefImpl::isWritable ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5395 of file memberdef.cpp.

5396{
5397 return m_memSpec.isWritable();
5398}

References m_memSpec.

Referenced by getLabels().

◆ livesInsideEnum()

bool MemberDefImpl::livesInsideEnum ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5619 of file memberdef.cpp.

5620{
5621 return m_livesInsideEnum;
5622}

References m_livesInsideEnum.

Referenced by setEnumScope().

◆ makeForeign()

void MemberDefImpl::makeForeign ( )
overridevirtual

Implements MemberDefMutable.

Definition at line 5963 of file memberdef.cpp.

5964{
5965 m_related = Relationship::Foreign;
5967}

References m_isLinkableCached, and m_related.

◆ makeImplementationDetail()

void MemberDefImpl::makeImplementationDetail ( )
overridevirtual

Implements MemberDefMutable.

Definition at line 6049 of file memberdef.cpp.

6050{
6051 m_implOnly=true;
6052}

References m_implOnly.

◆ makeRelated()

void MemberDefImpl::makeRelated ( )
overridevirtual

Implements MemberDefMutable.

Definition at line 5957 of file memberdef.cpp.

5958{
5959 m_related = Relationship::Related;
5961}

References m_isLinkableCached, and m_related.

◆ memberDeclaration()

MemberDef * MemberDefImpl::memberDeclaration ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5834 of file memberdef.cpp.

5835{
5836 return m_memDec;
5837}

References m_memDec.

◆ memberDefinition()

MemberDef * MemberDefImpl::memberDefinition ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5829 of file memberdef.cpp.

5830{
5831 return m_memDef;
5832}

References m_memDef.

◆ memberType()

MemberType MemberDefImpl::memberType ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5229 of file memberdef.cpp.

5230{
5231 return m_mtype;
5232}

References m_mtype.

Referenced by codeSymbolType().

◆ memberTypeName()

DString MemberDefImpl::memberTypeName ( ) const
overridevirtual

Implements MemberDef.

Definition at line 4161 of file memberdef.cpp.

4162{
4163 if (m_mtype == MemberType::Define)
4164 {
4165 return "macro definition";
4166 }
4167 else if (m_mtype == MemberType::Enumeration)
4168 {
4169 return "enumeration";
4170 }
4171 return to_string_lower(m_mtype);
4172}

References m_mtype.

Referenced by warnIfUndocumented().

◆ mergeMemberSpecifiers()

void MemberDefImpl::mergeMemberSpecifiers ( TypeSpecifier s)
overridevirtual

Implements MemberDefMutable.

Definition at line 5907 of file memberdef.cpp.

5908{
5909 m_memSpec.merge(s);
5910}

References m_memSpec.

◆ moveArgumentList()

void MemberDefImpl::moveArgumentList ( std::unique_ptr< ArgumentList > al)
overridevirtual

Implements MemberDefMutable.

Definition at line 4953 of file memberdef.cpp.

4954{
4955 m_defArgList = *al;
4956}

References m_defArgList.

◆ moveDeclArgumentList()

void MemberDefImpl::moveDeclArgumentList ( std::unique_ptr< ArgumentList > al)
overridevirtual

Implements MemberDefMutable.

Definition at line 4958 of file memberdef.cpp.

4959{
4960 m_declArgList = *al;
4961}

References m_declArgList.

◆ moveTo()

void MemberDefImpl::moveTo ( Definition * scope)
overridevirtual

Implements MemberDef.

Definition at line 1593 of file memberdef.cpp.

1594{
1595 setOuterScope(scope);
1597 {
1598 m_classDef = toClassDef(scope);
1599 }
1600 else if (scope->definitionType()==Definition::TypeFile)
1601 {
1602 m_fileDef = toFileDef(scope);
1603 }
1604 else if (scope->definitionType()==Definition::TypeModule)
1605 {
1606 m_moduleDef = toModuleDef(scope);
1607 }
1608 else if (scope->definitionType()==Definition::TypeNamespace)
1609 {
1610 m_nspace = toNamespaceDef(scope);
1611 }
1614}
void setOuterScope(Definition *def) override
FileDef * toFileDef(Definition *d)
Definition filedef.cpp:2054
ModuleDef * toModuleDef(Definition *d)
NamespaceDef * toNamespaceDef(Definition *d)

References Definition::definitionType(), m_classDef, m_fileDef, m_isConstructorCached, m_isLinkableCached, m_moduleDef, m_nspace, DefinitionMixin< MemberDefMutable >::setOuterScope(), toClassDef(), toFileDef(), toModuleDef(), toNamespaceDef(), Definition::TypeClass, Definition::TypeFile, Definition::TypeModule, and Definition::TypeNamespace.

◆ numberOfFlowKeyWords()

int MemberDefImpl::numberOfFlowKeyWords ( ) const
overridevirtual

Implements MemberDef.

Definition at line 6200 of file memberdef.cpp.

6201{
6202 return m_numberOfFlowKW;
6203}

References m_numberOfFlowKW.

◆ objCMethodName()

DString MemberDefImpl::objCMethodName ( bool localLink,
bool showStatic ) const
overridevirtual

Implements MemberDef.

Definition at line 5067 of file memberdef.cpp.

5068{
5069 DString qm;
5070 if (showStatic)
5071 {
5072 if (isStatic()) qm="+ "; else qm="- ";
5073 }
5074 qm+=name();
5075 if (!localLink) // link to method of same class
5076 {
5077 qm+=" (";
5078 qm+=getClassDef()->name();
5079 qm+=")";
5080 }
5081 return qm;
5082}

References getClassDef(), isStatic(), Definition::name(), and DefinitionMixin< MemberDefMutable >::name().

◆ overrideCallerGraph()

void MemberDefImpl::overrideCallerGraph ( bool e)
overridevirtual

Implements MemberDefMutable.

Definition at line 4986 of file memberdef.cpp.

4987{
4989 if (e) Doxygen::parseSourcesNeeded = true;
4990}
static bool parseSourcesNeeded
Definition doxygen.h:116

References m_hasCallerGraph, and Doxygen::parseSourcesNeeded.

◆ overrideCallGraph()

void MemberDefImpl::overrideCallGraph ( bool e)
overridevirtual

Implements MemberDefMutable.

Definition at line 4980 of file memberdef.cpp.

4981{
4983 if (e) Doxygen::parseSourcesNeeded = true;
4984}

References m_hasCallGraph, and Doxygen::parseSourcesNeeded.

◆ overrideEnumValues()

void MemberDefImpl::overrideEnumValues ( bool e)
overridevirtual

Implements MemberDefMutable.

Definition at line 5004 of file memberdef.cpp.

5005{
5007}

References m_hasEnumValues.

◆ overrideInlineSource()

void MemberDefImpl::overrideInlineSource ( bool e)
overridevirtual

Implements MemberDefMutable.

Definition at line 5009 of file memberdef.cpp.

5010{
5012}

References m_hasInlineSource.

◆ overrideReferencedByRelation()

void MemberDefImpl::overrideReferencedByRelation ( bool e)
overridevirtual

Implements MemberDefMutable.

Definition at line 4992 of file memberdef.cpp.

4993{
4995 if (e) Doxygen::parseSourcesNeeded = true;
4996}

References m_hasReferencedByRelation, and Doxygen::parseSourcesNeeded.

◆ overrideReferencesRelation()

void MemberDefImpl::overrideReferencesRelation ( bool e)
overridevirtual

Implements MemberDefMutable.

Definition at line 4998 of file memberdef.cpp.

4999{
5001 if (e) Doxygen::parseSourcesNeeded = true;
5002}

References m_hasReferencesRelation, and Doxygen::parseSourcesNeeded.

◆ protection()

Protection MemberDefImpl::protection ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5224 of file memberdef.cpp.

5225{
5226 return m_prot;
5227}

References m_prot.

Referenced by getLabels(), hasDetailedDescription(), isBriefSectionVisible(), and writeDeclaration().

◆ qualifiedName()

DString MemberDefImpl::qualifiedName ( ) const
overridevirtual

Returns the fully qualified name of this definition

Reimplemented from DefinitionMixin< MemberDefMutable >.

Definition at line 5032 of file memberdef.cpp.

5033{
5034 if (isObjCMethod())
5035 {
5036 DString qm;
5037 if (isStatic()) qm="+"; else qm="-";
5038 qm+="[";
5039 qm+=getClassDef()->name()+" ";
5040 qm+=name();
5041 qm+="]";
5042 return qm;
5043 }
5044 else if (m_enumScope && m_enumScope->isStrong())
5045 {
5046 return m_enumScope->qualifiedName()+
5048 localName();
5049 }
5050 else
5051 {
5053 }
5054}
virtual DString qualifiedName() const =0
DString qualifiedName() const override

References getClassDef(), DefinitionMixin< MemberDefMutable >::getLanguage(), getLanguageSpecificSeparator(), isObjCMethod(), isStatic(), MemberDef::isStrong(), DefinitionMixin< MemberDefMutable >::localName(), m_enumScope, Definition::name(), DefinitionMixin< MemberDefMutable >::name(), Definition::qualifiedName(), and DefinitionMixin< Base >::qualifiedName().

Referenced by _computeLinkableInProject(), _writeCallerGraph(), _writeCallGraph(), addListReference(), warnIfUndocumented(), warnIfUndocumentedParams(), and writeTagFile().

◆ redefineCount()

int MemberDefImpl::redefineCount ( ) const
overridevirtual

Implements MemberDef.

Definition at line 6565 of file memberdef.cpp.

6566{
6567 return m_redefineCount;
6568}

References m_redefineCount.

◆ reimplementedBy()

const MemberVector & MemberDefImpl::reimplementedBy ( ) const
overridevirtual

Implements MemberDef.

Definition at line 1643 of file memberdef.cpp.

1644{
1645 return m_redefinedBy;
1646}

References m_redefinedBy.

Referenced by _countReimplementedBy(), and _writeReimplementedBy().

◆ reimplements()

const MemberDef * MemberDefImpl::reimplements ( ) const
overridevirtual

Implements MemberDef.

Definition at line 1638 of file memberdef.cpp.

1639{
1640 return m_redefines;
1641}

References m_redefines.

Referenced by _isReimplements(), _writeReimplements(), and virtualness().

◆ relatedAlso()

ClassDef * MemberDefImpl::relatedAlso ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5584 of file memberdef.cpp.

5585{
5586 return m_relatedAlso;
5587}

References m_relatedAlso.

◆ requiresClause()

DString MemberDefImpl::requiresClause ( ) const
overridevirtual

Implements MemberDef.

Definition at line 6125 of file memberdef.cpp.

6126{
6127 return m_requiresClause;
6128}

References m_requiresClause.

◆ resolveAlias() [1/2]

const MemberDef * MemberDefImpl::resolveAlias ( ) const
inlineoverridevirtual

Implements MemberDef.

Definition at line 66 of file memberdef.cpp.

66{ return this; }

◆ resolveAlias() [2/2]

MemberDef * MemberDefImpl::resolveAlias ( )
inlineoverridevirtual

Implements MemberDef.

Definition at line 65 of file memberdef.cpp.

65{ return this; }

◆ resolveUnnamedParameters()

void MemberDefImpl::resolveUnnamedParameters ( const MemberDef * md)
overridevirtual

Implements MemberDefMutable.

Definition at line 5674 of file memberdef.cpp.

5675{
5676 ArgumentList &decAl = m_declArgList;
5677 ArgumentList &defAl = m_defArgList;
5678 const ArgumentList &decAlSrc = md->declArgumentList();
5679 const ArgumentList &defAlSrc = md->argumentList();
5680 auto decSrc = decAlSrc.begin(), defSrc = defAlSrc.begin();
5681 for (auto decIt = decAl.begin(), defIt = defAl.begin();
5682 decIt != decAl.end() && defIt != defAl.end() && decSrc != decAlSrc.end() && defSrc != defAlSrc.end();
5683 ++decIt, ++defIt, ++decSrc, ++defSrc++)
5684 {
5685 Argument &decA = *decIt;
5686 Argument &defA = *defIt;
5687 const Argument &decAS = *decSrc;
5688 const Argument &defAS = *defSrc;
5689 if (decA.name.empty())
5690 {
5691 if (!defA.name.empty())
5692 {
5693 decA.name = defA.name;
5694 }
5695 else if (!decAS.name.empty())
5696 {
5697 decA.name = decAS.name;
5698 }
5699 else if (!defAS.name.empty())
5700 {
5701 decA.name = defAS.name;
5702 }
5703 }
5704 if (defA.name.empty())
5705 {
5706 if (!decA.name.empty())
5707 {
5708 defA.name = decA.name;
5709 }
5710 else if (!decAS.name.empty())
5711 {
5712 defA.name = decAS.name;
5713 }
5714 else if (!defAS.name.empty())
5715 {
5716 defA.name = defAS.name;
5717 }
5718 }
5719 }
5720}

References MemberDef::argumentList(), ArgumentList::begin(), MemberDef::declArgumentList(), DString::empty(), ArgumentList::end(), m_declArgList, m_defArgList, and Argument::name.

◆ setAnchor()

void MemberDefImpl::setAnchor ( )
overridevirtual

Implements MemberDefMutable.

Definition at line 4430 of file memberdef.cpp.

4431{
4432 DString memAnchor = name();
4433 if (!m_args.empty()) memAnchor+=m_args;
4434 if (m_memSpec.isAlias()) // this is for backward compatibility
4435 {
4436 memAnchor.prepend(" = "+m_initializer);
4437 }
4438 memAnchor.prepend(definition()); // actually the method name is now included
4439 // twice, which is silly, but we keep it this way for backward
4440 // compatibility.
4441
4442 // include number of template arguments as well,
4443 // to distinguish between two template
4444 // specializations that only differ in the template parameters.
4446 {
4447 char buf[20];
4448 snprintf(buf,20,"%d:",static_cast<int>(m_tArgList.size()));
4449 buf[19]='\0';
4450 memAnchor.prepend(buf);
4451 }
4452 if (!m_requiresClause.empty())
4453 {
4454 memAnchor+=" "+m_requiresClause;
4455 }
4456 if (m_redefineCount>0)
4457 {
4458 char buf[20];
4459 snprintf(buf,20,":%d",m_redefineCount);
4460 buf[19]='\0';
4461 memAnchor.append(buf);
4462 }
4463
4464 // convert to md5 hash
4465 m_anc = "a"+md5str(memAnchor.view());
4466}
size_t size() const
Definition arguments.h:101
std::string_view view() const
Definition dstring.h:162
DString & append(char c)
Definition dstring.h:489
DString md5str(const std::string_view &str)
Definition md5hash.h:33

References DString::append(), definition(), DString::empty(), ArgumentList::hasParameters(), m_anc, m_args, m_initializer, m_memSpec, m_redefineCount, m_requiresClause, m_tArgList, md5str(), DefinitionMixin< MemberDefMutable >::name(), DString::prepend(), ArgumentList::size(), and DString::view().

◆ setAnonymousEnumType()

void MemberDefImpl::setAnonymousEnumType ( const MemberDef * md)
overridevirtual

Implements MemberDefMutable.

Definition at line 5996 of file memberdef.cpp.

5997{
5998 m_annEnumType = md;
5999}

References m_annEnumType.

◆ setAnonymousMemberForDeclaration()

void MemberDefImpl::setAnonymousMemberForDeclaration ( const MemberDef * md)
overridevirtual

Implements MemberDefMutable.

Definition at line 6001 of file memberdef.cpp.

6002{
6003 m_annMemberForDecl = md;
6004}

References m_annMemberForDecl.

◆ setAnonymousMemberForDetails()

void MemberDefImpl::setAnonymousMemberForDetails ( const MemberDef * md)
overridevirtual

Implements MemberDefMutable.

Definition at line 6006 of file memberdef.cpp.

6007{
6009}

References m_annMemberForDetails.

◆ setArgsString()

void MemberDefImpl::setArgsString ( const DString & as)
overridevirtual

Implements MemberDefMutable.

Definition at line 5974 of file memberdef.cpp.

5975{
5976 m_args = as;
5977}

References m_args.

◆ setBitfields()

void MemberDefImpl::setBitfields ( const DString & s)
overridevirtual

Implements MemberDefMutable.

Definition at line 5929 of file memberdef.cpp.

5930{
5931 m_bitfields = DString(s).simplifyWhiteSpace();
5932}
DString simplifyWhiteSpace() const
return a copy of this string with leading and trailing whitespace removed and multiple internal white...
Definition dstring.cpp:127

References m_bitfields, and DString::simplifyWhiteSpace().

◆ setBriefDescription()

void MemberDefImpl::setBriefDescription ( const DString & b,
const DString & briefFile,
int briefLine )
overridevirtual

Sets the brief description of this definition to b. A dot is added to the sentence if not available.

Reimplemented from DefinitionMixin< MemberDefMutable >.

Definition at line 1923 of file memberdef.cpp.

1924{
1927}
virtual DString briefFile() const =0
virtual int briefLine() const =0
void setBriefDescription(const DString &brief, const DString &briefFile, int briefLine) override

References DefinitionMixin< MemberDefMutable >::briefFile(), DefinitionMixin< MemberDefMutable >::briefLine(), m_isLinkableCached, and DefinitionMixin< Base >::setBriefDescription().

◆ setCategory()

void MemberDefImpl::setCategory ( ClassDef * def)
overridevirtual

Implements MemberDefMutable.

Definition at line 6095 of file memberdef.cpp.

6096{
6097 m_category = def;
6098}

References m_category.

◆ setCategoryRelation()

void MemberDefImpl::setCategoryRelation ( const MemberDef * md)
overridevirtual

Implements MemberDefMutable.

Definition at line 6105 of file memberdef.cpp.

6106{
6107 m_categoryRelation = md;
6108}

References m_categoryRelation.

◆ setClassDefOfAnonymousType()

void MemberDefImpl::setClassDefOfAnonymousType ( const ClassDef * cd)
overridevirtual

Implements MemberDefMutable.

Definition at line 2033 of file memberdef.cpp.

2034{
2035 m_anonymousType = cd;
2036}

References m_anonymousType.

◆ setDeclFile()

void MemberDefImpl::setDeclFile ( const DString & df,
int line,
size_t column )
overridevirtual

Implements MemberDefMutable.

Definition at line 6037 of file memberdef.cpp.

6038{
6039 m_declFileName = df;
6040 m_declLine = line;
6041 m_declColumn = column;
6042}

References m_declColumn, m_declFileName, and m_declLine.

Referenced by setExplicitExternal(), and setPrototype().

◆ setDefinition()

void MemberDefImpl::setDefinition ( const DString & d)
overridevirtual

Implements MemberDefMutable.

Definition at line 5873 of file memberdef.cpp.

5874{
5875 m_def=d;
5876}

References m_def.

◆ setDefinitionTemplateParameterLists()

void MemberDefImpl::setDefinitionTemplateParameterLists ( const ArgumentLists & lists)
overridevirtual

Implements MemberDefMutable.

Definition at line 1975 of file memberdef.cpp.

1976{
1977 m_defTmpArgLists = lists;
1978}

References m_defTmpArgLists.

◆ setDocsForDefinition()

void MemberDefImpl::setDocsForDefinition ( bool b)
overridevirtual

Implements MemberDefMutable.

Definition at line 6065 of file memberdef.cpp.

6066{
6068}

References m_docsForDefinition.

◆ setDocTransferDone()

void MemberDefImpl::setDocTransferDone ( )
overridevirtual

Implements MemberDefMutable.

Definition at line 1929 of file memberdef.cpp.

1930{
1931 m_docTransferDone = true;
1932}

References m_docTransferDone.

◆ setDocumentation()

void MemberDefImpl::setDocumentation ( const DString & d,
const DString & docFile,
int docLine,
bool stripWhiteSpace = true )
overridevirtual

Sets the documentation of this definition to d.

Reimplemented from DefinitionMixin< MemberDefMutable >.

Definition at line 1917 of file memberdef.cpp.

1918{
1921}
virtual int docLine() const =0
virtual DString docFile() const =0
void setDocumentation(const DString &doc, const DString &docFile, int docLine, bool stripWhiteSpace=true) override
std::string_view stripWhiteSpace(std::string_view s)
Given a string view s, returns a new, narrower view on that string, skipping over any leading or trai...
Definition stringutil.h:75

References DefinitionMixin< MemberDefMutable >::docFile(), DefinitionMixin< MemberDefMutable >::docLine(), m_isLinkableCached, DefinitionMixin< Base >::setDocumentation(), and stripWhiteSpace().

◆ setDocumentedEnumValues()

void MemberDefImpl::setDocumentedEnumValues ( bool value)
overridevirtual

Implements MemberDefMutable.

Definition at line 5991 of file memberdef.cpp.

5992{
5993 m_docEnumValues=value;
5994}

References m_docEnumValues.

◆ setEnumBaseType()

void MemberDefImpl::setEnumBaseType ( const DString & type)
overridevirtual

Implements MemberDefMutable.

Definition at line 6110 of file memberdef.cpp.

6111{
6112 m_enumBaseType = type;
6113}

References m_enumBaseType.

◆ setEnumClassScope()

void MemberDefImpl::setEnumClassScope ( ClassDef * cd)
overridevirtual

Implements MemberDefMutable.

Definition at line 5984 of file memberdef.cpp.

5985{
5986 m_classDef = cd;
5989}

References m_classDef, m_isConstructorCached, and m_isLinkableCached.

◆ setEnumScope()

void MemberDefImpl::setEnumScope ( MemberDef * md,
bool livesInsideEnum = false )
overridevirtual

Implements MemberDefMutable.

Definition at line 4482 of file memberdef.cpp.

4483{
4484 m_enumScope=md;
4486 if (md->getGroupDef())
4487 {
4488 m_group = md->getGroupDef();
4489 m_grouppri = md->getGroupPri();
4494 }
4495}
virtual bool getGroupHasDocs() const =0
virtual GroupDef * getGroupDef()=0
virtual int getGroupStartLine() const =0
virtual Grouping::GroupPri_t getGroupPri() const =0
virtual DString getGroupFileName() const =0
bool livesInsideEnum() const override

References MemberDef::getGroupDef(), MemberDef::getGroupFileName(), MemberDef::getGroupHasDocs(), MemberDef::getGroupPri(), MemberDef::getGroupStartLine(), livesInsideEnum(), m_enumScope, m_group, m_groupFileName, m_groupHasDocs, m_grouppri, m_groupStartLine, m_isLinkableCached, and m_livesInsideEnum.

◆ setExplicitExternal()

void MemberDefImpl::setExplicitExternal ( bool b,
const DString & df,
int line,
size_t column )
overridevirtual

Implements MemberDefMutable.

Definition at line 6024 of file memberdef.cpp.

6025{
6026 m_explExt=b;
6027 if (b)
6028 {
6029 setDeclFile(df,line,column);
6030 }
6031 else
6032 {
6033 setDefFile(df,line,column);
6034 }
6035}
void setDefFile(const DString &df, int defLine, size_t defColumn) override
void setDeclFile(const DString &df, int line, size_t column) override

References m_explExt, setDeclFile(), and DefinitionMixin< MemberDefMutable >::setDefFile().

◆ setExplicitInherited()

void MemberDefImpl::setExplicitInherited ( bool b)
overridevirtual

Implements MemberDefMutable.

Definition at line 1934 of file memberdef.cpp.

1935{
1937}

References m_explicitInherited.

◆ setFileDef()

void MemberDefImpl::setFileDef ( FileDef * fd)
overridevirtual

Implements MemberDefMutable.

Definition at line 5878 of file memberdef.cpp.

5879{
5880 m_fileDef=fd;
5884}

References m_fileDef, m_isConstructorCached, m_isDestructorCached, and m_isLinkableCached.

Referenced by _writeMultiLineInitializer().

◆ setFormalTemplateArguments()

void MemberDefImpl::setFormalTemplateArguments ( const ArgumentList & al)
overridevirtual

Implements MemberDefMutable.

Definition at line 6060 of file memberdef.cpp.

6061{
6063}

References m_formalTemplateArguments.

◆ setGroupAlias()

void MemberDefImpl::setGroupAlias ( const MemberDef * md)
overridevirtual

Implements MemberDefMutable.

Definition at line 6070 of file memberdef.cpp.

6071{
6072 m_groupAlias = md;
6073}

References m_groupAlias.

◆ setGroupDef()

void MemberDefImpl::setGroupDef ( GroupDef * gd,
Grouping::GroupPri_t pri,
const DString & fileName,
int startLine,
bool hasDocs,
MemberDef * member = nullptr )
overridevirtual

Implements MemberDefMutable.

Definition at line 4468 of file memberdef.cpp.

4471{
4472 //printf("%s MemberDefImpl::setGroupDef(%s)\n",qPrint(name()),qPrint(gd->name()));
4473 m_group=gd;
4474 m_grouppri=pri;
4475 m_groupFileName=fileName;
4476 m_groupStartLine=startLine;
4477 m_groupHasDocs=hasDocs;
4478 m_groupMember=member;
4480}

References m_group, m_groupFileName, m_groupHasDocs, m_groupMember, m_grouppri, m_groupStartLine, and m_isLinkableCached.

◆ setHidden()

void MemberDefImpl::setHidden ( bool b)
overridevirtual

Reimplemented from DefinitionMixin< MemberDefMutable >.

Definition at line 1945 of file memberdef.cpp.

1946{
1949}
void setHidden(bool b) override

References m_isLinkableCached, and DefinitionMixin< Base >::setHidden().

◆ setInbodyDocumentation()

void MemberDefImpl::setInbodyDocumentation ( const DString & d,
const DString & docFile,
int docLine )
overridevirtual

Set the documentation that was found inside the body of an item. If there was already some documentation set, the new documentation will be appended.

Reimplemented from DefinitionMixin< MemberDefMutable >.

Definition at line 1939 of file memberdef.cpp.

1940{
1943}
virtual DString inbodyFile() const =0
virtual int inbodyLine() const =0
void setInbodyDocumentation(const DString &doc, const DString &docFile, int docLine) override

References DefinitionMixin< MemberDefMutable >::inbodyFile(), DefinitionMixin< MemberDefMutable >::inbodyLine(), m_isLinkableCached, and DefinitionMixin< Base >::setInbodyDocumentation().

◆ setIncludeFile()

void MemberDefImpl::setIncludeFile ( FileDef * fd,
const DString & incName,
bool local,
bool force )
overridevirtual

Implements MemberDefMutable.

Definition at line 6496 of file memberdef.cpp.

6498{
6499 if (!force || includeName.empty()) return;
6500 //printf("MemberDefImpl::setIncludeFile(%p,%s,%d,%d)\n",fd,includeName,local,force);
6501 if (!m_incInfo) m_incInfo = std::make_unique<IncludeInfo>();
6502 m_incInfo->fileDef = fd;
6503 m_incInfo->includeName = includeName;
6505}
@ IncludeLocal
Definition filedef.h:47
@ IncludeSystem
Definition filedef.h:46

References DString::empty(), IncludeLocal, IncludeSystem, and m_incInfo.

◆ setInheritsDocsFrom()

void MemberDefImpl::setInheritsDocsFrom ( const MemberDef * md)
overridevirtual

Implements MemberDefMutable.

Definition at line 5969 of file memberdef.cpp.

5970{
5971 m_docProvider = md;
5972}

References m_docProvider.

◆ setInitializer()

void MemberDefImpl::setInitializer ( const DString & i)
overridevirtual

Implements MemberDefMutable.

Definition at line 4576 of file memberdef.cpp.

4577{
4578 size_t indent=0;
4580 int l=static_cast<int>(m_initializer.length());
4581 int p=l-1;
4582 while (p>=0 && isspace(static_cast<uint8_t>(m_initializer.at(p)))) p--;
4586
4587 //printf("%s::setInitializer(%s)\n",qPrint(name()),qPrint(m_initializer));
4588}
int contains(char c, bool cs=true) const
Definition dstring.cpp:85
const DString & initializer() const override
DString detab(const DString &s, size_t &refIndent)
Definition util.cpp:5207
void stripIndentationVerbatim(DString &doc, size_t indentationLevel, bool skipFirstLine)
Definition util.cpp:4785

References DString::at(), DString::contains(), detab(), initializer(), DString::left(), DString::length(), m_initializer, m_initLines, and stripIndentationVerbatim().

◆ setMaxInitLines()

void MemberDefImpl::setMaxInitLines ( int lines)
overridevirtual

Implements MemberDefMutable.

Definition at line 5934 of file memberdef.cpp.

5935{
5936 if (lines!=-1)
5937 {
5938 m_userInitLines=lines;
5939 }
5940}

References m_userInitLines.

◆ setMemberClass()

void MemberDefImpl::setMemberClass ( ClassDef * cd)
overridevirtual

◆ setMemberDeclaration()

void MemberDefImpl::setMemberDeclaration ( MemberDef * md)
overridevirtual

Implements MemberDefMutable.

Definition at line 6085 of file memberdef.cpp.

6086{
6087 m_memDec=md;
6088}

References m_memDec.

◆ setMemberDefinition()

void MemberDefImpl::setMemberDefinition ( MemberDef * md)
overridevirtual

Implements MemberDefMutable.

Definition at line 6080 of file memberdef.cpp.

6081{
6082 m_memDef=md;
6083}

References m_memDef.

◆ setMemberGroup()

void MemberDefImpl::setMemberGroup ( MemberGroup * grp)
overridevirtual

Implements MemberDef.

Definition at line 4416 of file memberdef.cpp.

4417{
4418 m_memberGroup = grp;
4419}

References m_memberGroup.

◆ setMemberGroupId()

void MemberDefImpl::setMemberGroupId ( int id)
overridevirtual

Implements MemberDefMutable.

Definition at line 6044 of file memberdef.cpp.

6045{
6046 m_grpId=id;
6047}
virtual DString id() const =0

References DefinitionMixin< MemberDefMutable >::id(), and m_grpId.

◆ setMemberSpecifiers()

void MemberDefImpl::setMemberSpecifiers ( TypeSpecifier s)
overridevirtual

Implements MemberDefMutable.

Definition at line 5897 of file memberdef.cpp.

5898{
5899 m_memSpec=s;
5900}

References m_memSpec.

◆ setMemberType()

void MemberDefImpl::setMemberType ( MemberType t)
overridevirtual

Implements MemberDefMutable.

Definition at line 5867 of file memberdef.cpp.

5868{
5869 m_mtype=t;
5871}

References m_isLinkableCached, and m_mtype.

◆ setModuleDef()

void MemberDefImpl::setModuleDef ( ModuleDef * mod)
overridevirtual

Implements MemberDefMutable.

Definition at line 5886 of file memberdef.cpp.

5887{
5888 m_moduleDef=mod;
5889}

References m_moduleDef.

◆ setNamespace()

void MemberDefImpl::setNamespace ( NamespaceDef * nd)
overridevirtual

Implements MemberDefMutable.

Definition at line 4505 of file memberdef.cpp.

4506{
4507 m_nspace=nd;
4508 setOuterScope(nd);
4509}

References m_nspace, and DefinitionMixin< MemberDefMutable >::setOuterScope().

◆ setProtection()

void MemberDefImpl::setProtection ( Protection p)
overridevirtual

Implements MemberDefMutable.

Definition at line 5891 of file memberdef.cpp.

5892{
5893 m_prot=p;
5895}

References m_isLinkableCached, and m_prot.

◆ setPrototype()

void MemberDefImpl::setPrototype ( bool p,
const DString & df,
int line,
size_t column )
overridevirtual

Implements MemberDefMutable.

Definition at line 6011 of file memberdef.cpp.

6012{
6013 m_proto=p;
6014 if (p)
6015 {
6016 setDeclFile(df,line,column);
6017 }
6018 else
6019 {
6020 setDefFile(df,line,column);
6021 }
6022}

References m_proto, setDeclFile(), and DefinitionMixin< MemberDefMutable >::setDefFile().

◆ setReadAccessor()

void MemberDefImpl::setReadAccessor ( const DString & r)
overridevirtual

Implements MemberDefMutable.

Definition at line 5942 of file memberdef.cpp.

5943{
5944 m_read=r;
5945}

References m_read.

◆ setRedefineCount()

void MemberDefImpl::setRedefineCount ( int count)
overridevirtual

Implements MemberDefMutable.

Definition at line 6570 of file memberdef.cpp.

6571{
6572 m_redefineCount=count;
6573}

References m_redefineCount.

◆ setReimplements()

void MemberDefImpl::setReimplements ( MemberDef * md)
overridevirtual

Implements MemberDefMutable.

Definition at line 1617 of file memberdef.cpp.

1618{
1619 m_redefines = md;
1620}

References m_redefines.

◆ setRelatedAlso()

void MemberDefImpl::setRelatedAlso ( ClassDef * cd)
overridevirtual

Implements MemberDefMutable.

Definition at line 5979 of file memberdef.cpp.

5980{
5981 m_relatedAlso=cd;
5982}

References m_relatedAlso.

◆ setRequiresClause()

void MemberDefImpl::setRequiresClause ( const DString & req)
overridevirtual

Implements MemberDefMutable.

Definition at line 6120 of file memberdef.cpp.

6121{
6122 m_requiresClause = req;
6123}

References m_requiresClause.

◆ setSectionList()

void MemberDefImpl::setSectionList ( const Definition * container,
const MemberList * sl )
overridevirtual

Implements MemberDefMutable.

Definition at line 4648 of file memberdef.cpp.

4649{
4650 //printf("MemberDefImpl::setSectionList(%s,%p) name=%s\n",qPrint(d->name()),sl,qPrint(name()));
4651 m_sectionMap.emplace(container,sl);
4652}

References m_sectionMap.

◆ setTagInfo()

void MemberDefImpl::setTagInfo ( const TagInfo * i)
overridevirtual

Implements MemberDefMutable.

Definition at line 5056 of file memberdef.cpp.

5057{
5058 if (ti)
5059 {
5060 //printf("%s: Setting tag name=%s anchor=%s\n",qPrint(name()),qPrint(ti->tagName),qPrint(ti->anchor));
5061 m_anc=ti->anchor;
5062 setReference(ti->tagName);
5064 }
5065}
void setReference(const DString &r) override
DString stripExtension(const DString &fName)
Definition util.cpp:3964

References TagInfo::anchor, TagInfo::fileName, m_anc, m_explicitOutputFileBase, DefinitionMixin< MemberDefMutable >::setReference(), stripExtension(), and TagInfo::tagName.

◆ setTemplateMaster()

void MemberDefImpl::setTemplateMaster ( const MemberDef * mt)
overridevirtual

Implements MemberDefMutable.

Definition at line 6054 of file memberdef.cpp.

6055{
6058}

References m_isLinkableCached, and m_templateMaster.

◆ setTemplateSpecialization()

void MemberDefImpl::setTemplateSpecialization ( bool b)
overridevirtual

Implements MemberDefMutable.

Definition at line 5952 of file memberdef.cpp.

5953{
5954 m_tspec=b;
5955}

References m_tspec.

◆ setType()

void MemberDefImpl::setType ( const DString & t)
overridevirtual

Implements MemberDefMutable.

Definition at line 4968 of file memberdef.cpp.

4969{
4970 m_type = t;
4971}

References m_type.

◆ setTypeConstraints()

void MemberDefImpl::setTypeConstraints ( const ArgumentList & al)
overridevirtual

Implements MemberDefMutable.

Definition at line 4963 of file memberdef.cpp.

4964{
4965 m_typeConstraints = al;
4966}

References m_typeConstraints.

◆ setVhdlSpecifiers()

void MemberDefImpl::setVhdlSpecifiers ( VhdlSpecifier s)
overridevirtual

Implements MemberDefMutable.

Definition at line 5902 of file memberdef.cpp.

5903{
5904 m_vhdlSpec=s;
5905}

References m_vhdlSpec.

◆ setWriteAccessor()

void MemberDefImpl::setWriteAccessor ( const DString & w)
overridevirtual

Implements MemberDefMutable.

Definition at line 5947 of file memberdef.cpp.

5948{
5949 m_write=w;
5950}

References m_write.

◆ sourceRefName()

DString MemberDefImpl::sourceRefName ( ) const
overridevirtual

Implements MemberDef.

Definition at line 1683 of file memberdef.cpp.

1684{
1685 DString n = name();
1686 DString s = getScopeString();
1687
1688 if (!s.empty())
1689 {
1690 n.prepend(s+"::");
1691 }
1692 else if (isStatic() && getFileDef())
1693 {
1694 n.prepend(getFileDef()->name()+":");
1695 }
1696 if (isCallable())
1697 {
1698 n.append(argsString());
1699 }
1700 return n;
1701}
bool isCallable() const override
DString getScopeString() const override

References DString::append(), argsString(), DString::empty(), getFileDef(), getScopeString(), isCallable(), isStatic(), DefinitionMixin< MemberDefMutable >::name(), and DString::prepend().

◆ templateArguments()

const ArgumentList & MemberDefImpl::templateArguments ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5722 of file memberdef.cpp.

5723{
5724 return m_tArgList;
5725}

References m_tArgList.

◆ templateMaster()

const MemberDef * MemberDefImpl::templateMaster ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5798 of file memberdef.cpp.

5799{
5800 return m_templateMaster;
5801}

References m_templateMaster.

Referenced by _computeLinkableInProject(), getOutputFileBase(), and getReference().

◆ typeConstraints()

const ArgumentList & MemberDefImpl::typeConstraints ( ) const
overridevirtual

Implements MemberDef.

Definition at line 6490 of file memberdef.cpp.

6491{
6492 return m_typeConstraints;
6493}

References m_typeConstraints.

◆ typeString()

DString MemberDefImpl::typeString ( ) const
overridevirtual

Implements MemberDef.

Definition at line 5099 of file memberdef.cpp.

5100{
5101 return m_type;
5102}

References m_type.

Referenced by _computeIsDestructor(), warnIfUndocumentedParams(), and writeTagFile().

◆ virtualness()

Specifier MemberDefImpl::virtualness ( int count = 0) const
overridevirtual

Implements MemberDef.

Definition at line 4654 of file memberdef.cpp.

4655{
4656 if (count>25)
4657 {
4659 "Internal inconsistency: recursion detected in overload relation for member {}!",name());
4660 return Specifier::Normal;
4661 }
4662 Specifier v = m_virt;
4663 const MemberDef *rmd = reimplements();
4664 while (rmd && v==Specifier::Normal)
4665 {
4666 v = rmd->virtualness(count+1)==Specifier::Normal ? Specifier::Normal : Specifier::Virtual;
4667 rmd = rmd->reimplements();
4668 }
4669 return v;
4670}
virtual const MemberDef * reimplements() const =0

References DefinitionMixin< MemberDefMutable >::getDefFileName(), DefinitionMixin< MemberDefMutable >::getDefLine(), m_virt, DefinitionMixin< MemberDefMutable >::name(), MemberDef::reimplements(), reimplements(), MemberDef::virtualness(), and warn.

Referenced by getLabels().

◆ visibleInIndex()

bool MemberDefImpl::visibleInIndex ( ) const
overridevirtual

Implements MemberDef.

Definition at line 4246 of file memberdef.cpp.

4247{
4248 bool hideUndocMembers = Config_getBool(HIDE_UNDOC_MEMBERS);
4249 bool extractStatic = Config_getBool(EXTRACT_STATIC);
4250 return (!isAnonymous() &&
4251 (!hideUndocMembers || hasDocumentation()) &&
4252 (!isStatic() || extractStatic) &&
4253 isLinkable()
4254 );
4255}

References Config_getBool, hasDocumentation(), DefinitionMixin< MemberDefMutable >::isAnonymous(), isLinkable(), and isStatic().

◆ warnIfUndocumented()

void MemberDefImpl::warnIfUndocumented ( ) const
overridevirtual

Implements MemberDef.

Definition at line 4174 of file memberdef.cpp.

4175{
4176 /*
4177 * Removed bug_303020:
4178 * if (m_memberGroup) return;
4179 */
4180 const ClassDef *cd = getClassDef();
4181 const NamespaceDef *nd = getNamespaceDef();
4182 const FileDef *fd = getFileDef();
4183 const GroupDef *gd = getGroupDef();
4184 const Definition *d=nullptr;
4185 DString t;
4186 if (cd)
4187 {
4188 t=cd->compoundTypeString();
4189 d=cd;
4190 }
4191 else if (nd)
4192 {
4193 t=nd->compoundTypeString();
4194 d=nd;
4195 }
4196 else if (gd)
4197 {
4198 t="group";
4199 d=gd;
4200 }
4201 else
4202 {
4203 t="file";
4204 d=fd;
4205 }
4206 bool extractAll = Config_getBool(EXTRACT_ALL);
4207
4208 //printf("%s:warnIfUndoc: hasUserDocs=%d isFriendClass=%d protection=%d isRef=%d isDel=%d\n",
4209 // qPrint(name()),
4210 // hasUserDocumentation(),isFriendClass(),protectionLevelVisible(m_prot),isReference(),isDeleted());
4211 if ((!hasUserDocumentation() && !extractAll) &&
4212 !isFriendClass() &&
4213 name().find('@')==DString::npos && d && d->name().find('@')==DString::npos &&
4216 !isReference() && !isDeleted()
4217 )
4218 {
4219 SrcLangExt lang = getLanguage();
4220 DString sep = getLanguageSpecificSeparator(lang,true);
4221 warn_undoc(getDefFileName(),getDefLine(),"Member {}{} ({}) of {} {} is not documented.",
4223 substitute(d->name(),"::",sep));
4224 }
4225 else if (!hasDetailedDescription())
4226 {
4228 }
4229
4230 // if it is an enum, we check that its members are documented
4231 if (!extractAll && isEnumerate() && Config_getBool(WARN_IF_UNDOC_ENUM_VAL))
4232 {
4233 for (const auto &fmd : enumFieldList())
4234 {
4235 if (!fmd->isLinkableInProject())
4236 {
4237 SrcLangExt lang = getLanguage();
4238 DString sep = getLanguageSpecificSeparator(lang,true);
4239 warn(fmd->getDefFileName(),fmd->getDefLine(), "Documentation for enum member '{}{}{}' is missing.",
4240 qualifiedName(),sep,fmd->name());
4241 }
4242 }
4243 }
4244}
virtual DString compoundTypeString() const =0
Returns the type of compound as a string.
void warnIfUndocumentedParams() const override
bool hasUserDocumentation() const override
DString memberTypeName() const override
bool _isAnonymousBitField() const
bool isDeleted() const override
virtual DString compoundTypeString() const =0
#define warn_undoc(file, line, fmt,...)
Definition message.h:102

References _isAnonymousBitField(), argsString(), ClassDef::compoundTypeString(), NamespaceDef::compoundTypeString(), Config_getBool, enumFieldList(), DString::find(), getClassDef(), DefinitionMixin< MemberDefMutable >::getDefFileName(), DefinitionMixin< MemberDefMutable >::getDefLine(), getFileDef(), getGroupDef(), DefinitionMixin< MemberDefMutable >::getLanguage(), getLanguageSpecificSeparator(), getNamespaceDef(), hasDetailedDescription(), hasUserDocumentation(), isDeleted(), isEnumerate(), isFriendClass(), isReference(), m_prot, memberTypeName(), Definition::name(), DefinitionMixin< MemberDefMutable >::name(), DString::npos, protectionLevelVisible(), qualifiedName(), substitute(), warn, warn_undoc, and warnIfUndocumentedParams().

Referenced by writeDeclaration().

◆ warnIfUndocumentedParams()

void MemberDefImpl::warnIfUndocumentedParams ( ) const
overridevirtual

Implements MemberDef.

Definition at line 4336 of file memberdef.cpp.

4337{
4338 DString returnType = typeString();
4339 bool isFortran = getLanguage()==SrcLangExt::Fortran;
4340 bool isFortranSubroutine = isFortran && returnType.find("subroutine")!=DString::npos;
4341
4342 bool isVoidReturn = returnType=="void" || returnType.endsWith(" void");
4343 if (!isVoidReturn && (returnType=="auto" || returnType.endsWith(" auto")))
4344 {
4345 const ArgumentList &defArgList=isDocsForDefinition() ? argumentList() : declArgumentList();
4346 if (!defArgList.trailingReturnType().empty())
4347 {
4348 DString strippedTrailingReturn = stripTrailingReturn(defArgList.trailingReturnType());
4349 isVoidReturn = (strippedTrailingReturn=="void") || (strippedTrailingReturn.endsWith(" void"));
4350 }
4351 }
4352 if (!Config_getBool(EXTRACT_ALL) &&
4353 Config_getBool(WARN_IF_UNDOCUMENTED) &&
4354 Config_getBool(WARN_NO_PARAMDOC) &&
4355 isFunction() &&
4356 !isDeleted() &&
4357 !isReference() &&
4359 {
4361 {
4363 "parameters of member {} are not documented",
4364 qualifiedName());
4365 }
4367 hasDocumentation() && !returnType.empty() &&
4368 !( // not one of the cases where nothing is returned
4369 isVoidReturn || // void return type
4370 isFortranSubroutine || // fortran subroutine
4371 isConstructor() || // a constructor
4372 isDestructor() || // or a destructor
4373 isFriend() // or a friend
4374 )
4375 )
4376 {
4378 "return type of member {} is not documented",
4379 qualifiedName());
4380 }
4381 }
4382 if (Config_getBool(WARN_IF_DOC_ERROR) &&
4384 (isVoidReturn || // void return type
4385 isFortranSubroutine || // fortran subroutine
4386 isConstructor() || // a constructor
4387 isDestructor())) // or destructor
4388 {
4389 warn_doc_error(docFile(),docLine(),"found documented return type for {} that does not return anything",
4390 qualifiedName());
4391 }
4392}
DString trailingReturnType() const
Definition arguments.h:115
bool endsWith(const char *s) const
Definition dstring.h:617
static bool suppressDocWarnings
Definition doxygen.h:123
bool isDocsForDefinition() const override
#define warn_doc_error(file, line, fmt,...)
Definition message.h:112

References argumentList(), Config_getBool, declArgumentList(), DefinitionMixin< MemberDefMutable >::docFile(), DefinitionMixin< MemberDefMutable >::docLine(), DString::empty(), DString::endsWith(), DString::find(), DefinitionMixin< MemberDefMutable >::getLanguage(), hasDocumentation(), isConstructor(), isDeleted(), isDestructor(), isDocsForDefinition(), isFriend(), isFunction(), isReference(), m_hasDocumentedParams, m_hasDocumentedReturnType, DString::npos, qualifiedName(), stripTrailingReturn(), Doxygen::suppressDocWarnings, ArgumentList::trailingReturnType(), typeString(), and warn_doc_error.

Referenced by warnIfUndocumented(), and writeDocumentation().

◆ writeDeclaration()

void MemberDefImpl::writeDeclaration ( OutputList & ol,
const ClassDef * cd,
const NamespaceDef * nd,
const FileDef * fd,
const GroupDef * gd,
const ModuleDef * mod,
bool inGroup,
int indentLevel,
const ClassDef * inheritFrom = nullptr,
const DString & inheritId = DString(),
const DString & declAnchor = DString() ) const
overridevirtual

init.empty() && initLines==0 && // one line initializer

Implements MemberDef.

Definition at line 2233 of file memberdef.cpp.

2237{
2238 const DString memAnchor = declAnchor.empty() ? anchor() : declAnchor;
2239 //printf("> %s MemberDefImpl::writeDeclaration() inGroup=%d inheritId=%s\n",qPrint(qualifiedName()),inGroup,qPrint(inheritId));
2240
2241 // hide enum value, since they appear already as part of the enum, unless they
2242 // are explicitly grouped.
2243 if (!inGroup && m_mtype==MemberType::EnumValue) return;
2244
2245 const Definition *d=nullptr;
2246 ASSERT (cd!=nullptr || nd!=nullptr || fd!=nullptr || gd!=nullptr || mod!=nullptr); // member should belong to something
2247 if (cd) d=cd;
2248 else if (nd) d=nd;
2249 else if (fd) d=fd;
2250 else d=gd;
2251 if (d==gd || d==mod) // see bug 753608
2252 {
2253 if (getClassDef()) d = getClassDef();
2254 else if (getNamespaceDef()) d = getNamespaceDef();
2255 else if (getFileDef()) d = getFileDef();
2256 }
2257 else if (d==fd) // see issue #9850, namespace member can be shown in file scope as well
2258 {
2259 if (getNamespaceDef()) d = getNamespaceDef();
2260 }
2261 if (d==nullptr)
2262 {
2263 err("No context could be derived for member '{}'\n",name());
2264 return; // should not happen
2265 }
2266
2267 DString cname = d->name();
2268 DString cdname = d->displayName();
2269 DString cfname = getOutputFileBase();
2270
2271 // search for the last anonymous scope in the member type
2272 const ClassDef *annoClassDef=getClassDefOfAnonymousType();
2273
2275
2276 // start a new member declaration
2279 ol.startMemberItem(annoClassDef && isAnonymous() ? DString() : memAnchor, anonType, inheritId);
2280
2281
2282 // If there is no detailed description we need to write the anchor here.
2283 bool detailsVisible = hasDetailedDescription();
2284 bool writeAnchor = (inGroup || getGroupDef()==nullptr) && // only write anchors for member that have no details and are
2285 !detailsVisible && // rendered inside the group page or are not grouped at all
2286 inheritId.empty();
2287
2288 if (writeAnchor)
2289 {
2290 DString doxyArgs=argsString();
2291 DString doxyName=name();
2292 if (!cname.empty())
2293 {
2295 }
2296 ol.startDoxyAnchor(cfname,cname,memAnchor,doxyName,doxyArgs);
2297 ol.addLabel(cfname,memAnchor);
2298 }
2299
2300 if (!detailsVisible)
2301 {
2302 ol.pushGeneratorState();
2306 ol.docify("\n");
2307 ol.popGeneratorState();
2308 }
2309
2310 if (annoClassDef)
2311 {
2312 for (int j=0;j<indentLevel;j++)
2313 {
2315 }
2316 }
2317
2318 // *** write template lists
2319 if (m_tArgList.hasParameters() && getLanguage()==SrcLangExt::Cpp)
2320 {
2323 ol.endMemberTemplateParams(memAnchor,inheritId);
2324 }
2325
2326
2327 // *** write type
2328 DString ltype(m_type);
2329 auto lang = getLanguage();
2330 if (isTypedef() && lang != SrcLangExt::Slice)
2331 {
2332 ltype.prepend("typedef ");
2333 }
2334 if (isTypeAlias())
2335 {
2336 if (lang==SrcLangExt::Python)
2337 {
2338 ltype="type";
2339 }
2340 else
2341 {
2342 ltype="using";
2343 }
2344 }
2345 // strip 'friend' keyword from ltype
2346 ltype.stripPrefix("friend ");
2347 static const reg::Ex r(R"(@\d+)"); // anonymous type marker
2348 reg::Match match;
2349 std::string stype = ltype.str();
2350 bool endAnonScopeNeeded=false;
2351 LinkifyTextOptions options;
2352 options.setScope(d).setFileScope(getBodyDef()).setSelf(this);
2353 if (reg::search(stype,match,r)) // member has an anonymous type marker
2354 {
2355 //printf("name=%s annoClassDef=%p stype='%s' scopeName='%s'\n",
2356 // qPrint(name()),(void*)annoClassDef,qPrint(stype),qPrint(cname));
2357
2358 static const reg::Ex ar(R"([\w@:]*@\d+[\w@:]*)"); // anonymous type marker(s) including scope
2359 reg::Match amatch;
2360 reg::search(stype,amatch,ar);
2361 size_t ai = amatch.position();
2362 size_t al = amatch.length();
2363 const MemberDef *amd = getAnonymousEnumType();
2364 if (annoClassDef && amd==nullptr) // type is an anonymous compound
2365 {
2366 if (isAnonymous()) // anonymous type without a variable name, e.g. "struct { int x; };" or "union { int x; };"
2367 {
2368 ol.startAnonTypeScope(indentLevel);
2369 annoClassDef->writeDeclaration(ol,inGroup,indentLevel+1,inheritedFrom,inheritId);
2370 //printf(">>>>>>>>>>>>>> startMemberItem(2)\n");
2372 ol.startMemberItem(memAnchor,anonType,inheritId);
2373 for (int j=0;j< indentLevel;j++)
2374 {
2376 }
2377 ol.docify("};");
2378 endAnonScopeNeeded=true;
2379 }
2380 else
2381 {
2382 ol.writeObjectLink(annoClassDef->getReference(),annoClassDef->getOutputFileBase(),
2383 annoClassDef->anchor(),ltype.left(ai)+ltype.mid(ai+al));
2384 }
2385 }
2386 else if (amd) // type is an anonymous enum
2387 {
2388 DString typePlaceholder = " { ... } ";
2389 if (lang==SrcLangExt::Cpp)
2390 {
2391 if (amd->isEnumStruct()) typePlaceholder.prepend(" struct");
2392 else if (amd->isStrong()) typePlaceholder.prepend(" class");
2393 }
2395 amd->anchor(),ltype.left(ai)+typePlaceholder+ltype.mid(ai+al));
2396 }
2397 else // fallback if anonymous type is not found
2398 {
2399 size_t i = match.position();
2400 size_t l = match.length();
2401 ltype = ltype.left(i) + " { ... } " + removeAnonymousScopes(ltype.mid(i+l));
2402 linkifyText(TextGeneratorOLImpl(ol), ltype, options);
2403 }
2404 }
2405 else if (ltype=="@") // rename type from enum values
2406 {
2407 ltype="";
2408 }
2409 else
2410 {
2411 if (isObjCMethod())
2412 {
2413 ltype.prepend("(");
2414 ltype.append(")");
2415 }
2416 linkifyText(TextGeneratorOLImpl(ol),ltype,options);
2417 }
2418
2419 if (!ltype.empty())
2420 {
2421 ol.pushGeneratorState();
2423 ol.docify(" ");
2424 ol.popGeneratorState();
2425 }
2426
2427 if (!isAnonymous())
2428 {
2430 }
2431
2432 // *** write name
2433 if (!isAnonymous() && !_isAnonymousBitField()) // hide anonymous stuff
2434 {
2435 bool extractPrivateVirtual = Config_getBool(EXTRACT_PRIV_VIRTUAL);
2436 bool extractStatic = Config_getBool(EXTRACT_STATIC);
2437 bool visibleIfPrivate = (protectionLevelVisible(protection()) ||
2438 m_mtype==MemberType::Friend ||
2439 (m_prot==Protection::Private &&
2440 (m_virt!=Specifier::Normal || isOverride() || isFinal()) &&
2441 extractPrivateVirtual && hasDocumentation()
2442 ));
2443 //printf("Member name=`%s gd=%p md->groupDef=%p inGroup=%d isLinkable()=%d hasDocumentation=%d\n",qPrint(name()),gd,getGroupDef(),inGroup,isLinkable(),hasDocumentation());
2444 if (!name().empty() && // name valid
2445 (hasDetailedDescription() || isReference()) && // has docs
2446 visibleIfPrivate &&
2447 !(isStatic() && getClassDef()==nullptr && !extractStatic) // hidden due to static-ness
2448 )
2449 {
2450 //printf("writeLink %s->%d\n",qPrint(name),hasDocumentation());
2451 const ClassDef *rcd = cd;
2452 if (isReference() && getClassDef()) rcd = getClassDef();
2453 writeLink(ol,rcd,nd,fd,gd,mod);
2454 }
2455 else if (isDocumentedFriendClass())
2456 // if the member is an undocumented friend declaration for some class,
2457 // then maybe we can link to the class
2458 {
2459 writeLink(ol,getClass(name()),nullptr,nullptr,nullptr,nullptr);
2460 }
2461 else
2462 // there is a brief member description and brief member
2463 // descriptions are enabled or there is no detailed description.
2464 {
2465 const ClassDef *rcd = cd;
2466 if (isReference() && getClassDef()) rcd = getClassDef();
2467 writeLink(ol,rcd,nd,fd,gd,mod,true);
2468 }
2469 }
2470
2471 // *** write arguments
2472 if (!argsString().empty() && !isObjCMethod())
2473 {
2474 if (!isDefine() && !isTypedef()) ol.writeString(" ");
2475 linkifyText(TextGeneratorOLImpl(ol), // out
2476 isDefine() ?
2477 substitute(argsString(),",",", ") :
2478 isTypedef() ?
2479 substitute(argsString(),")(",") (") :
2481 LinkifyTextOptions(options)
2482 .setArgumentList(&m_defArgList)
2483 .setAutoBreak(false)
2484 .setIndentLevel(indentLevel)
2485 );
2486 }
2487
2488 // *** write bitfields
2489 if (!m_bitfields.empty()) // add bitfields
2490 {
2491 linkifyText(TextGeneratorOLImpl(ol),m_bitfields,options);
2492 }
2493 else if (hasOneLineInitializer()
2494 //!init.empty() && initLines==0 && // one line initializer
2495 //((maxInitLines>0 && userInitLines==-1) || userInitLines>0) // enabled by default or explicitly
2496 ) // add initializer
2497 {
2498 if (isTypeAlias()) // using statement
2499 {
2500 ol.writeString(" = ");
2501 linkifyText(TextGeneratorOLImpl(ol),m_initializer.simplifyWhiteSpace(),options);
2502 }
2503 else if (!isDefine())
2504 {
2505 //ol.writeString(" = ");
2506 ol.writeString(" ");
2507 linkifyText(TextGeneratorOLImpl(ol),m_initializer.simplifyWhiteSpace(),options);
2508 }
2509 else
2510 {
2512 linkifyText(TextGeneratorOLImpl(ol),m_initializer,options);
2513 }
2514 }
2515
2516
2518 {
2519 ol.startTypewriter();
2520 ol.docify(" [implementation]");
2521 ol.endTypewriter();
2522 }
2523
2524 bool extractPrivate = Config_getBool(EXTRACT_PRIVATE);
2525
2526 if (isProperty() && (isSettable() || isGettable() ||
2529 {
2530 ol.writeLatexSpacing();
2531 ol.startTypewriter();
2532 ol.docify(" [");
2533 StringVector sl;
2534
2535 if (isGettable()) sl.emplace_back("get");
2536 if (isProtectedGettable()) sl.emplace_back("protected get");
2537 if (isSettable()) sl.emplace_back("set");
2538 if (isProtectedSettable()) sl.emplace_back("protected set");
2539 if (isInitonly()) sl.emplace_back("init");
2540 if (extractPrivate)
2541 {
2542 if (isPrivateGettable()) sl.emplace_back("private get");
2543 if (isPrivateSettable()) sl.emplace_back("private set");
2544 }
2545 bool first=true;
2546 for (const auto &s : sl)
2547 {
2548 if (!first)
2549 {
2550 ol.docify(", ");
2551 }
2552 first=false;
2553 ol.docify(s);
2554 }
2555 ol.docify("]");
2556 ol.endTypewriter();
2557 }
2558
2559 if (isEvent() && (isAddable() || isRemovable() || isRaisable()))
2560 {
2561 ol.writeLatexSpacing();
2562 ol.startTypewriter();
2563 ol.docify(" [");
2564 StringVector sl;
2565 if (isAddable()) sl.emplace_back("add");
2566 if (isRemovable()) sl.emplace_back("remove");
2567 if (isRaisable()) sl.emplace_back("raise");
2568 bool first=true;
2569 for (const auto &s : sl)
2570 {
2571 if (!first)
2572 {
2573 ol.docify(", ");
2574 }
2575 first=false;
2576 ol.docify(s);
2577 }
2578 ol.docify("]");
2579 ol.endTypewriter();
2580 }
2581
2582 if (writeAnchor)
2583 {
2584 ol.endDoxyAnchor(cfname,memAnchor);
2585 }
2586
2587 //printf("endMember %s annoClassDef=%p annEnumType=%p\n",
2588 // qPrint(name()),annoClassDef,annEnumType);
2589 ol.endMemberItem(anonType);
2590 if (endAnonScopeNeeded)
2591 {
2592 ol.endAnonTypeScope(indentLevel);
2593 }
2594
2595 // write brief description
2596 if (!briefDescription().empty() &&
2597 Config_getBool(BRIEF_MEMBER_DESC)
2598 )
2599 {
2600 auto parser { createDocParser() };
2601 auto ast { validatingParseDoc(*parser.get(),
2602 briefFile(),
2603 briefLine(),
2605 this,
2607 DocOptions()
2608 .setIndexWords(inheritedFrom==nullptr)
2609 .setSingleLine(true))
2610 };
2611 if (!ast->empty())
2612 {
2613 ol.startMemberDescription(memAnchor,inheritId);
2614 ol.writeDoc(ast.get(),getOuterScope()?getOuterScope():d,this);
2615 if (detailsVisible) // add More.. link only when both brief and details are visible
2616 {
2617 if (!isAnonymous()) // hide anonymous stuff
2618 {
2619 ol.pushGeneratorState();
2621 ol.docify(" ");
2622 ol.popGeneratorState();
2623 }
2624 }
2625 // for RTF we need to add an extra empty paragraph
2626 ol.pushGeneratorState();
2628 ol.startParagraph();
2629 ol.endParagraph();
2630 ol.popGeneratorState();
2632 }
2633 }
2634
2635 ol.endMemberDeclaration(memAnchor,inheritId);
2636
2638 //printf("< %s MemberDefImpl::writeDeclaration() inGroup=%d\n",qPrint(qualifiedName()),inGroup);
2639}
virtual void writeDeclaration(OutputList &ol, bool inGroup, int indentLevel, const ClassDef *inheritedFrom, const DString &inheritId) const =0
virtual SrcLangExt getLanguage() const =0
Returns the programming language this definition was written in.
virtual bool isEnumStruct() const =0
void warnIfUndocumented() const override
bool isDefine() const override
void _writeTemplatePrefix(OutputList &ol, const Definition *def, const ArgumentList &al, bool writeReqClause=true) const
DString excpString() const override
const MemberDef * getAnonymousEnumType() const override
bool hasOneLineInitializer() const override
void writeLink(OutputList &ol, const ClassDef *cd, const NamespaceDef *nd, const FileDef *fd, const GroupDef *gd, const ModuleDef *mod, bool onlyText=false) const override
bool isEvent() const override
void writeDoc(const IDocNodeAST *ast, const Definition *ctx, const MemberDef *md, int sectionLevel=-1)
Definition outputlist.h:379
void startMemberDeclaration()
Definition outputlist.h:565
void writeLatexSpacing()
Definition outputlist.h:541
void endMemberDescription()
Definition outputlist.h:563
void endMemberDeclaration(const DString &anchor, const DString &inheritId)
Definition outputlist.h:567
void endMemberTemplateParams(const DString &anchor, const DString &inheritId)
Definition outputlist.h:495
void insertMemberAlign(bool templ=false)
Definition outputlist.h:513
void startAnonTypeScope(int i1)
Definition outputlist.h:485
void endMemberItem(OutputGenerator::MemberItemType type)
Definition outputlist.h:491
void startMemberItem(const DString &anchor, OutputGenerator::MemberItemType type, const DString &id=DString())
Definition outputlist.h:489
void startMemberDescription(const DString &anchor, const DString &inheritId=DString(), bool typ=false)
Definition outputlist.h:561
void endAnonTypeScope(int i1)
Definition outputlist.h:487
void writeNonBreakableSpace(int num)
Definition outputlist.h:622
void startMemberTemplateParams()
Definition outputlist.h:493
size_t position() const
Returns the position of the match or std::string::npos if no position is set.
Definition regex.h:166
size_t length() const
Returns the position of the match or std::string::npos if no length is set.
Definition regex.h:169
IDocParserPtr createDocParser()
factory function to create a parser
Definition docparser.cpp:59
IDocNodeASTPtr validatingParseDoc(IDocParser &parserIntf, const DString &fileName, int startLine, const Definition *ctx, const MemberDef *md, const DString &input, const DocOptions &options)
static DString combineArgsAndException(DString args, DString exception)

References _isAnonymousBitField(), _writeTemplatePrefix(), OutputList::addLabel(), Definition::anchor(), anchor(), OutputGenerator::AnonymousEnd, DString::append(), argsString(), ASSERT, briefDescription(), DefinitionMixin< MemberDefMutable >::briefFile(), DefinitionMixin< MemberDefMutable >::briefLine(), combineArgsAndException(), Config_getBool, createDocParser(), OutputList::disable(), OutputList::disableAllBut(), Definition::displayName(), Docbook, OutputList::docify(), ArgumentList::empty(), DString::empty(), OutputList::endAnonTypeScope(), OutputList::endDoxyAnchor(), OutputList::endMemberDeclaration(), OutputList::endMemberDescription(), OutputList::endMemberItem(), OutputList::endMemberTemplateParams(), OutputList::endParagraph(), OutputList::endTypewriter(), err, excpString(), getAnonymousEnumType(), DefinitionMixin< MemberDefMutable >::getBodyDef(), getClass(), getClassDef(), getClassDefOfAnonymousType(), getFileDef(), getGroupDef(), DefinitionMixin< MemberDefMutable >::getLanguage(), getLanguageSpecificSeparator(), getNamespaceDef(), DefinitionMixin< MemberDefMutable >::getOuterScope(), Definition::getOutputFileBase(), getOutputFileBase(), Definition::getReference(), hasDetailedDescription(), hasDocumentation(), hasOneLineInitializer(), ArgumentList::hasParameters(), Html, OutputList::insertMemberAlign(), isAddable(), DefinitionMixin< MemberDefMutable >::isAnonymous(), isDefine(), isDocumentedFriendClass(), MemberDef::isEnumStruct(), isEvent(), isFinal(), isGettable(), isImplementation(), isInitonly(), isObjCMethod(), isObjCProperty(), isOverride(), isPrivateGettable(), isPrivateSettable(), isProperty(), isProtectedGettable(), isProtectedSettable(), isRaisable(), isReference(), isRemovable(), isSettable(), isStatic(), MemberDef::isStrong(), isTypeAlias(), isTypedef(), Latex, DString::left(), reg::Match::length(), linkifyText(), m_bitfields, m_defArgList, m_initializer, m_mtype, m_prot, m_tArgList, m_type, m_virt, Man, DString::mid(), Definition::name(), DefinitionMixin< MemberDefMutable >::name(), OutputGenerator::Normal, OutputList::popGeneratorState(), reg::Match::position(), DString::prepend(), protection(), protectionLevelVisible(), OutputList::pushGeneratorState(), removeAnonymousScopes(), RTF, reg::search(), LinkifyTextOptions::setFileScope(), LinkifyTextOptions::setScope(), LinkifyTextOptions::setSelf(), DString::simplifyWhiteSpace(), OutputList::startAnonTypeScope(), OutputList::startDoxyAnchor(), OutputList::startMemberDeclaration(), OutputList::startMemberDescription(), OutputList::startMemberItem(), OutputList::startMemberTemplateParams(), OutputList::startParagraph(), OutputList::startTypewriter(), DString::str(), DString::stripPrefix(), substitute(), OutputGenerator::Templated, validatingParseDoc(), warnIfUndocumented(), ClassDef::writeDeclaration(), OutputList::writeDoc(), OutputList::writeLatexSpacing(), writeLink(), OutputList::writeNonBreakableSpace(), OutputList::writeObjectLink(), and OutputList::writeString().

◆ writeDocumentation()

void MemberDefImpl::writeDocumentation ( const MemberList * ml,
int memCount,
int memTotal,
OutputList & ol,
const DString & scName,
const Definition * container,
bool inGroup,
bool showEnumValues = false,
bool showInline = false ) const
overridevirtual

Writes the "detailed documentation" section of this member to all active output formats.

Implements MemberDefMutable.

Definition at line 3492 of file memberdef.cpp.

3501{
3502 // if this member is in a group find the real scope name.
3503 bool hasParameterList = false;
3504
3505 //printf("MemberDefImpl::writeDocumentation(): name='%s' hasDocs='%d' containerType=%d inGroup=%d sectionLinkable=%d\n",
3506 // qPrint(name()),hasDocs,container->definitionType(),inGroup,hasDetailedDescription());
3507
3508 //if ( !hasDocs ) return;
3509 //if (isEnumValue() && !showEnumValues) return;
3510
3511 SrcLangExt lang = getLanguage();
3512 //printf("member=%s lang=%d\n",qPrint(name()),lang);
3513 bool optVhdl = lang==SrcLangExt::VHDL;
3514 DString sep = getLanguageSpecificSeparator(lang,true);
3515
3516 DString scopeName = scName;
3517 DString memAnchor = anchor();
3518 DString ciname = container->displayName();
3519 const Definition *scopedContainer = container; // see bug 753608
3520 if (container->definitionType()==TypeGroup)
3521 {
3522 if (getClassDef()) { scopeName=getClassDef()->displayName(); scopedContainer=getClassDef(); }
3523 else if (getNamespaceDef()) { scopeName=getNamespaceDef()->displayName(); scopedContainer=getNamespaceDef(); }
3524 else if (getFileDef()) { scopeName=getFileDef()->displayName(); scopedContainer=getFileDef(); }
3525 ciname = (toGroupDef(container))->groupTitle();
3526 }
3527 else if (container->definitionType()==TypeFile && getNamespaceDef() && getNamespaceDef()->isLinkable())
3528 { // member is in a namespace, but is written as part of the file documentation
3529 // as well, so we need to make sure its anchor is unique (it is not really used).
3530 memAnchor.prepend("file_");
3531 }
3532
3533 DString cname = container->name();
3534 DString cfname = getOutputFileBase();
3535
3536 // get member name
3537 DString doxyName=name();
3538 // prepend scope if there is any. TODO: make this optional for C only docs
3539 if (!scopeName.empty())
3540 {
3541 doxyName.prepend(scopeName+sep);
3542 }
3543 DString doxyArgs=argsString();
3544
3545 DString ldef = definition();
3546 DString title = name();
3547
3548 //printf("member '%s' def='%s'\n",qPrint(name()),qPrint(ldef));
3549 if (isEnumerate())
3550 {
3551 if (title.at(0)=='@')
3552 {
3553 ldef = title = "anonymous enum";
3554 if (isSliceLocal())
3555 {
3556 ldef.prepend("local ");
3557 }
3558 if (lang==SrcLangExt::Cpp)
3559 {
3560 if (isEnumStruct()) ldef.append(" struct");
3561 else if (isStrong()) ldef.append(" class");
3562 }
3563 if (!m_enumBaseType.empty())
3564 {
3565 ldef+=" : "+m_enumBaseType;
3566 }
3567 }
3568 else
3569 {
3570 if (lang==SrcLangExt::Cpp)
3571 {
3572 if (isEnumStruct()) ldef.prepend("struct ");
3573 else if (isStrong()) ldef.prepend("class ");
3574 }
3575 ldef.prepend("enum ");
3576 if (isSliceLocal())
3577 {
3578 ldef.prepend("local ");
3579 }
3580 }
3581 }
3582 else if (isEnumValue())
3583 {
3584 if (ldef.at(0)=='@')
3585 {
3586 ldef=ldef.mid(2);
3587 }
3588 }
3589 else if (isFunction() && !isObjCMethod())
3590 {
3591 title += "()";
3592 }
3593 if (lang == SrcLangExt::Slice)
3594 {
3595 // Remove the container scope from the member name.
3596 DString prefix = scName + sep;
3597 if (size_t pos = ldef.rfind(prefix); pos != DString::npos)
3598 {
3599 ldef.remove(pos, prefix.length());
3600 }
3601 }
3602 ldef.stripPrefix("constexpr ");
3603 ldef.stripPrefix("consteval ");
3604 ldef.stripPrefix("constinit ");
3605 ldef.stripPrefix("static ");
3606
3607 //----------------------------------------
3608
3609 ol.pushGeneratorState();
3610
3611 bool htmlEndLabelTable=false;
3612 StringVector sl = getLabels(scopedContainer);
3613 auto startHtmlLabelTable = [&]()
3614 {
3615 if (!sl.empty())
3616 {
3617 ol.pushGeneratorState();
3618 ol.disableAll();
3620 ol.writeString("<table class=\"mlabels\">\n");
3621 ol.writeString(" <tr>\n");
3622 ol.writeString(" <td class=\"mlabels-left\">\n");
3623 ol.popGeneratorState();
3624 htmlEndLabelTable=true;
3625 }
3626 };
3627
3628 static const reg::Ex r(R"(@\d+)");
3629 reg::Match match;
3630 std::string sdef = ldef.str();
3631 LinkifyTextOptions options;
3632 options.setScope(scopedContainer).setFileScope(getBodyDef()).setSelf(this);
3633 if ((isVariable() || isTypedef()) && reg::search(sdef,match,r))
3634 {
3635 // find enum type and insert it in the definition
3636 bool found=false;
3637 for (const auto &vmd : *ml)
3638 {
3639 if (vmd->isEnumerate() && match.str()==vmd->name())
3640 {
3641 ol.startDoxyAnchor(cfname, cname, memAnchor, doxyName, doxyArgs);
3642 ol.startMemberDoc(ciname,name(),memAnchor,name(),memCount,memTotal,showInline);
3643 ol.addLabel(cfname, memAnchor);
3644 DString prefix = match.prefix().str();
3645 DString suffix = match.suffix().str();
3646 linkifyText(TextGeneratorOLImpl(ol),prefix,options);
3647 vmd->writeEnumDeclaration(ol,getClassDef(),getNamespaceDef(),getFileDef(),getGroupDef(),getModuleDef());
3648 linkifyText(TextGeneratorOLImpl(ol),suffix,options);
3649
3650 found=true;
3651 break;
3652 }
3653 }
3654 if (!found) // anonymous compound
3655 {
3656 const ClassDef *annoClassDef=getClassDefOfAnonymousType();
3657 DString typeName;
3658 if (annoClassDef) typeName=annoClassDef->compoundTypeString();
3659 ol.startDoxyAnchor(cfname, cname, memAnchor, doxyName, doxyArgs);
3660 ol.startMemberDoc(ciname,name(),memAnchor,title,memCount,memTotal,showInline);
3661 ol.addLabel(cfname, memAnchor);
3662 // search for the last anonymous compound name in the definition
3663
3664 startHtmlLabelTable();
3666 if (reg::search(sdef,match,reAnonymous))
3667 {
3668 static const reg::Ex ar(R"([\w@:]*@\d+[\w@:]*)");
3669 reg::Match amatch;
3670 reg::search(sdef,amatch,ar);
3671 DString prefix = amatch.prefix().str();
3672 DString suffix = removeAnonymousScopes(amatch.suffix().str());
3673 //printf("writeDocumentation(): anonymous compound in definition: sdef='%s' prefix='%s' suffix='%s' annoClassDef=%p\n",
3674 // qPrint(sdef), qPrint(prefix),qPrint(suffix),(void*)annoClassDef);
3675 const MemberDef *amd = getAnonymousEnumType();
3676 if (annoClassDef && amd==nullptr)
3677 {
3678 ol.docify(prefix);
3679 DString annTypeName = annoClassDef->displayName(true);
3680 if (suffix.empty())
3681 {
3682 suffix="::"+localName();
3683 }
3684 ol.writeObjectLink(annoClassDef->getReference(),annoClassDef->getOutputFileBase(),
3685 annoClassDef->anchor(),annTypeName);
3686 linkifyText(TextGeneratorOLImpl(ol),suffix,options);
3687 }
3688 else if (amd) // type is an anonymous enum
3689 {
3690 DString typePlaceholder = " { ... } ";
3691 if (lang==SrcLangExt::Cpp)
3692 {
3693 if (amd->isEnumStruct()) typePlaceholder.prepend(" struct");
3694 else if (amd->isStrong()) typePlaceholder.prepend(" class");
3695 }
3696 ol.writeObjectLink(amd->getReference(),amd->getOutputFileBase(),amd->anchor(),prefix+typePlaceholder+suffix);
3697 }
3698 else
3699 {
3700 prefix = match.prefix().str();
3701 suffix = removeAnonymousScopes(match.suffix().str());
3702 ol.docify(prefix);
3703 ol.docify(" ");
3705 //ol.docify(" { ... } ");
3706 linkifyText(TextGeneratorOLImpl(ol),suffix,options);
3707 }
3708 }
3709 else
3710 {
3711 linkifyText(TextGeneratorOLImpl(ol),ldef,options);
3712 }
3713 }
3714 }
3715 else // not an enum value or anonymous compound
3716 {
3717 ol.startDoxyAnchor(cfname, cname, memAnchor, doxyName, doxyArgs);
3718 ol.startMemberDoc(ciname,name(),memAnchor,title,memCount,memTotal,showInline);
3719 ol.addLabel(cfname, memAnchor);
3720
3721 if (!m_metaData.empty() && getLanguage()==SrcLangExt::Slice)
3722 {
3724 ol.docify(m_metaData);
3726 }
3727
3728 const ClassDef *cd=getClassDef();
3729 const NamespaceDef *nd=getNamespaceDef();
3730 if (!m_defTmpArgLists.empty() && lang==SrcLangExt::Cpp)
3731 // definition has explicit template parameter declarations
3732 {
3733 for (const ArgumentList &tal : m_defTmpArgLists)
3734 {
3735 if (!tal.empty())
3736 {
3738 _writeTemplatePrefix(ol,scopedContainer,tal);
3740 }
3741 }
3742 }
3743 else // definition gets it template parameters from its class
3744 // (since no definition was found)
3745 {
3746 if (cd && lang==SrcLangExt::Cpp && !isTemplateSpecialization())
3747 {
3748 for (const ArgumentList &tal : cd->getTemplateParameterLists())
3749 {
3750 if (!tal.empty())
3751 {
3753 _writeTemplatePrefix(ol,scopedContainer,tal,false);
3755 }
3756 }
3757 }
3758 if (m_tArgList.hasParameters() && lang==SrcLangExt::Cpp) // function template prefix
3759 {
3761 _writeTemplatePrefix(ol,scopedContainer,m_tArgList);
3763 }
3764 }
3765
3766 startHtmlLabelTable();
3767
3769 if (cd && cd->isObjectiveC())
3770 {
3771 // strip scope name
3772 if (size_t ep = ldef.find("::"); ep!=DString::npos)
3773 {
3774 if (size_t sp=ldef.rfind(' ',ep); sp!=DString::npos)
3775 {
3776 ldef=ldef.left(sp+1)+ldef.mid(ep+2);
3777 } else {
3778 ldef=ldef.mid(ep+2);
3779 }
3780 }
3781 // strip keywords
3782 if (size_t dp = ldef.find(':'); dp!=DString::npos)
3783 {
3784 ldef=ldef.left(dp+1);
3785 }
3786 int dl=static_cast<int>(ldef.length());
3787 //printf("start >%s<\n",qPrint(ldef));
3788 int i=dl-1;
3789 while (i>=0 && (isId(ldef.at(i)) || ldef.at(i)==':')) i--;
3790 while (i>=0 && isspace(static_cast<uint8_t>(ldef.at(i)))) i--;
3791 if (i>0)
3792 {
3793 // insert branches around the type
3794 ldef="("+ldef.left(i+1)+")"+ldef.mid(i+1);
3795 }
3796 //printf("end >%s< i=%d\n",qPrint(ldef),i);
3797 if (isStatic()) ldef.prepend("+ "); else ldef.prepend("- ");
3798 }
3799
3800 if (optVhdl)
3801 {
3802 hasParameterList=VhdlDocGen::writeVHDLTypeDocumentation(this,scopedContainer,ol);
3803 }
3804 else if (lang==SrcLangExt::Slice)
3805 {
3806 // Eliminate the self-reference.
3807 size_t pos = ldef.rfind(' ');
3808 if (pos==DString::npos) pos=0;
3809 if (pos>0)
3810 {
3811 linkifyText(TextGeneratorOLImpl(ol),ldef.left(pos),options);
3812 }
3813 ol.docify(ldef.mid(pos));
3814 const Definition *scope = cd;
3815 if (scope==nullptr) scope = nd;
3816 hasParameterList=writeDefArgumentList(ol,scope,this);
3817 }
3818 else
3819 {
3820 linkifyText(TextGeneratorOLImpl(ol),substitute(ldef,"::",sep),options);
3821 const Definition *scope = cd;
3822 if (scope==nullptr) scope = nd;
3823 hasParameterList=writeDefArgumentList(ol,scope,this);
3824 }
3825
3826 if (hasOneLineInitializer()) // add initializer
3827 {
3828 if (isTypeAlias())
3829 {
3830 ol.docify(" = ");
3832 linkifyText(TextGeneratorOLImpl(ol),init,options);
3833 }
3834 else if (!isDefine())
3835 {
3836 ol.docify(" ");
3838 linkifyText(TextGeneratorOLImpl(ol),init,options);
3839 }
3840 else
3841 {
3843 linkifyText(TextGeneratorOLImpl(ol),m_initializer,options);
3844 }
3845 }
3846 if (!excpString().empty()) // add exception list
3847 {
3848 writeExceptionList(ol,cd,this);
3849 hasParameterList=true; // call endParameterList below
3850 }
3851 }
3852
3853 ol.pushGeneratorState();
3855 if (!sl.empty())
3856 {
3857 ol.startLabels();
3858 size_t count=0;
3859 for (const auto &s : sl)
3860 {
3861 count++;
3862 ol.writeLabel(s,count==sl.size());
3863 }
3864 ol.endLabels();
3865 }
3866 ol.popGeneratorState();
3867
3868 if (hasParameterList)
3869 {
3870 ol.endParameterList();
3871 ol.endMemberDoc(true);
3872 }
3873 else
3874 {
3875 ol.endMemberDocName();
3876 ol.endMemberDoc(false);
3877 }
3878
3879 // for HTML write the labels here
3880 ol.pushGeneratorState();
3881 ol.disableAll();
3883 if (htmlEndLabelTable)
3884 {
3885 ol.writeString(" </td>\n");
3886 ol.writeString(" <td class=\"mlabels-right\">\n");
3887 ol.startLabels();
3888 size_t count=0;
3889 for (const auto &s : sl)
3890 {
3891 count++;
3892 ol.writeLabel(s,count==sl.size());
3893 }
3894 ol.endLabels();
3895 ol.writeString(" </td>\n");
3896 ol.writeString(" </tr>\n");
3897 ol.writeString("</table>\n");
3898 }
3899 ol.writeString("</div>");
3900 ol.popGeneratorState();
3901
3902
3903 ol.endDoxyAnchor(cfname,memAnchor);
3904 ol.startIndent();
3905
3906 _writeGroupInclude(ol,inGroup);
3907
3908 /* write multi-line initializer (if any) */
3910
3911 /* write brief description */
3912 DString brief = briefDescription();
3913 if (!brief.empty() &&
3914 (Config_getBool(REPEAT_BRIEF) ||
3915 !Config_getBool(BRIEF_MEMBER_DESC)
3916 )
3917 )
3918 {
3919 ol.startParagraph();
3921 briefLine(),
3922 scopedContainer,
3923 this,
3924 brief,
3925 DocOptions()
3926 .setSingleLine(true));
3927 ol.endParagraph();
3928 }
3929
3930 /* write detailed description */
3931 DString detailed = documentation();
3932 if (!detailed.empty() ||
3933 !inbodyDocumentation().empty())
3934 {
3935 // write vhdl inline code with or without option INLINE_SOURCE
3936 if (optVhdl && VhdlDocGen::isMisc(this))
3937 {
3938 VhdlDocGen::writeSource(this,ol,cname);
3939 return;
3940 }
3941 else
3942 {
3943 ol.generateDoc(docFile(),
3944 docLine(),
3945 scopedContainer,
3946 this,
3947 detailed+"\n",
3948 DocOptions()
3949 .setIndexWords(true));
3950 }
3951
3952 if (!inbodyDocumentation().empty())
3953 {
3955 inbodyLine(),
3956 scopedContainer,
3957 this,
3958 inbodyDocumentation()+"\n",
3959 DocOptions()
3960 .setIndexWords(true));
3961 }
3962 }
3963 else if (!brief.empty() && (Config_getBool(REPEAT_BRIEF) || !Config_getBool(BRIEF_MEMBER_DESC)))
3964 {
3965 if (!inbodyDocumentation().empty())
3966 {
3968 inbodyLine(),
3969 scopedContainer,
3970 this,
3971 inbodyDocumentation()+"\n",
3972 DocOptions()
3973 .setIndexWords(true));
3974 }
3975 }
3976
3977
3978 //printf("***** defArgList=%p name=%s docs=%s hasDocs=%d\n",
3979 // defArgList,
3980 // defArgList?defArgList->hasDocumentation():-1);
3981 const ArgumentList &docArgList = m_templateMaster ?
3984 ol.generateDoc(docFile(),
3985 docLine(),
3986 scopedContainer,
3987 this, // memberDef
3988 inlineArgListToDoc(docArgList), // docStr
3989 DocOptions()
3990 .setIndexWords(true));
3991
3992 const ArgumentList &docTemplateArgList = m_templateMaster ?
3994 m_tArgList;
3995 ol.generateDoc(docFile(),
3996 docLine(),
3997 scopedContainer,
3998 this, // memberDef
3999 inlineTemplateArgListToDoc(docTemplateArgList), // docStr
4000 DocOptions()
4001 .setIndexWords(true));
4002
4003 _writeEnumValues(ol,scopedContainer,cfname,ciname,cname);
4007 _writeExamples(ol);
4009 DString scopeStr = getScopeString();
4010 writeSourceDef(ol);
4011 writeInlineCode(ol,scopeStr);
4012 if (hasReferencesRelation()) writeSourceRefs(ol,scopeStr);
4013 if (hasReferencedByRelation()) writeSourceReffedBy(ol,scopeStr);
4014 _writeCallGraph(ol);
4017
4018 ol.endIndent();
4019
4020 // enable LaTeX again
4021 //if (Config_getBool(EXTRACT_ALL) && !hasDocs) ol.enable(OutputType::Latex);
4022 ol.popGeneratorState();
4023
4025}
constexpr auto prefix
Definition anchor.cpp:47
virtual ArgumentLists getTemplateParameterLists() const =0
Returns the template parameter lists that form the template declaration of this class.
DString & remove(size_t index, size_t len)
Definition dstring.h:535
virtual DString inbodyDocumentation() const =0
void writeSourceDef(OutputList &ol) const override
DString briefFile() const override
DString inbodyFile() const override
void writeRequirementRefs(OutputList &ol) const override
void writeSourceReffedBy(OutputList &ol, const DString &scopeName) const override
void writeInlineCode(OutputList &ol, const DString &scopeName) const override
void writeSourceRefs(OutputList &ol, const DString &scopeName) const override
void _writeCallerGraph(OutputList &ol) const
void _writeTypeConstraints(OutputList &ol) const
void _writeExamples(OutputList &ol) const
void _writeReimplementedBy(OutputList &ol) const
StringVector getLabels(const Definition *container) const override
void _writeMultiLineInitializer(OutputList &ol, const DString &scopeName) const
void _writeCategoryRelation(OutputList &ol) const
bool isTemplateSpecialization() const override
void _writeReimplements(OutputList &ol) const
void _writeGroupInclude(OutputList &ol, bool inGroup) const
void _writeEnumValues(OutputList &ol, const Definition *container, const DString &cfname, const DString &ciname, const DString &cname) const
bool isVariable() const override
void _writeCallGraph(OutputList &ol) const
void endIndent()
Definition outputlist.h:580
void startMemberDocName(bool align)
Definition outputlist.h:676
void endMemberDocName()
Definition outputlist.h:678
void endMemberDoc(bool hasArgs)
Definition outputlist.h:531
void startMemberDoc(const DString &clName, const DString &memName, const DString &anchor, const DString &title, int memCount, int memTotal, bool showInline)
Definition outputlist.h:527
void startIndent()
Definition outputlist.h:578
void disableAll()
void endMemberDocPrefixItem()
Definition outputlist.h:674
void writeLabel(const DString &l, bool isLast)
Definition outputlist.h:736
void endLabels()
Definition outputlist.h:738
void endParameterList()
Definition outputlist.h:698
void startLabels()
Definition outputlist.h:734
void startMemberDocPrefixItem()
Definition outputlist.h:672
static bool writeVHDLTypeDocumentation(const MemberDef *mdef, const Definition *d, OutputList &ol)
static bool isMisc(const MemberDef *mdef)
static void writeSource(const MemberDef *mdef, OutputList &ol, const DString &cname)
GroupDef * toGroupDef(Definition *d)
static void writeExceptionList(OutputList &ol, const ClassDef *cd, const MemberDef *md)
static bool writeDefArgumentList(OutputList &ol, const Definition *scope, const MemberDef *md)
DString inlineArgListToDoc(const ArgumentList &al)
Definition util.cpp:4878
DString inlineTemplateArgListToDoc(const ArgumentList &al)
Definition util.cpp:837

References _writeCallerGraph(), _writeCallGraph(), _writeCategoryRelation(), _writeEnumValues(), _writeExamples(), _writeGroupInclude(), _writeMultiLineInitializer(), _writeReimplementedBy(), _writeReimplements(), _writeTemplatePrefix(), _writeTypeConstraints(), OutputList::addLabel(), Definition::anchor(), anchor(), DString::append(), argsString(), MemberDef::argumentList(), DString::at(), briefDescription(), DefinitionMixin< MemberDefMutable >::briefFile(), DefinitionMixin< MemberDefMutable >::briefLine(), ClassDef::compoundTypeString(), Config_getBool, definition(), Definition::definitionType(), OutputList::disable(), OutputList::disableAll(), Definition::displayName(), displayName(), DefinitionMixin< MemberDefMutable >::docFile(), OutputList::docify(), DefinitionMixin< MemberDefMutable >::docLine(), documentation(), ArgumentList::empty(), DString::empty(), OutputList::enable(), OutputList::endDoxyAnchor(), OutputList::endIndent(), OutputList::endLabels(), OutputList::endMemberDoc(), OutputList::endMemberDocName(), OutputList::endMemberDocPrefixItem(), OutputList::endParagraph(), OutputList::endParameterList(), excpString(), DString::find(), OutputList::generateDoc(), getAnonymousEnumType(), DefinitionMixin< MemberDefMutable >::getBodyDef(), getClassDef(), getClassDefOfAnonymousType(), getFileDef(), getGroupDef(), getLabels(), DefinitionMixin< MemberDefMutable >::getLanguage(), getLanguageSpecificSeparator(), getModuleDef(), getNamespaceDef(), Definition::getOutputFileBase(), getOutputFileBase(), Definition::getReference(), getScopeString(), ClassDef::getTemplateParameterLists(), hasMultiLineInitializer(), hasOneLineInitializer(), ArgumentList::hasParameters(), hasReferencedByRelation(), hasReferencesRelation(), DefinitionMixin< MemberDefMutable >::hasRequirementRefs(), Html, DefinitionMixin< MemberDefMutable >::inbodyDocumentation(), DefinitionMixin< MemberDefMutable >::inbodyFile(), DefinitionMixin< MemberDefMutable >::inbodyLine(), init(), inlineArgListToDoc(), inlineTemplateArgListToDoc(), isDefine(), isEnumerate(), MemberDef::isEnumStruct(), isEnumStruct(), isEnumValue(), isFunction(), isId(), isLinkable(), VhdlDocGen::isMisc(), isObjCMethod(), ClassDef::isObjectiveC(), isSliceLocal(), isStatic(), MemberDef::isStrong(), isStrong(), isTemplateSpecialization(), isTypeAlias(), isTypedef(), isVariable(), DString::left(), DString::length(), linkifyText(), DefinitionMixin< MemberDefMutable >::localName(), m_defArgList, m_defTmpArgLists, m_enumBaseType, m_initializer, m_metaData, m_tArgList, m_templateMaster, DString::mid(), Definition::name(), DefinitionMixin< MemberDefMutable >::name(), DString::npos, OutputList::popGeneratorState(), prefix, reg::Match::prefix(), DString::prepend(), OutputList::pushGeneratorState(), reAnonymous, DString::remove(), removeAnonymousScopes(), DString::rfind(), reg::search(), LinkifyTextOptions::setFileScope(), LinkifyTextOptions::setScope(), LinkifyTextOptions::setSelf(), DString::simplifyWhiteSpace(), OutputList::startDoxyAnchor(), OutputList::startIndent(), OutputList::startLabels(), OutputList::startMemberDoc(), OutputList::startMemberDocName(), OutputList::startMemberDocPrefixItem(), OutputList::startParagraph(), DString::str(), reg::SubMatch::str(), DString::stripPrefix(), substitute(), reg::Match::suffix(), MemberDef::templateArguments(), toGroupDef(), Definition::TypeFile, Definition::TypeGroup, warnIfUndocumentedParams(), writeDefArgumentList(), writeExceptionList(), DefinitionMixin< MemberDefMutable >::writeInlineCode(), OutputList::writeLabel(), OutputList::writeNonBreakableSpace(), OutputList::writeObjectLink(), DefinitionMixin< MemberDefMutable >::writeRequirementRefs(), VhdlDocGen::writeSource(), DefinitionMixin< MemberDefMutable >::writeSourceDef(), DefinitionMixin< MemberDefMutable >::writeSourceReffedBy(), DefinitionMixin< MemberDefMutable >::writeSourceRefs(), OutputList::writeString(), and VhdlDocGen::writeVHDLTypeDocumentation().

◆ writeEnumDeclaration()

void MemberDefImpl::writeEnumDeclaration ( OutputList & typeDecl,
const ClassDef * cd,
const NamespaceDef * nd,
const FileDef * fd,
const GroupDef * gd,
const ModuleDef * mod ) const
overridevirtual

Implements MemberDef.

Definition at line 4829 of file memberdef.cpp.

4831{
4832 int enumMemCount=0;
4833
4834 uint32_t numVisibleEnumValues=0;
4835 for (const auto &fmd : m_enumFields)
4836 {
4837 if (fmd->isBriefSectionVisible()) numVisibleEnumValues++;
4838 }
4839 if (numVisibleEnumValues==0 && !isBriefSectionVisible())
4840 {
4841 return;
4842 }
4843
4844 DString n = name();
4845 if (size_t i=n.rfind("::"); i!=DString::npos) n=n.mid(i+2); // strip scope (TODO: is this needed?)
4846 if (n[0]!='@') // not an anonymous enum
4847 {
4849 {
4850 //_writeTagData(compoundType);
4851 writeLink(typeDecl,cd,nd,fd,gd,mod);
4852 }
4853 else
4854 {
4855 typeDecl.startBold();
4856 typeDecl.docify(n);
4857 typeDecl.endBold();
4858 }
4859 typeDecl.writeChar(' ');
4860 }
4861 if (!m_enumBaseType.empty())
4862 {
4863 typeDecl.writeChar(':');
4864 typeDecl.writeChar(' ');
4865 typeDecl.docify(m_enumBaseType);
4866 typeDecl.writeChar(' ');
4867 }
4868
4869 uint32_t enumValuesPerLine = static_cast<uint32_t>(Config_getInt(ENUM_VALUES_PER_LINE));
4870 if (numVisibleEnumValues>0 && enumValuesPerLine>0)
4871 {
4872 typeDecl.docify("{ ");
4873
4874 auto it = m_enumFields.begin();
4875 if (it!=m_enumFields.end())
4876 {
4877 const MemberDef *fmd=*it;
4878 bool fmdVisible = fmd->isBriefSectionVisible();
4879 bool first=true;
4880 while (fmd)
4881 {
4882 if (fmdVisible)
4883 {
4884 if (!first)
4885 {
4886 typeDecl.writeString(", ");
4887 }
4888 /* in html we start a new line after a number of items */
4889 if (numVisibleEnumValues>enumValuesPerLine
4890 && (enumMemCount%enumValuesPerLine)==0
4891 )
4892 {
4893 typeDecl.pushGeneratorState();
4895 typeDecl.enable(OutputType::Latex);
4896 typeDecl.enable(OutputType::Docbook);
4897 typeDecl.lineBreak();
4898 typeDecl.disable(OutputType::Latex);
4899 typeDecl.disable(OutputType::Docbook);
4900 typeDecl.writeString("&#160;&#160;");
4901 typeDecl.popGeneratorState();
4902 }
4903
4904 if (fmd->hasDocumentation()) // enum value has docs
4905 {
4906 fmd->writeLink(typeDecl,cd,nd,fd,gd,mod);
4907 }
4908 else // no docs for this enum value
4909 {
4910 typeDecl.startBold();
4911 typeDecl.docify(fmd->name());
4912 typeDecl.endBold();
4913 }
4914 if (fmd->hasOneLineInitializer()) // enum value has initializer
4915 {
4916 //typeDecl.writeString(" = ");
4917 typeDecl.writeString(" ");
4918 typeDecl.parseText(fmd->initializer());
4919 }
4920 first=false;
4921 }
4922
4923 bool prevVisible = fmdVisible;
4924 ++it;
4925 if (it!=m_enumFields.end())
4926 {
4927 fmd=*it;
4928 }
4929 else
4930 {
4931 fmd=nullptr;
4932 }
4933 if (prevVisible)
4934 {
4935 typeDecl.disable(OutputType::Man);
4936 typeDecl.writeString("\n"); // to prevent too long lines in LaTeX
4937 typeDecl.enable(OutputType::Man);
4938 enumMemCount++;
4939 }
4940 }
4941 if (numVisibleEnumValues>enumValuesPerLine)
4942 {
4943 typeDecl.pushGeneratorState();
4945 typeDecl.lineBreak();
4946 typeDecl.popGeneratorState();
4947 }
4948 }
4949 typeDecl.docify(" }");
4950 }
4951}
virtual bool hasDocumentation() const =0
virtual const DString & initializer() const =0
virtual bool hasOneLineInitializer() const =0
virtual bool isBriefSectionVisible() const =0
virtual void writeLink(OutputList &ol, const ClassDef *cd, const NamespaceDef *nd, const FileDef *fd, const GroupDef *gd, const ModuleDef *md, bool onlyText=false) const =0
bool isBriefSectionVisible() const override
void writeChar(char c)
Definition outputlist.h:525

References Config_getInt, OutputList::disable(), OutputList::disableAllBut(), Docbook, OutputList::docify(), DString::empty(), OutputList::enable(), OutputList::endBold(), Definition::hasDocumentation(), hasDocumentedEnumValues(), MemberDef::hasOneLineInitializer(), Html, MemberDef::initializer(), MemberDef::isBriefSectionVisible(), isBriefSectionVisible(), isLinkableInProject(), Latex, OutputList::lineBreak(), m_enumBaseType, m_enumFields, Man, DString::mid(), Definition::name(), DefinitionMixin< MemberDefMutable >::name(), DString::npos, OutputList::parseText(), OutputList::popGeneratorState(), OutputList::pushGeneratorState(), DString::rfind(), OutputList::startBold(), OutputList::writeChar(), MemberDef::writeLink(), writeLink(), and OutputList::writeString().

◆ writeLink()

void MemberDefImpl::writeLink ( OutputList & ol,
const ClassDef * cd,
const NamespaceDef * nd,
const FileDef * fd,
const GroupDef * gd,
const ModuleDef * mod,
bool onlyText = false ) const
overridevirtual

Implements MemberDef.

Definition at line 1980 of file memberdef.cpp.

1983{
1984 SrcLangExt lang = getLanguage();
1985 bool hideScopeNames = Config_getBool(HIDE_SCOPE_NAMES);
1986 DString sep = getLanguageSpecificSeparator(lang,true);
1987 DString n = name();
1988 const ClassDef *classDef = getClassDef();
1989 const NamespaceDef *nspace = getNamespaceDef();
1990 if (!hideScopeNames)
1991 {
1992 if (m_enumScope && m_livesInsideEnum && getGroupDef()!=nullptr)
1993 {
1995 }
1996 if (classDef && (gd || mod) && !isRelated())
1997 {
1998 n.prepend(classDef->displayName()+sep);
1999 }
2000 else if (nspace && (gd || fd || mod))
2001 {
2002 n.prepend(nspace->displayName()+sep);
2003 }
2004 }
2005
2006 if (isObjCMethod())
2007 {
2008 if (isStatic()) ol.docify("+ "); else ol.docify("- ");
2009 }
2010 if (!onlyText && (isLinkable() || hasDetailedDescription())) // write link
2011 {
2012 if (m_mtype==MemberType::EnumValue && getGroupDef()==nullptr && // enum value is not grouped
2013 getEnumScope() && getEnumScope()->getGroupDef()) // but its container is
2014 {
2015 const GroupDef *enumValGroup = getEnumScope()->getGroupDef();
2016 ol.writeObjectLink(enumValGroup->getReference(),
2017 enumValGroup->getOutputFileBase(),
2018 anchor(),n);
2019 }
2020 else
2021 {
2023 }
2024 }
2025 else // write only text
2026 {
2027 ol.startBold();
2028 ol.docify(n);
2029 ol.endBold();
2030 }
2031}

References anchor(), Config_getBool, Definition::displayName(), OutputList::docify(), OutputList::endBold(), getClassDef(), getEnumScope(), MemberDef::getGroupDef(), getGroupDef(), DefinitionMixin< MemberDefMutable >::getLanguage(), getLanguageSpecificSeparator(), getNamespaceDef(), Definition::getOutputFileBase(), getOutputFileBase(), Definition::getReference(), getReference(), hasDetailedDescription(), isLinkable(), isObjCMethod(), isRelated(), isStatic(), m_enumScope, m_livesInsideEnum, m_mtype, DefinitionMixin< MemberDefMutable >::name(), DString::prepend(), OutputList::startBold(), and OutputList::writeObjectLink().

Referenced by writeDeclaration(), and writeEnumDeclaration().

◆ writeMemberDocSimple()

void MemberDefImpl::writeMemberDocSimple ( OutputList & ol,
const Definition * container ) const
overridevirtual

Implements MemberDefMutable.

Definition at line 4052 of file memberdef.cpp.

4053{
4054 Definition *scope = getOuterScope();
4055 DString doxyName = name();
4056 DString doxyArgs = argsString();
4057 DString memAnchor = anchor();
4058 DString cfname = getOutputFileBase();
4059 DString cname;
4060 if (scope) cname = scope->name();
4061 if (doxyName.at(0)=='@')
4062 {
4063 doxyName="__unnamed__";
4064 }
4065
4066 LinkifyTextOptions options;
4067 options.setScope(scope).setFileScope(getBodyDef()).setSelf(this);
4068
4069 if (container && container->definitionType()==Definition::TypeClass &&
4070 !(toClassDef(container))->isJavaEnum())
4071 {
4073 ol.startDoxyAnchor(cfname,cname,memAnchor,doxyName,doxyArgs);
4074 ol.addLabel(cfname,memAnchor);
4075
4076 bool written=false;
4077 const ClassDef *annoClassDef=getClassDefOfAnonymousType();
4078 if (annoClassDef)
4079 {
4080 static const reg::Ex ar(R"([\w@:]*@\d+[\w@:]*)"); // anonymous type marker(s) including scope
4081 reg::Match amatch;
4082 std::string stype = m_type.str();
4083 if (reg::search(stype,amatch,ar))
4084 {
4085 size_t ai = amatch.position();
4086 size_t al = amatch.length();
4087 ol.writeObjectLink(annoClassDef->getReference(),annoClassDef->getOutputFileBase(),
4088 annoClassDef->anchor(),m_type.left(ai)+m_type.mid(ai+al));
4089 written=true;
4090 }
4091 }
4092 if (!written)
4093 {
4094 DString ts;
4095 if (isFunctionPtr())
4096 {
4097 ts = m_type + m_args;
4098 }
4099 else
4100 {
4101 ts = fieldType();
4102 }
4103 linkifyText(TextGeneratorOLImpl(ol),ts,options);
4104 }
4105 ol.endDoxyAnchor(cfname,memAnchor);
4107 }
4108
4110 ol.docify(doxyName);
4111 if (isVariable() && !argsString().empty() && !isObjCMethod() && !isFunctionPtr())
4112 {
4113 linkifyText(TextGeneratorOLImpl(ol),argsString(),LinkifyTextOptions(options).setArgumentList(&m_defArgList));
4114 }
4115 if (!m_bitfields.empty()) // add bitfields
4116 {
4117 linkifyText(TextGeneratorOLImpl(ol),m_bitfields,options);
4118 }
4119 if (hasOneLineInitializer() && !isDefine())
4120 {
4121 ol.writeString(" ");
4122 linkifyText(TextGeneratorOLImpl(ol),m_initializer.simplifyWhiteSpace(),options);
4123 }
4125
4127
4128 DString brief = briefDescription();
4129 DString detailed = documentation();
4130
4131 /* write brief description */
4132 if (!brief.empty())
4133 {
4135 briefLine(),
4136 getOuterScope()?getOuterScope():container,this,
4137 brief,
4138 DocOptions()
4139 .setSingleLine(true));
4140 }
4141
4142 /* write detailed description */
4143 if (!detailed.empty())
4144 {
4145 if (!brief.empty())
4146 {
4148 ol.lineBreak();
4150 }
4151 ol.generateDoc(docFile(),
4152 docLine(),
4153 getOuterScope()?getOuterScope():container,this,
4154 detailed+"\n",
4155 DocOptions());
4156 }
4157
4158 ol.endInlineMemberDoc();
4159}
DString fieldType() const override
bool isFunctionPtr() const override
void endInlineMemberType()
Definition outputlist.h:724
void startInlineMemberType()
Definition outputlist.h:722
void startInlineMemberDoc()
Definition outputlist.h:730
void endInlineMemberDoc()
Definition outputlist.h:732
void startInlineMemberName()
Definition outputlist.h:726
void endInlineMemberName()
Definition outputlist.h:728

References OutputList::addLabel(), Definition::anchor(), anchor(), argsString(), DString::at(), briefDescription(), DefinitionMixin< MemberDefMutable >::briefFile(), DefinitionMixin< MemberDefMutable >::briefLine(), Definition::definitionType(), OutputList::disable(), DefinitionMixin< MemberDefMutable >::docFile(), OutputList::docify(), DefinitionMixin< MemberDefMutable >::docLine(), documentation(), DString::empty(), OutputList::enable(), OutputList::endDoxyAnchor(), OutputList::endInlineMemberDoc(), OutputList::endInlineMemberName(), OutputList::endInlineMemberType(), fieldType(), OutputList::generateDoc(), DefinitionMixin< MemberDefMutable >::getBodyDef(), getClassDefOfAnonymousType(), DefinitionMixin< MemberDefMutable >::getOuterScope(), Definition::getOutputFileBase(), getOutputFileBase(), Definition::getReference(), hasOneLineInitializer(), Html, isDefine(), isFunctionPtr(), isObjCMethod(), isVariable(), DString::left(), reg::Match::length(), OutputList::lineBreak(), linkifyText(), m_args, m_bitfields, m_defArgList, m_initializer, m_type, DString::mid(), Definition::name(), DefinitionMixin< MemberDefMutable >::name(), reg::Match::position(), reg::search(), LinkifyTextOptions::setFileScope(), LinkifyTextOptions::setScope(), LinkifyTextOptions::setSelf(), DString::simplifyWhiteSpace(), OutputList::startDoxyAnchor(), OutputList::startInlineMemberDoc(), OutputList::startInlineMemberName(), OutputList::startInlineMemberType(), DString::str(), toClassDef(), Definition::TypeClass, OutputList::writeObjectLink(), and OutputList::writeString().

◆ writeTagFile()

void MemberDefImpl::writeTagFile ( TextStream & tagFile,
bool useQualifiedName,
bool showNamespaceMembers ) const
overridevirtual

Implements MemberDefMutable.

Definition at line 4672 of file memberdef.cpp.

4673{
4674 if (!isLinkableInProject()) return;
4675 if (!showNamespaceMembers && getNamespaceDef()) return;
4676 tagFile << " <member kind=\"";
4677 if (m_mtype == MemberType::Enumeration)
4678 {
4679 tagFile << "enumeration";
4680 }
4681 else
4682 {
4683 tagFile << to_string_lower(m_mtype);
4684 }
4685 if (m_prot!=Protection::Public)
4686 {
4687 tagFile << "\" protection=\"";
4688 if (m_prot==Protection::Protected) tagFile << "protected";
4689 else if (m_prot==Protection::Package) tagFile << "package";
4690 else /* Private */ tagFile << "private";
4691 }
4692 if (m_virt!=Specifier::Normal)
4693 {
4694 tagFile << "\" virtualness=\"";
4695 if (m_virt==Specifier::Virtual) tagFile << "virtual";
4696 else /* Pure */ tagFile << "pure";
4697 }
4698 if (isStatic())
4699 {
4700 tagFile << "\" static=\"yes";
4701 }
4702 tagFile << "\">\n";
4703 if (typeString()!=DString("@"))
4704 {
4705 tagFile << " <type>" << convertToXML(typeString()) << "</type>\n";
4706 }
4707 DString fn = getOutputFileBase();
4709 tagFile << " <name>" << convertToXML(useQualifiedName ? qualifiedName() : name()) << "</name>\n";
4710 tagFile << " <anchorfile>" << convertToXML(fn) << "</anchorfile>\n";
4711 tagFile << " <anchor>" << convertToXML(anchor()) << "</anchor>\n";
4712 DString idStr = id();
4713 if (!idStr.empty())
4714 {
4715 tagFile << " <clangid>" << convertToXML(idStr) << "</clangid>\n";
4716 }
4717 tagFile << " <arglist>" << convertToXML(argsString()) << "</arglist>\n";
4718 if (isStrong())
4719 {
4720 for (const auto &fmd : m_enumFields)
4721 {
4722 if (!fmd->isReference())
4723 {
4724 tagFile << " <enumvalue file=\"" << convertToXML(fn);
4725 tagFile << "\" anchor=\"" << convertToXML(fmd->anchor());
4726 idStr = fmd->id();
4727 if (!idStr.empty())
4728 {
4729 tagFile << "\" clangid=\"" << convertToXML(idStr);
4730 }
4731 tagFile << "\">" << convertToXML(fmd->name()) << "</enumvalue>\n";
4732 }
4733 }
4734 }
4735 writeDocAnchorsToTagFile(tagFile);
4736 tagFile << " </member>\n";
4737}
void writeDocAnchorsToTagFile(TextStream &fs) const override
void addHtmlExtensionIfMissing(DString &fName)
Definition util.cpp:3940
DString convertToXML(const DString &s, bool keepEntities, const bool citeEntry)
Definition util.cpp:3241

References addHtmlExtensionIfMissing(), anchor(), argsString(), convertToXML(), DString::empty(), getNamespaceDef(), getOutputFileBase(), DefinitionMixin< MemberDefMutable >::id(), isLinkableInProject(), isStatic(), isStrong(), m_enumFields, m_mtype, m_prot, m_virt, DefinitionMixin< MemberDefMutable >::name(), qualifiedName(), typeString(), and DefinitionMixin< MemberDefMutable >::writeDocAnchorsToTagFile().

Member Data Documentation

◆ m_anc

DString MemberDefImpl::m_anc
private

Definition at line 428 of file memberdef.cpp.

Referenced by anchor(), deepCopy(), setAnchor(), and setTagInfo().

◆ m_annEnumType

const MemberDef* MemberDefImpl::m_annEnumType = nullptr
private

Definition at line 409 of file memberdef.cpp.

Referenced by deepCopy(), getAnonymousEnumType(), init(), and setAnonymousEnumType().

◆ m_annMemberForDecl

const MemberDef* MemberDefImpl::m_annMemberForDecl = nullptr
private

◆ m_annMemberForDetails

const MemberDef* MemberDefImpl::m_annMemberForDetails = nullptr
private

◆ m_anonymousType

const ClassDef* MemberDefImpl::m_anonymousType = nullptr
private

◆ m_args

DString MemberDefImpl::m_args
private

◆ m_bitfields

DString MemberDefImpl::m_bitfields
private

◆ m_cachedResolvedType

DString MemberDefImpl::m_cachedResolvedType
private

Definition at line 480 of file memberdef.cpp.

Referenced by cacheTypedefVal(), deepCopy(), and getCachedResolvedTypedef().

◆ m_cachedTypedefTemplSpec

DString MemberDefImpl::m_cachedTypedefTemplSpec
private

Definition at line 479 of file memberdef.cpp.

Referenced by cacheTypedefVal(), deepCopy(), and getCachedTypedefTemplSpec().

◆ m_cachedTypedefValue

const ClassDef* MemberDefImpl::m_cachedTypedefValue = nullptr
private

Definition at line 478 of file memberdef.cpp.

Referenced by cacheTypedefVal(), deepCopy(), getCachedTypedefVal(), and init().

◆ m_category

ClassDef* MemberDefImpl::m_category = nullptr
private

Definition at line 518 of file memberdef.cpp.

Referenced by _writeCategoryRelation(), category(), deepCopy(), and setCategory().

◆ m_categoryRelation

const MemberDef* MemberDefImpl::m_categoryRelation = nullptr
private

◆ m_classDef

ClassDef* MemberDefImpl::m_classDef = nullptr
private

◆ m_decl

DString MemberDefImpl::m_decl
private

Definition at line 431 of file memberdef.cpp.

Referenced by declaration(), deepCopy(), and init().

◆ m_declArgList

◆ m_declColumn

size_t MemberDefImpl::m_declColumn = 1
private

Definition at line 522 of file memberdef.cpp.

Referenced by deepCopy(), getDeclColumn(), and setDeclFile().

◆ m_declFileName

DString MemberDefImpl::m_declFileName
private

Definition at line 520 of file memberdef.cpp.

Referenced by deepCopy(), getDeclFileName(), and setDeclFile().

◆ m_declLine

int MemberDefImpl::m_declLine = -1
private

Definition at line 521 of file memberdef.cpp.

Referenced by deepCopy(), getDeclLine(), and setDeclFile().

◆ m_def

DString MemberDefImpl::m_def
private

Definition at line 427 of file memberdef.cpp.

Referenced by createTemplateInstanceMember(), deepCopy(), definition(), and setDefinition().

◆ m_defArgList

◆ m_defTmpArgLists

ArgumentLists MemberDefImpl::m_defTmpArgLists
private

◆ m_detailedDescriptionCachedValue

bool MemberDefImpl::m_detailedDescriptionCachedValue = false
mutableprivate

Definition at line 504 of file memberdef.cpp.

Referenced by deepCopy(), and hasDetailedDescription().

◆ m_docEnumValues

bool MemberDefImpl::m_docEnumValues = false
private

◆ m_docProvider

const MemberDef* MemberDefImpl::m_docProvider = nullptr
private

Definition at line 483 of file memberdef.cpp.

Referenced by deepCopy(), inheritsDocsFrom(), init(), and setInheritsDocsFrom().

◆ m_docsForDefinition

bool MemberDefImpl::m_docsForDefinition = false
private

Definition at line 515 of file memberdef.cpp.

Referenced by deepCopy(), init(), isDocsForDefinition(), and setDocsForDefinition().

◆ m_docTransferDone

bool MemberDefImpl::m_docTransferDone = false
private

Definition at line 442 of file memberdef.cpp.

Referenced by isDocTransferDone(), and setDocTransferDone().

◆ m_enumBaseType

DString MemberDefImpl::m_enumBaseType
private

◆ m_enumFields

MemberVector MemberDefImpl::m_enumFields
private

◆ m_enumScope

const MemberDef* MemberDefImpl::m_enumScope = nullptr
private

◆ m_examples

ExampleList MemberDefImpl::m_examples
private

Definition at line 423 of file memberdef.cpp.

Referenced by _writeExamples(), addExample(), deepCopy(), getExamples(), and hasExamples().

◆ m_exception

DString MemberDefImpl::m_exception
private

Definition at line 436 of file memberdef.cpp.

Referenced by createTemplateInstanceMember(), deepCopy(), excpString(), and init().

◆ m_explExt

bool MemberDefImpl::m_explExt = false
private

Definition at line 512 of file memberdef.cpp.

Referenced by deepCopy(), init(), isExternal(), and setExplicitExternal().

◆ m_explicitInherited

bool MemberDefImpl::m_explicitInherited = false
private

Definition at line 487 of file memberdef.cpp.

Referenced by getLabels(), and setExplicitInherited().

◆ m_explicitOutputFileBase

DString MemberDefImpl::m_explicitOutputFileBase
private

Definition at line 486 of file memberdef.cpp.

Referenced by deepCopy(), getOutputFileBase(), and setTagInfo().

◆ m_extraTypeChars

DString MemberDefImpl::m_extraTypeChars
private

Definition at line 438 of file memberdef.cpp.

Referenced by deepCopy(), extraTypeChars(), and init().

◆ m_fileDef

FileDef* MemberDefImpl::m_fileDef = nullptr
private

Definition at line 403 of file memberdef.cpp.

Referenced by deepCopy(), getFileDef(), getFileDef(), init(), moveTo(), and setFileDef().

◆ m_formalTemplateArguments

std::optional<ArgumentList> MemberDefImpl::m_formalTemplateArguments
private

Definition at line 456 of file memberdef.cpp.

Referenced by deepCopy(), formalTemplateArguments(), and setFormalTemplateArguments().

◆ m_group

GroupDef* MemberDefImpl::m_group = nullptr
private

Definition at line 471 of file memberdef.cpp.

Referenced by deepCopy(), getGroupDef(), getGroupDef(), init(), setEnumScope(), and setGroupDef().

◆ m_groupAlias

const MemberDef* MemberDefImpl::m_groupAlias = nullptr
private

Definition at line 468 of file memberdef.cpp.

Referenced by anchor(), deepCopy(), getGroupAlias(), init(), and setGroupAlias().

◆ m_groupFileName

DString MemberDefImpl::m_groupFileName
private

Definition at line 473 of file memberdef.cpp.

Referenced by deepCopy(), getGroupFileName(), setEnumScope(), and setGroupDef().

◆ m_groupHasDocs

bool MemberDefImpl::m_groupHasDocs = false
private

Definition at line 514 of file memberdef.cpp.

Referenced by deepCopy(), getGroupHasDocs(), setEnumScope(), and setGroupDef().

◆ m_groupMember

MemberDef* MemberDefImpl::m_groupMember = nullptr
private

Definition at line 475 of file memberdef.cpp.

Referenced by anchor(), deepCopy(), init(), and setGroupDef().

◆ m_grouppri

Grouping::GroupPri_t MemberDefImpl::m_grouppri = Grouping::GROUPING_AUTO_DEF
private

Definition at line 472 of file memberdef.cpp.

Referenced by deepCopy(), getGroupPri(), setEnumScope(), and setGroupDef().

◆ m_groupStartLine

int MemberDefImpl::m_groupStartLine = 0
private

Definition at line 474 of file memberdef.cpp.

Referenced by deepCopy(), getGroupStartLine(), setEnumScope(), and setGroupDef().

◆ m_grpId

int MemberDefImpl::m_grpId = 0
private

Definition at line 469 of file memberdef.cpp.

Referenced by deepCopy(), getMemberGroupId(), init(), and setMemberGroupId().

◆ m_hasCallerGraph

bool MemberDefImpl::m_hasCallerGraph = false
private

◆ m_hasCallGraph

bool MemberDefImpl::m_hasCallGraph = false
private

Definition at line 506 of file memberdef.cpp.

Referenced by _hasVisibleCallGraph(), deepCopy(), hasCallGraph(), init(), and overrideCallGraph().

◆ m_hasDetailedDescriptionCached

bool MemberDefImpl::m_hasDetailedDescriptionCached = false
mutableprivate

Definition at line 503 of file memberdef.cpp.

Referenced by deepCopy(), and hasDetailedDescription().

◆ m_hasDocumentedParams

bool MemberDefImpl::m_hasDocumentedParams = false
mutableprivate

Definition at line 495 of file memberdef.cpp.

Referenced by deepCopy(), detectUndocumentedParams(), init(), and warnIfUndocumentedParams().

◆ m_hasDocumentedReturnType

bool MemberDefImpl::m_hasDocumentedReturnType = false
mutableprivate

Definition at line 496 of file memberdef.cpp.

Referenced by deepCopy(), detectUndocumentedParams(), init(), and warnIfUndocumentedParams().

◆ m_hasEnumValues

bool MemberDefImpl::m_hasEnumValues = false
private

Definition at line 511 of file memberdef.cpp.

Referenced by deepCopy(), hasEnumValues(), init(), and overrideEnumValues().

◆ m_hasInlineSource

bool MemberDefImpl::m_hasInlineSource = false
private

Definition at line 510 of file memberdef.cpp.

Referenced by deepCopy(), hasInlineSource(), init(), and overrideInlineSource().

◆ m_hasReferencedByRelation

bool MemberDefImpl::m_hasReferencedByRelation = false
private

◆ m_hasReferencesRelation

bool MemberDefImpl::m_hasReferencesRelation = false
private

Definition at line 509 of file memberdef.cpp.

Referenced by deepCopy(), hasReferencesRelation(), init(), and overrideReferencesRelation().

◆ m_implOnly

bool MemberDefImpl::m_implOnly = false
private

Definition at line 493 of file memberdef.cpp.

Referenced by deepCopy(), init(), isImplementation(), and makeImplementationDetail().

◆ m_incInfo

std::unique_ptr<IncludeInfo> MemberDefImpl::m_incInfo
private

◆ m_initializer

◆ m_initLines

int MemberDefImpl::m_initLines = 0
private

◆ m_isConstructorCached

uint8_t MemberDefImpl::m_isConstructorCached
private

◆ m_isDestructorCached

uint8_t MemberDefImpl::m_isDestructorCached
private

Definition at line 400 of file memberdef.cpp.

Referenced by _computeIsDestructor(), isDestructor(), MemberDefImpl(), and setFileDef().

◆ m_isDMember

bool MemberDefImpl::m_isDMember = false
private

Definition at line 497 of file memberdef.cpp.

Referenced by _computeIsConstructor(), _computeIsDestructor(), deepCopy(), and init().

◆ m_isLinkableCached

◆ m_isTypedefValCached

bool MemberDefImpl::m_isTypedefValCached = false
private

◆ m_livesInsideEnum

bool MemberDefImpl::m_livesInsideEnum = false
private

Definition at line 408 of file memberdef.cpp.

Referenced by deepCopy(), init(), livesInsideEnum(), setEnumScope(), and writeLink().

◆ m_maxInitLines

int MemberDefImpl::m_maxInitLines = 0
private

Definition at line 447 of file memberdef.cpp.

Referenced by deepCopy(), hasMultiLineInitializer(), hasOneLineInitializer(), and init().

◆ m_memberGroup

MemberGroup* MemberDefImpl::m_memberGroup = nullptr
private

Definition at line 470 of file memberdef.cpp.

Referenced by deepCopy(), getMemberGroup(), init(), and setMemberGroup().

◆ m_memDec

MemberDef* MemberDefImpl::m_memDec = nullptr
private

Definition at line 418 of file memberdef.cpp.

Referenced by deepCopy(), init(), memberDeclaration(), and setMemberDeclaration().

◆ m_memDef

MemberDef* MemberDefImpl::m_memDef = nullptr
private

Definition at line 417 of file memberdef.cpp.

Referenced by deepCopy(), init(), memberDefinition(), and setMemberDefinition().

◆ m_memSpec

◆ m_metaData

DString MemberDefImpl::m_metaData
private

Definition at line 460 of file memberdef.cpp.

Referenced by deepCopy(), init(), and writeDocumentation().

◆ m_moduleDef

ModuleDef* MemberDefImpl::m_moduleDef = nullptr
private

Definition at line 405 of file memberdef.cpp.

Referenced by deepCopy(), getModuleDef(), init(), moveTo(), and setModuleDef().

◆ m_mtype

◆ m_nspace

NamespaceDef* MemberDefImpl::m_nspace = nullptr
private

Definition at line 404 of file memberdef.cpp.

Referenced by deepCopy(), getNamespaceDef(), getNamespaceDef(), init(), moveTo(), and setNamespace().

◆ m_numberOfFlowKW

int MemberDefImpl::m_numberOfFlowKW = 0
private

Definition at line 523 of file memberdef.cpp.

Referenced by deepCopy(), incrementFlowKeyWordCount(), and numberOfFlowKeyWords().

◆ m_prot

◆ m_proto

bool MemberDefImpl::m_proto = false
private

Definition at line 500 of file memberdef.cpp.

Referenced by deepCopy(), init(), isPrototype(), and setPrototype().

◆ m_qualifiers

StringVector MemberDefImpl::m_qualifiers
private

◆ m_read

DString MemberDefImpl::m_read
private

Definition at line 434 of file memberdef.cpp.

Referenced by deepCopy(), getReadAccessor(), and setReadAccessor().

◆ m_redefineCount

int MemberDefImpl::m_redefineCount = 0
private

Definition at line 524 of file memberdef.cpp.

Referenced by redefineCount(), setAnchor(), and setRedefineCount().

◆ m_redefinedBy

MemberVector MemberDefImpl::m_redefinedBy
private

Definition at line 415 of file memberdef.cpp.

Referenced by deepCopy(), insertReimplementedBy(), isReimplementedBy(), and reimplementedBy().

◆ m_redefines

MemberDef* MemberDefImpl::m_redefines = nullptr
private

Definition at line 414 of file memberdef.cpp.

Referenced by deepCopy(), init(), reimplements(), and setReimplements().

◆ m_related

Relationship MemberDefImpl::m_related = Relationship::Member
private

◆ m_relatedAlso

ClassDef* MemberDefImpl::m_relatedAlso = nullptr
private

Definition at line 419 of file memberdef.cpp.

Referenced by deepCopy(), init(), relatedAlso(), and setRelatedAlso().

◆ m_requiresClause

DString MemberDefImpl::m_requiresClause
private

◆ m_sectionMap

std::map<const Definition *,const MemberList *> MemberDefImpl::m_sectionMap
private

Definition at line 466 of file memberdef.cpp.

Referenced by deepCopy(), getSectionList(), and setSectionList().

◆ m_stat

bool MemberDefImpl::m_stat = false
private

◆ m_tArgList

◆ m_templateMaster

◆ m_tspec

bool MemberDefImpl::m_tspec = false
private

Definition at line 513 of file memberdef.cpp.

Referenced by deepCopy(), init(), isTemplateSpecialization(), and setTemplateSpecialization().

◆ m_type

◆ m_typeConstraints

ArgumentList MemberDefImpl::m_typeConstraints
private

◆ m_userInitLines

int MemberDefImpl::m_userInitLines = 0
private

◆ m_vhdlSpec

VhdlSpecifier MemberDefImpl::m_vhdlSpec
private

Definition at line 445 of file memberdef.cpp.

Referenced by deepCopy(), getVhdlSpecifiers(), init(), and setVhdlSpecifiers().

◆ m_virt

◆ m_write

DString MemberDefImpl::m_write
private

Definition at line 435 of file memberdef.cpp.

Referenced by deepCopy(), getWriteAccessor(), and setWriteAccessor().


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