7 class DocBuilder : Object
10 // extractable via JSON?
11 public string VERSION = "1.0.0" { get set };
14 private Packer packer;
16 public DocBuilder (Packer p)
20 GLib.debug("Roo JsDoc Toolkit started at %s ", (new GLib.DateTime()).format("Y/m/d H:i:s"));
24 if (PackerRun.opt_tmp_dir != null && !FileUtils.test(PackerRun.opt_tmp_dir, GLib.FileTest.IS_DIR)) {
25 Posix.mkdir(PackerRun.opt_tmp_dir, 0700);
31 this.symbolSet = DocParser.symbols;
33 // this currently uses the concept of publish.js...
41 * Parse the source files.
45 private void parseSrcFiles()
50 var useCache = PackerRun.opt_cache_dir == null ;
53 for (var i = 0, l = this.packer.files.size; i < l; i++) {
55 var srcFile = this.packer.files.get(i);
59 cacheFile = PackerRun.opt_cache_dir + srcFile.replace(/\//g, '_') + ".cache";
62 // disabled at present!@!!
64 if (GLib.FileUtils.test(cacheFile, GLib.FileTest.EXISTS)) {
66 var cache_mt = File.new_for_path (cacheFile).queryInfo(FileAttribute.TIME_MODIFIED,
67 GLib.FileQueryInfoFlags.NONE, null).
68 get_modification_time();
69 var original_mt = File.new_for_path (sourceInfo).queryInfo(FileAttribute.TIME_MODIFIED,
70 GLib.FileQueryInfoFlags.NONE, null).
71 get_modification_time();
72 // this check does not appear to work according to the doc's - need to check it out.
74 if (cache_mt > original_mt) { // cached time > original time!
75 // use the cached mtimes..
76 GLib.debug("Read %s" , cacheFile);
77 var parser = new Json.Parser();
78 parser.load_from_file(cacheFile);
79 var ar = parser.get_root ().get_array();
81 for(var i = 0;i < ar.get_length();i++) {
82 var o = ar.get_object_element(i);
83 var sym = Json.gobject_from_data(typeof(Symbol), o) as Symbol;
84 DocParser.symbols.add(sym);
93 GLib.debug("reading : %s" , srcFile);
94 src = GLib.FileUtils.get_contents(srcFile);
96 catch(GLib.FileError e) {
97 GLib.debug("Can't read source file '%s': %s", srcFile, e.to_string());
103 var tr = new TokenReader(this.packer);
106 tr.keepComments = true;
107 tr.sepIdents = false;
108 tr.collapseWhite = false;
112 var toks = tr.tokenize( new TextStream(src);
113 if (PackerRun.opt_dump_tokens) {
116 //GLib.Process.exit(0);
120 var ts = new TokenStream(toks);
125 DocParser.parse(ts, srcFile);
129 var ar = DocParser.symbolsToObject(srcFile);
131 var builder = new Json.Builder ();
132 builder.begin_array ();
133 for (var i=0;i<ar.size;i++) {
135 builder.add_object_value (ar.get(i));
137 builder.end_array ();
138 Json.Generator generator = new Json.Generator ();
139 Json.Node root = builder.get_root ();
140 generator.set_root (root);
141 generator.pretty= true;
143 generator.to_file(cacheFile);
157 publish : function() {
158 GLib.debug("Publishing");
163 GLib.debug("Making directories");
164 if (!File.isDirectory(Options.target))
165 File.mkdir(Options.target);
166 if (!File.isDirectory(Options.target+"/symbols"))
167 File.mkdir(Options.target+"/symbols");
168 if (!File.isDirectory(Options.target+"/symbols/src"))
169 File.mkdir(Options.target+"/symbols/src");
171 if (!File.isDirectory(Options.target +"/json")) {
172 File.mkdir(Options.target +"/json");
175 GLib.debug("Copying files from static: %s " , Options.templateDir);
176 // copy everything in 'static' into
177 File.list(Options.templateDir + '/static').forEach(function (f) {
178 GLib.debug("Copy %s/static/%s to %s/%s" , Options.templateDir , f, Options.target + '/' + f);
179 File.copyFile(Options.templateDir + '/static/' + f, Options.target + '/' + f, Gio.FileCopyFlags.OVERWRITE);
183 GLib.debug("Setting up templates");
184 // used to check the details of things being linked to
185 Link.symbolSet = this.symbolSet;
188 Link.srcFileFlatName = this.srcFileFlatName;
189 Link.srcFileRelName = this.srcFileRelName;
191 var classTemplate = new Template({
192 templateFile : Options.templateDir + "/class.html",
195 var classesTemplate = new Template({
196 templateFile : Options.templateDir +"/allclasses.html",
199 var classesindexTemplate = new Template({
200 templateFile : Options.templateDir +"/index.html",
203 var fileindexTemplate = new Template({
204 templateFile : Options.templateDir +"/allfiles.html",
209 classTemplate.symbolSet = this.symbolSet;
212 function hasNoParent($) {
213 return ($.memberOf == "")
215 function isaFile($) {
216 return ($.is("FILE"))
218 function isaClass($) {
219 return ($.is("CONSTRUCTOR") || $.isNamespace || $.isClass);
231 var symbols = this.symbolSet.toArray();
233 var files = Options.srcFiles;
235 for (var i = 0, l = files.length; i < l; i++) {
237 var targetDir = Options.target + "/symbols/src/";
238 this.makeSrcFile(file, targetDir);
240 //print(JSON.stringify(symbols,null,4));
242 var classes = symbols.filter(isaClass).sort(makeSortby("alias"));
244 //GLib.debug("classTemplate Process : all classes");
246 // var classesIndex = classesTemplate.process(classes); // kept in memory
248 GLib.debug("iterate classes");
252 for (var i = 0, l = classes.length; i < l; i++) {
253 var symbol = classes[i];
256 GLib.debug("classTemplate Process : " + symbol.alias);
261 File.write(Options.target+"/symbols/" +symbol.alias+'.' + Options.publishExt ,
262 classTemplate.process(symbol));
264 jsonAll[symbol.alias] = this.publishJSON(symbol);
270 File.write(Options.target+"/json/roodata.json",
278 // regenrate the index with different relative links
280 //var classesIndex = classesTemplate.process(classes);
282 GLib.debug("build index");
284 File.write(Options.target + "/index."+ Options.publishExt,
285 classesindexTemplate.process(classes)
288 // blank everything???? classesindexTemplate = classesIndex = classes = null;
292 var documentedFiles = symbols.filter(function ($) {
293 return ($.is("FILE"))
298 for (var i = 0; i < files.length; i++) {
299 allFiles.push(new Symbol(files[i], [], "FILE", new DocComment("/** */")));
302 for (var i = 0; i < documentedFiles.length; i++) {
303 var offset = files.indexOf(documentedFiles[i].alias);
304 allFiles[offset] = documentedFiles[i];
307 allFiles = allFiles.sort(makeSortby("name"));
308 GLib.debug("write files index");
310 File.write(Options.target + "/files."+Options.publishExt,
311 fileindexTemplate.process(allFiles)
319 * JSON files are lookup files for the documentation
320 * - can be used by IDE's or AJAX based doc tools
324 publishJSON : function(data)
326 // what we need to output to be usefull...
328 var cfgProperties = [];
329 if (!data.comment.getTag('singleton').length) {
330 cfgProperties = data.configToArray();
331 cfgProperties = cfgProperties.sort(makeSortby("alias"));
335 //println(cfgProperties.toSource());
337 for(var i =0; i < cfgProperties.length;i++) {
338 p = cfgProperties[i];
344 memberOf : p.memberOf == data.alias ? '' : p.memberOf
347 add.optvals = p.optvalues;
353 var ownEvents = data.methods.filter( function(e){
354 return e.isEvent && !e.comment.getTag('hide').length;
355 }).sort(makeSortby("name"));
360 for(var i =0; i < ownEvents.length;i++) {
363 name : m.name.substring(1),
364 sig : this.makeFuncSkel(m.params),
370 var ownMethods = data.methods.filter( function(e){
371 return !e.isEvent && !e.comment.getTag('hide').length;
372 }).sort(makeSortby("name"));
377 for(var i =0; i < ownMethods.length;i++) {
381 sig : this.makeMethodSkel(m.params),
387 //println(props.toSource());
388 // we need to output:
409 srcFileRelName : function(sourceFile)
411 return sourceFile.substring(Options.baseDir.length+1);
413 srcFileFlatName: function(sourceFile)
415 var name = this.srcFileRelName(sourceFile);
416 name = name.replace(/\.\.?[\\\/]/g, "").replace(/[\\\/]/g, "_");
417 return name.replace(/\:/g, "_") + '.html'; //??;
421 makeSrcFile: function(sourceFile)
423 // this stuff works...
426 var name = this.srcFileFlatName(sourceFile);
428 GLib.debug("Write Source file : " + Options.target+"/symbols/src/" + name);
429 var pretty = imports.PrettyPrint.toPretty(File.read( sourceFile));
430 File.write(Options.target+"/symbols/src/" + name,
432 '<title>' + sourceFile + '</title>' +
433 '<link rel="stylesheet" type="text/css" href="../../../css/highlight-js.css"/>' +
434 '</head><body class="highlightpage">' +
439 * used by JSON output to generate a function skeleton
441 makeFuncSkel :function(params) {
442 if (!params) return "function ()\n{\n\n}";
443 return "function (" +
446 return $.name.indexOf(".") == -1; // don't show config params in signature
448 ).map( function($) { return $.name == 'this' ? '_self' : $.name; } ).join(", ") +
451 makeMethodSkel :function(params) {
452 if (!params) return "()";
456 return $.name.indexOf(".") == -1; // don't show config params in signature
458 ).map( function($) { return $.type + " " +( $.name == 'this' ? '_self' : $.name ); } ).join(", ") +