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;
13 Options = imports.Options.Options;
14 Parser = imports.Parser.Parser;
16 TokenReader = imports.TokenReader.TokenReader;
17 TokenStream = imports.TokenStream.TokenStream;
18 Symbol = imports.Symbol.Symbol;
19 /****************** INCLUDES ARE ALL AT THE BOTTOM OF THIS FILE!!!!! *******************/
21 // should not realy be here -- or anywhere...??
34 build : function (opts)
37 XObject.extend(Options, opts);
44 Options.LOG.inform("JsDoc Toolkit main() running at "+new Date()+".");
45 Options.LOG.inform("With options: ");
47 if (!File.isDirectory(Options.cacheDirectory)) {
48 File.mkdir(Options.cacheDirectory)
51 Options.srcFiles = this._getSrcFiles();
52 this._parseSrcFiles();
53 this.symbolSet = Parser.symbols;
55 // this currently uses the concept of publish.js...
64 _getSrcFiles : function()
70 ext = Options.ext.split(",").map(function($) {return $.toLowerCase()});
73 for (var i = 0; i < Options.src.length; i++) {
74 this.srcFiles = this.srcFiles.concat(
76 File.list(Options.src[i] ).filter(
78 var thisExt = $.split(".").pop().toLowerCase();
79 return (ext.indexOf(thisExt) > -1); // || thisExt in JSDOC.handlers);
80 // we're only interested in files with certain extensions
89 _parseSrcFiles : function()
93 for (var i = 0, l = this.srcFiles.length; i < l; i++) {
95 var srcFile = this.srcFiles[i];
98 var cacheFile = Options.cacheDirectory + srcFile.replace(/\//g, '_') + ".cache";
100 //println(cacheFile);
101 // disabled at present!@!!
103 if (false && !Options.disablecache && File.exists(cacheFile)) {
106 var c_mt = File.getTimes(cacheFile);
107 var o_mt = File.getTimes(srcFile);
108 //println(c_mt.toSource());
109 // println(o_mt.toSource());
111 // this check does not appear to work according to the doc's - need to check it out.
113 if (c_mt[0] > o_mt[0]) { // cached time > original time!
114 // use the cached mtimes..
115 var syms = JSON.parse(File.read(cacheFile));
117 throw "Conversion of cache not done yet!";
119 for (var sy in syms) {
120 //println("ADD:" + sy );
121 Parser.symbols.addSymbol(syms[sy]);
129 src = File.read(srcFile);
132 LOG.warn("Can't read source file '"+srcFile+"': "+e.message);
137 var tr = new TokenReader();
138 var ts = new TokenStream(tr.tokenize(src));
140 Parser.parse(ts, srcFile);
142 //var outstr = JSON.stringify(
143 // Parser.filesSymbols[srcFile]._index
145 //File.write(cacheFile, outstr);
158 publish : function() {
165 if (!File.exists(Options.target))
166 File.mkdir(Options.target);
167 if (!File.exists(Options.target+"/symbols"))
168 File.mkdir(Options.target+"/symbols");
169 if (!File.exists(Options.target+"/symbols/src"))
170 File.mkdir(Options.target+"/symbols/src");
172 // copy everything in 'static' into
173 File.list(Options.templatesDir + '/static').forEach(function (f) {
174 File.copy(Options.templatesDir + '/static/' + f, Options.target + '/' + f);
178 // used to check the details of things being linked to
179 Link.symbolSet = symbolSet;
182 var classTemplate = new Template({
183 templateFile : Options.templatesDir + "/class.tmpl",
186 var classesTemplate = new Template(
187 templateFile : Options.templatesDir +"allclasses.tmpl",
191 classTemplate.symbolSet = symbolSet;
194 function hasNoParent($) {
195 return ($.memberOf == "")
197 function isaFile($) {
198 return ($.is("FILE"))
200 function isaClass($) {
201 return ($.is("CONSTRUCTOR") || $.isNamespace);
204 var symbols = symbolSet.toArray();
206 var files = Options.srcFiles;
208 for (var i = 0, l = files.length; i < l; i++) {
210 var srcDir = Options.target + "/symbols/src/";
211 this.makeSrcFile(file, srcDir);
214 var classes = symbols.filter(isaClass).sort(makeSortby("alias"));
217 publish.classesIndex = classesTemplate.process(classes); // kept in memory
219 IO.makeDir(publish.conf.outDir+"json");
221 for (var i = 0, l = classes.length; i < l; i++) {
222 var symbol = classes[i];
225 File.write(Options.target+"/symbols/" +symbol.alias+'.' + Options.publishExt ,
226 classTemplate.process(symbol));
228 print("write " + Options.target+"/symbols/" +symbol.alias+'.' + Options.publishExt);
231 IO.saveFile(publish.conf.outDir+"json/", symbol.alias+'.json' , publish.jsonRender(symbol));
236 // regenrate the index with different relative links
238 publish.classesIndex = classesTemplate.process(classes);
241 var classesindexTemplate = new JSDOC.JsPlate(publish.conf.templatesDir+"index.tmpl");
243 catch(e) { print(e.message); quit(); }
245 var classesIndex = classesindexTemplate.process(classes);
246 IO.saveFile(publish.conf.outDir, "index"+publish.conf.ext, classesIndex);
247 classesindexTemplate = classesIndex = classes = null;
250 var fileindexTemplate = new JSDOC.JsPlate(publish.conf.templatesDir+"allfiles.tmpl");
252 catch(e) { print(e.message); quit(); }
254 var documentedFiles = symbols.filter(isaFile);
257 for (var i = 0; i < files.length; i++) {
258 allFiles.push(new JSDOC.Symbol(files[i], [], "FILE", new JSDOC.DocComment("/** */")));
261 for (var i = 0; i < documentedFiles.length; i++) {
262 var offset = files.indexOf(documentedFiles[i].alias);
263 allFiles[offset] = documentedFiles[i];
266 allFiles = allFiles.sort(makeSortby("name"));
268 var filesIndex = fileindexTemplate.process(allFiles);
269 IO.saveFile(publish.conf.outDir, "files"+publish.conf.ext, filesIndex);
270 fileindexTemplate = filesIndex = files = null;
273 publishJSON = function(data)
275 // what we need to output to be usefull...
277 var cfgProperties = [];
278 if (!data.comment.getTag('singleton').length) {
279 cfgProperties = data.configToArray();
280 cfgProperties = cfgProperties.sort(makeSortby("name"));
284 //println(cfgProperties.toSource());
286 for(var i =0; i < cfgProperties.length;i++) {
287 p = cfgProperties[i];
292 memberOf : p.memberOf == data.alias ? '' : p.memberOf
297 var ownEvents = data.methods.filter( function(e){
298 return e.isEvent && !e.comment.getTag('hide').length;
299 }).sort(makeSortby("name"));
304 for(var i =0; i < ownEvents.length;i++) {
307 name : m.name.substring(1),
308 sig : makeFuncSkel(m.params),
313 //println(props.toSource());
314 // we need to output:
325 return JSON.encode(ret);
333 makeSrcFile: function(path, srcDir, name) {
334 if (Options.outputSource) return;
339 name = path.replace(/\.\.?[\\\/]/g, "").replace(/[\\\/]/g, "_");
340 name = name.replace(/\:/g, "_");
346 charset: IO.encoding,
352 IO.saveFile(srcDir, name+publish.conf.ext, src.hilited);