1 //<script type="text/javascript">
3 XObject = imports.XObject.XObject;
5 SymbolSet = imports.SymbolSet.SymbolSet;
6 //Parser = imports.Parser.Parser;
7 DocComment = imports.DocComment.DocComment;
8 DocTag = imports.DocTag.DocTag;
11 @class Represents a symbol in the source code.
13 Symbol = XObject.define(
16 if (arguments.length) this.populate.apply(this, arguments);
26 $args : [], // original arguments used when constructing.
29 augments : [], // Doctag[]
37 exceptions : [], // Doctag[]
38 inherits : [], // Doctag[]
40 isa : "OBJECT", // OBJECT//FUNCTION
49 methods : [], // Symbol[]
51 _params : [], //Doctag[]
52 properties : [], //Doctag[]
53 requires : [], //Doctag[]
54 returns : [], //Doctag[]
69 function array2object(a)
73 a.forEach(function(e) {
81 if (Symbol.hide.indexOf(i) > -1) {
84 switch (typeof(this[i])) {
100 ret[i] = array2object(this[i],true);
106 print(JSON.stringify(this[i]));
107 ret[i] = this[i].toObject();
111 print("object? :" + i);
118 ret[i] = this[i]; continue;
120 print("unknown type:" + typeof(this[i]));
130 // only initialize arrays / objects..
135 this.exceptions = [];
137 //this.inheritsFrom = [];
138 this.isa = "OBJECT"; // OBJECT//FUNCTION
141 this.properties = [];
146 this.childClasses = [];
149 this.comment = new DocComment();
150 this.comment.isUserComment = false;
155 serialize : function() {
157 for (var p in this) {
163 for (var i in keys) {
164 if (typeof this[keys[i]] == "function") continue;
165 out += " " +keys[i]+" => "+
167 (typeof(this[keys[i]]) != "object") ?
169 "[" +typeof(this[keys[i]])+"]"
173 return "\n{\n" + out + "}\n";
177 var clone = new Symbol();
178 clone.populate.apply(clone, this.$args); // repopulate using the original arguments
179 clone.srcFile = this.srcFile; // not the current srcFile, the one when the original was made
186 //__defineSetter__("name",
187 setName : function(n) {
188 n = n.replace(/^_global_[.#-]/, "");
189 n = n.replace(/\.prototype\.?/g, '#');
190 n = n.replace(/#$/g, '');
192 this.name = n; // real!
195 //__defineGetter__("name",
196 getName : function() { return this._name; },
198 //__defineSetter__("params",
199 setParams :function(v) {
200 for (var i = 0, l = v.length; i < l; i++) {
201 if (v[i].constructor != DocTag) { // may be a generic object parsed from signature, like {type:..., name:...}
202 var ty = v[i].hasOwnProperty('type') ? v[i].type : '';
203 this._params[i] = new DocTag(
204 "param"+((ty)?" {"+ty+"}":"")+" "+v[i].name);
207 this._params[i] = v[i];
210 this.params = this._params;
215 //__defineGetter__("params",
216 getParams : function() { return this._params; },
221 /** Object[] */ params,
223 /** DocComment */ comment
225 this.$args = arguments;
226 //println("Symbol created: " + isa + ":" + name);
228 this.alias = this.getName();
229 this.setParams(params);
230 this.isa = (isa == "VIRTUAL")? "OBJECT":isa;
231 this.comment = comment || new DocComment("");
232 this.srcFile = Symbol.srcFile;
236 if (this.is("FILE") && !this.alias) this.alias = this.srcFile;
240 //if (typeof PluginManager != "undefined") {
241 // PluginManager.run("onSymbol", this);
245 setTags : function() {
247 var authors = this.comment.getTag("author");
248 if (authors.length) {
249 this.author = authors.map(function($){return $.desc;}).join(", ");
253 assert("testing Symbol");
255 requires("../lib/JSDOC/DocComment.js");
256 requires("../frame/String.js");
257 requires("../lib/JSDOC/DocTag.js");
259 var sym = new Symbol("foo", [], "OBJECT", new DocComment("/**@author Joe Smith*"+"/"));
260 assertEqual(sym.author, "Joe Smith", "@author tag, author is found.");
263 var mth = this.comment.getTag("method");
265 this.isa = "FUNCTION";
268 var descs = this.comment.getTag("desc");
270 this.desc = descs.map(function($){return $.desc;}).join("\n"); // multiple descriptions are concatenated into one
274 var sym = new Symbol("foo", [], "OBJECT", new DocComment("/**@desc This is a description.*"+"/"));
275 assertEqual(sym.desc, "This is a description.", "@desc tag, description is found.");
279 if (this.is("FILE")) {
280 if (!this.alias) this.alias = this.srcFile;
282 var overviews = this.comment.getTag("overview");
283 if (overviews.length) {
284 this.desc = [this.desc].concat(overviews.map(function($){return $.desc;})).join("\n");
289 var sym = new Symbol("foo", [], "FILE", new DocComment("/**@overview This is an overview.*"+"/"));
290 assertEqual(sym.desc, "\nThis is an overview.", "@overview tag, description is found.");
294 var sinces = this.comment.getTag("since");
296 this.since = sinces.map(function($){return $.desc;}).join(", ");
300 var sym = new Symbol("foo", [], "FILE", new DocComment("/**@since 1.01*"+"/"));
301 assertEqual(sym.since, "1.01", "@since tag, description is found.");
305 if (this.comment.getTag("constant").length) {
306 this.isConstant = true;
311 var sym = new Symbol("foo", [], "FILE", new DocComment("/**@constant*"+"/"));
312 assertEqual(sym.isConstant, true, "@constant tag, isConstant set.");
316 var versions = this.comment.getTag("version");
317 if (versions.length) {
318 this.version = versions.map(function($){return $.desc;}).join(", ");
322 var sym = new Symbol("foo", [], "FILE", new DocComment("/**@version 2.0x*"+"/"));
323 assertEqual(sym.version, "2.0x", "@version tag, version is found.");
327 var deprecateds = this.comment.getTag("deprecated");
328 if (deprecateds.length) {
329 this.deprecated = deprecateds.map(function($){return $.desc;}).join("\n");
333 var sym = new Symbol("foo", [], "FILE", new DocComment("/**@deprecated Use other method.*"+"/"));
334 assertEqual(sym.deprecated, "Use other method.", "@deprecated tag, desc is found.");
338 var examples = this.comment.getTag("example");
339 if (examples.length) {
340 this.example = examples[0];
344 var sym = new Symbol("foo", [], "FILE", new DocComment("/**@example This\n is an example.*"+"/"));
345 assertEqual(sym.example, "This\n is an example.", "@deprecated tag, desc is found.");
349 var sees = this.comment.getTag("see");
351 var thisSee = this.see;
352 sees.map(function($){thisSee.push($.desc);});
356 var sym = new Symbol("foo", [], "FILE", new DocComment("/**@see The other thing.*"+"/"));
357 assertEqual(sym.see, "The other thing.", "@see tag, desc is found.");
361 var classes = this.comment.getTag("class");
362 if (classes.length) {
363 this.isa = "CONSTRUCTOR";
364 this.classDesc = classes[0].desc; // desc can't apply to the constructor as there is none.
365 if (!this.classDesc) {
366 this.classDesc = this.desc;
373 var sym = new Symbol("foo", [], "OBJECT", new DocComment("/**@class This describes the class.*"+"/"));
374 assertEqual(sym.isa, "CONSTRUCTOR", "@class tag, makes symbol a constructor.");
375 assertEqual(sym.classDesc, "This describes the class.", "@class tag, class description is found.");
379 var namespaces = this.comment.getTag("namespace");
380 if (namespaces.length) {
381 this.classDesc = namespaces[0].desc+"\n"+this.desc; // desc can't apply to the constructor as there is none.
382 this.isNamespace = true;
386 var sym = new Symbol("foo", [], "OBJECT", new DocComment("/**@namespace This describes the namespace.*"+"/"));
387 assertEqual(sym.classDesc, "This describes the namespace.\n", "@namespace tag, class description is found.");
391 var params = this.comment.getTag("param");
393 // user-defined params overwrite those with same name defined by the parser
394 var thisParams = this.getParams();
396 if (thisParams.length == 0) { // none exist yet, so just bung all these user-defined params straight in
397 this.setParams(params);
399 else { // need to overlay these user-defined params on to existing parser-defined params
400 for (var i = 0, l = params.length; i < l; i++) {
402 if (params[i].type) thisParams[i].type = params[i].type;
403 thisParams[i].name = params[i].name;
404 thisParams[i].desc = params[i].desc;
405 thisParams[i].isOptional = params[i].isOptional;
406 thisParams[i].defaultValue = params[i].defaultValue;
408 else thisParams[i] = params[i];
414 var sym = new Symbol("foo", [{type: "array", name: "pages"}], "FUNCTION", new DocComment("/**Description.*"+"/"));
415 assertEqual(sym.params.length, 1, "parser defined param is found.");
417 sym = new Symbol("foo", [], "FUNCTION", new DocComment("/**Description.\n@param {array} pages*"+"/"));
418 assertEqual(sym.params.length, 1, "user defined param is found.");
419 assertEqual(sym.params[0].type, "array", "user defined param type is found.");
420 assertEqual(sym.params[0].name, "pages", "user defined param name is found.");
422 sym = new Symbol("foo", [{type: "array", name: "pages"}], "FUNCTION", new DocComment("/**Description.\n@param {string} uid*"+"/"));
423 assertEqual(sym.params.length, 1, "user defined param overwrites parser defined param.");
424 assertEqual(sym.params[0].type, "string", "user defined param type overwrites parser defined param type.");
425 assertEqual(sym.params[0].name, "uid", "user defined param name overwrites parser defined param name.");
427 sym = new Symbol("foo", [{type: "array", name: "pages"}, {type: "number", name: "count"}], "FUNCTION", new DocComment("/**Description.\n@param {string} uid*"+"/"));
428 assertEqual(sym.params.length, 2, "user defined params overlay parser defined params.");
429 assertEqual(sym.params[1].type, "number", "user defined param type overlays parser defined param type.");
430 assertEqual(sym.params[1].name, "count", "user defined param name overlays parser defined param name.");
432 sym = new Symbol("foo", [], "FUNCTION", new DocComment("/**Description.\n@param {array} pages The pages description.*"+"/"));
433 assertEqual(sym.params.length, 1, "user defined param with description is found.");
434 assertEqual(sym.params[0].desc, "The pages description.", "user defined param description is found.");
438 if (this.comment.getTag("constructor").length) {
439 this.isa = "CONSTRUCTOR";
443 var sym = new Symbol("foo", [], "OBJECT", new DocComment("/**@constructor*"+"/"));
444 assertEqual(sym.isa, "CONSTRUCTOR", "@constructor tag, makes symbol a constructor.");
448 if (this.comment.getTag("static").length) {
449 this.isStatic = true;
450 if (this.isa == "CONSTRUCTOR") {
451 this.isNamespace = true;
456 if (this.comment.getTag("singleton").length) {
457 this.isStatic = true;
458 //if (this.isa == "CONSTRUCTOR") {
459 // this.isNamespace = true;
466 var sym = new Symbol("foo", [], "OBJECT", new DocComment("/**@static\n@constructor*"+"/"));
467 assertEqual(sym.isStatic, true, "@static tag, makes isStatic true.");
468 assertEqual(sym.isNamespace, true, "@static and @constructor tag, makes isNamespace true.");
472 if (this.comment.getTag("inner").length) {
474 this.isStatic = false;
478 var sym = new Symbol("foo", [], "OBJECT", new DocComment("/**@inner*"+"/"));
479 assertEqual(sym.isStatic, false, "@inner tag, makes isStatic false.");
480 assertEqual(sym.isInner, true, "@inner makes isInner true.");
484 if (this.comment.getTag("field").length) {
489 var sym = new Symbol("foo", [], "FUNCTION", new DocComment("/**@field*"+"/"));
490 assertEqual(sym.isa, "OBJECT", "@field tag, makes symbol an object.");
494 if (this.comment.getTag("function").length) {
495 this.isa = "FUNCTION";
499 if (this.comment.getTag("param").length && this.isa == "OBJECT" ) {
500 // change a property to a function..
501 this.isa = "FUNCTION";
506 var sym = new Symbol("foo", [], "OBJECT", new DocComment("/**@function*"+"/"));
507 assertEqual(sym.isa, "FUNCTION", "@function tag, makes symbol a function.");
511 var events = this.comment.getTag("event");
513 this.isa = "FUNCTION";
518 var sym = new Symbol("foo", [], "OBJECT", new DocComment("/**@event*"+"/"));
519 assertEqual(sym.isa, "FUNCTION", "@event tag, makes symbol a function.");
520 assertEqual(sym.isEvent, true, "@event makes isEvent true.");
524 var names = this.comment.getTag("name");
526 this.setName(names[0].desc);
534 var properties = this.comment.getTag("property");
535 if (properties.length) {
536 thisProperties = this.properties;
537 for (var i = 0; i < properties.length; i++) {
538 var property = new Symbol(this.alias+"#"+properties[i].name, [], "OBJECT", new DocComment("/**"+properties[i].desc+"\n@name "+properties[i].name+"\n@memberOf "+this.alias+"#*/"));
539 // TODO: shouldn't the following happen in the addProperty method of Symbol?
540 property.name = properties[i].name;
541 property.memberOf = this.alias;
542 if (properties[i].type) property.type = properties[i].type;
543 if (properties[i].defaultValue) property.defaultValue = properties[i].defaultValue;
544 this.addProperty(property);
545 imports.Parser.Parser.addSymbol(property);
550 var conf = this.comment.getTag("cfg");
552 for (var i = 0; i < conf.length; i++) {
553 this.addConfig(conf[i]);
562 var returns = this.comment.getTag("return");
563 if (returns.length) { // there can be many return tags in a single doclet
564 this.returns = returns;
565 this.type = returns.map(function($){return $.type}).join(", ");
573 this.exceptions = this.comment.getTag("throws");
580 var requires = this.comment.getTag("requires");
581 if (requires.length) {
582 this.requires = requires.map(function($){return $.desc});
590 var types = this.comment.getTag("type");
592 this.type = types[0].desc; //multiple type tags are ignored
600 if (this.comment.getTag("private").length || this.isInner) {
601 this.isPrivate = true;
605 if (this.comment.getTag("ignore").length) {
606 this.isIgnored = true;
613 // @inherits ... as ...
614 var inherits = this.comment.getTag("inherits");
615 if (inherits.length) {
616 for (var i = 0; i < inherits.length; i++) {
617 if (/^\s*([a-z$0-9_.#-]+)(?:\s+as\s+([a-z$0-9_.#]+))?/i.test(inherits[i].desc)) {
618 var inAlias = RegExp.$1;
619 var inAs = RegExp.$2 || inAlias;
621 if (inAlias) inAlias = inAlias.replace(/\.prototype\.?/g, "#");
624 inAs = inAs.replace(/\.prototype\.?/g, "#");
625 inAs = inAs.replace(/^this\.?/, "#");
628 if (inAs.indexOf(inAlias) != 0) { //not a full namepath
630 if (this.alias.charAt(this.alias.length-1) == "#" || inAs.charAt(0) == "#") {
633 inAs = this.alias + joiner + inAs;
636 this.inherits.push({alias: inAlias, as: inAs});
645 this.augments = this.comment.getTag("augments");
648 if (this.comment.getTag("extends")) {
649 this.augments = this.comment.getTag("extends");
654 var defaults = this.comment.getTag("default");
655 if (defaults.length) {
656 if (this.is("OBJECT")) {
657 this.defaultValue = defaults[0].desc;
666 var memberOfs = this.comment.getTag("memberOf");
667 if (memberOfs.length) {
668 this.memberOf = memberOfs[0].desc;
669 this.memberOf = this.memberOf.replace(/\.prototype\.?/g, "#");
677 if (this.comment.getTag("public").length) {
678 this.isPrivate = false;
686 is : function(what) {
687 return this.isa === what;
690 isBuiltin : function() {
691 return SymbolSet.isBuiltin(this.alias);
694 setType : function(/**String*/comment, /**Boolean*/overwrite) {
695 if (!overwrite && this.type) return;
696 var typeComment = DocComment.unwrapComment(comment);
697 this.type = typeComment;
700 inherit : function(symbol) {
701 if (!this.hasMember(symbol.name) && !symbol.isInner) {
702 if (symbol.is("FUNCTION"))
703 this.methods.push(symbol);
704 else if (symbol.is("OBJECT"))
705 this.properties.push(symbol);
709 hasMember : function(name) {
710 return (this.hasMethod(name) || this.hasProperty(name));
713 addMember : function(symbol) {
714 //println("ADDMEMBER: " + this.name + " ++ " + symbol.name);
716 if (symbol.comment.getTag("cfg").length == 1) {
717 symbol.comment.getTag("cfg")[0].memberOf = this.alias;
718 this.addConfig(symbol.comment.getTag("cfg")[0]);
722 if (symbol.is("FUNCTION")) { this.addMethod(symbol); }
723 else if (symbol.is("OBJECT")) { this.addProperty(symbol); }
726 hasMethod : function(name) {
727 var thisMethods = this.methods;
728 for (var i = 0, l = thisMethods.length; i < l; i++) {
729 if (thisMethods[i].name == name) return true;
730 if (thisMethods[i].alias == name) return true;
735 addMethod : function(symbol) {
736 var methodAlias = symbol.alias;
737 var thisMethods = this.methods;
738 for (var i = 0, l = thisMethods.length; i < l; i++) {
739 if (thisMethods[i].alias == methodAlias) {
740 thisMethods[i] = symbol; // overwriting previous method
744 thisMethods.push(symbol); // new method with this alias
747 hasProperty : function(name) {
748 var thisProperties = this.properties;
749 for (var i = 0, l = thisProperties.length; i < l; i++) {
750 if (thisProperties[i].name == name) return true;
751 if (thisProperties[i].alias == name) return true;
756 addProperty : function(symbol) {
757 var propertyAlias = symbol.alias;
758 var thisProperties = this.properties;
759 for (var i = 0, l = thisProperties.length; i < l; i++) {
760 if (thisProperties[i].alias == propertyAlias) {
761 thisProperties[i] = symbol; // overwriting previous property
766 thisProperties.push(symbol); // new property with this alias
769 addDocTag : function(docTag)
771 this.comment.tags.push(docTag);
772 if (docTag.title == 'cfg') {
773 this.addConfig(docTag);
778 addConfig : function(docTag)
780 if (typeof(docTag['memberOf']) == 'undefined') {
781 // remove prototype data...
782 //var a = this.alias.split('#')[0];
783 //docTag.memberOf = a;
784 docTag.memberOf = this.alias;
786 if (typeof(this.cfgs[docTag.name]) == 'undefined') {
787 this.cfgs[docTag.name] = docTag;
791 configToArray: function()
794 for(var ci in this.cfgs) {
795 // dont show hidden!!
796 if (this.cfgs[ci].desc.match(/@hide/)) {
799 r.push(this.cfgs[ci]);
807 * Elements that are not serialized
811 '$args' // not needed AFAIK
814 Symbol.srcFile = ""; //running reference to the current file being parsed
817 Symbol.fromDump = function(t)
819 var ns = new Symbol();
821 if (typeof(ns[i]) == "undefined") {
822 println("ERR:no default for Symbol:"+ i);