1 //<script type="text/javascript">
3 XObject = imports.XObject.XObject;
5 SymbolSet = imports.SymbolSet.SymbolSet;
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; },
215 * Main ctor entry point...
217 * @param {String} name The name of the sybmol.
218 * @param {Array} params Array of parameter objects
219 * @param {String} isa -- ???
220 * @param {DocComment} comment The related comment
225 populate : function( name, params, isa, comment )
227 this.$args = arguments;
228 //println("Symbol created: " + isa + ":" + name);
230 this.alias = this.getName();
231 this.setParams(params);
232 this.isa = (isa == "VIRTUAL")? "OBJECT":isa;
233 this.comment = comment || new DocComment("");
234 this.srcFile = Symbol.srcFile;
238 if (this.is("FILE") && !this.alias) this.alias = this.srcFile;
242 //if (typeof PluginManager != "undefined") {
243 // PluginManager.run("onSymbol", this);
247 setTags : function() {
249 var authors = this.comment.getTag("author");
250 if (authors.length) {
251 this.author = authors.map(function($){return $.desc;}).join(", ");
255 assert("testing Symbol");
257 requires("../lib/JSDOC/DocComment.js");
258 requires("../frame/String.js");
259 requires("../lib/JSDOC/DocTag.js");
261 var sym = new Symbol("foo", [], "OBJECT", new DocComment("/**@author Joe Smith*"+"/"));
262 assertEqual(sym.author, "Joe Smith", "@author tag, author is found.");
265 var mth = this.comment.getTag("method");
267 this.isa = "FUNCTION";
270 var descs = this.comment.getTag("desc");
272 this.desc = descs.map(function($){return $.desc;}).join("\n"); // multiple descriptions are concatenated into one
276 var sym = new Symbol("foo", [], "OBJECT", new DocComment("/**@desc This is a description.*"+"/"));
277 assertEqual(sym.desc, "This is a description.", "@desc tag, description is found.");
281 if (this.is("FILE")) {
282 if (!this.alias) this.alias = this.srcFile;
284 var overviews = this.comment.getTag("overview");
285 if (overviews.length) {
286 this.desc = [this.desc].concat(overviews.map(function($){return $.desc;})).join("\n");
291 var sym = new Symbol("foo", [], "FILE", new DocComment("/**@overview This is an overview.*"+"/"));
292 assertEqual(sym.desc, "\nThis is an overview.", "@overview tag, description is found.");
296 var sinces = this.comment.getTag("since");
298 this.since = sinces.map(function($){return $.desc;}).join(", ");
302 var sym = new Symbol("foo", [], "FILE", new DocComment("/**@since 1.01*"+"/"));
303 assertEqual(sym.since, "1.01", "@since tag, description is found.");
307 if (this.comment.getTag("constant").length) {
308 this.isConstant = true;
313 var sym = new Symbol("foo", [], "FILE", new DocComment("/**@constant*"+"/"));
314 assertEqual(sym.isConstant, true, "@constant tag, isConstant set.");
318 var versions = this.comment.getTag("version");
319 if (versions.length) {
320 this.version = versions.map(function($){return $.desc;}).join(", ");
324 var sym = new Symbol("foo", [], "FILE", new DocComment("/**@version 2.0x*"+"/"));
325 assertEqual(sym.version, "2.0x", "@version tag, version is found.");
329 var deprecateds = this.comment.getTag("deprecated");
330 if (deprecateds.length) {
331 this.deprecated = deprecateds.map(function($){return $.desc;}).join("\n");
335 var sym = new Symbol("foo", [], "FILE", new DocComment("/**@deprecated Use other method.*"+"/"));
336 assertEqual(sym.deprecated, "Use other method.", "@deprecated tag, desc is found.");
340 var examples = this.comment.getTag("example");
341 if (examples.length) {
342 this.example = examples[0];
346 var sym = new Symbol("foo", [], "FILE", new DocComment("/**@example This\n is an example.*"+"/"));
347 assertEqual(sym.example, "This\n is an example.", "@deprecated tag, desc is found.");
351 var sees = this.comment.getTag("see");
353 var thisSee = this.see;
354 sees.map(function($){thisSee.push($.desc);});
358 var sym = new Symbol("foo", [], "FILE", new DocComment("/**@see The other thing.*"+"/"));
359 assertEqual(sym.see, "The other thing.", "@see tag, desc is found.");
363 var classes = this.comment.getTag("class");
364 if (classes.length) {
365 this.isa = "CONSTRUCTOR";
366 this.classDesc = classes[0].desc; // desc can't apply to the constructor as there is none.
367 if (!this.classDesc) {
368 this.classDesc = this.desc;
375 var sym = new Symbol("foo", [], "OBJECT", new DocComment("/**@class This describes the class.*"+"/"));
376 assertEqual(sym.isa, "CONSTRUCTOR", "@class tag, makes symbol a constructor.");
377 assertEqual(sym.classDesc, "This describes the class.", "@class tag, class description is found.");
381 var namespaces = this.comment.getTag("namespace");
382 if (namespaces.length) {
383 this.classDesc = namespaces[0].desc+"\n"+this.desc; // desc can't apply to the constructor as there is none.
384 this.isNamespace = true;
388 var sym = new Symbol("foo", [], "OBJECT", new DocComment("/**@namespace This describes the namespace.*"+"/"));
389 assertEqual(sym.classDesc, "This describes the namespace.\n", "@namespace tag, class description is found.");
393 var params = this.comment.getTag("param");
395 // user-defined params overwrite those with same name defined by the parser
396 var thisParams = this.getParams();
398 if (thisParams.length == 0) { // none exist yet, so just bung all these user-defined params straight in
399 this.setParams(params);
401 else { // need to overlay these user-defined params on to existing parser-defined params
402 for (var i = 0, l = params.length; i < l; i++) {
404 if (params[i].type) thisParams[i].type = params[i].type;
405 thisParams[i].name = params[i].name;
406 thisParams[i].desc = params[i].desc;
407 thisParams[i].isOptional = params[i].isOptional;
408 thisParams[i].defaultValue = params[i].defaultValue;
410 else thisParams[i] = params[i];
416 var sym = new Symbol("foo", [{type: "array", name: "pages"}], "FUNCTION", new DocComment("/**Description.*"+"/"));
417 assertEqual(sym.params.length, 1, "parser defined param is found.");
419 sym = new Symbol("foo", [], "FUNCTION", new DocComment("/**Description.\n@param {array} pages*"+"/"));
420 assertEqual(sym.params.length, 1, "user defined param is found.");
421 assertEqual(sym.params[0].type, "array", "user defined param type is found.");
422 assertEqual(sym.params[0].name, "pages", "user defined param name is found.");
424 sym = new Symbol("foo", [{type: "array", name: "pages"}], "FUNCTION", new DocComment("/**Description.\n@param {string} uid*"+"/"));
425 assertEqual(sym.params.length, 1, "user defined param overwrites parser defined param.");
426 assertEqual(sym.params[0].type, "string", "user defined param type overwrites parser defined param type.");
427 assertEqual(sym.params[0].name, "uid", "user defined param name overwrites parser defined param name.");
429 sym = new Symbol("foo", [{type: "array", name: "pages"}, {type: "number", name: "count"}], "FUNCTION", new DocComment("/**Description.\n@param {string} uid*"+"/"));
430 assertEqual(sym.params.length, 2, "user defined params overlay parser defined params.");
431 assertEqual(sym.params[1].type, "number", "user defined param type overlays parser defined param type.");
432 assertEqual(sym.params[1].name, "count", "user defined param name overlays parser defined param name.");
434 sym = new Symbol("foo", [], "FUNCTION", new DocComment("/**Description.\n@param {array} pages The pages description.*"+"/"));
435 assertEqual(sym.params.length, 1, "user defined param with description is found.");
436 assertEqual(sym.params[0].desc, "The pages description.", "user defined param description is found.");
440 if (this.comment.getTag("constructor").length) {
441 this.isa = "CONSTRUCTOR";
445 var sym = new Symbol("foo", [], "OBJECT", new DocComment("/**@constructor*"+"/"));
446 assertEqual(sym.isa, "CONSTRUCTOR", "@constructor tag, makes symbol a constructor.");
450 if (this.comment.getTag("static").length) {
451 this.isStatic = true;
452 if (this.isa == "CONSTRUCTOR") {
453 this.isNamespace = true;
458 if (this.comment.getTag("singleton").length) {
459 this.isStatic = true;
460 //if (this.isa == "CONSTRUCTOR") {
461 // this.isNamespace = true;
468 var sym = new Symbol("foo", [], "OBJECT", new DocComment("/**@static\n@constructor*"+"/"));
469 assertEqual(sym.isStatic, true, "@static tag, makes isStatic true.");
470 assertEqual(sym.isNamespace, true, "@static and @constructor tag, makes isNamespace true.");
474 if (this.comment.getTag("inner").length) {
476 this.isStatic = false;
480 var sym = new Symbol("foo", [], "OBJECT", new DocComment("/**@inner*"+"/"));
481 assertEqual(sym.isStatic, false, "@inner tag, makes isStatic false.");
482 assertEqual(sym.isInner, true, "@inner makes isInner true.");
486 if (this.comment.getTag("field").length) {
491 var sym = new Symbol("foo", [], "FUNCTION", new DocComment("/**@field*"+"/"));
492 assertEqual(sym.isa, "OBJECT", "@field tag, makes symbol an object.");
496 if (this.comment.getTag("function").length) {
497 this.isa = "FUNCTION";
501 if (this.comment.getTag("param").length && this.isa == "OBJECT" ) {
502 // change a property to a function..
503 this.isa = "FUNCTION";
508 var sym = new Symbol("foo", [], "OBJECT", new DocComment("/**@function*"+"/"));
509 assertEqual(sym.isa, "FUNCTION", "@function tag, makes symbol a function.");
513 var events = this.comment.getTag("event");
515 this.isa = "FUNCTION";
520 var sym = new Symbol("foo", [], "OBJECT", new DocComment("/**@event*"+"/"));
521 assertEqual(sym.isa, "FUNCTION", "@event tag, makes symbol a function.");
522 assertEqual(sym.isEvent, true, "@event makes isEvent true.");
526 var names = this.comment.getTag("name");
528 this.setName(names[0].desc);
536 var properties = this.comment.getTag("property");
537 if (properties.length) {
538 thisProperties = this.properties;
539 for (var i = 0; i < properties.length; i++) {
540 var property = new Symbol(this.alias+"#"+properties[i].name, [], "OBJECT", new DocComment("/**"+properties[i].desc+"\n@name "+properties[i].name+"\n@memberOf "+this.alias+"#*/"));
541 // TODO: shouldn't the following happen in the addProperty method of Symbol?
542 property.name = properties[i].name;
543 property.memberOf = this.alias;
544 if (properties[i].type) property.type = properties[i].type;
545 if (properties[i].defaultValue) property.defaultValue = properties[i].defaultValue;
546 this.addProperty(property);
547 Symbol.parser.addSymbol(property);
552 var conf = this.comment.getTag("cfg");
554 for (var i = 0; i < conf.length; i++) {
555 this.addConfig(conf[i]);
564 var returns = this.comment.getTag("return");
565 if (returns.length) { // there can be many return tags in a single doclet
566 this.returns = returns;
567 this.type = returns.map(function($){return $.type}).join(", ");
575 this.exceptions = this.comment.getTag("throws");
582 var requires = this.comment.getTag("requires");
583 if (requires.length) {
584 this.requires = requires.map(function($){return $.desc});
592 var types = this.comment.getTag("type");
594 this.type = types[0].desc; //multiple type tags are ignored
602 if (this.comment.getTag("private").length || this.isInner) {
603 this.isPrivate = true;
607 if (this.comment.getTag("ignore").length) {
608 this.isIgnored = true;
615 // @inherits ... as ...
616 var inherits = this.comment.getTag("inherits");
617 if (inherits.length) {
618 for (var i = 0; i < inherits.length; i++) {
619 if (/^\s*([a-z$0-9_.#-]+)(?:\s+as\s+([a-z$0-9_.#]+))?/i.test(inherits[i].desc)) {
620 var inAlias = RegExp.$1;
621 var inAs = RegExp.$2 || inAlias;
623 if (inAlias) inAlias = inAlias.replace(/\.prototype\.?/g, "#");
626 inAs = inAs.replace(/\.prototype\.?/g, "#");
627 inAs = inAs.replace(/^this\.?/, "#");
630 if (inAs.indexOf(inAlias) != 0) { //not a full namepath
632 if (this.alias.charAt(this.alias.length-1) == "#" || inAs.charAt(0) == "#") {
635 inAs = this.alias + joiner + inAs;
638 this.inherits.push({alias: inAlias, as: inAs});
647 this.augments = this.comment.getTag("augments");
650 if (this.comment.getTag("extends")) {
651 this.augments = this.comment.getTag("extends");
656 var defaults = this.comment.getTag("default");
657 if (defaults.length) {
658 if (this.is("OBJECT")) {
659 this.defaultValue = defaults[0].desc;
668 var memberOfs = this.comment.getTag("memberOf");
669 if (memberOfs.length) {
670 this.memberOf = memberOfs[0].desc;
671 this.memberOf = this.memberOf.replace(/\.prototype\.?/g, "#");
672 this.name = this.name.split('.').pop();
673 this.name = this.name.split('#').pop();
674 this.name = this.memberOf + this.name;
675 this._name = this.name
676 this.alias = this.name;
684 if (this.comment.getTag("public").length) {
685 this.isPrivate = false;
693 is : function(what) {
694 return this.isa === what;
697 isBuiltin : function() {
698 return SymbolSet.isBuiltin(this.alias);
701 setType : function(/**String*/comment, /**Boolean*/overwrite) {
702 if (!overwrite && this.type) return;
703 var typeComment = DocComment.unwrapComment(comment);
704 this.type = typeComment;
707 inherit : function(symbol) {
708 if (!this.hasMember(symbol.name) && !symbol.isInner) {
709 if (symbol.is("FUNCTION"))
710 this.methods.push(symbol);
711 else if (symbol.is("OBJECT"))
712 this.properties.push(symbol);
716 hasMember : function(name) {
717 return (this.hasMethod(name) || this.hasProperty(name));
720 addMember : function(symbol) {
721 //println("ADDMEMBER: " + this.name + " ++ " + symbol.name);
723 if (symbol.comment.getTag("cfg").length == 1) {
724 symbol.comment.getTag("cfg")[0].memberOf = this.alias;
725 this.addConfig(symbol.comment.getTag("cfg")[0]);
729 if (symbol.is("FUNCTION")) { this.addMethod(symbol); }
730 else if (symbol.is("OBJECT")) { this.addProperty(symbol); }
733 hasMethod : function(name) {
734 var thisMethods = this.methods;
735 for (var i = 0, l = thisMethods.length; i < l; i++) {
736 if (thisMethods[i].name == name) return true;
737 if (thisMethods[i].alias == name) return true;
742 addMethod : function(symbol) {
743 var methodAlias = symbol.alias;
744 var thisMethods = this.methods;
745 for (var i = 0, l = thisMethods.length; i < l; i++) {
746 if (thisMethods[i].alias == methodAlias) {
747 thisMethods[i] = symbol; // overwriting previous method
751 thisMethods.push(symbol); // new method with this alias
754 hasProperty : function(name) {
755 var thisProperties = this.properties;
756 for (var i = 0, l = thisProperties.length; i < l; i++) {
757 if (thisProperties[i].name == name) return true;
758 if (thisProperties[i].alias == name) return true;
763 addProperty : function(symbol) {
764 var propertyAlias = symbol.alias;
765 var thisProperties = this.properties;
766 for (var i = 0, l = thisProperties.length; i < l; i++) {
767 if (thisProperties[i].alias == propertyAlias) {
768 thisProperties[i] = symbol; // overwriting previous property
773 thisProperties.push(symbol); // new property with this alias
776 addDocTag : function(docTag)
778 this.comment.tags.push(docTag);
779 if (docTag.title == 'cfg') {
780 this.addConfig(docTag);
785 addConfig : function(docTag)
787 if (typeof(docTag['memberOf']) == 'undefined') {
788 // remove prototype data...
789 //var a = this.alias.split('#')[0];
790 //docTag.memberOf = a;
791 docTag.memberOf = this.alias;
793 if (typeof(this.cfgs[docTag.name]) == 'undefined') {
794 this.cfgs[docTag.name] = docTag;
798 configToArray: function()
801 for(var ci in this.cfgs) {
802 // dont show hidden!!
803 if (this.cfgs[ci].desc.match(/@hide/)) {
806 r.push(this.cfgs[ci]);
814 * Elements that are not serialized
818 '$args' // not needed AFAIK
821 Symbol.srcFile = ""; //running reference to the current file being parsed
824 Symbol.fromDump = function(t)
826 var ns = new Symbol();
828 if (typeof(ns[i]) == "undefined") {
829 println("ERR:no default for Symbol:"+ i);
835 Symbol.parser = false; // set up by parser..