git.roojs.org Git - gnome.introspection-doc-generator/blob - JSDOC/BuildDocs.js

   1 //<script type="text/javascript">
   2 /**
   3         This is the main container for the JSDOC application.
   4         @namespace
   5 */
   6 Gio = imports.gi.Gio;
   7
   8 XObject = imports.XObject.XObject;
   9 File = imports.File.File;
  10
  11 Template = imports.JsTemplate.Template.Template;
  12 Link = imports.JsTemplate.Link.Link; // ?? fixme!??
  13
  14 Parser      = imports.Parser.Parser;
  15 TextStream  = imports.TextStream.TextStream;
  16 TokenReader = imports.TokenReader.TokenReader;
  17 TokenStream = imports.TokenStream.TokenStream;
  18 Symbol      = imports.Symbol.Symbol;
  19 DocComment  = imports.DocComment.DocComment;
  20
  21
  22 // should not realy be here -- or anywhere...??
  23
  24 function makeSortby(attribute) {
  25     return function(a, b) {
  26         if (a[attribute] != undefined && b[attribute] != undefined) {
  27             a = a[attribute]; //.toLowerCase();
  28             b = b[attribute];//.toLowerCase();
  29             if (a < b) return -1;
  30             if (a > b) return 1;
  31             return 0;
  32         }
  33     }
  34 }
  35
  36 Options = false; // refer to this everywhere!
  37
  38
  39 BuildDocs = {
  40
  41     VERSION : "2.0.0",
  42
  43
  44     srcFiles : [],
  45
  46
  47     build : function (opts)
  48     {
  49         Options = opts;
  50         Options.init();
  51
  52         Options.LOG.inform("JsDoc Toolkit main() running at "+new Date()+".");
  53         //Options.LOG.inform("With options: ");
  54
  55         if (Options.cacheDirectory.length && !File.isDirectory(Options.cacheDirectory)) {
  56             File.mkdir(Options.cacheDirectory)
  57         }
  58
  59         Options.srcFiles = this._getSrcFiles();
  60         this._parseSrcFiles();
  61         this.symbolSet = Parser.symbols;
  62
  63         // this currently uses the concept of publish.js...
  64
  65         this.publish();
  66
  67
  68
  69     },
  70     /**
  71      * create a list of files in this.srcFiles using list of directories / files in Options.src
  72      *
  73      */
  74
  75     _getSrcFiles : function()
  76     {
  77         this.srcFiles = [];
  78         var _this = this;
  79         var ext = ["js"];
  80         if (Options.ext) {
  81             ext = Options.ext.split(",").map(function($) {return $.toLowerCase()});
  82         }
  83
  84         for (var i = 0; i < Options.src.length; i++) {
  85             // add to sourcefiles..
  86             if (!File.isDirectory(Options.src[i])) {
  87                 _this.srcFiles.push(Options.src[i]);
  88                 continue;
  89             }
  90             File.list(Options.src[i] ).forEach(function($) {
  91                 if (Options['exclude-src'].indexOf($) > -1) {
  92                     return;
  93                 }
  94                 var thisExt = $.split(".").pop().toLowerCase();
  95                 if (ext.indexOf(thisExt) < 0) {
  96                     return;
  97                 }
  98                 _this.srcFiles.push(Options.src[i] + '/' + $);
  99             });
 100
 101         }
 102         //Seed.print(JSON.stringify(this.srcFiles, null,4));Seed.quit();
 103         return this.srcFiles;
 104     },
 105     /**
 106      * Parse the source files.
 107      *
 108      */
 109
 110     _parseSrcFiles : function()
 111     {
 112         Parser.init();
 113
 114         for (var i = 0, l = this.srcFiles.length; i < l; i++) {
 115
 116             var srcFile = this.srcFiles[i];
 117
 118
 119             var cacheFile = !Options.cacheDirectory.length ? false :
 120                 Options.cacheDirectory + srcFile.replace(/\//g, '_') + ".cache";
 121
 122             //print(cacheFile);
 123             // disabled at present!@!!
 124
 125             if (cacheFile  && File.exists(cacheFile)) {
 126                 // check filetime?
 127
 128                 var c_mt = File.mtime(cacheFile);
 129                 var o_mt = File.mtime(srcFile);
 130                 //println(c_mt.toSource());
 131                // println(o_mt.toSource());
 132
 133                 // this check does not appear to work according to the doc's - need to check it out.
 134
 135                 if (c_mt > o_mt) { // cached time  > original time!
 136                     // use the cached mtimes..
 137                     print("Read " + cacheFile);
 138                     var syms =  JSON.parse(File.read(cacheFile), function(k, v) {
 139                         //print(k);
 140                         if (typeof(v) != 'object') {
 141                             return v;
 142                         }
 143                         if (typeof(v['*object']) == 'undefined') {
 144                             return v;
 145                         }
 146                         var cls = imports[v['*object']][v['*object']];
 147                         //print(v['*object']);
 148                         delete v['*object'];
 149                         var ret = new cls();
 150                         XObject.extend(ret, v);
 151                         return ret;
 152
 153
 154                     });
 155                     //print("Add sybmols " + cacheFile);
 156                     for (var sy in syms._index) {
 157                       //  print("ADD:" + sy );
 158                        Parser.symbols.addSymbol(syms._index[sy]);
 159                     }
 160                     continue;
 161                 }
 162             }
 163
 164             var src = ''
 165             try {
 166                 Options.LOG.inform("reading : " + srcFile);
 167                 src = File.read(srcFile);
 168             }
 169             catch(e) {
 170                 Options.LOG.warn("Can't read source file '"+srcFile+"': "+e.message);
 171                 continue;
 172             }
 173
 174             var txs = new TextStream(src);
 175
 176             var tr = new TokenReader({ keepComments : true, keepWhite : true , sepIdents: false });
 177
 178             var ts = new TokenStream(tr.tokenize(txs));
 179
 180             Parser.parse(ts, srcFile);
 181
 182             if (cacheFile) {
 183                 File.write(cacheFile,
 184                   JSON.stringify(
 185                     Parser.symbolsToObject(srcFile),
 186                     null,2
 187                   )
 188                 );
 189
 190             }
 191             //var outstr = JSON.stringify(
 192             //    Parser.filesSymbols[srcFile]._index
 193             //);
 194             //File.write(cacheFile, outstr);
 195
 196
 197     //          }
 198         }
 199
 200
 201
 202         Parser.finish();
 203     },
 204
 205
 206
 207     publish  : function() {
 208         Options.LOG.inform("Publishing");
 209
 210         // link!!!
 211
 212
 213         Options.LOG.inform("Making directories");
 214         if (!File.isDirectory(Options.target))
 215             File.mkdir(Options.target);
 216         if (!File.isDirectory(Options.target+"/symbols"))
 217             File.mkdir(Options.target+"/symbols");
 218         if (!File.isDirectory(Options.target+"/symbols/src"))
 219             File.mkdir(Options.target+"/symbols/src");
 220
 221         if (!File.isDirectory(Options.target +"/json")) {
 222             File.mkdir(Options.target +"/json");
 223         }
 224
 225         Options.LOG.inform("Copying files from static: " +Options.templateDir);
 226         // copy everything in 'static' into
 227         File.list(Options.templateDir + '/static').forEach(function (f) {
 228             Options.LOG.inform("Copy " + Options.templateDir + '/static/' + f + ' to  ' + Options.target + '/' + f);
 229             File.copyFile(Options.templateDir + '/static/' + f, Options.target + '/' + f,  Gio.FileCopyFlags.OVERWRITE);
 230         });
 231
 232
 233         Options.LOG.inform("Setting up templates");
 234         // used to check the details of things being linked to
 235         Link.symbolSet = this.symbolSet;
 236         Link.base = "../";
 237
 238         Link.srcFileFlatName = this.srcFileFlatName;
 239         Link.srcFileRelName = this.srcFileRelName;
 240
 241         var classTemplate = new Template({
 242              templateFile : Options.templateDir  + "/class.html",
 243              Link : Link
 244         });
 245         var classesTemplate = new Template({
 246             templateFile : Options.templateDir +"/allclasses.html",
 247             Link : Link
 248         });
 249         var classesindexTemplate = new Template({
 250             templateFile : Options.templateDir +"/index.html",
 251             Link : Link
 252         });
 253         var fileindexTemplate = new Template({
 254             templateFile : Options.templateDir +"/allfiles.html",
 255             Link: Link
 256         });
 257
 258
 259         classTemplate.symbolSet = this.symbolSet;
 260
 261
 262         function hasNoParent($) {
 263             return ($.memberOf == "")
 264         }
 265         function isaFile($) {
 266             return ($.is("FILE"))
 267         }
 268         function isaClass($) {
 269             return ($.is("CONSTRUCTOR") || $.isNamespace || $.isClass);
 270         }
 271
 272
 273
 274
 275
 276
 277
 278
 279
 280
 281         var symbols = this.symbolSet.toArray();
 282
 283         var files = Options.srcFiles;
 284
 285         for (var i = 0, l = files.length; i < l; i++) {
 286             var file = files[i];
 287             var targetDir = Options.target + "/symbols/src/";
 288             this.makeSrcFile(file, targetDir);
 289         }
 290         //print(JSON.stringify(symbols,null,4));
 291
 292         var classes = symbols.filter(isaClass).sort(makeSortby("alias"));
 293
 294          //Options.LOG.inform("classTemplate Process : all classes");
 295
 296        // var classesIndex = classesTemplate.process(classes); // kept in memory
 297
 298         Options.LOG.inform("iterate classes");
 299
 300         var jsonAll = {};
 301
 302         for (var i = 0, l = classes.length; i < l; i++) {
 303             var symbol = classes[i];
 304             var output = "";
 305
 306             Options.LOG.inform("classTemplate Process : " + symbol.alias);
 307
 308
 309
 310
 311             File.write(Options.target+"/symbols/" +symbol.alias+'.' + Options.publishExt ,
 312                     classTemplate.process(symbol));
 313
 314             jsonAll[symbol.alias] = this.publishJSON(symbol);
 315
 316
 317
 318         }
 319
 320         File.write(Options.target+"/json/roodata.json",
 321                 JSON.stringify({
 322                     success : true,
 323                     data : jsonAll
 324                 }, null, 1)
 325         );
 326
 327
 328         // regenrate the index with different relative links
 329         Link.base = "";
 330         //var classesIndex = classesTemplate.process(classes);
 331
 332         Options.LOG.inform("build index");
 333
 334         File.write(Options.target +  "/index."+ Options.publishExt,
 335             classesindexTemplate.process(classes)
 336         );
 337
 338         // blank everything???? classesindexTemplate = classesIndex = classes = null;
 339
 340
 341
 342         var documentedFiles = symbols.filter(function ($) {
 343             return ($.is("FILE"))
 344         });
 345
 346         var allFiles = [];
 347
 348         for (var i = 0; i < files.length; i++) {
 349             allFiles.push(new  Symbol(files[i], [], "FILE", new DocComment("/** */")));
 350         }
 351
 352         for (var i = 0; i < documentedFiles.length; i++) {
 353             var offset = files.indexOf(documentedFiles[i].alias);
 354             allFiles[offset] = documentedFiles[i];
 355         }
 356
 357         allFiles = allFiles.sort(makeSortby("name"));
 358         Options.LOG.inform("write files index");
 359
 360         File.write(Options.target + "/files."+Options.publishExt,
 361             fileindexTemplate.process(allFiles)
 362         );
 363
 364
 365
 366
 367     },
 368     /**
 369      * JSON files are lookup files for the documentation
 370      * - can be used by IDE's or AJAX based doc tools
 371      *
 372      *
 373      */
 374     publishJSON : function(data)
 375     {
 376         // what we need to output to be usefull...
 377         // a) props..
 378         var cfgProperties = [];
 379         if (!data.comment.getTag('singleton').length) {
 380             cfgProperties = data.configToArray();
 381             cfgProperties = cfgProperties.sort(makeSortby("alias"));
 382
 383         }
 384         var props = [];
 385         //println(cfgProperties.toSource());
 386         var p ='';
 387         for(var i =0; i < cfgProperties.length;i++) {
 388             p = cfgProperties[i];
 389             var add = {
 390                 name : p.name,
 391                 type : p.type,
 392                 desc : p.desc,
 393
 394                 memberOf : p.memberOf == data.alias ? '' : p.memberOf
 395             }
 396             if (p.optvalues) {
 397                 add.optvals = p.optvalues;
 398             }
 399             props.push(add );
 400         }
 401
 402
 403         var ownEvents = data.methods.filter( function(e){
 404                 return e.isEvent && !e.comment.getTag('hide').length;
 405             }).sort(makeSortby("name"));
 406
 407
 408         var events = [];
 409         var m;
 410         for(var i =0; i < ownEvents.length;i++) {
 411             m = ownEvents[i];
 412             events.push( {
 413                 name : m.name.substring(1),
 414                 sig : this.makeFuncSkel(m.params),
 415                 type : 'function',
 416                 desc : m.desc
 417             });
 418         }
 419
 420         var ownMethods = data.methods.filter( function(e){
 421                 return !e.isEvent && !e.comment.getTag('hide').length;
 422             }).sort(makeSortby("name"));
 423
 424
 425         var methods = [];
 426
 427         for(var i =0; i < ownMethods.length;i++) {
 428             m = ownMethods[i];
 429             methods.push( {
 430                 name : m.name,
 431                 sig : this.makeMethodSkel(m.params),
 432                 type : 'function',
 433                 desc : m.desc
 434             });
 435         }
 436
 437         //println(props.toSource());
 438         // we need to output:
 439         //classname => {
 440         //    propname =>
 441         //        type=>
 442         //        desc=>
 443         //    }
 444
 445         var ret = {
 446             props : props,
 447             events: events,
 448             methods : methods,
 449         };
 450         return ret;
 451
 452
 453
 454         // b) methods
 455         // c) events
 456
 457
 458     },
 459     srcFileRelName : function(sourceFile)
 460     {
 461       return sourceFile.substring(Options.baseDir.length+1);
 462     },
 463     srcFileFlatName: function(sourceFile)
 464     {
 465         var name = this.srcFileRelName(sourceFile);
 466         name = name.replace(/\.\.?[\\\/]/g, "").replace(/[\\\/]/g, "_");
 467         return name.replace(/\:/g, "_") + '.html'; //??;
 468
 469     },
 470
 471     makeSrcFile: function(sourceFile)
 472     {
 473         // this stuff works...
 474
 475
 476         var name = this.srcFileFlatName(sourceFile);
 477
 478         Options.LOG.inform("Write Source file : " + Options.target+"/symbols/src/" + name);
 479         var pretty = imports.PrettyPrint.toPretty(File.read(  sourceFile));
 480         File.write(Options.target+"/symbols/src/" + name,
 481             '<html><head>' +
 482             '<title>' + sourceFile + '</title>' +
 483             '<link rel="stylesheet" type="text/css" href="../../../css/highlight-js.css"/>' +
 484             '</head><body class="highlightpage">' +
 485             pretty +
 486             '</body></html>');
 487     },
 488     /**
 489      * used by JSON output to generate a function skeleton
 490      */
 491     makeFuncSkel :function(params) {
 492         if (!params) return "function ()\n{\n\n}";
 493         return "function ("     +
 494             params.filter(
 495                 function($) {
 496                     return $.name.indexOf(".") == -1; // don't show config params in signature
 497                 }
 498             ).map( function($) { return $.name == 'this' ? '_self' : $.name; } ).join(", ") +
 499         ")\n{\n\n}";
 500     },
 501         makeMethodSkel :function(params) {
 502         if (!params) return "()";
 503         return "("      +
 504             params.filter(
 505                 function($) {
 506                     return $.name.indexOf(".") == -1; // don't show config params in signature
 507                 }
 508             ).map( function($) { return  $.type + " "  +(  $.name == 'this' ? '_self' : $.name ); } ).join(", ") +
 509         ")";
 510     }
 511
 512
 513 };
 514
 515
 516
 517
 518
 519
 520
 521
 522
 523
 524