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 this.author = authors.map(function($){return $.desc;}).join(", ");
233 assert("testing Symbol");
235 requires("../lib/JSDOC/DocComment.js");
236 requires("../frame/String.js");
237 requires("../lib/JSDOC/DocTag.js");
239 var sym = new Symbol("foo", [], "OBJECT", new DocComment("/**@author Joe Smith*"+"/"));
240 assertEqual(sym.author, "Joe Smith", "@author tag, author is found.");
243 var mth = this.comment.getTag("method");
245 this.isa = "FUNCTION";
248 var descs = this.comment.getTag("desc");
250 this.desc = descs.map(function($){return $.desc;}).join("\n"); // multiple descriptions are concatenated into one
254 var sym = new Symbol("foo", [], "OBJECT", new DocComment("/**@desc This is a description.*"+"/"));
255 assertEqual(sym.desc, "This is a description.", "@desc tag, description is found.");
259 if (this.is("FILE")) {
260 if (!this.alias) this.alias = this.srcFile;
262 var overviews = this.comment.getTag("overview");
263 if (overviews.length) {
264 this.desc = [this.desc].concat(overviews.map(function($){return $.desc;})).join("\n");
269 var sym = new Symbol("foo", [], "FILE", new DocComment("/**@overview This is an overview.*"+"/"));
270 assertEqual(sym.desc, "\nThis is an overview.", "@overview tag, description is found.");
274 var sinces = this.comment.getTag("since");
276 this.since = sinces.map(function($){return $.desc;}).join(", ");
280 var sym = new Symbol("foo", [], "FILE", new DocComment("/**@since 1.01*"+"/"));
281 assertEqual(sym.since, "1.01", "@since tag, description is found.");
285 if (this.comment.getTag("constant").length) {
286 this.isConstant = true;
291 var sym = new Symbol("foo", [], "FILE", new DocComment("/**@constant*"+"/"));
292 assertEqual(sym.isConstant, true, "@constant tag, isConstant set.");
296 var versions = this.comment.getTag("version");
297 if (versions.length) {
298 this.version = versions.map(function($){return $.desc;}).join(", ");
302 var sym = new Symbol("foo", [], "FILE", new DocComment("/**@version 2.0x*"+"/"));
303 assertEqual(sym.version, "2.0x", "@version tag, version is found.");
307 var deprecateds = this.comment.getTag("deprecated");
308 if (deprecateds.length) {
309 this.deprecated = deprecateds.map(function($){return $.desc;}).join("\n");
313 var sym = new Symbol("foo", [], "FILE", new DocComment("/**@deprecated Use other method.*"+"/"));
314 assertEqual(sym.deprecated, "Use other method.", "@deprecated tag, desc is found.");
318 var examples = this.comment.getTag("example");
319 if (examples.length) {
320 this.example = examples[0];
324 var sym = new Symbol("foo", [], "FILE", new DocComment("/**@example This\n is an example.*"+"/"));
325 assertEqual(sym.example, "This\n is an example.", "@deprecated tag, desc is found.");
329 var sees = this.comment.getTag("see");
331 var thisSee = this.see;
332 sees.map(function($){thisSee.push($.desc);});
336 var sym = new Symbol("foo", [], "FILE", new DocComment("/**@see The other thing.*"+"/"));
337 assertEqual(sym.see, "The other thing.", "@see tag, desc is found.");
341 var classes = this.comment.getTag("class");
342 if (classes.length) {
343 //print(JSON.stringify(this,null,4));
344 this.isa = "CONSTRUCTOR";
345 this.classDesc = classes[0].desc; // desc can't apply to the constructor as there is none.
346 if (!this.classDesc) {
347 this.classDesc = this.desc;
354 var sym = new Symbol("foo", [], "OBJECT", new DocComment("/**@class This describes the class.*"+"/"));
355 assertEqual(sym.isa, "CONSTRUCTOR", "@class tag, makes symbol a constructor.");
356 assertEqual(sym.classDesc, "This describes the class.", "@class tag, class description is found.");
360 var namespaces = this.comment.getTag("namespace");
361 if (namespaces.length) {
362 this.classDesc = namespaces[0].desc+"\n"+this.desc; // desc can't apply to the constructor as there is none.
363 this.isNamespace = true;
367 var sym = new Symbol("foo", [], "OBJECT", new DocComment("/**@namespace This describes the namespace.*"+"/"));
368 assertEqual(sym.classDesc, "This describes the namespace.\n", "@namespace tag, class description is found.");
372 var params = this.comment.getTag("param");
374 // user-defined params overwrite those with same name defined by the parser
375 var thisParams = this.getParams();
377 if (thisParams.length == 0) { // none exist yet, so just bung all these user-defined params straight in
378 this.setParams(params);
380 else { // need to overlay these user-defined params on to existing parser-defined params
381 for (var i = 0, l = params.length; i < l; i++) {
383 if (params[i].type) thisParams[i].type = params[i].type;
384 thisParams[i].name = params[i].name;
385 thisParams[i].desc = params[i].desc;
386 thisParams[i].isOptional = params[i].isOptional;
387 thisParams[i].defaultValue = params[i].defaultValue;
389 else thisParams[i] = params[i];
395 var sym = new Symbol("foo", [{type: "array", name: "pages"}], "FUNCTION", new DocComment("/**Description.*"+"/"));
396 assertEqual(sym.params.length, 1, "parser defined param is found.");
398 sym = new Symbol("foo", [], "FUNCTION", new DocComment("/**Description.\n@param {array} pages*"+"/"));
399 assertEqual(sym.params.length, 1, "user defined param is found.");
400 assertEqual(sym.params[0].type, "array", "user defined param type is found.");
401 assertEqual(sym.params[0].name, "pages", "user defined param name is found.");
403 sym = new Symbol("foo", [{type: "array", name: "pages"}], "FUNCTION", new DocComment("/**Description.\n@param {string} uid*"+"/"));
404 assertEqual(sym.params.length, 1, "user defined param overwrites parser defined param.");
405 assertEqual(sym.params[0].type, "string", "user defined param type overwrites parser defined param type.");
406 assertEqual(sym.params[0].name, "uid", "user defined param name overwrites parser defined param name.");
408 sym = new Symbol("foo", [{type: "array", name: "pages"}, {type: "number", name: "count"}], "FUNCTION", new DocComment("/**Description.\n@param {string} uid*"+"/"));
409 assertEqual(sym.params.length, 2, "user defined params overlay parser defined params.");
410 assertEqual(sym.params[1].type, "number", "user defined param type overlays parser defined param type.");
411 assertEqual(sym.params[1].name, "count", "user defined param name overlays parser defined param name.");
413 sym = new Symbol("foo", [], "FUNCTION", new DocComment("/**Description.\n@param {array} pages The pages description.*"+"/"));
414 assertEqual(sym.params.length, 1, "user defined param with description is found.");
415 assertEqual(sym.params[0].desc, "The pages description.", "user defined param description is found.");
419 if (this.comment.getTag("constructor").length) {
420 this.isa = "CONSTRUCTOR";
424 var sym = new Symbol("foo", [], "OBJECT", new DocComment("/**@constructor*"+"/"));
425 assertEqual(sym.isa, "CONSTRUCTOR", "@constructor tag, makes symbol a constructor.");
429 if (this.comment.getTag("static").length) {
430 this.isStatic = true;
431 if (this.isa == "CONSTRUCTOR") {
432 this.isNamespace = true;
437 if (this.comment.getTag("singleton").length) {
438 this.isStatic = true;
439 //print('------------- got singleton ---------------' + this.isa);
440 //if (this.isa == "CONSTRUCTOR") {
441 // this.isNamespace = true;
448 var sym = new Symbol("foo", [], "OBJECT", new DocComment("/**@static\n@constructor*"+"/"));
449 assertEqual(sym.isStatic, true, "@static tag, makes isStatic true.");
450 assertEqual(sym.isNamespace, true, "@static and @constructor tag, makes isNamespace true.");
454 if (this.comment.getTag("inner").length) {
456 this.isStatic = false;
460 var sym = new Symbol("foo", [], "OBJECT", new DocComment("/**@inner*"+"/"));
461 assertEqual(sym.isStatic, false, "@inner tag, makes isStatic false.");
462 assertEqual(sym.isInner, true, "@inner makes isInner true.");
466 if (this.comment.getTag("field").length) {
471 var sym = new Symbol("foo", [], "FUNCTION", new DocComment("/**@field*"+"/"));
472 assertEqual(sym.isa, "OBJECT", "@field tag, makes symbol an object.");
476 if (this.comment.getTag("function").length) {
477 this.isa = "FUNCTION";
481 if (this.comment.getTag("param").length && this.isa == "OBJECT" ) {
482 // change a property to a function..
483 this.isa = "FUNCTION";
488 var sym = new Symbol("foo", [], "OBJECT", new DocComment("/**@function*"+"/"));
489 assertEqual(sym.isa, "FUNCTION", "@function tag, makes symbol a function.");
493 var events = this.comment.getTag("event");
495 this.isa = "FUNCTION";
500 var sym = new Symbol("foo", [], "OBJECT", new DocComment("/**@event*"+"/"));
501 assertEqual(sym.isa, "FUNCTION", "@event tag, makes symbol a function.");
502 assertEqual(sym.isEvent, true, "@event makes isEvent true.");
506 var names = this.comment.getTag("name");
508 this.setName(names[0].desc);
516 var properties = this.comment.getTag("property");
517 if (properties.length) {
518 thisProperties = this.properties;
519 for (var i = 0; i < properties.length; i++) {
520 var property = new Symbol(this.alias+"#"+properties[i].name, [], "OBJECT", new DocComment("/**"+properties[i].desc+"\n@name "+properties[i].name+"\n@memberOf "+this.alias+"#*/"));
521 // TODO: shouldn't the following happen in the addProperty method of Symbol?
522 property.name = properties[i].name;
523 property.memberOf = this.alias;
524 if (properties[i].type) property.type = properties[i].type;
525 if (properties[i].defaultValue) property.defaultValue = properties[i].defaultValue;
526 this.addProperty(property);
527 imports.Parser.Parser.addSymbol(property);
532 var conf = this.comment.getTag("cfg");
534 for (var i = 0; i < conf.length; i++) {
535 this.addConfig(conf[i]);
544 var returns = this.comment.getTag("return");
545 if (returns.length) { // there can be many return tags in a single doclet
546 this.returns = returns;
547 this.type = returns.map(function($){return $.type}).join(", ");
555 this.exceptions = this.comment.getTag("throws");
562 var requires = this.comment.getTag("requires");
563 if (requires.length) {
564 this.requires = requires.map(function($){return $.desc});
572 var types = this.comment.getTag("type");
574 this.type = types[0].desc; //multiple type tags are ignored
582 if (this.comment.getTag("private").length || this.isInner) {
583 this.isPrivate = true;
587 if (this.comment.getTag("ignore").length) {
588 this.isIgnored = true;
595 // @inherits ... as ...
596 var inherits = this.comment.getTag("inherits");
597 if (inherits.length) {
598 for (var i = 0; i < inherits.length; i++) {
599 if (/^\s*([a-z$0-9_.#-]+)(?:\s+as\s+([a-z$0-9_.#]+))?/i.test(inherits[i].desc)) {
600 var inAlias = RegExp.$1;
601 var inAs = RegExp.$2 || inAlias;
603 if (inAlias) inAlias = inAlias.replace(/\.prototype\.?/g, "#");
606 inAs = inAs.replace(/\.prototype\.?/g, "#");
607 inAs = inAs.replace(/^this\.?/, "#");
610 if (inAs.indexOf(inAlias) != 0) { //not a full namepath
612 if (this.alias.charAt(this.alias.length-1) == "#" || inAs.charAt(0) == "#") {
615 inAs = this.alias + joiner + inAs;
618 this.inherits.push({alias: inAlias, as: inAs});
627 this.augments = this.comment.getTag("augments");
630 if (this.comment.getTag("extends")) {
631 this.augments = this.comment.getTag("extends");
636 var defaults = this.comment.getTag("default");
637 if (defaults.length) {
638 if (this.is("OBJECT")) {
639 this.defaultValue = defaults[0].desc;
648 var memberOfs = this.comment.getTag("memberOf");
649 if (memberOfs.length) {
650 this.memberOf = memberOfs[0].desc;
651 this.memberOf = this.memberOf.replace(/\.prototype\.?/g, "#");
652 this.name = this.name.split('.').pop();
653 this.name = this.name.split('#').pop();
654 this.name = this.memberOf + this.name;
655 this._name = this.name
656 this.alias = this.name;
664 if (this.comment.getTag("public").length) {
665 this.isPrivate = false;
673 is : function(what) {
674 return this.isa === what;
677 isBuiltin : function() {
678 return SymbolSet.isBuiltin(this.alias);
681 setType : function(/**String*/comment, /**Boolean*/overwrite) {
682 if (!overwrite && this.type) return;
683 var typeComment = DocComment.unwrapComment(comment);
684 this.type = typeComment;
687 inherit : function(symbol) {
688 if (!this.hasMember(symbol.name) && !symbol.isInner) {
689 if (symbol.is("FUNCTION"))
690 this.methods.push(symbol);
691 else if (symbol.is("OBJECT"))
692 this.properties.push(symbol);
696 hasMember : function(name) {
697 return (this.hasMethod(name) || this.hasProperty(name));
700 addMember : function(symbol) {
701 //println("ADDMEMBER: " + this.name + " ++ " + symbol.name);
703 if (symbol.comment.getTag("cfg").length == 1) {
704 symbol.comment.getTag("cfg")[0].memberOf = this.alias;
705 this.addConfig(symbol.comment.getTag("cfg")[0]);
709 if (symbol.is("FUNCTION")) { this.addMethod(symbol); }
710 else if (symbol.is("OBJECT")) { this.addProperty(symbol); }
713 hasMethod : function(name) {
714 var thisMethods = this.methods;
715 for (var i = 0, l = thisMethods.length; i < l; i++) {
716 if (thisMethods[i].name == name) return true;
717 if (thisMethods[i].alias == name) return true;
722 addMethod : function(symbol) {
723 var methodAlias = symbol.alias;
724 var thisMethods = this.methods;
725 for (var i = 0, l = thisMethods.length; i < l; i++) {
726 if (thisMethods[i].alias == methodAlias) {
727 thisMethods[i] = symbol; // overwriting previous method
731 thisMethods.push(symbol); // new method with this alias
734 hasProperty : function(name) {
735 var thisProperties = this.properties;
736 for (var i = 0, l = thisProperties.length; i < l; i++) {
737 if (thisProperties[i].name == name) return true;
738 if (thisProperties[i].alias == name) return true;
743 addProperty : function(symbol) {
744 var propertyAlias = symbol.alias;
745 var thisProperties = this.properties;
746 for (var i = 0, l = thisProperties.length; i < l; i++) {
747 if (thisProperties[i].alias == propertyAlias) {
748 thisProperties[i] = symbol; // overwriting previous property
753 thisProperties.push(symbol); // new property with this alias
756 addDocTag : function(docTag)
758 this.comment.tags.push(docTag);
759 if (docTag.title == 'cfg') {
760 this.addConfig(docTag);
765 addConfig : function(docTag)
767 if (typeof(docTag['memberOf']) == 'undefined') {
768 // remove prototype data...
769 //var a = this.alias.split('#')[0];
770 //docTag.memberOf = a;
771 docTag.memberOf = this.alias;
773 if (typeof(this.cfgs[docTag.name]) == 'undefined') {
774 this.cfgs[docTag.name] = docTag;
778 configToArray: function()
781 for(var ci in this.cfgs) {
782 // dont show hidden!!
783 if (this.cfgs[ci].desc.match(/@hide/)) {
786 r.push(this.cfgs[ci]);
794 * Elements that are not serialized
798 '$args' // not needed AFAIK
801 Symbol.srcFile = ""; //running reference to the current file being parsed
804 Symbol.fromDump = function(t)
806 var ns = new Symbol();
808 if (typeof(ns[i]) == "undefined") {
809 println("ERR:no default for Symbol:"+ i);