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

   1 // <script type="text/javascript">
   2 XObject         = imports.XObject.XObject;
   3 File            = imports.File.File;
   4
   5 TokenReader     = imports['JSDOC/TokenReader.js'].TokenReader;
   6 ScopeParser     = imports['JSDOC/ScopeParser.js'].ScopeParser;
   7 TokenStream     = imports['JSDOC/TokenStream.js'].TokenStream;
   8 CompressWhite   = imports['JSDOC/CompressWhite.js'].CompressWhite;
   9
  10 GLib = imports.gi.GLib;
  11 /**
  12  * @namespace JSDOC
  13  * @class  Packer
  14  * Create a new packer
  15  *
  16  * Use with pack.js
  17  *
  18  *
  19  * Usage:
  20  * <code>
  21  *
  22 Packer = imports['JSDOC/Packer.js'].Packer;
  23 var x = new  Packer({
  24
  25     files : [ "/location/of/file1.js", "/location/of/file2.js", ... ],
  26     target : "/tmp/output.js",
  27     debugTarget : "/tmp/output.debug.js", // merged file without compression.
  28     translateJSON: "/tmp/translate.json",
  29
  30
  31 );
  32 x.packFiles(
  33     "/location/of/temp_batch_dir",
  34     "/location/of/output-compacted-file.js",
  35     "/location/of/output-debug-merged-file.js"
  36 );
  37
  38  *</code>
  39  *
  40  * Notes for improving compacting:
  41  *  if you add a jsdoc comment
  42  * <code>
  43  * /**
  44  *   eval:var:avarname
  45  *   eval:var:bvarname
  46  *   ....
  47  * </code>
  48  * directly before an eval statement, it will compress all the code around the eval,
  49  * and not rename the variables 'avarname'
  50  *
  51  * Dont try running this on a merged uncompressed large file - it's used to be horrifically slow. not sure about now..
  52  * Best to use lot's of small classes, and use it to merge, as it will cache the compaction
  53  *
  54  *
  55  *
  56  * Notes for translation
  57  *  - translation relies on you using double quotes for strings if they need translating
  58  *  - single quoted strings are ignored.
  59  *
  60  * Generation of indexFiles
  61  *   - translateIndex = the indexfile
  62  *
  63  *
  64  *
  65  *
  66
  67  */
  68 Packer = function(cfg)
  69 {
  70
  71     XObject.extend(this, cfg);
  72     if (!this.files) {
  73         throw "No Files";
  74     }
  75     if (!this.target) {
  76         throw "No Target";
  77     }
  78     if ((typeof(cfg.tmpDir) != 'undefined') && (!cfg.cleanup)) {
  79         this.cleanup = false; // do not clean up files.. = as tmpdir is set.
  80     }
  81
  82     this.timer =  new Date() * 1;
  83     this.packAll();
  84
  85 }
  86 Packer.prototype = {
  87     /**
  88      * @prop files {Array} list of files to compress (must be full path)
  89      */
  90     files : false,
  91     /**
  92      * @prop target {String} target to write files to - must be full path.
  93      */
  94     target : '',
  95     /**
  96      * @prop debugTarget {String} target to write files debug version to (uncompacted)- must be full path.
  97      */
  98     debugTarget : '', // merged file without compression.
  99     /**
 100      * @prop tmpDir {String} (optional) where to put the temporary files.
 101      *      if you set this, then files will not be cleaned up
 102      */
 103     tmpDir : '/tmp',
 104
 105     translateJSON : '', // json based list of strings in all files.
 106
 107     /**
 108      * @prop cleanup {Boolean} (optional) clean up temp files after done -
 109      *    Defaults to false if you set tmpDir, otherwise true.
 110      */
 111     cleanup : true, //
 112
 113     packAll : function()  // do the packing (run from constructor)
 114     {
 115
 116         //this.transOrigFile= bpath + '/../lang.en.js'; // needs better naming...
 117         //File.write(this.transfile, "");
 118         File.write(this.target, "");
 119         if (this.debugTarget) {
 120             File.write(this.debugTarget, "");
 121         }
 122
 123         for(var i=0; i < this.files.length; i++)  {
 124             var file = this.files[i];
 125
 126             print("reading " +file );
 127             if (!File.exists(file)) {
 128                 print("SKIP (does not exist) " + file);
 129                 continue;
 130             }
 131
 132             if (this.debugTarget) {
 133                 File.append(this.debugTarget, File.read(files[i]));
 134             }
 135             // it's a good idea to check with 0 compression to see if the code can parse!!
 136
 137             // debug file..
 138             //File.append(dout, str +"\n");
 139
 140
 141
 142             var minfile = this.tmpDir + '/' +files.replace(/\//g, '.');
 143
 144
 145             // let's see if we have a min file already?
 146             // this might happen if tmpDir is set ..
 147             if (true && File.exists(minfile)) {
 148                 var mt = File.mtime(minfile);
 149                 var ot = File.mtime(files);
 150                 print("compare : " + mt + "=>" + ot);
 151                 if (mt >= ot) {
 152                     continue;
 153                     /*
 154                     // then the min'files time is > than original..
 155                     var str = File.read(minfile);
 156                     print("using MIN FILE  "+ minfile);
 157                     if (str.length) {
 158                         File.append(outpath, str + "\n");
 159                     }
 160
 161                     continue;
 162                     */
 163                 }
 164
 165             }
 166
 167             print("COMPRESSING ");
 168             //var codeComp = pack(str, 10, 0, 0);
 169             if (File.exists(minfile)) {
 170                 File.remove(minfile);
 171             }
 172             var str = File.read(files);
 173             var str = this.pack(str, files, minfile);
 174             if (str.length) {
 175                 File.write(minfile, str);
 176                 this.tmpFiles.push(minfile);
 177             }
 178
 179
 180
 181         }
 182         if (this.translateJSON) {
 183
 184
 185             print("MERGING LANGUAGE");
 186             File.write(this.target, "if (typeof(_T) == 'undefined') { _T={};}\n");
 187
 188
 189             File.write(this.translateJSON, "");
 190             for(var i=0; i < this.files.length; i++)  {
 191                 var file = this.files[i];
 192                 var transfile= this.tmpDir + '/' +file.replace(/\//g, '.') +'.lang.trans';
 193                 var transmd5 = this.tmpDir  + '/' +file.replace(/\//g, '.') +'.lang';
 194                 if (File.exists(transmd5)) {
 195                     var str = File.read(transmd5);
 196                     if (str.length) {
 197                         File.append(this.target, str + "\n");
 198                     }
 199                     if (this.cleanup) {
 200                         File.remove(transmd5);
 201                     }
 202                 }
 203                 if (File.exists(transfile)) {
 204                     var str = File.read(transfile);
 205                     if (str.length) {
 206                         File.append(this.translateJSON, str);
 207                     }
 208                     if (this.cleanup) {
 209                         File.remove(transfile);
 210                     }
 211                 }
 212
 213
 214             }
 215         }
 216
 217         print("MERGING SOURCE");
 218
 219         for(var i=0; i < files.length; i++)  {
 220
 221             var minfile = bpath + '/' + this.files.replace(/\//g, '.');
 222
 223
 224             if (!File.exists(minfile)) {
 225                 continue;
 226             }
 227             var str = File.read(minfile);
 228             print("using MIN FILE  "+ minfile);
 229             if (str.length) {
 230                 File.append(this.target, str + "\n");
 231             }
 232             if (this.cleanup) {
 233                 File.remove(minfile);
 234             }
 235
 236         }
 237
 238
 239
 240
 241     },
 242     /**
 243      * Core packing routine  for a file
 244      *
 245      * @param str - str source text..
 246      * @param fn - filename (for reference?)
 247      * @param minfile - min file location...
 248      *
 249      */
 250
 251     pack : function (str,fn,minfile)
 252     {
 253
 254         var tr = new  TokenReader(  { keepDocs :true, keepWhite : true,  keepComments : true, sepIdents : true });
 255         this.timerPrint("START" + fn);
 256
 257         // we can load translation map here...
 258
 259         var toks = tr.tokenize(new TextStream(str)); // dont merge xxx + . + yyyy etc.
 260
 261         // at this point we can write a language file...
 262         if (this.translateJSON) {
 263             this.writeTranslateFile(fn, minfile, tr.translateMap);
 264         }
 265
 266         this.activeFile = fn;
 267
 268         // and replace if we are generating a different language..
 269
 270         this.timerPrint("Tokenized");
 271         //return;//
 272         var sp = new ScopeParser(new TokenStream(toks));
 273         this.timerPrint("Converted to Parser");
 274         sp.packer = this;
 275         sp.buildSymbolTree();
 276         this.timerPrint("Built Sym tree");
 277         sp.mungeSymboltree();
 278         this.timerPrint("Munged Sym tree");
 279         print(sp.warnings.join("\n"));
 280         var out = JSDOC.CompressWhite(sp.ts, this);
 281         this.timerPrint("Compressed");
 282         return out;
 283
 284
 285
 286     },
 287
 288     timerPrint: function (str) {
 289         var ntime = new Date() * 1;
 290         var tdif =  ntime -this.timer;
 291         this.timer = ntime;
 292         print('['+tdif+']'+str);
 293     },
 294
 295     /**
 296      *
 297      * Translation concept...
 298      * -> replace text strings with _T....
 299      * -> this file will need inserting at the start of the application....
 300      * -> we need to generate 2 files,
 301      * -> a reference used to do the translation, and the _T file..
 302      *
 303      */
 304
 305     writeTranslateFile : function(fn, minfile, map)
 306     {
 307         var transfile = minfile + '.lang.trans';
 308         var transmd5 = minfile + '.lang';
 309         var i = 0;
 310         var v = '';
 311         if (File.exists(transfile)) {
 312             File.remove(transfile);
 313         }
 314         if (File.exists(transmd5)) {
 315             File.remove(transmd5);
 316         }
 317         for(v in map) { i++; break };
 318         if (!i ) {
 319             return; // no strings in file...
 320         }
 321         var ff = fn.split('/');
 322         var ffn = ff[ff.length-1];
 323
 324
 325         File.write(transfile, "\n" + ffn.toSource() + " : {");
 326         var l = '';
 327         var _tout = {}
 328
 329         File.write(transmd5, '');
 330         for(v in map) {
 331             File.append(transfile, l + "\n\t \"" + v + '" : "' + v + '"');
 332             l = ',';
 333             // strings are raw... - as the where encoded to start with!!!
 334             File.append(transmd5, '_T["' + this.md5(ffn + '-' + v) + '"]="'+v+"\";\n");
 335         }
 336         File.append(transfile, "\n},"); // always one trailing..
 337
 338
 339     },
 340     md5 : function (string)
 341     {
 342
 343         return GLib.compute_checksum_for_string(GLib.ChecksumType.MD5, string, string.length);
 344
 345     },
 346     stringHandler : function(tok)
 347     {
 348         //print("STRING HANDLER");
 349        // callback when outputing compressed file,
 350         if (!this.translateJSON) {
 351          //   print("TURNED OFF");
 352             return tok.outData;
 353         }
 354         if (tok.name == SINGLE_QUOTE) {
 355             return tok.outData;
 356         }
 357         var sval = tok.data.substring(1,tok.data.length-1);
 358         // blank with tabs or spaces..
 359         //if (!sval.replace(new RegExp("(\\\\n|\\\\t| )+",'g'), '').length) {
 360        //     return tok.outData;
 361        // }
 362
 363
 364
 365
 366         var ff = this.activeFile.split('/');
 367         var ffn = ff[ff.length-1];
 368         return '_T["' + this.md5(ffn + '-' + sval) + '"]';
 369
 370
 371     }
 372
 373
 374 };