类 DirContext::Private 继承关系图:

DirContext::Private 的协作图:

类
struct	Cachable

Public 成员函数
	Private (const DirDef *dd)

virtual	~Private ()

TemplateVariant	get (const QCString &n) const

StringVector	fields () const

TemplateVariant	title () const

TemplateVariant	highlight () const

TemplateVariant	subHighlight () const

TemplateVariant	dirName () const

TemplateVariant	dirs () const

TemplateVariant	files () const

TemplateVariant	hasDetails () const

TemplateVariant	compoundType () const

TemplateVariant	relPath () const

DotDirDepsPtr	getDirDepsGraph () const

TemplateVariant	hasDirGraph () const

TemplateVariant	dirGraph () const

Public 成员函数继承自 DefinitionContext< DirContext::Private >
	DefinitionContext (const Definition *d)

virtual	~DefinitionContext ()

Private 成员函数
TemplateVariant	createDirs () const

TemplateVariant	createFiles () const

DotDirDepsPtr	createDirDepsGraph () const

Private 属性
const DirDef *	m_dirDef

Cachable	m_cachable

静态 Private 属性
static const PropertyMap< DirContext::Private >	s_inst

额外继承的成员函数
Protected 成员函数继承自 DefinitionContext< DirContext::Private >
TemplateVariant	fileName () const

TemplateVariant	anchor () const

TemplateVariant	sourceFileName () const

TemplateVariant	isLinkable () const

TemplateVariant	isLinkableInProject () const

TemplateVariant	name () const

TemplateVariant	bareName () const

TemplateVariant	details () const

TemplateVariant	brief () const

TemplateVariant	inbodyDocs () const

TemplateVariant	dynSectionId () const

TemplateVariant	sourceDef () const

TemplateVariant	navigationPath () const

TemplateVariant	partOfGroups () const

TemplateVariant	isReference () const

TemplateVariant	externalReference () const

TemplateVariant	language () const

TemplateVariant	compoundKind () const

QCString	relPathAsString () const

virtual TemplateVariant	relPath () const

详细描述

在文件 context.cpp 第 3115 行定义.

构造及析构函数说明

◆ Private()

DirContext::Private::Private ( const DirDef * dd )

inline

在文件 context.cpp 第 3118 行定义.

                               : DefinitionContext<DirContext::Private>(dd) , m_dirDef(dd)
     {
     }

◆ ~Private()

virtual DirContext::Private::~Private ( )

inlinevirtual

在文件 context.cpp 第 3121 行定义.

3121 {}

成员函数说明

◆ compoundType()

TemplateVariant DirContext::Private::compoundType ( ) const

inline

在文件 context.cpp 第 3135 行定义.

3135 { return theTranslator->trDir(FALSE,TRUE); }

引用了 FALSE, theTranslator, Translator::trDir() , 以及 TRUE.

◆ createDirDepsGraph()

DotDirDepsPtr DirContext::Private::createDirDepsGraph ( ) const

inlineprivate

在文件 context.cpp 第 3216 行定义.

     {
       return std::make_shared<DotDirDeps>(m_dirDef);
     }

引用了 m_dirDef.

◆ createDirs()

TemplateVariant DirContext::Private::createDirs ( ) const

inlineprivate

在文件 context.cpp 第 3196 行定义.

     {
       TemplateVariantList list;
       list.reserve(m_dirDef->subDirs().size());
       for(const auto dd : m_dirDef->subDirs())
       {
         list.push_back(DirContext::alloc(dd));
       }
       return TemplateImmutableList::alloc(list);
     }

引用了 DirContext::alloc(), TemplateImmutableList::alloc(), m_dirDef , 以及 DirDef::subDirs().

◆ createFiles()

TemplateVariant DirContext::Private::createFiles ( ) const

inlineprivate

在文件 context.cpp 第 3206 行定义.

     {
       TemplateVariantList list;
       list.reserve(m_dirDef->getFiles().size());
       for (const auto &fd : m_dirDef->getFiles())
       {
         list.push_back(FileContext::alloc(fd));
       }
       return TemplateImmutableList::alloc(list);
     }

引用了 FileContext::alloc(), TemplateImmutableList::alloc(), DirDef::getFiles() , 以及 m_dirDef.

◆ dirGraph()

TemplateVariant DirContext::Private::dirGraph ( ) const

inline

在文件 context.cpp 第 3151 行定义.

     {
       TextStream t;
       static bool haveDot  = Config_getBool(HAVE_DOT);
       static bool dirGraph = Config_getBool(DIRECTORY_GRAPH);
       if (haveDot && dirGraph)
       {
         DotDirDepsPtr graph = getDirDepsGraph();
         switch (g_globals.outputFormat)
         {
           case ContextOutputFormat_Html:
             {
               graph->writeGraph(t,GOF_BITMAP,
                                 EOF_Html,
                                 g_globals.outputDir,
                                 g_globals.outputDir+Portable::pathSeparator()+addHtmlExtensionIfMissing(m_dirDef->getOutputFileBase()),
                                 relPathAsString(),
                                 TRUE,
                                 g_globals.dynSectionId,
                                 FALSE);
             }
             break;
           case ContextOutputFormat_Latex:
             {
               graph->writeGraph(t,GOF_EPS,
                                 EOF_LaTeX,
                                 g_globals.outputDir,
                                 g_globals.outputDir+Portable::pathSeparator()+m_dirDef->getOutputFileBase()+".tex",
                                 relPathAsString(),
                                 TRUE,
                                 g_globals.dynSectionId,
                                 FALSE);
             }
             break;
             // TODO: support other generators
           default:
             err("context.cpp: output format not yet supported\n");
             break;
         }
         g_globals.dynSectionId++;
       }
       return TemplateVariant(t.str().c_str(),TRUE);
     }

引用了 addHtmlExtensionIfMissing(), Config_getBool, ContextOutputFormat_Html, ContextOutputFormat_Latex, ContextGlobals::dynSectionId, EOF_Html, EOF_LaTeX, err(), FALSE, g_globals, getDirDepsGraph(), DirDef::getOutputFileBase(), GOF_BITMAP, GOF_EPS, m_dirDef, ContextGlobals::outputDir, ContextGlobals::outputFormat, Portable::pathSeparator(), DefinitionContext< DirContext::Private >::relPathAsString(), TextStream::str() , 以及 TRUE.

被这些函数引用 hasDirGraph().

◆ dirName()

TemplateVariant DirContext::Private::dirName ( ) const

inline

在文件 context.cpp 第 3131 行定义.

3131 { return TemplateVariant(m_dirDef->shortName()); }

引用了 m_dirDef , 以及 DirDef::shortName().

◆ dirs()

TemplateVariant DirContext::Private::dirs ( ) const

inline

在文件 context.cpp 第 3132 行定义.

3132 { return m_cachable.dirs.get(this); }

引用了 DirContext::Private::Cachable::dirs , 以及 m_cachable.

◆ fields()

StringVector DirContext::Private::fields ( ) const

inline

在文件 context.cpp 第 3125 行定义.

3125 { return s_inst.fields(); }

引用了 PropertyMap< T >::fields() , 以及 s_inst.

◆ files()

TemplateVariant DirContext::Private::files ( ) const

inline

在文件 context.cpp 第 3133 行定义.

3133 { return m_cachable.files.get(this); }

引用了 DirContext::Private::Cachable::files , 以及 m_cachable.

◆ get()

TemplateVariant DirContext::Private::get ( const QCString & n ) const

inline

在文件 context.cpp 第 3124 行定义.

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

引用了 PropertyMap< T >::get() , 以及 s_inst.

◆ getDirDepsGraph()

DotDirDepsPtr DirContext::Private::getDirDepsGraph ( ) const

inline

在文件 context.cpp 第 3137 行定义.

3137 { return m_cachable.dirDepsGraph.get(this); }

引用了 DirContext::Private::Cachable::dirDepsGraph , 以及 m_cachable.

被这些函数引用 dirGraph() , 以及 hasDirGraph().

◆ hasDetails()

TemplateVariant DirContext::Private::hasDetails ( ) const

inline

在文件 context.cpp 第 3134 行定义.

3134 { return m_dirDef->hasDetailedDescription(); }

引用了 DirDef::hasDetailedDescription() , 以及 m_dirDef.

◆ hasDirGraph()

TemplateVariant DirContext::Private::hasDirGraph ( ) const

inline

在文件 context.cpp 第 3139 行定义.

     {
       bool result=FALSE;
       static bool haveDot  = Config_getBool(HAVE_DOT);
       static bool dirGraph = Config_getBool(DIRECTORY_GRAPH);
       if (haveDot && dirGraph)
       {
         DotDirDepsPtr graph = getDirDepsGraph();
         result = !graph->isTrivial();
       }
       return result;
     }

引用了 Config_getBool, dirGraph(), FALSE , 以及 getDirDepsGraph().

◆ highlight()

TemplateVariant DirContext::Private::highlight ( ) const

inline

在文件 context.cpp 第 3129 行定义.

3129 { return TemplateVariant("files"); }

◆ relPath()

TemplateVariant DirContext::Private::relPath ( ) const

inline

在文件 context.cpp 第 3136 行定义.

3136 { return ""; }

◆ subHighlight()

TemplateVariant DirContext::Private::subHighlight ( ) const

inline

在文件 context.cpp 第 3130 行定义.

3130 { return TemplateVariant(""); }

◆ title()

TemplateVariant DirContext::Private::title ( ) const

inline

在文件 context.cpp 第 3128 行定义.

3128 { return TemplateVariant(m_dirDef->shortTitle()); }

引用了 m_dirDef , 以及 DirDef::shortTitle().

类成员变量说明

◆ m_cachable

Cachable DirContext::Private::m_cachable

private

在文件 context.cpp 第 3227 行定义.

被这些函数引用 dirs(), files() , 以及 getDirDepsGraph().

◆ m_dirDef

const DirDef* DirContext::Private::m_dirDef

private

在文件 context.cpp 第 3220 行定义.

被这些函数引用 createDirDepsGraph(), createDirs(), createFiles(), dirGraph(), dirName(), hasDetails() , 以及 title().

◆ s_inst

const PropertyMap< DirContext::Private > DirContext::Private::s_inst

staticprivate

初始值:

{
  BASE_PROPERTIES,
  {  "title",         &Private::title },
  {  "highlight",     &Private::highlight },
  {  "subhighlight",  &Private::subHighlight },
  {  "dirName",       &Private::dirName },
  {  "dirs",          &Private::dirs },
  {  "files",         &Private::files },
  {  "hasDetails",    &Private::hasDetails },
  {  "hasDirGraph",   &Private::hasDirGraph },
  {  "dirGraph",      &Private::dirGraph },
  {  "compoundType",  &Private::compoundType }
}

在文件 context.cpp 第 3228 行定义.

被这些函数引用 fields() , 以及 get().

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

src/context.cpp

类

Public 成员函数

Private 成员函数

Private 属性

静态 Private 属性

额外继承的成员函数

详细描述

构造及析构函数说明

◆ Private()

◆ ~Private()

成员函数说明

◆ compoundType()

◆ createDirDepsGraph()

◆ createDirs()

◆ createFiles()

◆ dirGraph()

◆ dirName()

◆ dirs()

◆ fields()

◆ files()

◆ get()

◆ getDirDepsGraph()

◆ hasDetails()

◆ hasDirGraph()

◆ highlight()

◆ relPath()

◆ subHighlight()

◆ title()

类成员变量说明

◆ m_cachable

◆ m_dirDef

◆ s_inst