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);
43 Options.LOG.inform("JsDoc Toolkit main() running at "+new Date()+".");
44 Options.LOG.inform("With options: ");
46 if (!File.isDirectory(Options.cacheDirectory)) {
47 File.mkdir(Options.cacheDirectory)
50 Options.srcFiles = this._getSrcFiles();
51 this._parseSrcFiles();
52 this.symbolSet = Parser.symbols;
54 // this currently uses the concept of publish.js...
63 _getSrcFiles : function()
69 ext = Options.ext.split(",").map(function($) {return $.toLowerCase()});
72 for (var i = 0; i < Options.src.length; i++) {
73 this.srcFiles = this.srcFiles.concat(
75 File.list(Options.src[i] ).filter(
77 var thisExt = $.split(".").pop().toLowerCase();
78 return (ext.indexOf(thisExt) > -1); // || thisExt in JSDOC.handlers);
79 // we're only interested in files with certain extensions
88 _parseSrcFiles : function()
92 for (var i = 0, l = this.srcFiles.length; i < l; i++) {
94 var srcFile = this.srcFiles[i];
97 var cacheFile = Options.cacheDirectory + srcFile.replace(/\//g, '_') + ".cache";
100 // disabled at present!@!!
102 if (false && !Options.disablecache && File.exists(cacheFile)) {
105 var c_mt = File.getTimes(cacheFile);
106 var o_mt = File.getTimes(srcFile);
107 //println(c_mt.toSource());
108 // println(o_mt.toSource());
110 // this check does not appear to work according to the doc's - need to check it out.
112 if (c_mt[0] > o_mt[0]) { // cached time > original time!
113 // use the cached mtimes..
114 var syms = JSON.parse(File.read(cacheFile));
116 throw "Conversion of cache not done yet!";
118 for (var sy in syms) {
119 //println("ADD:" + sy );
120 Parser.symbols.addSymbol(syms[sy]);
128 src = File.read(srcFile);
131 LOG.warn("Can't read source file '"+srcFile+"': "+e.message);
136 var tr = new TokenReader();
137 var ts = new TokenStream(tr.tokenize(src));
139 Parser.parse(ts, srcFile);
141 //var outstr = JSON.stringify(
142 // Parser.filesSymbols[srcFile]._index
144 //File.write(cacheFile, outstr);
157 publish : function() {
164 if (!File.exists(Options.target))
165 File.mkdir(Options.target);
166 if (!File.exists(Options.target+"/symbols"))
167 File.mkdir(Options.target+"/symbols");
168 if (!File.exists(Options.target+"/symbols/src"))
169 File.mkdir(Options.target+"/symbols/src");
171 // copy everything in 'static' into
172 File.list(Options.templatesDir + '/static').forEach(function (f) {
173 File.copy(Options.templatesDir + '/static/' + f, Options.target + '/' + f);
175 if (!File.isDirectory(Options.target +"/json")) {
176 File.makeDir(Options.target +"/json");
179 // used to check the details of things being linked to
180 Link.symbolSet = symbolSet;
183 var classTemplate = new Template({
184 templateFile : Options.templatesDir + "/class.tmpl",
187 var classesTemplate = new Template({
188 templateFile : Options.templatesDir +"/allclasses.tmpl",
191 var classesindexTemplate = new Template({
192 templateFile : Options.templatesDir +"/index.tmpl",
195 var fileindexTemplate = new Template({
196 templateFile : Options.templatesDir +"/allfiles.tmpl",
201 classTemplate.symbolSet = symbolSet;
204 function hasNoParent($) {
205 return ($.memberOf == "")
207 function isaFile($) {
208 return ($.is("FILE"))
210 function isaClass($) {
211 return ($.is("CONSTRUCTOR") || $.isNamespace);
214 var symbols = symbolSet.toArray();
216 var files = Options.srcFiles;
218 for (var i = 0, l = files.length; i < l; i++) {
220 var targetDir = Options.target + "/symbols/src/";
221 this.makeSrcFile(file, targetDir);
224 var classes = symbols.filter(isaClass).sort(makeSortby("alias"));
226 var classesIndex = classesTemplate.process(classes); // kept in memory
230 for (var i = 0, l = classes.length; i < l; i++) {
231 var symbol = classes[i];
234 File.write(Options.target+"/symbols/" +symbol.alias+'.' + Options.publishExt ,
235 classTemplate.process(symbol));
237 print("write " + Options.target+"/symbols/" +symbol.alias+'.' + Options.publishExt);
241 this.publishJSON(Options.target+"/json/", symbol.alias+'.json', symbol)
247 // regenrate the index with different relative links
249 var classesIndex = classesTemplate.process(classes);
253 File.write(Options.target + "/index."+ Options.publishExt,
254 classesindexTemplate.process(classes)
257 // blank everything???? classesindexTemplate = classesIndex = classes = null;
261 var documentedFiles = symbols.filter(function ($) {
262 return ($.is("FILE"))
267 for (var i = 0; i < files.length; i++) {
268 allFiles.push(new Symbol(files[i], [], "FILE", new JSDOC.DocComment("/** */")));
271 for (var i = 0; i < documentedFiles.length; i++) {
272 var offset = files.indexOf(documentedFiles[i].alias);
273 allFiles[offset] = documentedFiles[i];
276 allFiles = allFiles.sort(makeSortby("name"));
277 File.write(Options.target , "/files."+Options.publishExt,
278 fileindexTemplate.process(allFiles)
283 publishJSON = function(file, data)
285 // what we need to output to be usefull...
287 var cfgProperties = [];
288 if (!data.comment.getTag('singleton').length) {
289 cfgProperties = data.configToArray();
290 cfgProperties = cfgProperties.sort(makeSortby("name"));
294 //println(cfgProperties.toSource());
296 for(var i =0; i < cfgProperties.length;i++) {
297 p = cfgProperties[i];
302 memberOf : p.memberOf == data.alias ? '' : p.memberOf
307 var ownEvents = data.methods.filter( function(e){
308 return e.isEvent && !e.comment.getTag('hide').length;
309 }).sort(makeSortby("name"));
314 for(var i =0; i < ownEvents.length;i++) {
317 name : m.name.substring(1),
318 sig : makeFuncSkel(m.params),
323 //println(props.toSource());
324 // we need to output:
335 File.write(file, JSON.stringify(ret, null, 2 ));
343 makeSrcFile: function(sourceFile, targetDir, name)
345 if (Options.outputSource) return;
349 name = sourceFile.replace(/\.\.?[\\\/]/g, "").replace(/[\\\/]/g, "_");
350 name = name.replace(/\:/g, "_");
353 var pretty = PrettyPrint.toPretty(sourceFile);