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