1 //<Script type="text/javascript">
3 Scope = imports['JSDOC/Scope.js'].Scope;
8 * // FIXME - I need this to do next() without doccomments..
12 * Need to make this alot simpler...
14 * so debugging is possible.
17 * at present it just runs along the stream and finds stuff then calls parseExpr .. etc,,
20 * It would be better to parse blocks of code rather than the whole stream..
28 ScopeParser = function(ts) {
29 this.ts = ts; // {TokenStream}
32 this.indexedScopes = {};
33 this.timer = new Date() * 1;
37 // list of keywords that should not be used in object literals.
38 ScopeParser.idents = [
104 ScopeParser.prototype = {
106 timerPrint: function (str) {
107 var ntime = new Date() * 1;
108 var tdif = ntime -this.timer;
111 if (tdif > 100) { //slower ones..
114 println(pref+'['+tdif+']'+str);
118 //print('****************' + s);
119 this.warnings.push(s);
120 //println("WARNING:" + htmlescape(s) + "<BR>");
122 // defaults should not be initialized here =- otherwise they get duped on new, rather than initalized..
127 mode : "", //"BUILDING_SYMBOL_TREE",
129 indexedScopes : false,
136 buildSymbolTree : function()
141 this.braceNesting = 0;
147 this.globalScope = new Scope(-1, false, -1, '');
148 indexedScopes = { 0 : this.globalScope };
150 this.mode = 'BUILDING_SYMBOL_TREE';
151 this.parseScope(this.globalScope);
153 //print("---------------END PASS 1 ---------------- ");
156 mungeSymboltree : function()
163 // One problem with obfuscation resides in the use of undeclared
164 // and un-namespaced global symbols that are 3 characters or less
165 // in length. Here is an example:
167 // var declaredGlobalVar;
169 // function declaredGlobalFn() {
171 // localvar = abc; // abc is an undeclared global symbol
174 // In the example above, there is a slim chance that localvar may be
175 // munged to 'abc', conflicting with the undeclared global symbol
176 // abc, creating a potential bug. The following code detects such
177 // global symbols. This must be done AFTER the entire file has been
178 // parsed, and BEFORE munging the symbol tree. Note that declaring
179 // extra symbols in the global scope won't hurt.
181 // Note: Since we go through all the tokens to do this, we also use
182 // the opportunity to count how many times each identifier is used.
185 this.braceNesting = 0;
187 this.mode = 'PASS2_SYMBOL_TREE';
189 //println("MUNGING?");
191 this.parseScope(this.globalScope);
192 this.globalScope.munge();
198 print (" ".substring(0, this.braceNesting*2) + str);
200 //println("<B>LOG:</B>" + htmlescape(str) + "<BR/>\n");
204 //println("<B>LOG:</B>" + str + "<BR/>");
211 parseScope : function(scope) // parse a token stream..
213 //this.timerPrint("parseScope EnterScope");
214 //this.log(">>> ENTER SCOPE" + this.scopes.length);
220 var expressionBraceNesting = this.braceNesting + 0;
222 var parensNesting = 0;
224 var isObjectLitAr = [ false ];
226 this.scopes.push(scope);
228 //var scopeIndent = '';
229 //this.scopes.forEach(function() {
230 // scopeIndent += ' ';
232 //print(scopeIndent + ">> ENTER SCOPE");
237 token = this.ts.lookTok(1);
239 // this.timerPrint("parseScope AFTER lookT: " + token.toString());
240 //this.dumpToken(token , this.scopes, this.braceNesting);
241 //print('SCOPE:' + token.toString());
242 //this.log(token.data);
243 if (token.type == 'NAME') {
244 // print('*' + token.data);
246 switch(token.type + '.' + token.name) {
248 case "KEYW.CONST": // not really relivant as it's only mozzy that does this.
249 print('SCOPE-VAR:' + token.toString());
250 var vstart = this.ts.cursor +1;
252 //this.log("parseScope GOT VAR/CONST : " + token.toString());
254 token = this.ts.nextTok();
255 !this.debug|| print( token.toString());
257 if (!token) { // can return false at EOF!
260 if (token.name == "VAR" || token.data == ',') { // kludge..
263 //this.logR("parseScope GOT VAR : <B>" + token.toString() + "</B>");
264 if (token.type !="NAME") {
265 for(var i = Math.max(this.ts.cursor-10,0); i < this.ts.cursor+1; i++) {
266 print(this.ts.tokens[i].toString());
269 print( "var without ident");
274 if (this.mode == "BUILDING_SYMBOL_TREE") {
275 identifier = scope.getIdentifier(token.data) ;
277 if (identifier == false) {
278 scope.declareIdentifier(token.data, token);
280 token.identifier = identifier;
281 this.warn("(SCOPE) The variable " + token.data + ' (line:' + token.line + ") has already been declared in the same scope...");
285 token = this.ts.nextTok();
286 !this.debug|| print(token.toString());
288 assert token.getType() == Token.SEMI ||
289 token.getType() == Token.ASSIGN ||
290 token.getType() == Token.COMMA ||
291 token.getType() == Token.IN;
293 if (token.name == "IN") {
296 //var bn = this.braceNesting;
297 var bn = this.braceNesting;
298 this.parseExpression();
299 this.braceNesting = bn;
300 //this.braceNesting = bn;
301 //this.logR("parseScope DONE : <B>ParseExpression</B> - tok is:" + this.ts.lookT(0).toString());
303 token = this.ts.lookTok(1);
304 !this.debug|| print("AFTER EXP: " + token.toString());
305 if (token.data == ';') {
312 //this.ts.dump(vstart , this.ts.cursor);
315 case "KEYW.FUNCTION":
316 print('SCOPE-FUNC:' + token.toString());
317 //println("<i>"+token.data+"</i>");
318 var bn = this.braceNesting;
319 this.parseFunctionDeclaration();
320 this.braceNesting = bn;
323 case "PUNC.LEFT_CURLY": // {
324 print('SCOPE-CURLY:' + JSON.stringify(token,null,4));
325 //println("<i>"+token.data+"</i>");
328 for (var prop in token.props) {
329 if (token.props[prop].val.data == 'function') {
330 // parse a function..
331 this.parseFunctProp(token.props[prop]);
336 this.ts = new TokenStream(token.props[prop].val);
337 this.parseScope(scope);
342 // it's an object literal..
343 // the values could be replaced..
347 isObjectLitAr.push(false);
350 //print(">>>>>> OBJLIT PUSH(false)" + this.braceNesting);
353 case "PUNC.RIGHT_CURLY": // }
354 //println("<i>"+token.data+"</i>");
357 //print(">>>>>> OBJLIT POP"+ this.braceNesting);
358 //assert braceNesting >= scope.getBra ceNesting();
360 if (this.braceNesting < expressionBraceNesting) {
361 var ls = this.scopes.pop();
363 // eat symbol if we are currently at {
364 if (this.ts.look(0).data == '{') {
368 print("<<<<<<<EXIT SCOPE" +this.scopes.length);
374 print('SCOPE-WITH:' + token.toString());
375 //println("<i>"+token.data+"</i>");
376 if (this.mode == "BUILDING_SYMBOL_TREE") {
377 // Inside a 'with' block, it is impossible to figure out
378 // statically whether a symbol is a local variable or an
379 // object member. As a consequence, the only thing we can
380 // do is turn the obfuscation off for the highest scope
381 // containing the 'with' block.
382 this.protectScopeFromObfuscation(scope);
383 this.warn("Using 'with' is not recommended." + (this.munge ? " Moreover, using 'with' reduces the level of compression!" : ""), true);
388 print('SCOPE-CATCH:' + token.toString());
389 //println("<i>"+token.data+"</i>");
393 case Token.SPECIALCOMMENT:
394 if (mode == BUILDING_SYMBOL_TREE) {
395 protectScopeFromObfuscation(scope);
396 this.warn("Using JScript conditional comments is not recommended." + (munge ? " Moreover, using JScript conditional comments reduces the level of compression." : ""), true);
401 case "STRN.DOUBLE_QUOTE": // used for object lit detection..
402 case "STRN.SINGLE_QUOTE":
403 print('SCOPE-STRING:' + token.toString());
404 //println("<i>"+token.data+"</i>");
406 if (this.ts.lookTok(-1).data == '{' && this.ts.lookTok(1).data == ':') {
407 // then we are in an object lit.. -> we need to flag the brace as such...
409 isObjectLitAr.push(true);
410 //print(">>>>>> OBJLIT REPUSH(true)");
412 isInObjectLitAr = isObjectLitAr[isObjectLitAr.length-1];
414 if (isInObjectLitAr && this.ts.lookTok(1).data == ':' &&
415 ( this.ts.lookTok(-1).data == '{' || this.ts.lookTok(-1).data == ':' )) {
416 // see if we can replace..
417 // remove the quotes..
418 // should do a bit more checking!!!! (what about wierd char's in the string..
419 var str = token.data.substring(1,token.data.length-1);
420 if (/^[a-z_]+$/i.test(str) && ScopeParser.idents.indexOf(str) < 0) {
433 print('SCOPE-NAME:' + token.toString());
434 //print("DEAL WITH NAME:");
437 // look for { ** : <- indicates obj literal.. ** this could occur with numbers ..
438 if ((this.ts.lookTok(-1).data == "{") && (this.ts.lookTok(1).data == ":")) {
440 isObjectLitAr.push(true);
441 //print(">>>>>> OBJLIT REPUSH(true)");
442 //println("<i>"+token.data+"</i>");
445 // print("DEAL WITH obj lit:");
446 isInObjectLitAr = isObjectLitAr[isObjectLitAr.length-1];
448 if (isInObjectLitAr && (this.ts.lookTok(1).data == ":") && (this.ts.lookTok(-1).data == ",")) {
449 // skip, it's an object lit key..
450 //println("<i>"+token.data+"</i>");
455 // skip anyting with "." before it..!!
457 if (this.ts.lookTok(-1).data == ".") {
458 // skip, it's an object prop.
459 //println("<i>"+token.data+"</i>");
462 //print("SYMBOL: " + token.toString());
465 if (this.mode == 'PASS2_SYMBOL_TREE') {
467 //println("GOT IDENT: -2 : " + this.ts.lookT(-2).toString() + " <BR> ..... -1 : " + this.ts.lookT(-1).toString() + " <BR> ");
469 //print ("MUNGE?" + symbol);
471 //println("GOT IDENT: <B>" + symbol + "</B><BR/>");
473 //println("GOT IDENT (2): <B>" + symbol + "</B><BR/>");
474 identifier = this.getIdentifier(symbol, scope);
476 if (identifier == false) {
477 // BUG!find out where builtin is defined...
478 if (symbol.length <= 3 && Scope.builtin.indexOf(symbol) < 0) {
479 // Here, we found an undeclared and un-namespaced symbol that is
480 // 3 characters or less in length. Declare it in the global scope.
481 // We don't need to declare longer symbols since they won't cause
482 // any conflict with other munged symbols.
483 this.globalScope.declareIdentifier(symbol, token);
484 this.warn("Found an undeclared symbol: " + symbol + ' (line:' + token.line + ')', true);
487 //println("GOT IDENT IGNORE(3): <B>" + symbol + "</B><BR/>");
489 token.identifier = identifier;
490 identifier.refcount++;
495 //println("<B>SID</B>");
497 if (token.type != 'KEYW') {
500 print('SCOPE-KEYW:' + token.toString());
501 // print("Check eval:");
505 if (this.mode == 'BUILDING_SYMBOL_TREE') {
507 if (symbol == "eval") {
508 // look back one and see if we can find a comment!!!
509 if (this.ts.look(-1).type == "COMM") {
510 // look for eval:var:noreplace\n
512 this.ts.look(-1).data.replace(/eval:var:([a-z_]+)/ig, function(m, a) {
514 var hi = _t.getIdentifier(a, scope);
515 // println("PROTECT "+a+" from munge" + (hi ? "FOUND" : "MISSING"));
517 // println("PROTECT "+a+" from munge");
527 this.protectScopeFromObfuscation(scope);
528 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);
540 //print("parseScope TOK : " + token.toString());
541 token = this.ts.nextTok();
542 //if (this.ts.nextT()) break;
545 //print("<<<<<<<EXIT SCOPE ERR?" +this.scopes.length);
549 parseExpression : function() {
551 // Parse the expression until we encounter a comma or a semi-colon
552 // in the same brace nesting, bracket nesting and paren nesting.
553 // Parse functions if any...
554 //println("<i>EXP</i><BR/>");
555 !this.debug || print("PARSE EXPR");
558 // for printing stuff..
567 var expressionBraceNesting = this.braceNesting + 0;
568 var bracketNesting = 0;
569 var parensNesting = 0;
571 var isObjectLitAr = [ false ];
573 currentScope = this.scopes[this.scopes.length-1];
575 var scopeIndent = '';
576 this.scopes.forEach(function() {
579 //print(scopeIndent + ">> ENTER EXPRESSION" + this.expN);
580 while (token = this.ts.lookTok()) {
585 // moved out of loop?
586 currentScope = this.scopes[this.scopes.length-1];
588 var scopeIndent = '';
589 this.scopes.forEach(function() {
594 //this.dumpToken(token, this.scopes, this.braceNesting );
595 //print('EXP' + this.expN + ':' + token.toString());
598 //println("<i>"+token.data+"</i>");
599 //this.log("EXP:" + token.data);
600 switch (token.type) {
606 if (this.braceNesting == expressionBraceNesting &&
607 bracketNesting == 0 &&
608 parensNesting == 0) {
609 print(scopeIndent + "<< EXIT EXPRESSION");
617 case '{': //Token.LC:
618 isObjectLitAr.push(false);
621 ///print(">>>>> EXP PUSH(false)"+this.braceNesting);
624 case '}': //Token.RC:
627 //print(">>>>> EXP POP" + this.braceNesting);
628 // assert braceNesting >= expressionBraceNesting;
631 case '[': //Token.LB:
635 case ']': //Token.RB:
639 case '(': //Token.LP:
643 case ')': //Token.RP:
649 case 'STRN': // used for object lit detection..
650 if (this.ts.lookTok(-1).data == "{" && this.ts.lookTok(1).data == ":" ) {
651 // then we are in an object lit.. -> we need to flag the brace as such...
653 isObjectLitAr.push(true);
654 //print(">>>>> EXP PUSH(true)");
659 isInObjectLitAr = isObjectLitAr[isObjectLitAr.length-1];
660 if (isInObjectLitAr && this.ts.lookTok(1).data == ":" &&
661 ( this.ts.lookTok(-1).data == "{" || this.ts.lookTok(-1).data == "," )) {
662 // see if we can replace..
663 // remove the quotes..
664 var str = token.data.substring(1,token.data.length-1);
665 if (/^[a-z_]+$/i.test(str) && ScopeParser.idents.indexOf(str) < 0) {
680 //print("in NAME = " + token.toString());
681 //print("in NAME 0: " + this.ts.look(0).toString());
682 //print("in NAME 2: " + this.ts.lookTok(2).toString());
683 if (this.ts.look(0).data == "{" && this.ts.lookTok(2).data == ":") {
684 // then we are in an object lit.. -> we need to flag the brace as such...
686 isObjectLitAr.push(true);
687 //print(">>>>> EXP PUSH(true)");
691 isInObjectLitAr = isObjectLitAr[isObjectLitAr.length-1];
692 //print ("isInObjectLitAr : " + isInObjectLitAr + ' ' + token.toString());
694 if (isInObjectLitAr && this.ts.lookTok(0).data == "," && this.ts.lookTok(2).data == ":") {
697 //print(this.ts.lookTok(0).data);
698 if (this.ts.lookTok(0).data == ".") {
703 if (this.mode == 'PASS2_SYMBOL_TREE') {
705 identifier = this.getIdentifier(symbol, currentScope);
706 //println("<B>??</B>");
707 if (identifier == false) {
709 if (symbol.length <= 3 && Scope.builtin.indexOf(symbol) < 0) {
710 // Here, we found an undeclared and un-namespaced symbol that is
711 // 3 characters or less in length. Declare it in the global scope.
712 // We don't need to declare longer symbols since they won't cause
713 // any conflict with other munged symbols.
714 this.globalScope.declareIdentifier(symbol, token);
715 this.warn("Found an undeclared symbol: " + symbol + ' (line:' + token.line + ')', true);
717 //println("undeclared")
722 //println("<B>++</B>");
723 token.identifier = identifier;
724 identifier.refcount++;
733 //println("<B>EID</B>");
736 if (token.name == "FUNCTION") {
738 this.parseFunctionDeclaration();
745 if (this.mode == 'BUILDING_SYMBOL_TREE') {
747 if (symbol == "eval") {
748 if (this.ts.look(-1).type == 'COMM') {
749 // look for eval:var:noreplace\n
751 this.ts.look(-1).data.replace(/eval:var:([a-z]+)/ig, function(m, a) {
752 var hi = _t.getIdentifier(a, currentScope);
753 //println("PROTECT "+a+" from munge" + (hi ? "FOUND" : "MISSING"));
755 // println("PROTECT "+a+" from munge");
763 this.protectScopeFromObfuscation(currentScope);
764 this.warn("Using 'eval' is not recommended." + (this.munge ? " Moreover, using 'eval' reduces the level of compression!" : ""), true);
773 if (!this.ts.nextTok()) break;
775 print(scopeIndent + "<< EXIT EXPRESSION");
780 parseCatch : function() {
787 //token = getToken(-1);
788 //assert token.getType() == Token.CATCH;
789 token = this.ts.nextTok();
790 //assert token.getType() == Token.LP; (
791 token = this.ts.nextTok();
792 //assert token.getType() == Token.NAME;
795 currentScope = this.scopes[this.scopes.length-1];
797 if (this.mode == 'BUILDING_SYMBOL_TREE') {
798 // We must declare the exception identifier in the containing function
799 // scope to avoid errors related to the obfuscation process. No need to
800 // display a warning if the symbol was already declared here...
801 currentScope.declareIdentifier(symbol, token);
803 //?? why inc the refcount?? - that should be set when building the tree???
804 identifier = this.getIdentifier(symbol, currentScope);
805 identifier.refcount++;
808 token = this.ts.nextTok();
809 //assert token.getType() == Token.RP; // )
812 parseFunctionDeclaration : function()
814 //print("PARSE FUNCTION");
817 var currentScope = false;
820 var b4braceNesting = this.braceNesting + 0;
822 //this.logR("<B>PARSING FUNCTION</B>");
823 currentScope = this.scopes[this.scopes.length-1];
825 token = this.ts.nextTok();
826 if (token.type == "NAME") {
827 if (this.mode == 'BUILDING_SYMBOL_TREE') {
828 // Get the name of the function and declare it in the current scope.
830 if (currentScope.getIdentifier(symbol) != false) {
831 this.warn("The function " + symbol + " has already been declared in the same scope...", true);
833 currentScope.declareIdentifier(symbol,token);
835 token = this.ts.nextTok();
838 //assert token.getType() == Token.LP;
839 if (this.mode == 'BUILDING_SYMBOL_TREE') {
840 fnScope = new Scope(this.braceNesting, currentScope, token.n, '');
842 //println("STORING SCOPE" + this.ts.cursor);
844 this.indexedScopes[this.ts.cursor] = fnScope;
847 //qln("FETCHING SCOPE" + this.ts.cursor);
848 fnScope = this.indexedScopes[this.ts.cursor];
852 // Parse function arguments.
854 while (this.ts.lookTok().data != ')') { //(token = consumeToken()).getType() != Token.RP) {
855 token = this.ts.nextTok();
856 // print ("FUNC ARGS: " + token.toString())
857 //assert token.getType() == Token.NAME ||
858 // token.getType() == Token.COMMA;
859 if (token.type == 'NAME' && this.mode == 'BUILDING_SYMBOL_TREE') {
861 identifier = fnScope.declareIdentifier(symbol,token);
862 if (symbol == "$super" && argpos == 0) {
863 // Exception for Prototype 1.6...
864 identifier.preventMunging();
870 token = this.ts.nextTok();
871 //print(token.toString());
872 // assert token.getType() == Token.LC;
875 token = this.ts.nextTok();
876 //print(token.toString());
879 this.parseScope(fnScope);
880 // now pop it off the stack!!!
882 this.braceNesting = b4braceNesting;
883 //print("ENDFN -1: " + this.ts.lookTok(-1).toString());
884 //print("ENDFN 0: " + this.ts.lookTok(0).toString());
885 //print("ENDFN 1: " + this.ts.lookTok(1).toString());
888 protectScopeFromObfuscation : function(scope) {
889 //assert scope != null;
891 if (scope == this.globalScope) {
892 // The global scope does not get obfuscated,
893 // so we don't need to worry about it...
897 // Find the highest local scope containing the specified scope.
898 while (scope && scope.parent != this.globalScope) {
899 scope = scope.parent;
902 //assert scope.getParentScope() == globalScope;
903 scope.preventMunging();
906 getIdentifier: function(symbol, scope) {
908 while (scope != false) {
909 identifier = scope.getIdentifier(symbol);
910 //println("ScopeParser.getIdentgetUsedSymbols("+symbol+")=" + scope.getUsedSymbols().join(','));
914 scope = scope.parent;