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 getParams : function() { return this._params; },
167 public Symbol.new_populate(
169 Gee.ArrayList<string> params, // fixme???
173 this.$args = arguments;
174 //println("Symbol created: " + isa + ":" + name);
176 this.alias = this.getName();
177 this.setParams(params);
178 this.isa = (isa == "VIRTUAL")? "OBJECT":isa;
179 this.comment = comment || new DocComment("")
181 this.srcFile = DocParser.currentSourceFile;
185 if (this.is("FILE") && !this.alias) { // this will never hapen???
186 this.alias = this.srcFile;
193 setTags : function() {
195 var authors = this.comment.getTag("author");
196 if (authors.length) {
197 this.author = authors.map(function($){return $.desc;}).join(", ");
201 assert("testing Symbol");
203 requires("../lib/JSDOC/DocComment.js");
204 requires("../frame/String.js");
205 requires("../lib/JSDOC/DocTag.js");
207 var sym = new Symbol("foo", [], "OBJECT", new DocComment("/**@author Joe Smith*"+"/"));
208 assertEqual(sym.author, "Joe Smith", "@author tag, author is found.");
211 var mth = this.comment.getTag("method");
213 this.isa = "FUNCTION";
216 var descs = this.comment.getTag("desc");
218 this.desc = descs.map(function($){return $.desc;}).join("\n"); // multiple descriptions are concatenated into one
222 var sym = new Symbol("foo", [], "OBJECT", new DocComment("/**@desc This is a description.*"+"/"));
223 assertEqual(sym.desc, "This is a description.", "@desc tag, description is found.");
227 if (this.is("FILE")) {
228 if (!this.alias) this.alias = this.srcFile;
230 var overviews = this.comment.getTag("overview");
231 if (overviews.length) {
232 this.desc = [this.desc].concat(overviews.map(function($){return $.desc;})).join("\n");
237 var sym = new Symbol("foo", [], "FILE", new DocComment("/**@overview This is an overview.*"+"/"));
238 assertEqual(sym.desc, "\nThis is an overview.", "@overview tag, description is found.");
242 var sinces = this.comment.getTag("since");
244 this.since = sinces.map(function($){return $.desc;}).join(", ");
248 var sym = new Symbol("foo", [], "FILE", new DocComment("/**@since 1.01*"+"/"));
249 assertEqual(sym.since, "1.01", "@since tag, description is found.");
253 if (this.comment.getTag("constant").length) {
254 this.isConstant = true;
259 var sym = new Symbol("foo", [], "FILE", new DocComment("/**@constant*"+"/"));
260 assertEqual(sym.isConstant, true, "@constant tag, isConstant set.");
264 var versions = this.comment.getTag("version");
265 if (versions.length) {
266 this.version = versions.map(function($){return $.desc;}).join(", ");
270 var sym = new Symbol("foo", [], "FILE", new DocComment("/**@version 2.0x*"+"/"));
271 assertEqual(sym.version, "2.0x", "@version tag, version is found.");
275 var deprecateds = this.comment.getTag("deprecated");
276 if (deprecateds.length) {
277 this.deprecated = deprecateds.map(function($){return $.desc;}).join("\n");
281 var sym = new Symbol("foo", [], "FILE", new DocComment("/**@deprecated Use other method.*"+"/"));
282 assertEqual(sym.deprecated, "Use other method.", "@deprecated tag, desc is found.");
286 var examples = this.comment.getTag("example");
287 if (examples.length) {
288 this.example = examples[0];
292 var sym = new Symbol("foo", [], "FILE", new DocComment("/**@example This\n is an example.*"+"/"));
293 assertEqual(sym.example, "This\n is an example.", "@deprecated tag, desc is found.");
297 var sees = this.comment.getTag("see");
299 var thisSee = this.see;
300 sees.map(function($){thisSee.push($.desc);});
304 var sym = new Symbol("foo", [], "FILE", new DocComment("/**@see The other thing.*"+"/"));
305 assertEqual(sym.see, "The other thing.", "@see tag, desc is found.");
309 var classes = this.comment.getTag("class");
310 if (classes.length) {
311 //print(JSON.stringify(this,null,4));
312 this.isa = "CONSTRUCTOR";
313 this.classDesc = classes[0].desc; // desc can't apply to the constructor as there is none.
314 if (!this.classDesc) {
315 this.classDesc = this.desc;
322 var sym = new Symbol("foo", [], "OBJECT", new DocComment("/**@class This describes the class.*"+"/"));
323 assertEqual(sym.isa, "CONSTRUCTOR", "@class tag, makes symbol a constructor.");
324 assertEqual(sym.classDesc, "This describes the class.", "@class tag, class description is found.");
328 var namespaces = this.comment.getTag("namespace");
329 if (namespaces.length) {
330 this.classDesc = namespaces[0].desc+"\n"+this.desc; // desc can't apply to the constructor as there is none.
331 this.isNamespace = true;
335 var sym = new Symbol("foo", [], "OBJECT", new DocComment("/**@namespace This describes the namespace.*"+"/"));
336 assertEqual(sym.classDesc, "This describes the namespace.\n", "@namespace tag, class description is found.");
340 var params = this.comment.getTag("param");
342 // user-defined params overwrite those with same name defined by the parser
343 var thisParams = this.getParams();
345 if (thisParams.length == 0) { // none exist yet, so just bung all these user-defined params straight in
346 this.setParams(params);
348 else { // need to overlay these user-defined params on to existing parser-defined params
349 for (var i = 0, l = params.length; i < l; i++) {
351 if (params[i].type) thisParams[i].type = params[i].type;
352 thisParams[i].name = params[i].name;
353 thisParams[i].desc = params[i].desc;
354 thisParams[i].isOptional = params[i].isOptional;
355 thisParams[i].defaultValue = params[i].defaultValue;
357 else thisParams[i] = params[i];
363 var sym = new Symbol("foo", [{type: "array", name: "pages"}], "FUNCTION", new DocComment("/**Description.*"+"/"));
364 assertEqual(sym.params.length, 1, "parser defined param is found.");
366 sym = new Symbol("foo", [], "FUNCTION", new DocComment("/**Description.\n@param {array} pages*"+"/"));
367 assertEqual(sym.params.length, 1, "user defined param is found.");
368 assertEqual(sym.params[0].type, "array", "user defined param type is found.");
369 assertEqual(sym.params[0].name, "pages", "user defined param name is found.");
371 sym = new Symbol("foo", [{type: "array", name: "pages"}], "FUNCTION", new DocComment("/**Description.\n@param {string} uid*"+"/"));
372 assertEqual(sym.params.length, 1, "user defined param overwrites parser defined param.");
373 assertEqual(sym.params[0].type, "string", "user defined param type overwrites parser defined param type.");
374 assertEqual(sym.params[0].name, "uid", "user defined param name overwrites parser defined param name.");
376 sym = new Symbol("foo", [{type: "array", name: "pages"}, {type: "number", name: "count"}], "FUNCTION", new DocComment("/**Description.\n@param {string} uid*"+"/"));
377 assertEqual(sym.params.length, 2, "user defined params overlay parser defined params.");
378 assertEqual(sym.params[1].type, "number", "user defined param type overlays parser defined param type.");
379 assertEqual(sym.params[1].name, "count", "user defined param name overlays parser defined param name.");
381 sym = new Symbol("foo", [], "FUNCTION", new DocComment("/**Description.\n@param {array} pages The pages description.*"+"/"));
382 assertEqual(sym.params.length, 1, "user defined param with description is found.");
383 assertEqual(sym.params[0].desc, "The pages description.", "user defined param description is found.");
387 if (this.comment.getTag("constructor").length) {
388 this.isa = "CONSTRUCTOR";
392 var sym = new Symbol("foo", [], "OBJECT", new DocComment("/**@constructor*"+"/"));
393 assertEqual(sym.isa, "CONSTRUCTOR", "@constructor tag, makes symbol a constructor.");
397 if (this.comment.getTag("static").length) {
398 this.isStatic = true;
399 if (this.isa == "CONSTRUCTOR") {
400 this.isNamespace = true;
405 if (this.comment.getTag("singleton").length) {
406 this.isStatic = true;
407 //print('------------- got singleton ---------------' + this.isa);
408 //if (this.isa == "CONSTRUCTOR") {
409 // this.isNamespace = true;
416 var sym = new Symbol("foo", [], "OBJECT", new DocComment("/**@static\n@constructor*"+"/"));
417 assertEqual(sym.isStatic, true, "@static tag, makes isStatic true.");
418 assertEqual(sym.isNamespace, true, "@static and @constructor tag, makes isNamespace true.");
422 if (this.comment.getTag("inner").length) {
424 this.isStatic = false;
428 var sym = new Symbol("foo", [], "OBJECT", new DocComment("/**@inner*"+"/"));
429 assertEqual(sym.isStatic, false, "@inner tag, makes isStatic false.");
430 assertEqual(sym.isInner, true, "@inner makes isInner true.");
434 if (this.comment.getTag("field").length) {
439 var sym = new Symbol("foo", [], "FUNCTION", new DocComment("/**@field*"+"/"));
440 assertEqual(sym.isa, "OBJECT", "@field tag, makes symbol an object.");
444 if (this.comment.getTag("function").length) {
445 this.isa = "FUNCTION";
449 if (this.comment.getTag("param").length && this.isa == "OBJECT" ) {
450 // change a property to a function..
451 this.isa = "FUNCTION";
456 var sym = new Symbol("foo", [], "OBJECT", new DocComment("/**@function*"+"/"));
457 assertEqual(sym.isa, "FUNCTION", "@function tag, makes symbol a function.");
461 var events = this.comment.getTag("event");
463 this.isa = "FUNCTION";
468 var sym = new Symbol("foo", [], "OBJECT", new DocComment("/**@event*"+"/"));
469 assertEqual(sym.isa, "FUNCTION", "@event tag, makes symbol a function.");
470 assertEqual(sym.isEvent, true, "@event makes isEvent true.");
474 var names = this.comment.getTag("name");
476 this.setName(names[0].desc);
484 var properties = this.comment.getTag("property");
485 if (properties.length) {
486 thisProperties = this.properties;
487 for (var i = 0; i < properties.length; i++) {
488 var property = new Symbol(this.alias+"#"+properties[i].name, [], "OBJECT", new DocComment("/**"+properties[i].desc+"\n@name "+properties[i].name+"\n@memberOf "+this.alias+"#*/"));
489 // TODO: shouldn't the following happen in the addProperty method of Symbol?
490 property.name = properties[i].name;
491 property.memberOf = this.alias;
492 if (properties[i].type) property.type = properties[i].type;
493 if (properties[i].defaultValue) property.defaultValue = properties[i].defaultValue;
494 this.addProperty(property);
495 imports.Parser.Parser.addSymbol(property);
500 var conf = this.comment.getTag("cfg");
502 for (var i = 0; i < conf.length; i++) {
503 this.addConfig(conf[i]);
512 var returns = this.comment.getTag("return");
513 if (returns.length) { // there can be many return tags in a single doclet
514 this.returns = returns;
515 this.type = returns.map(function($){return $.type}).join(", ");
523 this.exceptions = this.comment.getTag("throws");
530 var requires = this.comment.getTag("requires");
531 if (requires.length) {
532 this.requires = requires.map(function($){return $.desc});
540 var types = this.comment.getTag("type");
542 this.type = types[0].desc; //multiple type tags are ignored
550 if (this.comment.getTag("private").length || this.isInner) {
551 this.isPrivate = true;
555 if (this.comment.getTag("ignore").length) {
556 this.isIgnored = true;
563 // @inherits ... as ...
564 var inherits = this.comment.getTag("inherits");
565 if (inherits.length) {
566 for (var i = 0; i < inherits.length; i++) {
567 if (/^\s*([a-z$0-9_.#-]+)(?:\s+as\s+([a-z$0-9_.#]+))?/i.test(inherits[i].desc)) {
568 var inAlias = RegExp.$1;
569 var inAs = RegExp.$2 || inAlias;
571 if (inAlias) inAlias = inAlias.replace(/\.prototype\.?/g, "#");
574 inAs = inAs.replace(/\.prototype\.?/g, "#");
575 inAs = inAs.replace(/^this\.?/, "#");
578 if (inAs.indexOf(inAlias) != 0) { //not a full namepath
580 if (this.alias.charAt(this.alias.length-1) == "#" || inAs.charAt(0) == "#") {
583 inAs = this.alias + joiner + inAs;
586 this.inherits.push({alias: inAlias, as: inAs});
595 this.augments = this.comment.getTag("augments");
598 if (this.comment.getTag("extends")) {
599 this.augments = this.comment.getTag("extends");
604 var defaults = this.comment.getTag("default");
605 if (defaults.length) {
606 if (this.is("OBJECT")) {
607 this.defaultValue = defaults[0].desc;
616 var memberOfs = this.comment.getTag("memberOf");
617 if (memberOfs.length) {
618 this.memberOf = memberOfs[0].desc;
619 this.memberOf = this.memberOf.replace(/\.prototype\.?/g, "#");
620 this.name = this.name.split('.').pop();
621 this.name = this.name.split('#').pop();
622 this.name = this.memberOf + this.name;
623 this._name = this.name
624 this.alias = this.name;
632 if (this.comment.getTag("public").length) {
633 this.isPrivate = false;
641 is : function(what) {
642 return this.isa === what;
645 isBuiltin : function() {
646 return SymbolSet.isBuiltin(this.alias);
649 setType : function(/**String*/comment, /**Boolean*/overwrite) {
650 if (!overwrite && this.type) return;
651 var typeComment = DocComment.unwrapComment(comment);
652 this.type = typeComment;
655 inherit : function(symbol) {
656 if (!this.hasMember(symbol.name) && !symbol.isInner) {
657 if (symbol.is("FUNCTION"))
658 this.methods.push(symbol);
659 else if (symbol.is("OBJECT"))
660 this.properties.push(symbol);
664 hasMember : function(name) {
665 return (this.hasMethod(name) || this.hasProperty(name));
668 addMember : function(symbol) {
669 //println("ADDMEMBER: " + this.name + " ++ " + symbol.name);
671 if (symbol.comment.getTag("cfg").length == 1) {
672 symbol.comment.getTag("cfg")[0].memberOf = this.alias;
673 this.addConfig(symbol.comment.getTag("cfg")[0]);
677 if (symbol.is("FUNCTION")) { this.addMethod(symbol); }
678 else if (symbol.is("OBJECT")) { this.addProperty(symbol); }
681 hasMethod : function(name) {
682 var thisMethods = this.methods;
683 for (var i = 0, l = thisMethods.length; i < l; i++) {
684 if (thisMethods[i].name == name) return true;
685 if (thisMethods[i].alias == name) return true;
690 addMethod : function(symbol) {
691 var methodAlias = symbol.alias;
692 var thisMethods = this.methods;
693 for (var i = 0, l = thisMethods.length; i < l; i++) {
694 if (thisMethods[i].alias == methodAlias) {
695 thisMethods[i] = symbol; // overwriting previous method
699 thisMethods.push(symbol); // new method with this alias
702 hasProperty : function(name) {
703 var thisProperties = this.properties;
704 for (var i = 0, l = thisProperties.length; i < l; i++) {
705 if (thisProperties[i].name == name) return true;
706 if (thisProperties[i].alias == name) return true;
711 addProperty : function(symbol) {
712 var propertyAlias = symbol.alias;
713 var thisProperties = this.properties;
714 for (var i = 0, l = thisProperties.length; i < l; i++) {
715 if (thisProperties[i].alias == propertyAlias) {
716 thisProperties[i] = symbol; // overwriting previous property
721 thisProperties.push(symbol); // new property with this alias
724 addDocTag : function(docTag)
726 this.comment.tags.push(docTag);
727 if (docTag.title == 'cfg') {
728 this.addConfig(docTag);
733 addConfig : function(docTag)
735 if (typeof(docTag['memberOf']) == 'undefined') {
736 // remove prototype data...
737 //var a = this.alias.split('#')[0];
738 //docTag.memberOf = a;
739 docTag.memberOf = this.alias;
741 if (typeof(this.cfgs[docTag.name]) == 'undefined') {
742 this.cfgs[docTag.name] = docTag;
746 configToArray: function()
749 for(var ci in this.cfgs) {
750 // dont show hidden!!
751 if (this.cfgs[ci].desc.match(/@hide/)) {
754 r.push(this.cfgs[ci]);
762 * Elements that are not serialized
766 '$args' // not needed AFAIK
769 Symbol.srcFile = ""; //running reference to the current file being parsed
772 Symbol.fromDump = function(t)
774 var ns = new Symbol();
776 if (typeof(ns[i]) == "undefined") {
777 println("ERR:no default for Symbol:"+ i);