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;
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...??
36 build : function (Options)
38 this.Options = Options;
41 Options.LOG.inform("JsDoc Toolkit main() running at "+new Date()+".");
42 //Options.LOG.inform("With options: ");
44 if (!File.isDirectory(Options.cacheDirectory)) {
45 File.mkdir(Options.cacheDirectory)
48 Options.srcFiles = this._getSrcFiles();
49 this._parseSrcFiles();
50 this.symbolSet = Parser.symbols;
52 // this currently uses the concept of publish.js...
61 _getSrcFiles : function()
67 ext = Options.ext.split(",").map(function($) {return $.toLowerCase()});
70 for (var i = 0; i < Options.src.length; i++) {
71 this.srcFiles = this.srcFiles.concat(
73 File.list(Options.src[i] ).filter(
75 var thisExt = $.split(".").pop().toLowerCase();
76 return (ext.indexOf(thisExt) > -1); // || thisExt in JSDOC.handlers);
77 // we're only interested in files with certain extensions
86 _parseSrcFiles : function()
90 for (var i = 0, l = this.srcFiles.length; i < l; i++) {
92 var srcFile = this.srcFiles[i];
95 var cacheFile = Options.cacheDirectory + srcFile.replace(/\//g, '_') + ".cache";
98 // disabled at present!@!!
100 if (false && !Options.disablecache && File.exists(cacheFile)) {
103 var c_mt = File.getTimes(cacheFile);
104 var o_mt = File.getTimes(srcFile);
105 //println(c_mt.toSource());
106 // println(o_mt.toSource());
108 // this check does not appear to work according to the doc's - need to check it out.
110 if (c_mt[0] > o_mt[0]) { // cached time > original time!
111 // use the cached mtimes..
112 var syms = JSON.parse(File.read(cacheFile));
114 throw "Conversion of cache not done yet!";
116 for (var sy in syms) {
117 //println("ADD:" + sy );
118 Parser.symbols.addSymbol(syms[sy]);
126 src = File.read(srcFile);
129 LOG.warn("Can't read source file '"+srcFile+"': "+e.message);
134 var tr = new TokenReader();
135 var ts = new TokenStream(tr.tokenize(src));
137 Parser.parse(ts, srcFile);
139 //var outstr = JSON.stringify(
140 // Parser.filesSymbols[srcFile]._index
142 //File.write(cacheFile, outstr);
155 publish : function() {
162 if (!File.exists(Options.target))
163 File.mkdir(Options.target);
164 if (!File.exists(Options.target+"/symbols"))
165 File.mkdir(Options.target+"/symbols");
166 if (!File.exists(Options.target+"/symbols/src"))
167 File.mkdir(Options.target+"/symbols/src");
169 // copy everything in 'static' into
170 File.list(Options.templatesDir + '/static').forEach(function (f) {
171 File.copy(Options.templatesDir + '/static/' + f, Options.target + '/' + f);
173 if (!File.isDirectory(Options.target +"/json")) {
174 File.makeDir(Options.target +"/json");
177 // used to check the details of things being linked to
178 Link.symbolSet = symbolSet;
181 var classTemplate = new Template({
182 templateFile : Options.templatesDir + "/class.tmpl",
185 var classesTemplate = new Template({
186 templateFile : Options.templatesDir +"/allclasses.tmpl",
189 var classesindexTemplate = new Template({
190 templateFile : Options.templatesDir +"/index.tmpl",
193 var fileindexTemplate = new Template({
194 templateFile : Options.templatesDir +"/allfiles.tmpl",
199 classTemplate.symbolSet = symbolSet;
202 function hasNoParent($) {
203 return ($.memberOf == "")
205 function isaFile($) {
206 return ($.is("FILE"))
208 function isaClass($) {
209 return ($.is("CONSTRUCTOR") || $.isNamespace);
212 var symbols = symbolSet.toArray();
214 var files = Options.srcFiles;
216 for (var i = 0, l = files.length; i < l; i++) {
218 var targetDir = Options.target + "/symbols/src/";
219 this.makeSrcFile(file, targetDir);
222 var classes = symbols.filter(isaClass).sort(makeSortby("alias"));
224 var classesIndex = classesTemplate.process(classes); // kept in memory
228 for (var i = 0, l = classes.length; i < l; i++) {
229 var symbol = classes[i];
232 File.write(Options.target+"/symbols/" +symbol.alias+'.' + Options.publishExt ,
233 classTemplate.process(symbol));
235 print("write " + Options.target+"/symbols/" +symbol.alias+'.' + Options.publishExt);
239 this.publishJSON(Options.target+"/json/", symbol.alias+'.json', symbol)
245 // regenrate the index with different relative links
247 var classesIndex = classesTemplate.process(classes);
251 File.write(Options.target + "/index."+ Options.publishExt,
252 classesindexTemplate.process(classes)
255 // blank everything???? classesindexTemplate = classesIndex = classes = null;
259 var documentedFiles = symbols.filter(function ($) {
260 return ($.is("FILE"))
265 for (var i = 0; i < files.length; i++) {
266 allFiles.push(new Symbol(files[i], [], "FILE", new JSDOC.DocComment("/** */")));
269 for (var i = 0; i < documentedFiles.length; i++) {
270 var offset = files.indexOf(documentedFiles[i].alias);
271 allFiles[offset] = documentedFiles[i];
274 allFiles = allFiles.sort(makeSortby("name"));
275 File.write(Options.target , "/files."+Options.publishExt,
276 fileindexTemplate.process(allFiles)
281 publishJSON : function(file, data)
283 // what we need to output to be usefull...
285 var cfgProperties = [];
286 if (!data.comment.getTag('singleton').length) {
287 cfgProperties = data.configToArray();
288 cfgProperties = cfgProperties.sort(makeSortby("name"));
292 //println(cfgProperties.toSource());
294 for(var i =0; i < cfgProperties.length;i++) {
295 p = cfgProperties[i];
300 memberOf : p.memberOf == data.alias ? '' : p.memberOf
305 var ownEvents = data.methods.filter( function(e){
306 return e.isEvent && !e.comment.getTag('hide').length;
307 }).sort(makeSortby("name"));
312 for(var i =0; i < ownEvents.length;i++) {
315 name : m.name.substring(1),
316 sig : makeFuncSkel(m.params),
321 //println(props.toSource());
322 // we need to output:
333 File.write(file, JSON.stringify(ret, null, 2 ));
341 makeSrcFile: function(sourceFile)
345 name = sourceFile.substring(Options.baseDir.length);
346 name = name.replace(/\.\.?[\\\/]/g, "").replace(/[\\\/]/g, "_");
347 name = name.replace(/\:/g, "_"); //??
350 var pretty = imports.PrettyPrint.toPretty(File.read(sourceFile));
351 File.write(Options.target+"/symbols/src/" + name,
353 '<title>' + sourceFile + '</title>' +
354 '<link rel="stylesheet" type="text/css" href="../../../highlight-js.css"/>' +
355 '</head><body class="highlightpage">' +