sproutcore 0.9.0

data/jsdoc/app/Doclet.js

@@ -0,0 +1,63 @@
+/**
+ * @fileOverview
+ * @name Doclet
+ * @author Michael Mathews micmath@gmail.com
+ * @url $HeadURL: https://jsdoc-toolkit.googlecode.com/svn/tags/jsdoc_toolkit-1.4.0b/app/Doclet.js $
+ * @revision $Id: Doclet.js 295 2007-11-11 01:09:02Z micmath $
+ * @license <a href="http://en.wikipedia.org/wiki/MIT_License">X11/MIT License</a>
+ *          (See the accompanying README file for full details.)
+ */
+ 
+/**
+ * @class Represents a collection of DocTags.
+ * @constructor
+ * @author Michael Mathews <a href="mailto:micmath@gmail.com">micmath@gmail.com</a>
+ * @param {string} comment The entire documentation comment. The openening slash-star-star and
+ * closing star-slash are optional. An untagged string at the start automatically gets a "desc" tag.
+ */
+function Doclet(comment) {
+	var src = Doclet.unwrapComment(comment);
+	var tagTexts = src.split(/(^|[\r\f\n])\s*@/);
+	
+	this.tags =
+		tagTexts.filter(function(el){return el.match(/^\w/)})
+		.map(function(el){return new DocTag(el)});
+	
+	var paramParent = "config"; // default
+	for(var i = 0; i < this.tags.length; i++) {
+		if (this.tags[i].title == "param") paramParent = this.tags[i].name;
+		if (this.tags[i].title == "config") {
+			this.tags[i].name = paramParent+"."+this.tags[i].name;
+			this.tags[i].title = "param"
+		}
+	}
+}
+
+/**
+ * Remove the slashes and stars from a doc comment.
+ */
+Doclet.unwrapComment = function(comment) {
+	if (!comment) comment = "/** @desc undocumented */";
+
+	var unwrapped = comment.replace(/(^\/\*\*|\*\/$)/g, "").replace(/^\s*\* ?/gm, "");
+	if (unwrapped.match(/^\s*[^@\s]/)) unwrapped = "@desc "+unwrapped;
+	return unwrapped;
+}
+
+/**
+ * Get every DocTag with the given title.
+ * @param {string} tagTitle
+ * @return {DocTag[]}
+ */
+Doclet.prototype.getTag = function(tagTitle) {
+	return this.tags.filter(function(el){return el.title == tagTitle});
+}
+
+/**
+ * Remove from this Doclet every DocTag with the given title.
+ * @private
+ * @param {string} tagTitle
+ */
+Doclet.prototype._dropTag = function(tagTitle) {
+	this.tags = this.tags.filter(function(el){return el.title != tagTitle});
+}

data/jsdoc/app/Dumper.js

@@ -0,0 +1,143 @@
+/**
+ * @class
+<pre>
+This is a lightly modified version of Kevin Jones' JavaScript
+library Data.Dump. To download the original visit:
+    <a href="http://openjsan.org/doc/k/ke/kevinj/Data/Dump/">http://openjsan.org/doc/k/ke/kevinj/Data/Dump/</a>
+
+AUTHORS
+
+The Data.Dump JavaScript module is written by Kevin Jones 
+(kevinj@cpan.org), based on Data::Dump by Gisle Aas (gisle@aas.no),
+based on Data::Dumper by Gurusamy Sarathy (gsar@umich.edu).
+
+COPYRIGHT
+
+Copyright 2007 Kevin Jones. Copyright 1998-2000,2003-2004 Gisle Aas.
+Copyright 1996-1998 Gurusamy Sarathy.
+
+This program is free software; you can redistribute it and/or modify
+it under the terms of the Perl Artistic License
+
+See http://www.perl.com/perl/misc/Artistic.html
+</pre>
+ * @static
+ */
+Dumper = {
+	/** @param [...] The objects to dump. */
+	dump: function () {
+	    if (arguments.length > 1)
+	        return this._dump(arguments);
+	    else if (arguments.length == 1)
+	        return this._dump(arguments[0]);
+	    else
+	        return "()";
+	},
+	
+	_dump: function (obj) {
+		if (typeof obj == 'undefined') return 'undefined';
+		var out;
+		var type = this._typeof(obj);
+		if (obj.circularReference) obj.circularReference++;
+		switch (type) {
+			case 'circular':
+				out = '{/*circularReference*/}';
+				break;
+			case 'object':
+				var pairs = new Array;
+				
+				for (var prop in obj) {
+					if (prop != "circularReference" && obj.hasOwnProperty(prop)) { //hide inherited properties
+						pairs.push(prop + ': ' + this._dump(obj[prop]));
+					}
+				}
+	
+				out = '{' + this._format_list(pairs) + '}';
+				break;
+	
+			case 'string':
+				for (var prop in Dumper.ESC) {
+					if (Dumper.ESC.hasOwnProperty(prop)) {
+						obj = obj.replace(prop, Dumper.ESC[prop]);
+					}
+				}
+	
+			// Escape UTF-8 Strings
+				if (obj.match(/^[\x00-\x7f]*$/)) {
+					out = '"' + obj + '"';
+				}
+				else {
+					out = "unescape('"+escape(obj)+"')";
+				}
+				break;
+	
+			case 'array':
+				var elems = new Array;
+	
+				for (var i=0; i<obj.length; i++) {
+					elems.push( this._dump(obj[i]) );
+				}
+	
+				out = '[' + this._format_list(elems) + ']';
+				break;
+	
+			case 'date':
+			// firefox returns GMT strings from toUTCString()...
+			var utc_string = obj.toUTCString().replace(/GMT/,'UTC');
+				out = 'new Date("' + utc_string + '")';
+				break;
+	
+			case 'element':
+				// DOM element
+				out = this._dump_dom(obj);
+				break;
+		
+				default:
+					out = obj;
+		}
+	
+		out = String(out).replace(/\n/g, '\n    ');
+		out = out.replace(/\n    (.*)$/,"\n$1");
+	
+		return out;
+	},
+	
+	_format_list: function (list) {
+		if (!list.length) return '';
+		var nl = list.toString().length > 60 ? '\n' : ' ';
+		return nl + list.join(',' + nl) + nl;
+    },
+    
+    _typeof: function (obj) {
+    	if (obj && obj.circularReference && obj.circularReference > 1) return 'circular';
+		if (Array.prototype.isPrototypeOf(obj)) return 'array';
+		if (Date.prototype.isPrototypeOf(obj)) return 'date';
+		if (typeof obj.nodeType != 'undefined') return 'element';
+		return typeof(obj);
+	},
+	
+	_dump_dom: function (obj) {
+		return '"' + Dumper.nodeTypes[obj.nodeType] + '"';
+	}
+};
+
+Dumper.ESC = {
+    "\t": "\\t",
+    "\n": "\\n",
+    "\f": "\\f"
+};
+
+Dumper.nodeTypes = {
+    1: "ELEMENT_NODE",
+    2: "ATTRIBUTE_NODE",
+    3: "TEXT_NODE",
+    4: "CDATA_SECTION_NODE",
+    5: "ENTITY_REFERENCE_NODE",
+    6: "ENTITY_NODE",
+    7: "PROCESSING_INSTRUCTION_NODE",
+    8: "COMMENT_NODE",
+    9: "DOCUMENT_NODE",
+    10: "DOCUMENT_TYPE_NODE",
+    11: "DOCUMENT_FRAGMENT_NODE",
+    12: "NOTATION_NODE"
+};

data/jsdoc/app/JsDoc.js

@@ -0,0 +1,103 @@
+/**
+ * @fileOverview
+ * @name JsDoc Toolkit
+ * @author Michael Mathews micmath@gmail.com
+ * @url $HeadURL: https://jsdoc-toolkit.googlecode.com/svn/tags/jsdoc_toolkit-1.4.0b/app/JsDoc.js $
+ * @revision $Id: JsDoc.js 327 2007-11-13 00:18:23Z micmath $
+ * @license <a href="http://en.wikipedia.org/wiki/MIT_License">X11/MIT License</a>
+ *          (See the accompanying README file for full details.)
+ */
+
+/** @class Handle reporting messages to the user.
+	@static
+*/
+LOG = {
+	warn: function(msg, e) {
+		if (e) msg = e.fileName+", line "+e.lineNumber+": "+msg;
+		
+		msg = ">> WARNING: "+msg;
+		LOG.warnings.push(msg);
+		if (LOG.out) LOG.out.write(msg+"\n");
+		else print(msg);
+	},
+
+	inform: function(msg) {
+		msg = " > "+msg;
+		if (LOG.out) LOG.out.write(msg+"\n");
+		else if (typeof VERBOSE != "undefined" && VERBOSE) print(msg);
+	}
+};
+LOG.warnings = [];
+
+/**
+	@class An automated documentation publishing system for JavaScript.
+	@static
+	@author Michael Mathews <a href="mailto:micmath@gmail.com">micmath@gmail.com</a>
+*/
+JsDoc = {
+	/** The version number of this release. */
+	VERSION: "1.4.0b",
+	
+	/**
+	 * Print out the expected usage syntax for this script on the command
+	 * line. This is called automatically by using the -h/--help option.
+	 */
+	usage: function() {
+		print("USAGE: java -jar app/js.jar app/jsdoc.js [OPTIONS] <SRC_DIR> <SRC_FILE> ...");
+		print("");
+		print("OPTIONS:");
+		print("  -t=<PATH> or --template=<PATH>\n          Required. Use this template to format the output.\n");
+		print("  -d=<PATH> or --directory=<PATH>\n          Output to this directory (defaults to js_docs_out).\n");
+		print("  -e=<ENCODING> or --encoding=<ENCODING>\n          Use this encoding to read and write files.\n");
+		
+		print("  -r=<DEPTH> or --recurse=<DEPTH>\n          Descend into src directories.\n");
+		print("  -x=<EXT>[,EXT]... or --ext=<EXT>[,EXT]...\n          Scan source files with the given extension/s (defaults to js).\n");
+		print("  -a or --allfunctions\n          Include all functions, even undocumented ones.\n");
+		print("  -A or --Allfunctions\n          Include all functions, even undocumented, underscored ones.\n");
+		print("  -p or --private\n          Include symbols tagged as private.\n");
+		print("  -o=<PATH> or --out=<PATH>\n          Print log messages to a file (defaults to stdout).\n");
+		print("  -h or --help\n          Show this message and exit.\n");
+		
+		java.lang.System.exit(0);
+	},
+	
+	/**
+	 * @param {string[]} srcFiles Paths to files to be documented
+	 * @return {DocFile[]}
+	 */
+	parse: function(srcFiles) {
+		var files = [];
+		
+		if (typeof srcFiles == "string") srcFiles = [srcFiles];	
+		var parser = new JsParse();
+		
+		srcFiles = srcFiles.sort();
+		
+		var docs = new DocFileGroup();
+		
+		// handle setting up relationships between symbols here
+		for (var f = 0; f < srcFiles.length; f++) {
+			var srcFile = srcFiles[f];
+			
+			LOG.inform("Tokenizing: file "+(f+1)+", "+srcFile);
+			var src = IO.readFile(srcFile);
+			
+			var tokens = new TokenReader(src).tokenize();
+			LOG.inform("\t"+tokens.length+" tokens found.");
+			var ts = new TokenStream(tokens);
+			
+			var file = new DocFile(srcFile);
+			parser.parse(ts);
+			LOG.inform("\t"+parser.symbols.length+" symbols found.");
+			
+			file.addSymbols(parser.symbols, JsDoc.opt);
+			if (parser.overview) file.overview = parser.overview;
+			
+			docs.addDocFile(file);
+		}
+		return docs;
+	}
+};
+
+/** Override this dummy function in your template. */
+function publish() {}

data/jsdoc/app/JsHilite.js

@@ -0,0 +1,45 @@
+/**
+ * @fileOverview
+ * @name JsHilite
+ * @author Michael Mathews micmath@gmail.com
+ * @url $HeadURL: https://jsdoc-toolkit.googlecode.com/svn/tags/jsdoc_toolkit-1.4.0b/app/JsHilite.js $
+ * @revision $Id: JsHilite.js 300 2007-11-11 16:51:53Z micmath $
+ * @license <a href="http://en.wikipedia.org/wiki/MIT_License">X11/MIT License</a>
+ *          (See the accompanying README file for full details.)
+ */
+
+require("app/JsToke.js");
+
+/**
+ * @class Turn source code into HTML with tokens marked for hilighting with CSS.
+ */
+function JsHilite(sourceCode, charset) {
+	this.tokenizer = new TokenReader(sourceCode);
+	this.tokenizer.keepComments = true;
+	this.tokenizer.keepDocs = true;
+	this.tokenizer.keepWhite = true;
+	Token.prototype.toString = function() { 
+		return "<span class=\""+this.type+"\">"+this.data.replace(/</g, "&lt;")+"</span>";
+	}
+	if (!charset) charset = "utf-8";
+	
+	this.header = '<html><head><meta http-equiv="content-type" content="text/html; charset='+charset+'"> '+
+	"<style>\n\
+	.KEYW {color: #933;}\n\
+	.COMM {color: #bbb; font-style: italic;}\n\
+	.NUMB {color: #393;}\n\
+	.STRN {color: #393;}\n\
+	.REGX {color: #339;}\n\
+	.linenumber {border-right: 1px dotted #666; color: #666; font-style: normal;}\n\
+	</style></head><body><pre>";
+	this.footer = "</pre></body></html>";
+	this.showLinenumbers = true;
+}
+
+JsHilite.prototype.hilite = function() {
+	var hilited = this.tokenizer.tokenize().join("");
+	var linenumber = 1;
+	if (this.showLinenumbers) hilited = hilited.replace(/(^|\n)/g, function(m){return m+"<span class='linenumber'>"+((linenumber<10)? " ":"")+((linenumber<100)? " ":"")+(linenumber++)+"</span> "});
+	
+	return this.header+hilited+this.footer;
+}

data/jsdoc/app/JsIO.js

@@ -0,0 +1,163 @@
+/**
+ * @fileOverview
+ * @name JsIO
+ * @author Michael Mathews micmath@gmail.com
+ * @url $HeadURL: https://jsdoc-toolkit.googlecode.com/svn/tags/jsdoc_toolkit-1.4.0b/app/JsIO.js $
+ * @revision $Id: JsIO.js 303 2007-11-11 18:59:08Z micmath $
+ * @license <a href="http://en.wikipedia.org/wiki/MIT_License">X11/MIT License</a>
+ *          (See the accompanying README file for full details.)
+ */
+
+// shortcuts
+FileWriter = Packages.java.io.FileWriter;
+File = Packages.java.io.File;
+
+/**
+ * @class Friendly interface to Java file operations. Requires Rhino.
+ * @static
+ */
+var IO = {
+	FileSeparator: Packages.java.io.File.separator,
+	
+	/**
+	 * Use to save content to a file.
+	 * @param {string} outDir Path to directory to save into.
+	 * @param {string} fileName Name to use for the new file.
+	 * @param {string} content To write to the new file.
+	 */
+	saveFile: function(outDir, fileName, content) {
+        var out = new Packages.java.io.PrintWriter(
+			new Packages.java.io.OutputStreamWriter(
+				new Packages.java.io.FileOutputStream(outDir+IO.FileSeparator+fileName),
+				IO.encoding
+			)
+		);
+        out.write(content);
+        out.flush();
+        out.close();
+    },
+	
+	/**
+	 * Gets the contents of a file.
+	 * @param {path|url} url
+	 * @return {string} The contents of the file at the given location.
+	 */
+	readFile: function(path) {
+        return readFile(path, IO.encoding);
+    },
+	
+	/**
+	 * Use to copy a file from one directory to another. Can take binary files too.
+	 * @param {string} inFile Path to the source file.
+	 * @param {string} outDir Path to directory to save into.
+	 * @param {string} fileName Name to use for the new file.
+	 */
+	copyFile: function(inFile, outDir, fileName) {
+		if (fileName == null) fileName = Util.fileName(inFile);
+	
+		var inFile = new File(inFile);
+		var outFile = new File(outDir+IO.FileSeparator+fileName);
+		
+		var bis = new Packages.java.io.BufferedInputStream(new Packages.java.io.FileInputStream(inFile), 4096);
+		var bos = new Packages.java.io.BufferedOutputStream(new Packages.java.io.FileOutputStream(outFile), 4096);
+		var theChar;
+		while ((theChar = bis.read()) != -1) {
+			bos.write(theChar);
+		}
+		bos.close();
+		bis.close();
+	},
+	
+	/**
+	 * Use to create a new directory.
+	 * @param {string} dirname Path of directory you wish to create.
+	 */
+	makeDir: function(dirName) {
+		(new File(dirName)).mkdir();
+	},
+	
+	/**
+	 * Get recursive list of files in a directory.
+	 * @param {array} dirs Paths to directories to search.
+	 * @param {int} recurse How many levels to descend, defaults to 1.
+	 * @return {array} Paths to found files.
+	 */
+	ls: function(dir, recurse, allFiles, path) {
+		if (path === undefined) { // initially
+			var allFiles = [];
+			var path = [dir];
+		}
+		if (path.length == 0) return allFiles;
+		if (recurse === undefined) recurse = 1;
+		
+		dir = new File(dir);
+		if (!dir.directory) return [String(dir)];
+		var files = dir.list();
+		
+		for (var f = 0; f < files.length; f++) {
+			var file = String(files[f]);
+			if (file.match(/^\.[^\.\/\\]/)) continue; // skip dot files
+
+			if ((new File(path.join("/")+"/"+file)).list()) { // it's a directory
+				path.push(file);
+				if (path.length-1 < recurse) IO.ls(path.join("/"), recurse, allFiles, path);
+				path.pop();
+			}
+			else {
+				allFiles.push((path.join("/")+"/"+file).replace("//", "/"));
+			}
+		}
+
+		return allFiles;
+	},
+	
+	/**
+	 * Check if a filepath exists.
+	 * @author vinces1979
+	 */
+	exists: function(path) {
+		file = new File(path);
+
+		if (file.isDirectory()){
+			return true;
+		}
+		if (!file.exists()){
+			LOG.inform('Path not found: ' + path);
+			return false;
+		}
+		if (!file.canRead()){
+			LOG.inform('Path not readable: ' + path);
+			return false;
+		}
+		return true;
+	},
+	
+	/**
+	 * Create an open filehandle.
+	 * @param {string} path Path to file to open.
+	 * @param {boolean} append Open in append mode?
+	 * @return {FileWriter} A filehandle that can write(string) and close().
+	 */
+	open: function(path, append) {
+        var append = true;
+        var outFile = new Packages.java.io.File(path);
+        var out = new Packages.java.io.PrintWriter(
+			new Packages.java.io.OutputStreamWriter(
+				new Packages.java.io.FileOutputStream(outFile, append),
+				IO.encoding
+			)
+		);
+        return out;
+    },
+    
+    setEncoding: function(encoding) {
+    	if (/ISO-8859-([0-9]+)/i.test(encoding)) {
+    		IO.encoding = "ISO8859_"+RegExp.$1;
+    	}
+    	else {
+    		IO.encoding = encoding
+    	}
+    }
+};
+
+IO.encoding = "utf-8";