Inheritance diagram for FileContext::Private:

Classes
struct	Cachable

Public Member Functions
	Private (FileDef *fd)

virtual	~Private ()

TemplateVariant	get (const char *n) const

TemplateVariant	title () const

TemplateVariant	highlight () const

TemplateVariant	subHighlight () const

TemplateVariant	versionInfo () const

TemplateVariant	includeList () const

DotInclDepGraph *	getIncludeGraph () const

TemplateVariant	hasIncludeGraph () const

TemplateVariant	includeGraph () const

DotInclDepGraph *	getIncludedByGraph () const

TemplateVariant	hasIncludedByGraph () const

TemplateVariant	includedByGraph () const

TemplateVariant	hasDetails () const

TemplateVariant	hasSourceFile () const

TemplateVariant	sources () const

TemplateVariant	version () const

TemplateVariant	classes () const

TemplateVariant	namespaces () const

TemplateVariant	constantgroups () const

TemplateVariant	getMemberList (SharedPtr< MemberListInfoContext > &list, MemberListType type, const char *title, bool detailed=FALSE) const

TemplateVariant	macros () const

TemplateVariant	typedefs () const

TemplateVariant	enums () const

TemplateVariant	functions () const

TemplateVariant	variables () const

TemplateVariant	memberGroups () const

TemplateVariant	detailedMacros () const

TemplateVariant	detailedTypedefs () const

TemplateVariant	detailedEnums () const

TemplateVariant	detailedFunctions () const

TemplateVariant	detailedVariables () const

TemplateVariant	inlineClasses () const

TemplateVariant	compoundType () const

Public Member Functions inherited from DefinitionContext< FileContext::Private >
	DefinitionContext (Definition *d)

void	addBaseProperties (PropertyMapper< FileContext::Private > &inst)

TemplateVariant	fileName () const

TemplateVariant	anchor () const

TemplateVariant	sourceFileName () const

TemplateVariant	isLinkable () const

TemplateVariant	isLinkableInProject () const

TemplateVariant	name () const

TemplateVariant	bareName () const

QCString	relPathAsString () const

virtual TemplateVariant	relPath () const

TemplateVariant	details () const

TemplateVariant	brief () const

TemplateVariant	inbodyDocs () const

TemplateVariant	dynSectionId () const

TemplateVariant	language () const

TemplateVariant	compoundKind () const

TemplateVariant	sourceDef () const

void	fillPath (Definition def, TemplateList list) const

TemplateVariant	navigationPath () const

TemplateVariant	isReference () const

TemplateVariant	externalReference () const

Private Member Functions
Cachable &	getCache () const

Private Attributes
FileDef *	m_fileDef

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

Detailed Description

Definition at line 2920 of file context.cpp.

Constructor & Destructor Documentation

FileContext::Private::Private ( FileDef * fd )

inline

Definition at line 2923 of file context.cpp.

                          : DefinitionContext<FileContext::Private>(fd) , m_fileDef(fd)
     {
       if (fd==0) abort();
       static bool init=FALSE;
       if (!init)
       {
         addBaseProperties(s_inst);
         s_inst.addProperty("title",                     &Private::title);
         s_inst.addProperty("highlight",                 &Private::highlight);
         s_inst.addProperty("subhighlight",              &Private::subHighlight);
         s_inst.addProperty("versionInfo",               &Private::versionInfo);
         s_inst.addProperty("includeList",               &Private::includeList);
         s_inst.addProperty("hasIncludeGraph",           &Private::hasIncludeGraph);
         s_inst.addProperty("hasIncludedByGraph",        &Private::hasIncludedByGraph);
         s_inst.addProperty("includeGraph",              &Private::includeGraph);
         s_inst.addProperty("includedByGraph",           &Private::includedByGraph);
         s_inst.addProperty("hasDetails",                &Private::hasDetails);
         s_inst.addProperty("hasSourceFile",             &Private::hasSourceFile);
         s_inst.addProperty("sources",                   &Private::sources);
         s_inst.addProperty("version",                   &Private::version);
         s_inst.addProperty("classes",                   &Private::classes);
         s_inst.addProperty("namespaces",                &Private::namespaces);
         s_inst.addProperty("constantgroups",            &Private::constantgroups);
         s_inst.addProperty("macros",                    &Private::macros);
         s_inst.addProperty("typedefs",                  &Private::typedefs);
         s_inst.addProperty("enums",                     &Private::enums);
         s_inst.addProperty("functions",                 &Private::functions);
         s_inst.addProperty("variables",                 &Private::variables);
         s_inst.addProperty("memberGroups",              &Private::memberGroups);
         s_inst.addProperty("detailedMacros",            &Private::detailedMacros);
         s_inst.addProperty("detailedTypedefs",          &Private::detailedTypedefs);
         s_inst.addProperty("detailedEnums",             &Private::detailedEnums);
         s_inst.addProperty("detailedFunctions",         &Private::detailedFunctions);
         s_inst.addProperty("detailedVariables",         &Private::detailedVariables);
         s_inst.addProperty("inlineClasses",             &Private::inlineClasses);
         s_inst.addProperty("compoundType",              &Private::compoundType);
         init=TRUE;
       }
       if (!fd->cookie()) { fd->setCookie(new FileContext::Private::Cachable(fd)); }
     }

virtual FileContext::Private::~Private ( )

inlinevirtual

Definition at line 2963 of file context.cpp.

2963 {}

Member Function Documentation

TemplateVariant FileContext::Private::classes ( ) const

inline

Definition at line 3133 of file context.cpp.

     {
       Cachable &cache = getCache();
       if (!cache.classes)
       {
         TemplateList *classList = TemplateList::alloc();
         if (m_fileDef->getClassSDict())
         {
           ClassSDict::Iterator sdi(*m_fileDef->getClassSDict());
           ClassDef *cd;
           for (sdi.toFirst();(cd=sdi.current());++sdi)
           {
             if (cd->visibleInParentsDeclList())
             {
               classList->append(ClassContext::alloc(cd));
             }
           }
         }
         cache.classes.reset(classList);
       }
       return cache.classes.get();
     }

TemplateVariant FileContext::Private::compoundType ( ) const

inline

Definition at line 3307 of file context.cpp.

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

TemplateVariant FileContext::Private::constantgroups ( ) const

inline

Definition at line 3177 of file context.cpp.

     {
       Cachable &cache = getCache();
       if (!cache.constantgroups)
       {
         TemplateList *namespaceList = TemplateList::alloc();
         if (m_fileDef->getNamespaceSDict())
         {
           NamespaceSDict::Iterator sdi(*m_fileDef->getNamespaceSDict());
           NamespaceDef *nd;
           for (sdi.toFirst();(nd=sdi.current());++sdi)
           {
             if (nd->isLinkable() && nd->isConstantGroup())
             {
               namespaceList->append(NamespaceContext::alloc(nd));
             }
           }
         }
         cache.constantgroups.reset(namespaceList);
       }
       return cache.constantgroups.get();
     }

TemplateVariant FileContext::Private::detailedEnums ( ) const

inline

Definition at line 3267 of file context.cpp.

     {
       return getMemberList(getCache().detailedEnums,MemberListType_docEnumMembers,theTranslator->trEnumerationTypeDocumentation());
     }

TemplateVariant FileContext::Private::detailedFunctions ( ) const

inline

Definition at line 3271 of file context.cpp.

     {
       QCString title = theTranslator->trFunctionDocumentation();
       SrcLangExt lang = m_fileDef->getLanguage();
       if (lang==SrcLangExt_Fortran) title=theTranslator->trSubprogramDocumentation();
       return getMemberList(getCache().detailedFunctions,MemberListType_docFuncMembers,title);
     }

TemplateVariant FileContext::Private::detailedMacros ( ) const

inline

Definition at line 3259 of file context.cpp.

     {
       return getMemberList(getCache().detailedMacros,MemberListType_docDefineMembers,theTranslator->trDefineDocumentation());
     }

TemplateVariant FileContext::Private::detailedTypedefs ( ) const

inline

Definition at line 3263 of file context.cpp.

     {
       return getMemberList(getCache().detailedTypedefs,MemberListType_docTypedefMembers,theTranslator->trTypedefDocumentation());
     }

TemplateVariant FileContext::Private::detailedVariables ( ) const

inline

Definition at line 3278 of file context.cpp.

     {
       return getMemberList(getCache().detailedVariables,MemberListType_docVarMembers,theTranslator->trVariableDocumentation());
     }

TemplateVariant FileContext::Private::enums ( ) const

inline

Definition at line 3227 of file context.cpp.

     {
       return getMemberList(getCache().enums,MemberListType_decEnumMembers,theTranslator->trEnumerations());
     }

TemplateVariant FileContext::Private::functions ( ) const

inline

Definition at line 3231 of file context.cpp.

     {
       QCString title = theTranslator->trFunctions();
       SrcLangExt lang = m_fileDef->getLanguage();
       if (lang==SrcLangExt_Fortran) title=theTranslator->trSubprograms();
       else if (lang==SrcLangExt_VHDL) title=VhdlDocGen::trFunctionAndProc();
       return getMemberList(getCache().functions,MemberListType_decFuncMembers,title);
     }

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

inline

Definition at line 2964 of file context.cpp.

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

Cachable& FileContext::Private::getCache ( ) const

inlineprivate

Definition at line 3337 of file context.cpp.

     {
       Cachable *c = static_cast<Cachable*>(m_fileDef->cookie());
       assert(c!=0);
       return *c;
     }

DotInclDepGraph* FileContext::Private::getIncludedByGraph ( ) const

inline

Definition at line 3053 of file context.cpp.

     {
       Cachable &cache = getCache();
       if (!cache.includedByGraph)
       {
         cache.includedByGraph.reset(new DotInclDepGraph(m_fileDef,TRUE));
       }
       return cache.includedByGraph.get();
     }

DotInclDepGraph* FileContext::Private::getIncludeGraph ( ) const

inline

Definition at line 3001 of file context.cpp.

     {
       Cachable &cache = getCache();
       if (!cache.includeGraph)
       {
         cache.includeGraph.reset(new DotInclDepGraph(m_fileDef,FALSE));
       }
       return cache.includeGraph.get();
     }

TemplateVariant FileContext::Private::getMemberList	(	SharedPtr< MemberListInfoContext > &	list,
		MemberListType	type,
		const char *	title,
		bool	detailed = `FALSE`
	)		const

inline

Definition at line 3199 of file context.cpp.

     {
       if (!list)
       {
         MemberList *ml = m_fileDef->getMemberList(type);
         if (ml)
         {
           list.reset(MemberListInfoContext::alloc(m_fileDef,relPathAsString(),ml,title,""));
         }
       }
       if (list)
       {
         return list.get();
       }
       else
       {
         return TemplateVariant(FALSE);
       }
     }

TemplateVariant FileContext::Private::hasDetails ( ) const

inline

Definition at line 3105 of file context.cpp.

     {
       return m_fileDef->hasDetailedDescription();
     }

TemplateVariant FileContext::Private::hasIncludedByGraph ( ) const

inline

Definition at line 3062 of file context.cpp.

     {
       static bool haveDot = Config_getBool("HAVE_DOT");
       DotInclDepGraph *incGraph = getIncludedByGraph();
       return (haveDot && !incGraph->isTooBig() && !incGraph->isTrivial());
     }

TemplateVariant FileContext::Private::hasIncludeGraph ( ) const

inline

Definition at line 3010 of file context.cpp.

     {
       static bool haveDot = Config_getBool("HAVE_DOT");
       DotInclDepGraph *incGraph = getIncludeGraph();
       return (haveDot && !incGraph->isTooBig() && !incGraph->isTrivial());
     }

TemplateVariant FileContext::Private::hasSourceFile ( ) const

inline

Definition at line 3109 of file context.cpp.

     {
       return m_fileDef->generateSourceFile();
     }

TemplateVariant FileContext::Private::highlight ( ) const

inline

Definition at line 2972 of file context.cpp.

     {
       return TemplateVariant("files");
     }

TemplateVariant FileContext::Private::includedByGraph ( ) const

inline

Definition at line 3068 of file context.cpp.

     {
       static bool haveDot = Config_getBool("HAVE_DOT");
       QGString result;
       if (haveDot)
       {
         DotInclDepGraph *cg = getIncludedByGraph();
         FTextStream t(&result);
         switch (g_globals.outputFormat)
         {
           case ContextOutputFormat_Html:
             {
               cg->writeGraph(t,GOF_BITMAP,EOF_Html,
                   g_globals.outputDir,
                   g_globals.outputDir+portable_pathSeparator()+m_fileDef->getOutputFileBase()+Doxygen::htmlFileExtension,
                   relPathAsString(),TRUE,g_globals.dynSectionId
                   );
             }
             break;
           case ContextOutputFormat_Latex:
             {
               cg->writeGraph(t,GOF_EPS,EOF_LaTeX,
                   g_globals.outputDir,
                   g_globals.outputDir+portable_pathSeparator()+m_fileDef->getOutputFileBase()+".tex",
                   relPathAsString(),TRUE,g_globals.dynSectionId
                   );
             }
             break;
             // TODO: support other generators
           default:
             err("context.cpp: output format not yet supported");
             break;
         }
         g_globals.dynSectionId++;
       }
       return TemplateVariant(result.data(),TRUE);
     }

TemplateVariant FileContext::Private::includeGraph ( ) const

inline

Definition at line 3016 of file context.cpp.

     {
       static bool haveDot = Config_getBool("HAVE_DOT");
       QGString result;
       if (haveDot)
       {
         DotInclDepGraph *cg = getIncludeGraph();
         FTextStream t(&result);
         switch (g_globals.outputFormat)
         {
           case ContextOutputFormat_Html:
             {
               cg->writeGraph(t,GOF_BITMAP,EOF_Html,
                   g_globals.outputDir,
                   g_globals.outputDir+portable_pathSeparator()+m_fileDef->getOutputFileBase()+Doxygen::htmlFileExtension,
                   relPathAsString(),TRUE,g_globals.dynSectionId
                   );
             }
             break;
           case ContextOutputFormat_Latex:
             {
               cg->writeGraph(t,GOF_EPS,EOF_LaTeX,
                   g_globals.outputDir,
                   g_globals.outputDir+portable_pathSeparator()+m_fileDef->getOutputFileBase()+".tex",
                   relPathAsString(),TRUE,g_globals.dynSectionId
                   );
             }
             break;
             // TODO: support other generators
           default:
             err("context.cpp: output format not yet supported");
             break;
         }
         g_globals.dynSectionId++;
       }
       return TemplateVariant(result.data(),TRUE);
     }

TemplateVariant FileContext::Private::includeList ( ) const

inline

Definition at line 2984 of file context.cpp.

     {
       Cachable &cache = getCache();
       if (!cache.includeInfoList && m_fileDef->includeFileList())
       {
         cache.includeInfoList.reset(IncludeInfoListContext::alloc(
               *m_fileDef->includeFileList(),m_fileDef->getLanguage()));
       }
       if (cache.includeInfoList)
       {
         return cache.includeInfoList.get();
       }
       else
       {
         return TemplateVariant(FALSE);
       }
     }

TemplateVariant FileContext::Private::inlineClasses ( ) const

inline

Definition at line 3282 of file context.cpp.

     {
       Cachable &cache = getCache();
       if (!cache.inlineClasses)
       {
         TemplateList *classList = TemplateList::alloc();
         if (m_fileDef->getClassSDict())
         {
           ClassSDict::Iterator sdi(*m_fileDef->getClassSDict());
           ClassDef *cd;
           for (sdi.toFirst();(cd=sdi.current());++sdi)
           {
             if (cd->name().find('@')==-1 &&
                 cd->isLinkableInProject() &&
                 cd->isEmbeddedInOuterScope() &&
                 cd->partOfGroups()==0)
             {
               classList->append(ClassContext::alloc(cd));
             }
           }
         }
         cache.inlineClasses.reset(classList);
       }
       return cache.inlineClasses.get();
     }

TemplateVariant FileContext::Private::macros ( ) const

inline

Definition at line 3219 of file context.cpp.

     {
       return getMemberList(getCache().macros,MemberListType_decDefineMembers,theTranslator->trDefines());
     }

TemplateVariant FileContext::Private::memberGroups ( ) const

inline

Definition at line 3243 of file context.cpp.

     {
       Cachable &cache = getCache();
       if (!cache.memberGroups)
       {
         if (m_fileDef->getMemberGroupSDict())
         {
           cache.memberGroups.reset(MemberGroupListContext::alloc(m_fileDef,relPathAsString(),m_fileDef->getMemberGroupSDict(),m_fileDef->subGrouping()));
         }
         else
         {
           cache.memberGroups.reset(MemberGroupListContext::alloc());
         }
       }
       return cache.memberGroups.get();
     }

TemplateVariant FileContext::Private::namespaces ( ) const

inline

Definition at line 3155 of file context.cpp.

     {
       Cachable &cache = getCache();
       if (!cache.namespaces)
       {
         TemplateList *namespaceList = TemplateList::alloc();
         if (m_fileDef->getNamespaceSDict())
         {
           NamespaceSDict::Iterator sdi(*m_fileDef->getNamespaceSDict());
           NamespaceDef *nd;
           for (sdi.toFirst();(nd=sdi.current());++sdi)
           {
             if (nd->isLinkable() && !nd->isConstantGroup())
             {
               namespaceList->append(NamespaceContext::alloc(nd));
             }
           }
         }
         cache.namespaces.reset(namespaceList);
       }
       return cache.namespaces.get();
     }

TemplateVariant FileContext::Private::sources ( ) const

inline

Definition at line 3113 of file context.cpp.

     {
       Cachable &cache = getCache();
       if (!cache.sources)
       {
         if (m_fileDef->generateSourceFile())
         {
           cache.sources.reset(new TemplateVariant(parseCode(m_fileDef,relPathAsString())));
         }
         else
         {
           cache.sources.reset(new TemplateVariant(""));
         }
       }
       return *cache.sources;
     }

TemplateVariant FileContext::Private::subHighlight ( ) const

inline

Definition at line 2976 of file context.cpp.

     {
       return TemplateVariant("");
     }

TemplateVariant FileContext::Private::title ( ) const

inline

Definition at line 2968 of file context.cpp.

     {
       return m_fileDef->title();
     }

TemplateVariant FileContext::Private::typedefs ( ) const

inline

Definition at line 3223 of file context.cpp.

     {
       return getMemberList(getCache().typedefs,MemberListType_decTypedefMembers,theTranslator->trTypedefs());
     }

TemplateVariant FileContext::Private::variables ( ) const

inline

Definition at line 3239 of file context.cpp.

     {
       return getMemberList(getCache().variables,MemberListType_decVarMembers,theTranslator->trVariables());
     }

TemplateVariant FileContext::Private::version ( ) const

inline

Definition at line 3129 of file context.cpp.

     {
       return m_fileDef->fileVersion();
     }

TemplateVariant FileContext::Private::versionInfo ( ) const

inline

Definition at line 2980 of file context.cpp.

     {
       return m_fileDef->getVersion();
     }

Member Data Documentation

FileDef* FileContext::Private::m_fileDef

private

Definition at line 3313 of file context.cpp.

PropertyMapper< FileContext::Private > FileContext::Private::s_inst

staticprivate

Definition at line 3343 of file context.cpp.

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

doxygen-1.8.11/src/context.cpp

Classes

Public Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation