Introduced template directory for template and resource files and resource compiler & manager

Author: Dimitri van Heesch

.gitignore

@@ -70,3 +70,6 @@
 /man
 /docbook
 /perlmod
+!/templates/html
+!/templates/latex
+

Makefile.in

@@ -102,7 +102,7 @@ pdf: docs
 DISTFILES =  Doxyfile vhdlparser libmd5 addon tmake doc examples bin lib objects testing \
              qtools src configure configure.bin Makefile.in Makefile.win_nmake.in \
              Makefile.win_make.in INSTALL LANGUAGE.HOWTO LICENSE PLATFORMS \
-             VERSION README.md packages winbuild jquery
+             VERSION README.md packages winbuild jquery templates
 
 archive: clean
 	tar zcvf dx`date +%y%m%d`.tgz $(DISTFILES)

jquery/Makefile

@@ -3,6 +3,7 @@ JQUERY_UI_VERSION = 1.8.18
 HASHCHANGE_VERSION = 1.3
 SCROLL_VERSION = 1.4.2
 POWERTIP_VERSION = 1.2.0
+
 MINIFIER ?= /usr/local/bin/yuicompressor-2.4.7
 SCRIPTS = jquery-$(JQUERY_VERSION).js \
           jquery.ui-$(JQUERY_UI_VERSION).core.js \
@@ -12,37 +13,23 @@ SCRIPTS = jquery-$(JQUERY_VERSION).js \
           jquery.ba-$(HASHCHANGE_VERSION)-hashchange.js \
           jquery.scrollTo-$(SCROLL_VERSION).js \
 	  jquery.powertip-$(POWERTIP_VERSION).js
-RESULTS = jquery_p1.js jquery_p2.js jquery_p3.js \
-          jquery_ui.js jquery_fx.js jquery_pt.js
+RESULTS = jquery.js
 
 SCRIPTS_MIN = $(SCRIPTS:%.js=%-min.js)
 
 all: $(RESULTS)
 
 install: $(RESULTS)
-	cp $(RESULTS) ../src/
-
-jquery_ui.js: scripts
-	cat jquery.ui-$(JQUERY_UI_VERSION).core-min.js \
-            jquery.ui-$(JQUERY_UI_VERSION).widget-min.js \
-            jquery.ui-$(JQUERY_UI_VERSION).mouse-min.js \
-            jquery.ui-$(JQUERY_UI_VERSION).resizable-min.js \
-            jquery.ba-$(HASHCHANGE_VERSION)-hashchange-min.js > jquery_ui.js
-
-jquery_pt.js: scripts
-	cat jquery.powertip-$(POWERTIP_VERSION)-min.js > jquery_pt.js
-
-jquery_fx.js: scripts
-	cat jquery.scrollTo-$(SCROLL_VERSION)-min.js > jquery_fx.js
+	cp $(RESULTS) ../templates/html/
 
-jquery_p1.js jquery_p2.js jquery_p3.js: scripts
-	perl split_jquery.pl jquery-$(JQUERY_VERSION)-min.js $@
+jquery.js: scripts
+	cat $(SCRIPTS_MIN) > jquery.js
 
 scripts: $(SCRIPTS_MIN)
 
 clean:
 	rm -f $(SCRIPTS_MIN) $(RESULTS)
 
 %-min.js: %.js
-	java -jar $(MINIFIER).jar --line-break 13000 $^ > $@
+	java -jar $(MINIFIER).jar $^ > $@
 

jquery/README

@@ -11,7 +11,4 @@ packages:
 - jquery.scrollTo: 1.4.2: https://github.com/flesler/jquery.scrollTo
 - jquery.powertip: 1.2.0: http://stevenbenner.github.io/jquery-powertip/
 
-The Makefile will built the jquery_*.js files used by doxygen.
-Some files are split into smaller parts to make sure Visual Studio can compile them 
-as strings.
-
+The Makefile will built the jquery.js files used by doxygen.

jquery/split_jquery.pl

@@ -297,7 +297,7 @@ class QCString
     {
       if (!str) return *this;
       int len1 = length();
-      int len2 = strlen(str);
+      int len2 = (int)strlen(str);
       resize(len1+len2+1);
       memcpy(data()+len1,str,len2);
       return *this;
@@ -467,7 +467,7 @@ class QCString
         {
           if (str)
           {
-            int len = strlen(str);
+            int len = (int)strlen(str);
             u.s.isShort = len<SHORT_STR_CAPACITY;
             if (len<SHORT_STR_CAPACITY)
             {
@@ -489,7 +489,7 @@ class QCString
         {
           if (str && maxlen>0)
           {
-            uint len=strlen(str);
+            uint len=(uint)strlen(str);
             if (len>maxlen) len=maxlen;
             u.s.isShort = len<=SHORT_STR_MAX_LEN;
             if (u.s.isShort)
@@ -543,7 +543,7 @@ class QCString
           }
           if (str)
           {
-            int len = strlen(str);
+            int len = (int)strlen(str);
             u.s.isShort = len<SHORT_STR_CAPACITY;
             if (len<SHORT_STR_CAPACITY)
             {

qtools/qcstring.h

@@ -21,20 +21,11 @@
 #include "util.h"
 #include "language.h"
 #include "ftextstream.h"
+#include "resourcemgr.h"
 #include <qdir.h>
 
 //--------------------------------------------------------------------------
 
-static const char *doxygen_bst =
-#include "doxygen.bst.h"
-;
-
-static const char *bib2xhtml_pl =
-#include "bib2xhtml.pl.h"
-;
-
-//--------------------------------------------------------------------------
-
 const QCString CiteConsts::fileName("citelist");
 const QCString CiteConsts::anchorPrefix("CITEREF_");
 const QCString bibTmpFile("bibTmpFile_");
@@ -153,26 +144,12 @@ void CiteDict::generatePage() const
   f.close();
 
   // 2. generate bib2xhtml
-  QCString bib2xhtmlFile = outputDir+"/bib2xhtml.pl";
-  f.setName(bib2xhtmlFile);
-  QCString bib2xhtml = bib2xhtml_pl;
-  if (!f.open(IO_WriteOnly)) 
-  {
-    err("could not open file %s for writing\n",bib2xhtmlFile.data());
-  }
-  f.writeBlock(bib2xhtml, bib2xhtml.length());
-  f.close();
+  QCString bib2xhtmlFile  = outputDir+"/bib2xhtml.pl";
+  ResourceMgr::instance().copyResource("bib2xhtml.pl",outputDir);
 
   // 3. generate doxygen.bst
   QCString doxygenBstFile = outputDir+"/doxygen.bst";
-  QCString bstData = doxygen_bst;
-  f.setName(doxygenBstFile);
-  if (!f.open(IO_WriteOnly)) 
-  {
-    err("could not open file %s for writing\n",doxygenBstFile.data());
-  }
-  f.writeBlock(bstData, bstData.length());
-  f.close();
+  ResourceMgr::instance().copyResource("doxygen.bst",outputDir);
 
   // 4. for all formats we just copy the bib files to as special output directory
   //    so bibtex can find them without path (bibtex doesn't support paths or

src/cite.cpp

@@ -13,6 +13,7 @@
  *
  */
 
+#include <assert.h>
 #include <qdir.h>
 
 #include "context.h"
@@ -1108,6 +1109,7 @@ class DefinitionContext : public PropertyMapper
   public:
     DefinitionContext(Definition *d) : m_def(d)
     {
+      assert(d!=0);
       //%% string name: the name of the symbol
       addProperty("name",this,&DefinitionContext::name);
       //%% string bareName: the bare name of the symbol with scope info
@@ -8147,7 +8149,6 @@ void generateOutputViaTemplate()
       SharedPtr<ExampleListContext>           exampleList          (ExampleListContext::alloc());
       SharedPtr<ModuleTreeContext>            moduleTree           (ModuleTreeContext::alloc());
       SharedPtr<ModuleListContext>            moduleList           (ModuleListContext::alloc());
-      SharedPtr<PageContext>                  mainPage             (PageContext::alloc(Doxygen::mainPage,TRUE));
       SharedPtr<GlobalsIndexContext>          globalsIndex         (GlobalsIndexContext::alloc());
       SharedPtr<ClassMembersIndexContext>     classMembersIndex    (ClassMembersIndexContext::alloc());
       SharedPtr<NamespaceMembersIndexContext> namespaceMembersIndex(NamespaceMembersIndexContext::alloc());
@@ -8187,7 +8188,15 @@ void generateOutputViaTemplate()
       //%% DirList dirList
       ctx->set("dirList",dirList.get());
       //%% Page mainPage
-      ctx->set("mainPage",mainPage.get());
+      if (Doxygen::mainPage)
+      {
+        SharedPtr<PageContext> mainPage(PageContext::alloc(Doxygen::mainPage,TRUE));
+        ctx->set("mainPage",mainPage.get());
+      }
+      else
+      {
+        ctx->set("mainPage",FALSE);
+      }
       //%% GlobalsIndex globalsIndex:
       ctx->set("globalsIndex",globalsIndex.get());
       //%% ClassMembersIndex classMembersIndex:

src/context.cpp

@@ -100,6 +100,9 @@
 #include "context.h"
 #include "fileparser.h"
 
+// provided by the generated file resources.cpp
+extern void initResources();
+
 #define RECURSE_ENTRYTREE(func,var) \
   do { if (var->children()) { \
     EntryNavListIterator eli(*var->children()); \
@@ -9915,6 +9918,7 @@ static const char *getArg(int argc,char **argv,int &optind)
 
 void initDoxygen()
 {
+  initResources();
   const char *lang = portable_getenv("LC_ALL");
   if (lang) portable_setenv("LANG",lang);
   setlocale(LC_ALL,"");
@@ -10884,7 +10888,7 @@ void parseInput()
 
   QCString htmlOutput;
   bool &generateHtml = Config_getBool("GENERATE_HTML");
-  if (generateHtml)
+  if (generateHtml || g_useOutputTemplate /* TODO: temp hack */)
     htmlOutput = createOutputDirectory(outputDirectory,"HTML_OUTPUT","/html");
 
   QCString docbookOutput;