JSDOC/ScopeParser.js
[gnome.introspection-doc-generator] / JSDOC / ScopeParser.js
1 //<Script type="text/javascript">
2
3 Scope = imports['JSDOC/Scope.js'].Scope;
4
5 /**
6 * Scope stuff
7
8 * // FIXME - I need this to do next() without doccomments..
9 */
10
11 ScopeParser = function(ts) {
12     this.ts = ts; // {TokenStream}
13     this.warnings = [];
14     this.scopes = [];
15     this.indexedScopes = {};
16     this.timer = new Date() * 1;
17     this.debug = false;
18 }
19
20 // list of keywords that should not be used in object literals.
21 ScopeParser.idents = [
22         "break",         
23         "case",          
24         "continue",     
25         "default",      
26         "delete",       
27         "do",            
28         "else",         
29         "export",       
30         "false",        
31         "for",          
32         "function",     
33         "if",           
34         "import",       
35         "in",           
36         "new",          
37         "null",         
38         "return",       
39         "switch",       
40         "this",         
41         "true",         
42         "typeof",       
43         "var",          
44         "void",         
45         "while",        
46         "with",         
47
48         "catch",        
49         "class",        
50         "const",        
51         "debugger",     
52         "enum",         
53         "extends",      
54         "finally",      
55         "super",        
56         "throw",         
57         "try",          
58
59         "abstract",     
60         "boolean",      
61         "byte",         
62         "char",         
63         "double",       
64         "final",        
65         "float",        
66         "goto",         
67         "implements", 
68         "instanceof",
69         "int",           
70         "interface",     
71         "long",          
72         "native",       
73         "package",      
74         "private",      
75         "protected",     
76         "public",        
77         "short",        
78         "static",       
79         "synchronized",  
80         "throws",        
81         "transient",     
82                 "include",       
83                 "undefined"
84 ];
85
86
87 ScopeParser.prototype = {
88     timer: 0,
89     timerPrint: function (str) {
90         var ntime = new Date() * 1;
91         var tdif =  ntime -this.timer;
92         this.timer = ntime;
93         var pref = '';
94         if (tdif > 100) { //slower ones..
95             pref = '***';
96         }
97         println(pref+'['+tdif+']'+str);
98         
99     },
100     warn: function(s) {
101         //print('****************' + s);
102         this.warnings.push(s);
103         //println("WARNING:" + htmlescape(s) + "<BR>");
104     },
105     // defaults should not be initialized here =- otherwise they get duped on new, rather than initalized..
106     warnings : false,
107     ts : false,
108     scopes : false,
109     global : false,
110     mode : "", //"BUILDING_SYMBOL_TREE",
111     braceNesting : 0,
112     indexedScopes : false,
113     munge: true,
114
115
116
117
118
119     buildSymbolTree : function()
120     {
121         //println("<PRE>");
122         
123         this.ts.rewind();
124         this.braceNesting = 0;
125         this.scopes = [];
126         
127         
128         
129         
130         this.globalScope = new  Scope(-1, false, -1, '');
131         indexedScopes = { 0 : this.globalScope };
132         
133         this.mode = 'BUILDING_SYMBOL_TREE';
134         this.parseScope(this.globalScope);
135         
136         //print("---------------END PASS 1 ---------------- ");
137         
138     },
139     mungeSymboltree : function()
140     {
141
142         if (!this.munge) {
143             return;
144         }
145
146         // One problem with obfuscation resides in the use of undeclared
147         // and un-namespaced global symbols that are 3 characters or less
148         // in length. Here is an example:
149         //
150         //     var declaredGlobalVar;
151         //
152         //     function declaredGlobalFn() {
153         //         var localvar;
154         //         localvar = abc; // abc is an undeclared global symbol
155         //     }
156         //
157         // In the example above, there is a slim chance that localvar may be
158         // munged to 'abc', conflicting with the undeclared global symbol
159         // abc, creating a potential bug. The following code detects such
160         // global symbols. This must be done AFTER the entire file has been
161         // parsed, and BEFORE munging the symbol tree. Note that declaring
162         // extra symbols in the global scope won't hurt.
163         //
164         // Note: Since we go through all the tokens to do this, we also use
165         // the opportunity to count how many times each identifier is used.
166
167         this.ts.rewind();
168         this.braceNesting = 0;
169         this.scopes= [];
170         this.mode = 'PASS2_SYMBOL_TREE';
171         
172         //println("MUNGING?");
173         
174         this.parseScope(this.globalScope);
175         this.globalScope.munge();
176     },
177
178
179     log : function(str)
180     {
181         print ("                    ".substring(0, this.braceNesting*2) + str);
182         
183         //println("<B>LOG:</B>" + htmlescape(str) + "<BR/>\n");
184     },
185     logR : function(str)
186     {
187             //println("<B>LOG:</B>" + str + "<BR/>");
188     },
189
190     
191     dumpLine : false,
192     dumpToken: function (tok, scope, brace) {
193         if (this.dumpLine == false) {
194             this.dumpLine = {
195                 str : '' +tok.data,
196                 scope : scope.length,
197                 brace : brace
198             }
199             return;
200         }
201         
202         if (this.dumpLine.scope == scope.length && this.dumpLine.brace == brace) {
203             this.dumpLine.str += ' ' + tok.data;
204             if (this.dumpLine.str.length > 80 || tok.data ==';') {
205                 
206                 print(
207                 //    (new Array(this.dumpLine.scope)).join("  ") + '|' + 
208                     (new Array(this.dumpLine.brace+1)).join("  ") + this.dumpLine.str);
209                 this.dumpLine.str = '';
210             }
211             return;
212         }
213         
214         print(
215           //  (new Array(this.dumpLine.scope)).join("  ") + '|' + 
216             (new Array(this.dumpLine.brace+1)).join("  ") + this.dumpLine.str); 
217         
218         
219         this.dumpLine = {
220             str : '' +tok.data,
221             scope : scope.length,
222             brace : brace
223         }
224         
225     },
226
227
228
229     parseScope : function(scope) // parse a token stream..
230     {
231         //this.timerPrint("parseScope EnterScope"); 
232         //this.log(">>> ENTER SCOPE" + this.scopes.length);
233         var symbol;
234         var token;
235         
236         var identifier;
237
238         var expressionBraceNesting = this.braceNesting + 0;
239         
240         var parensNesting = 0;
241         
242         var isObjectLitAr = [ false ];
243         var isInObjectLitAr;
244         this.scopes.push(scope);
245        
246         var scopeIndent = ''; 
247         this.scopes.forEach(function() {
248             scopeIndent += '   '; 
249         });
250         print(scopeIndent + ">> ENTER SCOPE");
251         
252         
253         
254         
255         token = this.ts.lookTok(1);
256         while (token) {
257           //  this.timerPrint("parseScope AFTER lookT: " + token.toString()); 
258             this.dumpToken(token , this.scopes, this.braceNesting);
259             //this.log(token.data);
260             if (token.type == 'NAME') {
261             //    print('*' + token.data);
262             }
263             switch(token.type + '.' + token.name) {
264                 case "KEYW.VAR":
265                 case "KEYW.CONST": // not really relivant as it's only mozzy that does this.
266                     
267                     //this.log("parseScope GOT VAR/CONST : " + token.toString()); 
268                     while (true) {
269                         token = this.ts.nextTok();
270                         !this.debug|| print( token.toString());
271                       
272                         if (!token) { // can return false at EOF!
273                             break;
274                         }
275                         if (token.name == "VAR" || token.data == ',') { // kludge..
276                             continue;
277                         }
278                         //this.logR("parseScope GOT VAR  : <B>" + token.toString() + "</B>"); 
279                         if (token.type !="NAME") {
280                             for(var i = Math.max(this.ts.cursor-10,0); i < this.ts.cursor+1; i++) {
281                                 print(this.ts.tokens[i].toString());
282                             }
283                             
284                             print( "var without ident");
285                             Seed.quit()
286                         }
287                         
288
289                         if (this.mode == "BUILDING_SYMBOL_TREE") {
290                             identifier = scope.getIdentifier(token.data) ;
291                             
292                             if (identifier == false) {
293                                 scope.declareIdentifier(token.data, token);
294                             } else {
295                                 token.identifier = identifier;
296                                 this.warn("(SCOPE) The variable " + token.data  + ' (line:' + token.line + ")  has already been declared in the same scope...");
297                             }
298                         }
299
300                         token = this.ts.nextTok();
301                         !this.debug|| print(token.toString());
302                         /*
303                         assert token.getType() == Token.SEMI ||
304                                 token.getType() == Token.ASSIGN ||
305                                 token.getType() == Token.COMMA ||
306                                 token.getType() == Token.IN;
307                         */
308                         if (token.name == "IN") {
309                             break;
310                         } else {
311                             //var bn = this.braceNesting;
312                             this.parseExpression();
313                             //this.braceNesting = bn;
314                             //this.logR("parseScope DONE  : <B>ParseExpression</B> - tok is:" + this.ts.lookT(0).toString()); 
315                             
316                             token = this.ts.lookTok(1);
317                             !this.debug|| print("AFTER EXP: " + token.toString());
318                             if (token.data == ';') {
319                                 break;
320                             }
321                         }
322                     }
323                     break;
324                 case "KEYW.FUNCTION":
325                     //println("<i>"+token.data+"</i>");
326                      var bn = this.braceNesting;
327                     this.parseFunctionDeclaration();
328                      this.braceNesting = bn;
329                     break;
330
331                 case "PUNC.LEFT_CURLY": // {
332                     //println("<i>"+token.data+"</i>");
333                     isObjectLitAr.push(false);
334                     this.braceNesting++;
335                     
336                     //print(">>>>>> OBJLIT PUSH(false)" + this.braceNesting);
337                     break;
338
339                 case "PUNC.RIGHT_CURLY": // }
340                     //println("<i>"+token.data+"</i>");
341                     this.braceNesting--;
342                     isObjectLitAr.pop();
343                     //print(">>>>>> OBJLIT POP"+ this.braceNesting);
344                         //assert braceNesting >= scope.getBra ceNesting();
345                     
346                     if (this.braceNesting < expressionBraceNesting) {
347                         var ls = this.scopes.pop();
348                         ls.getUsedSymbols();
349                         // eat symbol if we are currently at { 
350                         if (this.ts.look(0).data == '{') {
351                             this.ts.nextTok();
352                         }
353                         
354                         //print("<<<<<<<EXIT SCOPE" +this.scopes.length);
355                         return;
356                     }
357                     break;
358
359                 case "KEYW.WITH":
360                     //println("<i>"+token.data+"</i>");   
361                     if (this.mode == "BUILDING_SYMBOL_TREE") {
362                         // Inside a 'with' block, it is impossible to figure out
363                         // statically whether a symbol is a local variable or an
364                         // object member. As a consequence, the only thing we can
365                         // do is turn the obfuscation off for the highest scope
366                         // containing the 'with' block.
367                         this.protectScopeFromObfuscation(scope);
368                         this.warn("Using 'with' is not recommended." + (this.munge ? " Moreover, using 'with' reduces the level of compression!" : ""), true);
369                     }
370                     break;
371
372                 case "KEYW.CATCH":
373                     //println("<i>"+token.data+"</i>");
374                     this.parseCatch();
375                     break;
376                 /*
377                 case Token.SPECIALCOMMENT:
378                         if (mode == BUILDING_SYMBOL_TREE) {
379                             protectScopeFromObfuscation(scope);
380                             this.warn("Using JScript conditional comments is not recommended." + (munge ? " Moreover, using JScript conditional comments reduces the level of compression." : ""), true);
381                         }
382                         break;
383                 */
384                 
385                 case "STRN.DOUBLE_QUOTE": // used for object lit detection..
386                 case "STRN.SINGLE_QUOTE":
387                     //println("<i>"+token.data+"</i>");
388                     if (this.ts.lookTok(-1).data == '{' && this.ts.lookTok(1).data == ':') {
389                         // then we are in an object lit.. -> we need to flag the brace as such...
390                         isObjectLitAr.pop();
391                         isObjectLitAr.push(true);
392                         //print(">>>>>> OBJLIT REPUSH(true)");
393                     }
394                     isInObjectLitAr = isObjectLitAr[isObjectLitAr.length-1];
395                     
396                     if (isInObjectLitAr &&  this.ts.lookTok(1).data == ':' &&
397                         ( this.ts.lookTok(-1).data == '{'  ||  this.ts.lookTok(-1).data == ':' )) {
398                         // see if we can replace..
399                         // remove the quotes..
400                         // should do a bit more checking!!!! (what about wierd char's in the string..
401                         var str = token.data.substring(1,token.data.length-1);
402                         if (/^[a-z_]+$/i.test(str) && ScopeParser.idents.indexOf(str) < 0) {
403                             token.outData = str;
404                         }
405                         
406                          
407                         
408                     }
409                     
410                     
411                     
412                     break;
413                 
414                 case "NAME.NAME":
415                 
416                     //print("DEAL WITH NAME:");
417                     // got identifier..
418                     
419                     // look for  { ** : <- indicates obj literal.. ** this could occur with numbers ..
420                     if ((this.ts.lookTok(-1).data == "{") && (this.ts.lookTok(1).data == ":")) {
421                         isObjectLitAr.pop();
422                         isObjectLitAr.push(true);
423                         //print(">>>>>> OBJLIT REPUSH(true)");
424                         //println("<i>"+token.data+"</i>");
425                         break;
426                     }
427                    // print("DEAL WITH obj lit:");
428                     isInObjectLitAr = isObjectLitAr[isObjectLitAr.length-1];
429                     
430                     if (isInObjectLitAr && (this.ts.lookTok(1).data == ":") && (this.ts.lookTok(-1).data == ",")) {
431                         // skip, it's an object lit key..
432                         //println("<i>"+token.data+"</i>");
433                         break;
434                     }
435                     
436                     
437                     // skip anyting with "." before it..!!
438                      
439                     if (this.ts.lookTok(-1).data == ".") {
440                         // skip, it's an object prop.
441                         //println("<i>"+token.data+"</i>");
442                         break;
443                     }
444                     symbol = token.data;
445                     if (this.mode == 'PASS2_SYMBOL_TREE') {
446                         
447                         //println("GOT IDENT: -2 : " + this.ts.lookT(-2).toString() + " <BR> ..... -1 :  " +  this.ts.lookT(-1).toString() + " <BR> "); 
448                         
449                         //print ("MUNGE?" + symbol);
450                         
451                         //println("GOT IDENT: <B>" + symbol + "</B><BR/>");
452                              
453                             //println("GOT IDENT (2): <B>" + symbol + "</B><BR/>");
454                         identifier = this.getIdentifier(symbol, scope);
455                         
456                         if (identifier == false) {
457 // BUG!find out where builtin is defined...
458                             if (symbol.length <= 3 &&  Scope.builtin.indexOf(symbol) < 0) {
459                                 // Here, we found an undeclared and un-namespaced symbol that is
460                                 // 3 characters or less in length. Declare it in the global scope.
461                                 // We don't need to declare longer symbols since they won't cause
462                                 // any conflict with other munged symbols.
463                                 this.globalScope.declareIdentifier(symbol, token);
464                                 this.warn("Found an undeclared symbol: " + symbol + ' (line:' + token.line + ')', true);
465                             }
466                             
467                             //println("GOT IDENT IGNORE(3): <B>" + symbol + "</B><BR/>");
468                         } else {
469                             token.identifier = identifier;
470                             identifier.refcount++;
471                         }
472                     }   
473                     
474                     break;
475                     //println("<B>SID</B>");
476                 default:
477                     if (token.type != 'KEYW') {
478                         break;
479                     }
480                    // print("Check eval:");
481                 
482                     symbol = token.data;
483                     
484                      if (this.mode == 'BUILDING_SYMBOL_TREE') {
485
486                         if (symbol == "eval") {
487                             // look back one and see if we can find a comment!!!
488                             if (this.ts.look(-1).type == "COMM") {
489                                 // look for eval:var:noreplace\n
490                                 var _t = this;
491                                 this.ts.look(-1).data.replace(/eval:var:([a-z_]+)/ig, function(m, a) {
492                                     
493                                     var hi = _t.getIdentifier(a, scope);
494                                    // println("PROTECT "+a+" from munge" + (hi ? "FOUND" : "MISSING"));
495                                     if (hi) {
496                                      //   println("PROTECT "+a+" from munge");
497                                         hi.toMunge = false;
498                                     }
499                                     
500                                 });
501                                 
502                                 
503                             } else {
504                                 
505                             
506                                 this.protectScopeFromObfuscation(scope);
507                                 this.warn("Using 'eval' is not recommended. (use  eval:var:noreplace in comments to optimize) " + (this.munge ? " Moreover, using 'eval' reduces the level of compression!" : ""), true);
508                             }
509
510                         }
511
512                     }
513                     break;
514                 
515                 
516             } // end switch
517             
518             
519             //this.timerPrint("parseScope TOK : " + token.toString()); 
520             token = this.ts.nextTok();
521             //if (this.ts.nextT()) break;
522             
523         }
524         //print("<<<<<<<EXIT SCOPE ERR?" +this.scopes.length);
525     },
526
527
528     parseExpression : function() {
529
530         // Parse the expression until we encounter a comma or a semi-colon
531         // in the same brace nesting, bracket nesting and paren nesting.
532         // Parse functions if any...
533         //println("<i>EXP</i><BR/>");
534         !this.debug || print("PARSE EXPR");
535        
536          
537         // for printing stuff..
538        
539         
540         
541         var symbol;
542         var token;
543         var currentScope;
544         var identifier;
545
546         var expressionBraceNesting = this.braceNesting;
547         var bracketNesting = 0;
548         var parensNesting = 0;
549         var isInObjectLitAr;
550         var isObjectLitAr = [ false ];
551         
552         currentScope = this.scopes[this.scopes.length-1];
553             
554         var scopeIndent = ''; 
555         this.scopes.forEach(function() {
556             scopeIndent += '   '; 
557         });
558         print(scopeIndent + ">> ENTER EXPRESSION");
559         while (token = this.ts.lookTok()) {
560      
561
562             
563            /*
564             // moved out of loop?
565            currentScope = this.scopes[this.scopes.length-1];
566             
567             var scopeIndent = ''; 
568             this.scopes.forEach(function() {
569                 scopeIndent += '   '; 
570             });
571            */ 
572            
573            this.dumpToken(token,  this.scopes, this.braceNesting );
574             
575             
576             //println("<i>"+token.data+"</i>");
577             //this.log("EXP:" + token.data);
578             switch (token.type) {
579                 case 'PUNC':
580                     switch(token.data) {
581                          
582                         case ';':
583                         case ',':
584                             if (this.braceNesting == expressionBraceNesting &&
585                                     bracketNesting == 0 &&
586                                     parensNesting == 0) {
587                                 print(scopeIndent + "<< EXIT EXPRESSION");
588                                 return;
589                             }
590                             break;
591
592                        
593
594                         case '{': //Token.LC:
595                             isObjectLitAr.push(false);
596                             
597                             this.braceNesting++;
598                             ///print(">>>>> EXP PUSH(false)"+this.braceNesting);
599                             break;
600
601                         case '}': //Token.RC:
602                             this.braceNesting--;
603                             isObjectLitAr.pop();
604                             //print(">>>>> EXP POP" + this.braceNesting);    
605                            // assert braceNesting >= expressionBraceNesting;
606                             break;
607
608                         case '[': //Token.LB:
609                             bracketNesting++;
610                             break;
611
612                         case ']': //Token.RB:
613                             bracketNesting--;
614                             break;
615
616                         case '(': //Token.LP:
617                             parensNesting++;
618                             break;
619
620                         case ')': //Token.RP:
621                             parensNesting--;
622                             break;
623                     }
624                     break;
625                     
626                 case 'STRN': // used for object lit detection..
627                     if (this.ts.lookTok(-1).data == "{" && this.ts.lookTok(1).data == ":" ) {
628                         // then we are in an object lit.. -> we need to flag the brace as such...
629                         isObjectLitAr.pop();
630                         isObjectLitAr.push(true);
631                         //print(">>>>> EXP PUSH(true)");
632                     }
633                     
634                     
635                      
636                     isInObjectLitAr = isObjectLitAr[isObjectLitAr.length-1];
637                     if (isInObjectLitAr &&  this.ts.lookTok(1).data == ":"  &&
638                         ( this.ts.lookTok(-1).data == "{"  ||  this.ts.lookTok(-1).data == "," )) {
639                         // see if we can replace..
640                         // remove the quotes..
641                         var str = token.data.substring(1,token.data.length-1);
642                         if (/^[a-z_]+$/i.test(str) && ScopeParser.idents.indexOf(str) < 0) {
643                             token.outData = str;
644                         }
645                         
646                          
647                         
648                     }
649                     
650                     break;
651                 
652                       
653              
654                 case 'NAME':
655                
656                     symbol = token.data;
657                     //print("in NAME = " + token.toString());
658                     //print("in NAME 0: " + this.ts.look(0).toString());
659                     //print("in NAME 2: " + this.ts.lookTok(2).toString());
660                     if (this.ts.look(0).data == "{"  && this.ts.lookTok(2).data == ":") {
661                         // then we are in an object lit.. -> we need to flag the brace as such...
662                         isObjectLitAr.pop();
663                         isObjectLitAr.push(true);
664                          //print(">>>>> EXP  PUSH(true)");
665                         break;
666                     }
667                     
668                     isInObjectLitAr = isObjectLitAr[isObjectLitAr.length-1];
669                     //print ("isInObjectLitAr : " + isInObjectLitAr + ' ' + token.toString());
670                     
671                     if (isInObjectLitAr && this.ts.lookTok(0).data == "," && this.ts.lookTok(2).data == ":") {
672                         break;
673                     }
674                     //print(this.ts.lookTok(0).data);
675                     if (this.ts.lookTok(0).data == ".") {
676                         //skip '.'
677                         break;
678                     }
679                     
680                      if (this.mode == 'PASS2_SYMBOL_TREE') {
681
682                         identifier = this.getIdentifier(symbol, currentScope);
683                         //println("<B>??</B>");
684                         if (identifier == false) {
685
686                             if (symbol.length <= 3 &&  Scope.builtin.indexOf(symbol) < 0) {
687                                 // Here, we found an undeclared and un-namespaced symbol that is
688                                 // 3 characters or less in length. Declare it in the global scope.
689                                 // We don't need to declare longer symbols since they won't cause
690                                 // any conflict with other munged symbols.
691                                 this.globalScope.declareIdentifier(symbol, token);
692                                 this.warn("Found an undeclared symbol: " + symbol + ' (line:' + token.line + ')', true);
693                             } else {
694                                 //println("undeclared")
695                             }
696                             
697                             
698                         } else {
699                             //println("<B>++</B>");
700                             token.identifier = identifier;
701                             identifier.refcount++;
702                         }
703                         
704                     }
705                     break;
706                     
707                     
708                     
709                     
710                     //println("<B>EID</B>");
711                  case 'KEYW':   
712                  
713                     if (token.name == "FUNCTION") {
714                         
715                         this.parseFunctionDeclaration();
716                         break;
717                     }
718                
719                     
720              
721                     symbol = token.data;
722                     if (this.mode == 'BUILDING_SYMBOL_TREE') {
723
724                         if (symbol == "eval") {
725                             if (this.ts.look(-1).type == 'COMM') {
726                                 // look for eval:var:noreplace\n
727                                 var _t = this;
728                                 this.ts.look(-1).data.replace(/eval:var:([a-z]+)/ig, function(m, a) {
729                                     var hi = _t.getIdentifier(a, currentScope);
730                                    //println("PROTECT "+a+" from munge" + (hi ? "FOUND" : "MISSING"));
731                                     if (hi) {
732                                       //  println("PROTECT "+a+" from munge");
733                                         hi.toMunge = false;
734                                     }
735                                     
736                                     
737                                 });
738                                 
739                             } else {
740                                 this.protectScopeFromObfuscation(currentScope);
741                                 this.warn("Using 'eval' is not recommended." + (this.munge ? " Moreover, using 'eval' reduces the level of compression!" : ""), true);
742                             }
743                             
744
745                         }
746                         break;
747                     } 
748                    
749             }
750             if (!this.ts.nextTok()) break;
751         }
752         print(scopeIndent + "<< EXIT EXPRESSION");
753     },
754
755
756     parseCatch : function() {
757
758         var symbol;
759         var token;
760         var currentScope;
761         var identifier;
762
763         //token = getToken(-1);
764         //assert token.getType() == Token.CATCH;
765         token = this.ts.nextTok();
766         //assert token.getType() == Token.LP; (
767         token = this.ts.nextTok();
768         //assert token.getType() == Token.NAME;
769         
770         symbol = token.data;
771         currentScope = this.scopes[this.scopes.length-1];
772
773         if (this.mode == 'BUILDING_SYMBOL_TREE') {
774             // We must declare the exception identifier in the containing function
775             // scope to avoid errors related to the obfuscation process. No need to
776             // display a warning if the symbol was already declared here...
777             currentScope.declareIdentifier(symbol, token);
778         } else {
779             //?? why inc the refcount?? - that should be set when building the tree???
780             identifier = this.getIdentifier(symbol, currentScope);
781             identifier.refcount++;
782         }
783
784         token = this.ts.nextTok();
785         //assert token.getType() == Token.RP; // )
786     },
787     
788     parseFunctionDeclaration : function() 
789     {
790         print("PARSE FUNCTION");
791         var symbol;
792         var token;
793         var currentScope  = false; 
794         var fnScope = false;
795         var identifier;
796         //this.logR("<B>PARSING FUNCTION</B>");
797         currentScope = this.scopes[this.scopes.length-1];
798
799         token = this.ts.nextTok();
800         if (token.type == "NAME") {
801             if (this.mode == 'BUILDING_SYMBOL_TREE') {
802                 // Get the name of the function and declare it in the current scope.
803                 symbol = token.data;
804                 if (currentScope.getIdentifier(symbol) != false) {
805                     this.warn("The function " + symbol + " has already been declared in the same scope...", true);
806                 }
807                 currentScope.declareIdentifier(symbol,token);
808             }
809             token =  this.ts.nextTok();
810         }
811
812         //assert token.getType() == Token.LP;
813         if (this.mode == 'BUILDING_SYMBOL_TREE') {
814             fnScope = new Scope(this.braceNesting, currentScope, token.n, '');
815             
816             //println("STORING SCOPE" + this.ts.cursor);
817             
818             this.indexedScopes[this.ts.cursor] = fnScope;
819             
820         } else {
821             //qln("FETCHING SCOPE" + this.ts.cursor);
822             fnScope = this.indexedScopes[this.ts.cursor];
823           
824         }
825         
826         // Parse function arguments.
827         var argpos = 0;
828         while (this.ts.lookTok().data != ')') { //(token = consumeToken()).getType() != Token.RP) {
829             token = this.ts.nextTok();
830            // print ("FUNC ARGS: " + token.toString())
831             //assert token.getType() == Token.NAME ||
832             //        token.getType() == Token.COMMA;
833             if (token.type == 'NAME' && this.mode == 'BUILDING_SYMBOL_TREE') {
834                 symbol = token.data;
835                 identifier = fnScope.declareIdentifier(symbol,token);
836                 if (symbol == "$super" && argpos == 0) {
837                     // Exception for Prototype 1.6...
838                     identifier.preventMunging();
839                 }
840                 argpos++;
841             }
842         }
843
844         token = this.ts.nextTok();
845         print(token.toString());
846         // assert token.getType() == Token.LC;
847         this.braceNesting++;
848
849         token = this.ts.nextTok();
850         print(token.toString());
851         if (token.type == "STRN" && this.ts.lookTok(1).data == ';') {
852             /*
853             
854             NOT SUPPORTED YET!?!!?!
855             
856             // This is a hint. Hints are empty statements that look like
857             // "localvar1:nomunge, localvar2:nomunge"; They allow developers
858             // to prevent specific symbols from getting obfuscated (some heretic
859             // implementations, such as Prototype 1.6, require specific variable
860             // names, such as $super for example, in order to work appropriately.
861             // Note: right now, only "nomunge" is supported in the right hand side
862             // of a hint. However, in the future, the right hand side may contain
863             // other values.
864             consumeToken();
865             String hints = token.getValue();
866             // Remove the leading and trailing quotes...
867             hints = hints.substring(1, hints.length() - 1).trim();
868             StringTokenizer st1 = new StringTokenizer(hints, ",");
869             while (st1.hasMoreTokens()) {
870                 String hint = st1.nextToken();
871                 int idx = hint.indexOf(':');
872                 if (idx <= 0 || idx >= hint.length() - 1) {
873                     if (mode == BUILDING_SYMBOL_TREE) {
874                         // No need to report the error twice, hence the test...
875                         this.warn("Invalid hint syntax: " + hint, true);
876                     }
877                     break;
878                 }
879                 String variableName = hint.substring(0, idx).trim();
880                 String variableType = hint.substring(idx + 1).trim();
881                 if (mode == BUILDING_SYMBOL_TREE) {
882                     fnScope.addHint(variableName, variableType);
883                 } else if (mode == CHECKING_SYMBOL_TREE) {
884                     identifier = fnScope.getIdentifier(variableName);
885                     if (identifier != null) {
886                         if (variableType.equals("nomunge")) {
887                             identifier.preventMunging();
888                         } else {
889                             this.warn("Unsupported hint value: " + hint, true);
890                         }
891                     } else {
892                         this.warn("Hint refers to an unknown identifier: " + hint, true);
893                     }
894                 }
895             }
896             */
897         }
898
899         this.parseScope(fnScope);
900         // now pop it off the stack!!!
901        
902         this.braceNesting--;
903         
904     },
905     
906     protectScopeFromObfuscation : function(scope) {
907             //assert scope != null;
908         
909         if (scope == this.globalScope) {
910             // The global scope does not get obfuscated,
911             // so we don't need to worry about it...
912             return;
913         }
914
915         // Find the highest local scope containing the specified scope.
916         while (scope && scope.parent != this.globalScope) {
917             scope = scope.parent;
918         }
919
920         //assert scope.getParentScope() == globalScope;
921         scope.preventMunging();
922     },
923     
924     getIdentifier: function(symbol, scope) {
925         var identifier;
926         while (scope != false) {
927             identifier = scope.getIdentifier(symbol);
928             //println("ScopeParser.getIdentgetUsedSymbols("+symbol+")=" + scope.getUsedSymbols().join(','));
929             if (identifier) {
930                 return identifier;
931             }
932             scope = scope.parent;
933         }
934         return false;
935     }
936 };