X-Git-Url: http://git.roojs.org/?a=blobdiff_plain;f=JSDOC%2FBuildDocs.js;h=59d571d2910917af98df87056257833221940736;hb=7e20bee87f8a9611dedd3b3707ba21a50e8ebfd5;hp=dda68aaf6e468a16c09cd93f0dd20ae1992e1571;hpb=e72b72e5c60e4a0fdbea786265abfa9c59de066d;p=gnome.introspection-doc-generator diff --git a/JSDOC/BuildDocs.js b/JSDOC/BuildDocs.js index dda68aa..59d571d 100644 --- a/JSDOC/BuildDocs.js +++ b/JSDOC/BuildDocs.js @@ -10,9 +10,9 @@ File = imports.File.File; Template = imports.JsTemplate.Template.Template; -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; @@ -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,35 +153,40 @@ 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"); + if (!File.isDirectory(Options.target +"/json")) { + File.mkdir(Options.target +"/json"); + } + + Options.LOG.inform("Copying files from static: " +Options.templatesDir); // copy everything in 'static' into File.list(Options.templatesDir + '/static').forEach(function (f) { + Options.LOG.inform("Copy " + Options.templatesDir + '/static/' + f + ' to ' + Options.target + '/' + f); File.copy(Options.templatesDir + '/static/' + f, Options.target + '/' + f); }); - if (!File.isDirectory(Options.target +"/json")) { - File.makeDir(Options.target +"/json"); - } + + Options.LOG.inform("Setting up templates"); // used to check the details of things being linked to Link.symbolSet = symbolSet; - + Link.base = "../"; var classTemplate = new Template({ templateFile : Options.templatesDir + "/class.tmpl", @@ -218,15 +225,13 @@ BuildDocs = { 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 @@ -249,23 +254,26 @@ BuildDocs = { // regenrate the index with different relative links Link.base = ""; - publish.classesIndex = classesTemplate.process(classes); + var classesIndex = classesTemplate.process(classes); - var classesIndex = classesindexTemplate.process(classes); - IO.saveFile(publish.conf.outDir, "index"+publish.conf.ext, classesIndex); - classesindexTemplate = classesIndex = classes = null; - try { - var fileindexTemplate = new JSDOC.JsPlate(publish.conf.templatesDir+"allfiles.tmpl"); - } - catch(e) { print(e.message); quit(); } + File.write(Options.target + "/index."+ Options.publishExt, + classesindexTemplate.process(classes) + ); + + // 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,23 @@ 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); + name = name.replace(/\.\.?[\\\/]/g, "").replace(/[\\\/]/g, "_"); + name = name.replace(/\:/g, "_"); //?? - var src = { - path: path, - name:name, - charset: IO.encoding, - hilited: "" - }; - - if (src.hilited) { - IO.saveFile(srcDir, name+publish.conf.ext, src.hilited); - } + var pretty = imports.PrettyPrint.toPretty(File.read(sourceFile)); + File.write(Options.target+"/symbols/src/" + name, + '' + + '' + sourceFile + '' + + '' + + '' + + pretty + + ''); }