NestingNodeContext::Private Class Reference

Classes
struct	Cachable

Public Member Functions
	Private (const NestingNodeContext *parent, const NestingNodeContext *thisNode, Definition *d, int index, int level, bool addCls, bool inherit, bool hideSuper)
TemplateVariant	get (const char *n) const
TemplateVariant	isLeafNode () const
TemplateVariant	children () const
TemplateVariant	getClass () const
TemplateVariant	getNamespace () const
TemplateVariant	getDir () const
TemplateVariant	getFile () const
TemplateVariant	getPage () const
TemplateVariant	getModule () const
TemplateVariant	level () const
TemplateVariant	id () const
TemplateVariant	name () const
QCString	relPathAsString () const
TemplateVariant	brief () const
TemplateVariant	isLinkable () const
TemplateVariant	anchor () const
TemplateVariant	fileName () const
TemplateVariant	isReference () const
TemplateVariant	externalReference () const
void	addClasses (bool inherit, bool hideSuper)
void	addNamespaces (bool addClasses)
void	addDirFiles ()
void	addPages ()
void	addModules ()

Private Attributes
const NestingNodeContext *	m_parent
Definition *	m_def
SharedPtr< NestingContext >	m_children
int	m_level
int	m_index
Cachable	m_cache

Static Private Attributes
static PropertyMapper < NestingNodeContext::Private >	s_inst

Detailed Description

Definition at line 6076 of file context.cpp.

Constructor & Destructor Documentation

NestingNodeContext::Private::Private ( const NestingNodeContext *  parent, const NestingNodeContext *  thisNode, Definition *  d, int  index, int  level, bool  addCls, bool  inherit, bool  hideSuper  )

inline

Definition at line 6079 of file context.cpp.

References addClasses(), addDirFiles(), addModules(), addNamespaces(), addPages(), NestingContext::alloc(), anchor(), brief(), children(), externalReference(), fileName(), getClass(), getDir(), getFile(), getModule(), getNamespace(), getPage(), id(), Config::init(), isLeafNode(), isLinkable(), isReference(), level(), m_children, name(), SharedPtr< T >::reset(), and s_inst.

      : m_parent(parent), m_def(d), m_level(level), m_index(index)
    {
      m_children.reset(NestingContext::alloc(thisNode,level+1));
      static bool init=FALSE;
      if (!init)
      {
        //%% bool is_leaf_node: true if this node does not have any children
        s_inst.addProperty("is_leaf_node",&Private::isLeafNode);
        //%% Nesting children: list of nested classes/namespaces
        s_inst.addProperty("children",&Private::children);
        //%% [optional] Class class: class info (if this node represents a class)
        s_inst.addProperty("class",&Private::getClass);
        //%% [optional] Namespace namespace: namespace info (if this node represents a namespace)
        s_inst.addProperty("namespace",&Private::getNamespace);
        //%% [optional] File file: file info (if this node represents a file)
        s_inst.addProperty("file",&Private::getFile);
        //%% [optional] Dir dir: directory info (if this node represents a directory)
        s_inst.addProperty("dir",&Private::getDir);
        //%% [optional] Page page: page info (if this node represents a page)
        s_inst.addProperty("page",&Private::getPage);
        //%% [optional] Module module: module info (if this node represents a module)
        s_inst.addProperty("module",&Private::getModule);
        //%% int id
        s_inst.addProperty("id",&Private::id);
        //%% string level
        s_inst.addProperty("level",&Private::level);
        //%% string name
        s_inst.addProperty("name",&Private::name);
        //%% string brief
        s_inst.addProperty("brief",&Private::brief);
        //%% bool isLinkable
        s_inst.addProperty("isLinkable",&Private::isLinkable);
        s_inst.addProperty("anchor",&Private::anchor);
        s_inst.addProperty("fileName",&Private::fileName);
        s_inst.addProperty("isReference",&Private::isReference);
        s_inst.addProperty("externalReference",&Private::externalReference);
        init=TRUE;
      }

      addNamespaces(addCls);
      addClasses(inherit,hideSuper);
      addDirFiles();
      addPages();
      addModules();
    }

Member Function Documentation

void NestingNodeContext::Private::addClasses ( bool  inherit, bool  hideSuper  )

inline

Definition at line 6287 of file context.cpp.

References NestingContext::addClasses(), NestingContext::addDerivedClasses(), ClassDef::baseClasses(), classHasVisibleChildren(), DefinitionIntf::definitionType(), ClassDef::getClassSDict(), Definition::getLanguage(), m_children, m_def, SrcLangExt_VHDL, ClassDef::subClasses(), DefinitionIntf::TypeClass, and ClassDef::visited.

Referenced by addNamespaces(), and Private().

    {
      ClassDef *cd = m_def->definitionType()==Definition::TypeClass ? (ClassDef*)m_def : 0;
      if (cd && inherit)
      {
        bool hasChildren = !cd->visited && !hideSuper && classHasVisibleChildren(cd);
        if (hasChildren)
        {
          bool wasVisited=cd->visited;
          cd->visited=TRUE;
          if (cd->getLanguage()==SrcLangExt_VHDL)
          {
            m_children->addDerivedClasses(cd->baseClasses(),wasVisited);
          }
          else
          {
            m_children->addDerivedClasses(cd->subClasses(),wasVisited);
          }
        }
      }
      else
      {
        if (cd && cd->getClassSDict())
        {
          m_children->addClasses(*cd->getClassSDict(),FALSE);
        }
      }
    }

void NestingNodeContext::Private::addDirFiles ( )

inline

Definition at line 6327 of file context.cpp.

References NestingContext::addDirs(), NestingContext::addFiles(), DefinitionIntf::definitionType(), DirDef::getFiles(), m_children, m_def, DirDef::subDirs(), and DefinitionIntf::TypeDir.

Referenced by Private().

    {
      DirDef *dd = m_def->definitionType()==Definition::TypeDir ? (DirDef*)m_def : 0;
      if (dd)
      {
        m_children->addDirs(dd->subDirs());
        if (dd && dd->getFiles())
        {
          m_children->addFiles(*dd->getFiles());
        }
      }
    }

void NestingNodeContext::Private::addModules ( )

inline

Definition at line 6347 of file context.cpp.

References NestingContext::addModules(), DefinitionIntf::definitionType(), GroupDef::getSubGroups(), m_children, m_def, and DefinitionIntf::TypeGroup.

Referenced by Private().

    {
      GroupDef *gd = m_def->definitionType()==Definition::TypeGroup ? (GroupDef*)m_def : 0;
      if (gd && gd->getSubGroups())
      {
        m_children->addModules(*gd->getSubGroups());
      }
    }

void NestingNodeContext::Private::addNamespaces ( bool  addClasses )

inline

Definition at line 6315 of file context.cpp.

References NestingContext::addClasses(), addClasses(), NestingContext::addNamespaces(), DefinitionIntf::definitionType(), NamespaceDef::getClassSDict(), NamespaceDef::getNamespaceSDict(), m_children, m_def, and DefinitionIntf::TypeNamespace.

Referenced by Private().

    {
      NamespaceDef *nd = m_def->definitionType()==Definition::TypeNamespace ? (NamespaceDef*)m_def : 0;
      if (nd && nd->getNamespaceSDict())
      {
        m_children->addNamespaces(*nd->getNamespaceSDict(),FALSE,addClasses);
      }
      if (addClasses && nd && nd->getClassSDict())
      {
        m_children->addClasses(*nd->getClassSDict(),FALSE);
      }
    }

void NestingNodeContext::Private::addPages ( )

inline

Definition at line 6339 of file context.cpp.

References NestingContext::addPages(), DefinitionIntf::definitionType(), PageDef::getSubPages(), m_children, m_def, and DefinitionIntf::TypePage.

Referenced by Private().

    {
      PageDef *pd = m_def->definitionType()==Definition::TypePage ? (PageDef*)m_def : 0;
      if (pd && pd->getSubPages())
      {
        m_children->addPages(*pd->getSubPages(),FALSE);
      }
    }

TemplateVariant NestingNodeContext::Private::anchor ( ) const

inline

Definition at line 6268 of file context.cpp.

References Definition::anchor(), and m_def.

Referenced by Private().

    {
      return m_def->anchor();
    }

TemplateVariant NestingNodeContext::Private::brief ( ) const

inline

Definition at line 6248 of file context.cpp.

References NestingNodeContext::Private::Cachable::brief, Definition::briefDescription(), Definition::briefFile(), Definition::briefLine(), Definition::hasBriefDescription(), m_cache, m_def, parseDoc(), and ScopedPtr< T >::reset().

Referenced by Private().

    {
      if (!m_cache.brief)
      {
        if (m_def->hasBriefDescription())
        {
          m_cache.brief.reset(new TemplateVariant(parseDoc(m_def,m_def->briefFile(),m_def->briefLine(),
                              "",m_def->briefDescription(),TRUE)));
        }
        else
        {
          m_cache.brief.reset(new TemplateVariant(""));
        }
      }
      return *m_cache.brief;
    }

TemplateVariant NestingNodeContext::Private::children ( ) const

inline

Definition at line 6134 of file context.cpp.

References SharedPtr< T >::get(), and m_children.

Referenced by Private().

    {
      return m_children.get();
    }

TemplateVariant NestingNodeContext::Private::externalReference ( ) const

inline

Definition at line 6280 of file context.cpp.

References Definition::externalReference(), m_def, and relPathAsString().

Referenced by Private().

    {
      return m_def->externalReference(relPathAsString());
    }

TemplateVariant NestingNodeContext::Private::fileName ( ) const

inline

Definition at line 6272 of file context.cpp.

References Definition::getOutputFileBase(), and m_def.

Referenced by Private().

    {
      return m_def->getOutputFileBase();
    }

TemplateVariant NestingNodeContext::Private::get ( const char *  n ) const

inline

Definition at line 6126 of file context.cpp.

References s_inst.

Referenced by NestingNodeContext::get().

    {
      return s_inst.get(this,n);
    }

TemplateVariant NestingNodeContext::Private::getClass ( ) const

inline

Definition at line 6138 of file context.cpp.

References ClassContext::alloc(), NestingNodeContext::Private::Cachable::classContext, DefinitionIntf::definitionType(), SharedPtr< T >::get(), m_cache, m_def, SharedPtr< T >::reset(), and DefinitionIntf::TypeClass.

Referenced by Private().

    {
      if (!m_cache.classContext && m_def->definitionType()==Definition::TypeClass)
      {
        m_cache.classContext.reset(ClassContext::alloc((ClassDef*)m_def));
      }
      if (m_cache.classContext)
      {
        return m_cache.classContext.get();
      }
      else
      {
        return TemplateVariant(FALSE);
      }
    }

TemplateVariant NestingNodeContext::Private::getDir ( ) const

inline

Definition at line 6168 of file context.cpp.

References DirContext::alloc(), DefinitionIntf::definitionType(), NestingNodeContext::Private::Cachable::dirContext, SharedPtr< T >::get(), m_cache, m_def, SharedPtr< T >::reset(), and DefinitionIntf::TypeDir.

Referenced by Private().

    {
      if (!m_cache.dirContext && m_def->definitionType()==Definition::TypeDir)
      {
        m_cache.dirContext.reset(DirContext::alloc((DirDef*)m_def));
      }
      if (m_cache.dirContext)
      {
        return m_cache.dirContext.get();
      }
      else
      {
        return TemplateVariant(FALSE);
      }
    }

TemplateVariant NestingNodeContext::Private::getFile ( ) const

inline

Definition at line 6183 of file context.cpp.

References FileContext::alloc(), DefinitionIntf::definitionType(), NestingNodeContext::Private::Cachable::fileContext, SharedPtr< T >::get(), m_cache, m_def, SharedPtr< T >::reset(), and DefinitionIntf::TypeFile.

Referenced by Private().

    {
      if (!m_cache.fileContext && m_def->definitionType()==Definition::TypeFile)
      {
        m_cache.fileContext.reset(FileContext::alloc((FileDef*)m_def));
      }
      if (m_cache.fileContext)
      {
        return m_cache.fileContext.get();
      }
      else
      {
        return TemplateVariant(FALSE);
      }
    }

TemplateVariant NestingNodeContext::Private::getModule ( ) const

inline

Definition at line 6213 of file context.cpp.

References ModuleContext::alloc(), DefinitionIntf::definitionType(), SharedPtr< T >::get(), m_cache, m_def, NestingNodeContext::Private::Cachable::moduleContext, SharedPtr< T >::reset(), and DefinitionIntf::TypeGroup.

Referenced by Private().

    {
      if (!m_cache.moduleContext && m_def->definitionType()==Definition::TypeGroup)
      {
        m_cache.moduleContext.reset(ModuleContext::alloc((GroupDef*)m_def));
      }
      if (m_cache.moduleContext)
      {
        return m_cache.moduleContext.get();
      }
      else
      {
        return TemplateVariant(FALSE);
      }
    }

TemplateVariant NestingNodeContext::Private::getNamespace ( ) const

inline

Definition at line 6153 of file context.cpp.

References NamespaceContext::alloc(), DefinitionIntf::definitionType(), SharedPtr< T >::get(), m_cache, m_def, NestingNodeContext::Private::Cachable::namespaceContext, SharedPtr< T >::reset(), and DefinitionIntf::TypeNamespace.

Referenced by Private().

    {
      if (!m_cache.namespaceContext && m_def->definitionType()==Definition::TypeNamespace)
      {
        m_cache.namespaceContext.reset(NamespaceContext::alloc((NamespaceDef*)m_def));
      }
      if (m_cache.namespaceContext)
      {
        return m_cache.namespaceContext.get();
      }
      else
      {
        return TemplateVariant(FALSE);
      }
    }

TemplateVariant NestingNodeContext::Private::getPage ( ) const

inline

Definition at line 6198 of file context.cpp.

References PageContext::alloc(), DefinitionIntf::definitionType(), SharedPtr< T >::get(), m_cache, m_def, NestingNodeContext::Private::Cachable::pageContext, SharedPtr< T >::reset(), and DefinitionIntf::TypePage.

Referenced by Private().

    {
      if (!m_cache.pageContext && m_def->definitionType()==Definition::TypePage)
      {
        m_cache.pageContext.reset(PageContext::alloc((PageDef*)m_def,FALSE,FALSE));
      }
      if (m_cache.pageContext)
      {
        return m_cache.pageContext.get();
      }
      else
      {
        return TemplateVariant(FALSE);
      }
    }

TemplateVariant NestingNodeContext::Private::id ( ) const

inline

Definition at line 6232 of file context.cpp.

References NestingNodeContext::id(), m_index, and m_parent.

Referenced by NestingNodeContext::id(), and Private().

    {
      QCString result;
      if (m_parent) result=m_parent->id();
      result+=QCString().setNum(m_index)+"_";
      return result;
    }

TemplateVariant NestingNodeContext::Private::isLeafNode ( ) const

inline

Definition at line 6130 of file context.cpp.

References NestingContext::count(), and m_children.

Referenced by Private().

    {
      return m_children->count()==0;
    }

TemplateVariant NestingNodeContext::Private::isLinkable ( ) const

inline

Definition at line 6264 of file context.cpp.

References Definition::isLinkable(), and m_def.

Referenced by Private().

    {
      return m_def->isLinkable();
    }

TemplateVariant NestingNodeContext::Private::isReference ( ) const

inline

Definition at line 6276 of file context.cpp.

References Definition::isReference(), and m_def.

Referenced by Private().

    {
      return m_def->isReference();
    }

TemplateVariant NestingNodeContext::Private::level ( ) const

inline

Definition at line 6228 of file context.cpp.

References m_level.

Referenced by Private().

    {
      return m_level;
    }

TemplateVariant NestingNodeContext::Private::name ( ) const

inline

Definition at line 6239 of file context.cpp.

References Definition::displayName(), and m_def.

Referenced by Private().

    {
      return m_def->displayName(FALSE);
    }

QCString NestingNodeContext::Private::relPathAsString ( ) const

inline

Definition at line 6243 of file context.cpp.

References Config_getBool.

Referenced by externalReference().

    {
      static bool createSubdirs = Config_getBool(CREATE_SUBDIRS);
      return createSubdirs ? QCString("../../") : QCString("");
    }

Member Data Documentation

Cachable NestingNodeContext::Private::m_cache

mutableprivate

Definition at line 6371 of file context.cpp.

Referenced by brief(), getClass(), getDir(), getFile(), getModule(), getNamespace(), and getPage().

SharedPtr<NestingContext> NestingNodeContext::Private::m_children

private

Definition at line 6358 of file context.cpp.

Referenced by addClasses(), addDirFiles(), addModules(), addNamespaces(), addPages(), children(), isLeafNode(), and Private().

Definition* NestingNodeContext::Private::m_def

private

Definition at line 6357 of file context.cpp.

Referenced by addClasses(), addDirFiles(), addModules(), addNamespaces(), addPages(), anchor(), brief(), externalReference(), fileName(), getClass(), getDir(), getFile(), getModule(), getNamespace(), getPage(), isLinkable(), isReference(), and name().

int NestingNodeContext::Private::m_index

private

Definition at line 6360 of file context.cpp.

Referenced by id().

int NestingNodeContext::Private::m_level

private

Definition at line 6359 of file context.cpp.

Referenced by level().

const NestingNodeContext* NestingNodeContext::Private::m_parent

private

Definition at line 6356 of file context.cpp.

Referenced by id().

PropertyMapper< NestingNodeContext::Private > NestingNodeContext::Private::s_inst

staticprivate

Definition at line 6372 of file context.cpp.

Referenced by get(), and Private().

---

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

• context.cpp