memberdef.cpp File Reference

#include "memberdef.h"
#include <memory>
#include <mutex>
#include <optional>
#include "arguments.h"
#include "code.h"
#include "config.h"
#include "defargs.h"
#include "definitionimpl.h"
#include "docparser.h"
#include "dotcallgraph.h"
#include "doxygen.h"
#include "example.h"
#include "filedef.h"
#include "groupdef.h"
#include "language.h"
#include "md5hash.h"
#include "membergroup.h"
#include "memberlist.h"
#include "membername.h"
#include "message.h"
#include "moduledef.h"
#include "namespacedef.h"
#include "outputlist.h"
#include "parserintf.h"
#include "regex.h"
#include "trace.h"
#include "util.h"
#include "vhdldocgen.h"

Include dependency graph for memberdef.cpp:

Go to the source code of this file.

Classes
class	MemberDefImpl
class	MemberDefAliasImpl

Functions
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.
std::unique_ptr< MemberDef >	createMemberDefAlias (const Definition *newScope, const MemberDef *aliasMd)
static void	writePageRef (OutputList &ol, const DString &cn, const DString &mn)
static DString	addTemplateNames (const DString &s, const DString &n, const DString &t)
static bool	writeDefArgumentList (OutputList &ol, const Definition *scope, const MemberDef *md)
static void	writeExceptionListImpl (OutputList &ol, const ClassDef *cd, const MemberDef *md, DString const &exception)
static void	writeExceptionList (OutputList &ol, const ClassDef *cd, const MemberDef *md)
static DString	combineArgsAndException (DString args, DString exception)
static DString	simplifyTypeForTable (const DString &s)
static DString	stripTrailingReturn (const DString &trailRet)
static void	invalidateCachedTypesInArgumentList (ArgumentList &al)
static void	transferArgumentDocumentation (ArgumentList &decAl, ArgumentList &defAl)
static bool	hasParamCommand (const DString &doc)
void	combineDeclarationAndDefinition (MemberDefMutable *mdec, MemberDefMutable *mdef)
void	mergeMemberOverrideOptions (MemberDefMutable *md1, MemberDefMutable *md2)
void	addDocCrossReference (const MemberDef *s, const MemberDef *d)
MemberDef *	toMemberDef (Definition *d)
MemberDef *	toMemberDef (DefinitionMutable *md)
const MemberDef *	toMemberDef (const Definition *d)
MemberDefMutable *	toMemberDefMutable (Definition *d)

Variables
static std::mutex	g_hasDetailedDescriptionMutex
static const reg::Ex	reAnonymous (R"([\w:@]*@\d+)")
static std::mutex	g_detectUndocumentedParamsMutex
static std::mutex	g_docCrossReferenceMutex

Function Documentation

addDocCrossReference()

void addDocCrossReference	(	const MemberDef *	s,
		const MemberDef *	d )

Definition at line 6563 of file memberdef.cpp.

{
  MemberDefMutable *src = toMemberDefMutable(const_cast<MemberDef*>(s));
  MemberDefMutable *dst = toMemberDefMutable(const_cast<MemberDef*>(d));
  if (src==nullptr || dst==nullptr) return;
  //printf("--> addDocCrossReference src=%s,dst=%s\n",qPrint(src->name()),qPrint(dst->name()));
  if (dst->isTypedef() || dst->isEnumerate()) return; // don't add types
  if ((dst->hasReferencedByRelation() || dst->hasCallerGraph()) &&
      src->isCallable()
     )
  {
    DString sourceRefName = src->sourceRefName();
    MemberDefMutable *mdDef = toMemberDefMutable(dst->memberDefinition());
    MemberDefMutable *mdDecl = toMemberDefMutable(dst->memberDeclaration());
 
    // ---- critical section
    std::lock_guard<std::mutex> lock(g_docCrossReferenceMutex);
    dst->addSourceReferencedBy(src,sourceRefName);
    if (mdDef)
    {
      mdDef->addSourceReferencedBy(src,sourceRefName);
    }
    if (mdDecl)
    {
      mdDecl->addSourceReferencedBy(src,sourceRefName);
    }
    // ---- end critical section
  }
  if ((src->hasReferencesRelation() || src->hasCallGraph()) &&
      src->isCallable()
     )
  {
    DString sourceRefName = dst->sourceRefName();
    MemberDefMutable *mdDef = toMemberDefMutable(src->memberDefinition());
    MemberDefMutable *mdDecl = toMemberDefMutable(src->memberDeclaration());
 
    // ---- critical section
    std::lock_guard<std::mutex> lock(g_docCrossReferenceMutex);
    src->addSourceReferences(dst,sourceRefName);
    if (mdDef)
    {
      mdDef->addSourceReferences(dst,sourceRefName);
    }
    if (mdDecl)
    {
      mdDecl->addSourceReferences(dst,sourceRefName);
    }
    // ---- end critical section
  }
}

References DefinitionMutable::addSourceReferencedBy(), DefinitionMutable::addSourceReferences(), g_docCrossReferenceMutex, MemberDef::hasCallerGraph(), MemberDef::hasCallGraph(), MemberDef::hasReferencedByRelation(), MemberDef::hasReferencesRelation(), MemberDef::isCallable(), MemberDef::isEnumerate(), MemberDef::isTypedef(), MemberDef::memberDeclaration(), MemberDef::memberDefinition(), MemberDef::sourceRefName(), and toMemberDefMutable().

Referenced by findMemberLink(), generateClassMemberLink(), generateClassOrGlobalLink(), generateClassOrGlobalLink(), getLink(), getLinkInScope(), getLinkInScope(), writeObjCMethodCall(), and MemberDefMutable::writeTagFile().

addTemplateNames()

DString addTemplateNames ( const DString & s, const DString & n, const DString & t )

static

Definition at line 1008 of file memberdef.cpp.

{
  DString result;
  DString clRealName=n;
  size_t p=0,i=0;
  if ((i=clRealName.find('<'))!=DString::npos)
  {
    clRealName=clRealName.left(i); // strip template specialization
  }
  if ((i=clRealName.rfind("::"))!=DString::npos)
  {
    clRealName=clRealName.mid(i+2);
  }
  while ((i=s.find(clRealName,p))!=DString::npos)
  {
    result+=s.mid(p,i-p);
    size_t j=clRealName.length()+i;
    if (s.length()==j || (s.at(j)!='<' && !isId(s.at(j))))
    { // add template names
      //printf("Adding %s+%s\n",qPrint(clRealName),qPrint(t));
      result+=clRealName+t;
    }
    else
    { // template names already present
      //printf("Adding %s\n",qPrint(clRealName));
      result+=clRealName;
    }
    p=i+clRealName.length();
  }
  result+=s.mid(p);
  //printf("addTemplateNames(%s,%s,%s)=%s\n",qPrint(s),qPrint(n),qPrint(t),qPrint(result));
  return result;
}

References DString::at(), DString::find(), isId(), DString::left(), DString::length(), DString::mid(), DString::npos, and DString::rfind().

Referenced by writeDefArgumentList().

combineArgsAndException()

DString combineArgsAndException ( DString args, DString exception )

static

Definition at line 2209 of file memberdef.cpp.

{
  if (exception.empty()) return args;                      // no exception, nothing to combine args
  size_t pos = args.rfind(')');
  size_t eqPos = pos!=DString::npos ? args.find('=',pos) : DString::npos; // look for '=' in '(args) = something'
  if (eqPos==DString::npos) return args+" "+exception;      // append exception at the end
  return args.left(eqPos)+" "+exception+" "+args.mid(eqPos); // insert exception before =
}

References DString::empty(), DString::find(), DString::left(), DString::mid(), DString::npos, and DString::rfind().

Referenced by MemberDefImpl::writeDeclaration().

combineDeclarationAndDefinition()

void combineDeclarationAndDefinition	(	MemberDefMutable *	mdec,
		MemberDefMutable *	mdef )

Definition at line 6248 of file memberdef.cpp.

{
  AUTO_TRACE("mdec='{}' mdef='{}' mdec.isPrototype={} mdef.isPrototype={}",
              mdec->name(), mdef->name(), mdec->isPrototype(), mdef->isPrototype());
  if (
      (!mdef->isDocTransferDone() || !mdec->isDocTransferDone()) &&
      (
       (mdef->isFunction() && !mdef->isStatic() && !mdef->isPrototype()) ||
       (mdef->isVariable() && !mdef->isExternal() && !mdef->isStatic())
      )
     )
  {
    bool sameNumTemplateArgs = mdef->templateArguments().size()==mdec->templateArguments().size();
 
    ArgumentList &mdefAl = const_cast<ArgumentList&>(mdef->argumentList());
    ArgumentList &mdecAl = const_cast<ArgumentList&>(mdec->argumentList());
    if (sameNumTemplateArgs &&
        matchArguments2(mdef->getOuterScope(),mdef->getFileDef(),mdef->typeString(),&mdefAl,
                        mdec->getOuterScope(),mdec->getFileDef(),mdec->typeString(),&mdecAl,
                        true,mdef->getLanguage()
                       )
       ) /* match found */
    {
      AUTO_TRACE_ADD("combining definition and declaration");
 
      if (Config_getBool(RESOLVE_UNNAMED_PARAMS))
      {
        mdec->resolveUnnamedParameters(mdef);
      }
 
      // check if the definition documents its own parameters, before the documentation is merged
      bool mdefHasParamDocs = hasParamCommand(mdef->documentation());
      for (const Argument &a : mdefAl)
      {
        if (!a.docs.empty()) mdefHasParamDocs = true; // e.g. with ///< comments
      }
 
      // first merge argument documentation
      transferArgumentDocumentation(mdecAl,mdefAl);
 
      // get the detailed descriptions before the brief descriptions are copied, since a brief
      // description copied to a member that already has one is added to its detailed description
      DString mdefDocs   = mdef->documentation();
      DString mdecDocs   = mdec->documentation();
      DString mdefFile   = mdef->docFile();
      DString mdecFile   = mdec->docFile();
      int mdefLine        = mdef->docLine();
      int mdecLine        = mdec->docLine();
      bool mdefDocsForDef = mdef->isDocsForDefinition();
      bool mdecDocsForDef = mdec->isDocsForDefinition();
 
      // copy brief description between definition and declaration
      DString mdefBrief     = mdef->briefDescription();
      DString mdecBrief     = mdec->briefDescription();
      DString mdefBriefFile = mdef->briefFile();
      DString mdecBriefFile = mdec->briefFile();
      int mdefBriefLine      = mdef->briefLine();
      int mdecBriefLine      = mdec->briefLine();
      if (!mdef->isDocTransferDone() && !mdecBrief.empty())
      {
        mdef->setBriefDescription(mdecBrief,mdecBriefFile,mdecBriefLine);
      }
      if (!mdec->isDocTransferDone() && !mdefBrief.empty())
      {
        mdec->setBriefDescription(mdefBrief,mdefBriefFile,mdefBriefLine);
      }
 
      // copy detailed description between definition and declaration
      if (!mdec->isDocTransferDone() && !mdefDocs.empty())
      {
        //printf("transferring docs mdef->mdec (%s->%s)\n",mdef->argsString(),mdec->argsString());
        mdec->setDocumentation(mdefDocs,mdefFile,mdefLine);
        mdec->setDocsForDefinition(mdefDocsForDef);
        if (mdefAl.hasParameters())
        {
          auto mdefAlComb = stringToArgumentList(mdef->getLanguage(),mdef->argsString());
          transferArgumentDocumentation(mdefAl,*mdefAlComb);
          mdec->moveArgumentList(std::move(mdefAlComb));
        }
      }
      if (!mdef->isDocTransferDone() && !mdecDocs.empty())
      {
        //printf("transferring docs mdec->mdef (%s->%s)\n",mdec->argsString(),mdef->argsString());
        mdef->setDocumentation(mdecDocs,mdecFile,mdecLine);
        // only use the parameters of the declaration if the definition does not document its own
        if (!mdefHasParamDocs)
        {
          mdef->setDocsForDefinition(mdecDocsForDef);
          if (mdecAl.hasParameters())
          {
            auto mdecAlComb = stringToArgumentList(mdec->getLanguage(),mdec->argsString());
            transferArgumentDocumentation(mdecAl,*mdecAlComb);
            mdef->moveDeclArgumentList(std::move(mdecAlComb));
          }
        }
      }
 
      // copy inbody documentation between definition and declaration
      DString mdefInbodyDocs = mdef->inbodyDocumentation();
      DString mdecInbodyDocs = mdec->inbodyDocumentation();
      DString mdefInbodyFile = mdef->inbodyFile();
      DString mdecInbodyFile = mdec->inbodyFile();
      int mdefInbodyLine      = mdef->inbodyLine();
      int mdecInbodyLine      = mdec->inbodyLine();
      if (!mdec->isDocTransferDone() && !mdefInbodyDocs.empty())
      {
        mdec->setInbodyDocumentation(mdefInbodyDocs,mdefInbodyFile,mdefInbodyLine);
      }
      if (!mdef->isDocTransferDone() && !mdecInbodyDocs.empty())
      {
        mdef->setInbodyDocumentation(mdecInbodyDocs,mdecInbodyFile,mdecInbodyLine);
      }
 
      if (mdec->getStartBodyLine()!=-1 && mdef->getStartBodyLine()==-1)
      {
        //printf("body mdec->mdef %d-%d\n",mdec->getStartBodyLine(),mdef->getEndBodyLine());
        mdef->setBodySegment(mdec->getDefLine(),mdec->getStartBodyLine(),mdec->getEndBodyLine());
        mdef->setBodyDef(mdec->getBodyDef());
        //mdef->setBodyMember(mdec);
      }
      else if (mdef->getStartBodyLine()!=-1 && mdec->getStartBodyLine()==-1)
      {
        //printf("body mdef->mdec %d-%d\n",mdef->getStartBodyLine(),mdec->getEndBodyLine());
        mdec->setBodySegment(mdef->getDefLine(),mdef->getStartBodyLine(),mdef->getEndBodyLine());
        mdec->setBodyDef(mdef->getBodyDef());
        //mdec->setBodyMember(mdef);
      }
      mdec->mergeMemberSpecifiers(mdef->getMemberSpecifiers());
      mdef->mergeMemberSpecifiers(mdec->getMemberSpecifiers());
 
      // copy group info.
      if (mdec->getGroupDef()==nullptr && mdef->getGroupDef()!=nullptr)
      {
        mdec->setGroupDef(mdef->getGroupDef(),
            mdef->getGroupPri(),
            mdef->docFile(),
            mdef->docLine(),
            mdef->hasDocumentation(),
            mdef
            );
      }
      else if (mdef->getGroupDef()==nullptr && mdec->getGroupDef()!=nullptr)
      {
        mdef->setGroupDef(mdec->getGroupDef(),
            mdec->getGroupPri(),
            mdec->docFile(),
            mdec->docLine(),
            mdec->hasDocumentation(),
            mdec
            );
      }
 
 
      mdec->mergeRefItems(mdef);
      mdef->mergeRefItems(mdec);
 
      mdef->setMemberDeclaration(mdec);
      mdec->setMemberDefinition(mdef);
 
      mergeMemberOverrideOptions(mdec,mdef);
 
      mdef->addQualifiers(mdec->getQualifiers());
      mdec->addQualifiers(mdef->getQualifiers());
 
      mdef->setDocTransferDone();
      mdec->setDocTransferDone();
    }
  }
}

References MemberDefMutable::addQualifiers(), MemberDef::argsString(), MemberDef::argumentList(), AUTO_TRACE, AUTO_TRACE_ADD, Definition::briefDescription(), Definition::briefFile(), Definition::briefLine(), Config_getBool, Definition::docFile(), Definition::docLine(), Definition::documentation(), DString::empty(), Definition::getBodyDef(), Definition::getDefLine(), Definition::getEndBodyLine(), MemberDef::getFileDef(), MemberDef::getGroupDef(), MemberDef::getGroupPri(), Definition::getLanguage(), MemberDef::getMemberSpecifiers(), Definition::getOuterScope(), MemberDef::getQualifiers(), Definition::getStartBodyLine(), Definition::hasDocumentation(), hasParamCommand(), ArgumentList::hasParameters(), Definition::inbodyDocumentation(), Definition::inbodyFile(), Definition::inbodyLine(), MemberDef::isDocsForDefinition(), MemberDef::isDocTransferDone(), MemberDef::isExternal(), MemberDef::isFunction(), MemberDef::isPrototype(), MemberDef::isStatic(), MemberDef::isVariable(), matchArguments2(), mergeMemberOverrideOptions(), MemberDefMutable::mergeMemberSpecifiers(), DefinitionMutable::mergeRefItems(), MemberDefMutable::moveArgumentList(), MemberDefMutable::moveDeclArgumentList(), Definition::name(), MemberDefMutable::resolveUnnamedParameters(), DefinitionMutable::setBodyDef(), DefinitionMutable::setBodySegment(), DefinitionMutable::setBriefDescription(), MemberDefMutable::setDocsForDefinition(), MemberDefMutable::setDocTransferDone(), DefinitionMutable::setDocumentation(), MemberDefMutable::setGroupDef(), DefinitionMutable::setInbodyDocumentation(), MemberDefMutable::setMemberDeclaration(), MemberDefMutable::setMemberDefinition(), ArgumentList::size(), stringToArgumentList(), MemberDef::templateArguments(), transferArgumentDocumentation(), and MemberDef::typeString().

Referenced by ClassDefImpl::mergeCategory(), transferFunctionDocumentation(), and MemberDefMutable::writeTagFile().

createMemberDef()

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.

Definition at line 526 of file memberdef.cpp.

{
  return std::make_unique<MemberDefImpl>(defFileName,defLine,defColumn,type,name,args,excp,prot,virt,
                           stat,related,t,tal,al,metaData);
}

Referenced by addEnumValuesToEnums(), addGlobalFunction(), addInstance(), addInterfaceOrServiceToServiceOrSingleton(), addLocalObjCMethod(), addMemberSpecialization(), addMethodToClass(), addOverloaded(), addVariableToClass(), addVariableToFile(), buildDefineList(), createTagLessInstance(), MemberDefImpl::createTemplateInstanceMember(), createUsingMemberImportForClass(), findDefineDocumentation(), findEnums(), findMember(), findUsingDeclImports(), and MemberDefMutable::writeTagFile().

createMemberDefAlias()

std::unique_ptr< MemberDef > createMemberDefAlias	(	const Definition *	newScope,
		const MemberDef *	aliasMd )

Definition at line 980 of file memberdef.cpp.

{
  auto amd = std::make_unique<MemberDefAliasImpl>(newScope,aliasMd);
  //printf("amd: name=%s displayName=%s\n",qPrint(amd->name()),qPrint(amd->displayName()));
  return amd;
}

Referenced by MemberDefAliasImpl::deepCopy(), findUsingDeclImports(), NamespaceDefImpl::insertMember(), insertMemberAlias(), and MemberDefMutable::writeTagFile().

hasParamCommand()

bool hasParamCommand ( const DString & doc )

static

Definition at line 6229 of file memberdef.cpp.

{
  size_t i=0;
  while ((i=doc.find("param",i))!=DString::npos)
  {
    if (i>0 && (i+5>=doc.length() || !isId(doc[i+5])))
    {
      char c = doc[i-1];
      // a command needs whitespace before it, so that e.g. an e-mail address does not count
      if (c=='<' || ((c=='\\' || c=='@') && (i==1 || disspace(doc[i-2]))))
      {
        return true;
      }
    }
    i+=5;
  }
  return false;
}

References disspace(), DString::find(), isId(), DString::length(), and DString::npos.

Referenced by combineDeclarationAndDefinition(), and MemberDefImpl::detectUndocumentedParams().

invalidateCachedTypesInArgumentList()

void invalidateCachedTypesInArgumentList ( ArgumentList & al )

static

Definition at line 6164 of file memberdef.cpp.

{
  for (Argument &a : al)
  {
    a.canType.clear();
  }
}

Referenced by MemberDefImpl::invalidateCachedArgumentTypes().

mergeMemberOverrideOptions()

void mergeMemberOverrideOptions	(	MemberDefMutable *	md1,
		MemberDefMutable *	md2 )

Definition at line 6418 of file memberdef.cpp.

{
  if (Config_getBool(CALL_GRAPH)  !=md1->hasCallGraph())   md2->overrideCallGraph(md1->hasCallGraph());
  if (Config_getBool(CALLER_GRAPH)!=md1->hasCallerGraph()) md2->overrideCallerGraph(md1->hasCallerGraph());
  if (Config_getBool(CALL_GRAPH)  !=md2->hasCallGraph())   md1->overrideCallGraph( md2->hasCallGraph());
  if (Config_getBool(CALLER_GRAPH)!=md2->hasCallerGraph()) md1->overrideCallerGraph(md2->hasCallerGraph());
 
  if (Config_getBool(SHOW_ENUM_VALUES)  !=md1->hasEnumValues())   md2->overrideEnumValues(md1->hasEnumValues());
  if (Config_getBool(SHOW_ENUM_VALUES)  !=md2->hasEnumValues())   md1->overrideEnumValues( md2->hasEnumValues());
 
  if (Config_getBool(REFERENCED_BY_RELATION)!=md1->hasReferencedByRelation()) md2->overrideReferencedByRelation(md1->hasReferencedByRelation());
  if (Config_getBool(REFERENCES_RELATION)   !=md1->hasReferencesRelation())   md2->overrideReferencesRelation(md1->hasReferencesRelation());
  if (Config_getBool(REFERENCED_BY_RELATION)!=md2->hasReferencedByRelation()) md1->overrideReferencedByRelation(md2->hasReferencedByRelation());
  if (Config_getBool(REFERENCES_RELATION)   !=md2->hasReferencesRelation())   md1->overrideReferencesRelation(md2->hasReferencesRelation());
 
  if (Config_getBool(INLINE_SOURCES)!=md1->hasInlineSource()) md2->overrideInlineSource(md1->hasInlineSource());
  if (Config_getBool(INLINE_SOURCES)!=md2->hasInlineSource()) md1->overrideInlineSource(md2->hasInlineSource());
}

References Config_getBool, MemberDef::hasCallerGraph(), MemberDef::hasCallGraph(), MemberDef::hasEnumValues(), MemberDef::hasInlineSource(), MemberDef::hasReferencedByRelation(), MemberDef::hasReferencesRelation(), MemberDefMutable::overrideCallerGraph(), MemberDefMutable::overrideCallGraph(), MemberDefMutable::overrideEnumValues(), MemberDefMutable::overrideInlineSource(), MemberDefMutable::overrideReferencedByRelation(), and MemberDefMutable::overrideReferencesRelation().

Referenced by combineDeclarationAndDefinition(), findFriends(), and MemberDefMutable::writeTagFile().

simplifyTypeForTable()

DString simplifyTypeForTable ( const DString & s )

static

Definition at line 4012 of file memberdef.cpp.

{
  DString ts=removeAnonymousScopes(s);
  if (ts.endsWith("::")) ts = ts.left(ts.length()-2);
  static const reg::Ex re1(R"(\a\w*::)");       // non-template version
  static const reg::Ex re2(R"(\a\w*<[^>]*>::)"); // template version
  reg::Match match;
  std::string t = ts.str();
  while (reg::search(t,match,re2) || reg::search(t,match,re1))
  {
    t = match.prefix().str() + match.suffix().str(); // remove the matched part
  }
  //printf("simplifyTypeForTable(%s)->%s\n",qPrint(s),qPrint(t));
  return t;
}

References DString::endsWith(), DString::left(), DString::length(), removeAnonymousScopes(), reg::search(), and DString::str().

Referenced by MemberDefImpl::fieldType().

stripTrailingReturn()

DString stripTrailingReturn ( const DString & trailRet )

static

Definition at line 4240 of file memberdef.cpp.

{
  DString ret = trailRet;
 
  ret = ret.stripWhiteSpace();
  if (ret.startsWith("->"))
  {
    ret = ret.mid(2).stripWhiteSpace();
    return ret;
  }
  return trailRet;
}

References DString::mid(), DString::startsWith(), and DString::stripWhiteSpace().

Referenced by MemberDefImpl::warnIfUndocumentedParams().

toMemberDef() [1/3]

const MemberDef * toMemberDef

(

const Definition *

d

)

Definition at line 6641 of file memberdef.cpp.

{
  if (d && (typeid(*d)==typeid(MemberDefImpl) || typeid(*d)==typeid(MemberDefAliasImpl)))
  {
    return static_cast<const MemberDef*>(d);
  }
  else
  {
    return nullptr;
  }
}

toMemberDef() [2/3]

MemberDef * toMemberDef

(

Definition *

d

)

Definition at line 6616 of file memberdef.cpp.

{
  if (d && (typeid(*d)==typeid(MemberDefImpl) || typeid(*d)==typeid(MemberDefAliasImpl)))
  {
    return static_cast<MemberDef*>(d);
  }
  else
  {
    return nullptr;
  }
}

Referenced by codeFolding(), DefinitionImpl::computeTooltip(), definitionToName(), DocRef::DocRef(), dumpSymbol(), findMemberLink(), findUsingDeclImports(), generateClassOrGlobalLink(), RequirementManager::generatePage(), getDefs(), MemberDefAliasImpl::getMdAlias(), MemberDefAliasImpl::getMdAlias(), getMemberFromSymbol(), SymbolResolver::Private::getResolvedSymbol(), SymbolResolver::Private::getResolvedType(), getSQLDocBlock(), SymbolResolver::Private::isAccessibleFrom(), SymbolResolver::Private::isAccessibleFromWithExpScope(), isFileLocalStatic(), DocParser::processCopyDoc(), SymbolResolver::resolveSymbol(), resolveUserReferences(), SearchIndex::setCurrentDoc(), SearchIndexExternal::setCurrentDoc(), SymbolResolver::Private::substTypedef(), DefinitionImpl::writeInlineCode(), writeJavasScriptSearchDataPage(), writeObjCMethodCall(), MemberDefMutable::writeTagFile(), DefinitionImpl::writeToc(), and TooltipManager::writeTooltips().

toMemberDef() [3/3]

MemberDef * toMemberDef

(

DefinitionMutable *

md

)

Definition at line 6628 of file memberdef.cpp.

{
  Definition *d = toDefinition(md);
  if (d && typeid(*d)==typeid(MemberDefImpl))
  {
    return static_cast<MemberDef*>(d);
  }
  else
  {
    return nullptr;
  }
}

References toDefinition().

toMemberDefMutable()

MemberDefMutable * toMemberDefMutable

(

Definition *

d

)

Definition at line 6653 of file memberdef.cpp.

{
  if (d && typeid(*d)==typeid(MemberDefImpl))
  {
    return static_cast<MemberDefMutable*>(d);
  }
  else
  {
    return nullptr;
  }
}

Referenced by addDocCrossReference(), addEnumValuesToEnums(), addGlobalFunction(), addInstance(), addInterfaceOrServiceToServiceOrSingleton(), MemberList::addListReferences(), addLocalObjCMethod(), addMemberFunction(), addMemberSpecialization(), addMembersToMemberGroup(), addMemberToGroups(), ClassDefImpl::addMemberToList(), FileDefImpl::addMemberToList(), ModuleDefImpl::addMemberToList(), NamespaceDefImpl::addMemberToList(), ModuleDefImpl::addMemberToModule(), ModuleManager::addMemberToModule(), ClassDefImpl::addMemberToTemplateInstance(), addMethodToClass(), addOverloaded(), MemberList::addRequirementReferences(), addVariableToClass(), addVariableToFile(), associateVariableWithAnonymousEnumType(), buildDefineList(), buildFunctionList(), buildTypedefList(), computeMemberRelationsForBaseClass(), createTagLessInstance(), MemberDefImpl::createTemplateInstanceMember(), createUsingMemberImportForClass(), ClassDefImpl::deepCopy(), MemberGroup::distributeMemberGroupDocumentation(), findDefineDocumentation(), findDEV(), findEnumDocumentation(), findEnums(), findFriends(), findGlobalMember(), findMember(), MemberList::findSectionsInDocumentation(), findUsingDeclImports(), flushCachedTemplateRelations(), flushUnresolvedRelations(), generateClassMemberLink(), generateClassOrGlobalLink(), getLinkInScope(), ClassDefImpl::hideDerivedVariablesInPython(), incrementFlowKeyWordCount(), incrementFlowKeyWordCount(), inheritDocumentation(), GroupDefImpl::insertMember(), MemberGroup::insertMember(), NamespaceDefImpl::insertMember(), MemberDefImpl::insertReimplementedBy(), ClassDefImpl::mergeCategory(), ClassDefImpl::mergeMembersFromBaseClasses(), SymbolResolver::Private::newResolveTypedef(), processTagLessClassesForList(), MemberList::setAnchors(), MemberList::setAnonymousEnumType(), ClassDefImpl::setGroupDefForAllMembers(), transferFunctionDocumentation(), transferFunctionReferences(), transferRelatedFunctionDocumentation(), transferStaticInstanceInitializers(), tryAddEnumDocsToGroupMember(), vhdlCorrectMemberProperties(), MemberList::writeDocumentation(), MemberList::writeDocumentationPage(), VhdlDocGen::writePlainVHDLDeclarations(), MemberList::writeSimpleDocumentation(), VhdlDocGen::writeSource(), MemberDefMutable::writeTagFile(), and MemberList::writeTagFile().

transferArgumentDocumentation()

void transferArgumentDocumentation ( ArgumentList & decAl, ArgumentList & defAl )

static

Definition at line 6197 of file memberdef.cpp.

{
  for (auto decIt = decAl.begin(), defIt = defAl.begin();
            decIt!= decAl.end() && defIt!= defAl.end();
          ++decIt,               ++defIt)
  {
    Argument &decA = *decIt;
    Argument &defA = *defIt;
    if (decA.docs.empty() && !defA.docs.empty())
    {
      decA.docs = defA.docs;
    }
    else if (defA.docs.empty() && !decA.docs.empty())
    {
      defA.docs = decA.docs;
    }
    //printf("transferArgumentDocumentation(%s<->%s)\n",qPrint(decA.name),qPrint(defA.name));
    if (Config_getBool(RESOLVE_UNNAMED_PARAMS))
    {
      if (decA.name.empty() && !defA.name.empty())
      {
        decA.name = defA.name;
      }
      else if (defA.name.empty() && !decA.name.empty())
      {
        defA.name = decA.name;
      }
    }
  }
}

References ArgumentList::begin(), Config_getBool, Argument::docs, DString::empty(), ArgumentList::end(), and Argument::name.

Referenced by combineDeclarationAndDefinition().

writeDefArgumentList()

bool writeDefArgumentList ( OutputList & ol, const Definition * scope, const MemberDef * md )

static

Definition at line 1081 of file memberdef.cpp.

{
  const ArgumentList &defArgList=(md->isDocsForDefinition()) ?
                             md->argumentList() : md->declArgumentList();
  //printf("writeDefArgumentList '%s' isDocsForDefinition()=%d hasParameters()=%d (%s)\n",
  //    qPrint(md->name()),md->isDocsForDefinition(),defArgList.hasParameters(),qPrint(argListToString(defArgList)));
  if (!defArgList.hasParameters() || md->isProperty() || md->isTypedef())
  {
    return false; // member has no function like argument list
  }
 
  bool isDefine = md->isDefine();
  if (!isDefine) ol.docify(" ");
 
  //printf("writeDefArgList(%d)\n",defArgList->count());
  ol.endMemberDocName();
  ol.startParameterList(!md->isObjCMethod());
  //printf("===> name=%s isDefine=%d\n",qPrint(md->name()),md->isDefine());
 
  DString cName;
  if (scope)
  {
    cName=scope->name();
    size_t il=cName.find('<');
    size_t ir=cName.rfind('>');
    if (il!=DString::npos && ir!=DString::npos && ir>il)
    {
      cName=cName.mid(il,ir-il+1);
      //printf("1. cName=%s\n",qPrint(cName));
    }
    else if (scope->definitionType()==Definition::TypeClass)
    {
      cName=tempArgListToString((toClassDef(scope))->templateArguments(),
                             scope->getLanguage());
      //printf("2. cName=%s\n",qPrint(cName));
    }
    else // no template specifier
    {
      cName.clear();
    }
  }
  //printf("~~~ %s cName=%s\n",qPrint(md->name()),qPrint(cName));
 
  DString sep = getLanguageSpecificSeparator(md->getLanguage(),true);
 
  LinkifyTextOptions options;
  options.setScope(scope).setFileScope(md->getBodyDef()).setSelf(md);
 
  bool first=true;
  bool paramTypeStarted=false;
  auto alIt = defArgList.begin();
  while (alIt!=defArgList.end())
  {
    Argument a = *alIt;
    if (isDefine || first)
    {
      ol.startParameterType(first,DString());
      paramTypeStarted=true;
      if (isDefine)
      {
        ol.endParameterType();
        ol.startParameterName(true);
      }
    }
 
    if (!a.attrib.empty() && !md->isObjCMethod()) // argument has an IDL attribute
    {
      ol.docify(a.attrib+" ");
    }
 
    DString atype = a.type;
    if (sep!="::") { atype=substitute(atype,"::",sep); }
 
    size_t funcPtrPos=DString::npos;
    {
      if (md->isObjCMethod()) { atype.prepend("("); atype.append(")"); }
      if (atype!="...")
      {
        if (!cName.empty() && scope && scope!=Doxygen::globalScope)
        {
          atype=addTemplateNames(atype,scope->name(),cName);
        }
        // 1. split ...*)(... -> '*' + name + ')(...'
        // 2. split ...*[some thing])(... -> '*' + name + '[some thing])(...'
        size_t starPos = atype.find('*');                       // find pointer
        if (starPos==DString::npos) starPos = atype.find('&'); // can also be reference
        funcPtrPos = atype.find(")(");
        if (starPos!=DString::npos && funcPtrPos!=DString::npos && funcPtrPos>starPos)
        {
          funcPtrPos=starPos+1;
        }
        else
        {
          funcPtrPos=DString::npos;
        }
        linkifyText(TextGeneratorOLImpl(ol),
                    funcPtrPos==DString::npos ? atype : atype.left(funcPtrPos),
                    options);
      }
    }
 
    if (!isDefine)
    {
      if (paramTypeStarted)
      {
        ol.endParameterType();
        paramTypeStarted=false;
      }
      ol.startParameterName(defArgList.size()<2);
    }
    else
    {
      ol.endParameterName();
    }
 
    if (atype=="...")
    {
      ol.docify(atype);
    }
    else if (!a.name.empty()) // argument has a name
    {
      ol.docify(a.name);
    }
    if (!isDefine)
    {
      if (funcPtrPos!=DString::npos)
      {
        ol.writeNonBreakableSpace(1);
      }
      ol.endParameterName();
    }
    ol.startParameterExtra();
    if (funcPtrPos!=DString::npos)
    {
      linkifyText(TextGeneratorOLImpl(ol),atype.mid(funcPtrPos),options);
    }
    if (!a.array.empty())
    {
      ol.docify(a.array);
    }
    if (!a.defval.empty()) // write the default value
    {
      DString n=a.defval;
      if (scope && scope!=Doxygen::globalScope && !cName.empty())
      {
        n=addTemplateNames(n,scope->name(),cName);
      }
      ol.startParameterDefVal(" = ");
      linkifyText(TextGeneratorOLImpl(ol),n,LinkifyTextOptions(options).setKeepSpaces(true));
      ol.endParameterDefVal();
    }
    ++alIt;
    if (alIt!=defArgList.end())
    {
      a = *alIt;
      if (!md->isObjCMethod()) ol.docify(", "); // there are more arguments
      if (!isDefine)
      {
        DString key;
        if (md->isObjCMethod() && a.attrib.length()>=2)
        {
          //printf("Found parameter keyword %s\n",a.qPrint(attrib));
          // strip [ and ]
          key=a.attrib.mid(1,a.attrib.length()-2);
          if (key!=",") key+=":"; // for normal keywords add colon
        }
        ol.endParameterExtra(false,false,!md->isObjCMethod());
        ol.startParameterType(false,key);
        paramTypeStarted=true;
      }
      else // isDefine
      {
        ol.endParameterExtra(false,false,true);
      }
    }
    first=false;
  }
  if (first)
  {
    ol.startParameterName(defArgList.size()<2);
    ol.endParameterName();
    ol.startParameterExtra();
  }
  ol.endParameterExtra(true,defArgList.size()<2,!md->isObjCMethod());
  if (!md->extraTypeChars().empty())
  {
    ol.docify(md->extraTypeChars());
  }
  if (defArgList.constSpecifier())
  {
    ol.docify(" const");
  }
  if (defArgList.volatileSpecifier())
  {
    ol.docify(" volatile");
  }
  if (defArgList.refQualifier()==RefQualifierType::LValue)
  {
    ol.docify(" &");
  }
  else if (defArgList.refQualifier()==RefQualifierType::RValue)
  {
    ol.docify(" &&");
  }
  if (!defArgList.trailingReturnType().empty())
  {
    linkifyText(TextGeneratorOLImpl(ol), defArgList.trailingReturnType(), options);
  }
  return true;
}

References addTemplateNames(), DString::append(), MemberDef::argumentList(), Argument::array, Argument::attrib, ArgumentList::begin(), DString::clear(), ArgumentList::constSpecifier(), MemberDef::declArgumentList(), Definition::definitionType(), Argument::defval, OutputList::docify(), DString::empty(), ArgumentList::end(), OutputList::endMemberDocName(), OutputList::endParameterDefVal(), OutputList::endParameterExtra(), OutputList::endParameterName(), OutputList::endParameterType(), MemberDef::extraTypeChars(), DString::find(), Definition::getBodyDef(), Definition::getLanguage(), getLanguageSpecificSeparator(), Doxygen::globalScope, ArgumentList::hasParameters(), MemberDef::isDefine(), MemberDef::isDocsForDefinition(), MemberDef::isObjCMethod(), MemberDef::isProperty(), MemberDef::isTypedef(), DString::left(), DString::length(), linkifyText(), LValue, DString::mid(), Argument::name, Definition::name(), DString::npos, DString::prepend(), ArgumentList::refQualifier(), DString::rfind(), RValue, LinkifyTextOptions::setFileScope(), LinkifyTextOptions::setScope(), LinkifyTextOptions::setSelf(), ArgumentList::size(), OutputList::startParameterDefVal(), OutputList::startParameterExtra(), OutputList::startParameterList(), OutputList::startParameterName(), OutputList::startParameterType(), substitute(), tempArgListToString(), toClassDef(), ArgumentList::trailingReturnType(), Argument::type, Definition::TypeClass, ArgumentList::volatileSpecifier(), and OutputList::writeNonBreakableSpace().

Referenced by MemberDefImpl::writeDocumentation().

writeExceptionList()

void writeExceptionList ( OutputList & ol, const ClassDef * cd, const MemberDef * md )

static

Definition at line 1331 of file memberdef.cpp.

{
  DString exception = md->excpString().stripWhiteSpace();
  if (exception.at(0)=='{')
  {
    // this is an UNO IDL attribute - need special handling
    size_t index = exception.find(';');
    size_t oldIndex = 1;
    while (index!=DString::npos) // there should be no more than 2 (set / get)
    {
      // omit '{' and ';' -> "set raises (...)"
      writeExceptionListImpl(ol,cd,md,exception.mid(oldIndex,index-oldIndex));
      oldIndex = index+1;
      index = exception.find(';',oldIndex);
    }
    // the rest is now just '}' - omit that
  }
  else
  {
    writeExceptionListImpl(ol,cd,md,exception);
  }
}

References DString::at(), MemberDef::excpString(), DString::find(), DString::mid(), DString::npos, DString::stripWhiteSpace(), and writeExceptionListImpl().

Referenced by MemberDefImpl::writeDocumentation().

writeExceptionListImpl()

void writeExceptionListImpl ( OutputList & ol, const ClassDef * cd, const MemberDef * md, DString const & exception )

static

Definition at line 1292 of file memberdef.cpp.

{
  // this is ordinary exception spec - there must be a '('
  //printf("exception='%s'\n",qPrint(exception));
  size_t index = exception.find('(');
  LinkifyTextOptions options;
  options.setScope(cd).setFileScope(md->getBodyDef()).setSelf(md);
  if (index!=DString::npos)
  {
    ol.exceptionEntry(exception.left(index),false);
    ++index; // paren in second column so skip it here
    for (size_t comma = exception.find(',', index); comma!=DString::npos; )
    {
      ++comma; // include comma
      linkifyText(TextGeneratorOLImpl(ol),exception.mid(index,comma-index),options);
      ol.exceptionEntry(DString(),false);
      index=comma;
      comma = exception.find(',', index);
    }
    if (size_t close = exception.find(')', index); close!=DString::npos)
    {
      DString type=removeRedundantWhiteSpace(exception.mid(index,close-index));
      linkifyText(TextGeneratorOLImpl(ol),type,options);
      ol.exceptionEntry(DString(),true);
    }
    else
    {
      warn(md->getDefFileName(),md->getDefLine(),
          "missing ) in exception list on member {}",md->name());
    }
  }
  else // Java Exception
  {
    ol.docify(" ");
    linkifyText(TextGeneratorOLImpl(ol),exception,options);
  }
}

References OutputList::docify(), OutputList::exceptionEntry(), DString::find(), Definition::getBodyDef(), Definition::getDefFileName(), Definition::getDefLine(), DString::left(), linkifyText(), DString::mid(), Definition::name(), DString::npos, removeRedundantWhiteSpace(), LinkifyTextOptions::setFileScope(), LinkifyTextOptions::setScope(), LinkifyTextOptions::setSelf(), and warn.

Referenced by writeExceptionList().

writePageRef()

void writePageRef ( OutputList & ol, const DString & cn, const DString & mn )

static

Definition at line 989 of file memberdef.cpp.

{
  ol.pushGeneratorState();
 
  ol.disable(OutputType::Html);
  ol.disable(OutputType::Man);
  ol.disable(OutputType::Docbook);
  if (Config_getBool(PDF_HYPERLINKS)) ol.disable(OutputType::Latex);
  if (Config_getBool(RTF_HYPERLINKS)) ol.disable(OutputType::RTF);
  ol.startPageRef();
  ol.docify(theTranslator->trPageAbbreviation());
  ol.endPageRef(cn,mn);
 
  ol.popGeneratorState();
}

References Config_getBool, OutputList::disable(), Docbook, OutputList::docify(), OutputList::endPageRef(), Html, Latex, Man, OutputList::popGeneratorState(), OutputList::pushGeneratorState(), RTF, OutputList::startPageRef(), theTranslator, and Translator::trPageAbbreviation().

Referenced by MemberDefImpl::_writeReimplementedBy(), and MemberDefImpl::_writeReimplements().

Variable Documentation

g_detectUndocumentedParamsMutex

std::mutex g_detectUndocumentedParamsMutex

static

Definition at line 4253 of file memberdef.cpp.

Referenced by MemberDefImpl::detectUndocumentedParams().

g_docCrossReferenceMutex

std::mutex g_docCrossReferenceMutex

static

Definition at line 6561 of file memberdef.cpp.

Referenced by addDocCrossReference().

g_hasDetailedDescriptionMutex

std::mutex g_hasDetailedDescriptionMutex

static

Definition at line 2629 of file memberdef.cpp.

Referenced by MemberDefImpl::hasDetailedDescription().

reAnonymous

const reg::Ex reAnonymous(R"([\w:@]*@\d+)") ( R"([\w:@]*@\d+)" )

static

Referenced by MemberDefImpl::displayDefinition(), and MemberDefImpl::writeDocumentation().