ClassTreeContext::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
TemplateVariant	title () const
TemplateVariant	maxDepth () const
TemplateVariant	preferredDepth () const

Private Attributes
SharedPtr< NestingContext >	m_classTree
Cachable	m_cache

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

Detailed Description

Definition at line 6707 of file context.cpp.

Constructor & Destructor Documentation

ClassTreeContext::Private::Private ( )

inline

Definition at line 6710 of file context.cpp.

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

    {
      m_classTree.reset(NestingContext::alloc(0,0));
      if (Doxygen::namespaceSDict)
      {
        m_classTree->addNamespaces(*Doxygen::namespaceSDict,TRUE,TRUE);
      }
      if (Doxygen::classSDict)
      {
        m_classTree->addClasses(*Doxygen::classSDict,TRUE);
      }
      //%% Nesting 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);
        init=TRUE;
      }
    }

Member Function Documentation

TemplateVariant ClassTreeContext::Private::fileName ( ) const

inline

Definition at line 6744 of file context.cpp.

Referenced by Private().

    {
      return "annotated";
    }

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

inline

Definition at line 6736 of file context.cpp.

References s_inst.

Referenced by ClassTreeContext::get().

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

TemplateVariant ClassTreeContext::Private::highlight ( ) const

inline

Definition at line 6752 of file context.cpp.

Referenced by Private().

    {
      return "classes";
    }

TemplateVariant ClassTreeContext::Private::maxDepth ( ) const

inline

Definition at line 6777 of file context.cpp.

References computeMaxDepth(), SharedPtr< T >::get(), m_cache, m_classTree, ClassTreeContext::Private::Cachable::maxDepth, and ClassTreeContext::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 ClassTreeContext::Private::preferredDepth ( ) const

inline

Definition at line 6786 of file context.cpp.

References computePreferredDepth(), SharedPtr< T >::get(), m_cache, m_classTree, maxDepth(), ClassTreeContext::Private::Cachable::preferredDepth, ClassTreeContext::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 ClassTreeContext::Private::relPath ( ) const

inline

Definition at line 6748 of file context.cpp.

Referenced by Private().

    {
      return "";
    }

TemplateVariant ClassTreeContext::Private::subhighlight ( ) const

inline

Definition at line 6756 of file context.cpp.

Referenced by Private().

    {
      return "classlist";
    }

TemplateVariant ClassTreeContext::Private::title ( ) const

inline

Definition at line 6760 of file context.cpp.

References Config_getBool, theTranslator, Translator::trClasses(), Translator::trCompoundListFortran(), and VhdlDocGen::trDesignUnitList().

Referenced by Private().

    {
      static bool fortranOpt = Config_getBool(OPTIMIZE_FOR_FORTRAN);
      static bool vhdlOpt    = Config_getBool(OPTIMIZE_OUTPUT_VHDL);
      if (fortranOpt)
      {
        return theTranslator->trCompoundListFortran();
      }
      else if (vhdlOpt)
      {
        return VhdlDocGen::trDesignUnitList();
      }
      else
      {
        return theTranslator->trClasses();
      }
    }

TemplateVariant ClassTreeContext::Private::tree ( ) const

inline

Definition at line 6740 of file context.cpp.

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

Referenced by Private().

    {
      return m_classTree.get();
    }

Member Data Documentation

Cachable ClassTreeContext::Private::m_cache

mutableprivate

Definition at line 6806 of file context.cpp.

Referenced by maxDepth(), and preferredDepth().

SharedPtr<NestingContext> ClassTreeContext::Private::m_classTree

private

Definition at line 6796 of file context.cpp.

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

PropertyMapper< ClassTreeContext::Private > ClassTreeContext::Private::s_inst

staticprivate

Definition at line 6807 of file context.cpp.

Referenced by get(), and Private().

---

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

• context.cpp