4 @class Represents a symbol in the source code.
11 public class Symbol : Object
14 private static bool regex_init = false;
15 private GLib.Regex regex_global;
16 private GLib.Regex regex_prototype;
18 static void regexInit()
20 if (Symbol.regex_init = true) {
23 Symbol.regex_init = true;
24 Symbol.regex_global = new GLib.Regex("^_global_[.#-]");
25 Symbol.regex_prototype = new GLib.Regex("\\.prototype\\.?");
28 private string private_string_name = "";
29 private string private_name {
31 var n = Symbol.regex_global(value, value.length, 0, "");
32 n = Symbol.regex_prototype(n,n.length, 0, "#");
34 if (!n.has_suffix("#")) {
37 n = n.substring(0, n.length-1);
40 this.private_string_name = n;
46 get { return this.private_string_name; }
50 string defaultValue = "";
52 private Gee.ArrayList<DocTag> private_doctag_params;
54 private Gee.ArrayList<DocTag> private_params{
56 for (var i = 0; i < value.size; i++) {
58 this.private_doctag_params.add(v.get(i));
60 //this.params = this._params;
64 Gee.ArrayList<string> private_string_params{
66 for (var i = 0; i < value.size; i++) {
68 //var ty = v[i].hasOwnProperty('type') ? v[i].type : '';
69 this.private_doctag_params.add( new DocTag(value.get(i)));
71 //"param"+((ty)?" {"+ty+"}":"")+" "+v.get(i).name);
77 public Gee.ArrayList<DocTag> params {
79 return this.private_doctag_params;
84 private Gee.ArrayList<DocTag> augments ;
86 private Gee.ArrayList<DocTag> exceptions ;
88 private Gee.ArrayList<DocTag> inherits;
89 private Gee.ArrayList<DocTag> methods;
91 private Gee.ArrayList<DocTag> properties;
92 private Gee.ArrayList<DocTag> requires;
93 private Gee.ArrayList<DocTag> returns;
94 private Gee.ArrayList<DocTag> see ;
103 //$args : [], // original arguments used when constructing.
105 public string alias = "";
108 string classDesc = "";
110 string deprecated = "";
116 string isa = "OBJECT"; // OBJECT//FUNCTION
118 public bool isEvent = false;
119 public bool isConstant = false;
120 public bool isIgnored = false;
121 public bool isInner = false;
122 public bool isNamespace = false;
123 public bool isPrivate = false;
124 public bool isStatic = false;
126 string memberOf = "";
140 public void initArrays()
142 // only initialize arrays / objects..
149 this.exceptions = new Gee.ArrayList<DocTag>();
150 this.inherits = new Gee.ArrayList<DocTag>();
152 this.isa = "OBJECT"; // OBJECT//FUNCTION
153 this.methods = new Gee.ArrayList<DocTag>();
154 //this.private_params = new Gee.ArrayList<DocTag>();
155 this.properties = new Gee.ArrayList<DocTag>();
156 this.requires = new Gee.ArrayList<DocTag>();
157 this.returns = new Gee.ArrayList<DocTag>();
158 this.see = new Gee.ArrayList<DocTag>();
164 //this.inheritsFrom = [];
165 //this.childClasses = [];
167 this.comment = new DocComment();
168 this.comment.isUserComment = false;
173 Public Symbol.new_builtin(string name)
177 this.srcFile = DocParser.currentSourceFile;
178 this.prviate_name = name ;
179 this.alias = this.name;
180 this.isa = "CONSTRUCTOR";
181 this.comment = new DocComment("");
182 this.comment.isUserComment = false;
183 this.isNamespace = false;
185 this.isPrivate = false;
195 public Symbol.new_populate_with_args(
197 Gee.ArrayList<string> params, // fixme???
203 // this.$args = arguments;
204 //println("Symbol created: " + isa + ":" + name);
205 this.private_name = name;
206 this.alias = this.getName();
207 this.private_string_params = params;
208 this.isa = (isa == "VIRTUAL")? "OBJECT":isa;
209 this.comment = new DocComment(comment);
211 this.srcFile = DocParser.currentSourceFile;
215 if (this.is("FILE") && !this.alias) { // this will never hapen???
216 this.alias = this.srcFile;
219 this.tagsFromComment();
223 void tagsFromComment() {
225 var authors = this.comment.getTag("author");
227 // turns author into a string....
229 foreach(var a in authors) {
230 this.author += (this.author == "") ? "": ", ";
231 this.author += a.desc;
236 assert("testing Symbol");
238 requires("../lib/JSDOC/DocComment.js");
239 requires("../frame/String.js");
240 requires("../lib/JSDOC/DocTag.js");
242 var sym = new Symbol("foo", [], "OBJECT", new DocComment("/**@author Joe Smith*"+"/"));
243 assertEqual(sym.author, "Joe Smith", "@author tag, author is found.");
246 var mth = this.comment.getTag("method");
248 this.isa = "FUNCTION";
251 var descs = this.comment.getTag("desc");
254 foreach(var d in desc) {
255 this.desc = this.desc == "" ? "": "\n";
262 var sym = new Symbol("foo", [], "OBJECT", new DocComment("/**@desc This is a description.*"+"/"));
263 assertEqual(sym.desc, "This is a description.", "@desc tag, description is found.");
267 if (this.is("FILE")) {
268 if (!this.alias) this.alias = this.srcFile;
270 var overviews = this.comment.getTag("overview");
271 if (overviews.length) {
272 foreach(var d in overviews) {
273 this.desc = this.desc == "" ? "": "\n";
280 var sym = new Symbol("foo", [], "FILE", new DocComment("/**@overview This is an overview.*"+"/"));
281 assertEqual(sym.desc, "\nThis is an overview.", "@overview tag, description is found.");
285 var sinces = this.comment.getTag("since");
288 foreach(var d in sinces) {
289 this.sinces = this.desc == "" ? "": "\n";
290 this.sinces += d.desc;
295 var sym = new Symbol("foo", [], "FILE", new DocComment("/**@since 1.01*"+"/"));
296 assertEqual(sym.since, "1.01", "@since tag, description is found.");
300 if (this.comment.getTag("constant").length) {
301 this.isConstant = true;
306 var sym = new Symbol("foo", [], "FILE", new DocComment("/**@constant*"+"/"));
307 assertEqual(sym.isConstant, true, "@constant tag, isConstant set.");
311 var versions = this.comment.getTag("version");
312 if (versions.length) {
314 foreach(var d in versions) {
315 this.versions = this.desc == "" ? "": "\n";
318 this.version = versions.map(function($){return $.desc;}).join(", ");
322 var sym = new Symbol("foo", [], "FILE", new DocComment("/**@version 2.0x*"+"/"));
323 assertEqual(sym.version, "2.0x", "@version tag, version is found.");
327 var deprecateds = this.comment.getTag("deprecated");
328 if (deprecateds.length) {
329 this.deprecated = deprecateds.map(function($){return $.desc;}).join("\n");
333 var sym = new Symbol("foo", [], "FILE", new DocComment("/**@deprecated Use other method.*"+"/"));
334 assertEqual(sym.deprecated, "Use other method.", "@deprecated tag, desc is found.");
338 var examples = this.comment.getTag("example");
339 if (examples.length) {
340 this.example = examples[0];
344 var sym = new Symbol("foo", [], "FILE", new DocComment("/**@example This\n is an example.*"+"/"));
345 assertEqual(sym.example, "This\n is an example.", "@deprecated tag, desc is found.");
349 var sees = this.comment.getTag("see");
351 var thisSee = this.see;
352 sees.map(function($){thisSee.push($.desc);});
356 var sym = new Symbol("foo", [], "FILE", new DocComment("/**@see The other thing.*"+"/"));
357 assertEqual(sym.see, "The other thing.", "@see tag, desc is found.");
361 var classes = this.comment.getTag("class");
362 if (classes.length) {
363 //print(JSON.stringify(this,null,4));
364 this.isa = "CONSTRUCTOR";
365 this.classDesc = classes[0].desc; // desc can't apply to the constructor as there is none.
366 if (!this.classDesc) {
367 this.classDesc = this.desc;
374 var sym = new Symbol("foo", [], "OBJECT", new DocComment("/**@class This describes the class.*"+"/"));
375 assertEqual(sym.isa, "CONSTRUCTOR", "@class tag, makes symbol a constructor.");
376 assertEqual(sym.classDesc, "This describes the class.", "@class tag, class description is found.");
380 var namespaces = this.comment.getTag("namespace");
381 if (namespaces.length) {
382 this.classDesc = namespaces[0].desc+"\n"+this.desc; // desc can't apply to the constructor as there is none.
383 this.isNamespace = true;
387 var sym = new Symbol("foo", [], "OBJECT", new DocComment("/**@namespace This describes the namespace.*"+"/"));
388 assertEqual(sym.classDesc, "This describes the namespace.\n", "@namespace tag, class description is found.");
392 var params = this.comment.getTag("param");
394 // user-defined params overwrite those with same name defined by the parser
395 var thisParams = this.getParams();
397 if (thisParams.length == 0) { // none exist yet, so just bung all these user-defined params straight in
398 this.setParams(params);
400 else { // need to overlay these user-defined params on to existing parser-defined params
401 for (var i = 0, l = params.length; i < l; i++) {
403 if (params[i].type) thisParams[i].type = params[i].type;
404 thisParams[i].name = params[i].name;
405 thisParams[i].desc = params[i].desc;
406 thisParams[i].isOptional = params[i].isOptional;
407 thisParams[i].defaultValue = params[i].defaultValue;
409 else thisParams[i] = params[i];
415 var sym = new Symbol("foo", [{type: "array", name: "pages"}], "FUNCTION", new DocComment("/**Description.*"+"/"));
416 assertEqual(sym.params.length, 1, "parser defined param is found.");
418 sym = new Symbol("foo", [], "FUNCTION", new DocComment("/**Description.\n@param {array} pages*"+"/"));
419 assertEqual(sym.params.length, 1, "user defined param is found.");
420 assertEqual(sym.params[0].type, "array", "user defined param type is found.");
421 assertEqual(sym.params[0].name, "pages", "user defined param name is found.");
423 sym = new Symbol("foo", [{type: "array", name: "pages"}], "FUNCTION", new DocComment("/**Description.\n@param {string} uid*"+"/"));
424 assertEqual(sym.params.length, 1, "user defined param overwrites parser defined param.");
425 assertEqual(sym.params[0].type, "string", "user defined param type overwrites parser defined param type.");
426 assertEqual(sym.params[0].name, "uid", "user defined param name overwrites parser defined param name.");
428 sym = new Symbol("foo", [{type: "array", name: "pages"}, {type: "number", name: "count"}], "FUNCTION", new DocComment("/**Description.\n@param {string} uid*"+"/"));
429 assertEqual(sym.params.length, 2, "user defined params overlay parser defined params.");
430 assertEqual(sym.params[1].type, "number", "user defined param type overlays parser defined param type.");
431 assertEqual(sym.params[1].name, "count", "user defined param name overlays parser defined param name.");
433 sym = new Symbol("foo", [], "FUNCTION", new DocComment("/**Description.\n@param {array} pages The pages description.*"+"/"));
434 assertEqual(sym.params.length, 1, "user defined param with description is found.");
435 assertEqual(sym.params[0].desc, "The pages description.", "user defined param description is found.");
439 if (this.comment.getTag("constructor").length) {
440 this.isa = "CONSTRUCTOR";
444 var sym = new Symbol("foo", [], "OBJECT", new DocComment("/**@constructor*"+"/"));
445 assertEqual(sym.isa, "CONSTRUCTOR", "@constructor tag, makes symbol a constructor.");
449 if (this.comment.getTag("static").length) {
450 this.isStatic = true;
451 if (this.isa == "CONSTRUCTOR") {
452 this.isNamespace = true;
457 if (this.comment.getTag("singleton").length) {
458 this.isStatic = true;
459 //print('------------- got singleton ---------------' + this.isa);
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 imports.Parser.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);