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