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