Skip to content

Commit

Permalink
Template context support for CREATE_SUBDIRS
Browse files Browse the repository at this point in the history
  • Loading branch information
Dimitri van Heesch committed Aug 2, 2014
1 parent 7e3e890 commit 9282aab
Show file tree
Hide file tree
Showing 5 changed files with 124 additions and 19 deletions.
114 changes: 99 additions & 15 deletions src/context.cpp
View file
Expand Up @@ -13,6 +13,8 @@
*
*/

#include <qdir.h>

#include "context.h"
#include "config.h"
#include "index.h"
Expand Down Expand Up @@ -286,7 +288,7 @@ class ConfigContext::Private
{
public:
Private() { m_cachedLists.setAutoDelete(TRUE); }
~Private() { }
virtual ~Private() { }
TemplateVariant fetchList(const QCString &name,const QStrList *list)
{
TemplateVariant *v = m_cachedLists.find(name);
Expand Down Expand Up @@ -663,6 +665,19 @@ class TranslateContext::Private : public PropertyMapper
static bool extractAll = Config_getBool("EXTRACT_ALL");
return theTranslator->trNamespaceMemberDescription(extractAll);
}
TemplateVariant classMembersDescription() const
{
static bool extractAll = Config_getBool("EXTRACT_ALL");
static bool fortranOpt = Config_getBool("OPTIMIZE_FOR_FORTRAN");
if (fortranOpt)
{
return theTranslator->trCompoundMembersDescriptionFortran(extractAll);
}
else
{
return theTranslator->trCompoundMembersDescription(extractAll);
}
}
TemplateVariant relatedPagesDesc() const
{
return theTranslator->trRelatedPagesDescription();
Expand Down Expand Up @@ -805,6 +820,11 @@ class TranslateContext::Private : public PropertyMapper
bool extractAll = Config_getBool("EXTRACT_ALL");
return theTranslator->trModulesListDescription(extractAll);
}
TemplateVariant namespaceListDescription() const
{
bool extractAll = Config_getBool("EXTRACT_ALL");
return theTranslator->trNamespaceListDescription(extractAll);
}
TemplateVariant directories() const
{
return theTranslator->trDirectories();
Expand Down Expand Up @@ -871,6 +891,8 @@ class TranslateContext::Private : public PropertyMapper
addProperty("classHierarchy", this,&Private::classHierarchy);
//%% string classMembers
addProperty("classMembers", this,&Private::classMembers);
//%% string classMembersDescription
addProperty("classMembersDescription",this,&Private::classMembersDescription);
//%% string modules
addProperty("modules", this,&Private::modules);
//%% string namespaces
Expand Down Expand Up @@ -961,6 +983,8 @@ class TranslateContext::Private : public PropertyMapper
addProperty("detailLevel", this,&Private::detailLevel);
//%% string fileListDescription
addProperty("fileListDescription",this,&Private::fileListDescription);
//%% string namespaceListDescription
addProperty("namespaceListDescription",this,&Private::namespaceListDescription);
//%% string directories
addProperty("directories", this,&Private::directories);
//%% string moduleDescript
Expand Down Expand Up @@ -1177,7 +1201,7 @@ class DefinitionContext : public PropertyMapper
static bool createSubdirs = Config_getBool("CREATE_SUBDIRS");
return createSubdirs ? QCString("../../") : QCString("");
}
TemplateVariant relPath() const
virtual TemplateVariant relPath() const
{
return relPathAsString();
}
Expand Down Expand Up @@ -1499,6 +1523,7 @@ class ClassContext::Private : public DefinitionContext<ClassContext::Private>
addProperty("memberGroups", this,&Private::memberGroups);
addProperty("additionalInheritedMembers",this,&Private::additionalInheritedMembers);
}
virtual ~Private() {}
TemplateVariant title() const
{
return TemplateVariant(m_classDef->title());
Expand Down Expand Up @@ -2175,6 +2200,7 @@ class NamespaceContext::Private : public DefinitionContext<NamespaceContext::Pri
addProperty("detailedVariables", this,&Private::detailedVariables);
addProperty("inlineClasses", this,&Private::inlineClasses);
}
virtual ~Private() {}
TemplateVariant title() const
{
return TemplateVariant(m_namespaceDef->title());
Expand Down Expand Up @@ -2433,6 +2459,7 @@ class FileContext::Private : public DefinitionContext<FileContext::Private>
addProperty("inlineClasses", this,&Private::inlineClasses);
addProperty("compoundType", this,&Private::compoundType);
}
virtual ~Private() {}
TemplateVariant title() const
{
return m_fileDef->title();
Expand Down Expand Up @@ -2789,6 +2816,7 @@ class DirContext::Private : public DefinitionContext<DirContext::Private>
addProperty("hasDetails", this,&Private::hasDetails);
addProperty("compoundType", this,&Private::compoundType);
}
virtual ~Private() {}
TemplateVariant title() const
{
return TemplateVariant(m_dirDef->shortTitle());
Expand Down Expand Up @@ -2849,6 +2877,10 @@ class DirContext::Private : public DefinitionContext<DirContext::Private>
{
return theTranslator->trDir(FALSE,TRUE);
}
TemplateVariant relPath() const
{
return "";
}

private:
DirDef *m_dirDef;
Expand Down Expand Up @@ -2891,6 +2923,7 @@ class PageContext::Private : public DefinitionContext<PageContext::Private>
addProperty("highlight",this,&Private::highlight);
addProperty("subhighlight",this,&Private::subHighlight);
}
virtual ~Private() {}
TemplateVariant title() const
{
if (m_isMainPage)
Expand All @@ -2909,9 +2942,27 @@ class PageContext::Private : public DefinitionContext<PageContext::Private>
return m_pageDef->title();
}
}
TemplateVariant relPath() const
{
if (m_pageDef==Doxygen::mainPage)
{
return "";
}
else
{
return DefinitionContext<PageContext::Private>::relPath();
}
}
TemplateVariant highlight() const
{
return "pages";
if (m_pageDef==Doxygen::mainPage)
{
return "main";
}
else
{
return "pages";
}
}
TemplateVariant subHighlight() const
{
Expand Down Expand Up @@ -3186,6 +3237,7 @@ class MemberContext::Private : public DefinitionContext<MemberContext::Private>
if (md->isRaisable()) m_cache.eventAttrs->append("raise");
}
}
virtual ~Private() {}
TemplateVariant fieldType() const
{
return createLinkedText(m_memberDef,relPathAsString(),m_memberDef->fieldType());
Expand Down Expand Up @@ -4161,6 +4213,7 @@ class ModuleContext::Private : public DefinitionContext<ModuleContext::Private>
addProperty("inlineClasses", this,&Private::inlineClasses);
addProperty("compoundType", this,&Private::compoundType);
}
virtual ~Private() {}
TemplateVariant title() const
{
return TemplateVariant(m_groupDef->groupTitle());
Expand Down Expand Up @@ -5784,6 +5837,23 @@ TemplateListIntf::ConstIterator *NamespaceListContext::createIterator() const
class NamespaceTreeContext::Private : public PropertyMapper
{
public:
Private()
{
m_namespaceTree.reset(NestingContext::alloc(0,0));
if (Doxygen::namespaceSDict)
{
m_namespaceTree->addNamespaces(*Doxygen::namespaceSDict,TRUE,FALSE);
}
//%% Nesting tree
addProperty("tree",this,&Private::tree);
addProperty("fileName",this,&Private::fileName);
addProperty("relPath",this,&Private::relPath);
addProperty("highlight",this,&Private::highlight);
addProperty("subhighlight",this,&Private::subhighlight);
addProperty("title",this,&Private::title);
addProperty("preferredDepth",this,&Private::preferredDepth);
addProperty("maxDepth",this,&Private::maxDepth);
}
TemplateVariant tree() const
{
return m_namespaceTree.get();
Expand Down Expand Up @@ -5822,23 +5892,35 @@ class NamespaceTreeContext::Private : public PropertyMapper
return theTranslator->trNamespaceList();
}
}
Private()
TemplateVariant maxDepth() const
{
m_namespaceTree.reset(NestingContext::alloc(0,0));
if (Doxygen::namespaceSDict)
if (!m_cache.maxDepthComputed)
{
m_namespaceTree->addNamespaces(*Doxygen::namespaceSDict,TRUE,FALSE);
m_cache.maxDepth = computeMaxDepth(m_namespaceTree.get());
m_cache.maxDepthComputed=TRUE;
}
//%% Nesting tree
addProperty("tree",this,&Private::tree);
addProperty("fileName",this,&Private::fileName);
addProperty("relPath",this,&Private::relPath);
addProperty("highlight",this,&Private::highlight);
addProperty("subhighlight",this,&Private::subhighlight);
addProperty("title",this,&Private::title);
return m_cache.maxDepth;
}
TemplateVariant preferredDepth() const
{
if (!m_cache.preferredDepthComputed)
{
m_cache.preferredDepth = computePreferredDepth(m_namespaceTree.get(),maxDepth().toInt());
m_cache.preferredDepthComputed=TRUE;
}
return m_cache.preferredDepth;
}
private:
SharedPtr<NestingContext> m_namespaceTree;
struct Cachable
{
Cachable() : maxDepthComputed(FALSE), preferredDepthComputed(FALSE) {}
int maxDepth;
bool maxDepthComputed;
int preferredDepth;
bool preferredDepthComputed;
};
mutable Cachable m_cache;
};
//%% }

Expand Down Expand Up @@ -7581,7 +7663,7 @@ class InheritedMemberInfoContext::Private : public PropertyMapper
addProperty("id", this,&Private::id);
addProperty("inheritedFrom", this,&Private::inheritedFrom);
}
~Private()
virtual ~Private()
{
delete m_memberList;
}
Expand Down Expand Up @@ -8120,6 +8202,8 @@ void generateOutputViaTemplate()
g_globals.outputFormat = ContextGlobals::Html;
g_globals.dynSectionId = 0;
g_globals.outputDir = Config_getString("HTML_OUTPUT");
QDir dir(g_globals.outputDir);
createSubDirs(dir);
HtmlEscaper htmlEsc;
ctx->setEscapeIntf(Config_getString("HTML_FILE_EXTENSION"),&htmlEsc);
HtmlSpaceless spl;
Expand Down
4 changes: 2 additions & 2 deletions src/context.h
View file
Expand Up @@ -66,7 +66,7 @@ class RefCountedContext
m_className=className;
m_insideRelease = FALSE;
}
virtual ~RefCountedContext()
~RefCountedContext()
{
if (!m_insideRelease) abort();
}
Expand Down Expand Up @@ -152,7 +152,7 @@ class DoxygenContext : public RefCountedContext, public TemplateStructIntf

private:
DoxygenContext();
~DoxygenContext();
~DoxygenContext();
class Private;
Private *p;
};
Expand Down
2 changes: 1 addition & 1 deletion src/definition.cpp
View file
Expand Up @@ -1360,7 +1360,7 @@ QCString Definition::qualifiedName() const
//printf("end %s::qualifiedName()=%s\n",name().data(),m_impl->qualifiedName.data());
//count--;
return m_impl->qualifiedName;
};
}

void Definition::setOuterScope(Definition *d)
{
Expand Down
2 changes: 1 addition & 1 deletion src/memberdef.cpp
View file
Expand Up @@ -5102,6 +5102,6 @@ bool MemberDef::isFunctionOrSignalSlot() const

bool MemberDef::isRelatedOrFriend() const
{
return isRelated() || isForeign() || isFriend() && !isFriendToHide();
return isRelated() || isForeign() || (isFriend() && !isFriendToHide());
}

21 changes: 21 additions & 0 deletions src/template.cpp
View file
Expand Up @@ -27,6 +27,7 @@
#include <qfile.h>
#include <qregexp.h>
#include <qcstring.h>
#include <qdir.h>

#include "sortdict.h"
#include "ftextstream.h"
Expand Down Expand Up @@ -3465,6 +3466,25 @@ class TemplateNodeCreate : public TemplateNodeCreator<TemplateNodeCreate>
delete m_templateExpr;
delete m_fileExpr;
}
void mkpath(TemplateContextImpl *ci,const QCString &fileName)
{
int i=fileName.find('/');
QCString outputDir = ci->outputDirectory();
QDir d(outputDir);
int j=0;
while (i!=-1) // fileName contains path part
{
if (d.exists())
{
bool ok = d.mkdir(fileName.mid(j,i-j));
if (!ok) break;
QCString dirName = outputDir+'/'+fileName.left(i);
d = QDir(dirName);
j = i+1;
}
i=fileName.find('/',i+1);
}
}
void render(FTextStream &, TemplateContext *c)
{
TemplateContextImpl* ci = dynamic_cast<TemplateContextImpl*>(c);
Expand All @@ -3490,6 +3510,7 @@ class TemplateNodeCreate : public TemplateNodeCreator<TemplateNodeCreate>
TemplateImpl *createTemplate = ct ? dynamic_cast<TemplateImpl*>(ct) : 0;
if (createTemplate)
{
//mkpath(ci,outputFile);
QCString extension=outputFile;
int i=extension.findRev('.');
if (i!=-1)
Expand Down

0 comments on commit 9282aab

Please sign in to comment.