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");
226 if (authors.length) {
227 this.author = authors.map(function($){return $.desc;}).join(", ");
231 assert("testing Symbol");
233 requires("../lib/JSDOC/DocComment.js");
234 requires("../frame/String.js");
235 requires("../lib/JSDOC/DocTag.js");
237 var sym = new Symbol("foo", [], "OBJECT", new DocComment("/**@author Joe Smith*"+"/"));
238 assertEqual(sym.author, "Joe Smith", "@author tag, author is found.");
241 var mth = this.comment.getTag("method");
243 this.isa = "FUNCTION";
246 var descs = this.comment.getTag("desc");
248 this.desc = descs.map(function($){return $.desc;}).join("\n"); // multiple descriptions are concatenated into one
252 var sym = new Symbol("foo", [], "OBJECT", new DocComment("/**@desc This is a description.*"+"/"));
253 assertEqual(sym.desc, "This is a description.", "@desc tag, description is found.");
257 if (this.is("FILE")) {
258 if (!this.alias) this.alias = this.srcFile;
260 var overviews = this.comment.getTag("overview");
261 if (overviews.length) {
262 this.desc = [this.desc].concat(overviews.map(function($){return $.desc;})).join("\n");
267 var sym = new Symbol("foo", [], "FILE", new DocComment("/**@overview This is an overview.*"+"/"));
268 assertEqual(sym.desc, "\nThis is an overview.", "@overview tag, description is found.");
272 var sinces = this.comment.getTag("since");
274 this.since = sinces.map(function($){return $.desc;}).join(", ");
278 var sym = new Symbol("foo", [], "FILE", new DocComment("/**@since 1.01*"+"/"));
279 assertEqual(sym.since, "1.01", "@since tag, description is found.");
283 if (this.comment.getTag("constant").length) {
284 this.isConstant = true;
289 var sym = new Symbol("foo", [], "FILE", new DocComment("/**@constant*"+"/"));
290 assertEqual(sym.isConstant, true, "@constant tag, isConstant set.");
294 var versions = this.comment.getTag("version");
295 if (versions.length) {
296 this.version = versions.map(function($){return $.desc;}).join(", ");
300 var sym = new Symbol("foo", [], "FILE", new DocComment("/**@version 2.0x*"+"/"));
301 assertEqual(sym.version, "2.0x", "@version tag, version is found.");
305 var deprecateds = this.comment.getTag("deprecated");
306 if (deprecateds.length) {
307 this.deprecated = deprecateds.map(function($){return $.desc;}).join("\n");
311 var sym = new Symbol("foo", [], "FILE", new DocComment("/**@deprecated Use other method.*"+"/"));
312 assertEqual(sym.deprecated, "Use other method.", "@deprecated tag, desc is found.");
316 var examples = this.comment.getTag("example");
317 if (examples.length) {
318 this.example = examples[0];
322 var sym = new Symbol("foo", [], "FILE", new DocComment("/**@example This\n is an example.*"+"/"));
323 assertEqual(sym.example, "This\n is an example.", "@deprecated tag, desc is found.");
327 var sees = this.comment.getTag("see");
329 var thisSee = this.see;
330 sees.map(function($){thisSee.push($.desc);});
334 var sym = new Symbol("foo", [], "FILE", new DocComment("/**@see The other thing.*"+"/"));
335 assertEqual(sym.see, "The other thing.", "@see tag, desc is found.");
339 var classes = this.comment.getTag("class");
340 if (classes.length) {
341 //print(JSON.stringify(this,null,4));
342 this.isa = "CONSTRUCTOR";
343 this.classDesc = classes[0].desc; // desc can't apply to the constructor as there is none.
344 if (!this.classDesc) {
345 this.classDesc = this.desc;
352 var sym = new Symbol("foo", [], "OBJECT", new DocComment("/**@class This describes the class.*"+"/"));
353 assertEqual(sym.isa, "CONSTRUCTOR", "@class tag, makes symbol a constructor.");
354 assertEqual(sym.classDesc, "This describes the class.", "@class tag, class description is found.");
358 var namespaces = this.comment.getTag("namespace");
359 if (namespaces.length) {
360 this.classDesc = namespaces[0].desc+"\n"+this.desc; // desc can't apply to the constructor as there is none.
361 this.isNamespace = true;
365 var sym = new Symbol("foo", [], "OBJECT", new DocComment("/**@namespace This describes the namespace.*"+"/"));
366 assertEqual(sym.classDesc, "This describes the namespace.\n", "@namespace tag, class description is found.");
370 var params = this.comment.getTag("param");
372 // user-defined params overwrite those with same name defined by the parser
373 var thisParams = this.getParams();
375 if (thisParams.length == 0) { // none exist yet, so just bung all these user-defined params straight in
376 this.setParams(params);
378 else { // need to overlay these user-defined params on to existing parser-defined params
379 for (var i = 0, l = params.length; i < l; i++) {
381 if (params[i].type) thisParams[i].type = params[i].type;
382 thisParams[i].name = params[i].name;
383 thisParams[i].desc = params[i].desc;
384 thisParams[i].isOptional = params[i].isOptional;
385 thisParams[i].defaultValue = params[i].defaultValue;
387 else thisParams[i] = params[i];
393 var sym = new Symbol("foo", [{type: "array", name: "pages"}], "FUNCTION", new DocComment("/**Description.*"+"/"));
394 assertEqual(sym.params.length, 1, "parser defined param is found.");
396 sym = new Symbol("foo", [], "FUNCTION", new DocComment("/**Description.\n@param {array} pages*"+"/"));
397 assertEqual(sym.params.length, 1, "user defined param is found.");
398 assertEqual(sym.params[0].type, "array", "user defined param type is found.");
399 assertEqual(sym.params[0].name, "pages", "user defined param name is found.");
401 sym = new Symbol("foo", [{type: "array", name: "pages"}], "FUNCTION", new DocComment("/**Description.\n@param {string} uid*"+"/"));
402 assertEqual(sym.params.length, 1, "user defined param overwrites parser defined param.");
403 assertEqual(sym.params[0].type, "string", "user defined param type overwrites parser defined param type.");
404 assertEqual(sym.params[0].name, "uid", "user defined param name overwrites parser defined param name.");
406 sym = new Symbol("foo", [{type: "array", name: "pages"}, {type: "number", name: "count"}], "FUNCTION", new DocComment("/**Description.\n@param {string} uid*"+"/"));
407 assertEqual(sym.params.length, 2, "user defined params overlay parser defined params.");
408 assertEqual(sym.params[1].type, "number", "user defined param type overlays parser defined param type.");
409 assertEqual(sym.params[1].name, "count", "user defined param name overlays parser defined param name.");
411 sym = new Symbol("foo", [], "FUNCTION", new DocComment("/**Description.\n@param {array} pages The pages description.*"+"/"));
412 assertEqual(sym.params.length, 1, "user defined param with description is found.");
413 assertEqual(sym.params[0].desc, "The pages description.", "user defined param description is found.");
417 if (this.comment.getTag("constructor").length) {
418 this.isa = "CONSTRUCTOR";
422 var sym = new Symbol("foo", [], "OBJECT", new DocComment("/**@constructor*"+"/"));
423 assertEqual(sym.isa, "CONSTRUCTOR", "@constructor tag, makes symbol a constructor.");
427 if (this.comment.getTag("static").length) {
428 this.isStatic = true;
429 if (this.isa == "CONSTRUCTOR") {
430 this.isNamespace = true;
435 if (this.comment.getTag("singleton").length) {
436 this.isStatic = true;
437 //print('------------- got singleton ---------------' + this.isa);
438 //if (this.isa == "CONSTRUCTOR") {
439 // this.isNamespace = true;
446 var sym = new Symbol("foo", [], "OBJECT", new DocComment("/**@static\n@constructor*"+"/"));
447 assertEqual(sym.isStatic, true, "@static tag, makes isStatic true.");
448 assertEqual(sym.isNamespace, true, "@static and @constructor tag, makes isNamespace true.");
452 if (this.comment.getTag("inner").length) {
454 this.isStatic = false;
458 var sym = new Symbol("foo", [], "OBJECT", new DocComment("/**@inner*"+"/"));
459 assertEqual(sym.isStatic, false, "@inner tag, makes isStatic false.");
460 assertEqual(sym.isInner, true, "@inner makes isInner true.");
464 if (this.comment.getTag("field").length) {
469 var sym = new Symbol("foo", [], "FUNCTION", new DocComment("/**@field*"+"/"));
470 assertEqual(sym.isa, "OBJECT", "@field tag, makes symbol an object.");
474 if (this.comment.getTag("function").length) {
475 this.isa = "FUNCTION";
479 if (this.comment.getTag("param").length && this.isa == "OBJECT" ) {
480 // change a property to a function..
481 this.isa = "FUNCTION";
486 var sym = new Symbol("foo", [], "OBJECT", new DocComment("/**@function*"+"/"));
487 assertEqual(sym.isa, "FUNCTION", "@function tag, makes symbol a function.");
491 var events = this.comment.getTag("event");
493 this.isa = "FUNCTION";
498 var sym = new Symbol("foo", [], "OBJECT", new DocComment("/**@event*"+"/"));
499 assertEqual(sym.isa, "FUNCTION", "@event tag, makes symbol a function.");
500 assertEqual(sym.isEvent, true, "@event makes isEvent true.");
504 var names = this.comment.getTag("name");
506 this.setName(names[0].desc);
514 var properties = this.comment.getTag("property");
515 if (properties.length) {
516 thisProperties = this.properties;
517 for (var i = 0; i < properties.length; i++) {
518 var property = new Symbol(this.alias+"#"+properties[i].name, [], "OBJECT", new DocComment("/**"+properties[i].desc+"\n@name "+properties[i].name+"\n@memberOf "+this.alias+"#*/"));
519 // TODO: shouldn't the following happen in the addProperty method of Symbol?
520 property.name = properties[i].name;
521 property.memberOf = this.alias;
522 if (properties[i].type) property.type = properties[i].type;
523 if (properties[i].defaultValue) property.defaultValue = properties[i].defaultValue;
524 this.addProperty(property);
525 imports.Parser.Parser.addSymbol(property);
530 var conf = this.comment.getTag("cfg");
532 for (var i = 0; i < conf.length; i++) {
533 this.addConfig(conf[i]);
542 var returns = this.comment.getTag("return");
543 if (returns.length) { // there can be many return tags in a single doclet
544 this.returns = returns;
545 this.type = returns.map(function($){return $.type}).join(", ");
553 this.exceptions = this.comment.getTag("throws");
560 var requires = this.comment.getTag("requires");
561 if (requires.length) {
562 this.requires = requires.map(function($){return $.desc});
570 var types = this.comment.getTag("type");
572 this.type = types[0].desc; //multiple type tags are ignored
580 if (this.comment.getTag("private").length || this.isInner) {
581 this.isPrivate = true;
585 if (this.comment.getTag("ignore").length) {
586 this.isIgnored = true;
593 // @inherits ... as ...
594 var inherits = this.comment.getTag("inherits");
595 if (inherits.length) {
596 for (var i = 0; i < inherits.length; i++) {
597 if (/^\s*([a-z$0-9_.#-]+)(?:\s+as\s+([a-z$0-9_.#]+))?/i.test(inherits[i].desc)) {
598 var inAlias = RegExp.$1;
599 var inAs = RegExp.$2 || inAlias;
601 if (inAlias) inAlias = inAlias.replace(/\.prototype\.?/g, "#");
604 inAs = inAs.replace(/\.prototype\.?/g, "#");
605 inAs = inAs.replace(/^this\.?/, "#");
608 if (inAs.indexOf(inAlias) != 0) { //not a full namepath
610 if (this.alias.charAt(this.alias.length-1) == "#" || inAs.charAt(0) == "#") {
613 inAs = this.alias + joiner + inAs;
616 this.inherits.push({alias: inAlias, as: inAs});
625 this.augments = this.comment.getTag("augments");
628 if (this.comment.getTag("extends")) {
629 this.augments = this.comment.getTag("extends");
634 var defaults = this.comment.getTag("default");
635 if (defaults.length) {
636 if (this.is("OBJECT")) {
637 this.defaultValue = defaults[0].desc;
646 var memberOfs = this.comment.getTag("memberOf");
647 if (memberOfs.length) {
648 this.memberOf = memberOfs[0].desc;
649 this.memberOf = this.memberOf.replace(/\.prototype\.?/g, "#");
650 this.name = this.name.split('.').pop();
651 this.name = this.name.split('#').pop();
652 this.name = this.memberOf + this.name;
653 this._name = this.name
654 this.alias = this.name;
662 if (this.comment.getTag("public").length) {
663 this.isPrivate = false;
671 is : function(what) {
672 return this.isa === what;
675 isBuiltin : function() {
676 return SymbolSet.isBuiltin(this.alias);
679 setType : function(/**String*/comment, /**Boolean*/overwrite) {
680 if (!overwrite && this.type) return;
681 var typeComment = DocComment.unwrapComment(comment);
682 this.type = typeComment;
685 inherit : function(symbol) {
686 if (!this.hasMember(symbol.name) && !symbol.isInner) {
687 if (symbol.is("FUNCTION"))
688 this.methods.push(symbol);
689 else if (symbol.is("OBJECT"))
690 this.properties.push(symbol);
694 hasMember : function(name) {
695 return (this.hasMethod(name) || this.hasProperty(name));
698 addMember : function(symbol) {
699 //println("ADDMEMBER: " + this.name + " ++ " + symbol.name);
701 if (symbol.comment.getTag("cfg").length == 1) {
702 symbol.comment.getTag("cfg")[0].memberOf = this.alias;
703 this.addConfig(symbol.comment.getTag("cfg")[0]);
707 if (symbol.is("FUNCTION")) { this.addMethod(symbol); }
708 else if (symbol.is("OBJECT")) { this.addProperty(symbol); }
711 hasMethod : function(name) {
712 var thisMethods = this.methods;
713 for (var i = 0, l = thisMethods.length; i < l; i++) {
714 if (thisMethods[i].name == name) return true;
715 if (thisMethods[i].alias == name) return true;
720 addMethod : function(symbol) {
721 var methodAlias = symbol.alias;
722 var thisMethods = this.methods;
723 for (var i = 0, l = thisMethods.length; i < l; i++) {
724 if (thisMethods[i].alias == methodAlias) {
725 thisMethods[i] = symbol; // overwriting previous method
729 thisMethods.push(symbol); // new method with this alias
732 hasProperty : function(name) {
733 var thisProperties = this.properties;
734 for (var i = 0, l = thisProperties.length; i < l; i++) {
735 if (thisProperties[i].name == name) return true;
736 if (thisProperties[i].alias == name) return true;
741 addProperty : function(symbol) {
742 var propertyAlias = symbol.alias;
743 var thisProperties = this.properties;
744 for (var i = 0, l = thisProperties.length; i < l; i++) {
745 if (thisProperties[i].alias == propertyAlias) {
746 thisProperties[i] = symbol; // overwriting previous property
751 thisProperties.push(symbol); // new property with this alias
754 addDocTag : function(docTag)
756 this.comment.tags.push(docTag);
757 if (docTag.title == 'cfg') {
758 this.addConfig(docTag);
763 addConfig : function(docTag)
765 if (typeof(docTag['memberOf']) == 'undefined') {
766 // remove prototype data...
767 //var a = this.alias.split('#')[0];
768 //docTag.memberOf = a;
769 docTag.memberOf = this.alias;
771 if (typeof(this.cfgs[docTag.name]) == 'undefined') {
772 this.cfgs[docTag.name] = docTag;
776 configToArray: function()
779 for(var ci in this.cfgs) {
780 // dont show hidden!!
781 if (this.cfgs[ci].desc.match(/@hide/)) {
784 r.push(this.cfgs[ci]);
792 * Elements that are not serialized
796 '$args' // not needed AFAIK
799 Symbol.srcFile = ""; //running reference to the current file being parsed
802 Symbol.fromDump = function(t)
804 var ns = new Symbol();
806 if (typeof(ns[i]) == "undefined") {
807 println("ERR:no default for Symbol:"+ i);