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
   7
   8 XObject = imports.XObject.XObject;
   9 File = imports.File.File;
  10
  11 Options = imports.Options.Options;
  12 Parser   = imports.Parser.Parser;
  13
  14 TokenReader = imports.TokenReader.TokenReader;
  15 TokenStream = imports.TokenStream.TokenStream;
  16 Symbol = imports.Symbol.Symbol;
  17 /******************    INCLUDES ARE ALL AT THE BOTTOM OF THIS FILE!!!!! *******************/
  18
  19 // should not realy be here -- or anywhere...??
  20
  21
  22
  23
  24
  25 BuildDocs = {
  26
  27     VERSION : "2.0.0",
  28
  29
  30     srcFiles : [],
  31
  32     build : function (opts)
  33     {
  34
  35         XObject.extend(Options, opts);
  36
  37         Options.init();
  38
  39
  40
  41
  42         Options.LOG.inform("JsDoc Toolkit main() running at "+new Date()+".");
  43         Options.LOG.inform("With options: ");
  44
  45         if (!File.isDirectory(Options.cacheDirectory)) {
  46             File.mkdir(Options.cacheDirectory)
  47         }
  48
  49         Options.srcFiles = this._getSrcFiles();
  50         this._parseSrcFiles();
  51         this.symbolSet = Parser.symbols;
  52
  53         // this currently uses the concept of publish.js...
  54
  55         this.publish();
  56
  57
  58
  59     },
  60
  61
  62     _getSrcFiles : function()
  63     {
  64         this.srcFiles = [];
  65
  66         var ext = ["js"];
  67         if (Options.ext) {
  68             ext = Options.ext.split(",").map(function($) {return $.toLowerCase()});
  69         }
  70
  71         for (var i = 0; i < Options.src.length; i++) {
  72             this.srcFiles = this.srcFiles.concat(
  73
  74                 File.list(Options.src[i] ).filter(
  75                     function($) {
  76                         var thisExt = $.split(".").pop().toLowerCase();
  77                         return (ext.indexOf(thisExt) > -1); // || thisExt in JSDOC.handlers);
  78                             // we're only interested in files with certain extensions
  79                     }
  80                 )
  81             );
  82         }
  83
  84         return this.srcFiles;
  85     },
  86
  87     _parseSrcFiles : function()
  88     {
  89         Parser.init();
  90
  91         for (var i = 0, l = this.srcFiles.length; i < l; i++) {
  92
  93             var srcFile = this.srcFiles[i];
  94
  95
  96             var cacheFile = Options.cacheDirectory + srcFile.replace(/\//g, '_') + ".cache";
  97
  98             //println(cacheFile);
  99             // disabled at present!@!!
 100
 101             if (false && !Options.disablecache  && File.exists(cacheFile)) {
 102                 // check filetime?
 103
 104                 var c_mt = File.getTimes(cacheFile);
 105                 var o_mt = File.getTimes(srcFile);
 106                 //println(c_mt.toSource());
 107                // println(o_mt.toSource());
 108
 109                 // this check does not appear to work according to the doc's - need to check it out.
 110
 111                 if (c_mt[0] > o_mt[0]) { // cached time  > original time!
 112                     // use the cached mtimes..
 113                     var syms =  JSON.parse(File.read(cacheFile));
 114
 115                     throw "Conversion of cache not done yet!";
 116
 117                     for (var sy in syms) {
 118                         //println("ADD:" + sy );
 119                        Parser.symbols.addSymbol(syms[sy]);
 120                     }
 121                     continue;
 122                 }
 123             }
 124
 125             var src = ''
 126             try {
 127                 src = File.read(srcFile);
 128             }
 129             catch(e) {
 130                 LOG.warn("Can't read source file '"+srcFile+"': "+e.message);
 131                 continue;
 132             }
 133
 134
 135             var tr = new TokenReader();
 136             var ts = new TokenStream(tr.tokenize(src));
 137
 138             Parser.parse(ts, srcFile);
 139
 140             //var outstr = JSON.stringify(
 141             //    Parser.filesSymbols[srcFile]._index
 142             //);
 143             //File.write(cacheFile, outstr);
 144
 145
 146     //          }
 147         }
 148
 149
 150
 151         Parser.finish();
 152     }
 153
 154
 155
 156     publish  : function() {
 157
 158
 159
 160         publish.conf = {  // trailing slash expected for dirs
 161             ext: ".html",
 162
 163             templatesDir: JSDOC.opt.t + "/",
 164             symbolsDir: "symbols/",
 165             srcDir: "symbols/src/"
 166         };
 167
 168         publish.conf.outDir = (JSDOC.opt.d.length > 0 ? JSDOC.opt.d : "/tmp/jsdoc/");
 169
 170
 171
 172
 173         if (JSDOC.opt.s && defined(Link) && Link.prototype._makeSrcLink) {
 174             Link.prototype._makeSrcLink = function(srcFilePath) {
 175                 return "&lt;"+srcFilePath+"&gt;";
 176             }
 177         }
 178
 179         println(publish.conf.outDir);
 180
 181         if (!File.exists(publish.conf.outDir))
 182             File.mkdir(publish.conf.outDir);
 183         if (!File.exists(publish.conf.outDir+"symbols"))
 184             File.mkdir(publish.conf.outDir+"symbols");
 185         if (!File.exists(publish.conf.outDir+"symbols/src"))
 186             File.mkdir(publish.conf.outDir+"symbols/src");
 187
 188         IO.copyFile (publish.conf.templatesDir+"static/default.css", publish.conf.outDir, "default.css");
 189         IO.copyFile (publish.conf.templatesDir+"static/doc.js", publish.conf.outDir, "doc.js");
 190         IO.copyFile (publish.conf.templatesDir+"static/page.js", publish.conf.outDir, "page.js");
 191
 192
 193         //IO.mkPath((publish.conf.outDir+"symbols/src").split("/"));
 194
 195         // used to check the details of things being linked to
 196         Link.symbolSet = symbolSet;
 197
 198         //try {
 199             var classTemplate = new JSDOC.JsPlate(publish.conf.templatesDir+"class.tmpl");
 200             var classesTemplate = new JSDOC.JsPlate(publish.conf.templatesDir+"allclasses.tmpl");
 201         //}
 202         //atch(e) {
 203         //      print(e.message);
 204         ///     quit();
 205         //}
 206
 207         // filters
 208
 209         classTemplate.symbolSet = symbolSet;
 210
 211
 212         function hasNoParent($) {return ($.memberOf == "")}
 213         function isaFile($) {return ($.is("FILE"))}
 214         function isaClass($) { return ($.is("CONSTRUCTOR") || $.isNamespace); }
 215
 216         var symbols = symbolSet.toArray();
 217
 218         var files = JSDOC.opt.srcFiles;
 219         for (var i = 0, l = files.length; i < l; i++) {
 220             var file = files[i];
 221             var srcDir = publish.conf.outDir + "symbols/src/";
 222             makeSrcFile(file, srcDir);
 223         }
 224
 225         var classes = symbols.filter(isaClass).sort(makeSortby("alias"));
 226
 227         Link.base = "../";
 228         publish.classesIndex = classesTemplate.process(classes); // kept in memory
 229
 230         IO.makeDir(publish.conf.outDir+"json");
 231
 232         for (var i = 0, l = classes.length; i < l; i++) {
 233             var symbol = classes[i];
 234             var output = "";
 235
 236             output = classTemplate.process(symbol);
 237             println("write " + publish.conf.outDir+"symbols/" +symbol.alias+publish.conf.ext);
 238             IO.saveFile(publish.conf.outDir+"symbols/", symbol.alias+publish.conf.ext, output);
 239             // dump out a
 240             IO.saveFile(publish.conf.outDir+"json/",  symbol.alias+'.json' , publish.jsonRender(symbol));
 241
 242
 243         }
 244
 245         // regenrate the index with different relative links
 246         Link.base = "";
 247         publish.classesIndex = classesTemplate.process(classes);
 248
 249         try {
 250             var classesindexTemplate = new JSDOC.JsPlate(publish.conf.templatesDir+"index.tmpl");
 251         }
 252         catch(e) { print(e.message); quit(); }
 253
 254         var classesIndex = classesindexTemplate.process(classes);
 255         IO.saveFile(publish.conf.outDir, "index"+publish.conf.ext, classesIndex);
 256         classesindexTemplate = classesIndex = classes = null;
 257
 258         try {
 259             var fileindexTemplate = new JSDOC.JsPlate(publish.conf.templatesDir+"allfiles.tmpl");
 260         }
 261         catch(e) { print(e.message); quit(); }
 262
 263         var documentedFiles = symbols.filter(isaFile);
 264         var allFiles = [];
 265
 266         for (var i = 0; i < files.length; i++) {
 267             allFiles.push(new JSDOC.Symbol(files[i], [], "FILE", new JSDOC.DocComment("/** */")));
 268         }
 269
 270         for (var i = 0; i < documentedFiles.length; i++) {
 271             var offset = files.indexOf(documentedFiles[i].alias);
 272             allFiles[offset] = documentedFiles[i];
 273         }
 274
 275         allFiles = allFiles.sort(makeSortby("name"));
 276
 277         var filesIndex = fileindexTemplate.process(allFiles);
 278         IO.saveFile(publish.conf.outDir, "files"+publish.conf.ext, filesIndex);
 279         fileindexTemplate = filesIndex = files = null;
 280     }
 281
 282
 283
 284
 285 };
 286
 287
 288
 289
 290
 291
 292
 293
 294
 295
 296