X-Git-Url: http://git.roojs.org/?p=gnome.introspection-doc-generator;a=blobdiff_plain;f=JSDOC%2FBuildDocs.js;h=e06e0a1deac3a759acca2b40c1994e51ad1da389;hp=5697d00dabf16117c03f62fef53be528f5cc82a5;hb=d3e6639d674718bdd2290055c4a61616bdcb7a4f;hpb=d7d5498028ae0562e58125024445002e79965293 diff --git a/JSDOC/BuildDocs.js b/JSDOC/BuildDocs.js index 5697d00..e06e0a1 100644 --- a/JSDOC/BuildDocs.js +++ b/JSDOC/BuildDocs.js @@ -3,25 +3,38 @@ This is the main container for the JSDOC application. @namespace */ - +Gio = imports.gi.Gio; XObject = imports.XObject.XObject; File = imports.File.File; Template = imports.JsTemplate.Template.Template; +Link = imports.JsTemplate.Link.Link; // ?? fixme!?? -Options = imports.Options.Options; -Parser = imports.Parser.Parser; - +Parser = imports.Parser.Parser; +TextStream = imports.TextStream.TextStream; TokenReader = imports.TokenReader.TokenReader; TokenStream = imports.TokenStream.TokenStream; -Symbol = imports.Symbol.Symbol; +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) { + return function(a, b) { + if (a[attribute] != undefined && b[attribute] != undefined) { + a = a[attribute]; //.toLowerCase(); + b = b[attribute];//.toLowerCase(); + if (a < b) return -1; + if (a > b) return 1; + return 0; + } + } +} - +Options = false; // refer to this everywhere! BuildDocs = { @@ -31,20 +44,16 @@ BuildDocs = { srcFiles : [], + build : function (opts) { - - XObject.extend(Options, opts); - + Options = opts; Options.init(); - - - Options.LOG.inform("JsDoc Toolkit main() running at "+new Date()+"."); - Options.LOG.inform("With options: "); + //Options.LOG.inform("With options: "); - if (!File.isDirectory(Options.cacheDirectory)) { + if (Options.cacheDirectory.length && !File.isDirectory(Options.cacheDirectory)) { File.mkdir(Options.cacheDirectory) } @@ -53,7 +62,7 @@ BuildDocs = { this.symbolSet = Parser.symbols; // this currently uses the concept of publish.js... - + this.publish(); @@ -64,25 +73,28 @@ BuildDocs = { _getSrcFiles : function() { this.srcFiles = []; - + var _this = this; var ext = ["js"]; if (Options.ext) { ext = Options.ext.split(",").map(function($) {return $.toLowerCase()}); } for (var i = 0; i < Options.src.length; i++) { - this.srcFiles = this.srcFiles.concat( + // add to sourcefiles.. - File.list(Options.src[i] ).filter( - function($) { - var thisExt = $.split(".").pop().toLowerCase(); - return (ext.indexOf(thisExt) > -1); // || thisExt in JSDOC.handlers); - // we're only interested in files with certain extensions - } - ) - ); + File.list(Options.src[i] ).forEach(function($) { + if (Options['exclude-src'].indexOf($) > -1) { + return; + } + var thisExt = $.split(".").pop().toLowerCase(); + if (ext.indexOf(thisExt) < 0) { + return; + } + _this.srcFiles.push(Options.src[i] + '/' + $); + }); + } - + //Seed.print(JSON.stringify(this.srcFiles, null,4));Seed.quit(); return this.srcFiles; }, @@ -126,16 +138,19 @@ BuildDocs = { var src = '' try { + Options.LOG.inform("reading : " + srcFile); src = File.read(srcFile); } catch(e) { - LOG.warn("Can't read source file '"+srcFile+"': "+e.message); + Options.LOG.warn("Can't read source file '"+srcFile+"': "+e.message); continue; } - - var tr = new TokenReader(); - var ts = new TokenStream(tr.tokenize(src)); + var txs = new TextStream(src); + + var tr = new TokenReader({ keepComments : true, keepWhite : true , sepIdents: false }); + + var ts = new TokenStream(tr.tokenize(txs)); Parser.parse(ts, srcFile); @@ -151,55 +166,60 @@ BuildDocs = { Parser.finish(); - } + }, publish : function() { - + Options.LOG.inform("Publishing"); // link!!! - - if (!File.exists(Options.target)) + Options.LOG.inform("Making directories"); + if (!File.isDirectory(Options.target)) File.mkdir(Options.target); - if (!File.exists(Options.target+"/symbols")) + if (!File.isDirectory(Options.target+"/symbols")) File.mkdir(Options.target+"/symbols"); - if (!File.exists(Options.target+"/symbols/src")) + if (!File.isDirectory(Options.target+"/symbols/src")) File.mkdir(Options.target+"/symbols/src"); - // copy everything in 'static' into - File.list(Options.templatesDir + '/static').forEach(function (f) { - File.copy(Options.templatesDir + '/static/' + f, Options.target + '/' + f); - }); if (!File.isDirectory(Options.target +"/json")) { - File.makeDir(Options.target +"/json"); + File.mkdir(Options.target +"/json"); } + Options.LOG.inform("Copying files from static: " +Options.templateDir); + // copy everything in 'static' into + File.list(Options.templateDir + '/static').forEach(function (f) { + Options.LOG.inform("Copy " + Options.templateDir + '/static/' + f + ' to ' + Options.target + '/' + f); + File.copyFile(Options.templateDir + '/static/' + f, Options.target + '/' + f, Gio.FileCopyFlags.OVERWRITE); + }); + + + Options.LOG.inform("Setting up templates"); // used to check the details of things being linked to - Link.symbolSet = symbolSet; + Link.symbolSet = this.symbolSet; Link.base = "../"; var classTemplate = new Template({ - templateFile : Options.templatesDir + "/class.tmpl", + templateFile : Options.templateDir + "/class.html", Link : Link }); var classesTemplate = new Template({ - templateFile : Options.templatesDir +"/allclasses.tmpl", + templateFile : Options.templateDir +"/allclasses.html", Link : Link }); var classesindexTemplate = new Template({ - templateFile : Options.templatesDir +"/index.tmpl", + templateFile : Options.templateDir +"/index.html", Link : Link }); var fileindexTemplate = new Template({ - templateFile : Options.templatesDir +"/allfiles.tmpl", + templateFile : Options.templateDir +"/allfiles.html", Link: Link }); - classTemplate.symbolSet = symbolSet; + classTemplate.symbolSet = this.symbolSet; function hasNoParent($) { @@ -212,34 +232,47 @@ BuildDocs = { return ($.is("CONSTRUCTOR") || $.isNamespace); } - var symbols = symbolSet.toArray(); + + + + + + + + + + var symbols = this.symbolSet.toArray(); var files = Options.srcFiles; for (var i = 0, l = files.length; i < l; i++) { var file = files[i]; - var srcDir = Options.target + "/symbols/src/"; - this.makeSrcFile(file, srcDir); + var targetDir = Options.target + "/symbols/src/"; + this.makeSrcFile(file, targetDir); } var classes = symbols.filter(isaClass).sort(makeSortby("alias")); - publish.classesIndex = classesTemplate.process(classes); // kept in memory - + //Options.LOG.inform("classTemplate Process : all classes"); + + // var classesIndex = classesTemplate.process(classes); // kept in memory + Options.LOG.inform("iterate classes"); for (var i = 0, l = classes.length; i < l; i++) { var symbol = classes[i]; var output = ""; + Options.LOG.inform("classTemplate Process : " + symbol.alias); + File.write(Options.target+"/symbols/" +symbol.alias+'.' + Options.publishExt , classTemplate.process(symbol)); - print("write " + Options.target+"/symbols/" +symbol.alias+'.' + Options.publishExt); + // dump out a - this.publishJSON(Options.target+"/json/", symbol.alias+'.json', symbol) + this.publishJSON(Options.target+"/json/" + symbol.alias+'.json', symbol) @@ -247,9 +280,9 @@ BuildDocs = { // regenrate the index with different relative links Link.base = ""; - publish.classesIndex = classesTemplate.process(classes); + //var classesIndex = classesTemplate.process(classes); - + Options.LOG.inform("build index"); File.write(Options.target + "/index."+ Options.publishExt, classesindexTemplate.process(classes) @@ -266,7 +299,7 @@ BuildDocs = { var allFiles = []; for (var i = 0; i < files.length; i++) { - allFiles.push(new Symbol(files[i], [], "FILE", new JSDOC.DocComment("/** */"))); + allFiles.push(new Symbol(files[i], [], "FILE", new DocComment("/** */"))); } for (var i = 0; i < documentedFiles.length; i++) { @@ -275,13 +308,20 @@ BuildDocs = { } allFiles = allFiles.sort(makeSortby("name")); - - var filesIndex = fileindexTemplate.process(allFiles); - IO.saveFile(publish.conf.outDir, "files"+publish.conf.ext, filesIndex); - fileindexTemplate = filesIndex = files = null; - } - - publishJSON = function(file, data) + Options.LOG.inform("write files index"); + + File.write(Options.target + "/files."+Options.publishExt, + fileindexTemplate.process(allFiles) + ); + + }, + /** + * JSON files are lookup files for the documentation + * - can be used by IDE's or AJAX based doc tools + * + * + */ + publishJSON : function(file, data) { // what we need to output to be usefull... // a) props.. @@ -316,7 +356,7 @@ BuildDocs = { m = ownEvents[i]; events.push( { name : m.name.substring(1), - sig : makeFuncSkel(m.params), + sig : this.makeFuncSkel(m.params), type : 'function', desc : m.desc }); @@ -341,29 +381,42 @@ BuildDocs = { }, - makeSrcFile: function(path, srcDir, name) { - if (Options.outputSource) return; + makeSrcFile: function(sourceFile) + { + // this stuff works... + return; - return; // not done? - if (!name) { - name = path.replace(/\.\.?[\\\/]/g, "").replace(/[\\\/]/g, "_"); - name = name.replace(/\:/g, "_"); - } + name = sourceFile.substring(Options.baseDir.length+1); + name = name.replace(/\.\.?[\\\/]/g, "").replace(/[\\\/]/g, "_"); - var src = { - path: path, - name:name, - charset: IO.encoding, - hilited: "" - }; + name = name.replace(/\:/g, "_"); //?? - - if (src.hilited) { - IO.saveFile(srcDir, name+publish.conf.ext, src.hilited); - } + Options.LOG.inform("Write Source file : " + Options.target+"/symbols/src/" + name); + var pretty = imports.PrettyPrint.toPretty(File.read(sourceFile)); + File.write(Options.target+"/symbols/src/" + name, + '' + + '' + sourceFile + '' + + '' + + '' + + pretty + + ''); + }, + /** + * used by JSON output to generate a function skeleton + */ + makeFuncSkel :function(params) { + if (!params) return "function ()\n{\n\n}"; + return "function (" + + params.filter( + function($) { + return $.name.indexOf(".") == -1; // don't show config params in signature + } + ).map( function($) { return $.name == 'this' ? '_self' : $.name; } ).join(", ") + + ")\n{\n\n}"; } - + + };