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.
32 comment : { isUserComment: false },
40 isa : "OBJECT", // OBJECT//FUNCTION
69 function array2object(a , m)
73 a.forEach(function(e) {
74 r.push(m ? e : e.toObject());
80 if (Symbol.hide.indexOf[i] > -1) {
83 switch (typeof(this[i])) {
88 case 'params' : ret[i] = array2object(this[i],true); continue;
94 print("object? :" + i);
98 ret[i] = this[i]; continue;
100 print("unknown type:" + typeof(this[i]));
111 this.defaultValue = "";
119 this.comment = { isUserComment: false };
120 //this.defaultValue = null;
121 this.deprecated = "";
125 this.exceptions = [];
127 this.inheritsFrom = [];
128 this.isa = "OBJECT"; // OBJECT//FUNCTION
129 this.isEvent = false;
130 this.isConstant = false;
131 this.isIgnored = false;
132 this.isInner = false;
133 this.isNamespace = false;
134 this.isPrivate = false;
135 this.isStatic = false;
140 this.properties = [];
148 this.childClasses = [];
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 this.isa = "CONSTRUCTOR";
362 this.classDesc = classes[0].desc; // desc can't apply to the constructor as there is none.
363 if (!this.classDesc) {
364 this.classDesc = this.desc;
371 var sym = new Symbol("foo", [], "OBJECT", new DocComment("/**@class This describes the class.*"+"/"));
372 assertEqual(sym.isa, "CONSTRUCTOR", "@class tag, makes symbol a constructor.");
373 assertEqual(sym.classDesc, "This describes the class.", "@class tag, class description is found.");
377 var namespaces = this.comment.getTag("namespace");
378 if (namespaces.length) {
379 this.classDesc = namespaces[0].desc+"\n"+this.desc; // desc can't apply to the constructor as there is none.
380 this.isNamespace = true;
384 var sym = new Symbol("foo", [], "OBJECT", new DocComment("/**@namespace This describes the namespace.*"+"/"));
385 assertEqual(sym.classDesc, "This describes the namespace.\n", "@namespace tag, class description is found.");
389 var params = this.comment.getTag("param");
391 // user-defined params overwrite those with same name defined by the parser
392 var thisParams = this.getParams();
394 if (thisParams.length == 0) { // none exist yet, so just bung all these user-defined params straight in
395 this.setParams(params);
397 else { // need to overlay these user-defined params on to existing parser-defined params
398 for (var i = 0, l = params.length; i < l; i++) {
400 if (params[i].type) thisParams[i].type = params[i].type;
401 thisParams[i].name = params[i].name;
402 thisParams[i].desc = params[i].desc;
403 thisParams[i].isOptional = params[i].isOptional;
404 thisParams[i].defaultValue = params[i].defaultValue;
406 else thisParams[i] = params[i];
412 var sym = new Symbol("foo", [{type: "array", name: "pages"}], "FUNCTION", new DocComment("/**Description.*"+"/"));
413 assertEqual(sym.params.length, 1, "parser defined param is found.");
415 sym = new Symbol("foo", [], "FUNCTION", new DocComment("/**Description.\n@param {array} pages*"+"/"));
416 assertEqual(sym.params.length, 1, "user defined param is found.");
417 assertEqual(sym.params[0].type, "array", "user defined param type is found.");
418 assertEqual(sym.params[0].name, "pages", "user defined param name is found.");
420 sym = new Symbol("foo", [{type: "array", name: "pages"}], "FUNCTION", new DocComment("/**Description.\n@param {string} uid*"+"/"));
421 assertEqual(sym.params.length, 1, "user defined param overwrites parser defined param.");
422 assertEqual(sym.params[0].type, "string", "user defined param type overwrites parser defined param type.");
423 assertEqual(sym.params[0].name, "uid", "user defined param name overwrites parser defined param name.");
425 sym = new Symbol("foo", [{type: "array", name: "pages"}, {type: "number", name: "count"}], "FUNCTION", new DocComment("/**Description.\n@param {string} uid*"+"/"));
426 assertEqual(sym.params.length, 2, "user defined params overlay parser defined params.");
427 assertEqual(sym.params[1].type, "number", "user defined param type overlays parser defined param type.");
428 assertEqual(sym.params[1].name, "count", "user defined param name overlays parser defined param name.");
430 sym = new Symbol("foo", [], "FUNCTION", new DocComment("/**Description.\n@param {array} pages The pages description.*"+"/"));
431 assertEqual(sym.params.length, 1, "user defined param with description is found.");
432 assertEqual(sym.params[0].desc, "The pages description.", "user defined param description is found.");
436 if (this.comment.getTag("constructor").length) {
437 this.isa = "CONSTRUCTOR";
441 var sym = new Symbol("foo", [], "OBJECT", new DocComment("/**@constructor*"+"/"));
442 assertEqual(sym.isa, "CONSTRUCTOR", "@constructor tag, makes symbol a constructor.");
446 if (this.comment.getTag("static").length) {
447 this.isStatic = true;
448 if (this.isa == "CONSTRUCTOR") {
449 this.isNamespace = true;
454 if (this.comment.getTag("singleton").length) {
455 this.isStatic = true;
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, "#");
675 if (this.comment.getTag("public").length) {
676 this.isPrivate = false;
684 is : function(what) {
685 return this.isa === what;
688 isBuiltin : function() {
689 return SymbolSet.isBuiltin(this.alias);
692 setType : function(/**String*/comment, /**Boolean*/overwrite) {
693 if (!overwrite && this.type) return;
694 var typeComment = DocComment.unwrapComment(comment);
695 this.type = typeComment;
698 inherit : function(symbol) {
699 if (!this.hasMember(symbol.name) && !symbol.isInner) {
700 if (symbol.is("FUNCTION"))
701 this.methods.push(symbol);
702 else if (symbol.is("OBJECT"))
703 this.properties.push(symbol);
707 hasMember : function(name) {
708 return (this.hasMethod(name) || this.hasProperty(name));
711 addMember : function(symbol) {
712 //println("ADDMEMBER: " + this.name + " ++ " + symbol.name);
714 if (symbol.comment.getTag("cfg").length == 1) {
715 symbol.comment.getTag("cfg")[0].memberOf = this.alias;
716 this.addConfig(symbol.comment.getTag("cfg")[0]);
720 if (symbol.is("FUNCTION")) { this.addMethod(symbol); }
721 else if (symbol.is("OBJECT")) { this.addProperty(symbol); }
724 hasMethod : function(name) {
725 var thisMethods = this.methods;
726 for (var i = 0, l = thisMethods.length; i < l; i++) {
727 if (thisMethods[i].name == name) return true;
728 if (thisMethods[i].alias == name) return true;
733 addMethod : function(symbol) {
734 var methodAlias = symbol.alias;
735 var thisMethods = this.methods;
736 for (var i = 0, l = thisMethods.length; i < l; i++) {
737 if (thisMethods[i].alias == methodAlias) {
738 thisMethods[i] = symbol; // overwriting previous method
742 thisMethods.push(symbol); // new method with this alias
745 hasProperty : function(name) {
746 var thisProperties = this.properties;
747 for (var i = 0, l = thisProperties.length; i < l; i++) {
748 if (thisProperties[i].name == name) return true;
749 if (thisProperties[i].alias == name) return true;
754 addProperty : function(symbol) {
755 var propertyAlias = symbol.alias;
756 var thisProperties = this.properties;
757 for (var i = 0, l = thisProperties.length; i < l; i++) {
758 if (thisProperties[i].alias == propertyAlias) {
759 thisProperties[i] = symbol; // overwriting previous property
764 thisProperties.push(symbol); // new property with this alias
767 addDocTag : function(docTag)
769 this.comment.tags.push(docTag);
770 if (docTag.title == 'cfg') {
771 this.addConfig(docTag);
776 addConfig : function(docTag)
778 if (typeof(docTag['memberOf']) == 'undefined') {
779 // remove prototype data...
780 //var a = this.alias.split('#')[0];
781 //docTag.memberOf = a;
782 docTag.memberOf = this.alias;
784 if (typeof(this.cfgs[docTag.name]) == 'undefined') {
785 this.cfgs[docTag.name] = docTag;
789 configToArray: function()
792 for(var ci in this.cfgs) {
793 // dont show hidden!!
794 if (this.cfgs[ci].desc.match(/@hide/)) {
797 r.push(this.cfgs[ci]);
805 * Elements that are not serialized
809 '$args' // not needed AFAIK
812 Symbol.srcFile = ""; //running reference to the current file being parsed
815 Symbol.fromDump = function(t)
817 var ns = new Symbol();
819 if (typeof(ns[i]) == "undefined") {
820 println("ERR:no default for Symbol:"+ i);