git.roojs.org Git - gnome.introspection-doc-generator/blob - JSDOC/Scope.js

   1 //<Script type="text/javascript">
   2
   3 /**
   4 * Scope stuff
   5 *
   6 * // FIXME - I need this to do next() without doccomments..
   7 */
   8
   9 Identifier = imports['JSDOC/Identifier.js'].Identifier
  10 XObject = imports.XObject.XObject;
  11
  12
  13 function Scope(braceN, parent, startTokN, lastIdent)
  14 {
  15     if (lastIdent.length) {
  16        //  println("NEW SCOPE: " + lastIdent);
  17     }
  18
  19     this.braceN = braceN
  20     this.parent = parent;
  21     this.id = startTokN;
  22     this.identifiers = { };
  23     this.subScopes = [];
  24     this.hints = { };
  25     this.ident = lastIdent;
  26
  27
  28     //println("ADD SCOPE(" + this.id + ") TO "+ (parent ? this.parent.id : 'TOP') + "<BR/>");
  29
  30     if (parent) {
  31         this.parent.subScopes.push(this);
  32     }
  33
  34 }
  35
  36
  37
  38
  39
  40
  41
  42 Scope.prototype = {
  43
  44     id : 0,
  45     braceN : -1,
  46     parent : false,
  47     subScopes : false,
  48     identifiers : false,
  49     hints: false,
  50     mungeM : true,
  51     ident: '',
  52
  53     munged : false,
  54     protectedVars : {}, // only used by to parent..
  55     declareIdentifier : function(symbol, token) {
  56
  57         //println("ADD IDENT(" + this.id + "):<B>" + symbol+"</B><BR/>");
  58
  59         if (typeof(this.identifiers[symbol])== 'undefined') {
  60
  61             this.identifiers[symbol] =  new Identifier(symbol, this);
  62
  63         }
  64         if (typeof(token) != 'undefined') { // shoudl this happen?
  65             token.identifier = this.identifiers[symbol];
  66
  67         }
  68         if (this.braceN < 0) {
  69                 // then it's global...
  70                 this.identifiers[symbol].toMunge  = false;
  71         }
  72         this.addToParentScope(symbol);
  73         return this.identifiers[symbol];
  74     },
  75     getIdentifier : function(symbol) {
  76         return (typeof(this.identifiers[symbol])== 'undefined') ? false : this.identifiers[symbol];
  77     },
  78
  79     addHint : function(varName, varType) {
  80         this.hint[varName] = varType;
  81     },
  82     preventMunging : function() {
  83         this.mungeM = false;
  84     },
  85
  86     usedsymcache : false,
  87
  88     getUsedSymbols : function() {
  89
  90         var result = [];
  91        // if (this.usedsymcache !== false) {
  92         //    return this.usedsymcache;
  93         //}
  94
  95         var idents = this.identifiers;
  96         for(var i in idents) {
  97             //println('<b>'+i+'</b>='+typeof(idents[i]) +'<br/>');
  98             var identifier = this.identifiers[i];
  99             var mungedValue = identifier.mungedValue
 100             if (!mungedValue.length) {
 101                 //println(identifier.toSource());
 102                 mungedValue = identifier.name;
 103             }
 104             result.push(mungedValue);
 105         }
 106         //println("Symbols for ("+ this.id +"): <B>" + result.join(',') + "</B><BR/>");
 107         //this.usedsymcache = result;
 108         return result;
 109     },
 110
 111     getAllUsedSymbols :function() {
 112         var result = this.getUsedSymbols();
 113         var scope = this.parent;
 114         while (scope !== false) {
 115             //println("addused:"+scope.id);
 116             result = result.concat(scope.getUsedSymbols());
 117             scope = scope.parent;
 118         }
 119          //println("Done - addused");
 120         return result;
 121     },
 122     /** - we need to register short vairalbes so they never get munged into.. */
 123     addToParentScope: function(ident) {
 124         if (ident.length > 2) {
 125             return;
 126         }
 127         var scope = this.parent;
 128         while (scope !== false) {
 129             //println("addused:"+scope.id);
 130             if (!scope.parent) {
 131                 scope.protectedVars[ident] = true;
 132             }
 133             scope = scope.parent;
 134         }
 135
 136     },
 137     isProtectedVar: function(ident) {
 138         if (ident.length > 2) {
 139             return false;
 140         }
 141         var scope = this.parent;
 142         while (scope !== false) {
 143             //println("addused:"+scope.id);
 144             if (!scope.parent) {
 145                 if (typeof(scope.protectedVars[ident])  != 'undefined') return true;
 146             }
 147             scope = scope.parent;
 148         }
 149         return false;
 150     },
 151
 152
 153
 154     munge :function() {
 155
 156         if (!this.mungeM) {
 157             // Stop right here if this scope was flagged as unsafe for munging.
 158            // println("MUNGE: SKIP -  Scope" + this.id+"</BR>");
 159             return;
 160         }
 161         if (this.munged) {
 162             return;
 163         }
 164
 165
 166         //println("MUNGE: Scope:" + this.id+"</BR>");
 167
 168         var pickFromSet = 1;
 169
 170         // Do not munge symbols in the global scope!
 171         if (this.parent) {
 172
 173
 174             //println("MUNGE: Building FreeSyms:" + this.id+"</BR>");
 175
 176             var freeSymbols = [];
 177             var sy = this.getAllUsedSymbols();
 178
 179             var addSyms=function(batch)
 180             {
 181                 for(var i =0;i<batch.length;i++) {
 182                     if (sy.indexOf(batch[i]) > -1) {
 183                         continue;
 184                     }
 185                     freeSymbols.push(batch[i]);
 186                 }
 187             }
 188             /*
 189             var exsymbols  = function(n) {
 190                 if (sy.indexOf(n) > -1) {
 191                     return;
 192                 }
 193                 freeSymbols.push(n);
 194             }
 195             */
 196             addSyms(JSDOC.Scope.ones);
 197
 198             //if (freeSymbols.length == 0) {
 199             //    pickFromSet = 2;
 200                // JSDOC.Scope.twos.filter(exsymbols);
 201
 202             //}
 203             //if (freeSymbols.length == 0) {
 204             //    pickFromSet = 3;
 205             //    throw "disabled  threes!"
 206             //    JSDOC.Scope.threes.filter(exsymbols);
 207             //
 208             //}
 209             //if (freeSymbols.length == 0) {
 210             //    throw  "The Compressor ran out of symbols. Aborting...???? ";
 211            // }
 212             var repsym = '';
 213             //println(freeSymbols.toSource());
 214
 215             //println("MUNGE: Replacing " + this.id+"</BR>");
 216             for (var i in  this.identifiers) {
 217
 218                 // is the identifer in the global scope!?!!?
 219
 220
 221                 if (!this.identifiers[i].toMunge) {
 222                     continue;
 223                 }
 224
 225                 if (this.isProtectedVar(i)) {
 226                     continue; //
 227                 }
 228
 229
 230
 231                 if (this.identifiers[i].constructor != JSDOC.Identifier) {
 232                     continue;
 233                 }
 234                // println("IDENT:" +i+'</BR>');
 235
 236                 if (!repsym.length) {
 237                     if (!freeSymbols.length) {
 238                         addSyms(JSDOC.Scope.twos);
 239                     }
 240                     repsym = freeSymbols.shift(); // pop off beginngin???
 241                 }
 242
 243                 var identifier = this.identifiers[i];
 244                 //println(typeof(identifier.name));
 245                 var mungedValue = identifier.name;
 246
 247                 //println([     repsym,mungedValue ]);
 248
 249                 if (this.mungeM && repsym.length < mungedValue.length) {
 250                     //println("REPLACE:"+ mungedValue +" with " + repsym + "<BR>");
 251                     mungedValue = repsym;
 252                     repsym = '';
 253                 }
 254                 identifier.mungedValue =  mungedValue;
 255             }
 256             //println("MUNGE: Done " + this.id+"</BR>");
 257         }
 258         this.munged = true;
 259         //println("Doing sub scopes");
 260         for (var i = 0; i < this.subScopes.length; i++) {
 261             var ss = this.subScopes[i];
 262             ss.munge();
 263         }
 264     }
 265
 266
 267 });
 268
 269
 270
 271
 272
 273 XObject.extend(Scope, {
 274
 275     builtin : ["NaN","top"],
 276     skips : [  'as', 'is', 'do', 'if', 'in', 'for', 'int', 'new', 'try', 'use', 'var', "NaN","top"],
 277
 278     ones : [],
 279     twos : [],
 280     threes : [],
 281     init : function () {
 282         /* cache it later?
 283         if (File.exists('/tmp/var_list_ones.js')) {
 284             eval("JSDOC.Scope.ones = " + File.read('/tmp/var_list_ones.js'));
 285             eval("JSDOC.Scope.twos = " + File.read('/tmp/var_twos_ones.js'));
 286             eval("JSDOC.Scope.threes = " + File.read('/tmp/var_threes_ones.js'));
 287         }
 288         */
 289         this.ones = 'A,B,C,D,E,F,G,H,I,J,K,L,M,N,O,P,Q,R,S,T,U,V,W,X,Y,Z,a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r,s,t,u,v,w,x,y,z'.split(',');
 290         var a = this.ones;
 291         var n = a.concat( '0,1,2,3,4,5,6,7,8,9'.split(','));
 292         for(var i = 0; i < a.length; i++) {
 293             for(var j = 0; j < n.length; j++) {
 294                 var tw = a[i] + n[j];
 295                 if (this.skips.indexOf(tw) < 0) {
 296                     this.twos.push(tw);
 297                 }
 298
 299                 /*
 300                 for(var k = 0; k < n.length; k++) {
 301                     var thr = a[i] + n[j] + n[k];
 302                     //println("thr="+ thr + ":iOf="+this.skips.indexOf(thr) );
 303                     if (this.skips.indexOf(thr)  < 0) {
 304                         //println("+"+thr);
 305                         this.threes.push(thr);
 306                        }
 307
 308                 }
 309                 */
 310             }
 311         }
 312         //println("done creating var list");
 313         //println("threes="+ this.threes.toSource());
 314         //throw "DONE";
 315
 316
 317     }
 318 })
 319 // init the scope constants..
 320 Scope.init();
 321