e915b736c82f60bba9644592bb44a48ffe80fd31
[roojspacker] / src / jsdoc / Symbol.vala
1  
2 /**
3         Create a new Symbol.
4         @class Represents a symbol in the source code.
5  */
6  
7  
8 namespace JSDOC {
9
10
11         public  class Symbol : Object
12         {
13                 
14                 private static bool regex_init = false;
15                 private GLib.Regex regex_global;
16                 private GLib.Regex regex_prototype;
17                 
18                 static void  regexInit()
19                 {
20                         if (Symbol.regex_init = true) {
21                                 return;
22                         }
23                         Symbol.regex_init = true;
24                         Symbol.regex_global = new GLib.Regex("^_global_[.#-]");
25                         Symbol.regex_prototype = new GLib.Regex("\\.prototype\\.?");
26                 }
27
28                 private string private_string_name = "";
29                 private string private_name {
30                 set {
31                                 var n = Symbol.regex_global(value, value.length, 0, "");
32                         n =  Symbol.regex_prototype(n,n.length, 0, "#");
33                         while (true) {
34                                 if (!n.has_suffix("#")) {
35                                         break;
36                                         }
37                                         n = n.substring(0, n.length-1);
38                                 }
39                         
40                         this.private_string_name = n;
41                 }
42                 
43                 }
44                  
45         public string name {
46                 get { return this.private_string_name; }
47                 }
48                 
49       
50         string defaultValue = "";
51         
52                 private Gee.ArrayList<DocTag> private_doctag_params;
53
54                 private Gee.ArrayList<DocTag> private_params{
55                         set  {
56                                 for (var i = 0; i < value.size; i++) {
57                                    
58                                     this.private_doctag_params.add(v.get(i));
59                                 }
60                                 //this.params = this._params;
61                         }
62                 }
63      
64                 Gee.ArrayList<string> private_string_params{
65                         set  {
66                                 for (var i = 0; i < value.size; i++) {
67
68                                     //var ty = v[i].hasOwnProperty('type') ? v[i].type : '';
69                                     this.private_doctag_params.add( new DocTag(value.get(i)));
70                                            
71                                    //"param"+((ty)?" {"+ty+"}":"")+" "+v.get(i).name);
72                                     
73                                 }
74                                 
75                         }
76                 }
77                 public Gee.ArrayList<DocTag> params {
78                         get {
79                                 return this.private_doctag_params;
80                         }
81                 
82                 }
83
84                 private Gee.ArrayList<DocTag>  augments ;  
85
86                 private Gee.ArrayList<DocTag>  exceptions ;
87
88                 private Gee.ArrayList<DocTag>  inherits; 
89                 private Gee.ArrayList<DocTag>  methods;
90
91                 private Gee.ArrayList<DocTag> properties;
92                 private Gee.ArrayList<DocTag> requires;
93                 private Gee.ArrayList<DocTag> returns;
94                 private Gee.ArrayList<DocTag> see ;
95
96          
97         //childClasses : [],
98         //cfgs : {},
99         
100         
101         DocComment comment;
102                 
103         //$args : [], // original arguments used when constructing.
104         string addOn = "";
105         public string alias = "";
106         
107         string author = "";
108         string classDesc = "";
109
110         string deprecated = "";
111         string desc = "";
112         //events : false,
113         string example = "";
114         
115         //inheritsFrom : [],
116         string isa = "OBJECT"; // OBJECT//FUNCTION
117         
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;
125         
126         string memberOf = "";
127
128
129
130        
131         string since = "";
132
133         string type = "";
134         string version = "";
135        
136         string srcFile = "";
137         
138         
139         
140         public void initArrays()
141         {
142             // only initialize arrays / objects..
143
144             
145             //this.params = [];
146             //this.$args = [];
147             
148             //this.events = [];
149             this.exceptions = new Gee.ArrayList<DocTag>();
150             this.inherits = new Gee.ArrayList<DocTag>();
151             //
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>();
159  
160             
161             
162             this.cfgs = {};
163             // derived later?
164             //this.inheritsFrom = [];
165             //this.childClasses = [];
166             
167             this.comment = new DocComment();
168             this.comment.isUserComment =  false;
169             
170                
171         }
172                 
173                 Public Symbol.new_builtin(string name)
174                 {
175             Symbol.regexInit();
176             this.initArrays();
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;
184                         this.srcFile = "";
185                         this.isPrivate = false;
186                         // init arrays....
187                         
188                         
189                         
190                 }
191                 
192
193  
194
195         public Symbol.new_populate_with_args(
196                 string  name,
197                 Gee.ArrayList<string> params, // fixme???
198                 string isa,
199                 string comment
200         ) {
201             Symbol.regexInit();
202             this.initArrays();
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);
210             
211             this.srcFile = DocParser.currentSourceFile;
212             
213            
214             
215             if (this.is("FILE") && !this.alias) { // this will never hapen???
216                         this.alias = this.srcFile;
217                 }
218
219             this.tagsFromComment();
220             
221         }
222
223         void tagsFromComment() {
224             // @author
225             var authors = this.comment.getTag("author");
226             if (authors.size) {
227                         // turns author into a string....
228                         this.author = "";
229                 foreach(var a in authors) {
230                     this.author += (this.author == "") ? "": ", ";
231                     this.author += a.desc;
232                 }
233             }
234             
235             /*~t
236                 assert("testing Symbol");
237                 
238                 requires("../lib/JSDOC/DocComment.js");
239                 requires("../frame/String.js");
240                 requires("../lib/JSDOC/DocTag.js");
241
242                 var sym = new Symbol("foo", [], "OBJECT", new DocComment("/**@author Joe Smith*"+"/"));
243                 assertEqual(sym.author, "Joe Smith", "@author tag, author is found.");
244             */
245             // @desc
246             var mth = this.comment.getTag("method");
247             if (mth.length) {
248                 this.isa = "FUNCTION";
249             }
250             // @desc
251             var descs = this.comment.getTag("desc");
252             if (descs.length) {
253                 this.desc = "";
254                 foreach(var d in desc) {
255                     this.desc = this.desc == "" ? "": "\n";
256                     this.desc += d.desc;
257                 }
258
259             }
260             
261             /*~t
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.");
264             */
265             
266             // @overview
267             if (this.is("FILE")) {
268                 if (!this.alias) this.alias = this.srcFile;
269                 
270                 var overviews = this.comment.getTag("overview");
271                 if (overviews.length) {
272                     foreach(var d in overviews) {
273                         this.desc = this.desc == "" ? "": "\n";
274                         this.desc += d.desc;
275                     }
276                 }
277             }
278             
279             /*~t
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.");
282             */
283             
284             // @since
285             var sinces = this.comment.getTag("since");
286             if (sinces.length) {
287                 foreach(var d in sinces) {
288                     this.sinces = this.desc == "" ? "": "\n";
289                     this.sinces += d.desc;
290                 }
291             }
292             
293             /*~t
294                 var sym = new Symbol("foo", [], "FILE", new DocComment("/**@since 1.01*"+"/"));
295                 assertEqual(sym.since, "1.01", "@since tag, description is found.");
296             */
297             
298             // @constant
299             if (this.comment.getTag("constant").length) {
300                 this.isConstant = true;
301                 this.isa = "OBJECT";
302             }
303             
304             /*~t
305                 var sym = new Symbol("foo", [], "FILE", new DocComment("/**@constant*"+"/"));
306                 assertEqual(sym.isConstant, true, "@constant tag, isConstant set.");
307             */
308             
309             // @version
310             var versions = this.comment.getTag("version");
311             if (versions.length) {
312                  foreach(var d in versions) {
313                     this.desc = this.desc == "" ? "": "\n";
314                     this.desc += d.desc;
315                 }
316                 this.version = versions.map(function($){return $.desc;}).join(", ");
317             }
318             
319             /*~t
320                 var sym = new Symbol("foo", [], "FILE", new DocComment("/**@version 2.0x*"+"/"));
321                 assertEqual(sym.version, "2.0x", "@version tag, version is found.");
322             */
323             
324             // @deprecated
325             var deprecateds = this.comment.getTag("deprecated");
326             if (deprecateds.length) {
327                 this.deprecated = deprecateds.map(function($){return $.desc;}).join("\n");
328             }
329             
330             /*~t
331                 var sym = new Symbol("foo", [], "FILE", new DocComment("/**@deprecated Use other method.*"+"/"));
332                 assertEqual(sym.deprecated, "Use other method.", "@deprecated tag, desc is found.");
333             */
334             
335             // @example
336             var examples = this.comment.getTag("example");
337             if (examples.length) {
338                 this.example = examples[0];
339             }
340             
341             /*~t
342                 var sym = new Symbol("foo", [], "FILE", new DocComment("/**@example This\n  is an example.*"+"/"));
343                 assertEqual(sym.example, "This\n  is an example.", "@deprecated tag, desc is found.");
344             */
345             
346             // @see
347             var sees = this.comment.getTag("see");
348             if (sees.length) {
349                 var thisSee = this.see;
350                 sees.map(function($){thisSee.push($.desc);});
351             }
352             
353             /*~t
354                 var sym = new Symbol("foo", [], "FILE", new DocComment("/**@see The other thing.*"+"/"));
355                 assertEqual(sym.see, "The other thing.", "@see tag, desc is found.");
356             */
357             
358             // @class
359             var classes = this.comment.getTag("class");
360             if (classes.length) {
361                 //print(JSON.stringify(this,null,4));
362                 this.isa = "CONSTRUCTOR";
363                 this.classDesc = classes[0].desc; // desc can't apply to the constructor as there is none.
364                 if (!this.classDesc) {
365                     this.classDesc = this.desc;
366                    }
367                 
368                 
369             }
370             
371             /*~t
372                 var sym = new Symbol("foo", [], "OBJECT", new DocComment("/**@class This describes the class.*"+"/"));
373                 assertEqual(sym.isa, "CONSTRUCTOR", "@class tag, makes symbol a constructor.");
374                 assertEqual(sym.classDesc, "This describes the class.", "@class tag, class description is found.");
375             */
376             
377             // @namespace
378             var namespaces = this.comment.getTag("namespace");
379             if (namespaces.length) {
380                 this.classDesc = namespaces[0].desc+"\n"+this.desc; // desc can't apply to the constructor as there is none.
381                 this.isNamespace = true;
382             }
383             
384             /*~t
385                 var sym = new Symbol("foo", [], "OBJECT", new DocComment("/**@namespace This describes the namespace.*"+"/"));
386                 assertEqual(sym.classDesc, "This describes the namespace.\n", "@namespace tag, class description is found.");
387             */
388             
389             // @param
390             var params = this.comment.getTag("param");
391             if (params.length) {
392                 // user-defined params overwrite those with same name defined by the parser
393                 var thisParams = this.getParams();
394
395                 if (thisParams.length == 0) { // none exist yet, so just bung all these user-defined params straight in
396                     this.setParams(params);
397                 }
398                 else { // need to overlay these user-defined params on to existing parser-defined params
399                     for (var i = 0, l = params.length; i < l; i++) {
400                         if (thisParams[i]) {
401                             if (params[i].type) thisParams[i].type = params[i].type;
402                             thisParams[i].name = params[i].name;
403                             thisParams[i].desc = params[i].desc;
404                             thisParams[i].isOptional = params[i].isOptional;
405                             thisParams[i].defaultValue = params[i].defaultValue;
406                         }
407                         else thisParams[i] = params[i];
408                     }
409                 }
410             }
411             
412             /*~t
413                 var sym = new Symbol("foo", [{type: "array", name: "pages"}], "FUNCTION", new DocComment("/**Description.*"+"/"));
414                 assertEqual(sym.params.length, 1, "parser defined param is found.");
415                 
416                 sym = new Symbol("foo", [], "FUNCTION", new DocComment("/**Description.\n@param {array} pages*"+"/"));
417                 assertEqual(sym.params.length, 1, "user defined param is found.");
418                 assertEqual(sym.params[0].type, "array", "user defined param type is found.");
419                 assertEqual(sym.params[0].name, "pages", "user defined param name is found.");
420                 
421                 sym = new Symbol("foo", [{type: "array", name: "pages"}], "FUNCTION", new DocComment("/**Description.\n@param {string} uid*"+"/"));
422                 assertEqual(sym.params.length, 1, "user defined param overwrites parser defined param.");
423                 assertEqual(sym.params[0].type, "string", "user defined param type overwrites parser defined param type.");
424                 assertEqual(sym.params[0].name, "uid", "user defined param name overwrites parser defined param name.");
425             
426                 sym = new Symbol("foo", [{type: "array", name: "pages"}, {type: "number", name: "count"}], "FUNCTION", new DocComment("/**Description.\n@param {string} uid*"+"/"));
427                 assertEqual(sym.params.length, 2, "user defined params  overlay parser defined params.");
428                 assertEqual(sym.params[1].type, "number", "user defined param type overlays parser defined param type.");
429                 assertEqual(sym.params[1].name, "count", "user defined param name overlays parser defined param name.");
430
431                 sym = new Symbol("foo", [], "FUNCTION", new DocComment("/**Description.\n@param {array} pages The pages description.*"+"/"));
432                 assertEqual(sym.params.length, 1, "user defined param with description is found.");
433                 assertEqual(sym.params[0].desc, "The pages description.", "user defined param description is found.");
434             */
435             
436             // @constructor
437             if (this.comment.getTag("constructor").length) {
438                 this.isa = "CONSTRUCTOR";
439             }
440             
441             /*~t
442                 var sym = new Symbol("foo", [], "OBJECT", new DocComment("/**@constructor*"+"/"));
443                 assertEqual(sym.isa, "CONSTRUCTOR", "@constructor tag, makes symbol a constructor.");
444             */
445             
446             // @static
447             if (this.comment.getTag("static").length) {
448                 this.isStatic = true;
449                 if (this.isa == "CONSTRUCTOR") {
450                     this.isNamespace = true;
451                 }
452             }
453             
454                 // @static
455             if (this.comment.getTag("singleton").length) {
456                 this.isStatic = true;
457                 //print('------------- got singleton ---------------' + this.isa);
458                 //if (this.isa == "CONSTRUCTOR") {
459                 //      this.isNamespace = true;
460                 //}
461             }
462             
463             
464             
465             /*~t
466                 var sym = new Symbol("foo", [], "OBJECT", new DocComment("/**@static\n@constructor*"+"/"));
467                 assertEqual(sym.isStatic, true, "@static tag, makes isStatic true.");
468                 assertEqual(sym.isNamespace, true, "@static and @constructor tag, makes isNamespace true.");
469             */
470             
471             // @inner
472             if (this.comment.getTag("inner").length) {
473                 this.isInner = true;
474                 this.isStatic = false;
475             }
476             
477             /*~t
478                 var sym = new Symbol("foo", [], "OBJECT", new DocComment("/**@inner*"+"/"));
479                 assertEqual(sym.isStatic, false, "@inner tag, makes isStatic false.");
480                 assertEqual(sym.isInner, true, "@inner makes isInner true.");
481             */
482             
483             // @field
484             if (this.comment.getTag("field").length) {
485                 this.isa = "OBJECT";
486             }
487             
488             /*~t
489                 var sym = new Symbol("foo", [], "FUNCTION", new DocComment("/**@field*"+"/"));
490                 assertEqual(sym.isa, "OBJECT", "@field tag, makes symbol an object.");
491             */
492             
493             // @function
494             if (this.comment.getTag("function").length) {
495                 this.isa = "FUNCTION";
496             }
497             
498             // @param
499             if (this.comment.getTag("param").length && this.isa == "OBJECT" ) {
500                 // change a property to a function..
501                 this.isa = "FUNCTION";
502             }
503             
504             
505             /*~t
506                 var sym = new Symbol("foo", [], "OBJECT", new DocComment("/**@function*"+"/"));
507                 assertEqual(sym.isa, "FUNCTION", "@function tag, makes symbol a function.");
508             */
509             
510             // @event
511             var events = this.comment.getTag("event");
512             if (events.length) {
513                 this.isa = "FUNCTION";
514                 this.isEvent = true;
515             }
516             
517             /*~t
518                 var sym = new Symbol("foo", [], "OBJECT", new DocComment("/**@event*"+"/"));
519                 assertEqual(sym.isa, "FUNCTION", "@event tag, makes symbol a function.");
520                 assertEqual(sym.isEvent, true, "@event makes isEvent true.");
521             */
522             
523             // @name
524             var names = this.comment.getTag("name");
525             if (names.length) {
526                 this.setName(names[0].desc);
527             }
528             
529             /*~t
530                 // todo
531             */
532             
533             // @property
534             var properties = this.comment.getTag("property");
535             if (properties.length) {
536                 thisProperties = this.properties;
537                 for (var i = 0; i < properties.length; i++) {
538                     var property = new Symbol(this.alias+"#"+properties[i].name, [], "OBJECT", new DocComment("/**"+properties[i].desc+"\n@name "+properties[i].name+"\n@memberOf "+this.alias+"#*/"));
539                     // TODO: shouldn't the following happen in the addProperty method of Symbol?
540                     property.name = properties[i].name;
541                     property.memberOf = this.alias;
542                     if (properties[i].type) property.type = properties[i].type;
543                     if (properties[i].defaultValue) property.defaultValue = properties[i].defaultValue;
544                     this.addProperty(property);
545                     imports.Parser.Parser.addSymbol(property);
546                 }
547             }
548             
549             // config..
550             var conf = this.comment.getTag("cfg");
551             if (conf.length) {
552                 for (var i = 0; i < conf.length; i++) {
553                     this.addConfig(conf[i]);
554                 }
555             }
556             
557             /*~t
558                 // todo
559             */
560
561             // @return
562             var returns = this.comment.getTag("return");
563             if (returns.length) { // there can be many return tags in a single doclet
564                 this.returns = returns;
565                 this.type = returns.map(function($){return $.type}).join(", ");
566             }
567             
568             /*~t
569                 // todo
570             */
571             
572             // @exception
573             this.exceptions = this.comment.getTag("throws");
574             
575             /*~t
576                 // todo
577             */
578             
579             // @requires
580             var requires = this.comment.getTag("requires");
581             if (requires.length) {
582                 this.requires = requires.map(function($){return $.desc});
583             }
584             
585             /*~t
586                 // todo
587             */
588             
589             // @type
590             var types = this.comment.getTag("type");
591             if (types.length) {
592                 this.type = types[0].desc; //multiple type tags are ignored
593             }
594             
595             /*~t
596                 // todo
597             */
598             
599             // @private
600             if (this.comment.getTag("private").length || this.isInner) {
601                 this.isPrivate = true;
602             }
603             
604             // @ignore
605             if (this.comment.getTag("ignore").length) {
606                 this.isIgnored = true;
607             }
608             
609             /*~t
610                 // todo
611             */
612             
613             // @inherits ... as ...
614             var inherits = this.comment.getTag("inherits");
615             if (inherits.length) {
616                 for (var i = 0; i < inherits.length; i++) {
617                     if (/^\s*([a-z$0-9_.#-]+)(?:\s+as\s+([a-z$0-9_.#]+))?/i.test(inherits[i].desc)) {
618                         var inAlias = RegExp.$1;
619                         var inAs = RegExp.$2 || inAlias;
620
621                         if (inAlias) inAlias = inAlias.replace(/\.prototype\.?/g, "#");
622                         
623                         if (inAs) {
624                             inAs = inAs.replace(/\.prototype\.?/g, "#");
625                             inAs = inAs.replace(/^this\.?/, "#");
626                         }
627
628                         if (inAs.indexOf(inAlias) != 0) { //not a full namepath
629                             var joiner = ".";
630                             if (this.alias.charAt(this.alias.length-1) == "#" || inAs.charAt(0) == "#") {
631                                 joiner = "";
632                             }
633                             inAs = this.alias + joiner + inAs;
634                         }
635                     }
636                     this.inherits.push({alias: inAlias, as: inAs});
637                 }
638             }
639             
640             /*~t
641                 // todo
642             */
643
644             // @augments
645             this.augments = this.comment.getTag("augments");
646             
647             //@extends - Ext
648             if (this.comment.getTag("extends")) {   
649                 this.augments = this.comment.getTag("extends");
650             }
651             
652             
653             // @default
654             var defaults = this.comment.getTag("default");
655             if (defaults.length) {
656                 if (this.is("OBJECT")) {
657                     this.defaultValue = defaults[0].desc;
658                 }
659             }
660             
661             /*~t
662                 // todo
663             */
664             
665             // @memberOf
666             var memberOfs = this.comment.getTag("memberOf");
667             if (memberOfs.length) {
668                 this.memberOf = memberOfs[0].desc;
669                 this.memberOf = this.memberOf.replace(/\.prototype\.?/g, "#");
670                 this.name = this.name.split('.').pop();
671                 this.name = this.name.split('#').pop();
672                 this.name = this.memberOf + this.name;
673                 this._name = this.name
674                 this.alias = this.name;
675             }
676
677             /*~t
678                 // todo
679             */
680             
681             // @public
682             if (this.comment.getTag("public").length) {
683                 this.isPrivate = false;
684             }
685             
686             /*~t
687                 // todo
688             */
689         },
690
691         is : function(what) {
692             return this.isa === what;
693         },
694
695         isBuiltin : function() {
696             return SymbolSet.isBuiltin(this.alias);
697         },
698
699         setType : function(/**String*/comment, /**Boolean*/overwrite) {
700             if (!overwrite && this.type) return;
701             var typeComment = DocComment.unwrapComment(comment);
702             this.type = typeComment;
703         },
704
705         inherit : function(symbol) {
706             if (!this.hasMember(symbol.name) && !symbol.isInner) {
707                 if (symbol.is("FUNCTION"))
708                     this.methods.push(symbol);
709                 else if (symbol.is("OBJECT"))
710                     this.properties.push(symbol);
711             }
712         },
713
714         hasMember : function(name) {
715             return (this.hasMethod(name) || this.hasProperty(name));
716         },
717
718         addMember : function(symbol) {
719             //println("ADDMEMBER: " + this.name +  " ++ " + symbol.name);
720             
721             if (symbol.comment.getTag("cfg").length == 1) { 
722                 symbol.comment.getTag("cfg")[0].memberOf = this.alias;
723                 this.addConfig(symbol.comment.getTag("cfg")[0]);
724                 return;
725             }
726             
727             if (symbol.is("FUNCTION")) { this.addMethod(symbol); }
728             else if (symbol.is("OBJECT")) { this.addProperty(symbol); }
729         },
730
731         hasMethod : function(name) {
732             var thisMethods = this.methods;
733             for (var i = 0, l = thisMethods.length; i < l; i++) {
734                 if (thisMethods[i].name == name) return true;
735                 if (thisMethods[i].alias == name) return true;
736             }
737             return false;
738         },
739
740         addMethod : function(symbol) {
741             var methodAlias = symbol.alias;
742             var thisMethods = this.methods;
743             for (var i = 0, l = thisMethods.length; i < l; i++) {
744                 if (thisMethods[i].alias == methodAlias) {
745                     thisMethods[i] = symbol; // overwriting previous method
746                     return;
747                 }
748             }
749             thisMethods.push(symbol); // new method with this alias
750         },
751
752         hasProperty : function(name) {
753             var thisProperties = this.properties;
754             for (var i = 0, l = thisProperties.length; i < l; i++) {
755                 if (thisProperties[i].name == name) return true;
756                 if (thisProperties[i].alias == name) return true;
757             }
758             return false;
759         },
760
761         addProperty : function(symbol) {
762             var propertyAlias = symbol.alias;
763             var thisProperties = this.properties;
764             for (var i = 0, l = thisProperties.length; i < l; i++) {
765                 if (thisProperties[i].alias == propertyAlias) {
766                     thisProperties[i] = symbol; // overwriting previous property
767                     return;
768                 }
769             }
770
771             thisProperties.push(symbol); // new property with this alias
772         },
773         
774         addDocTag : function(docTag)
775         {
776             this.comment.tags.push(docTag);
777             if (docTag.title == 'cfg') {
778                 this.addConfig(docTag);
779             }
780             
781         },
782         
783         addConfig : function(docTag)
784         {
785             if (typeof(docTag['memberOf']) == 'undefined') {
786                 // remove prototype data...
787                 //var a = this.alias.split('#')[0];
788                 //docTag.memberOf = a;
789                 docTag.memberOf = this.alias;
790             }
791             if (typeof(this.cfgs[docTag.name]) == 'undefined') {
792                 this.cfgs[docTag.name] = docTag;
793             }
794             
795         },
796         configToArray: function()
797         {
798             var r = [];
799             for(var ci in this.cfgs) {
800                 // dont show hidden!!
801                 if (this.cfgs[ci].desc.match(/@hide/)) {
802                     continue;
803                 }
804                 r.push(this.cfgs[ci]); 
805                
806             }
807             return r;
808         }
809 });
810
811 /**
812  * Elements that are not serialized
813  * 
814  */
815 Symbol.hide = [ 
816     '$args' // not needed AFAIK
817 ]
818
819 Symbol.srcFile = ""; //running reference to the current file being parsed
820
821
822 Symbol.fromDump = function(t)
823 {
824     var ns = new Symbol();
825     for (var i in t) {
826         if (typeof(ns[i]) == "undefined") {
827             println("ERR:no default for Symbol:"+ i);
828         }
829         ns[i] = t[i];
830     }
831     return ns;
832 }