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 // it's an object literal..
329 // the values could be replaced..
333 isObjectLitAr.push(false);
336 //print(">>>>>> OBJLIT PUSH(false)" + this.braceNesting);
339 case "PUNC.RIGHT_CURLY": // }
340 //println("<i>"+token.data+"</i>");
343 //print(">>>>>> OBJLIT POP"+ this.braceNesting);
344 //assert braceNesting >= scope.getBra ceNesting();
346 if (this.braceNesting < expressionBraceNesting) {
347 var ls = this.scopes.pop();
349 // eat symbol if we are currently at {
350 if (this.ts.look(0).data == '{') {
354 print("<<<<<<<EXIT SCOPE" +this.scopes.length);
360 print('SCOPE-WITH:' + token.toString());
361 //println("<i>"+token.data+"</i>");
362 if (this.mode == "BUILDING_SYMBOL_TREE") {
363 // Inside a 'with' block, it is impossible to figure out
364 // statically whether a symbol is a local variable or an
365 // object member. As a consequence, the only thing we can
366 // do is turn the obfuscation off for the highest scope
367 // containing the 'with' block.
368 this.protectScopeFromObfuscation(scope);
369 this.warn("Using 'with' is not recommended." + (this.munge ? " Moreover, using 'with' reduces the level of compression!" : ""), true);
374 print('SCOPE-CATCH:' + token.toString());
375 //println("<i>"+token.data+"</i>");
379 case Token.SPECIALCOMMENT:
380 if (mode == BUILDING_SYMBOL_TREE) {
381 protectScopeFromObfuscation(scope);
382 this.warn("Using JScript conditional comments is not recommended." + (munge ? " Moreover, using JScript conditional comments reduces the level of compression." : ""), true);
387 case "STRN.DOUBLE_QUOTE": // used for object lit detection..
388 case "STRN.SINGLE_QUOTE":
389 print('SCOPE-STRING:' + token.toString());
390 //println("<i>"+token.data+"</i>");
392 if (this.ts.lookTok(-1).data == '{' && this.ts.lookTok(1).data == ':') {
393 // then we are in an object lit.. -> we need to flag the brace as such...
395 isObjectLitAr.push(true);
396 //print(">>>>>> OBJLIT REPUSH(true)");
398 isInObjectLitAr = isObjectLitAr[isObjectLitAr.length-1];
400 if (isInObjectLitAr && this.ts.lookTok(1).data == ':' &&
401 ( this.ts.lookTok(-1).data == '{' || this.ts.lookTok(-1).data == ':' )) {
402 // see if we can replace..
403 // remove the quotes..
404 // should do a bit more checking!!!! (what about wierd char's in the string..
405 var str = token.data.substring(1,token.data.length-1);
406 if (/^[a-z_]+$/i.test(str) && ScopeParser.idents.indexOf(str) < 0) {
419 print('SCOPE-NAME:' + token.toString());
420 //print("DEAL WITH NAME:");
423 // look for { ** : <- indicates obj literal.. ** this could occur with numbers ..
424 if ((this.ts.lookTok(-1).data == "{") && (this.ts.lookTok(1).data == ":")) {
426 isObjectLitAr.push(true);
427 //print(">>>>>> OBJLIT REPUSH(true)");
428 //println("<i>"+token.data+"</i>");
431 // print("DEAL WITH obj lit:");
432 isInObjectLitAr = isObjectLitAr[isObjectLitAr.length-1];
434 if (isInObjectLitAr && (this.ts.lookTok(1).data == ":") && (this.ts.lookTok(-1).data == ",")) {
435 // skip, it's an object lit key..
436 //println("<i>"+token.data+"</i>");
441 // skip anyting with "." before it..!!
443 if (this.ts.lookTok(-1).data == ".") {
444 // skip, it's an object prop.
445 //println("<i>"+token.data+"</i>");
448 //print("SYMBOL: " + token.toString());
451 if (this.mode == 'PASS2_SYMBOL_TREE') {
453 //println("GOT IDENT: -2 : " + this.ts.lookT(-2).toString() + " <BR> ..... -1 : " + this.ts.lookT(-1).toString() + " <BR> ");
455 //print ("MUNGE?" + symbol);
457 //println("GOT IDENT: <B>" + symbol + "</B><BR/>");
459 //println("GOT IDENT (2): <B>" + symbol + "</B><BR/>");
460 identifier = this.getIdentifier(symbol, scope);
462 if (identifier == false) {
463 // BUG!find out where builtin is defined...
464 if (symbol.length <= 3 && Scope.builtin.indexOf(symbol) < 0) {
465 // Here, we found an undeclared and un-namespaced symbol that is
466 // 3 characters or less in length. Declare it in the global scope.
467 // We don't need to declare longer symbols since they won't cause
468 // any conflict with other munged symbols.
469 this.globalScope.declareIdentifier(symbol, token);
470 this.warn("Found an undeclared symbol: " + symbol + ' (line:' + token.line + ')', true);
473 //println("GOT IDENT IGNORE(3): <B>" + symbol + "</B><BR/>");
475 token.identifier = identifier;
476 identifier.refcount++;
481 //println("<B>SID</B>");
483 if (token.type != 'KEYW') {
486 print('SCOPE-KEYW:' + token.toString());
487 // print("Check eval:");
491 if (this.mode == 'BUILDING_SYMBOL_TREE') {
493 if (symbol == "eval") {
494 // look back one and see if we can find a comment!!!
495 if (this.ts.look(-1).type == "COMM") {
496 // look for eval:var:noreplace\n
498 this.ts.look(-1).data.replace(/eval:var:([a-z_]+)/ig, function(m, a) {
500 var hi = _t.getIdentifier(a, scope);
501 // println("PROTECT "+a+" from munge" + (hi ? "FOUND" : "MISSING"));
503 // println("PROTECT "+a+" from munge");
513 this.protectScopeFromObfuscation(scope);
514 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);
526 //print("parseScope TOK : " + token.toString());
527 token = this.ts.nextTok();
528 //if (this.ts.nextT()) break;
531 //print("<<<<<<<EXIT SCOPE ERR?" +this.scopes.length);
535 parseExpression : function() {
537 // Parse the expression until we encounter a comma or a semi-colon
538 // in the same brace nesting, bracket nesting and paren nesting.
539 // Parse functions if any...
540 //println("<i>EXP</i><BR/>");
541 !this.debug || print("PARSE EXPR");
544 // for printing stuff..
553 var expressionBraceNesting = this.braceNesting + 0;
554 var bracketNesting = 0;
555 var parensNesting = 0;
557 var isObjectLitAr = [ false ];
559 currentScope = this.scopes[this.scopes.length-1];
561 var scopeIndent = '';
562 this.scopes.forEach(function() {
565 //print(scopeIndent + ">> ENTER EXPRESSION" + this.expN);
566 while (token = this.ts.lookTok()) {
571 // moved out of loop?
572 currentScope = this.scopes[this.scopes.length-1];
574 var scopeIndent = '';
575 this.scopes.forEach(function() {
580 //this.dumpToken(token, this.scopes, this.braceNesting );
581 //print('EXP' + this.expN + ':' + token.toString());
584 //println("<i>"+token.data+"</i>");
585 //this.log("EXP:" + token.data);
586 switch (token.type) {
592 if (this.braceNesting == expressionBraceNesting &&
593 bracketNesting == 0 &&
594 parensNesting == 0) {
595 print(scopeIndent + "<< EXIT EXPRESSION");
603 case '{': //Token.LC:
604 isObjectLitAr.push(false);
607 ///print(">>>>> EXP PUSH(false)"+this.braceNesting);
610 case '}': //Token.RC:
613 //print(">>>>> EXP POP" + this.braceNesting);
614 // assert braceNesting >= expressionBraceNesting;
617 case '[': //Token.LB:
621 case ']': //Token.RB:
625 case '(': //Token.LP:
629 case ')': //Token.RP:
635 case 'STRN': // used for object lit detection..
636 if (this.ts.lookTok(-1).data == "{" && this.ts.lookTok(1).data == ":" ) {
637 // then we are in an object lit.. -> we need to flag the brace as such...
639 isObjectLitAr.push(true);
640 //print(">>>>> EXP PUSH(true)");
645 isInObjectLitAr = isObjectLitAr[isObjectLitAr.length-1];
646 if (isInObjectLitAr && this.ts.lookTok(1).data == ":" &&
647 ( this.ts.lookTok(-1).data == "{" || this.ts.lookTok(-1).data == "," )) {
648 // see if we can replace..
649 // remove the quotes..
650 var str = token.data.substring(1,token.data.length-1);
651 if (/^[a-z_]+$/i.test(str) && ScopeParser.idents.indexOf(str) < 0) {
666 //print("in NAME = " + token.toString());
667 //print("in NAME 0: " + this.ts.look(0).toString());
668 //print("in NAME 2: " + this.ts.lookTok(2).toString());
669 if (this.ts.look(0).data == "{" && this.ts.lookTok(2).data == ":") {
670 // then we are in an object lit.. -> we need to flag the brace as such...
672 isObjectLitAr.push(true);
673 //print(">>>>> EXP PUSH(true)");
677 isInObjectLitAr = isObjectLitAr[isObjectLitAr.length-1];
678 //print ("isInObjectLitAr : " + isInObjectLitAr + ' ' + token.toString());
680 if (isInObjectLitAr && this.ts.lookTok(0).data == "," && this.ts.lookTok(2).data == ":") {
683 //print(this.ts.lookTok(0).data);
684 if (this.ts.lookTok(0).data == ".") {
689 if (this.mode == 'PASS2_SYMBOL_TREE') {
691 identifier = this.getIdentifier(symbol, currentScope);
692 //println("<B>??</B>");
693 if (identifier == false) {
695 if (symbol.length <= 3 && Scope.builtin.indexOf(symbol) < 0) {
696 // Here, we found an undeclared and un-namespaced symbol that is
697 // 3 characters or less in length. Declare it in the global scope.
698 // We don't need to declare longer symbols since they won't cause
699 // any conflict with other munged symbols.
700 this.globalScope.declareIdentifier(symbol, token);
701 this.warn("Found an undeclared symbol: " + symbol + ' (line:' + token.line + ')', true);
703 //println("undeclared")
708 //println("<B>++</B>");
709 token.identifier = identifier;
710 identifier.refcount++;
719 //println("<B>EID</B>");
722 if (token.name == "FUNCTION") {
724 this.parseFunctionDeclaration();
731 if (this.mode == 'BUILDING_SYMBOL_TREE') {
733 if (symbol == "eval") {
734 if (this.ts.look(-1).type == 'COMM') {
735 // look for eval:var:noreplace\n
737 this.ts.look(-1).data.replace(/eval:var:([a-z]+)/ig, function(m, a) {
738 var hi = _t.getIdentifier(a, currentScope);
739 //println("PROTECT "+a+" from munge" + (hi ? "FOUND" : "MISSING"));
741 // println("PROTECT "+a+" from munge");
749 this.protectScopeFromObfuscation(currentScope);
750 this.warn("Using 'eval' is not recommended." + (this.munge ? " Moreover, using 'eval' reduces the level of compression!" : ""), true);
759 if (!this.ts.nextTok()) break;
761 print(scopeIndent + "<< EXIT EXPRESSION");
766 parseCatch : function() {
773 //token = getToken(-1);
774 //assert token.getType() == Token.CATCH;
775 token = this.ts.nextTok();
776 //assert token.getType() == Token.LP; (
777 token = this.ts.nextTok();
778 //assert token.getType() == Token.NAME;
781 currentScope = this.scopes[this.scopes.length-1];
783 if (this.mode == 'BUILDING_SYMBOL_TREE') {
784 // We must declare the exception identifier in the containing function
785 // scope to avoid errors related to the obfuscation process. No need to
786 // display a warning if the symbol was already declared here...
787 currentScope.declareIdentifier(symbol, token);
789 //?? why inc the refcount?? - that should be set when building the tree???
790 identifier = this.getIdentifier(symbol, currentScope);
791 identifier.refcount++;
794 token = this.ts.nextTok();
795 //assert token.getType() == Token.RP; // )
798 parseFunctionDeclaration : function()
800 //print("PARSE FUNCTION");
803 var currentScope = false;
806 var b4braceNesting = this.braceNesting + 0;
808 //this.logR("<B>PARSING FUNCTION</B>");
809 currentScope = this.scopes[this.scopes.length-1];
811 token = this.ts.nextTok();
812 if (token.type == "NAME") {
813 if (this.mode == 'BUILDING_SYMBOL_TREE') {
814 // Get the name of the function and declare it in the current scope.
816 if (currentScope.getIdentifier(symbol) != false) {
817 this.warn("The function " + symbol + " has already been declared in the same scope...", true);
819 currentScope.declareIdentifier(symbol,token);
821 token = this.ts.nextTok();
824 //assert token.getType() == Token.LP;
825 if (this.mode == 'BUILDING_SYMBOL_TREE') {
826 fnScope = new Scope(this.braceNesting, currentScope, token.n, '');
828 //println("STORING SCOPE" + this.ts.cursor);
830 this.indexedScopes[this.ts.cursor] = fnScope;
833 //qln("FETCHING SCOPE" + this.ts.cursor);
834 fnScope = this.indexedScopes[this.ts.cursor];
838 // Parse function arguments.
840 while (this.ts.lookTok().data != ')') { //(token = consumeToken()).getType() != Token.RP) {
841 token = this.ts.nextTok();
842 // print ("FUNC ARGS: " + token.toString())
843 //assert token.getType() == Token.NAME ||
844 // token.getType() == Token.COMMA;
845 if (token.type == 'NAME' && this.mode == 'BUILDING_SYMBOL_TREE') {
847 identifier = fnScope.declareIdentifier(symbol,token);
848 if (symbol == "$super" && argpos == 0) {
849 // Exception for Prototype 1.6...
850 identifier.preventMunging();
856 token = this.ts.nextTok();
857 //print(token.toString());
858 // assert token.getType() == Token.LC;
861 token = this.ts.nextTok();
862 //print(token.toString());
865 this.parseScope(fnScope);
866 // now pop it off the stack!!!
868 this.braceNesting = b4braceNesting;
869 //print("ENDFN -1: " + this.ts.lookTok(-1).toString());
870 //print("ENDFN 0: " + this.ts.lookTok(0).toString());
871 //print("ENDFN 1: " + this.ts.lookTok(1).toString());
874 protectScopeFromObfuscation : function(scope) {
875 //assert scope != null;
877 if (scope == this.globalScope) {
878 // The global scope does not get obfuscated,
879 // so we don't need to worry about it...
883 // Find the highest local scope containing the specified scope.
884 while (scope && scope.parent != this.globalScope) {
885 scope = scope.parent;
888 //assert scope.getParentScope() == globalScope;
889 scope.preventMunging();
892 getIdentifier: function(symbol, scope) {
894 while (scope != false) {
895 identifier = scope.getIdentifier(symbol);
896 //println("ScopeParser.getIdentgetUsedSymbols("+symbol+")=" + scope.getUsedSymbols().join(','));
900 scope = scope.parent;