X-Git-Url: http://git.roojs.org/?a=blobdiff_plain;f=JSDOC%2FBuildDocs.js;h=85f33ac36abca939f4d2cd70bcf72f75114473f0;hb=7d79987b2c0f1b02a8823dcc95764d787e4c91e4;hp=b3f5e1f5794b826c4640d6a803bc53c411210e3b;hpb=2c7fba165ba30fc95c860b9e5ab3b6914df2969e;p=gnome.introspection-doc-generator diff --git a/JSDOC/BuildDocs.js b/JSDOC/BuildDocs.js index b3f5e1f..85f33ac 100644 --- a/JSDOC/BuildDocs.js +++ b/JSDOC/BuildDocs.js @@ -3,16 +3,16 @@ 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; - +TextStream = imports.TextStream.TextStream; TokenReader = imports.TokenReader.TokenReader; TokenStream = imports.TokenStream.TokenStream; Symbol = imports.Symbol.Symbol; @@ -21,7 +21,7 @@ Symbol = imports.Symbol.Symbol; // should not realy be here -- or anywhere...?? - +Options = false; // refer to this everywhere! BuildDocs = { @@ -31,20 +31,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 +49,7 @@ BuildDocs = { this.symbolSet = Parser.symbols; // this currently uses the concept of publish.js... - + this.publish(); @@ -64,25 +60,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 +125,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 }); + + var ts = new TokenStream(tr.tokenize(txs)); Parser.parse(ts, srcFile); @@ -151,51 +153,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.tmpl", Link : Link }); var classesTemplate = new Template({ - templateFile : Options.templatesDir +"/allclasses.tmpl", + templateFile : Options.templateDir +"/allclasses.tmpl", Link : Link }); var classesindexTemplate = new Template({ - templateFile : Options.templatesDir +"/index.tmpl", + templateFile : Options.templateDir +"/index.tmpl", Link : Link }); + var fileindexTemplate = new Template({ + templateFile : Options.templateDir +"/allfiles.tmpl", + Link: Link + }); + - - classTemplate.symbolSet = symbolSet; + classTemplate.symbolSet = this.symbolSet; function hasNoParent($) { @@ -208,21 +219,19 @@ 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")); - - Link.base = "../"; - - publish.classesIndex = classesTemplate.process(classes); // kept in memory + + var classesIndex = classesTemplate.process(classes); // kept in memory @@ -245,27 +254,26 @@ BuildDocs = { // regenrate the index with different relative links Link.base = ""; - publish.classesIndex = classesTemplate.process(classes); + var classesIndex = classesTemplate.process(classes); - try { - var classesindexTemplate = new JSDOC.JsPlate(Options.templatesDir+"index.tmpl"); - } - catch(e) { print(e.message); quit(); } + - var classesIndex = classesindexTemplate.process(classes); - IO.saveFile(publish.conf.outDir, "index"+publish.conf.ext, classesIndex); - classesindexTemplate = classesIndex = classes = null; + File.write(Options.target + "/index."+ Options.publishExt, + classesindexTemplate.process(classes) + ); - try { - var fileindexTemplate = new JSDOC.JsPlate(publish.conf.templatesDir+"allfiles.tmpl"); - } - catch(e) { print(e.message); quit(); } + // blank everything???? classesindexTemplate = classesIndex = classes = null; + + + + var documentedFiles = symbols.filter(function ($) { + return ($.is("FILE")) + }); - var documentedFiles = symbols.filter(isaFile); var allFiles = []; for (var i = 0; i < files.length; i++) { - allFiles.push(new JSDOC.Symbol(files[i], [], "FILE", new JSDOC.DocComment("/** */"))); + allFiles.push(new Symbol(files[i], [], "FILE", new JSDOC.DocComment("/** */"))); } for (var i = 0; i < documentedFiles.length; i++) { @@ -274,13 +282,13 @@ BuildDocs = { } allFiles = allFiles.sort(makeSortby("name")); + File.write(Options.target , "/files."+Options.publishExt, + fileindexTemplate.process(allFiles) + ); + + }, - var filesIndex = fileindexTemplate.process(allFiles); - IO.saveFile(publish.conf.outDir, "files"+publish.conf.ext, filesIndex); - fileindexTemplate = filesIndex = files = null; - } - - publishJSON = function(file, data) + publishJSON : function(file, data) { // what we need to output to be usefull... // a) props.. @@ -340,27 +348,24 @@ BuildDocs = { }, - makeSrcFile: function(path, srcDir, name) { - if (Options.outputSource) return; + makeSrcFile: function(sourceFile) + { - 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 :" + sourceFile); + var pretty = imports.PrettyPrint.toPretty(File.read(sourceFile)); + File.write(Options.target+"/symbols/src/" + name, + '' + + '' + sourceFile + '' + + '' + + '' + + pretty + + ''); }