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(authors as a) {
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");
253 this.desc = descs.map(function($){return $.desc;}).join("\n"); // multiple descriptions are concatenated into one
257 var sym = new Symbol("foo", [], "OBJECT", new DocComment("/**@desc This is a description.*"+"/"));
258 assertEqual(sym.desc, "This is a description.", "@desc tag, description is found.");
262 if (this.is("FILE")) {
263 if (!this.alias) this.alias = this.srcFile;
265 var overviews = this.comment.getTag("overview");
266 if (overviews.length) {
267 this.desc = [this.desc].concat(overviews.map(function($){return $.desc;})).join("\n");
272 var sym = new Symbol("foo", [], "FILE", new DocComment("/**@overview This is an overview.*"+"/"));
273 assertEqual(sym.desc, "\nThis is an overview.", "@overview tag, description is found.");
277 var sinces = this.comment.getTag("since");
279 this.since = sinces.map(function($){return $.desc;}).join(", ");
283 var sym = new Symbol("foo", [], "FILE", new DocComment("/**@since 1.01*"+"/"));
284 assertEqual(sym.since, "1.01", "@since tag, description is found.");
288 if (this.comment.getTag("constant").length) {
289 this.isConstant = true;
294 var sym = new Symbol("foo", [], "FILE", new DocComment("/**@constant*"+"/"));
295 assertEqual(sym.isConstant, true, "@constant tag, isConstant set.");
299 var versions = this.comment.getTag("version");
300 if (versions.length) {
301 this.version = versions.map(function($){return $.desc;}).join(", ");
305 var sym = new Symbol("foo", [], "FILE", new DocComment("/**@version 2.0x*"+"/"));
306 assertEqual(sym.version, "2.0x", "@version tag, version is found.");
310 var deprecateds = this.comment.getTag("deprecated");
311 if (deprecateds.length) {
312 this.deprecated = deprecateds.map(function($){return $.desc;}).join("\n");
316 var sym = new Symbol("foo", [], "FILE", new DocComment("/**@deprecated Use other method.*"+"/"));
317 assertEqual(sym.deprecated, "Use other method.", "@deprecated tag, desc is found.");
321 var examples = this.comment.getTag("example");
322 if (examples.length) {
323 this.example = examples[0];
327 var sym = new Symbol("foo", [], "FILE", new DocComment("/**@example This\n is an example.*"+"/"));
328 assertEqual(sym.example, "This\n is an example.", "@deprecated tag, desc is found.");
332 var sees = this.comment.getTag("see");
334 var thisSee = this.see;
335 sees.map(function($){thisSee.push($.desc);});
339 var sym = new Symbol("foo", [], "FILE", new DocComment("/**@see The other thing.*"+"/"));
340 assertEqual(sym.see, "The other thing.", "@see tag, desc is found.");
344 var classes = this.comment.getTag("class");
345 if (classes.length) {
346 //print(JSON.stringify(this,null,4));
347 this.isa = "CONSTRUCTOR";
348 this.classDesc = classes[0].desc; // desc can't apply to the constructor as there is none.
349 if (!this.classDesc) {
350 this.classDesc = this.desc;
357 var sym = new Symbol("foo", [], "OBJECT", new DocComment("/**@class This describes the class.*"+"/"));
358 assertEqual(sym.isa, "CONSTRUCTOR", "@class tag, makes symbol a constructor.");
359 assertEqual(sym.classDesc, "This describes the class.", "@class tag, class description is found.");
363 var namespaces = this.comment.getTag("namespace");
364 if (namespaces.length) {
365 this.classDesc = namespaces[0].desc+"\n"+this.desc; // desc can't apply to the constructor as there is none.
366 this.isNamespace = true;
370 var sym = new Symbol("foo", [], "OBJECT", new DocComment("/**@namespace This describes the namespace.*"+"/"));
371 assertEqual(sym.classDesc, "This describes the namespace.\n", "@namespace tag, class description is found.");
375 var params = this.comment.getTag("param");
377 // user-defined params overwrite those with same name defined by the parser
378 var thisParams = this.getParams();
380 if (thisParams.length == 0) { // none exist yet, so just bung all these user-defined params straight in
381 this.setParams(params);
383 else { // need to overlay these user-defined params on to existing parser-defined params
384 for (var i = 0, l = params.length; i < l; i++) {
386 if (params[i].type) thisParams[i].type = params[i].type;
387 thisParams[i].name = params[i].name;
388 thisParams[i].desc = params[i].desc;
389 thisParams[i].isOptional = params[i].isOptional;
390 thisParams[i].defaultValue = params[i].defaultValue;
392 else thisParams[i] = params[i];
398 var sym = new Symbol("foo", [{type: "array", name: "pages"}], "FUNCTION", new DocComment("/**Description.*"+"/"));
399 assertEqual(sym.params.length, 1, "parser defined param is found.");
401 sym = new Symbol("foo", [], "FUNCTION", new DocComment("/**Description.\n@param {array} pages*"+"/"));
402 assertEqual(sym.params.length, 1, "user defined param is found.");
403 assertEqual(sym.params[0].type, "array", "user defined param type is found.");
404 assertEqual(sym.params[0].name, "pages", "user defined param name is found.");
406 sym = new Symbol("foo", [{type: "array", name: "pages"}], "FUNCTION", new DocComment("/**Description.\n@param {string} uid*"+"/"));
407 assertEqual(sym.params.length, 1, "user defined param overwrites parser defined param.");
408 assertEqual(sym.params[0].type, "string", "user defined param type overwrites parser defined param type.");
409 assertEqual(sym.params[0].name, "uid", "user defined param name overwrites parser defined param name.");
411 sym = new Symbol("foo", [{type: "array", name: "pages"}, {type: "number", name: "count"}], "FUNCTION", new DocComment("/**Description.\n@param {string} uid*"+"/"));
412 assertEqual(sym.params.length, 2, "user defined params overlay parser defined params.");
413 assertEqual(sym.params[1].type, "number", "user defined param type overlays parser defined param type.");
414 assertEqual(sym.params[1].name, "count", "user defined param name overlays parser defined param name.");
416 sym = new Symbol("foo", [], "FUNCTION", new DocComment("/**Description.\n@param {array} pages The pages description.*"+"/"));
417 assertEqual(sym.params.length, 1, "user defined param with description is found.");
418 assertEqual(sym.params[0].desc, "The pages description.", "user defined param description is found.");
422 if (this.comment.getTag("constructor").length) {
423 this.isa = "CONSTRUCTOR";
427 var sym = new Symbol("foo", [], "OBJECT", new DocComment("/**@constructor*"+"/"));
428 assertEqual(sym.isa, "CONSTRUCTOR", "@constructor tag, makes symbol a constructor.");
432 if (this.comment.getTag("static").length) {
433 this.isStatic = true;
434 if (this.isa == "CONSTRUCTOR") {
435 this.isNamespace = true;
440 if (this.comment.getTag("singleton").length) {
441 this.isStatic = true;
442 //print('------------- got singleton ---------------' + this.isa);
443 //if (this.isa == "CONSTRUCTOR") {
444 // this.isNamespace = true;
451 var sym = new Symbol("foo", [], "OBJECT", new DocComment("/**@static\n@constructor*"+"/"));
452 assertEqual(sym.isStatic, true, "@static tag, makes isStatic true.");
453 assertEqual(sym.isNamespace, true, "@static and @constructor tag, makes isNamespace true.");
457 if (this.comment.getTag("inner").length) {
459 this.isStatic = false;
463 var sym = new Symbol("foo", [], "OBJECT", new DocComment("/**@inner*"+"/"));
464 assertEqual(sym.isStatic, false, "@inner tag, makes isStatic false.");
465 assertEqual(sym.isInner, true, "@inner makes isInner true.");
469 if (this.comment.getTag("field").length) {
474 var sym = new Symbol("foo", [], "FUNCTION", new DocComment("/**@field*"+"/"));
475 assertEqual(sym.isa, "OBJECT", "@field tag, makes symbol an object.");
479 if (this.comment.getTag("function").length) {
480 this.isa = "FUNCTION";
484 if (this.comment.getTag("param").length && this.isa == "OBJECT" ) {
485 // change a property to a function..
486 this.isa = "FUNCTION";
491 var sym = new Symbol("foo", [], "OBJECT", new DocComment("/**@function*"+"/"));
492 assertEqual(sym.isa, "FUNCTION", "@function tag, makes symbol a function.");
496 var events = this.comment.getTag("event");
498 this.isa = "FUNCTION";
503 var sym = new Symbol("foo", [], "OBJECT", new DocComment("/**@event*"+"/"));
504 assertEqual(sym.isa, "FUNCTION", "@event tag, makes symbol a function.");
505 assertEqual(sym.isEvent, true, "@event makes isEvent true.");
509 var names = this.comment.getTag("name");
511 this.setName(names[0].desc);
519 var properties = this.comment.getTag("property");
520 if (properties.length) {
521 thisProperties = this.properties;
522 for (var i = 0; i < properties.length; i++) {
523 var property = new Symbol(this.alias+"#"+properties[i].name, [], "OBJECT", new DocComment("/**"+properties[i].desc+"\n@name "+properties[i].name+"\n@memberOf "+this.alias+"#*/"));
524 // TODO: shouldn't the following happen in the addProperty method of Symbol?
525 property.name = properties[i].name;
526 property.memberOf = this.alias;
527 if (properties[i].type) property.type = properties[i].type;
528 if (properties[i].defaultValue) property.defaultValue = properties[i].defaultValue;
529 this.addProperty(property);
530 imports.Parser.Parser.addSymbol(property);
535 var conf = this.comment.getTag("cfg");
537 for (var i = 0; i < conf.length; i++) {
538 this.addConfig(conf[i]);
547 var returns = this.comment.getTag("return");
548 if (returns.length) { // there can be many return tags in a single doclet
549 this.returns = returns;
550 this.type = returns.map(function($){return $.type}).join(", ");
558 this.exceptions = this.comment.getTag("throws");
565 var requires = this.comment.getTag("requires");
566 if (requires.length) {
567 this.requires = requires.map(function($){return $.desc});
575 var types = this.comment.getTag("type");
577 this.type = types[0].desc; //multiple type tags are ignored
585 if (this.comment.getTag("private").length || this.isInner) {
586 this.isPrivate = true;
590 if (this.comment.getTag("ignore").length) {
591 this.isIgnored = true;
598 // @inherits ... as ...
599 var inherits = this.comment.getTag("inherits");
600 if (inherits.length) {
601 for (var i = 0; i < inherits.length; i++) {
602 if (/^\s*([a-z$0-9_.#-]+)(?:\s+as\s+([a-z$0-9_.#]+))?/i.test(inherits[i].desc)) {
603 var inAlias = RegExp.$1;
604 var inAs = RegExp.$2 || inAlias;
606 if (inAlias) inAlias = inAlias.replace(/\.prototype\.?/g, "#");
609 inAs = inAs.replace(/\.prototype\.?/g, "#");
610 inAs = inAs.replace(/^this\.?/, "#");
613 if (inAs.indexOf(inAlias) != 0) { //not a full namepath
615 if (this.alias.charAt(this.alias.length-1) == "#" || inAs.charAt(0) == "#") {
618 inAs = this.alias + joiner + inAs;
621 this.inherits.push({alias: inAlias, as: inAs});
630 this.augments = this.comment.getTag("augments");
633 if (this.comment.getTag("extends")) {
634 this.augments = this.comment.getTag("extends");
639 var defaults = this.comment.getTag("default");
640 if (defaults.length) {
641 if (this.is("OBJECT")) {
642 this.defaultValue = defaults[0].desc;
651 var memberOfs = this.comment.getTag("memberOf");
652 if (memberOfs.length) {
653 this.memberOf = memberOfs[0].desc;
654 this.memberOf = this.memberOf.replace(/\.prototype\.?/g, "#");
655 this.name = this.name.split('.').pop();
656 this.name = this.name.split('#').pop();
657 this.name = this.memberOf + this.name;
658 this._name = this.name
659 this.alias = this.name;
667 if (this.comment.getTag("public").length) {
668 this.isPrivate = false;
676 is : function(what) {
677 return this.isa === what;
680 isBuiltin : function() {
681 return SymbolSet.isBuiltin(this.alias);
684 setType : function(/**String*/comment, /**Boolean*/overwrite) {
685 if (!overwrite && this.type) return;
686 var typeComment = DocComment.unwrapComment(comment);
687 this.type = typeComment;
690 inherit : function(symbol) {
691 if (!this.hasMember(symbol.name) && !symbol.isInner) {
692 if (symbol.is("FUNCTION"))
693 this.methods.push(symbol);
694 else if (symbol.is("OBJECT"))
695 this.properties.push(symbol);
699 hasMember : function(name) {
700 return (this.hasMethod(name) || this.hasProperty(name));
703 addMember : function(symbol) {
704 //println("ADDMEMBER: " + this.name + " ++ " + symbol.name);
706 if (symbol.comment.getTag("cfg").length == 1) {
707 symbol.comment.getTag("cfg")[0].memberOf = this.alias;
708 this.addConfig(symbol.comment.getTag("cfg")[0]);
712 if (symbol.is("FUNCTION")) { this.addMethod(symbol); }
713 else if (symbol.is("OBJECT")) { this.addProperty(symbol); }
716 hasMethod : function(name) {
717 var thisMethods = this.methods;
718 for (var i = 0, l = thisMethods.length; i < l; i++) {
719 if (thisMethods[i].name == name) return true;
720 if (thisMethods[i].alias == name) return true;
725 addMethod : function(symbol) {
726 var methodAlias = symbol.alias;
727 var thisMethods = this.methods;
728 for (var i = 0, l = thisMethods.length; i < l; i++) {
729 if (thisMethods[i].alias == methodAlias) {
730 thisMethods[i] = symbol; // overwriting previous method
734 thisMethods.push(symbol); // new method with this alias
737 hasProperty : function(name) {
738 var thisProperties = this.properties;
739 for (var i = 0, l = thisProperties.length; i < l; i++) {
740 if (thisProperties[i].name == name) return true;
741 if (thisProperties[i].alias == name) return true;
746 addProperty : function(symbol) {
747 var propertyAlias = symbol.alias;
748 var thisProperties = this.properties;
749 for (var i = 0, l = thisProperties.length; i < l; i++) {
750 if (thisProperties[i].alias == propertyAlias) {
751 thisProperties[i] = symbol; // overwriting previous property
756 thisProperties.push(symbol); // new property with this alias
759 addDocTag : function(docTag)
761 this.comment.tags.push(docTag);
762 if (docTag.title == 'cfg') {
763 this.addConfig(docTag);
768 addConfig : function(docTag)
770 if (typeof(docTag['memberOf']) == 'undefined') {
771 // remove prototype data...
772 //var a = this.alias.split('#')[0];
773 //docTag.memberOf = a;
774 docTag.memberOf = this.alias;
776 if (typeof(this.cfgs[docTag.name]) == 'undefined') {
777 this.cfgs[docTag.name] = docTag;
781 configToArray: function()
784 for(var ci in this.cfgs) {
785 // dont show hidden!!
786 if (this.cfgs[ci].desc.match(/@hide/)) {
789 r.push(this.cfgs[ci]);
797 * Elements that are not serialized
801 '$args' // not needed AFAIK
804 Symbol.srcFile = ""; //running reference to the current file being parsed
807 Symbol.fromDump = function(t)
809 var ns = new Symbol();
811 if (typeof(ns[i]) == "undefined") {
812 println("ERR:no default for Symbol:"+ i);