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
 236         for(var i=0; i < this.files.length; i++)  {
 237             var file = this.files[i];
 238
 239             print("reading " +file );
 240             if (!File.isFile(file)) {
 241                 print("SKIP (is not a file) " + file);
 242                 continue;
 243             }
 244
 245             // debug Target
 246
 247             if (this.debugTarget) {
 248                 File.append(this.debugTarget, File.read(file));
 249             }
 250             // it's a good idea to check with 0 compression to see if the code can parse!!
 251
 252             // debug file..
 253             //File.append(dout, str +"\n");
 254
 255
 256
 257             var minfile = this.tmpDir + '/' +file.replace(/\//g, '.');
 258
 259
 260             // let's see if we have a min file already?
 261             // this might happen if tmpDir is set ..
 262             if (true && File.exists(minfile)) {
 263                 var mt = File.mtime(minfile);
 264                 var ot = File.mtime(file);
 265                 print("compare : " + mt + "=>" + ot);
 266                 if (mt >= ot) {
 267                     continue;
 268
 269                 }
 270
 271             }
 272
 273             print("COMPRESSING ");
 274             //var codeComp = pack(str, 10, 0, 0);
 275             if (File.exists(minfile)) {
 276                 File.remove(minfile);
 277             }
 278             var str = File.read(file);
 279             var str = this.pack(str, file, minfile);
 280             if (str.length) {
 281                 File.write(minfile, str);
 282             }
 283
 284
 285
 286         }
 287         if (this.translateJSON) {
 288
 289
 290             print("MERGING LANGUAGE");
 291             var out = "if (typeof(_T) == 'undefined') { _T={};}\n"
 292             if (this.target) {
 293                 File.write(this.target, out);
 294             } else {
 295                 this.out += out;
 296             }
 297
 298
 299
 300             File.write(this.translateJSON, "");
 301             for(var i=0; i < this.files.length; i++)  {
 302                 var file = this.files[i];
 303                 var transfile= this.tmpDir + '/' +file.replace(/\//g, '.') +'.lang.trans';
 304                 var transmd5 = this.tmpDir  + '/' +file.replace(/\//g, '.') +'.lang';
 305                 if (File.exists(transmd5)) {
 306                     var str = File.read(transmd5);
 307                     if (str.length) {
 308                         if (this.target) {
 309                             File.append(this.target, str + "\n");
 310                         } else {
 311                             this.out += str + "\n";
 312                         }
 313
 314                     }
 315                     if (this.cleanup) {
 316                         File.remove(transmd5);
 317                     }
 318                 }
 319                 if (File.exists(transfile)) {
 320                     var str = File.read(transfile);
 321                     if (str.length) {
 322                         File.append(this.translateJSON, str);
 323                     }
 324                     if (this.cleanup) {
 325                         File.remove(transfile);
 326                     }
 327                 }
 328
 329
 330             }
 331         }
 332
 333         print("MERGING SOURCE");
 334
 335         for(var i=0; i < this.files.length; i++)  {
 336             var file = this.files[i];
 337             var minfile = this.tmpDir + '/' + file.replace(/\//g, '.');
 338
 339
 340             if (!File.exists(minfile)) {
 341                 continue;
 342             }
 343             var str = File.read(minfile);
 344             print("using MIN FILE  "+ minfile);
 345             if (str.length) {
 346                 if (this.target) {
 347                     File.append(this.target, str + "\n");
 348                 } else {
 349                     this.out += str + "\n";
 350                 }
 351
 352             }
 353             if (this.cleanup) {
 354                 File.remove(minfile);
 355             }
 356
 357         }
 358         print("Output file: " + this.target);
 359         if (this.debugTarget) print("Output debug file: " + this.debugTarget);
 360
 361
 362
 363
 364     },
 365     /**
 366      * Core packing routine  for a file
 367      *
 368      * @param str - str source text..
 369      * @param fn - filename (for reference?)
 370      * @param minfile - min file location...
 371      *
 372      */
 373
 374     pack : function (str,fn,minfile)
 375     {
 376
 377         var tr = new  TokenReader(  {
 378             keepDocs :true,
 379             keepWhite : true,
 380             keepComments : true,
 381             sepIdents : true,
 382             collapseWhite : false,
 383             filename : fn
 384         });
 385         this.timerPrint("START" + fn);
 386
 387         // we can load translation map here...
 388
 389         var toks = tr.tokenize(new TextStream(str)); // dont merge xxx + . + yyyy etc.
 390
 391         // at this point we can write a language file...
 392         if (this.translateJSON) {
 393
 394             this.writeTranslateFile(fn, minfile, toks);
 395         }
 396
 397         this.activeFile = fn;
 398
 399         // and replace if we are generating a different language..
 400
 401         this.timerPrint("Tokenized");
 402         //var ts = new TokenStream(toks);
 403         //print(JSON.stringify(toks, null,4 )); Seed.quit();
 404         var ts = new Collapse(toks);
 405        // print(JSON.stringify(ts.tokens, null,4 )); Seed.quit();
 406         //return;//
 407         var sp = new ScopeParser(ts);
 408         this.timerPrint("Converted to Parser");
 409         sp.packer = this;
 410         sp.buildSymbolTree();
 411         this.timerPrint("Built Sym tree");
 412         sp.mungeSymboltree();
 413         this.timerPrint("Munged Sym tree");
 414         print(sp.warnings.join("\n"));
 415
 416
 417         var out = CompressWhite(new TokenStream(toks), this, this.keepWhite); // do not kill whitespace..
 418
 419
 420         this.timerPrint("Compressed");
 421         return out;
 422
 423
 424
 425     },
 426
 427     timerPrint: function (str) {
 428         var ntime = new Date() * 1;
 429         var tdif =  ntime -this.timer;
 430         this.timer = ntime;
 431         print('['+tdif+']'+str);
 432     },
 433
 434     /**
 435      *
 436      * Translation concept...
 437      * -> replace text strings with _T....
 438      * -> this file will need inserting at the start of the application....
 439      * -> we need to generate 2 files,
 440      * -> a reference used to do the translation, and the _T file..
 441      *
 442      */
 443
 444     writeTranslateFile : function(fn, minfile, toks)
 445     {
 446
 447         var map = {};
 448         var _this = this;
 449         toks.forEach(function (t) {
 450             if (t.type == 'STRN' && t.name == 'DOUBLE_QUOTE') {
 451                 var sval = t.data.substring(1,t.data.length-1);
 452                 var ffn = fn.substring(_this.prefix.length);
 453                 map[sval] = _this.md5(ffn + '-' + sval);
 454             }
 455         })
 456
 457         var transfile = minfile + '.lang.trans';
 458         var transmd5 = minfile + '.lang';
 459         print("writeTranslateFile "  + transfile);
 460         var i = 0;
 461         var v = '';
 462         if (File.exists(transfile)) {
 463             File.remove(transfile);
 464         }
 465         if (File.exists(transmd5)) {
 466             File.remove(transmd5);
 467         }
 468         for(v in map) { i++; break };
 469         if (!i ) {
 470             return; // no strings in file...
 471         }
 472         var ffn = fn.substring(this.prefix.length);
 473
 474
 475         File.write(transfile, "\n'" + ffn  + "' : {");
 476         var l = '';
 477         var _tout = {}
 478
 479         File.write(transmd5, '');
 480         for(v in map) {
 481             if (!v.length) {
 482                 continue;
 483             }
 484             File.append(transfile, l + "\n\t" + JSON.stringify(v) + " : " + JSON.stringify(v));
 485             l = ',';
 486             // strings are raw... - as the where encoded to start with!!!
 487             File.append(transmd5, '_T["' + this.md5(ffn + '-' + v) + '"]='+JSON.stringify(v)+";\n");
 488         }
 489         File.append(transfile, "\n},"); // always one trailing..
 490
 491
 492     },
 493     md5 : function (string)
 494     {
 495
 496         return GLib.compute_checksum_for_string(GLib.ChecksumType.MD5, string, string.length);
 497
 498     },
 499     stringHandler : function(tok)
 500     {
 501         //print("STRING HANDLER");
 502        // callback when outputing compressed file,
 503        var data = tok.data;
 504         if (!this.translateJSON) {
 505          //   print("TURNED OFF");
 506             return data;
 507         }
 508         if (tok.name == 'SINGLE_QUOTE') {
 509             return data;
 510         }
 511
 512         var sval = data.substring(1,data.length-1);
 513         // we do not clean up... quoting here!??!!?!?!?!?
 514
 515
 516         // blank with tabs or spaces..
 517         //if (!sval.replace(new RegExp("(\\\\n|\\\\t| )+",'g'), '').length) {
 518        //     return tok.outData;
 519        // }
 520
 521         var sval = tok.data.substring(1,data.length-1);
 522         var fn = this.activeFile.substring(this.prefix.length);
 523
 524
 525         return '_T["' + this.md5(fn + '-' + sval) + '"]';
 526
 527
 528     }
 529
 530
 531 };