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;
112 print("unknown type:" + typeof(this[i]));
122 // only initialize arrays / objects..
127 this.exceptions = [];
130 this.isa = "OBJECT"; // OBJECT//FUNCTION
133 this.properties = [];
142 this.inheritsFrom = [];
143 this.childClasses = [];
145 this.comment = new DocComment();
146 this.comment.isUserComment = false;
151 serialize : function() {
153 for (var p in this) {
159 for (var i in keys) {
160 if (typeof this[keys[i]] == "function") continue;
161 out += " " +keys[i]+" => "+
163 (typeof(this[keys[i]]) != "object") ?
165 "[" +typeof(this[keys[i]])+"]"
169 return "\n{\n" + out + "}\n";
173 var clone = new Symbol();
174 clone.populate.apply(clone, this.$args); // repopulate using the original arguments
175 clone.srcFile = this.srcFile; // not the current srcFile, the one when the original was made
182 //__defineSetter__("name",
183 setName : function(n) {
184 n = n.replace(/^_global_[.#-]/, "");
185 n = n.replace(/\.prototype\.?/g, '#');
186 n = n.replace(/#$/g, '');
188 this.name = n; // real!
191 //__defineGetter__("name",
192 getName : function() { return this._name; },
194 //__defineSetter__("params",
195 setParams :function(v) {
196 for (var i = 0, l = v.length; i < l; i++) {
197 if (v[i].constructor != DocTag) { // may be a generic object parsed from signature, like {type:..., name:...}
198 var ty = v[i].hasOwnProperty('type') ? v[i].type : '';
199 this._params[i] = new DocTag(
200 "param"+((ty)?" {"+ty+"}":"")+" "+v[i].name);
203 this._params[i] = v[i];
206 this.params = this._params;
211 //__defineGetter__("params",
212 getParams : function() { return this._params; },
217 /** Object[] */ params,
219 /** DocComment */ comment
221 this.$args = arguments;
222 //println("Symbol created: " + isa + ":" + name);
224 this.alias = this.getName();
225 this.setParams(params);
226 this.isa = (isa == "VIRTUAL")? "OBJECT":isa;
227 this.comment = comment || new DocComment("");
228 this.srcFile = Symbol.srcFile;
232 if (this.is("FILE") && !this.alias) this.alias = this.srcFile;
236 //if (typeof PluginManager != "undefined") {
237 // PluginManager.run("onSymbol", this);
241 setTags : function() {
243 var authors = this.comment.getTag("author");
244 if (authors.length) {
245 this.author = authors.map(function($){return $.desc;}).join(", ");
249 assert("testing Symbol");
251 requires("../lib/JSDOC/DocComment.js");
252 requires("../frame/String.js");
253 requires("../lib/JSDOC/DocTag.js");
255 var sym = new Symbol("foo", [], "OBJECT", new DocComment("/**@author Joe Smith*"+"/"));
256 assertEqual(sym.author, "Joe Smith", "@author tag, author is found.");
259 var mth = this.comment.getTag("method");
261 this.isa = "FUNCTION";
264 var descs = this.comment.getTag("desc");
266 this.desc = descs.map(function($){return $.desc;}).join("\n"); // multiple descriptions are concatenated into one
270 var sym = new Symbol("foo", [], "OBJECT", new DocComment("/**@desc This is a description.*"+"/"));
271 assertEqual(sym.desc, "This is a description.", "@desc tag, description is found.");
275 if (this.is("FILE")) {
276 if (!this.alias) this.alias = this.srcFile;
278 var overviews = this.comment.getTag("overview");
279 if (overviews.length) {
280 this.desc = [this.desc].concat(overviews.map(function($){return $.desc;})).join("\n");
285 var sym = new Symbol("foo", [], "FILE", new DocComment("/**@overview This is an overview.*"+"/"));
286 assertEqual(sym.desc, "\nThis is an overview.", "@overview tag, description is found.");
290 var sinces = this.comment.getTag("since");
292 this.since = sinces.map(function($){return $.desc;}).join(", ");
296 var sym = new Symbol("foo", [], "FILE", new DocComment("/**@since 1.01*"+"/"));
297 assertEqual(sym.since, "1.01", "@since tag, description is found.");
301 if (this.comment.getTag("constant").length) {
302 this.isConstant = true;
307 var sym = new Symbol("foo", [], "FILE", new DocComment("/**@constant*"+"/"));
308 assertEqual(sym.isConstant, true, "@constant tag, isConstant set.");
312 var versions = this.comment.getTag("version");
313 if (versions.length) {
314 this.version = versions.map(function($){return $.desc;}).join(", ");
318 var sym = new Symbol("foo", [], "FILE", new DocComment("/**@version 2.0x*"+"/"));
319 assertEqual(sym.version, "2.0x", "@version tag, version is found.");
323 var deprecateds = this.comment.getTag("deprecated");
324 if (deprecateds.length) {
325 this.deprecated = deprecateds.map(function($){return $.desc;}).join("\n");
329 var sym = new Symbol("foo", [], "FILE", new DocComment("/**@deprecated Use other method.*"+"/"));
330 assertEqual(sym.deprecated, "Use other method.", "@deprecated tag, desc is found.");
334 var examples = this.comment.getTag("example");
335 if (examples.length) {
336 this.example = examples[0];
340 var sym = new Symbol("foo", [], "FILE", new DocComment("/**@example This\n is an example.*"+"/"));
341 assertEqual(sym.example, "This\n is an example.", "@deprecated tag, desc is found.");
345 var sees = this.comment.getTag("see");
347 var thisSee = this.see;
348 sees.map(function($){thisSee.push($.desc);});
352 var sym = new Symbol("foo", [], "FILE", new DocComment("/**@see The other thing.*"+"/"));
353 assertEqual(sym.see, "The other thing.", "@see tag, desc is found.");
357 var classes = this.comment.getTag("class");
358 if (classes.length) {
359 //print(JSON.stringify(this,null,4));
360 this.isa = "CONSTRUCTOR";
361 this.classDesc = classes[0].desc; // desc can't apply to the constructor as there is none.
362 if (!this.classDesc) {
363 this.classDesc = this.desc;
370 var sym = new Symbol("foo", [], "OBJECT", new DocComment("/**@class This describes the class.*"+"/"));
371 assertEqual(sym.isa, "CONSTRUCTOR", "@class tag, makes symbol a constructor.");
372 assertEqual(sym.classDesc, "This describes the class.", "@class tag, class description is found.");
376 var namespaces = this.comment.getTag("namespace");
377 if (namespaces.length) {
378 this.classDesc = namespaces[0].desc+"\n"+this.desc; // desc can't apply to the constructor as there is none.
379 this.isNamespace = true;
383 var sym = new Symbol("foo", [], "OBJECT", new DocComment("/**@namespace This describes the namespace.*"+"/"));
384 assertEqual(sym.classDesc, "This describes the namespace.\n", "@namespace tag, class description is found.");
388 var params = this.comment.getTag("param");
390 // user-defined params overwrite those with same name defined by the parser
391 var thisParams = this.getParams();
393 if (thisParams.length == 0) { // none exist yet, so just bung all these user-defined params straight in
394 this.setParams(params);
396 else { // need to overlay these user-defined params on to existing parser-defined params
397 for (var i = 0, l = params.length; i < l; i++) {
399 if (params[i].type) thisParams[i].type = params[i].type;
400 thisParams[i].name = params[i].name;
401 thisParams[i].desc = params[i].desc;
402 thisParams[i].isOptional = params[i].isOptional;
403 thisParams[i].defaultValue = params[i].defaultValue;
405 else thisParams[i] = params[i];
411 var sym = new Symbol("foo", [{type: "array", name: "pages"}], "FUNCTION", new DocComment("/**Description.*"+"/"));
412 assertEqual(sym.params.length, 1, "parser defined param is found.");
414 sym = new Symbol("foo", [], "FUNCTION", new DocComment("/**Description.\n@param {array} pages*"+"/"));
415 assertEqual(sym.params.length, 1, "user defined param is found.");
416 assertEqual(sym.params[0].type, "array", "user defined param type is found.");
417 assertEqual(sym.params[0].name, "pages", "user defined param name is found.");
419 sym = new Symbol("foo", [{type: "array", name: "pages"}], "FUNCTION", new DocComment("/**Description.\n@param {string} uid*"+"/"));
420 assertEqual(sym.params.length, 1, "user defined param overwrites parser defined param.");
421 assertEqual(sym.params[0].type, "string", "user defined param type overwrites parser defined param type.");
422 assertEqual(sym.params[0].name, "uid", "user defined param name overwrites parser defined param name.");
424 sym = new Symbol("foo", [{type: "array", name: "pages"}, {type: "number", name: "count"}], "FUNCTION", new DocComment("/**Description.\n@param {string} uid*"+"/"));
425 assertEqual(sym.params.length, 2, "user defined params overlay parser defined params.");
426 assertEqual(sym.params[1].type, "number", "user defined param type overlays parser defined param type.");
427 assertEqual(sym.params[1].name, "count", "user defined param name overlays parser defined param name.");
429 sym = new Symbol("foo", [], "FUNCTION", new DocComment("/**Description.\n@param {array} pages The pages description.*"+"/"));
430 assertEqual(sym.params.length, 1, "user defined param with description is found.");
431 assertEqual(sym.params[0].desc, "The pages description.", "user defined param description is found.");
435 if (this.comment.getTag("constructor").length) {
436 this.isa = "CONSTRUCTOR";
440 var sym = new Symbol("foo", [], "OBJECT", new DocComment("/**@constructor*"+"/"));
441 assertEqual(sym.isa, "CONSTRUCTOR", "@constructor tag, makes symbol a constructor.");
445 if (this.comment.getTag("static").length) {
446 this.isStatic = true;
447 if (this.isa == "CONSTRUCTOR") {
448 this.isNamespace = true;
453 if (this.comment.getTag("singleton").length) {
454 this.isStatic = true;
455 //print('------------- got singleton ---------------' + this.isa);
456 //if (this.isa == "CONSTRUCTOR") {
457 // this.isNamespace = true;
464 var sym = new Symbol("foo", [], "OBJECT", new DocComment("/**@static\n@constructor*"+"/"));
465 assertEqual(sym.isStatic, true, "@static tag, makes isStatic true.");
466 assertEqual(sym.isNamespace, true, "@static and @constructor tag, makes isNamespace true.");
470 if (this.comment.getTag("inner").length) {
472 this.isStatic = false;
476 var sym = new Symbol("foo", [], "OBJECT", new DocComment("/**@inner*"+"/"));
477 assertEqual(sym.isStatic, false, "@inner tag, makes isStatic false.");
478 assertEqual(sym.isInner, true, "@inner makes isInner true.");
482 if (this.comment.getTag("field").length) {
487 var sym = new Symbol("foo", [], "FUNCTION", new DocComment("/**@field*"+"/"));
488 assertEqual(sym.isa, "OBJECT", "@field tag, makes symbol an object.");
492 if (this.comment.getTag("function").length) {
493 this.isa = "FUNCTION";
497 if (this.comment.getTag("param").length && this.isa == "OBJECT" ) {
498 // change a property to a function..
499 this.isa = "FUNCTION";
504 var sym = new Symbol("foo", [], "OBJECT", new DocComment("/**@function*"+"/"));
505 assertEqual(sym.isa, "FUNCTION", "@function tag, makes symbol a function.");
509 var events = this.comment.getTag("event");
511 this.isa = "FUNCTION";
516 var sym = new Symbol("foo", [], "OBJECT", new DocComment("/**@event*"+"/"));
517 assertEqual(sym.isa, "FUNCTION", "@event tag, makes symbol a function.");
518 assertEqual(sym.isEvent, true, "@event makes isEvent true.");
522 var names = this.comment.getTag("name");
524 this.setName(names[0].desc);
532 var properties = this.comment.getTag("property");
533 if (properties.length) {
534 thisProperties = this.properties;
535 for (var i = 0; i < properties.length; i++) {
536 var property = new Symbol(this.alias+"#"+properties[i].name, [], "OBJECT", new DocComment("/**"+properties[i].desc+"\n@name "+properties[i].name+"\n@memberOf "+this.alias+"#*/"));
537 // TODO: shouldn't the following happen in the addProperty method of Symbol?
538 property.name = properties[i].name;
539 property.memberOf = this.alias;
540 if (properties[i].type) property.type = properties[i].type;
541 if (properties[i].defaultValue) property.defaultValue = properties[i].defaultValue;
542 this.addProperty(property);
543 imports.Parser.Parser.addSymbol(property);
548 var conf = this.comment.getTag("cfg");
550 for (var i = 0; i < conf.length; i++) {
551 this.addConfig(conf[i]);
560 var returns = this.comment.getTag("return");
561 if (returns.length) { // there can be many return tags in a single doclet
562 this.returns = returns;
563 this.type = returns.map(function($){return $.type}).join(", ");
571 this.exceptions = this.comment.getTag("throws");
578 var requires = this.comment.getTag("requires");
579 if (requires.length) {
580 this.requires = requires.map(function($){return $.desc});
588 var types = this.comment.getTag("type");
590 this.type = types[0].desc; //multiple type tags are ignored
598 if (this.comment.getTag("private").length || this.isInner) {
599 this.isPrivate = true;
603 if (this.comment.getTag("ignore").length) {
604 this.isIgnored = true;
611 // @inherits ... as ...
612 var inherits = this.comment.getTag("inherits");
613 if (inherits.length) {
614 for (var i = 0; i < inherits.length; i++) {
615 if (/^\s*([a-z$0-9_.#-]+)(?:\s+as\s+([a-z$0-9_.#]+))?/i.test(inherits[i].desc)) {
616 var inAlias = RegExp.$1;
617 var inAs = RegExp.$2 || inAlias;
619 if (inAlias) inAlias = inAlias.replace(/\.prototype\.?/g, "#");
622 inAs = inAs.replace(/\.prototype\.?/g, "#");
623 inAs = inAs.replace(/^this\.?/, "#");
626 if (inAs.indexOf(inAlias) != 0) { //not a full namepath
628 if (this.alias.charAt(this.alias.length-1) == "#" || inAs.charAt(0) == "#") {
631 inAs = this.alias + joiner + inAs;
634 this.inherits.push({alias: inAlias, as: inAs});
643 this.augments = this.comment.getTag("augments");
646 if (this.comment.getTag("extends")) {
647 this.augments = this.comment.getTag("extends");
652 var defaults = this.comment.getTag("default");
653 if (defaults.length) {
654 if (this.is("OBJECT")) {
655 this.defaultValue = defaults[0].desc;
664 var memberOfs = this.comment.getTag("memberOf");
665 if (memberOfs.length) {
666 this.memberOf = memberOfs[0].desc;
667 this.memberOf = this.memberOf.replace(/\.prototype\.?/g, "#");
668 this.name = this.name.split('.').pop();
669 this.name = this.name.split('#').pop();
670 this.name = this.memberOf + this.name;
671 this._name = this.name
672 this.alias = this.name;
680 if (this.comment.getTag("public").length) {
681 this.isPrivate = false;
689 is : function(what) {
690 return this.isa === what;
693 isBuiltin : function() {
694 return SymbolSet.isBuiltin(this.alias);
697 setType : function(/**String*/comment, /**Boolean*/overwrite) {
698 if (!overwrite && this.type) return;
699 var typeComment = DocComment.unwrapComment(comment);
700 this.type = typeComment;
703 inherit : function(symbol) {
704 if (!this.hasMember(symbol.name) && !symbol.isInner) {
705 if (symbol.is("FUNCTION"))
706 this.methods.push(symbol);
707 else if (symbol.is("OBJECT"))
708 this.properties.push(symbol);
712 hasMember : function(name) {
713 return (this.hasMethod(name) || this.hasProperty(name));
716 addMember : function(symbol) {
717 //println("ADDMEMBER: " + this.name + " ++ " + symbol.name);
719 if (symbol.comment.getTag("cfg").length == 1) {
720 symbol.comment.getTag("cfg")[0].memberOf = this.alias;
721 this.addConfig(symbol.comment.getTag("cfg")[0]);
725 if (symbol.is("FUNCTION")) { this.addMethod(symbol); }
726 else if (symbol.is("OBJECT")) { this.addProperty(symbol); }
729 hasMethod : function(name) {
730 var thisMethods = this.methods;
731 for (var i = 0, l = thisMethods.length; i < l; i++) {
732 if (thisMethods[i].name == name) return true;
733 if (thisMethods[i].alias == name) return true;
738 addMethod : function(symbol) {
739 var methodAlias = symbol.alias;
740 var thisMethods = this.methods;
741 for (var i = 0, l = thisMethods.length; i < l; i++) {
742 if (thisMethods[i].alias == methodAlias) {
743 thisMethods[i] = symbol; // overwriting previous method
747 thisMethods.push(symbol); // new method with this alias
750 hasProperty : function(name) {
751 var thisProperties = this.properties;
752 for (var i = 0, l = thisProperties.length; i < l; i++) {
753 if (thisProperties[i].name == name) return true;
754 if (thisProperties[i].alias == name) return true;
759 addProperty : function(symbol) {
760 var propertyAlias = symbol.alias;
761 var thisProperties = this.properties;
762 for (var i = 0, l = thisProperties.length; i < l; i++) {
763 if (thisProperties[i].alias == propertyAlias) {
764 thisProperties[i] = symbol; // overwriting previous property
769 thisProperties.push(symbol); // new property with this alias
772 addDocTag : function(docTag)
774 this.comment.tags.push(docTag);
775 if (docTag.title == 'cfg') {
776 this.addConfig(docTag);
781 addConfig : function(docTag)
783 if (typeof(docTag['memberOf']) == 'undefined') {
784 // remove prototype data...
785 //var a = this.alias.split('#')[0];
786 //docTag.memberOf = a;
787 docTag.memberOf = this.alias;
789 if (typeof(this.cfgs[docTag.name]) == 'undefined') {
790 this.cfgs[docTag.name] = docTag;
794 configToArray: function()
797 for(var ci in this.cfgs) {
798 // dont show hidden!!
799 if (this.cfgs[ci].desc.match(/@hide/)) {
802 r.push(this.cfgs[ci]);
810 * Elements that are not serialized
814 '$args' // not needed AFAIK
817 Symbol.srcFile = ""; //running reference to the current file being parsed
820 Symbol.fromDump = function(t)
822 var ns = new Symbol();
824 if (typeof(ns[i]) == "undefined") {
825 println("ERR:no default for Symbol:"+ i);