Template = imports.JsTemplate.Template.Template;
Link = imports.JsTemplate.Link.Link; // ?? fixme!??
-Parser = imports.Parser.Parser;
-TextStream = imports.TextStream.TextStream;
+Parser = imports.Parser.Parser;
+TextStream = imports.TextStream.TextStream;
TokenReader = imports.TokenReader.TokenReader;
TokenStream = imports.TokenStream.TokenStream;
-Symbol = imports.Symbol.Symbol;
-/****************** INCLUDES ARE ALL AT THE BOTTOM OF THIS FILE!!!!! *******************/
+Symbol = imports.Symbol.Symbol;
+DocComment = imports.DocComment.DocComment;
+
// should not realy be here -- or anywhere...??
+function makeSortby(attribute) {
+ return function(a, b) {
+ if (a[attribute] != undefined && b[attribute] != undefined) {
+ a = a[attribute]; //.toLowerCase();
+ b = b[attribute];//.toLowerCase();
+ if (a < b) return -1;
+ if (a > b) return 1;
+ return 0;
+ }
+ }
+}
Options = false; // refer to this everywhere!
},
-
+ /**
+ * create a list of files in this.srcFiles using list of directories / files in Options.src
+ *
+ */
_getSrcFiles : function()
{
//Seed.print(JSON.stringify(this.srcFiles, null,4));Seed.quit();
return this.srcFiles;
},
+ /**
+ * Parse the source files.
+ *
+ */
_parseSrcFiles : function()
{
var srcFile = this.srcFiles[i];
- var cacheFile = Options.cacheDirectory + srcFile.replace(/\//g, '_') + ".cache";
+ var cacheFile = !Options.cacheDirectory.length ? false :
+ Options.cacheDirectory + srcFile.replace(/\//g, '_') + ".cache";
- //println(cacheFile);
+ //print(cacheFile);
// disabled at present!@!!
- if (false && !Options.disablecache && File.exists(cacheFile)) {
+ if (cacheFile && File.exists(cacheFile)) {
// check filetime?
- var c_mt = File.getTimes(cacheFile);
- var o_mt = File.getTimes(srcFile);
+ var c_mt = File.mtime(cacheFile);
+ var o_mt = File.mtime(srcFile);
//println(c_mt.toSource());
// println(o_mt.toSource());
// this check does not appear to work according to the doc's - need to check it out.
- if (c_mt[0] > o_mt[0]) { // cached time > original time!
+ if (c_mt > o_mt) { // cached time > original time!
// use the cached mtimes..
- var syms = JSON.parse(File.read(cacheFile));
-
- throw "Conversion of cache not done yet!";
-
- for (var sy in syms) {
+ print("Read " + cacheFile);
+ var syms = JSON.parse(File.read(cacheFile), function(k, v) {
+ //print(k);
+ if (typeof(v) != 'object') {
+ return v;
+ }
+ if (typeof(v._object) == 'undefined') {
+ return v;
+ }
+ var cls = imports[v._object][v._object];
+ print(v._object);
+ delete v._object;
+ var ret = new cls();
+ XObject.extend(ret, v);
+ return ret;
+ });
+ print("Add sybmols " + cacheFile);
+ for (var sy in syms._index) {
//println("ADD:" + sy );
Parser.symbols.addSymbol(syms[sy]);
}
var txs = new TextStream(src);
- var tr = new TokenReader({ keepComments : true, keepWhite : true });
+ var tr = new TokenReader({ keepComments : true, keepWhite : true , sepIdents: false });
var ts = new TokenStream(tr.tokenize(txs));
Parser.parse(ts, srcFile);
-
+
+ if (cacheFile) {
+ File.write(cacheFile,
+ JSON.stringify(
+ Parser.symbolsToObject(srcFile),
+ null,2
+ )
+ );
+
+ }
//var outstr = JSON.stringify(
// Parser.filesSymbols[srcFile]._index
//);
Link.symbolSet = this.symbolSet;
Link.base = "../";
+ Link.srcFileFlatName = this.srcFileFlatName;
+ Link.srcFileRelName = this.srcFileRelName;
+
var classTemplate = new Template({
- templateFile : Options.templateDir + "/class.tmpl",
+ templateFile : Options.templateDir + "/class.html",
Link : Link
});
var classesTemplate = new Template({
- templateFile : Options.templateDir +"/allclasses.tmpl",
+ templateFile : Options.templateDir +"/allclasses.html",
Link : Link
});
var classesindexTemplate = new Template({
- templateFile : Options.templateDir +"/index.tmpl",
+ templateFile : Options.templateDir +"/index.html",
Link : Link
});
var fileindexTemplate = new Template({
- templateFile : Options.templateDir +"/allfiles.tmpl",
+ templateFile : Options.templateDir +"/allfiles.html",
Link: Link
});
return ($.is("CONSTRUCTOR") || $.isNamespace);
}
+
+
+
+
+
+
+
+
+
var symbols = this.symbolSet.toArray();
var files = Options.srcFiles;
var classes = symbols.filter(isaClass).sort(makeSortby("alias"));
- var classesIndex = classesTemplate.process(classes); // kept in memory
+ //Options.LOG.inform("classTemplate Process : all classes");
+
+ // var classesIndex = classesTemplate.process(classes); // kept in memory
+ Options.LOG.inform("iterate classes");
+ var jsonAll = {};
for (var i = 0, l = classes.length; i < l; i++) {
var symbol = classes[i];
var output = "";
- File.write(Options.target+"/symbols/" +symbol.alias+'.' + Options.publishExt ,
- classTemplate.process(symbol));
+ Options.LOG.inform("classTemplate Process : " + symbol.alias);
+
- print("write " + Options.target+"/symbols/" +symbol.alias+'.' + Options.publishExt);
- // dump out a
- this.publishJSON(Options.target+"/json/", symbol.alias+'.json', symbol)
+ File.write(Options.target+"/symbols/" +symbol.alias+'.' + Options.publishExt ,
+ classTemplate.process(symbol));
+
+ jsonAll[symbol.alias] = this.publishJSON(symbol);
}
+ File.write(Options.target+"/json/roodata.json",
+ JSON.stringify({
+ success : true,
+ data : jsonAll
+ }, null, 1)
+ );
+
+
// regenrate the index with different relative links
Link.base = "";
- var classesIndex = classesTemplate.process(classes);
+ //var classesIndex = classesTemplate.process(classes);
-
+ Options.LOG.inform("build index");
File.write(Options.target + "/index."+ Options.publishExt,
classesindexTemplate.process(classes)
var allFiles = [];
for (var i = 0; i < files.length; i++) {
- allFiles.push(new Symbol(files[i], [], "FILE", new JSDOC.DocComment("/** */")));
+ allFiles.push(new Symbol(files[i], [], "FILE", new DocComment("/** */")));
}
for (var i = 0; i < documentedFiles.length; i++) {
}
allFiles = allFiles.sort(makeSortby("name"));
- File.write(Options.target , "/files."+Options.publishExt,
+ Options.LOG.inform("write files index");
+
+ File.write(Options.target + "/files."+Options.publishExt,
fileindexTemplate.process(allFiles)
);
+
+
+
},
-
- publishJSON : function(file, data)
+ /**
+ * JSON files are lookup files for the documentation
+ * - can be used by IDE's or AJAX based doc tools
+ *
+ *
+ */
+ publishJSON : function(data)
{
// what we need to output to be usefull...
// a) props..
var cfgProperties = [];
if (!data.comment.getTag('singleton').length) {
cfgProperties = data.configToArray();
- cfgProperties = cfgProperties.sort(makeSortby("name"));
+ cfgProperties = cfgProperties.sort(makeSortby("alias"));
}
var props = [];
m = ownEvents[i];
events.push( {
name : m.name.substring(1),
- sig : makeFuncSkel(m.params),
+ sig : this.makeFuncSkel(m.params),
type : 'function',
desc : m.desc
});
props : props,
events: events
};
- File.write(file, JSON.stringify(ret, null, 2 ));
+ return ret;
+
// b) methods
},
- makeSrcFile: function(sourceFile)
+ srcFileRelName : function(sourceFile)
{
-
-
- name = sourceFile.substring(Options.baseDir.length+1);
+ return sourceFile.substring(Options.baseDir.length+1);
+ },
+ srcFileFlatName: function(sourceFile)
+ {
+ var name = this.srcFileRelName(sourceFile);
name = name.replace(/\.\.?[\\\/]/g, "").replace(/[\\\/]/g, "_");
+ return name.replace(/\:/g, "_") + '.html'; //??;
+
+ },
+
+ makeSrcFile: function(sourceFile)
+ {
+ // this stuff works...
+
- name = name.replace(/\:/g, "_"); //??
+ var name = this.srcFileFlatName(sourceFile);
- Options.LOG.inform("Write Source file :" + sourceFile);
- var pretty = imports.PrettyPrint.toPretty(File.read(sourceFile));
+ Options.LOG.inform("Write Source file : " + Options.target+"/symbols/src/" + name);
+ var pretty = imports.PrettyPrint.toPretty(File.read( sourceFile));
File.write(Options.target+"/symbols/src/" + name,
'<html><head>' +
'<title>' + sourceFile + '</title>' +
- '<link rel="stylesheet" type="text/css" href="../../../highlight-js.css"/>' +
+ '<link rel="stylesheet" type="text/css" href="../../../css/highlight-js.css"/>' +
'</head><body class="highlightpage">' +
pretty +
'</body></html>');
+ },
+ /**
+ * used by JSON output to generate a function skeleton
+ */
+ makeFuncSkel :function(params) {
+ if (!params) return "function ()\n{\n\n}";
+ return "function (" +
+ params.filter(
+ function($) {
+ return $.name.indexOf(".") == -1; // don't show config params in signature
+ }
+ ).map( function($) { return $.name == 'this' ? '_self' : $.name; } ).join(", ") +
+ ")\n{\n\n}";
}
-
+
+
};
projects / gnome.introspection-doc-generator / blobdiff