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");
287 foreach(var d in sinces) {
288 this.desc = this.desc == "" ? "": "\n";
294 var sym = new Symbol("foo", [], "FILE", new DocComment("/**@since 1.01*"+"/"));
295 assertEqual(sym.since, "1.01", "@since tag, description is found.");
299 if (this.comment.getTag("constant").length) {
300 this.isConstant = true;
305 var sym = new Symbol("foo", [], "FILE", new DocComment("/**@constant*"+"/"));
306 assertEqual(sym.isConstant, true, "@constant tag, isConstant set.");
310 var versions = this.comment.getTag("version");
311 if (versions.length) {
312 this.version = versions.map(function($){return $.desc;}).join(", ");
316 var sym = new Symbol("foo", [], "FILE", new DocComment("/**@version 2.0x*"+"/"));
317 assertEqual(sym.version, "2.0x", "@version tag, version is found.");
321 var deprecateds = this.comment.getTag("deprecated");
322 if (deprecateds.length) {
323 this.deprecated = deprecateds.map(function($){return $.desc;}).join("\n");
327 var sym = new Symbol("foo", [], "FILE", new DocComment("/**@deprecated Use other method.*"+"/"));
328 assertEqual(sym.deprecated, "Use other method.", "@deprecated tag, desc is found.");
332 var examples = this.comment.getTag("example");
333 if (examples.length) {
334 this.example = examples[0];
338 var sym = new Symbol("foo", [], "FILE", new DocComment("/**@example This\n is an example.*"+"/"));
339 assertEqual(sym.example, "This\n is an example.", "@deprecated tag, desc is found.");
343 var sees = this.comment.getTag("see");
345 var thisSee = this.see;
346 sees.map(function($){thisSee.push($.desc);});
350 var sym = new Symbol("foo", [], "FILE", new DocComment("/**@see The other thing.*"+"/"));
351 assertEqual(sym.see, "The other thing.", "@see tag, desc is found.");
355 var classes = this.comment.getTag("class");
356 if (classes.length) {
357 //print(JSON.stringify(this,null,4));
358 this.isa = "CONSTRUCTOR";
359 this.classDesc = classes[0].desc; // desc can't apply to the constructor as there is none.
360 if (!this.classDesc) {
361 this.classDesc = this.desc;
368 var sym = new Symbol("foo", [], "OBJECT", new DocComment("/**@class This describes the class.*"+"/"));
369 assertEqual(sym.isa, "CONSTRUCTOR", "@class tag, makes symbol a constructor.");
370 assertEqual(sym.classDesc, "This describes the class.", "@class tag, class description is found.");
374 var namespaces = this.comment.getTag("namespace");
375 if (namespaces.length) {
376 this.classDesc = namespaces[0].desc+"\n"+this.desc; // desc can't apply to the constructor as there is none.
377 this.isNamespace = true;
381 var sym = new Symbol("foo", [], "OBJECT", new DocComment("/**@namespace This describes the namespace.*"+"/"));
382 assertEqual(sym.classDesc, "This describes the namespace.\n", "@namespace tag, class description is found.");
386 var params = this.comment.getTag("param");
388 // user-defined params overwrite those with same name defined by the parser
389 var thisParams = this.getParams();
391 if (thisParams.length == 0) { // none exist yet, so just bung all these user-defined params straight in
392 this.setParams(params);
394 else { // need to overlay these user-defined params on to existing parser-defined params
395 for (var i = 0, l = params.length; i < l; i++) {
397 if (params[i].type) thisParams[i].type = params[i].type;
398 thisParams[i].name = params[i].name;
399 thisParams[i].desc = params[i].desc;
400 thisParams[i].isOptional = params[i].isOptional;
401 thisParams[i].defaultValue = params[i].defaultValue;
403 else thisParams[i] = params[i];
409 var sym = new Symbol("foo", [{type: "array", name: "pages"}], "FUNCTION", new DocComment("/**Description.*"+"/"));
410 assertEqual(sym.params.length, 1, "parser defined param is found.");
412 sym = new Symbol("foo", [], "FUNCTION", new DocComment("/**Description.\n@param {array} pages*"+"/"));
413 assertEqual(sym.params.length, 1, "user defined param is found.");
414 assertEqual(sym.params[0].type, "array", "user defined param type is found.");
415 assertEqual(sym.params[0].name, "pages", "user defined param name is found.");
417 sym = new Symbol("foo", [{type: "array", name: "pages"}], "FUNCTION", new DocComment("/**Description.\n@param {string} uid*"+"/"));
418 assertEqual(sym.params.length, 1, "user defined param overwrites parser defined param.");
419 assertEqual(sym.params[0].type, "string", "user defined param type overwrites parser defined param type.");
420 assertEqual(sym.params[0].name, "uid", "user defined param name overwrites parser defined param name.");
422 sym = new Symbol("foo", [{type: "array", name: "pages"}, {type: "number", name: "count"}], "FUNCTION", new DocComment("/**Description.\n@param {string} uid*"+"/"));
423 assertEqual(sym.params.length, 2, "user defined params overlay parser defined params.");
424 assertEqual(sym.params[1].type, "number", "user defined param type overlays parser defined param type.");
425 assertEqual(sym.params[1].name, "count", "user defined param name overlays parser defined param name.");
427 sym = new Symbol("foo", [], "FUNCTION", new DocComment("/**Description.\n@param {array} pages The pages description.*"+"/"));
428 assertEqual(sym.params.length, 1, "user defined param with description is found.");
429 assertEqual(sym.params[0].desc, "The pages description.", "user defined param description is found.");
433 if (this.comment.getTag("constructor").length) {
434 this.isa = "CONSTRUCTOR";
438 var sym = new Symbol("foo", [], "OBJECT", new DocComment("/**@constructor*"+"/"));
439 assertEqual(sym.isa, "CONSTRUCTOR", "@constructor tag, makes symbol a constructor.");
443 if (this.comment.getTag("static").length) {
444 this.isStatic = true;
445 if (this.isa == "CONSTRUCTOR") {
446 this.isNamespace = true;
451 if (this.comment.getTag("singleton").length) {
452 this.isStatic = true;
453 //print('------------- got singleton ---------------' + this.isa);
454 //if (this.isa == "CONSTRUCTOR") {
455 // this.isNamespace = true;
462 var sym = new Symbol("foo", [], "OBJECT", new DocComment("/**@static\n@constructor*"+"/"));
463 assertEqual(sym.isStatic, true, "@static tag, makes isStatic true.");
464 assertEqual(sym.isNamespace, true, "@static and @constructor tag, makes isNamespace true.");
468 if (this.comment.getTag("inner").length) {
470 this.isStatic = false;
474 var sym = new Symbol("foo", [], "OBJECT", new DocComment("/**@inner*"+"/"));
475 assertEqual(sym.isStatic, false, "@inner tag, makes isStatic false.");
476 assertEqual(sym.isInner, true, "@inner makes isInner true.");
480 if (this.comment.getTag("field").length) {
485 var sym = new Symbol("foo", [], "FUNCTION", new DocComment("/**@field*"+"/"));
486 assertEqual(sym.isa, "OBJECT", "@field tag, makes symbol an object.");
490 if (this.comment.getTag("function").length) {
491 this.isa = "FUNCTION";
495 if (this.comment.getTag("param").length && this.isa == "OBJECT" ) {
496 // change a property to a function..
497 this.isa = "FUNCTION";
502 var sym = new Symbol("foo", [], "OBJECT", new DocComment("/**@function*"+"/"));
503 assertEqual(sym.isa, "FUNCTION", "@function tag, makes symbol a function.");
507 var events = this.comment.getTag("event");
509 this.isa = "FUNCTION";
514 var sym = new Symbol("foo", [], "OBJECT", new DocComment("/**@event*"+"/"));
515 assertEqual(sym.isa, "FUNCTION", "@event tag, makes symbol a function.");
516 assertEqual(sym.isEvent, true, "@event makes isEvent true.");
520 var names = this.comment.getTag("name");
522 this.setName(names[0].desc);
530 var properties = this.comment.getTag("property");
531 if (properties.length) {
532 thisProperties = this.properties;
533 for (var i = 0; i < properties.length; i++) {
534 var property = new Symbol(this.alias+"#"+properties[i].name, [], "OBJECT", new DocComment("/**"+properties[i].desc+"\n@name "+properties[i].name+"\n@memberOf "+this.alias+"#*/"));
535 // TODO: shouldn't the following happen in the addProperty method of Symbol?
536 property.name = properties[i].name;
537 property.memberOf = this.alias;
538 if (properties[i].type) property.type = properties[i].type;
539 if (properties[i].defaultValue) property.defaultValue = properties[i].defaultValue;
540 this.addProperty(property);
541 imports.Parser.Parser.addSymbol(property);
546 var conf = this.comment.getTag("cfg");
548 for (var i = 0; i < conf.length; i++) {
549 this.addConfig(conf[i]);
558 var returns = this.comment.getTag("return");
559 if (returns.length) { // there can be many return tags in a single doclet
560 this.returns = returns;
561 this.type = returns.map(function($){return $.type}).join(", ");
569 this.exceptions = this.comment.getTag("throws");
576 var requires = this.comment.getTag("requires");
577 if (requires.length) {
578 this.requires = requires.map(function($){return $.desc});
586 var types = this.comment.getTag("type");
588 this.type = types[0].desc; //multiple type tags are ignored
596 if (this.comment.getTag("private").length || this.isInner) {
597 this.isPrivate = true;
601 if (this.comment.getTag("ignore").length) {
602 this.isIgnored = true;
609 // @inherits ... as ...
610 var inherits = this.comment.getTag("inherits");
611 if (inherits.length) {
612 for (var i = 0; i < inherits.length; i++) {
613 if (/^\s*([a-z$0-9_.#-]+)(?:\s+as\s+([a-z$0-9_.#]+))?/i.test(inherits[i].desc)) {
614 var inAlias = RegExp.$1;
615 var inAs = RegExp.$2 || inAlias;
617 if (inAlias) inAlias = inAlias.replace(/\.prototype\.?/g, "#");
620 inAs = inAs.replace(/\.prototype\.?/g, "#");
621 inAs = inAs.replace(/^this\.?/, "#");
624 if (inAs.indexOf(inAlias) != 0) { //not a full namepath
626 if (this.alias.charAt(this.alias.length-1) == "#" || inAs.charAt(0) == "#") {
629 inAs = this.alias + joiner + inAs;
632 this.inherits.push({alias: inAlias, as: inAs});
641 this.augments = this.comment.getTag("augments");
644 if (this.comment.getTag("extends")) {
645 this.augments = this.comment.getTag("extends");
650 var defaults = this.comment.getTag("default");
651 if (defaults.length) {
652 if (this.is("OBJECT")) {
653 this.defaultValue = defaults[0].desc;
662 var memberOfs = this.comment.getTag("memberOf");
663 if (memberOfs.length) {
664 this.memberOf = memberOfs[0].desc;
665 this.memberOf = this.memberOf.replace(/\.prototype\.?/g, "#");
666 this.name = this.name.split('.').pop();
667 this.name = this.name.split('#').pop();
668 this.name = this.memberOf + this.name;
669 this._name = this.name
670 this.alias = this.name;
678 if (this.comment.getTag("public").length) {
679 this.isPrivate = false;
687 is : function(what) {
688 return this.isa === what;
691 isBuiltin : function() {
692 return SymbolSet.isBuiltin(this.alias);
695 setType : function(/**String*/comment, /**Boolean*/overwrite) {
696 if (!overwrite && this.type) return;
697 var typeComment = DocComment.unwrapComment(comment);
698 this.type = typeComment;
701 inherit : function(symbol) {
702 if (!this.hasMember(symbol.name) && !symbol.isInner) {
703 if (symbol.is("FUNCTION"))
704 this.methods.push(symbol);
705 else if (symbol.is("OBJECT"))
706 this.properties.push(symbol);
710 hasMember : function(name) {
711 return (this.hasMethod(name) || this.hasProperty(name));
714 addMember : function(symbol) {
715 //println("ADDMEMBER: " + this.name + " ++ " + symbol.name);
717 if (symbol.comment.getTag("cfg").length == 1) {
718 symbol.comment.getTag("cfg")[0].memberOf = this.alias;
719 this.addConfig(symbol.comment.getTag("cfg")[0]);
723 if (symbol.is("FUNCTION")) { this.addMethod(symbol); }
724 else if (symbol.is("OBJECT")) { this.addProperty(symbol); }
727 hasMethod : function(name) {
728 var thisMethods = this.methods;
729 for (var i = 0, l = thisMethods.length; i < l; i++) {
730 if (thisMethods[i].name == name) return true;
731 if (thisMethods[i].alias == name) return true;
736 addMethod : function(symbol) {
737 var methodAlias = symbol.alias;
738 var thisMethods = this.methods;
739 for (var i = 0, l = thisMethods.length; i < l; i++) {
740 if (thisMethods[i].alias == methodAlias) {
741 thisMethods[i] = symbol; // overwriting previous method
745 thisMethods.push(symbol); // new method with this alias
748 hasProperty : function(name) {
749 var thisProperties = this.properties;
750 for (var i = 0, l = thisProperties.length; i < l; i++) {
751 if (thisProperties[i].name == name) return true;
752 if (thisProperties[i].alias == name) return true;
757 addProperty : function(symbol) {
758 var propertyAlias = symbol.alias;
759 var thisProperties = this.properties;
760 for (var i = 0, l = thisProperties.length; i < l; i++) {
761 if (thisProperties[i].alias == propertyAlias) {
762 thisProperties[i] = symbol; // overwriting previous property
767 thisProperties.push(symbol); // new property with this alias
770 addDocTag : function(docTag)
772 this.comment.tags.push(docTag);
773 if (docTag.title == 'cfg') {
774 this.addConfig(docTag);
779 addConfig : function(docTag)
781 if (typeof(docTag['memberOf']) == 'undefined') {
782 // remove prototype data...
783 //var a = this.alias.split('#')[0];
784 //docTag.memberOf = a;
785 docTag.memberOf = this.alias;
787 if (typeof(this.cfgs[docTag.name]) == 'undefined') {
788 this.cfgs[docTag.name] = docTag;
792 configToArray: function()
795 for(var ci in this.cfgs) {
796 // dont show hidden!!
797 if (this.cfgs[ci].desc.match(/@hide/)) {
800 r.push(this.cfgs[ci]);
808 * Elements that are not serialized
812 '$args' // not needed AFAIK
815 Symbol.srcFile = ""; //running reference to the current file being parsed
818 Symbol.fromDump = function(t)
820 var ns = new Symbol();
822 if (typeof(ns[i]) == "undefined") {
823 println("ERR:no default for Symbol:"+ i);