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

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