a7f955ca8242a8707b16321fe5626a7461ac6b28
[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                 this.since = "";
288                 foreach(var d in sinces) {
289                     this.since = this.since == "" ? "": "\n";
290                     this.since += d.desc;
291                 }
292             }
293             
294             /*~t
295                 var sym = new Symbol("foo", [], "FILE", new DocComment("/**@since 1.01*"+"/"));
296                 assertEqual(sym.since, "1.01", "@since tag, description is found.");
297             */
298             
299             // @constant
300             if (this.comment.getTag("constant").length) {
301                 this.isConstant = true;
302                 this.isa = "OBJECT";
303             }
304             
305             /*~t
306                 var sym = new Symbol("foo", [], "FILE", new DocComment("/**@constant*"+"/"));
307                 assertEqual(sym.isConstant, true, "@constant tag, isConstant set.");
308             */
309             
310             // @version
311             var versions = this.comment.getTag("version");
312             if (versions.length) {
313                 this.version = "";
314                  foreach(var d in versions) {
315                     this.version = this.version == "" ? "": "\n";
316                     this.version += d.desc;
317                 }
318             }
319             
320             /*~t
321                 var sym = new Symbol("foo", [], "FILE", new DocComment("/**@version 2.0x*"+"/"));
322                 assertEqual(sym.version, "2.0x", "@version tag, version is found.");
323             */
324             
325             // @deprecated
326             var deprecateds = this.comment.getTag("deprecated");
327             if (deprecateds.length) {
328                 this.deprecated = "";
329                  foreach(var d in deprecateds) {
330                     this.deprecated = this.deprecated == "" ? "": "\n";
331                     this.deprecated += d.desc;
332                 }
333             }
334             
335             /*~t
336                 var sym = new Symbol("foo", [], "FILE", new DocComment("/**@deprecated Use other method.*"+"/"));
337                 assertEqual(sym.deprecated, "Use other method.", "@deprecated tag, desc is found.");
338             */
339             
340             // @example
341             var examples = this.comment.getTag("example");
342             if (examples.length) {
343                 this.example = examples[0];
344             }
345             
346             /*~t
347                 var sym = new Symbol("foo", [], "FILE", new DocComment("/**@example This\n  is an example.*"+"/"));
348                 assertEqual(sym.example, "This\n  is an example.", "@deprecated tag, desc is found.");
349             */
350             
351             // @see
352             var sees = this.comment.getTag("see");
353             if (sees.length) {
354                 var thisSee = this.see;
355                 foreach(var s in sees) {
356                     this.see.add(s.desc);
357                 }
358           }
359             
360             /*~t
361                 var sym = new Symbol("foo", [], "FILE", new DocComment("/**@see The other thing.*"+"/"));
362                 assertEqual(sym.see, "The other thing.", "@see tag, desc is found.");
363             */
364             
365             // @class
366             var classes = this.comment.getTag("class");
367             if (classes.length) {
368                 //print(JSON.stringify(this,null,4));
369                 this.isa = "CONSTRUCTOR";
370                 this.classDesc = classes[0].desc; // desc can't apply to the constructor as there is none.
371                 if (!this.classDesc) {
372                     this.classDesc = this.desc;
373                    }
374                 
375                 
376             }
377             
378             /*~t
379                 var sym = new Symbol("foo", [], "OBJECT", new DocComment("/**@class This describes the class.*"+"/"));
380                 assertEqual(sym.isa, "CONSTRUCTOR", "@class tag, makes symbol a constructor.");
381                 assertEqual(sym.classDesc, "This describes the class.", "@class tag, class description is found.");
382             */
383             
384             // @namespace
385             var namespaces = this.comment.getTag("namespace");
386             if (namespaces.length) {
387                 this.classDesc = namespaces[0].desc+"\n"+this.desc; // desc can't apply to the constructor as there is none.
388                 this.isNamespace = true;
389             }
390             
391             /*~t
392                 var sym = new Symbol("foo", [], "OBJECT", new DocComment("/**@namespace This describes the namespace.*"+"/"));
393                 assertEqual(sym.classDesc, "This describes the namespace.\n", "@namespace tag, class description is found.");
394             */
395             
396             // @param
397             var params = this.comment.getTag("param");
398             if (params.length) {
399                 // user-defined params overwrite those with same name defined by the parser
400                 var thisParams = this.getParams();
401
402                 if (thisParams.length == 0) { // none exist yet, so just bung all these user-defined params straight in
403                     this.setParams(params);
404                 }
405                 else { // need to overlay these user-defined params on to existing parser-defined params
406                     for (var i = 0, l = params.length; i < l; i++) {
407                         if (thisParams[i]) {
408                             if (params[i].type) thisParams[i].type = params[i].type;
409                             thisParams[i].name = params[i].name;
410                             thisParams[i].desc = params[i].desc;
411                             thisParams[i].isOptional = params[i].isOptional;
412                             thisParams[i].defaultValue = params[i].defaultValue;
413                         }
414                         else thisParams[i] = params[i];
415                     }
416                 }
417             }
418             
419             /*~t
420                 var sym = new Symbol("foo", [{type: "array", name: "pages"}], "FUNCTION", new DocComment("/**Description.*"+"/"));
421                 assertEqual(sym.params.length, 1, "parser defined param is found.");
422                 
423                 sym = new Symbol("foo", [], "FUNCTION", new DocComment("/**Description.\n@param {array} pages*"+"/"));
424                 assertEqual(sym.params.length, 1, "user defined param is found.");
425                 assertEqual(sym.params[0].type, "array", "user defined param type is found.");
426                 assertEqual(sym.params[0].name, "pages", "user defined param name is found.");
427                 
428                 sym = new Symbol("foo", [{type: "array", name: "pages"}], "FUNCTION", new DocComment("/**Description.\n@param {string} uid*"+"/"));
429                 assertEqual(sym.params.length, 1, "user defined param overwrites parser defined param.");
430                 assertEqual(sym.params[0].type, "string", "user defined param type overwrites parser defined param type.");
431                 assertEqual(sym.params[0].name, "uid", "user defined param name overwrites parser defined param name.");
432             
433                 sym = new Symbol("foo", [{type: "array", name: "pages"}, {type: "number", name: "count"}], "FUNCTION", new DocComment("/**Description.\n@param {string} uid*"+"/"));
434                 assertEqual(sym.params.length, 2, "user defined params  overlay parser defined params.");
435                 assertEqual(sym.params[1].type, "number", "user defined param type overlays parser defined param type.");
436                 assertEqual(sym.params[1].name, "count", "user defined param name overlays parser defined param name.");
437
438                 sym = new Symbol("foo", [], "FUNCTION", new DocComment("/**Description.\n@param {array} pages The pages description.*"+"/"));
439                 assertEqual(sym.params.length, 1, "user defined param with description is found.");
440                 assertEqual(sym.params[0].desc, "The pages description.", "user defined param description is found.");
441             */
442             
443             // @constructor
444             if (this.comment.getTag("constructor").length) {
445                 this.isa = "CONSTRUCTOR";
446             }
447             
448             /*~t
449                 var sym = new Symbol("foo", [], "OBJECT", new DocComment("/**@constructor*"+"/"));
450                 assertEqual(sym.isa, "CONSTRUCTOR", "@constructor tag, makes symbol a constructor.");
451             */
452             
453             // @static
454             if (this.comment.getTag("static").length) {
455                 this.isStatic = true;
456                 if (this.isa == "CONSTRUCTOR") {
457                     this.isNamespace = true;
458                 }
459             }
460             
461                 // @static
462             if (this.comment.getTag("singleton").length) {
463                 this.isStatic = true;
464                 //print('------------- got singleton ---------------' + this.isa);
465                 //if (this.isa == "CONSTRUCTOR") {
466                 //      this.isNamespace = true;
467                 //}
468             }
469             
470             
471             
472             /*~t
473                 var sym = new Symbol("foo", [], "OBJECT", new DocComment("/**@static\n@constructor*"+"/"));
474                 assertEqual(sym.isStatic, true, "@static tag, makes isStatic true.");
475                 assertEqual(sym.isNamespace, true, "@static and @constructor tag, makes isNamespace true.");
476             */
477             
478             // @inner
479             if (this.comment.getTag("inner").length) {
480                 this.isInner = true;
481                 this.isStatic = false;
482             }
483             
484             /*~t
485                 var sym = new Symbol("foo", [], "OBJECT", new DocComment("/**@inner*"+"/"));
486                 assertEqual(sym.isStatic, false, "@inner tag, makes isStatic false.");
487                 assertEqual(sym.isInner, true, "@inner makes isInner true.");
488             */
489             
490             // @field
491             if (this.comment.getTag("field").length) {
492                 this.isa = "OBJECT";
493             }
494             
495             /*~t
496                 var sym = new Symbol("foo", [], "FUNCTION", new DocComment("/**@field*"+"/"));
497                 assertEqual(sym.isa, "OBJECT", "@field tag, makes symbol an object.");
498             */
499             
500             // @function
501             if (this.comment.getTag("function").length) {
502                 this.isa = "FUNCTION";
503             }
504             
505             // @param
506             if (this.comment.getTag("param").length && this.isa == "OBJECT" ) {
507                 // change a property to a function..
508                 this.isa = "FUNCTION";
509             }
510             
511             
512             /*~t
513                 var sym = new Symbol("foo", [], "OBJECT", new DocComment("/**@function*"+"/"));
514                 assertEqual(sym.isa, "FUNCTION", "@function tag, makes symbol a function.");
515             */
516             
517             // @event
518             var events = this.comment.getTag("event");
519             if (events.length) {
520                 this.isa = "FUNCTION";
521                 this.isEvent = true;
522             }
523             
524             /*~t
525                 var sym = new Symbol("foo", [], "OBJECT", new DocComment("/**@event*"+"/"));
526                 assertEqual(sym.isa, "FUNCTION", "@event tag, makes symbol a function.");
527                 assertEqual(sym.isEvent, true, "@event makes isEvent true.");
528             */
529             
530             // @name
531             var names = this.comment.getTag("name");
532             if (names.length) {
533                 this.setName(names[0].desc);
534             }
535             
536             /*~t
537                 // todo
538             */
539             
540             // @property
541             var properties = this.comment.getTag("property");
542             if (properties.length) {
543                 thisProperties = this.properties;
544                 for (var i = 0; i < properties.length; i++) {
545                     var property = new Symbol(
546                         this.alias+"#"+properties[i].name,
547                          [], 
548                         "OBJECT",
549                          new DocComment(
550                             "/**"+properties[i].desc+"\n@name "+properties[i].name+"\n@memberOf "+this.alias+"#*/"
551                     ));
552                     // TODO: shouldn't the following happen in the addProperty method of Symbol?
553                     property.name = properties[i].name;
554                     property.memberOf = this.alias;
555                     if (properties[i].type) property.type = properties[i].type;
556                     if (properties[i].defaultValue) property.defaultValue = properties[i].defaultValue;
557                     this.addProperty(property);
558                     imports.Parser.Parser.addSymbol(property);
559                 }
560             }
561             
562             // config..
563             var conf = this.comment.getTag("cfg");
564             if (conf.length) {
565                 for (var i = 0; i < conf.length; i++) {
566                     this.addConfig(conf[i]);
567                 }
568             }
569             
570             /*~t
571                 // todo
572             */
573
574             // @return
575             var returns = this.comment.getTag("return");
576             if (returns.length) { // there can be many return tags in a single doclet
577                 this.returns = returns;
578                 this.type = returns.map(function($){return $.type}).join(", ");
579             }
580             
581             /*~t
582                 // todo
583             */
584             
585             // @exception
586             this.exceptions = this.comment.getTag("throws");
587             
588             /*~t
589                 // todo
590             */
591             
592             // @requires
593             var requires = this.comment.getTag("requires");
594             if (requires.length) {
595                 this.requires = requires.map(function($){return $.desc});
596             }
597             
598             /*~t
599                 // todo
600             */
601             
602             // @type
603             var types = this.comment.getTag("type");
604             if (types.length) {
605                 this.type = types[0].desc; //multiple type tags are ignored
606             }
607             
608             /*~t
609                 // todo
610             */
611             
612             // @private
613             if (this.comment.getTag("private").length || this.isInner) {
614                 this.isPrivate = true;
615             }
616             
617             // @ignore
618             if (this.comment.getTag("ignore").length) {
619                 this.isIgnored = true;
620             }
621             
622             /*~t
623                 // todo
624             */
625             
626             // @inherits ... as ...
627             var inherits = this.comment.getTag("inherits");
628             if (inherits.length) {
629                 for (var i = 0; i < inherits.length; i++) {
630                     if (/^\s*([a-z$0-9_.#-]+)(?:\s+as\s+([a-z$0-9_.#]+))?/i.test(inherits[i].desc)) {
631                         var inAlias = RegExp.$1;
632                         var inAs = RegExp.$2 || inAlias;
633
634                         if (inAlias) inAlias = inAlias.replace(/\.prototype\.?/g, "#");
635                         
636                         if (inAs) {
637                             inAs = inAs.replace(/\.prototype\.?/g, "#");
638                             inAs = inAs.replace(/^this\.?/, "#");
639                         }
640
641                         if (inAs.indexOf(inAlias) != 0) { //not a full namepath
642                             var joiner = ".";
643                             if (this.alias.charAt(this.alias.length-1) == "#" || inAs.charAt(0) == "#") {
644                                 joiner = "";
645                             }
646                             inAs = this.alias + joiner + inAs;
647                         }
648                     }
649                     this.inherits.push({alias: inAlias, as: inAs});
650                 }
651             }
652             
653             /*~t
654                 // todo
655             */
656
657             // @augments
658             this.augments = this.comment.getTag("augments");
659             
660             //@extends - Ext
661             if (this.comment.getTag("extends")) {   
662                 this.augments = this.comment.getTag("extends");
663             }
664             
665             
666             // @default
667             var defaults = this.comment.getTag("default");
668             if (defaults.length) {
669                 if (this.is("OBJECT")) {
670                     this.defaultValue = defaults[0].desc;
671                 }
672             }
673             
674             /*~t
675                 // todo
676             */
677             
678             // @memberOf
679             var memberOfs = this.comment.getTag("memberOf");
680             if (memberOfs.length) {
681                 this.memberOf = memberOfs[0].desc;
682                 this.memberOf = this.memberOf.replace(/\.prototype\.?/g, "#");
683                 this.name = this.name.split('.').pop();
684                 this.name = this.name.split('#').pop();
685                 this.name = this.memberOf + this.name;
686                 this._name = this.name
687                 this.alias = this.name;
688             }
689
690             /*~t
691                 // todo
692             */
693             
694             // @public
695             if (this.comment.getTag("public").length) {
696                 this.isPrivate = false;
697             }
698             
699             /*~t
700                 // todo
701             */
702         },
703
704         is : function(what) {
705             return this.isa === what;
706         },
707
708         isBuiltin : function() {
709             return SymbolSet.isBuiltin(this.alias);
710         },
711
712         setType : function(/**String*/comment, /**Boolean*/overwrite) {
713             if (!overwrite && this.type) return;
714             var typeComment = DocComment.unwrapComment(comment);
715             this.type = typeComment;
716         },
717
718         inherit : function(symbol) {
719             if (!this.hasMember(symbol.name) && !symbol.isInner) {
720                 if (symbol.is("FUNCTION"))
721                     this.methods.push(symbol);
722                 else if (symbol.is("OBJECT"))
723                     this.properties.push(symbol);
724             }
725         },
726
727         hasMember : function(name) {
728             return (this.hasMethod(name) || this.hasProperty(name));
729         },
730
731         addMember : function(symbol) {
732             //println("ADDMEMBER: " + this.name +  " ++ " + symbol.name);
733             
734             if (symbol.comment.getTag("cfg").length == 1) { 
735                 symbol.comment.getTag("cfg")[0].memberOf = this.alias;
736                 this.addConfig(symbol.comment.getTag("cfg")[0]);
737                 return;
738             }
739             
740             if (symbol.is("FUNCTION")) { this.addMethod(symbol); }
741             else if (symbol.is("OBJECT")) { this.addProperty(symbol); }
742         },
743
744         hasMethod : function(name) {
745             var thisMethods = this.methods;
746             for (var i = 0, l = thisMethods.length; i < l; i++) {
747                 if (thisMethods[i].name == name) return true;
748                 if (thisMethods[i].alias == name) return true;
749             }
750             return false;
751         },
752
753         addMethod : function(symbol) {
754             var methodAlias = symbol.alias;
755             var thisMethods = this.methods;
756             for (var i = 0, l = thisMethods.length; i < l; i++) {
757                 if (thisMethods[i].alias == methodAlias) {
758                     thisMethods[i] = symbol; // overwriting previous method
759                     return;
760                 }
761             }
762             thisMethods.push(symbol); // new method with this alias
763         },
764
765         hasProperty : function(name) {
766             var thisProperties = this.properties;
767             for (var i = 0, l = thisProperties.length; i < l; i++) {
768                 if (thisProperties[i].name == name) return true;
769                 if (thisProperties[i].alias == name) return true;
770             }
771             return false;
772         },
773
774         addProperty : function(symbol) {
775             var propertyAlias = symbol.alias;
776             var thisProperties = this.properties;
777             for (var i = 0, l = thisProperties.length; i < l; i++) {
778                 if (thisProperties[i].alias == propertyAlias) {
779                     thisProperties[i] = symbol; // overwriting previous property
780                     return;
781                 }
782             }
783
784             thisProperties.push(symbol); // new property with this alias
785         },
786         
787         addDocTag : function(docTag)
788         {
789             this.comment.tags.push(docTag);
790             if (docTag.title == 'cfg') {
791                 this.addConfig(docTag);
792             }
793             
794         },
795         
796         addConfig : function(docTag)
797         {
798             if (typeof(docTag['memberOf']) == 'undefined') {
799                 // remove prototype data...
800                 //var a = this.alias.split('#')[0];
801                 //docTag.memberOf = a;
802                 docTag.memberOf = this.alias;
803             }
804             if (typeof(this.cfgs[docTag.name]) == 'undefined') {
805                 this.cfgs[docTag.name] = docTag;
806             }
807             
808         },
809         configToArray: function()
810         {
811             var r = [];
812             for(var ci in this.cfgs) {
813                 // dont show hidden!!
814                 if (this.cfgs[ci].desc.match(/@hide/)) {
815                     continue;
816                 }
817                 r.push(this.cfgs[ci]); 
818                
819             }
820             return r;
821         }
822 });
823
824 /**
825  * Elements that are not serialized
826  * 
827  */
828 Symbol.hide = [ 
829     '$args' // not needed AFAIK
830 ]
831
832 Symbol.srcFile = ""; //running reference to the current file being parsed
833
834
835 Symbol.fromDump = function(t)
836 {
837     var ns = new Symbol();
838     for (var i in t) {
839         if (typeof(ns[i]) == "undefined") {
840             println("ERR:no default for Symbol:"+ i);
841         }
842         ns[i] = t[i];
843     }
844     return ns;
845 }