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[]
70 var ret = { '*object' : 'Symbol' };
72 if (Symbol.hide.indexOf(i) > -1) {
75 switch (typeof(this[i])) {
91 case 'cfgs': // key val of doctags..
102 print("object? :" + i);
110 ret[i] = this[i]; continue;
113 print("unknown type:" + typeof(this[i]));
114 print(JSON.stringify(this));
124 // only initialize arrays / objects..
129 this.exceptions = [];
132 this.isa = "OBJECT"; // OBJECT//FUNCTION
135 this.properties = [];
144 this.inheritsFrom = [];
145 this.childClasses = [];
147 this.comment = new DocComment();
148 this.comment.isUserComment = false;
153 serialize : function() {
155 for (var p in this) {
161 for (var i in keys) {
162 if (typeof this[keys[i]] == "function") continue;
163 out += " " +keys[i]+" => "+
165 (typeof(this[keys[i]]) != "object") ?
167 "[" +typeof(this[keys[i]])+"]"
171 return "\n{\n" + out + "}\n";
175 var clone = new Symbol();
176 clone.populate.apply(clone, this.$args); // repopulate using the original arguments
177 clone.srcFile = this.srcFile; // not the current srcFile, the one when the original was made
184 //__defineSetter__("name",
185 setName : function(n) {
186 n = n.replace(/^_global_[.#-]/, "");
187 n = n.replace(/\.prototype\.?/g, '#');
188 n = n.replace(/#$/g, '');
190 this.name = n; // real!
193 //__defineGetter__("name",
194 getName : function() { return this._name; },
196 //__defineSetter__("params",
197 setParams :function(v) {
198 for (var i = 0, l = v.length; i < l; i++) {
199 if (v[i].constructor != DocTag) { // may be a generic object parsed from signature, like {type:..., name:...}
200 var ty = v[i].hasOwnProperty('type') ? v[i].type : '';
201 this._params[i] = new DocTag(
202 "param"+((ty)?" {"+ty+"}":"")+" "+v[i].name);
205 this._params[i] = v[i];
208 this.params = this._params;
213 //__defineGetter__("params",
214 getParams : function() { return this._params; },
219 /** Object[] */ params,
221 /** DocComment */ comment
223 this.$args = arguments;
224 //println("Symbol created: " + isa + ":" + name);
226 this.alias = this.getName();
227 this.setParams(params);
228 this.isa = (isa == "VIRTUAL")? "OBJECT":isa;
229 this.comment = comment || new DocComment("");
230 this.srcFile = Symbol.srcFile;
234 if (this.is("FILE") && !this.alias) this.alias = this.srcFile;
238 //if (typeof PluginManager != "undefined") {
239 // PluginManager.run("onSymbol", this);
243 setTags : function() {
245 var authors = this.comment.getTag("author");
246 if (authors.length) {
247 this.author = authors.map(function($){return $.desc;}).join(", ");
251 assert("testing Symbol");
253 requires("../lib/JSDOC/DocComment.js");
254 requires("../frame/String.js");
255 requires("../lib/JSDOC/DocTag.js");
257 var sym = new Symbol("foo", [], "OBJECT", new DocComment("/**@author Joe Smith*"+"/"));
258 assertEqual(sym.author, "Joe Smith", "@author tag, author is found.");
261 var mth = this.comment.getTag("method");
263 this.isa = "FUNCTION";
266 var descs = this.comment.getTag("desc");
268 this.desc = descs.map(function($){return $.desc;}).join("\n"); // multiple descriptions are concatenated into one
272 var sym = new Symbol("foo", [], "OBJECT", new DocComment("/**@desc This is a description.*"+"/"));
273 assertEqual(sym.desc, "This is a description.", "@desc tag, description is found.");
277 if (this.is("FILE")) {
278 if (!this.alias) this.alias = this.srcFile;
280 var overviews = this.comment.getTag("overview");
281 if (overviews.length) {
282 this.desc = [this.desc].concat(overviews.map(function($){return $.desc;})).join("\n");
287 var sym = new Symbol("foo", [], "FILE", new DocComment("/**@overview This is an overview.*"+"/"));
288 assertEqual(sym.desc, "\nThis is an overview.", "@overview tag, description is found.");
292 var sinces = this.comment.getTag("since");
294 this.since = sinces.map(function($){return $.desc;}).join(", ");
298 var sym = new Symbol("foo", [], "FILE", new DocComment("/**@since 1.01*"+"/"));
299 assertEqual(sym.since, "1.01", "@since tag, description is found.");
303 if (this.comment.getTag("constant").length) {
304 this.isConstant = true;
309 var sym = new Symbol("foo", [], "FILE", new DocComment("/**@constant*"+"/"));
310 assertEqual(sym.isConstant, true, "@constant tag, isConstant set.");
314 var versions = this.comment.getTag("version");
315 if (versions.length) {
316 this.version = versions.map(function($){return $.desc;}).join(", ");
320 var sym = new Symbol("foo", [], "FILE", new DocComment("/**@version 2.0x*"+"/"));
321 assertEqual(sym.version, "2.0x", "@version tag, version is found.");
325 var deprecateds = this.comment.getTag("deprecated");
326 if (deprecateds.length) {
327 this.deprecated = deprecateds.map(function($){return $.desc;}).join("\n");
331 var sym = new Symbol("foo", [], "FILE", new DocComment("/**@deprecated Use other method.*"+"/"));
332 assertEqual(sym.deprecated, "Use other method.", "@deprecated tag, desc is found.");
336 var examples = this.comment.getTag("example");
337 if (examples.length) {
338 this.example = examples[0];
342 var sym = new Symbol("foo", [], "FILE", new DocComment("/**@example This\n is an example.*"+"/"));
343 assertEqual(sym.example, "This\n is an example.", "@deprecated tag, desc is found.");
347 var sees = this.comment.getTag("see");
349 var thisSee = this.see;
350 sees.map(function($){thisSee.push($.desc);});
354 var sym = new Symbol("foo", [], "FILE", new DocComment("/**@see The other thing.*"+"/"));
355 assertEqual(sym.see, "The other thing.", "@see tag, desc is found.");
359 var classes = this.comment.getTag("class");
360 if (classes.length) {
361 //print(JSON.stringify(this,null,4));
362 this.isa = "CONSTRUCTOR";
363 this.classDesc = classes[0].desc; // desc can't apply to the constructor as there is none.
364 if (!this.classDesc) {
365 this.classDesc = this.desc;
372 var sym = new Symbol("foo", [], "OBJECT", new DocComment("/**@class This describes the class.*"+"/"));
373 assertEqual(sym.isa, "CONSTRUCTOR", "@class tag, makes symbol a constructor.");
374 assertEqual(sym.classDesc, "This describes the class.", "@class tag, class description is found.");
378 var namespaces = this.comment.getTag("namespace");
379 if (namespaces.length) {
380 this.classDesc = namespaces[0].desc+"\n"+this.desc; // desc can't apply to the constructor as there is none.
381 this.isNamespace = true;
385 var sym = new Symbol("foo", [], "OBJECT", new DocComment("/**@namespace This describes the namespace.*"+"/"));
386 assertEqual(sym.classDesc, "This describes the namespace.\n", "@namespace tag, class description is found.");
390 var params = this.comment.getTag("param");
392 // user-defined params overwrite those with same name defined by the parser
393 var thisParams = this.getParams();
395 if (thisParams.length == 0) { // none exist yet, so just bung all these user-defined params straight in
396 this.setParams(params);
398 else { // need to overlay these user-defined params on to existing parser-defined params
399 for (var i = 0, l = params.length; i < l; i++) {
401 if (params[i].type) thisParams[i].type = params[i].type;
402 thisParams[i].name = params[i].name;
403 thisParams[i].desc = params[i].desc;
404 thisParams[i].isOptional = params[i].isOptional;
405 thisParams[i].defaultValue = params[i].defaultValue;
407 else thisParams[i] = params[i];
413 var sym = new Symbol("foo", [{type: "array", name: "pages"}], "FUNCTION", new DocComment("/**Description.*"+"/"));
414 assertEqual(sym.params.length, 1, "parser defined param is found.");
416 sym = new Symbol("foo", [], "FUNCTION", new DocComment("/**Description.\n@param {array} pages*"+"/"));
417 assertEqual(sym.params.length, 1, "user defined param is found.");
418 assertEqual(sym.params[0].type, "array", "user defined param type is found.");
419 assertEqual(sym.params[0].name, "pages", "user defined param name is found.");
421 sym = new Symbol("foo", [{type: "array", name: "pages"}], "FUNCTION", new DocComment("/**Description.\n@param {string} uid*"+"/"));
422 assertEqual(sym.params.length, 1, "user defined param overwrites parser defined param.");
423 assertEqual(sym.params[0].type, "string", "user defined param type overwrites parser defined param type.");
424 assertEqual(sym.params[0].name, "uid", "user defined param name overwrites parser defined param name.");
426 sym = new Symbol("foo", [{type: "array", name: "pages"}, {type: "number", name: "count"}], "FUNCTION", new DocComment("/**Description.\n@param {string} uid*"+"/"));
427 assertEqual(sym.params.length, 2, "user defined params overlay parser defined params.");
428 assertEqual(sym.params[1].type, "number", "user defined param type overlays parser defined param type.");
429 assertEqual(sym.params[1].name, "count", "user defined param name overlays parser defined param name.");
431 sym = new Symbol("foo", [], "FUNCTION", new DocComment("/**Description.\n@param {array} pages The pages description.*"+"/"));
432 assertEqual(sym.params.length, 1, "user defined param with description is found.");
433 assertEqual(sym.params[0].desc, "The pages description.", "user defined param description is found.");
437 if (this.comment.getTag("constructor").length) {
438 this.isa = "CONSTRUCTOR";
442 var sym = new Symbol("foo", [], "OBJECT", new DocComment("/**@constructor*"+"/"));
443 assertEqual(sym.isa, "CONSTRUCTOR", "@constructor tag, makes symbol a constructor.");
447 if (this.comment.getTag("static").length) {
448 this.isStatic = true;
449 if (this.isa == "CONSTRUCTOR") {
450 this.isNamespace = true;
455 if (this.comment.getTag("singleton").length) {
456 this.isStatic = true;
457 //print('------------- got singleton ---------------' + this.isa);
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, "#");
670 this.name = this.name.split('.').pop();
671 this.name = this.name.split('#').pop();
672 this.name = this.memberOf + this.name;
673 this._name = this.name
674 this.alias = this.name;
682 if (this.comment.getTag("public").length) {
683 this.isPrivate = false;
691 is : function(what) {
692 return this.isa === what;
695 isBuiltin : function() {
696 return SymbolSet.isBuiltin(this.alias);
699 setType : function(/**String*/comment, /**Boolean*/overwrite) {
700 if (!overwrite && this.type) return;
701 var typeComment = DocComment.unwrapComment(comment);
702 this.type = typeComment;
705 inherit : function(symbol) {
706 if (!this.hasMember(symbol.name) && !symbol.isInner) {
707 if (symbol.is("FUNCTION"))
708 this.methods.push(symbol);
709 else if (symbol.is("OBJECT"))
710 this.properties.push(symbol);
714 hasMember : function(name) {
715 return (this.hasMethod(name) || this.hasProperty(name));
718 addMember : function(symbol) {
719 //println("ADDMEMBER: " + this.name + " ++ " + symbol.name);
721 if (symbol.comment.getTag("cfg").length == 1) {
722 symbol.comment.getTag("cfg")[0].memberOf = this.alias;
723 this.addConfig(symbol.comment.getTag("cfg")[0]);
727 if (symbol.is("FUNCTION")) { this.addMethod(symbol); }
728 else if (symbol.is("OBJECT")) { this.addProperty(symbol); }
731 hasMethod : function(name) {
732 var thisMethods = this.methods;
733 for (var i = 0, l = thisMethods.length; i < l; i++) {
734 if (thisMethods[i].name == name) return true;
735 if (thisMethods[i].alias == name) return true;
740 addMethod : function(symbol) {
741 var methodAlias = symbol.alias;
742 var thisMethods = this.methods;
743 for (var i = 0, l = thisMethods.length; i < l; i++) {
744 if (thisMethods[i].alias == methodAlias) {
745 thisMethods[i] = symbol; // overwriting previous method
749 thisMethods.push(symbol); // new method with this alias
752 hasProperty : function(name) {
753 var thisProperties = this.properties;
754 for (var i = 0, l = thisProperties.length; i < l; i++) {
755 if (thisProperties[i].name == name) return true;
756 if (thisProperties[i].alias == name) return true;
761 addProperty : function(symbol) {
762 var propertyAlias = symbol.alias;
763 var thisProperties = this.properties;
764 for (var i = 0, l = thisProperties.length; i < l; i++) {
765 if (thisProperties[i].alias == propertyAlias) {
766 thisProperties[i] = symbol; // overwriting previous property
771 thisProperties.push(symbol); // new property with this alias
774 addDocTag : function(docTag)
776 this.comment.tags.push(docTag);
777 if (docTag.title == 'cfg') {
778 this.addConfig(docTag);
783 addConfig : function(docTag)
785 if (typeof(docTag['memberOf']) == 'undefined') {
786 // remove prototype data...
787 //var a = this.alias.split('#')[0];
788 //docTag.memberOf = a;
789 docTag.memberOf = this.alias;
791 if (typeof(this.cfgs[docTag.name]) == 'undefined') {
792 this.cfgs[docTag.name] = docTag;
796 configToArray: function()
799 for(var ci in this.cfgs) {
800 // dont show hidden!!
801 if (this.cfgs[ci].desc.match(/@hide/)) {
804 r.push(this.cfgs[ci]);
812 * Elements that are not serialized
816 '$args' // not needed AFAIK
819 Symbol.srcFile = ""; //running reference to the current file being parsed
822 Symbol.fromDump = function(t)
824 var ns = new Symbol();
826 if (typeof(ns[i]) == "undefined") {
827 println("ERR:no default for Symbol:"+ i);