ClassHierarchyContext::Private Class Reference

Classes
struct	Cachable

Public Member Functions
	Private ()
TemplateVariant	get (const char *n) const
TemplateVariant	tree () const
TemplateVariant	fileName () const
TemplateVariant	relPath () const
TemplateVariant	highlight () const
TemplateVariant	subhighlight () const
DotGfxHierarchyTable *	getHierarchy () const
TemplateVariant	diagrams () const
TemplateVariant	title () const
TemplateVariant	maxDepth () const
TemplateVariant	preferredDepth () const

Private Attributes
SharedPtr< NestingContext >	m_classTree
Cachable	m_cache

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

Detailed Description

Definition at line 5929 of file context.cpp.

Constructor & Destructor Documentation

ClassHierarchyContext::Private::Private ( )

inline

Definition at line 5932 of file context.cpp.

References NestingContext::addClassHierarchy(), NestingContext::alloc(), Doxygen::classSDict, diagrams(), fileName(), Doxygen::hiddenClasses, highlight(), Config::init(), initClassHierarchy(), m_classTree, maxDepth(), preferredDepth(), relPath(), SharedPtr< T >::reset(), s_inst, subhighlight(), title(), and tree().

    {
      m_classTree.reset(NestingContext::alloc(0,0));
      initClassHierarchy(Doxygen::classSDict);
      initClassHierarchy(Doxygen::hiddenClasses);
      m_classTree->addClassHierarchy(*Doxygen::classSDict,TRUE);
      m_classTree->addClassHierarchy(*Doxygen::hiddenClasses,TRUE);
      //%% ClassInheritance tree
      static bool init=FALSE;
      if (!init)
      {
        s_inst.addProperty("tree",            &Private::tree);
        s_inst.addProperty("fileName",        &Private::fileName);
        s_inst.addProperty("relPath",         &Private::relPath);
        s_inst.addProperty("highlight",       &Private::highlight);
        s_inst.addProperty("subhighlight",    &Private::subhighlight);
        s_inst.addProperty("title",           &Private::title);
        s_inst.addProperty("preferredDepth",  &Private::preferredDepth);
        s_inst.addProperty("maxDepth",        &Private::maxDepth);
        s_inst.addProperty("diagrams",        &Private::diagrams);
        init=TRUE;
      }
    }

Member Function Documentation

TemplateVariant ClassHierarchyContext::Private::diagrams ( ) const

inline

Definition at line 5987 of file context.cpp.

References TemplateList::alloc(), InheritanceGraphContext::alloc(), TemplateList::append(), ClassHierarchyContext::Private::Cachable::diagrams, SharedPtr< T >::get(), getHierarchy(), m_cache, SharedPtr< T >::reset(), and DotGfxHierarchyTable::subGraphs().

Referenced by Private().

    {
      if (!m_cache.diagrams)
      {
        TemplateList *diagrams = TemplateList::alloc();
        DotGfxHierarchyTable *hierarchy = getHierarchy();
        if (hierarchy->subGraphs())
        {
          int id=0;
          QListIterator<DotNode> li(*hierarchy->subGraphs());
          DotNode *n;
          for (li.toFirst();(n=li.current());++li)
          {
            diagrams->append(InheritanceGraphContext::alloc(hierarchy,n,id++));
          }
        }
        m_cache.diagrams.reset(diagrams);
      }
      return m_cache.diagrams.get();
    }

TemplateVariant ClassHierarchyContext::Private::fileName ( ) const

inline

Definition at line 5963 of file context.cpp.

Referenced by Private().

    {
      return "hierarchy";
    }

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

inline

Definition at line 5955 of file context.cpp.

References s_inst.

Referenced by ClassHierarchyContext::get().

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

DotGfxHierarchyTable* ClassHierarchyContext::Private::getHierarchy ( ) const

inline

Definition at line 5979 of file context.cpp.

References ScopedPtr< T >::get(), ClassHierarchyContext::Private::Cachable::hierarchy, m_cache, and ScopedPtr< T >::reset().

Referenced by diagrams().

    {
      if (!m_cache.hierarchy)
      {
        m_cache.hierarchy.reset(new DotGfxHierarchyTable());
      }
      return m_cache.hierarchy.get();
    }

TemplateVariant ClassHierarchyContext::Private::highlight ( ) const

inline

Definition at line 5971 of file context.cpp.

Referenced by Private().

    {
      return "classes";
    }

TemplateVariant ClassHierarchyContext::Private::maxDepth ( ) const

inline

Definition at line 6019 of file context.cpp.

References computeMaxDepth(), SharedPtr< T >::get(), m_cache, m_classTree, ClassHierarchyContext::Private::Cachable::maxDepth, and ClassHierarchyContext::Private::Cachable::maxDepthComputed.

Referenced by preferredDepth(), and Private().

    {
      if (!m_cache.maxDepthComputed)
      {
        m_cache.maxDepth = computeMaxDepth(m_classTree.get());
        m_cache.maxDepthComputed=TRUE;
      }
      return m_cache.maxDepth;
    }

TemplateVariant ClassHierarchyContext::Private::preferredDepth ( ) const

inline

Definition at line 6028 of file context.cpp.

References computePreferredDepth(), SharedPtr< T >::get(), m_cache, m_classTree, maxDepth(), ClassHierarchyContext::Private::Cachable::preferredDepth, ClassHierarchyContext::Private::Cachable::preferredDepthComputed, and TemplateVariant::toInt().

Referenced by Private().

    {
      if (!m_cache.preferredDepthComputed)
      {
        m_cache.preferredDepth = computePreferredDepth(m_classTree.get(),maxDepth().toInt());
        m_cache.preferredDepthComputed=TRUE;
      }
      return m_cache.preferredDepth;
    }

TemplateVariant ClassHierarchyContext::Private::relPath ( ) const

inline

Definition at line 5967 of file context.cpp.

Referenced by Private().

    {
      return "";
    }

TemplateVariant ClassHierarchyContext::Private::subhighlight ( ) const

inline

Definition at line 5975 of file context.cpp.

Referenced by Private().

    {
      return "classhierarchy";
    }

TemplateVariant ClassHierarchyContext::Private::title ( ) const

inline

Definition at line 6007 of file context.cpp.

References Config_getBool, theTranslator, Translator::trClassHierarchy(), and VhdlDocGen::trDesignUnitHierarchy().

Referenced by Private().

    {
      static bool vhdlOpt    = Config_getBool(OPTIMIZE_OUTPUT_VHDL);
      if (vhdlOpt)
      {
        return VhdlDocGen::trDesignUnitHierarchy();
      }
      else
      {
        return theTranslator->trClassHierarchy();
      }
    }

TemplateVariant ClassHierarchyContext::Private::tree ( ) const

inline

Definition at line 5959 of file context.cpp.

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

Referenced by Private().

    {
      return m_classTree.get();
    }

Member Data Documentation

Cachable ClassHierarchyContext::Private::m_cache

mutableprivate

Definition at line 6050 of file context.cpp.

Referenced by diagrams(), getHierarchy(), maxDepth(), and preferredDepth().

SharedPtr<NestingContext> ClassHierarchyContext::Private::m_classTree

private

Definition at line 6038 of file context.cpp.

Referenced by maxDepth(), preferredDepth(), Private(), and tree().

PropertyMapper< ClassHierarchyContext::Private > ClassHierarchyContext::Private::s_inst

staticprivate

Definition at line 6051 of file context.cpp.

Referenced by get(), and Private().

---

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

• context.cpp