SymbolResolver类 参考

Helper class to find a class definition or check if A symbol is accessible in a given scope. 更多...

#include <symbolresolver.h>

类
struct	Private

Public 成员函数
	SymbolResolver (const FileDef *fileScope=0)
	~SymbolResolver ()
const ClassDef *	resolveClass (const Definition *scope, const QCString &name, bool maybeUnlinkable=false, bool mayBeHidden=false)
	Find the class definition matching name within the scope set. 更多...
ClassDefMutable *	resolveClassMutable (const Definition *scope, const QCString &name, bool mayBeUnlinkable=false, bool mayBeHidden=false)
	Wrapper around resolveClass that returns a mutable interface to the class object or a nullptr if the symbol is immutable. 更多...
int	isAccessibleFrom (const Definition *scope, const Definition *item)
	Checks if symbol item is accessible from within scope. 更多...
int	isAccessibleFromWithExpScope (const Definition *scope, const Definition *item, const QCString &explicitScopePart)
	Check if symbol item is accessible from within scope, where it has to match the explicitScopePart. 更多...
void	setFileScope (const FileDef *fd)
	Sets or updates the file scope using when resolving symbols. 更多...
const MemberDef *	getTypedef () const
	In case a call to resolveClass() resolves to a type member (e.g. 更多...
QCString	getTemplateSpec () const
	In case a call to resolveClass() points to a template specialization, the template part is return via this method. 更多...
QCString	getResolvedType () const
	In case a call to resolveClass() points to a typedef or using declaration. 更多...

Private 属性
std::unique_ptr< Private >	p

详细描述

Helper class to find a class definition or check if A symbol is accessible in a given scope.

在文件 symbolresolver.h 第 30 行定义.

构造及析构函数说明

SymbolResolver()

SymbolResolver::SymbolResolver ( const FileDef *  fileScope = 0 )

explicit

在文件 symbolresolver.cpp 第 1023 行定义.

  : p(std::make_unique<Private>(fileScope))
{
}

~SymbolResolver()

SymbolResolver::~SymbolResolver

(

)

在文件 symbolresolver.cpp 第 1028 行定义.

{
}

成员函数说明

getResolvedType()

QCString SymbolResolver::getResolvedType

(

)

const

In case a call to resolveClass() points to a typedef or using declaration.

The type name it resolved to is returned via this method.

在文件 symbolresolver.cpp 第 1113 行定义.

{
  return p->resolvedType;
}

引用了 p.

被这些函数引用 getCanonicalTypeForIdentifier().

getTemplateSpec()

QCString SymbolResolver::getTemplateSpec

(

)

const

In case a call to resolveClass() points to a template specialization, the template part is return via this method.

在文件 symbolresolver.cpp 第 1108 行定义.

{
  return p->templateSpec;
}

引用了 p.

被这些函数引用 findClassRelation() , 以及 getCanonicalTypeForIdentifier().

getTypedef()

const MemberDef * SymbolResolver::getTypedef

(

)

const

In case a call to resolveClass() resolves to a type member (e.g.

an enum) this method will return it.

在文件 symbolresolver.cpp 第 1103 行定义.

{
  return p->typeDef;
}

引用了 p.

被这些函数引用 findClassRelation(), getCanonicalTypeForIdentifier(), getDefs() , 以及 linkifyText().

isAccessibleFrom()

int SymbolResolver::isAccessibleFrom	(	const Definition *	scope,
		const Definition *	item
	)

Checks if symbol item is accessible from within scope.

返回

-1 if item is not accessible or a number indicating how many scope levels up the nearest match was found.

在文件 symbolresolver.cpp 第 1082 行定义.

{
  p->reset();
  AccessStack accessStack;
  return p->isAccessibleFrom(accessStack,scope,item);
}

引用了 p.

被这些函数引用 SymbolResolver::Private::isAccessibleFrom(), SymbolResolver::Private::isAccessibleFromWithExpScope() , 以及 resolveTypeDef().

isAccessibleFromWithExpScope()

int SymbolResolver::isAccessibleFromWithExpScope	(	const Definition *	scope,
		const Definition *	item,
		const QCString &	explicitScopePart
	)

Check if symbol item is accessible from within scope, where it has to match the explicitScopePart.

返回

-1 if item is not accessible or a number indicating how many scope levels up the nearest match was found.

在文件 symbolresolver.cpp 第 1089 行定义.

{
  p->reset();
  VisitedNamespaces visitedNamespaces;
  AccessStack accessStack;
  return p->isAccessibleFromWithExpScope(visitedNamespaces,accessStack,scope,item,explicitScopePart);
}

引用了 p.

被这些函数引用 getMemberFromSymbol(), SymbolResolver::Private::getResolvedSymbol(), SymbolResolver::Private::isAccessibleFromWithExpScope() , 以及 SymbolResolver::Private::substTypedef().

resolveClass()

const ClassDef * SymbolResolver::resolveClass	(	const Definition *	scope,
		const QCString &	name,
		bool	maybeUnlinkable = false,
		bool	mayBeHidden = false
	)

Find the class definition matching name within the scope set.

参数

scope	The scope to search from.
name	The name of the symbol.
maybeUnlinkable	include unlinkable symbols in the search.
mayBeHidden	include hidden symbols in the search.

注解

As a result of this call the getters getTypedef(), getTemplateSpec(), and getResolvedType() are set as well.

在文件 symbolresolver.cpp 第 1033 行定义.

{
  p->reset();
 
  if (scope==0 ||
      (scope->definitionType()!=Definition::TypeClass &&
       scope->definitionType()!=Definition::TypeNamespace
      ) ||
      (scope->getLanguage()==SrcLangExt_Java && QCString(name).find("::")!=-1)
     )
  {
    scope=Doxygen::globalScope;
  }
  //fprintf(stderr,"------------ resolveClass(scope=%s,name=%s,mayUnlinkable=%d)\n",
  //    scope?qPrint(scope->name()):"<global>",
  //    name,
  //    mayBeUnlinkable
  //   );
  const ClassDef *result;
  if (Config_getBool(OPTIMIZE_OUTPUT_VHDL))
  {
    result = getClass(name);
  }
  else
  {
    result = p->getResolvedClassRec(scope,name,&p->typeDef,&p->templateSpec,&p->resolvedType);
    if (result==0) // for nested classes imported via tag files, the scope may not
                   // present, so we check the class name directly as well.
                   // See also bug701314
    {
      result = getClass(name);
    }
  }
  if (!mayBeUnlinkable && result && !result->isLinkable())
  {
    if (!mayBeHidden || !result->isHidden())
    {
      //printf("result was %s\n",result?qPrint(result->name()):"<none>");
      result=0; // don't link to artificial/hidden classes unless explicitly allowed
    }
  }
  //fprintf(stderr,"ResolvedClass(%s,%s)=%s\n",scope?qPrint(scope->name()):"<global>",
  //                                  name,result?qPrint(result->name()):"<none>");
  return result;
}

引用了 Config_getBool, Definition::definitionType(), getClass(), Definition::getLanguage(), Doxygen::globalScope, Definition::isHidden(), ClassDef::isLinkable(), p, SrcLangExt_Java, Definition::TypeClass , 以及 Definition::TypeNamespace.

被这些函数引用 findClassDefinition(), findClassWithinClassContext(), findUsingDeclImports(), getCanonicalTypeForIdentifier(), getDefs(), isVarWithConstructor(), linkifyText(), normalizeNonTemplateArgumentsInString() , 以及 resolveClassMutable().

resolveClassMutable()

ClassDefMutable* SymbolResolver::resolveClassMutable ( const Definition *  scope, const QCString &  name, bool  mayBeUnlinkable = false, bool  mayBeHidden = false  )

inline

Wrapper around resolveClass that returns a mutable interface to the class object or a nullptr if the symbol is immutable.

在文件 symbolresolver.h 第 55 行定义.

    {
      return toClassDefMutable(resolveClass(scope,name,mayBeUnlinkable,mayBeHidden));
    }

引用了 resolveClass() , 以及 toClassDefMutable().

被这些函数引用 ClassDefImpl::addTypeConstraint(), findClassRelation(), findUsedClassesForClass() , 以及 findUsingDeclarations().

setFileScope()

void SymbolResolver::setFileScope

(

const FileDef *

fd

)

Sets or updates the file scope using when resolving symbols.

在文件 symbolresolver.cpp 第 1098 行定义.

{
  p->setFileScope(fileScope);
}

引用了 p.

类成员变量说明

p

std::unique_ptr<Private> SymbolResolver::p

private

在文件 symbolresolver.h 第 101 行定义.

被这些函数引用 getResolvedType(), getTemplateSpec(), getTypedef(), isAccessibleFrom(), isAccessibleFromWithExpScope(), resolveClass() , 以及 setFileScope().

---

该类的文档由以下文件生成:

• src/symbolresolver.h
• src/symbolresolver.cpp