JSDOC/TokenReader.js

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

diff --git a/JSDOC/BuildDocs.js b/JSDOC/BuildDocs.js
index 7793449..8c8552e 100644 (file)
--- a/JSDOC/BuildDocs.js
+++ b/JSDOC/BuildDocs.js
@@ -18,8 +18,7 @@ TokenStream = imports.TokenStream.TokenStream;
 Symbol      = imports.Symbol.Symbol;
 DocComment  = imports.DocComment.DocComment;
 
-/******************    INCLUDES ARE ALL AT THE BOTTOM OF THIS FILE!!!!! *******************/
-
+ 
 // should not realy be here -- or anywhere...??
 
 function makeSortby(attribute) {
@@ -68,7 +67,10 @@ BuildDocs = {
         
         
     },
-    
+    /**
+     * create a list of files in this.srcFiles using list of directories / files in Options.src
+     * 
+     */
     
     _getSrcFiles : function() 
     {
@@ -81,7 +83,10 @@ BuildDocs = {
         
         for (var i = 0; i < Options.src.length; i++) {
             // add to sourcefiles..
-            
+            if (!File.isDirectory(Options.src[i])) {
+                _this.srcFiles.push(Options.src[i]);
+                continue;
+            }
             File.list(Options.src[i] ).forEach(function($) {
                 if (Options['exclude-src'].indexOf($) > -1) {
                     return;
@@ -97,6 +102,10 @@ BuildDocs = {
         //Seed.print(JSON.stringify(this.srcFiles, null,4));Seed.quit();
         return this.srcFiles;
     },
+    /**
+     * Parse the source files.
+     * 
+     */
 
     _parseSrcFiles : function() 
     {
@@ -107,30 +116,46 @@ BuildDocs = {
             var srcFile = this.srcFiles[i];
             
             
-            var cacheFile = Options.cacheDirectory + srcFile.replace(/\//g, '_') + ".cache";
+            var cacheFile = !Options.cacheDirectory.length ? false : 
+                Options.cacheDirectory + srcFile.replace(/\//g, '_') + ".cache";
             
-            //println(cacheFile);
+            //print(cacheFile);
             // disabled at present!@!!
             
-            if (false && !Options.disablecache  && File.exists(cacheFile)) {
+            if (cacheFile  && File.exists(cacheFile)) {
                 // check filetime?
                 
-                var c_mt = File.getTimes(cacheFile);
-                var o_mt = File.getTimes(srcFile);
+                var c_mt = File.mtime(cacheFile);
+                var o_mt = File.mtime(srcFile);
                 //println(c_mt.toSource());
                // println(o_mt.toSource());
                
                 // this check does not appear to work according to the doc's - need to check it out.
                
-                if (c_mt[0] > o_mt[0]) { // cached time  > original time!
+                if (c_mt > o_mt) { // cached time  > original time!
                     // use the cached mtimes..
-                    var syms =  JSON.parse(File.read(cacheFile));
-                    
-                    throw "Conversion of cache not done yet!";
-                    
-                    for (var sy in syms) {
-                        //println("ADD:" + sy );
-                       Parser.symbols.addSymbol(syms[sy]);
+                    print("Read " + cacheFile);
+                    var syms =  JSON.parse(File.read(cacheFile), function(k, v) {
+                        //print(k);
+                        if (typeof(v) != 'object') {
+                            return v;
+                        }
+                        if (typeof(v['*object']) == 'undefined') {
+                            return v;
+                        }
+                        var cls = imports[v['*object']][v['*object']];
+                        //print(v['*object']);
+                        delete v['*object'];
+                        var ret = new cls();
+                        XObject.extend(ret, v);
+                        return ret;
+                        
+                        
+                    });
+                    //print("Add sybmols " + cacheFile); 
+                    for (var sy in syms._index) {
+                      //  print("ADD:" + sy );
+                       Parser.symbols.addSymbol(syms._index[sy]);
                     }
                     continue;
                 }
@@ -153,7 +178,16 @@ BuildDocs = {
             var ts = new TokenStream(tr.tokenize(txs));
         
             Parser.parse(ts, srcFile);
-              
+            
+            if (cacheFile) {
+                File.write(cacheFile,
+                  JSON.stringify(
+                    Parser.symbolsToObject(srcFile),
+                    null,2
+                  )
+                );
+            
+            }
             //var outstr = JSON.stringify(
             //    Parser.filesSymbols[srcFile]._index
             //);
@@ -231,8 +265,8 @@ BuildDocs = {
         function isaFile($) {
             return ($.is("FILE"))
         }
-        function isaClass($) { 
-            return ($.is("CONSTRUCTOR") || $.isNamespace); 
+        function isaClass($) {
+            return ($.is("CONSTRUCTOR") || $.isNamespace || $.isClass); 
         }
         
         
@@ -253,6 +287,7 @@ BuildDocs = {
             var targetDir = Options.target + "/symbols/src/";
             this.makeSrcFile(file, targetDir);
         }
+        //print(JSON.stringify(symbols,null,4));
         
         var classes = symbols.filter(isaClass).sort(makeSortby("alias"));
          
@@ -282,11 +317,11 @@ BuildDocs = {
             
         }
         
-        File.write(Options.target+"/symbols/json/roodata.json",
+        File.write(Options.target+"/json/roodata.json",
                 JSON.stringify({
                     success : true,
                     data : jsonAll
-                }, null, 1);
+                }, null, 1)
         );
         
         
@@ -336,14 +371,14 @@ BuildDocs = {
      * 
      * 
      */
-    publishJSON : function(file, data)
+    publishJSON : function(data)
     {
         // what we need to output to be usefull...
         // a) props..
         var cfgProperties = [];
         if (!data.comment.getTag('singleton').length) {
             cfgProperties = data.configToArray();
-            cfgProperties = cfgProperties.sort(makeSortby("name"));
+            cfgProperties = cfgProperties.sort(makeSortby("alias"));
             
         }
         var props = []; 
@@ -351,12 +386,17 @@ BuildDocs = {
         var p ='';
         for(var i =0; i < cfgProperties.length;i++) {
             p = cfgProperties[i];
-            props.push( {
+            var add = {
                 name : p.name,
                 type : p.type,
                 desc : p.desc,
+                
                 memberOf : p.memberOf == data.alias ? '' : p.memberOf
-            });
+            }
+            if (p.optvalues) {
+                add.optvals = p.optvalues;
+            }
+            props.push(add );
         }
         
          
@@ -376,6 +416,24 @@ BuildDocs = {
                 desc : m.desc
             });
         }
+        
+        var ownMethods = data.methods.filter( function(e){
+                return !e.isEvent && !e.comment.getTag('hide').length;
+            }).sort(makeSortby("name"));
+             
+        
+        var methods = [];
+        
+        for(var i =0; i < ownMethods.length;i++) {
+            m = ownMethods[i];
+            methods.push( {
+                name : m.name,
+                sig : this.makeMethodSkel(m.params),
+                type : 'function',
+                desc : m.desc
+            });
+        }
+        
         //println(props.toSource());
         // we need to output:
         //classname => {
@@ -386,7 +444,8 @@ BuildDocs = {
 
         var ret = {
             props : props,
-            events: events
+            events: events,
+            methods : methods,
         };
         return ret;
         
@@ -438,8 +497,17 @@ BuildDocs = {
                 }
             ).map( function($) { return $.name == 'this' ? '_self' : $.name; } ).join(", ") +
         ")\n{\n\n}";
+    },
+       makeMethodSkel :function(params) {
+        if (!params) return "()";
+        return "("     +
+            params.filter(
+                function($) {
+                    return $.name.indexOf(".") == -1; // don't show config params in signature
+                }
+            ).map( function($) { return  $.type + " "  +(  $.name == 'this' ? '_self' : $.name ); } ).join(", ") +
+        ")";
     }
-       
  
     
 };