xpcomcore-rubygem 0.3.2 → 0.5.0

data/xpcomcore/etc/jsdoc-toolkit/app/lib/JSDOC.js

@@ -1,104 +0,0 @@
-/**
-	@overview
-	@date $Date: 2009-06-21 23:36:33 +0100 (Sun, 21 Jun 2009) $
-	@version $Revision: 801 $ 
-	@location $HeadURL: https://jsdoc-toolkit.googlecode.com/svn/trunk/jsdoc-toolkit/app/lib/JSDOC.js $
-	@name JSDOC.js
- */
-
-/**
-	This is the main container for the JSDOC application.
-	@namespace
-*/
-JSDOC = {
-};
-
-/**
-	@requires Opt
- */
-if (typeof arguments == "undefined") arguments = [];
-JSDOC.opt = Opt.get(
-	arguments, 
-	{
-		a: "allfunctions", 
-		c: "conf",
-		d: "directory",
-		"D[]": "define",
-		e: "encoding",
-		"E[]": "exclude",
-		h: "help",
-		n: "nocode",
-		o: "out",
-		p: "private",
-		q: "quiet",
-		r: "recurse",
-		S: "securemodules",
-		s: "suppress",
-		t: "template",
-		T: "testmode",
-		u: "unique",
-		v: "verbose",
-		x: "ext"
-	}
-);
-
-/** The current version string of this application. */
-JSDOC.VERSION = "2.3.0";
-
-/** Print out usage information and quit. */
-JSDOC.usage = function() {
-	print("USAGE: java -jar jsrun.jar app/run.js [OPTIONS] <SRC_DIR> <SRC_FILE> ...");
-	print("");
-	print("OPTIONS:");
-	print("  -a or --allfunctions\n          Include all functions, even undocumented ones.\n");
-	print("  -c or --conf\n          Load a configuration file.\n");
-	print("  -d=<PATH> or --directory=<PATH>\n          Output to this directory (defaults to \"out\").\n");
-	print("  -D=\"myVar:My value\" or --define=\"myVar:My value\"\n          Multiple. Define a variable, available in JsDoc as JSDOC.opt.D.myVar.\n");
-	print("  -e=<ENCODING> or --encoding=<ENCODING>\n          Use this encoding to read and write files.\n");
-	print("  -E=\"REGEX\" or --exclude=\"REGEX\"\n          Multiple. Exclude files based on the supplied regex.\n");
-	print("  -h or --help\n          Show this message and exit.\n");
-	print("  -n or --nocode\n          Ignore all code, only document comments with @name tags.\n");
-	print("  -o=<PATH> or --out=<PATH>\n          Print log messages to a file (defaults to stdout).\n");
-	print("  -p or --private\n          Include symbols tagged as private, underscored and inner symbols.\n");
-	print("  -q or --quiet\n          Do not output any messages, not even warnings.\n");
-	print("  -r=<DEPTH> or --recurse=<DEPTH>\n          Descend into src directories.\n");
-	print("  -s or --suppress\n          Suppress source code output.\n");
-	print("  -S or --securemodules\n          Use Secure Modules mode to parse source code.\n");
-	print("  -t=<PATH> or --template=<PATH>\n          Required. Use this template to format the output.\n");
-	print("  -T or --test\n          Run all unit tests and exit.\n");
-	print("  -u or --unique\n          Force file names to be unique, but not based on symbol names.\n");
-	print("  -v or --verbose\n          Provide verbose feedback about what is happening.\n");
-	print("  -x=<EXT>[,EXT]... or --ext=<EXT>[,EXT]...\n          Scan source files with the given extension/s (defaults to js).\n");
-	
-	quit();
-}
-
-/*t:
-	plan(4, "Testing JSDOC namespace.");
-	
-	is(
-		typeof JSDOC,
-		"object",
-		"JSDOC.usage is a function."
-	);
-	
-	is(
-		typeof JSDOC.VERSION,
-		"string",
-		"JSDOC.VERSION is a string."
-	);
-	
-	is(
-		typeof JSDOC.usage,
-		"function",
-		"JSDOC.usage is a function."
-	);
-	
-	is(
-		typeof JSDOC.opt,
-		"object",
-		"JSDOC.opt is a object."
-	);
- */
-
-if (this.IO) IO.includeDir("lib/JSDOC/");

data/xpcomcore/etc/jsdoc-toolkit/app/lib/JSDOC/DocComment.js

@@ -1,200 +0,0 @@
-if (typeof JSDOC == "undefined") JSDOC = {};
-
-/**
-	Create a new DocComment. This takes a raw documentation comment,
-	and wraps it in useful accessors.
-	@class Represents a documentation comment object.
- */ 
-JSDOC.DocComment = function(/**String*/comment) {
-	this.init();
-	if (typeof comment != "undefined") {
-		this.parse(comment);
-	}
-}
-
-JSDOC.DocComment.prototype.init = function() {
-	this.isUserComment = true;
-	this.src           = "";
-	this.meta          = "";
-	this.tagTexts      = [];
-	this.tags          = [];
-}
-
-/**
-	@requires JSDOC.DocTag
- */
-JSDOC.DocComment.prototype.parse = function(/**String*/comment) {
-	if (comment == "") {
-		comment = "/** @desc */";
-		this.isUserComment = false;
-	}
-	
-	this.src = JSDOC.DocComment.unwrapComment(comment);
-	
-	this.meta = "";
-	if (this.src.indexOf("#") == 0) {
-		this.src.match(/#(.+[+-])([\s\S]*)$/);
-		if (RegExp.$1) this.meta = RegExp.$1;
-		if (RegExp.$2) this.src = RegExp.$2;
-	}
-	
-	if (typeof JSDOC.PluginManager != "undefined") {
-		JSDOC.PluginManager.run("onDocCommentSrc", this);
-	}
-	
-	this.fixDesc();
-
-	this.src = JSDOC.DocComment.shared+"\n"+this.src;
-	
-	this.tagTexts = 
-		this.src
-		.split(/(^|[\r\n])\s*@/)
-		.filter(function($){return $.match(/\S/)});
-	
-	/**
-		The tags found in the comment.
-		@type JSDOC.DocTag[]
-	 */
-	this.tags = this.tagTexts.map(function($){return new JSDOC.DocTag($)});
-	
-	if (typeof JSDOC.PluginManager != "undefined") {
-		JSDOC.PluginManager.run("onDocCommentTags", this);
-	}
-}
-
-/*t:
-	plan(5, "testing JSDOC.DocComment");
-	requires("../frame/String.js");
-	requires("../lib/JSDOC/DocTag.js");
-	
-	var com = new JSDOC.DocComment("/**@foo some\n* comment here*"+"/");
-	is(com.tagTexts[0], "foo some\ncomment here", "first tag text is found.");
-	is(com.tags[0].title, "foo", "the title is found in a comment with one tag.");
-	
-	var com = new JSDOC.DocComment("/** @foo first\n* @bar second*"+"/");
-	is(com.getTag("bar").length, 1, "getTag() returns one tag by that title.");
-	
-	JSDOC.DocComment.shared = "@author John Smith";
-	var com = new JSDOC.DocComment("/**@foo some\n* comment here*"+"/");
-	is(com.tags[0].title, "author", "shared comment is added.");
-	is(com.tags[1].title, "foo", "shared comment is added to existing tag.");
-*/
-
-/**
-	If no @desc tag is provided, this function will add it.
- */
-JSDOC.DocComment.prototype.fixDesc = function() {
-	if (this.meta && this.meta != "@+") return;
-	if (/^\s*[^@\s]/.test(this.src)) {				
-		this.src = "@desc "+this.src;
-	}
-}
-
-/*t:
-	plan(5, "testing JSDOC.DocComment#fixDesc");
-	
-	var com = new JSDOC.DocComment();
-	
-	com.src = "this is a desc\n@author foo";
-	com.fixDesc();
-	is(com.src, "@desc this is a desc\n@author foo", "if no @desc tag is provided one is added.");
-
-	com.src = "x";
-	com.fixDesc();
-	is(com.src, "@desc x", "if no @desc tag is provided one is added to a single character.");
-
-	com.src = "\nx";
-	com.fixDesc();
-	is(com.src, "@desc \nx", "if no @desc tag is provided one is added to return and character.");
-	
-	com.src = " ";
-	com.fixDesc();
-	is(com.src, " ", "if no @desc tag is provided one is not added to just whitespace.");
-
-	com.src = "";
-	com.fixDesc();
-	is(com.src, "", "if no @desc tag is provided one is not added to empty.");
-*/
-
-/**
-	Remove slash-star comment wrapper from a raw comment string.
-	@type String
- */
-JSDOC.DocComment.unwrapComment = function(/**String*/comment) {
-	if (!comment) return "";
-	var unwrapped = comment.replace(/(^\/\*\*|\*\/$)/g, "").replace(/^\s*\* ?/gm, "");
-	return unwrapped;
-}
-
-/*t:
-	plan(5, "testing JSDOC.DocComment.unwrapComment");
-	
-	var com = "/**x*"+"/";
-	var unwrapped = JSDOC.DocComment.unwrapComment(com);
-	is(unwrapped, "x", "a single character jsdoc is found.");
-	
-	com = "/***x*"+"/";
-	unwrapped = JSDOC.DocComment.unwrapComment(com);
-	is(unwrapped, "x", "three stars are allowed in the opener.");
-	
-	com = "/****x*"+"/";
-	unwrapped = JSDOC.DocComment.unwrapComment(com);
-	is(unwrapped, "*x", "fourth star in the opener is kept.");
-	
-	com = "/**x\n * y\n*"+"/";
-	unwrapped = JSDOC.DocComment.unwrapComment(com);
-	is(unwrapped, "x\ny\n", "leading stars and spaces are trimmed.");
-	
-	com = "/**x\n *   y\n*"+"/";
-	unwrapped = JSDOC.DocComment.unwrapComment(com);
-	is(unwrapped, "x\n  y\n", "only first space after leading stars are trimmed.");
-*/
-
-/**
-	Provides a printable version of the comment.
-	@type String
- */
-JSDOC.DocComment.prototype.toString = function() {
-	return this.src;
-}
-
-/*t:
-	plan(1, "testing JSDOC.DocComment#fixDesc");
-	var com = new JSDOC.DocComment();
-	com.src = "foo";
-	is(""+com, "foo", "stringifying a comment returns the unwrapped src.");
-*/
-
-/**
-	Given the title of a tag, returns all tags that have that title.
-	@type JSDOC.DocTag[]
- */
-JSDOC.DocComment.prototype.getTag = function(/**String*/tagTitle) {
-	return this.tags.filter(function($){return $.title == tagTitle});
-}
-
-/*t:
-	plan(1, "testing JSDOC.DocComment#getTag");
-	requires("../frame/String.js");
-	requires("../lib/JSDOC/DocTag.js");
-	
-	var com = new JSDOC.DocComment("/**@foo some\n* @bar\n* @bar*"+"/");
-	is(com.getTag("bar").length, 2, "getTag returns expected number of tags.");
-*/
-
-/**
-	Used to store the currently shared tag text.
-*/
-JSDOC.DocComment.shared = "";
-
-/*t:
-	plan(2, "testing JSDOC.DocComment.shared");
-	requires("../frame/String.js");
-	requires("../lib/JSDOC/DocTag.js");
-	
-	JSDOC.DocComment.shared = "@author Michael";
-	
-	var com = new JSDOC.DocComment("/**@foo\n* @foo*"+"/");
-	is(com.getTag("author").length, 1, "getTag returns shared tag.");
-	is(com.getTag("foo").length, 2, "getTag returns unshared tags too.");
-*/

data/xpcomcore/etc/jsdoc-toolkit/app/lib/JSDOC/DocTag.js

@@ -1,294 +0,0 @@
-if (typeof JSDOC == "undefined") JSDOC = {};
-
-/**
-	@constructor
- */
-JSDOC.DocTag = function(src) {
-	this.init();
-	if (typeof src != "undefined") {
-		this.parse(src);
-	}
-}
-
-/**
-	Create and initialize the properties of this.
- */
-JSDOC.DocTag.prototype.init = function() {
-	this.title        = "";
-	this.type         = "";
-	this.name         = "";
-	this.isOptional   = false;
-	this.defaultValue = "";
-	this.desc         = "";
-	
-	return this;
-}
-
-/**
-	Populate the properties of this from the given tag src.
-	@param {string} src
- */
-JSDOC.DocTag.prototype.parse = function(src) {
-	if (typeof src != "string") throw "src must be a string not "+(typeof src);
-
-	try {
-		src = this.nibbleTitle(src);
-		if (JSDOC.PluginManager) {
-			JSDOC.PluginManager.run("onDocTagSynonym", this);
-		}
-		
-		src = this.nibbleType(src);
-		
-		// only some tags are allowed to have names.
-		if (this.title == "param" || this.title == "property" || this.title == "config") { // @config is deprecated
-			src = this.nibbleName(src);
-		}
-	}
-	catch(e) {
-		if (LOG) LOG.warn(e);
-		else throw e;
-	}
-	this.desc = src; // whatever is left
-	
-	// example tags need to have whitespace preserved
-	if (this.title != "example") this.desc = this.desc.trim();
-	
-	if (JSDOC.PluginManager) {
-		JSDOC.PluginManager.run("onDocTag", this);
-	}
-}
-
-/**
-	Automatically called when this is stringified.
- */
-JSDOC.DocTag.prototype.toString = function() {
-	return this.desc;
-}
-
-/*t:
-	plan(1, "testing JSDOC.DocTag#toString");
-	
-	var tag = new JSDOC.DocTag("param {object} date A valid date.");
-	is(""+tag, "A valid date.", "stringifying a tag returns the desc.");
- */
-
-/**
-	Find and shift off the title of a tag.
-	@param {string} src
-	@return src
- */
-JSDOC.DocTag.prototype.nibbleTitle = function(src) {
-	if (typeof src != "string") throw "src must be a string not "+(typeof src);
-	
-	var parts = src.match(/^\s*(\S+)(?:\s([\s\S]*))?$/);
-
-	if (parts && parts[1]) this.title = parts[1];
-	if (parts && parts[2]) src = parts[2];
-	else src = "";
-	
-	return src;
-}
-
-/*t:
-	plan(8, "testing JSDOC.DocTag#nibbleTitle");
-	
-	var tag = new JSDOC.DocTag();
-	
-	tag.init().nibbleTitle("aTitleGoesHere");
-	is(tag.title, "aTitleGoesHere", "a title can be found in a single-word string.");
-	
-	var src = tag.init().nibbleTitle("aTitleGoesHere and the rest");
-	is(tag.title, "aTitleGoesHere", "a title can be found in a multi-word string.");
-	is(src, "and the rest", "the rest is returned when the title is nibbled off.");
-	
-	src = tag.init().nibbleTitle("");
-	is(tag.title, "", "given an empty string the title is empty.");
-	is(src, "", "the rest is empty when the tag is empty.");
-
-	var src = tag.init().nibbleTitle(" aTitleGoesHere\n  a description");
-	is(tag.title, "aTitleGoesHere", "leading and trailing spaces are not part of the title.");
-	is(src, "  a description", "leading spaces (less one) are part of the description.");
-
-	tag.init().nibbleTitle("a.Title::Goes_Here foo");
-	is(tag.title, "a.Title::Goes_Here", "titles with punctuation are allowed.");
- */
-
-/**
-	Find and shift off the type of a tag.
-	@requires frame/String.js
-	@param {string} src
-	@return src
- */
-JSDOC.DocTag.prototype.nibbleType = function(src) {
-	if (typeof src != "string") throw "src must be a string not "+(typeof src);
-	
-	if (src.match(/^\s*\{/)) {
-		var typeRange = src.balance("{", "}");
-		if (typeRange[1] == -1) {
-			throw "Malformed comment tag ignored. Tag type requires an opening { and a closing }: "+src;
-		}
-		this.type = src.substring(typeRange[0]+1, typeRange[1]).trim();
-		this.type = this.type.replace(/\s*,\s*/g, "|"); // multiples can be separated by , or |
-		src = src.substring(typeRange[1]+1);
-	}
-	
-	return src;
-}
-
-/*t:
-	plan(5, "testing JSDOC.DocTag.parser.nibbleType");
-	requires("../frame/String.js");
-	
-	var tag = new JSDOC.DocTag();
-	
-	tag.init().nibbleType("{String[]} aliases");
-	is(tag.type, "String[]", "type can have non-alpha characters.");
-	
-	tag.init().nibbleType("{ aTypeGoesHere  } etc etc");
-	is(tag.type, "aTypeGoesHere", "type is trimmed.");
-	
-	tag.init().nibbleType("{ oneType, twoType ,\n threeType  } etc etc");
-	is(tag.type, "oneType|twoType|threeType", "multiple types can be separated by commas.");
-	
-	var error;
-	try { tag.init().nibbleType("{widget foo"); }
-	catch(e) { error = e; }
-	is(typeof error, "string", "malformed tag type throws error.");
-	isnt(error.indexOf("Malformed"), -1, "error message tells tag is malformed.");
- */
-
-/**
-	Find and shift off the name of a tag.
-	@requires frame/String.js
-	@param {string} src
-	@return src
- */
-JSDOC.DocTag.prototype.nibbleName = function(src) {
-	if (typeof src != "string") throw "src must be a string not "+(typeof src);
-	
-	src = src.trim();
-	
-	// is optional?
-	if (src.charAt(0) == "[") {
-		var nameRange = src.balance("[", "]");
-		if (nameRange[1] == -1) {
-			throw "Malformed comment tag ignored. Tag optional name requires an opening [ and a closing ]: "+src;
-		}
-		this.name = src.substring(nameRange[0]+1, nameRange[1]).trim();
-		this.isOptional = true;
-		
-		src = src.substring(nameRange[1]+1);
-		
-		// has default value?
-		var nameAndValue = this.name.split("=");
-		if (nameAndValue.length) {
-			this.name = nameAndValue.shift().trim();
-			this.defaultValue = nameAndValue.join("=");
-		}
-	}
-	else {
-		var parts = src.match(/^(\S+)(?:\s([\s\S]*))?$/);
-		if (parts) {
-			if (parts[1]) this.name = parts[1];
-			if (parts[2]) src = parts[2].trim();
-			else src = "";
-		}
-	}	
-
-	return src;
-}
-
-/*t:
-	requires("../frame/String.js");
-	plan(9, "testing JSDOC.DocTag.parser.nibbleName");
-	
-	var tag = new JSDOC.DocTag();
-	
-	tag.init().nibbleName("[foo] This is a description.");
-	is(tag.isOptional, true, "isOptional syntax is detected.");
-	is(tag.name, "foo", "optional param name is found.");
- 	
-	tag.init().nibbleName("[foo] This is a description.");
-	is(tag.isOptional, true, "isOptional syntax is detected when no type.");
-	is(tag.name, "foo", "optional param name is found when no type.");
-	
-	tag.init().nibbleName("[foo=7] This is a description.");
- 	is(tag.name, "foo", "optional param name is found when default value.");
- 	is(tag.defaultValue, 7, "optional param default value is found when default value.");
- 	
- 	//tag.init().nibbleName("[foo= a value] This is a description.");
- 	//is(tag.defaultValue, " a value", "optional param default value is found when default value has spaces (issue #112).");
- 	
- 	tag.init().nibbleName("[foo=[]] This is a description.");
- 	is(tag.defaultValue, "[]", "optional param default value is found when default value is [] (issue #95).");
- 	
- 	tag.init().nibbleName("[foo=a=b] This is a description.");
- 	is(tag.name, "foo", "optional param name is found when default value is a=b.");
- 	is(tag.defaultValue, "a=b", "optional param default value is found when default value is a=b.")
- */
-
-/*t:
-	plan(32, "Testing JSDOC.DocTag.parser.");
-	requires("../frame/String.js");
-	
- 	var tag = new JSDOC.DocTag();
- 	
- 	is(typeof tag, "object", "JSDOC.DocTag.parser with an empty string returns an object.");
- 	is(typeof tag.title, "string", "returned object has a string property 'title'.");
- 	is(typeof tag.type, "string", "returned object has a string property 'type'.");
- 	is(typeof tag.name, "string", "returned object has a string property 'name'.");
- 	is(typeof tag.defaultValue, "string", "returned object has a string property 'defaultValue'.");
- 	is(typeof tag.isOptional, "boolean", "returned object has a boolean property 'isOptional'.");
- 	is(typeof tag.desc, "string", "returned object has a string property 'desc'.");
-  
-  	tag = new JSDOC.DocTag("param {widget} foo");
-  	is(tag.title, "param", "param title is found.");
-  	is(tag.name, "foo", "param name is found when desc is missing.");
- 	is(tag.desc, "", "param desc is empty when missing.");
- 	
- 	tag = new JSDOC.DocTag("param {object} date A valid date.");
- 	is(tag.name, "date", "param name is found with a type.");
- 	is(tag.type, "object", "param type is found.");
- 	is(tag.desc, "A valid date.", "param desc is found with a type.");
- 	
-  	tag = new JSDOC.DocTag("param aName a description goes\n    here.");
-	is(tag.name, "aName", "param name is found without a type.");
- 	is(tag.desc, "a description goes\n    here.", "param desc is found without a type.");
- 	
- 	tag = new JSDOC.DocTag("param {widget}");
- 	is(tag.name, "", "param name is empty when it is not given.");
-	
-	tag = new JSDOC.DocTag("param {widget} [foo] This is a description.");
-	is(tag.name, "foo", "optional param name is found.");
-	
-	tag = new JSDOC.DocTag("return {aType} This is a description.");
-	is(tag.type, "aType", "when return tag has no name, type is found.");
-	is(tag.desc, "This is a description.", "when return tag has no name, desc is found.");
-	
-	tag = new JSDOC.DocTag("author Joe Coder <jcoder@example.com>");
-	is(tag.title, "author", "author tag has a title.");
-	is(tag.type, "", "the author tag has no type.");
-	is(tag.name, "", "the author tag has no name.");
-	is(tag.desc, "Joe Coder <jcoder@example.com>", "author tag has desc.");
-	
-	tag = new JSDOC.DocTag("private \t\n  ");
-	is(tag.title, "private", "private tag has a title.");
-	is(tag.type, "", "the private tag has no type.");
-	is(tag.name, "", "the private tag has no name.");
-	is(tag.desc, "", "private tag has no desc.");
-
-	tag = new JSDOC.DocTag("example\n   example(code);\n   more();");
-	is(tag.desc, "   example(code);\n   more();", "leading whitespace (less one) in examples code is preserved.");
-	
-	tag = new JSDOC.DocTag("param theName  \n");
-	is(tag.name, "theName", "name only is found.");
-	
-	tag = new JSDOC.DocTag("type theDesc  \n");
-	is(tag.desc, "theDesc", "desc only is found.");
-	
-	tag = new JSDOC.DocTag("type {theType} \n");
-	is(tag.type, "theType", "type only is found.");
-	
-	tag = new JSDOC.DocTag("");
-	is(tag.title, "", "title is empty when tag is empty.");
- */