1 //<script type="text/javascript">
3 This is the main container for the JSDOC application.
8 XObject = imports.XObject.XObject;
9 File = imports.File.File;
11 Template = imports.JsTemplate.Template.Template;
12 Link = imports.JsTemplate.Link.Link; // ?? fixme!??
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;
21 /****************** INCLUDES ARE ALL AT THE BOTTOM OF THIS FILE!!!!! *******************/
23 // should not realy be here -- or anywhere...??
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();
37 Options = false; // refer to this everywhere!
48 build : function (opts)
53 Options.LOG.inform("JsDoc Toolkit main() running at "+new Date()+".");
54 //Options.LOG.inform("With options: ");
56 if (Options.cacheDirectory.length && !File.isDirectory(Options.cacheDirectory)) {
57 File.mkdir(Options.cacheDirectory)
60 Options.srcFiles = this._getSrcFiles();
61 this._parseSrcFiles();
62 this.symbolSet = Parser.symbols;
64 // this currently uses the concept of publish.js...
73 _getSrcFiles : function()
79 ext = Options.ext.split(",").map(function($) {return $.toLowerCase()});
82 for (var i = 0; i < Options.src.length; i++) {
83 // add to sourcefiles..
85 File.list(Options.src[i] ).forEach(function($) {
86 if (Options['exclude-src'].indexOf($) > -1) {
89 var thisExt = $.split(".").pop().toLowerCase();
90 if (ext.indexOf(thisExt) < 0) {
93 _this.srcFiles.push(Options.src[i] + '/' + $);
97 //Seed.print(JSON.stringify(this.srcFiles, null,4));Seed.quit();
101 _parseSrcFiles : function()
105 for (var i = 0, l = this.srcFiles.length; i < l; i++) {
107 var srcFile = this.srcFiles[i];
110 var cacheFile = Options.cacheDirectory + srcFile.replace(/\//g, '_') + ".cache";
112 //println(cacheFile);
113 // disabled at present!@!!
115 if (false && !Options.disablecache && File.exists(cacheFile)) {
118 var c_mt = File.getTimes(cacheFile);
119 var o_mt = File.getTimes(srcFile);
120 //println(c_mt.toSource());
121 // println(o_mt.toSource());
123 // this check does not appear to work according to the doc's - need to check it out.
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));
129 throw "Conversion of cache not done yet!";
131 for (var sy in syms) {
132 //println("ADD:" + sy );
133 Parser.symbols.addSymbol(syms[sy]);
141 Options.LOG.inform("reading : " + srcFile);
142 src = File.read(srcFile);
145 Options.LOG.warn("Can't read source file '"+srcFile+"': "+e.message);
149 var txs = new TextStream(src);
151 var tr = new TokenReader({ keepComments : true, keepWhite : true , sepIdents: false });
153 var ts = new TokenStream(tr.tokenize(txs));
155 Parser.parse(ts, srcFile);
157 //var outstr = JSON.stringify(
158 // Parser.filesSymbols[srcFile]._index
160 //File.write(cacheFile, outstr);
173 publish : function() {
174 Options.LOG.inform("Publishing");
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");
187 if (!File.isDirectory(Options.target +"/json")) {
188 File.mkdir(Options.target +"/json");
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);
199 Options.LOG.inform("Setting up templates");
200 // used to check the details of things being linked to
201 Link.symbolSet = this.symbolSet;
204 Link.symbolToSrcFileName = this.symbolToSrcFileName;
206 var classTemplate = new Template({
207 templateFile : Options.templateDir + "/class.html",
210 var classesTemplate = new Template({
211 templateFile : Options.templateDir +"/allclasses.html",
214 var classesindexTemplate = new Template({
215 templateFile : Options.templateDir +"/index.html",
218 var fileindexTemplate = new Template({
219 templateFile : Options.templateDir +"/allfiles.html",
224 classTemplate.symbolSet = this.symbolSet;
227 function hasNoParent($) {
228 return ($.memberOf == "")
230 function isaFile($) {
231 return ($.is("FILE"))
233 function isaClass($) {
234 return ($.is("CONSTRUCTOR") || $.isNamespace);
246 var symbols = this.symbolSet.toArray();
248 var files = Options.srcFiles;
250 for (var i = 0, l = files.length; i < l; i++) {
252 var targetDir = Options.target + "/symbols/src/";
253 this.makeSrcFile(file, targetDir);
256 var classes = symbols.filter(isaClass).sort(makeSortby("alias"));
258 //Options.LOG.inform("classTemplate Process : all classes");
260 // var classesIndex = classesTemplate.process(classes); // kept in memory
262 Options.LOG.inform("iterate classes");
264 for (var i = 0, l = classes.length; i < l; i++) {
265 var symbol = classes[i];
268 Options.LOG.inform("classTemplate Process : " + symbol.alias);
270 File.write(Options.target+"/symbols/" +symbol.alias+'.' + Options.publishExt ,
271 classTemplate.process(symbol));
277 this.publishJSON(Options.target+"/json/" + symbol.alias+'.json', symbol)
283 // regenrate the index with different relative links
285 //var classesIndex = classesTemplate.process(classes);
287 Options.LOG.inform("build index");
289 File.write(Options.target + "/index."+ Options.publishExt,
290 classesindexTemplate.process(classes)
293 // blank everything???? classesindexTemplate = classesIndex = classes = null;
297 var documentedFiles = symbols.filter(function ($) {
298 return ($.is("FILE"))
303 for (var i = 0; i < files.length; i++) {
304 allFiles.push(new Symbol(files[i], [], "FILE", new DocComment("/** */")));
307 for (var i = 0; i < documentedFiles.length; i++) {
308 var offset = files.indexOf(documentedFiles[i].alias);
309 allFiles[offset] = documentedFiles[i];
312 allFiles = allFiles.sort(makeSortby("name"));
313 Options.LOG.inform("write files index");
315 File.write(Options.target + "/files."+Options.publishExt,
316 fileindexTemplate.process(allFiles)
321 * JSON files are lookup files for the documentation
322 * - can be used by IDE's or AJAX based doc tools
326 publishJSON : function(file, data)
328 // what we need to output to be usefull...
330 var cfgProperties = [];
331 if (!data.comment.getTag('singleton').length) {
332 cfgProperties = data.configToArray();
333 cfgProperties = cfgProperties.sort(makeSortby("name"));
337 //println(cfgProperties.toSource());
339 for(var i =0; i < cfgProperties.length;i++) {
340 p = cfgProperties[i];
345 memberOf : p.memberOf == data.alias ? '' : p.memberOf
350 var ownEvents = data.methods.filter( function(e){
351 return e.isEvent && !e.comment.getTag('hide').length;
352 }).sort(makeSortby("name"));
357 for(var i =0; i < ownEvents.length;i++) {
360 name : m.name.substring(1),
361 sig : this.makeFuncSkel(m.params),
366 //println(props.toSource());
367 // we need to output:
378 File.write(file, JSON.stringify(ret, null, 2 ));
387 symbolToSrcFileName : function(sourceFile)
389 var name = sourceFile.substring(Options.baseDir.length+1);
390 name = name.replace(/\.\.?[\\\/]/g, "").replace(/[\\\/]/g, "_");
392 name = name.replace(/\:/g, "_"); //??
395 makeSrcFile: function(sourceFile)
397 // this stuff works...
398 var name = this.symbolToSrcFileName(sourceFile);
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,
405 '<title>' + sourceFile + '</title>' +
406 '<link rel="stylesheet" type="text/css" href="../../../highlight-js.css"/>' +
407 '</head><body class="highlightpage">' +
412 * used by JSON output to generate a function skeleton
414 makeFuncSkel :function(params) {
415 if (!params) return "function ()\n{\n\n}";
416 return "function (" +
419 return $.name.indexOf(".") == -1; // don't show config params in signature
421 ).map( function($) { return $.name == 'this' ? '_self' : $.name; } ).join(", ") +