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 TextStream      = imports.TextStream.TextStream;
   6 TokenReader     = imports.TokenReader.TokenReader;
   7 ScopeParser     = imports.ScopeParser.ScopeParser;
   8 TokenStream     = imports.TokenStream.TokenStream;
   9 CompressWhite   = imports.CompressWhite.CompressWhite;
  10 Collapse        = imports.Collapse.Collapse;
  11
  12 GLib = imports.gi.GLib;
  13 /**
  14  * @namespace JSDOC
  15  * @class  Packer
  16  * Create a new packer
  17  *
  18  * Use with pack.js
  19  *
  20  *
  21  * Usage:
  22  * <code>
  23  *
  24 Packer = imports['JSDOC/Packer.js'].Packer;
  25 var x = new  Packer({
  26
  27     files : [ "/location/of/file1.js", "/location/of/file2.js", ... ],
  28     target : "/tmp/output.js",
  29     debugTarget : "/tmp/output.debug.js", // merged file without compression.
  30     translateJSON: "/tmp/translate.json",
  31
  32
  33 );
  34 x.packFiles(
  35     "/location/of/temp_batch_dir",
  36     "/location/of/output-compacted-file.js",
  37     "/location/of/output-debug-merged-file.js"
  38 );
  39
  40  *</code>
  41  *
  42  * Notes for improving compacting:
  43  *  if you add a jsdoc comment
  44  * <code>
  45  * /**
  46  *   eval:var:avarname
  47  *   eval:var:bvarname
  48  *   ....
  49  * </code>
  50  * directly before an eval statement, it will compress all the code around the eval,
  51  * and not rename the variables 'avarname'
  52  *
  53  * Dont try running this on a merged uncompressed large file - it's used to be horrifically slow. not sure about now..
  54  * Best to use lot's of small classes, and use it to merge, as it will cache the compaction
  55  *
  56  *
  57  *
  58  * Notes for translation
  59  *  - translation relies on you using double quotes for strings if they need translating
  60  *  - single quoted strings are ignored.
  61  *
  62  * Generation of indexFiles
  63  *   - translateIndex = the indexfile
  64  *
  65  *
  66  *
  67  *
  68
  69  */
  70 Packer = function(cfg)
  71 {
  72
  73     XObject.extend(this, cfg);
  74     var _this = this;
  75     if (this.srcfiles && this.srcfiles.length) {
  76         this.srcfiles.forEach(function(f) {
  77             _this.loadSourceFile(f);
  78         });
  79
  80     }
  81
  82     if (!this.files) {
  83         throw "No Files";
  84     }
  85
  86     var link = false;
  87     if (cfg.autoBuild) {
  88         var version = 0;
  89         this.files.forEach(function(f) {
  90             version = Math.max(File.mtime(f), version);
  91         });
  92         var dirname = GLib.path_get_dirname(this.files[0]);
  93         var outname = this.module ? this.module : GLib.path_get_basename(dirname);
  94         this.target = dirname + '/compiled/' + outname + '-' + version + '.js';
  95         link = dirname + '/compiled/' + outname + '.js';
  96         if (File.exists(this.target)) {
  97             print("Target file already exists");
  98             Seed.quit();
  99         }
 100         this.prefix = dirname +'/';
 101         this.translateJSON  = dirname + '/compiled/_translation_.js';
 102
 103     }
 104
 105
 106     this.timer =  new Date() * 1;
 107     this.packAll();
 108
 109     if (link) {
 110         if (File.exists(link)) {
 111             File.remove(link);
 112         }
 113         var f = Gio.file_new_for_path(this.target);
 114         f.create_symbolic_link(link);
 115     }
 116
 117
 118
 119 }
 120 Packer.prototype = {
 121     /**
 122      * @cfg {String} srcfiles file containing a list of files/or classes to use.
 123      */
 124     srcfile : false,
 125
 126     /**
 127      * @cfg {Array} files list of files to compress (must be full path)
 128      */
 129     files : false,
 130     /**
 131      * @cfg {String} target to write files to - must be full path.
 132      */
 133     target : '',
 134     /**
 135      * @cfg {Boolean} autoBuild - turn on autobuild feature (puts files in compiled directory,
 136      * and enables translation toolkit.
 137      */
 138     autoBuild : false,
 139      /**
 140      * @cfg {String} module used with autoBuild to force a file name
 141      */
 142     module: false,
 143     /**
 144      * @cfg {String} debugTargettarget to write files debug version to (uncompacted)- must be full path.
 145      */
 146     debugTarget : '', // merged file without compression.
 147     /**
 148      * @cfg {String} tmpDir  (optional) where to put the temporary files.
 149      *      if you set this, then files will not be cleaned up
 150      */
 151     tmpDir : '/tmp',
 152
 153     translateJSON : '', // json based list of strings in all files.
 154
 155     /**
 156      * @cfg {Boolean} cleanup  (optional) clean up temp files after done -
 157      *    Defaults to false if you set tmpDir, otherwise true.
 158      */
 159     cleanup : true,
 160
 161     /**
 162      * @cfg {String} prefix (optional) prefix of directory to be stripped of when
 163      *    Calculating md5 of filename
 164      */
 165     prefix : '',
 166     out : '', // if no target is specified - then this will contain the result
 167
 168     /**
 169      * load a dependancy list -f option
 170      * @param {String} srcfile sourcefile to parse
 171      *
 172      */
 173
 174     loadSourceFile : function(srcfile)
 175     {
 176         var lines = File.read(srcfile).split("\n");
 177         var _this = this;
 178         lines.forEach(function(f) {
 179
 180             if (/^\s*\//.test(f) || !/[a-z]+/i.test(f)) { // skip comments..
 181                 return;
 182             }
 183             if (/\.js$/.test(f)) {
 184                 _this.files.push( f);
 185                 // js file..
 186                 return;
 187             }
 188
 189             //println("ADD"+ f.replace(/\./g, '/'));
 190             var add = f.replace(/\./g, '/').replace(/\s+/g,'')+'.js';
 191             if (_this.files.indexOf(f) > -1) {
 192                 return;
 193             }
 194             _this.files.push( add );
 195
 196         })
 197     },
 198
 199
 200     packAll : function()  // do the packing (run from constructor)
 201     {
 202
 203         //this.transOrigFile= bpath + '/../lang.en.js'; // needs better naming...
 204         //File.write(this.transfile, "");
 205         if (this.target) {
 206             File.write(this.target, "");
 207         }
 208
 209         if (this.debugTarget) {
 210             File.write(this.debugTarget, "");
 211         }
 212
 213         for(var i=0; i < this.files.length; i++)  {
 214             var file = this.files[i];
 215
 216             print("reading " +file );
 217             if (!File.isFile(file)) {
 218                 print("SKIP (is not a file) " + file);
 219                 continue;
 220             }
 221
 222             if (this.debugTarget) {
 223                 File.append(this.debugTarget, File.read(file));
 224             }
 225             // it's a good idea to check with 0 compression to see if the code can parse!!
 226
 227             // debug file..
 228             //File.append(dout, str +"\n");
 229
 230
 231
 232             var minfile = this.tmpDir + '/' +file.replace(/\//g, '.');
 233
 234
 235             // let's see if we have a min file already?
 236             // this might happen if tmpDir is set ..
 237             if (true && File.exists(minfile)) {
 238                 var mt = File.mtime(minfile);
 239                 var ot = File.mtime(file);
 240                 print("compare : " + mt + "=>" + ot);
 241                 if (mt >= ot) {
 242                     continue;
 243                     /*
 244                     // then the min'files time is > than original..
 245                     var str = File.read(minfile);
 246                     print("using MIN FILE  "+ minfile);
 247                     if (str.length) {
 248                         File.append(outpath, str + "\n");
 249                     }
 250
 251                     continue;
 252                     */
 253                 }
 254
 255             }
 256
 257             print("COMPRESSING ");
 258             //var codeComp = pack(str, 10, 0, 0);
 259             if (File.exists(minfile)) {
 260                 File.remove(minfile);
 261             }
 262             var str = File.read(file);
 263             var str = this.pack(str, file, minfile);
 264             if (str.length) {
 265                 File.write(minfile, str);
 266             }
 267
 268
 269
 270         }
 271         if (this.translateJSON) {
 272
 273
 274             print("MERGING LANGUAGE");
 275             var out = "if (typeof(_T) == 'undefined') { _T={};}\n"
 276             if (this.target) {
 277                 File.write(this.target, out);
 278             } else {
 279                 this.out += out;
 280             }
 281
 282
 283
 284             File.write(this.translateJSON, "");
 285             for(var i=0; i < this.files.length; i++)  {
 286                 var file = this.files[i];
 287                 var transfile= this.tmpDir + '/' +file.replace(/\//g, '.') +'.lang.trans';
 288                 var transmd5 = this.tmpDir  + '/' +file.replace(/\//g, '.') +'.lang';
 289                 if (File.exists(transmd5)) {
 290                     var str = File.read(transmd5);
 291                     if (str.length) {
 292                         if (this.target) {
 293                             File.append(this.target, str + "\n");
 294                         } else {
 295                             this.out += str + "\n";
 296                         }
 297
 298                     }
 299                     if (this.cleanup) {
 300                         File.remove(transmd5);
 301                     }
 302                 }
 303                 if (File.exists(transfile)) {
 304                     var str = File.read(transfile);
 305                     if (str.length) {
 306                         File.append(this.translateJSON, str);
 307                     }
 308                     if (this.cleanup) {
 309                         File.remove(transfile);
 310                     }
 311                 }
 312
 313
 314             }
 315         }
 316
 317         print("MERGING SOURCE");
 318
 319         for(var i=0; i < this.files.length; i++)  {
 320             var file = this.files[i];
 321             var minfile = this.tmpDir + '/' + file.replace(/\//g, '.');
 322
 323
 324             if (!File.exists(minfile)) {
 325                 continue;
 326             }
 327             var str = File.read(minfile);
 328             print("using MIN FILE  "+ minfile);
 329             if (str.length) {
 330                 if (this.target) {
 331                     File.append(this.target, str + "\n");
 332                 } else {
 333                     this.out += str + "\n";
 334                 }
 335
 336             }
 337             if (this.cleanup) {
 338                 File.remove(minfile);
 339             }
 340
 341         }
 342
 343
 344
 345
 346     },
 347     /**
 348      * Core packing routine  for a file
 349      *
 350      * @param str - str source text..
 351      * @param fn - filename (for reference?)
 352      * @param minfile - min file location...
 353      *
 354      */
 355
 356     pack : function (str,fn,minfile)
 357     {
 358
 359         var tr = new  TokenReader(  {
 360             keepDocs :true,
 361             keepWhite : true,
 362             keepComments : true,
 363             sepIdents : true,
 364             collapseWhite : false
 365         });
 366         this.timerPrint("START" + fn);
 367
 368         // we can load translation map here...
 369
 370         var toks = tr.tokenize(new TextStream(str)); // dont merge xxx + . + yyyy etc.
 371
 372         // at this point we can write a language file...
 373         if (this.translateJSON) {
 374
 375             this.writeTranslateFile(fn, minfile, toks);
 376         }
 377
 378         this.activeFile = fn;
 379
 380         // and replace if we are generating a different language..
 381
 382         this.timerPrint("Tokenized");
 383         //var ts = new TokenStream(toks);
 384         //print(JSON.stringify(toks, null,4 )); Seed.quit();
 385         var ts = new Collapse(toks);
 386        // print(JSON.stringify(ts.tokens, null,4 )); Seed.quit();
 387         //return;//
 388         var sp = new ScopeParser(ts);
 389         this.timerPrint("Converted to Parser");
 390         sp.packer = this;
 391         sp.buildSymbolTree();
 392         this.timerPrint("Built Sym tree");
 393         sp.mungeSymboltree();
 394         this.timerPrint("Munged Sym tree");
 395         print(sp.warnings.join("\n"));
 396
 397
 398         //var out = CompressWhite(new TokenStream(toks), this, true); // do not kill whitespace..
 399         var out = CompressWhite(new TokenStream(toks), this, false);
 400         this.timerPrint("Compressed");
 401         return out;
 402
 403
 404
 405     },
 406
 407     timerPrint: function (str) {
 408         var ntime = new Date() * 1;
 409         var tdif =  ntime -this.timer;
 410         this.timer = ntime;
 411         print('['+tdif+']'+str);
 412     },
 413
 414     /**
 415      *
 416      * Translation concept...
 417      * -> replace text strings with _T....
 418      * -> this file will need inserting at the start of the application....
 419      * -> we need to generate 2 files,
 420      * -> a reference used to do the translation, and the _T file..
 421      *
 422      */
 423
 424     writeTranslateFile : function(fn, minfile, toks)
 425     {
 426
 427         var map = {};
 428         var _this = this;
 429         toks.forEach(function (t) {
 430             if (t.type == 'STRN' && t.name == 'DOUBLE_QUOTE') {
 431                 var sval = t.data.substring(1,t.data.length-1);
 432                 var ffn = fn.substring(_this.prefix.length);
 433                 map[sval] = _this.md5(ffn + '-' + sval);
 434             }
 435         })
 436
 437         var transfile = minfile + '.lang.trans';
 438         var transmd5 = minfile + '.lang';
 439         print("writeTranslateFile "  + transfile);
 440         var i = 0;
 441         var v = '';
 442         if (File.exists(transfile)) {
 443             File.remove(transfile);
 444         }
 445         if (File.exists(transmd5)) {
 446             File.remove(transmd5);
 447         }
 448         for(v in map) { i++; break };
 449         if (!i ) {
 450             return; // no strings in file...
 451         }
 452         var ffn = fn.substring(this.prefix.length);
 453
 454
 455         File.write(transfile, "\n'" + ffn  + "' : {");
 456         var l = '';
 457         var _tout = {}
 458
 459         File.write(transmd5, '');
 460         for(v in map) {
 461             if (!v.length) {
 462                 continue;
 463             }
 464             File.append(transfile, l + "\n\t" + JSON.stringify(v) + " : " + JSON.stringify(v));
 465             l = ',';
 466             // strings are raw... - as the where encoded to start with!!!
 467             File.append(transmd5, '_T["' + this.md5(ffn + '-' + v) + '"]='+JSON.stringify(v)+";\n");
 468         }
 469         File.append(transfile, "\n},"); // always one trailing..
 470
 471
 472     },
 473     md5 : function (string)
 474     {
 475
 476         return GLib.compute_checksum_for_string(GLib.ChecksumType.MD5, string, string.length);
 477
 478     },
 479     stringHandler : function(tok)
 480     {
 481         //print("STRING HANDLER");
 482        // callback when outputing compressed file,
 483        var data = tok.data;
 484         if (!this.translateJSON) {
 485          //   print("TURNED OFF");
 486             return data;
 487         }
 488         if (tok.name == 'SINGLE_QUOTE') {
 489             return data;
 490         }
 491
 492         var sval = data.substring(1,data.length-1);
 493         // we do not clean up... quoting here!??!!?!?!?!?
 494
 495
 496         // blank with tabs or spaces..
 497         //if (!sval.replace(new RegExp("(\\\\n|\\\\t| )+",'g'), '').length) {
 498        //     return tok.outData;
 499        // }
 500
 501         var sval = tok.data.substring(1,data.length-1);
 502         var fn = this.activeFile.substring(this.prefix.length);
 503
 504
 505         return '_T["' + this.md5(fn + '-' + sval) + '"]';
 506
 507
 508     }
 509
 510
 511 };