4 @class Represents a symbol in the source code.
11 public class Symbol : Object
19 // probably needs vairous CTORS..
23 string defaultValue : "",
28 augments : [], // Doctag[]
29 exceptions : [], // Doctag[]
30 inherits : [], // Doctag[]
31 methods : [], // Symbol[]
33 _params : [], //Doctag[]
34 properties : [], //Doctag[]
35 requires : [], //Doctag[]
36 returns : [], //Doctag[]
46 //$args : [], // original arguments used when constructing.
48 public string alias = "";
51 string classDesc = "";
53 string deprecated = "";
59 string isa = "OBJECT"; // OBJECT//FUNCTION
61 public bool isEvent = false;
62 public bool isConstant = false;
63 public bool isIgnored = false;
64 public bool isInner = false;
65 public bool isNamespace = false;
66 public bool isPrivate = false;
67 public bool isStatic = false;
83 public void initArrays()
85 // only initialize arrays / objects..
95 this.isa = "OBJECT"; // OBJECT//FUNCTION
107 this.inheritsFrom = [];
108 this.childClasses = [];
110 this.comment = new DocComment();
111 this.comment.isUserComment = false;
116 Public Symbol.new_builtin(string name)
118 this.srcFile = DocParser.currentSourceFile;
119 this.setName( name );
120 this.alias = this.getName();
121 this.isa = "CONSTRUCTOR";
122 this.comment = new DocComment("");
123 this.comment.isUserComment = false;
124 this.isNamespace = false;
126 this.isPrivate = false;
134 //__defineSetter__("name",
135 setName : function(n) {
136 n = n.replace(/^_global_[.#-]/, "");
137 n = n.replace(/\.prototype\.?/g, '#');
138 n = n.replace(/#$/g, '');
140 this.name = n; // real!
143 //__defineGetter__("name",
144 getName : function() { return this._name; },
146 //__defineSetter__("params",
147 setParams :function(v) {
148 for (var i = 0, l = v.length; i < l; i++) {
149 if (v[i].constructor != DocTag) { // may be a generic object parsed from signature, like {type:..., name:...}
150 var ty = v[i].hasOwnProperty('type') ? v[i].type : '';
151 this._params[i] = new DocTag(
152 "param"+((ty)?" {"+ty+"}":"")+" "+v[i].name);
155 this._params[i] = v[i];
158 this.params = this._params;
163 //__defineGetter__("params",
164 public getParams : function() {
169 public Symbol.new_populate_with_args(
171 Gee.ArrayList<string> params, // fixme???
175 this.$args = arguments;
176 //println("Symbol created: " + isa + ":" + name);
178 this.alias = this.getName();
179 this.setParams(params);
180 this.isa = (isa == "VIRTUAL")? "OBJECT":isa;
181 this.comment = comment || new DocComment("")
183 this.srcFile = DocParser.currentSourceFile;
187 if (this.is("FILE") && !this.alias) { // this will never hapen???
188 this.alias = this.srcFile;
195 setTags : function() {
197 var authors = this.comment.getTag("author");
198 if (authors.length) {
199 this.author = authors.map(function($){return $.desc;}).join(", ");
203 assert("testing Symbol");
205 requires("../lib/JSDOC/DocComment.js");
206 requires("../frame/String.js");
207 requires("../lib/JSDOC/DocTag.js");
209 var sym = new Symbol("foo", [], "OBJECT", new DocComment("/**@author Joe Smith*"+"/"));
210 assertEqual(sym.author, "Joe Smith", "@author tag, author is found.");
213 var mth = this.comment.getTag("method");
215 this.isa = "FUNCTION";
218 var descs = this.comment.getTag("desc");
220 this.desc = descs.map(function($){return $.desc;}).join("\n"); // multiple descriptions are concatenated into one
224 var sym = new Symbol("foo", [], "OBJECT", new DocComment("/**@desc This is a description.*"+"/"));
225 assertEqual(sym.desc, "This is a description.", "@desc tag, description is found.");
229 if (this.is("FILE")) {
230 if (!this.alias) this.alias = this.srcFile;
232 var overviews = this.comment.getTag("overview");
233 if (overviews.length) {
234 this.desc = [this.desc].concat(overviews.map(function($){return $.desc;})).join("\n");
239 var sym = new Symbol("foo", [], "FILE", new DocComment("/**@overview This is an overview.*"+"/"));
240 assertEqual(sym.desc, "\nThis is an overview.", "@overview tag, description is found.");
244 var sinces = this.comment.getTag("since");
246 this.since = sinces.map(function($){return $.desc;}).join(", ");
250 var sym = new Symbol("foo", [], "FILE", new DocComment("/**@since 1.01*"+"/"));
251 assertEqual(sym.since, "1.01", "@since tag, description is found.");
255 if (this.comment.getTag("constant").length) {
256 this.isConstant = true;
261 var sym = new Symbol("foo", [], "FILE", new DocComment("/**@constant*"+"/"));
262 assertEqual(sym.isConstant, true, "@constant tag, isConstant set.");
266 var versions = this.comment.getTag("version");
267 if (versions.length) {
268 this.version = versions.map(function($){return $.desc;}).join(", ");
272 var sym = new Symbol("foo", [], "FILE", new DocComment("/**@version 2.0x*"+"/"));
273 assertEqual(sym.version, "2.0x", "@version tag, version is found.");
277 var deprecateds = this.comment.getTag("deprecated");
278 if (deprecateds.length) {
279 this.deprecated = deprecateds.map(function($){return $.desc;}).join("\n");
283 var sym = new Symbol("foo", [], "FILE", new DocComment("/**@deprecated Use other method.*"+"/"));
284 assertEqual(sym.deprecated, "Use other method.", "@deprecated tag, desc is found.");
288 var examples = this.comment.getTag("example");
289 if (examples.length) {
290 this.example = examples[0];
294 var sym = new Symbol("foo", [], "FILE", new DocComment("/**@example This\n is an example.*"+"/"));
295 assertEqual(sym.example, "This\n is an example.", "@deprecated tag, desc is found.");
299 var sees = this.comment.getTag("see");
301 var thisSee = this.see;
302 sees.map(function($){thisSee.push($.desc);});
306 var sym = new Symbol("foo", [], "FILE", new DocComment("/**@see The other thing.*"+"/"));
307 assertEqual(sym.see, "The other thing.", "@see tag, desc is found.");
311 var classes = this.comment.getTag("class");
312 if (classes.length) {
313 //print(JSON.stringify(this,null,4));
314 this.isa = "CONSTRUCTOR";
315 this.classDesc = classes[0].desc; // desc can't apply to the constructor as there is none.
316 if (!this.classDesc) {
317 this.classDesc = this.desc;
324 var sym = new Symbol("foo", [], "OBJECT", new DocComment("/**@class This describes the class.*"+"/"));
325 assertEqual(sym.isa, "CONSTRUCTOR", "@class tag, makes symbol a constructor.");
326 assertEqual(sym.classDesc, "This describes the class.", "@class tag, class description is found.");
330 var namespaces = this.comment.getTag("namespace");
331 if (namespaces.length) {
332 this.classDesc = namespaces[0].desc+"\n"+this.desc; // desc can't apply to the constructor as there is none.
333 this.isNamespace = true;
337 var sym = new Symbol("foo", [], "OBJECT", new DocComment("/**@namespace This describes the namespace.*"+"/"));
338 assertEqual(sym.classDesc, "This describes the namespace.\n", "@namespace tag, class description is found.");
342 var params = this.comment.getTag("param");
344 // user-defined params overwrite those with same name defined by the parser
345 var thisParams = this.getParams();
347 if (thisParams.length == 0) { // none exist yet, so just bung all these user-defined params straight in
348 this.setParams(params);
350 else { // need to overlay these user-defined params on to existing parser-defined params
351 for (var i = 0, l = params.length; i < l; i++) {
353 if (params[i].type) thisParams[i].type = params[i].type;
354 thisParams[i].name = params[i].name;
355 thisParams[i].desc = params[i].desc;
356 thisParams[i].isOptional = params[i].isOptional;
357 thisParams[i].defaultValue = params[i].defaultValue;
359 else thisParams[i] = params[i];
365 var sym = new Symbol("foo", [{type: "array", name: "pages"}], "FUNCTION", new DocComment("/**Description.*"+"/"));
366 assertEqual(sym.params.length, 1, "parser defined param is found.");
368 sym = new Symbol("foo", [], "FUNCTION", new DocComment("/**Description.\n@param {array} pages*"+"/"));
369 assertEqual(sym.params.length, 1, "user defined param is found.");
370 assertEqual(sym.params[0].type, "array", "user defined param type is found.");
371 assertEqual(sym.params[0].name, "pages", "user defined param name is found.");
373 sym = new Symbol("foo", [{type: "array", name: "pages"}], "FUNCTION", new DocComment("/**Description.\n@param {string} uid*"+"/"));
374 assertEqual(sym.params.length, 1, "user defined param overwrites parser defined param.");
375 assertEqual(sym.params[0].type, "string", "user defined param type overwrites parser defined param type.");
376 assertEqual(sym.params[0].name, "uid", "user defined param name overwrites parser defined param name.");
378 sym = new Symbol("foo", [{type: "array", name: "pages"}, {type: "number", name: "count"}], "FUNCTION", new DocComment("/**Description.\n@param {string} uid*"+"/"));
379 assertEqual(sym.params.length, 2, "user defined params overlay parser defined params.");
380 assertEqual(sym.params[1].type, "number", "user defined param type overlays parser defined param type.");
381 assertEqual(sym.params[1].name, "count", "user defined param name overlays parser defined param name.");
383 sym = new Symbol("foo", [], "FUNCTION", new DocComment("/**Description.\n@param {array} pages The pages description.*"+"/"));
384 assertEqual(sym.params.length, 1, "user defined param with description is found.");
385 assertEqual(sym.params[0].desc, "The pages description.", "user defined param description is found.");
389 if (this.comment.getTag("constructor").length) {
390 this.isa = "CONSTRUCTOR";
394 var sym = new Symbol("foo", [], "OBJECT", new DocComment("/**@constructor*"+"/"));
395 assertEqual(sym.isa, "CONSTRUCTOR", "@constructor tag, makes symbol a constructor.");
399 if (this.comment.getTag("static").length) {
400 this.isStatic = true;
401 if (this.isa == "CONSTRUCTOR") {
402 this.isNamespace = true;
407 if (this.comment.getTag("singleton").length) {
408 this.isStatic = true;
409 //print('------------- got singleton ---------------' + this.isa);
410 //if (this.isa == "CONSTRUCTOR") {
411 // this.isNamespace = true;
418 var sym = new Symbol("foo", [], "OBJECT", new DocComment("/**@static\n@constructor*"+"/"));
419 assertEqual(sym.isStatic, true, "@static tag, makes isStatic true.");
420 assertEqual(sym.isNamespace, true, "@static and @constructor tag, makes isNamespace true.");
424 if (this.comment.getTag("inner").length) {
426 this.isStatic = false;
430 var sym = new Symbol("foo", [], "OBJECT", new DocComment("/**@inner*"+"/"));
431 assertEqual(sym.isStatic, false, "@inner tag, makes isStatic false.");
432 assertEqual(sym.isInner, true, "@inner makes isInner true.");
436 if (this.comment.getTag("field").length) {
441 var sym = new Symbol("foo", [], "FUNCTION", new DocComment("/**@field*"+"/"));
442 assertEqual(sym.isa, "OBJECT", "@field tag, makes symbol an object.");
446 if (this.comment.getTag("function").length) {
447 this.isa = "FUNCTION";
451 if (this.comment.getTag("param").length && this.isa == "OBJECT" ) {
452 // change a property to a function..
453 this.isa = "FUNCTION";
458 var sym = new Symbol("foo", [], "OBJECT", new DocComment("/**@function*"+"/"));
459 assertEqual(sym.isa, "FUNCTION", "@function tag, makes symbol a function.");
463 var events = this.comment.getTag("event");
465 this.isa = "FUNCTION";
470 var sym = new Symbol("foo", [], "OBJECT", new DocComment("/**@event*"+"/"));
471 assertEqual(sym.isa, "FUNCTION", "@event tag, makes symbol a function.");
472 assertEqual(sym.isEvent, true, "@event makes isEvent true.");
476 var names = this.comment.getTag("name");
478 this.setName(names[0].desc);
486 var properties = this.comment.getTag("property");
487 if (properties.length) {
488 thisProperties = this.properties;
489 for (var i = 0; i < properties.length; i++) {
490 var property = new Symbol(this.alias+"#"+properties[i].name, [], "OBJECT", new DocComment("/**"+properties[i].desc+"\n@name "+properties[i].name+"\n@memberOf "+this.alias+"#*/"));
491 // TODO: shouldn't the following happen in the addProperty method of Symbol?
492 property.name = properties[i].name;
493 property.memberOf = this.alias;
494 if (properties[i].type) property.type = properties[i].type;
495 if (properties[i].defaultValue) property.defaultValue = properties[i].defaultValue;
496 this.addProperty(property);
497 imports.Parser.Parser.addSymbol(property);
502 var conf = this.comment.getTag("cfg");
504 for (var i = 0; i < conf.length; i++) {
505 this.addConfig(conf[i]);
514 var returns = this.comment.getTag("return");
515 if (returns.length) { // there can be many return tags in a single doclet
516 this.returns = returns;
517 this.type = returns.map(function($){return $.type}).join(", ");
525 this.exceptions = this.comment.getTag("throws");
532 var requires = this.comment.getTag("requires");
533 if (requires.length) {
534 this.requires = requires.map(function($){return $.desc});
542 var types = this.comment.getTag("type");
544 this.type = types[0].desc; //multiple type tags are ignored
552 if (this.comment.getTag("private").length || this.isInner) {
553 this.isPrivate = true;
557 if (this.comment.getTag("ignore").length) {
558 this.isIgnored = true;
565 // @inherits ... as ...
566 var inherits = this.comment.getTag("inherits");
567 if (inherits.length) {
568 for (var i = 0; i < inherits.length; i++) {
569 if (/^\s*([a-z$0-9_.#-]+)(?:\s+as\s+([a-z$0-9_.#]+))?/i.test(inherits[i].desc)) {
570 var inAlias = RegExp.$1;
571 var inAs = RegExp.$2 || inAlias;
573 if (inAlias) inAlias = inAlias.replace(/\.prototype\.?/g, "#");
576 inAs = inAs.replace(/\.prototype\.?/g, "#");
577 inAs = inAs.replace(/^this\.?/, "#");
580 if (inAs.indexOf(inAlias) != 0) { //not a full namepath
582 if (this.alias.charAt(this.alias.length-1) == "#" || inAs.charAt(0) == "#") {
585 inAs = this.alias + joiner + inAs;
588 this.inherits.push({alias: inAlias, as: inAs});
597 this.augments = this.comment.getTag("augments");
600 if (this.comment.getTag("extends")) {
601 this.augments = this.comment.getTag("extends");
606 var defaults = this.comment.getTag("default");
607 if (defaults.length) {
608 if (this.is("OBJECT")) {
609 this.defaultValue = defaults[0].desc;
618 var memberOfs = this.comment.getTag("memberOf");
619 if (memberOfs.length) {
620 this.memberOf = memberOfs[0].desc;
621 this.memberOf = this.memberOf.replace(/\.prototype\.?/g, "#");
622 this.name = this.name.split('.').pop();
623 this.name = this.name.split('#').pop();
624 this.name = this.memberOf + this.name;
625 this._name = this.name
626 this.alias = this.name;
634 if (this.comment.getTag("public").length) {
635 this.isPrivate = false;
643 is : function(what) {
644 return this.isa === what;
647 isBuiltin : function() {
648 return SymbolSet.isBuiltin(this.alias);
651 setType : function(/**String*/comment, /**Boolean*/overwrite) {
652 if (!overwrite && this.type) return;
653 var typeComment = DocComment.unwrapComment(comment);
654 this.type = typeComment;
657 inherit : function(symbol) {
658 if (!this.hasMember(symbol.name) && !symbol.isInner) {
659 if (symbol.is("FUNCTION"))
660 this.methods.push(symbol);
661 else if (symbol.is("OBJECT"))
662 this.properties.push(symbol);
666 hasMember : function(name) {
667 return (this.hasMethod(name) || this.hasProperty(name));
670 addMember : function(symbol) {
671 //println("ADDMEMBER: " + this.name + " ++ " + symbol.name);
673 if (symbol.comment.getTag("cfg").length == 1) {
674 symbol.comment.getTag("cfg")[0].memberOf = this.alias;
675 this.addConfig(symbol.comment.getTag("cfg")[0]);
679 if (symbol.is("FUNCTION")) { this.addMethod(symbol); }
680 else if (symbol.is("OBJECT")) { this.addProperty(symbol); }
683 hasMethod : function(name) {
684 var thisMethods = this.methods;
685 for (var i = 0, l = thisMethods.length; i < l; i++) {
686 if (thisMethods[i].name == name) return true;
687 if (thisMethods[i].alias == name) return true;
692 addMethod : function(symbol) {
693 var methodAlias = symbol.alias;
694 var thisMethods = this.methods;
695 for (var i = 0, l = thisMethods.length; i < l; i++) {
696 if (thisMethods[i].alias == methodAlias) {
697 thisMethods[i] = symbol; // overwriting previous method
701 thisMethods.push(symbol); // new method with this alias
704 hasProperty : function(name) {
705 var thisProperties = this.properties;
706 for (var i = 0, l = thisProperties.length; i < l; i++) {
707 if (thisProperties[i].name == name) return true;
708 if (thisProperties[i].alias == name) return true;
713 addProperty : function(symbol) {
714 var propertyAlias = symbol.alias;
715 var thisProperties = this.properties;
716 for (var i = 0, l = thisProperties.length; i < l; i++) {
717 if (thisProperties[i].alias == propertyAlias) {
718 thisProperties[i] = symbol; // overwriting previous property
723 thisProperties.push(symbol); // new property with this alias
726 addDocTag : function(docTag)
728 this.comment.tags.push(docTag);
729 if (docTag.title == 'cfg') {
730 this.addConfig(docTag);
735 addConfig : function(docTag)
737 if (typeof(docTag['memberOf']) == 'undefined') {
738 // remove prototype data...
739 //var a = this.alias.split('#')[0];
740 //docTag.memberOf = a;
741 docTag.memberOf = this.alias;
743 if (typeof(this.cfgs[docTag.name]) == 'undefined') {
744 this.cfgs[docTag.name] = docTag;
748 configToArray: function()
751 for(var ci in this.cfgs) {
752 // dont show hidden!!
753 if (this.cfgs[ci].desc.match(/@hide/)) {
756 r.push(this.cfgs[ci]);
764 * Elements that are not serialized
768 '$args' // not needed AFAIK
771 Symbol.srcFile = ""; //running reference to the current file being parsed
774 Symbol.fromDump = function(t)
776 var ns = new Symbol();
778 if (typeof(ns[i]) == "undefined") {
779 println("ERR:no default for Symbol:"+ i);