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[]
69 function array2object(a)
73 a.forEach(function(e) {
81 if (Symbol.hide.indexOf(i) > -1) {
84 switch (typeof(this[i])) {
97 ret[i] = array2object(this[i],true);
103 print(JSON.stringify(this[i]));
104 ret[i] = this[i].toObject();
108 print("object? :" + i);
115 ret[i] = this[i]; continue;
117 print("unknown type:" + typeof(this[i]));
127 // only initialize arrays / objects..
132 this.exceptions = [];
134 //this.inheritsFrom = [];
135 this.isa = "OBJECT"; // OBJECT//FUNCTION
138 this.properties = [];
143 this.childClasses = [];
146 this.comment = new DocComment();
147 this.comment.isUserComment = false;
152 serialize : function() {
154 for (var p in this) {
160 for (var i in keys) {
161 if (typeof this[keys[i]] == "function") continue;
162 out += " " +keys[i]+" => "+
164 (typeof(this[keys[i]]) != "object") ?
166 "[" +typeof(this[keys[i]])+"]"
170 return "\n{\n" + out + "}\n";
174 var clone = new Symbol();
175 clone.populate.apply(clone, this.$args); // repopulate using the original arguments
176 clone.srcFile = this.srcFile; // not the current srcFile, the one when the original was made
183 //__defineSetter__("name",
184 setName : function(n) {
185 n = n.replace(/^_global_[.#-]/, "");
186 n = n.replace(/\.prototype\.?/g, '#');
187 n = n.replace(/#$/g, '');
189 this.name = n; // real!
192 //__defineGetter__("name",
193 getName : function() { return this._name; },
195 //__defineSetter__("params",
196 setParams :function(v) {
197 for (var i = 0, l = v.length; i < l; i++) {
198 if (v[i].constructor != DocTag) { // may be a generic object parsed from signature, like {type:..., name:...}
199 var ty = v[i].hasOwnProperty('type') ? v[i].type : '';
200 this._params[i] = new DocTag(
201 "param"+((ty)?" {"+ty+"}":"")+" "+v[i].name);
204 this._params[i] = v[i];
207 this.params = this._params;
212 //__defineGetter__("params",
213 getParams : function() { return this._params; },
218 /** Object[] */ params,
220 /** DocComment */ comment
222 this.$args = arguments;
223 //println("Symbol created: " + isa + ":" + name);
225 this.alias = this.getName();
226 this.setParams(params);
227 this.isa = (isa == "VIRTUAL")? "OBJECT":isa;
228 this.comment = comment || new DocComment("");
229 this.srcFile = Symbol.srcFile;
233 if (this.is("FILE") && !this.alias) this.alias = this.srcFile;
237 //if (typeof PluginManager != "undefined") {
238 // PluginManager.run("onSymbol", this);
242 setTags : function() {
244 var authors = this.comment.getTag("author");
245 if (authors.length) {
246 this.author = authors.map(function($){return $.desc;}).join(", ");
250 assert("testing Symbol");
252 requires("../lib/JSDOC/DocComment.js");
253 requires("../frame/String.js");
254 requires("../lib/JSDOC/DocTag.js");
256 var sym = new Symbol("foo", [], "OBJECT", new DocComment("/**@author Joe Smith*"+"/"));
257 assertEqual(sym.author, "Joe Smith", "@author tag, author is found.");
260 var mth = this.comment.getTag("method");
262 this.isa = "FUNCTION";
265 var descs = this.comment.getTag("desc");
267 this.desc = descs.map(function($){return $.desc;}).join("\n"); // multiple descriptions are concatenated into one
271 var sym = new Symbol("foo", [], "OBJECT", new DocComment("/**@desc This is a description.*"+"/"));
272 assertEqual(sym.desc, "This is a description.", "@desc tag, description is found.");
276 if (this.is("FILE")) {
277 if (!this.alias) this.alias = this.srcFile;
279 var overviews = this.comment.getTag("overview");
280 if (overviews.length) {
281 this.desc = [this.desc].concat(overviews.map(function($){return $.desc;})).join("\n");
286 var sym = new Symbol("foo", [], "FILE", new DocComment("/**@overview This is an overview.*"+"/"));
287 assertEqual(sym.desc, "\nThis is an overview.", "@overview tag, description is found.");
291 var sinces = this.comment.getTag("since");
293 this.since = sinces.map(function($){return $.desc;}).join(", ");
297 var sym = new Symbol("foo", [], "FILE", new DocComment("/**@since 1.01*"+"/"));
298 assertEqual(sym.since, "1.01", "@since tag, description is found.");
302 if (this.comment.getTag("constant").length) {
303 this.isConstant = true;
308 var sym = new Symbol("foo", [], "FILE", new DocComment("/**@constant*"+"/"));
309 assertEqual(sym.isConstant, true, "@constant tag, isConstant set.");
313 var versions = this.comment.getTag("version");
314 if (versions.length) {
315 this.version = versions.map(function($){return $.desc;}).join(", ");
319 var sym = new Symbol("foo", [], "FILE", new DocComment("/**@version 2.0x*"+"/"));
320 assertEqual(sym.version, "2.0x", "@version tag, version is found.");
324 var deprecateds = this.comment.getTag("deprecated");
325 if (deprecateds.length) {
326 this.deprecated = deprecateds.map(function($){return $.desc;}).join("\n");
330 var sym = new Symbol("foo", [], "FILE", new DocComment("/**@deprecated Use other method.*"+"/"));
331 assertEqual(sym.deprecated, "Use other method.", "@deprecated tag, desc is found.");
335 var examples = this.comment.getTag("example");
336 if (examples.length) {
337 this.example = examples[0];
341 var sym = new Symbol("foo", [], "FILE", new DocComment("/**@example This\n is an example.*"+"/"));
342 assertEqual(sym.example, "This\n is an example.", "@deprecated tag, desc is found.");
346 var sees = this.comment.getTag("see");
348 var thisSee = this.see;
349 sees.map(function($){thisSee.push($.desc);});
353 var sym = new Symbol("foo", [], "FILE", new DocComment("/**@see The other thing.*"+"/"));
354 assertEqual(sym.see, "The other thing.", "@see tag, desc is found.");
358 var classes = this.comment.getTag("class");
359 if (classes.length) {
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 //if (this.isa == "CONSTRUCTOR") {
456 // this.isNamespace = true;
463 var sym = new Symbol("foo", [], "OBJECT", new DocComment("/**@static\n@constructor*"+"/"));
464 assertEqual(sym.isStatic, true, "@static tag, makes isStatic true.");
465 assertEqual(sym.isNamespace, true, "@static and @constructor tag, makes isNamespace true.");
469 if (this.comment.getTag("inner").length) {
471 this.isStatic = false;
475 var sym = new Symbol("foo", [], "OBJECT", new DocComment("/**@inner*"+"/"));
476 assertEqual(sym.isStatic, false, "@inner tag, makes isStatic false.");
477 assertEqual(sym.isInner, true, "@inner makes isInner true.");
481 if (this.comment.getTag("field").length) {
486 var sym = new Symbol("foo", [], "FUNCTION", new DocComment("/**@field*"+"/"));
487 assertEqual(sym.isa, "OBJECT", "@field tag, makes symbol an object.");
491 if (this.comment.getTag("function").length) {
492 this.isa = "FUNCTION";
496 if (this.comment.getTag("param").length && this.isa == "OBJECT" ) {
497 // change a property to a function..
498 this.isa = "FUNCTION";
503 var sym = new Symbol("foo", [], "OBJECT", new DocComment("/**@function*"+"/"));
504 assertEqual(sym.isa, "FUNCTION", "@function tag, makes symbol a function.");
508 var events = this.comment.getTag("event");
510 this.isa = "FUNCTION";
515 var sym = new Symbol("foo", [], "OBJECT", new DocComment("/**@event*"+"/"));
516 assertEqual(sym.isa, "FUNCTION", "@event tag, makes symbol a function.");
517 assertEqual(sym.isEvent, true, "@event makes isEvent true.");
521 var names = this.comment.getTag("name");
523 this.setName(names[0].desc);
531 var properties = this.comment.getTag("property");
532 if (properties.length) {
533 thisProperties = this.properties;
534 for (var i = 0; i < properties.length; i++) {
535 var property = new Symbol(this.alias+"#"+properties[i].name, [], "OBJECT", new DocComment("/**"+properties[i].desc+"\n@name "+properties[i].name+"\n@memberOf "+this.alias+"#*/"));
536 // TODO: shouldn't the following happen in the addProperty method of Symbol?
537 property.name = properties[i].name;
538 property.memberOf = this.alias;
539 if (properties[i].type) property.type = properties[i].type;
540 if (properties[i].defaultValue) property.defaultValue = properties[i].defaultValue;
541 this.addProperty(property);
542 imports.Parser.Parser.addSymbol(property);
547 var conf = this.comment.getTag("cfg");
549 for (var i = 0; i < conf.length; i++) {
550 this.addConfig(conf[i]);
559 var returns = this.comment.getTag("return");
560 if (returns.length) { // there can be many return tags in a single doclet
561 this.returns = returns;
562 this.type = returns.map(function($){return $.type}).join(", ");
570 this.exceptions = this.comment.getTag("throws");
577 var requires = this.comment.getTag("requires");
578 if (requires.length) {
579 this.requires = requires.map(function($){return $.desc});
587 var types = this.comment.getTag("type");
589 this.type = types[0].desc; //multiple type tags are ignored
597 if (this.comment.getTag("private").length || this.isInner) {
598 this.isPrivate = true;
602 if (this.comment.getTag("ignore").length) {
603 this.isIgnored = true;
610 // @inherits ... as ...
611 var inherits = this.comment.getTag("inherits");
612 if (inherits.length) {
613 for (var i = 0; i < inherits.length; i++) {
614 if (/^\s*([a-z$0-9_.#-]+)(?:\s+as\s+([a-z$0-9_.#]+))?/i.test(inherits[i].desc)) {
615 var inAlias = RegExp.$1;
616 var inAs = RegExp.$2 || inAlias;
618 if (inAlias) inAlias = inAlias.replace(/\.prototype\.?/g, "#");
621 inAs = inAs.replace(/\.prototype\.?/g, "#");
622 inAs = inAs.replace(/^this\.?/, "#");
625 if (inAs.indexOf(inAlias) != 0) { //not a full namepath
627 if (this.alias.charAt(this.alias.length-1) == "#" || inAs.charAt(0) == "#") {
630 inAs = this.alias + joiner + inAs;
633 this.inherits.push({alias: inAlias, as: inAs});
642 this.augments = this.comment.getTag("augments");
645 if (this.comment.getTag("extends")) {
646 this.augments = this.comment.getTag("extends");
651 var defaults = this.comment.getTag("default");
652 if (defaults.length) {
653 if (this.is("OBJECT")) {
654 this.defaultValue = defaults[0].desc;
663 var memberOfs = this.comment.getTag("memberOf");
664 if (memberOfs.length) {
665 this.memberOf = memberOfs[0].desc;
666 this.memberOf = this.memberOf.replace(/\.prototype\.?/g, "#");
674 if (this.comment.getTag("public").length) {
675 this.isPrivate = false;
683 is : function(what) {
684 return this.isa === what;
687 isBuiltin : function() {
688 return SymbolSet.isBuiltin(this.alias);
691 setType : function(/**String*/comment, /**Boolean*/overwrite) {
692 if (!overwrite && this.type) return;
693 var typeComment = DocComment.unwrapComment(comment);
694 this.type = typeComment;
697 inherit : function(symbol) {
698 if (!this.hasMember(symbol.name) && !symbol.isInner) {
699 if (symbol.is("FUNCTION"))
700 this.methods.push(symbol);
701 else if (symbol.is("OBJECT"))
702 this.properties.push(symbol);
706 hasMember : function(name) {
707 return (this.hasMethod(name) || this.hasProperty(name));
710 addMember : function(symbol) {
711 //println("ADDMEMBER: " + this.name + " ++ " + symbol.name);
713 if (symbol.comment.getTag("cfg").length == 1) {
714 symbol.comment.getTag("cfg")[0].memberOf = this.alias;
715 this.addConfig(symbol.comment.getTag("cfg")[0]);
719 if (symbol.is("FUNCTION")) { this.addMethod(symbol); }
720 else if (symbol.is("OBJECT")) { this.addProperty(symbol); }
723 hasMethod : function(name) {
724 var thisMethods = this.methods;
725 for (var i = 0, l = thisMethods.length; i < l; i++) {
726 if (thisMethods[i].name == name) return true;
727 if (thisMethods[i].alias == name) return true;
732 addMethod : function(symbol) {
733 var methodAlias = symbol.alias;
734 var thisMethods = this.methods;
735 for (var i = 0, l = thisMethods.length; i < l; i++) {
736 if (thisMethods[i].alias == methodAlias) {
737 thisMethods[i] = symbol; // overwriting previous method
741 thisMethods.push(symbol); // new method with this alias
744 hasProperty : function(name) {
745 var thisProperties = this.properties;
746 for (var i = 0, l = thisProperties.length; i < l; i++) {
747 if (thisProperties[i].name == name) return true;
748 if (thisProperties[i].alias == name) return true;
753 addProperty : function(symbol) {
754 var propertyAlias = symbol.alias;
755 var thisProperties = this.properties;
756 for (var i = 0, l = thisProperties.length; i < l; i++) {
757 if (thisProperties[i].alias == propertyAlias) {
758 thisProperties[i] = symbol; // overwriting previous property
763 thisProperties.push(symbol); // new property with this alias
766 addDocTag : function(docTag)
768 this.comment.tags.push(docTag);
769 if (docTag.title == 'cfg') {
770 this.addConfig(docTag);
775 addConfig : function(docTag)
777 if (typeof(docTag['memberOf']) == 'undefined') {
778 // remove prototype data...
779 //var a = this.alias.split('#')[0];
780 //docTag.memberOf = a;
781 docTag.memberOf = this.alias;
783 if (typeof(this.cfgs[docTag.name]) == 'undefined') {
784 this.cfgs[docTag.name] = docTag;
788 configToArray: function()
791 for(var ci in this.cfgs) {
792 // dont show hidden!!
793 if (this.cfgs[ci].desc.match(/@hide/)) {
796 r.push(this.cfgs[ci]);
804 * Elements that are not serialized
808 '$args' // not needed AFAIK
811 Symbol.srcFile = ""; //running reference to the current file being parsed
814 Symbol.fromDump = function(t)
816 var ns = new Symbol();
818 if (typeof(ns[i]) == "undefined") {
819 println("ERR:no default for Symbol:"+ i);