namespacedef.h File Reference

#include <memory>
#include <unordered_set>
#include "definition.h"
#include "filedef.h"
#include "linkedmap.h"
#include "membergroup.h"

Include dependency graph for namespacedef.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	NamespaceLinkedMap
class	NamespaceLinkedRefMap
class	NamespaceDef
	An abstract interface of a namespace symbol. More...
class	NamespaceDefMutable

Typedefs
using	NamespaceDefSet = std::unordered_set<const NamespaceDef*>

Functions
std::unique_ptr< NamespaceDef >	createNamespaceDef (const QCString &defFileName, int defLine, int defColumn, const QCString &name, const QCString &ref=QCString(), const QCString &refFile=QCString(), const QCString &type=QCString(), bool isPublished=false)
	Factory method to create new NamespaceDef instance.
std::unique_ptr< NamespaceDef >	createNamespaceDefAlias (const Definition *newScope, const NamespaceDef *nd)
	Factory method to create an alias of an existing namespace.
NamespaceDef *	toNamespaceDef (Definition *d)
NamespaceDef *	toNamespaceDef (DefinitionMutable *d)
const NamespaceDef *	toNamespaceDef (const Definition *d)
NamespaceDefMutable *	toNamespaceDefMutable (Definition *d)
void	replaceNamespaceAliases (QCString &name)
NamespaceDef *	getResolvedNamespace (const QCString &key)
NamespaceDefMutable *	getResolvedNamespaceMutable (const QCString &key)
bool	namespaceHasNestedNamespace (const NamespaceDef *nd)
bool	namespaceHasNestedConcept (const NamespaceDef *nd)
bool	namespaceHasNestedClass (const NamespaceDef *nd, bool filterClasses, ClassDef::CompoundType ct)

Typedef Documentation

NamespaceDefSet

using NamespaceDefSet = std::unordered_set<const NamespaceDef*>

Definition at line 39 of file namespacedef.h.

Function Documentation

createNamespaceDef()

std::unique_ptr< NamespaceDef > createNamespaceDef	(	const QCString &	defFileName,
		int	defLine,
		int	defColumn,
		const QCString &	name,
		const QCString &	ref = QCString(),
		const QCString &	refFile = QCString(),
		const QCString &	type = QCString(),
		bool	isPublished = false )

Factory method to create new NamespaceDef instance.

Definition at line 173 of file namespacedef.cpp.

{
  //printf("createNamespaceDef(%s)\n",qPrint(name));
  return std::make_unique<NamespaceDefImpl>(defFileName,defLine,defColumn,name,ref,refFile,type,isPublished);
}

Referenced by adjustConfiguration(), buildNamespaceList(), buildScopeFromQualifiedName(), findUsingDirectives(), and NamespaceDefMutable::setInline().

createNamespaceDefAlias()

std::unique_ptr< NamespaceDef > createNamespaceDefAlias	(	const Definition *	newScope,
		const NamespaceDef *	nd )

Factory method to create an alias of an existing namespace.

Used for inline namespaces.

Definition at line 261 of file namespacedef.cpp.

{
  auto alnd = std::make_unique<NamespaceDefAliasImpl>(newScope,nd);
  //printf("alnd name=%s localName=%s qualifiedName=%s displayName()=%s\n",
  //    qPrint(alnd->name()),qPrint(alnd->localName()),qPrint(alnd->qualifiedName()),
  //    qPrint(alnd->displayName()));
  return alnd;
}

Referenced by buildNamespaceList(), and NamespaceDefMutable::setInline().

getResolvedNamespace()

NamespaceDef * getResolvedNamespace

(

const QCString &

key

)

Definition at line 1777 of file namespacedef.cpp.

{
  //printf("> getResolvedNamespace(%s)\n",qPrint(name));
  if (name.isEmpty()) return nullptr;
  StringSet namespacesTried;
  auto ns = getResolvedNamespaceRec(namespacesTried,NamespaceAliasInfo(name.str()));
  //printf("< getResolvedNamespace(%s)=%s\n",qPrint(name),ns?qPrint(ns->qualifiedName()):"nullptr");
  return ns;
}

References getResolvedNamespaceRec(), QCString::isEmpty(), and QCString::str().

Referenced by addMemberFunction(), buildFunctionList(), buildTypedefList(), extractNamespaceName(), findUsedNamespace(), findUsingDeclImports(), findUsingDirectives(), generateClassOrGlobalLink(), generateClassOrGlobalLink(), getResolvedNamespaceMutable(), CCodeParser::parseCode(), setCallContextForVar(), NamespaceDefMutable::setInline(), and writeAlphabeticalClassList().

getResolvedNamespaceMutable()

NamespaceDefMutable * getResolvedNamespaceMutable ( const QCString & key )

inline

Definition at line 150 of file namespacedef.h.

{
  return toNamespaceDefMutable(getResolvedNamespace(key));
}

References getResolvedNamespace(), getResolvedNamespaceMutable(), and toNamespaceDefMutable().

Referenced by addEnumValuesToEnums(), addGlobalFunction(), addVariableToFile(), findEnums(), findUsingDeclarations(), findUsingDirectives(), and getResolvedNamespaceMutable().

namespaceHasNestedClass()

bool namespaceHasNestedClass	(	const NamespaceDef *	nd,
		bool	filterClasses,
		ClassDef::CompoundType	ct )

Definition at line 1825 of file namespacedef.cpp.

{
  //printf(">namespaceHasNestedClass(%s,filterClasses=%d)\n",qPrint(nd->name()),filterClasses);
  for (const auto &cnd : nd->getNamespaces())
  {
    if (namespaceHasNestedClass(cnd,filterClasses,ct))
    {
      //printf("<namespaceHasNestedClass(%s,filterClasses=%d): case1\n",qPrint(nd->name()),filterClasses);
      return true;
    }
  }
 
  ClassLinkedRefMap list = nd->getClasses();
  if (filterClasses)
  {
    switch (ct)
    {
      case ClassDef::Interface:
        list = nd->getInterfaces();
        break;
      case ClassDef::Struct:
        list = nd->getStructs();
        break;
      case ClassDef::Exception:
        list = nd->getExceptions();
        break;
      default:
        break;
    }
  }
 
  for (const auto &cd : list)
  {
    //printf("candidate %s isLinkableInProject()=%d\n",qPrint(cd->name()),cd->isLinkableInProject());
    if (cd->isLinkableInProject())
    {
      //printf("<namespaceHasNestedClass(%s,filterClasses=%d): case2\n",qPrint(nd->name()),filterClasses);
      return true;
    }
  }
  //printf("<namespaceHasNestedClass(%s,filterClasses=%d): case3\n",qPrint(nd->name()),filterClasses);
  return false;
}

References ClassDef::Exception, NamespaceDef::getClasses(), NamespaceDef::getExceptions(), NamespaceDef::getInterfaces(), NamespaceDef::getNamespaces(), NamespaceDef::getStructs(), ClassDef::Interface, namespaceHasNestedClass(), and ClassDef::Struct.

Referenced by namespaceHasNestedClass(), writeClassTreeInsideNamespaceElement(), and writeNamespaceTreeElement().

namespaceHasNestedConcept()

bool namespaceHasNestedConcept

(

const NamespaceDef *

nd

)

Definition at line 1801 of file namespacedef.cpp.

{
  //printf(">namespaceHasNestedConcept(%s)\n",qPrint(nd->name()));
  for (const auto &cnd : nd->getNamespaces())
  {
    if (namespaceHasNestedConcept(cnd))
    {
      //printf("<namespaceHasNestedConcept(%s): case1\n",qPrint(nd->name()));
      return true;
    }
  }
  for (const auto &cnd : nd->getConcepts())
  {
    //printf("candidate %s isLinkableInProject()=%d\n",qPrint(cnd->name()),cnd->isLinkableInProject());
    if (cnd->isLinkableInProject())
    {
      //printf("<namespaceHasNestedConcept(%s): case2\n",qPrint(nd->name()));
      return true;
    }
  }
  //printf("<namespaceHasNestedConcept(%s): case3\n",qPrint(nd->name()));
  return false;
}

References NamespaceDef::getConcepts(), NamespaceDef::getNamespaces(), and namespaceHasNestedConcept().

Referenced by namespaceHasNestedConcept(), writeConceptTreeInsideNamespaceElement(), and writeNamespaceTreeElement().

namespaceHasNestedNamespace()

bool namespaceHasNestedNamespace

(

const NamespaceDef *

nd

)

Definition at line 1789 of file namespacedef.cpp.

{
  for (const auto &cnd : nd->getNamespaces())
  {
    if (cnd->isLinkableInProject() && !cnd->isAnonymous())
    {
      return true;
    }
  }
  return false;
}

References NamespaceDef::getNamespaces().

Referenced by writeNamespaceTreeElement().

replaceNamespaceAliases()

void replaceNamespaceAliases

(

QCString &

name

)

Definition at line 1769 of file namespacedef.cpp.

{
  //printf("> replaceNamespaceAliases(%s)\n",qPrint(name));
  StringSet namespacesTried;
  name = replaceNamespaceAliasesRec(namespacesTried,name);
  //printf("< replaceNamespaceAliases: result=%s\n",qPrint(name));
}

References replaceNamespaceAliasesRec().

Referenced by findClassRelation(), findUsedClassesForClass(), getMemberFromSymbol(), SymbolResolver::Private::getResolvedSymbolRec(), SymbolResolver::Private::getResolvedTypeRec(), and NamespaceDefMutable::setInline().

toNamespaceDef() [1/3]

const NamespaceDef * toNamespaceDef

(

const Definition *

d

)

Definition at line 1654 of file namespacedef.cpp.

{
  if (d && (typeid(*d)==typeid(NamespaceDefImpl) || typeid(*d)==typeid(NamespaceDefAliasImpl)))
  {
    return static_cast<const NamespaceDef*>(d);
  }
  else
  {
    return nullptr;
  }
}

toNamespaceDef() [2/3]

NamespaceDef * toNamespaceDef

(

Definition *

d

)

Definition at line 1628 of file namespacedef.cpp.

{
  if (d && (typeid(*d)==typeid(NamespaceDefImpl) || typeid(*d)==typeid(NamespaceDefAliasImpl)))
  {
    return static_cast<NamespaceDef*>(d);
  }
  else
  {
    return nullptr;
  }
}

Referenced by DocSets::addIndexItem(), NamespaceDefImpl::addInnerCompound(), buildNamespaceList(), findGlobalMember(), findUsingDirectives(), SymbolResolver::Private::followPath(), generateClassMemberLink(), getDefsNew(), NamespaceDefAliasImpl::getNSAlias(), SymbolResolver::Private::isAccessibleFrom(), SymbolResolver::Private::isAccessibleFromWithExpScope(), MemberDefImpl::moveTo(), resolveClassNestingRelations(), NamespaceDefMutable::setInline(), and writeJavasScriptSearchDataPage().

toNamespaceDef() [3/3]

NamespaceDef * toNamespaceDef

(

DefinitionMutable *

d

)

Definition at line 1640 of file namespacedef.cpp.

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

References toDefinition().

toNamespaceDefMutable()

NamespaceDefMutable * toNamespaceDefMutable

(

Definition *

d

)

Definition at line 1666 of file namespacedef.cpp.

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

Referenced by addEnumValuesToEnums(), addListReferences(), addMembersToMemberGroup(), addNamespaceToGroups(), adjustConfiguration(), buildNamespaceList(), buildScopeFromQualifiedName(), combineUsingRelations(), FileDefImpl::combineUsingRelations(), NamespaceDefImpl::combineUsingRelations(), computeMemberReferences(), countMembers(), distributeMemberGroupDocumentation(), findEnums(), findScopeFromQualifiedName(), findSectionsInDocumentation(), findUsingDeclImports(), findUsingDirectives(), generateNamespaceDocs(), getResolvedNamespaceMutable(), NamespaceDefImpl::insertMember(), insertMemberAlias(), NamespaceDefMutable::setInline(), sortMemberLists(), and writeTagFile().