/****************************************************************************** * * * * Copyright (C) 1997-2015 by Dimitri van Heesch. * * Permission to use, copy, modify, and distribute this software and its * documentation under the terms of the GNU General Public License is hereby * granted. No representations are made about the suitability of this software * for any purpose. It is provided "as is" without express or implied warranty. * See the GNU General Public License for more details. * * Documents produced by Doxygen are derivative works derived from the * input used in their production; they are not affected by this license. * */ #ifndef MEMBERDEF_H #define MEMBERDEF_H #include #include #include #include "types.h" #include "definition.h" #include "arguments.h" #include "classdef.h" class NamespaceDef; class GroupDef; class FileDef; class MemberList; class MemberGroup; class ExampleList; class OutputList; class GroupDef; struct TagInfo; class MemberDefMutable; class MemberGroupList; /** A model of a class/file/namespace member symbol. */ class MemberDef : public Definition { public: virtual ~MemberDef() {} virtual DefType definitionType() const = 0; // move this member into a different scope virtual MemberDef *deepCopy() const =0; virtual void moveTo(Definition *) = 0; virtual MemberDef *resolveAlias() = 0; virtual const MemberDef *resolveAlias() const = 0; ClassDefMutable *getClassDefMutable() const; //----------------------------------------------------------------------------------- // ---- getters ----- //----------------------------------------------------------------------------------- // link id virtual QCString getOutputFileBase() const = 0; virtual QCString getReference() const = 0; virtual QCString anchor() const = 0; virtual QCString declaration() const = 0; virtual QCString definition() const = 0; virtual QCString typeString() const = 0; virtual QCString argsString() const = 0; virtual QCString excpString() const = 0; virtual QCString bitfieldString() const = 0; virtual QCString extraTypeChars() const = 0; virtual const QCString &initializer() const = 0; virtual int initializerLines() const = 0; virtual uint64 getMemberSpecifiers() const = 0; virtual const MemberList *getSectionList(const Definition *container) const = 0; virtual QCString displayDefinition() const = 0; // scope query members virtual const FileDef *getFileDef() const = 0; virtual const ClassDef *getClassDef() const = 0; virtual const NamespaceDef* getNamespaceDef() const = 0; virtual const ClassDef *accessorClass() const = 0; // grabbing the property read/write accessor names virtual QCString getReadAccessor() const = 0; virtual QCString getWriteAccessor() const = 0; // querying the grouping definition virtual const GroupDef *getGroupDef() const = 0; virtual Grouping::GroupPri_t getGroupPri() const = 0; virtual QCString getGroupFileName() const = 0; virtual int getGroupStartLine() const = 0; virtual bool getGroupHasDocs() const = 0; virtual QCString qualifiedName() const = 0; virtual QCString objCMethodName(bool localLink,bool showStatic) const = 0; // direct kind info virtual Protection protection() const = 0; virtual Specifier virtualness(int count=0) const = 0; virtual MemberType memberType() const = 0; virtual QCString memberTypeName() const = 0; // getter methods virtual bool isSignal() const = 0; virtual bool isSlot() const = 0; virtual bool isVariable() const = 0; virtual bool isEnumerate() const = 0; virtual bool isEnumValue() const = 0; virtual bool isTypedef() const = 0; virtual bool isSequence() const = 0; virtual bool isDictionary() const = 0; virtual bool isFunction() const = 0; virtual bool isFunctionPtr() const = 0; virtual bool isDefine() const = 0; virtual bool isFriend() const = 0; virtual bool isDCOP() const = 0; virtual bool isProperty() const = 0; virtual bool isEvent() const = 0; virtual bool isRelated() const = 0; virtual bool isForeign() const = 0; virtual bool isStatic() const = 0; virtual bool isInline() const = 0; virtual bool isExplicit() const = 0; virtual bool isMutable() const = 0; virtual bool isGettable() const = 0; virtual bool isPrivateGettable() const = 0; virtual bool isProtectedGettable() const = 0; virtual bool isSettable() const = 0; virtual bool isPrivateSettable() const = 0; virtual bool isProtectedSettable() const = 0; virtual bool isReadable() const = 0; virtual bool isWritable() const = 0; virtual bool isAddable() const = 0; virtual bool isRemovable() const = 0; virtual bool isRaisable() const = 0; virtual bool isFinal() const = 0; virtual bool isAbstract() const = 0; virtual bool isOverride() const = 0; virtual bool isInitonly() const = 0; virtual bool isOptional() const = 0; virtual bool isRequired() const = 0; virtual bool isNonAtomic() const = 0; virtual bool isCopy() const = 0; virtual bool isAssign() const = 0; virtual bool isRetain() const = 0; virtual bool isWeak() const = 0; virtual bool isStrong() const = 0; virtual bool isEnumStruct() const = 0; virtual bool isUnretained() const = 0; virtual bool isNew() const = 0; virtual bool isSealed() const = 0; virtual bool isImplementation() const = 0; virtual bool isExternal() const = 0; virtual bool isTypeAlias() const = 0; virtual bool isDefault() const = 0; virtual bool isDelete() const = 0; virtual bool isNoExcept() const = 0; virtual bool isAttribute() const = 0; // UNO IDL attribute virtual bool isUNOProperty() const = 0; // UNO IDL property virtual bool isReadonly() const = 0; virtual bool isBound() const = 0; virtual bool isConstrained() const = 0; virtual bool isTransient() const = 0; virtual bool isMaybeVoid() const = 0; virtual bool isMaybeDefault() const = 0; virtual bool isMaybeAmbiguous() const = 0; virtual bool isPublished() const = 0; // UNO IDL published virtual bool isTemplateSpecialization() const = 0; virtual bool isObjCMethod() const = 0; virtual bool isObjCProperty() const = 0; virtual bool isConstructor() const = 0; virtual bool isDestructor() const = 0; virtual bool hasOneLineInitializer() const = 0; virtual bool hasMultiLineInitializer() const = 0; virtual bool showInCallGraph() const = 0; virtual bool isStrongEnumValue() const = 0; virtual bool livesInsideEnum() const = 0; virtual bool isSliceLocal() const = 0; virtual bool isConstExpr() const = 0; virtual int numberOfFlowKeyWords() const = 0; // derived getters virtual bool isFriendToHide() const = 0; virtual bool isNotFriend() const = 0; virtual bool isFunctionOrSignalSlot() const = 0; virtual bool isRelatedOrFriend() const = 0; // output info virtual bool isLinkableInProject() const = 0; virtual bool isLinkable() const = 0; virtual bool hasDocumentation() const = 0; // overrides hasDocumentation in definition.h //bool hasUserDocumentation() const = 0; // overrides hasUserDocumentation virtual bool isDeleted() const = 0; virtual bool isBriefSectionVisible() const = 0; virtual bool isDetailedSectionVisible(bool inGroup,bool inFile) const = 0; virtual bool isDetailedSectionLinkable() const = 0; virtual bool isFriendClass() const = 0; virtual bool isDocumentedFriendClass() const = 0; virtual const MemberDef *reimplements() const = 0; virtual const MemberList &reimplementedBy() const = 0; virtual bool isReimplementedBy(const ClassDef *cd) const = 0; virtual ClassDef *relatedAlso() const = 0; virtual bool hasDocumentedEnumValues() const = 0; virtual const MemberDef *getAnonymousEnumType() const = 0; virtual bool isDocsForDefinition() const = 0; virtual const MemberDef *getEnumScope() const = 0; virtual const MemberList &enumFieldList() const = 0; virtual QCString enumBaseType() const = 0; virtual bool hasExamples() const = 0; virtual const ExampleList &getExamples() const = 0; virtual bool isPrototype() const = 0; // argument related members virtual const ArgumentList &argumentList() const = 0; virtual const ArgumentList &declArgumentList() const = 0; virtual const ArgumentList &templateArguments() const = 0; virtual const ArgumentLists &definitionTemplateParameterLists() const = 0; // member group related members virtual int getMemberGroupId() const = 0; virtual MemberGroup *getMemberGroup() const = 0; virtual bool fromAnonymousScope() const = 0; virtual bool anonymousDeclShown() const = 0; virtual MemberDef *fromAnonymousMember() const = 0; // callgraph related members virtual bool hasCallGraph() const = 0; virtual bool hasCallerGraph() const = 0; virtual bool visibleMemberGroup(bool hideNoHeader) const = 0; // referenced related members virtual bool hasReferencesRelation() const = 0; virtual bool hasReferencedByRelation() const = 0; virtual const MemberDef *templateMaster() const = 0; virtual QCString getScopeString() const = 0; virtual ClassDef *getClassDefOfAnonymousType() const = 0; // cached typedef functions virtual bool isTypedefValCached() const = 0; virtual const ClassDef *getCachedTypedefVal() const = 0; virtual QCString getCachedTypedefTemplSpec() const = 0; virtual QCString getCachedResolvedTypedef() const = 0; virtual MemberDef *memberDefinition() const = 0; virtual MemberDef *memberDeclaration() const = 0; virtual const MemberDef *inheritsDocsFrom() const = 0; virtual const MemberDef *getGroupAlias() const = 0; virtual ClassDef *category() const = 0; virtual const MemberDef *categoryRelation() const = 0; virtual QCString displayName(bool=TRUE) const = 0; virtual QCString getDeclType() const = 0; virtual StringVector getLabels(const Definition *container) const = 0; virtual const ArgumentList &typeConstraints() const = 0; virtual QCString requiresClause() const = 0; // overrules virtual QCString documentation() const = 0; virtual QCString briefDescription(bool abbr=FALSE) const = 0; virtual QCString fieldType() const = 0; virtual bool isReference() const = 0; virtual QCString getDeclFileName() const = 0; virtual int getDeclLine() const = 0; virtual int getDeclColumn() const = 0; virtual MemberDefMutable *createTemplateInstanceMember(const ArgumentList &formalArgs, const std::unique_ptr &actualArgs) const = 0; virtual void writeDeclaration(OutputList &ol, const ClassDef *cd,const NamespaceDef *nd,const FileDef *fd,const GroupDef *gd, bool inGroup, const ClassDef *inheritFrom=0,const QCString &inheritId=QCString()) const = 0; virtual void writeEnumDeclaration(OutputList &typeDecl, const ClassDef *cd, const NamespaceDef *nd,const FileDef *fd,const GroupDef *gd) const = 0; virtual void detectUndocumentedParams(bool hasParamCommand,bool hasReturnCommand) const = 0; virtual void warnIfUndocumented() const = 0; virtual void warnIfUndocumentedParams() const = 0; virtual bool visibleInIndex() const = 0; // TODO: this is not a getter, should be passed at construction virtual void setMemberGroup(MemberGroup *grp) = 0; }; class MemberDefMutable : public DefinitionMutable, public MemberDef { public: //----------------------------------------------------------------------------------- // ---- setters ----- //----------------------------------------------------------------------------------- // set functions virtual void setMemberType(MemberType t) = 0; virtual void setDefinition(const QCString &d) = 0; virtual void setFileDef(const FileDef *fd) = 0; virtual void setAnchor() = 0; virtual void setProtection(Protection p) = 0; virtual void setMemberSpecifiers(uint64 s) = 0; virtual void mergeMemberSpecifiers(uint64 s) = 0; virtual void setInitializer(const QCString &i) = 0; virtual void setBitfields(const QCString &s) = 0; virtual void setMaxInitLines(int lines) = 0; virtual void setMemberClass(const ClassDef *cd) = 0; virtual void setSectionList(const Definition *container,const MemberList *sl) = 0; virtual void setGroupDef(const GroupDef *gd,Grouping::GroupPri_t pri, const QCString &fileName,int startLine,bool hasDocs, MemberDef *member=0) = 0; virtual void setReadAccessor(const QCString &r) = 0; virtual void setWriteAccessor(const QCString &w) = 0; virtual void setTemplateSpecialization(bool b) = 0; virtual void makeRelated() = 0; virtual void makeForeign() = 0; virtual void setInheritsDocsFrom(const MemberDef *md) = 0; virtual void setTagInfo(const TagInfo *i) = 0; virtual void setArgsString(const QCString &as) = 0; virtual void incrementFlowKeyWordCount() = 0; virtual void setEnumBaseType(const QCString &type) = 0; // relation to other members virtual void setReimplements(const MemberDef *md) = 0; virtual void insertReimplementedBy(const MemberDef *md) = 0; virtual void setRelatedAlso(ClassDef *cd) = 0; // enumeration specific members virtual void insertEnumField(const MemberDef *md) = 0; virtual void setEnumScope(const MemberDef *md,bool livesInsideEnum=FALSE) = 0; virtual void setEnumClassScope(const ClassDef *cd) = 0; virtual void setDocumentedEnumValues(bool value) = 0; virtual void setAnonymousEnumType(const MemberDef *md) = 0; // example related members virtual bool addExample(const QCString &anchor,const QCString &name,const QCString &file) = 0; // prototype related members virtual void setPrototype(bool p,const QCString &df,int line, int column) = 0; virtual void setExplicitExternal(bool b,const QCString &df,int line,int column) = 0; virtual void setDeclFile(const QCString &df,int line,int column) = 0; // argument related members virtual void moveArgumentList(std::unique_ptr al) = 0; virtual void moveDeclArgumentList(std::unique_ptr al) = 0; virtual void resolveUnnamedParameters(const MemberDef *md) = 0; virtual void setDefinitionTemplateParameterLists(const ArgumentLists &lists) = 0; virtual void setTypeConstraints(const ArgumentList &al) = 0; virtual void setType(const QCString &t) = 0; virtual void setAccessorType(ClassDef *cd,const QCString &t) = 0; // namespace related members virtual void setNamespace(const NamespaceDef *nd) = 0; // member group related members virtual void setMemberGroupId(int id) = 0; virtual void makeImplementationDetail() = 0; // anonymous scope members virtual void setFromAnonymousMember(MemberDef *m) = 0; virtual void enableCallGraph(bool e) = 0; virtual void enableCallerGraph(bool e) = 0; virtual void enableReferencedByRelation(bool e) = 0; virtual void enableReferencesRelation(bool e) = 0; virtual void setTemplateMaster(const MemberDef *mt) = 0; virtual void addListReference(Definition *d) = 0; virtual void setDocsForDefinition(bool b) = 0; virtual void setGroupAlias(const MemberDef *md) = 0; virtual void cacheTypedefVal(const ClassDef *val,const QCString &templSpec,const QCString &resolvedType) = 0; virtual void invalidateTypedefValCache() = 0; virtual void invalidateCachedArgumentTypes() = 0; // declaration <-> definition relation virtual void setMemberDefinition(MemberDef *md) = 0; virtual void setMemberDeclaration(MemberDef *md) = 0; virtual void copyArgumentNames(const MemberDef *bmd) = 0; virtual void setCategory(ClassDef *) = 0; virtual void setCategoryRelation(const MemberDef *) = 0; virtual void setDocumentation(const QCString &d,const QCString &docFile,int docLine,bool stripWhiteSpace=TRUE) = 0; virtual void setBriefDescription(const QCString &b,const QCString &briefFile,int briefLine) = 0; virtual void setInbodyDocumentation(const QCString &d,const QCString &inbodyFile,int inbodyLine) = 0; virtual void setHidden(bool b) = 0; virtual void setRequiresClause(const QCString &req) = 0; //----------------------------------------------------------------------------------- // --- actions ---- //----------------------------------------------------------------------------------- virtual void findSectionsInDocumentation() = 0; virtual void addToSearchIndex() const = 0; //----------------------------------------------------------------------------------- // --- write output ---- //----------------------------------------------------------------------------------- virtual void writeDocumentation(const MemberList *ml,int memCount,int memTotal,OutputList &ol, const QCString &scopeName,const Definition *container, bool inGroup,bool showEnumValues=FALSE,bool showInline=FALSE) const = 0; virtual void writeMemberDocSimple(OutputList &ol,const Definition *container) const = 0; virtual void writeTagFile(TextStream &) const = 0; virtual void writeLink(OutputList &ol, const ClassDef *cd,const NamespaceDef *nd,const FileDef *fd,const GroupDef *gd, bool onlyText=FALSE) const = 0; // write helpers virtual void setAnonymousUsed() const = 0; virtual void setFromAnonymousScope(bool b) const = 0; }; inline ClassDefMutable *MemberDef::getClassDefMutable() const { return toClassDefMutable(getClassDef()); } // --- Cast functions MemberDef *toMemberDef(Definition *d); MemberDef *toMemberDef(DefinitionMutable *d); const MemberDef *toMemberDef(const Definition *d); MemberDefMutable *toMemberDefMutable(Definition *d); MemberDefMutable *toMemberDefMutable(const Definition *d); //------------------------------------------------------------------------ /** Factory method to create a new instance of a MemberDef */ MemberDefMutable *createMemberDef(const QCString &defFileName,int defLine,int defColumn, const QCString &type,const QCString &name,const QCString &args, const QCString &excp,Protection prot,Specifier virt,bool stat, Relationship related,MemberType t,const ArgumentList &tal, const ArgumentList &al,const QCString &metaData); MemberDef *createMemberDefAlias(const Definition *newScope,const MemberDef *aliasMd); void combineDeclarationAndDefinition(MemberDefMutable *mdec,MemberDefMutable *mdef); void addDocCrossReference(MemberDefMutable *src,MemberDefMutable *dst); #endif