JSDOC/BuildDocs.js

[gnome.introspection-doc-generator] / JSDOC / BuildDocs.js

diff --git a/JSDOC/BuildDocs.js b/JSDOC/BuildDocs.js
index 59d571d..3a6529b 100644 (file)
--- a/JSDOC/BuildDocs.js
+++ b/JSDOC/BuildDocs.js
@@ -3,19 +3,21 @@
        This is the main container for the JSDOC application.
        @namespace
 */
-
+Gio = imports.gi.Gio;
 
 XObject = imports.XObject.XObject;
 File = imports.File.File;
 
 Template = imports.JsTemplate.Template.Template;
+Link = imports.JsTemplate.Link.Link; // ?? fixme!??
 
-
-Parser   = imports.Parser.Parser;
-TextStream = imports.TextStream.TextStream;
+Parser      = imports.Parser.Parser;
+TextStream  = imports.TextStream.TextStream;
 TokenReader = imports.TokenReader.TokenReader;
 TokenStream = imports.TokenStream.TokenStream;
-Symbol = imports.Symbol.Symbol;
+Symbol      = imports.Symbol.Symbol;
+DocComment  = imports.DocComment.DocComment;
+
 /******************    INCLUDES ARE ALL AT THE BOTTOM OF THIS FILE!!!!! *******************/
 
 // should not realy be here -- or anywhere...??
@@ -135,7 +137,7 @@ BuildDocs = {
 
             var txs = new TextStream(src);
             
-            var tr = new TokenReader({ keepComments : true, keepWhite : true });
+            var tr = new TokenReader({ keepComments : true, keepWhite : true , sepIdents: false });
             
             var ts = new TokenStream(tr.tokenize(txs));
         
@@ -175,38 +177,38 @@ BuildDocs = {
             File.mkdir(Options.target +"/json");
         }
         
-        Options.LOG.inform("Copying files from static: " +Options.templatesDir);
+        Options.LOG.inform("Copying files from static: " +Options.templateDir);
         // copy everything in 'static' into 
-        File.list(Options.templatesDir + '/static').forEach(function (f) {
-            Options.LOG.inform("Copy " + Options.templatesDir + '/static/' + f + ' to  ' + Options.target + '/' + f);
-            File.copy(Options.templatesDir + '/static/' + f, Options.target + '/' + f);
+        File.list(Options.templateDir + '/static').forEach(function (f) {
+            Options.LOG.inform("Copy " + Options.templateDir + '/static/' + f + ' to  ' + Options.target + '/' + f);
+            File.copyFile(Options.templateDir + '/static/' + f, Options.target + '/' + f,  Gio.FileCopyFlags.OVERWRITE);
         });
         
         
         Options.LOG.inform("Setting up templates");
         // used to check the details of things being linked to
-        Link.symbolSet = symbolSet;
+        Link.symbolSet = this.symbolSet;
         Link.base = "../";
         
         var classTemplate = new Template({
-             templateFile : Options.templatesDir  + "/class.tmpl",
+             templateFile : Options.templateDir  + "/class.tmpl",
              Link : Link
         });
         var classesTemplate = new Template({
-            templateFile : Options.templatesDir +"/allclasses.tmpl",
+            templateFile : Options.templateDir +"/allclasses.tmpl",
             Link : Link
         });
         var classesindexTemplate = new Template({
-            templateFile : Options.templatesDir +"/index.tmpl",
+            templateFile : Options.templateDir +"/index.tmpl",
             Link : Link
         });
         var fileindexTemplate = new Template({   
-            templateFile : Options.templatesDir +"/allfiles.tmpl",
+            templateFile : Options.templateDir +"/allfiles.tmpl",
             Link: Link
         });
 
         
-        classTemplate.symbolSet = symbolSet;
+        classTemplate.symbolSet = this.symbolSet;
         
         
         function hasNoParent($) {
@@ -218,8 +220,27 @@ BuildDocs = {
         function isaClass($) { 
             return ($.is("CONSTRUCTOR") || $.isNamespace); 
         }
+        function makeSortby(attribute) {
+            return function(a, b) {
+                if (a[attribute] != undefined && b[attribute] != undefined) {
+                    a = a[attribute]; //.toLowerCase();
+                    b = b[attribute];//.toLowerCase();
+                    if (a < b) return -1;
+                    if (a > b) return 1;
+                    return 0;
+                }
+            }
+        }
+        
+        
+        
+        
+        
         
-        var symbols = symbolSet.toArray();
+        
+        
+        
+        var symbols = this.symbolSet.toArray();
         
         var files = Options.srcFiles;
         
@@ -231,22 +252,26 @@ BuildDocs = {
         
         var classes = symbols.filter(isaClass).sort(makeSortby("alias"));
          
-       var classesIndex = classesTemplate.process(classes); // kept in memory
-        
+         //Options.LOG.inform("classTemplate Process : all classes");
+            
+       // var classesIndex = classesTemplate.process(classes); // kept in memory
         
+        Options.LOG.inform("iterate classes");
         
         for (var i = 0, l = classes.length; i < l; i++) {
             var symbol = classes[i];
             var output = "";
             
+            Options.LOG.inform("classTemplate Process : " + symbol.alias);
+            
             File.write(Options.target+"/symbols/" +symbol.alias+'.' + Options.publishExt ,
                     classTemplate.process(symbol));
             
-            print("write " + Options.target+"/symbols/" +symbol.alias+'.' + Options.publishExt);
+            
             
             // dump out a 
             
-            this.publishJSON(Options.target+"/json/",  symbol.alias+'.json', symbol)
+            this.publishJSON(Options.target+"/json/" + symbol.alias+'.json', symbol)
             
             
             
@@ -254,9 +279,9 @@ BuildDocs = {
         
         // regenrate the index with different relative links
         Link.base = "";
-        var classesIndex = classesTemplate.process(classes);
+        //var classesIndex = classesTemplate.process(classes);
         
-          
+        Options.LOG.inform("build index");
         
         File.write(Options.target +  "/index."+ Options.publishExt, 
             classesindexTemplate.process(classes)
@@ -273,7 +298,7 @@ BuildDocs = {
         var allFiles = [];
         
         for (var i = 0; i < files.length; i++) {
-            allFiles.push(new  Symbol(files[i], [], "FILE", new JSDOC.DocComment("/** */")));
+            allFiles.push(new  Symbol(files[i], [], "FILE", new DocComment("/** */")));
         }
         
         for (var i = 0; i < documentedFiles.length; i++) {
@@ -282,12 +307,19 @@ BuildDocs = {
         }
             
         allFiles = allFiles.sort(makeSortby("name"));
-        File.write(Options.target , "/files."+Options.publishExt, 
+        Options.LOG.inform("write files index");
+        
+        File.write(Options.target + "/files."+Options.publishExt, 
             fileindexTemplate.process(allFiles)
         );
         
     },
-
+    /**
+     * JSON files are lookup files for the documentation
+     * - can be used by IDE's or AJAX based doc tools
+     * 
+     * 
+     */
     publishJSON : function(file, data)
     {
         // what we need to output to be usefull...
@@ -350,13 +382,16 @@ BuildDocs = {
     },
     makeSrcFile: function(sourceFile) 
     {
+        // this stuff works...
+        return;
         
         
-        name = sourceFile.substring(Options.baseDir.length);
+        name = sourceFile.substring(Options.baseDir.length+1);
         name = name.replace(/\.\.?[\\\/]/g, "").replace(/[\\\/]/g, "_");
-        name = name.replace(/\:/g, "_"); //??
         
+        name = name.replace(/\:/g, "_"); //??
         
+        Options.LOG.inform("Write Source file : " + Options.target+"/symbols/src/" + name);
         var pretty = imports.PrettyPrint.toPretty(File.read(sourceFile));
         File.write(Options.target+"/symbols/src/" + name, 
             '<html><head>' +