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