git.roojs.org Git - roojspacker/blob - src/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
  23 x.pack();  // writes files  etc..
  24
  25  *</code>
  26  *
  27  * Notes for improving compacting:
  28  *  if you add a jsdoc comment
  29  * <code>
  30  * /**
  31  *   eval:var:avarname
  32  *   eval:var:bvarname
  33  *   ....
  34  * </code>
  35  * directly before an eval statement, it will compress all the code around the eval,
  36  * and not rename the variables 'avarname'
  37  *
  38  * Dont try running this on a merged uncompressed large file - it's used to be horrifically slow. not sure about now..
  39  * Best to use lot's of small classes, and use it to merge, as it will cache the compaction
  40  *
  41  *
  42  *
  43  * Notes for translation
  44  *  - translation relies on you using double quotes for strings if they need translating
  45  *  - single quoted strings are ignored.
  46  *
  47  * Generation of indexFiles
  48  *   - translateIndex = the indexfile
  49  *
  50  *
  51  *
  52  *
  53
  54  */
  55 namespace JSDOC
  56 {
  57         public errordomain PackerError {
  58             ArgumentError
  59     }
  60
  61
  62         public class Packer : Object
  63         {
  64                 /**
  65                 * @cfg {String} target to write files to - must be full path.
  66                 */
  67                 string target = "";
  68                 GLib.FileOutputStream targetStream = null;
  69                 /**
  70                  * @cfg {String} debugTarget target to write files debug version to (uncompacted)- must be full path.
  71                  */
  72                 string targetDebug = "";
  73
  74
  75                 GLib.FileOutputStream targetDebugStream  = null;
  76                 /**
  77                  * @cfg {String} tmpDir  (optional) where to put the temporary files.
  78                  *      if you set this, then files will not be cleaned up
  79                  *
  80                  *  at present we need tmpfiles - as we compile multiple files into one.
  81                  *  we could do this in memory now, as I suspect vala will not be as bad as javascript for leakage...
  82                  *
  83                  */
  84                 public string tmpDir = "/tmp";  // FIXME??? in ctor?
  85
  86
  87
  88                 /**
  89                  * @cfg {Boolean} cleanup  (optional) clean up temp files after done -
  90                  *    Defaults to false if you set tmpDir, otherwise true.
  91                  */
  92                 public bool cleanup =  false;
  93
  94
  95                 /**
  96                  * @cfg {Boolean} keepWhite (optional) do not remove white space in output.
  97                  *    usefull for debugging compressed files.
  98                  */
  99
 100                 public bool keepWhite =  false;
 101
 102                 /**
 103                  * @cfg {Boolean} skipScope (optional) skip Scope parsing and replacement.
 104                  *    usefull for debugging...
 105                  */
 106
 107                 public bool skipScope = false;
 108
 109
 110                 /**
 111                  * @cfg {Boolean} dumpTokens (optional) read the first file and dump the tokens.
 112                  *    usefull for debugging...
 113                  */
 114
 115                 public bool dumpTokens = false;
 116
 117                 // list of files to compile...
 118                 Gee.ArrayList<string> files;
 119
 120                 /**
 121                 * @cfg activeFile ??? used???
 122                 */
 123
 124                 public string activeFile = "";
 125
 126
 127                 /**
 128                 * @cfg baseDir -- prefix the files listed in indexfiles with this.
 129                 */
 130
 131                 public string baseDir = "";
 132
 133
 134                 public  string outstr = ""; // if no target is specified - then this will contain the result
 135
 136
 137
 138
 139                 public Packer()
 140                 {
 141 #if HAVE_JSON_GLIB
 142                         this.result = new Json.Object();
 143 #else
 144                         this.result_count = new  Gee.HashMap <string,int>();
 145
 146                         this.result =  new Gee.HashMap<
 147                                 string /* errtype*/ , Gee.HashMap<string /*fn*/,     Gee.HashMap<int /*line*/, Gee.ArrayList<string>>>
 148                         >();
 149
 150 #endif
 151                         this.files = new Gee.ArrayList<string>();
 152
 153                         new Lang_Class(); ///initilizaze lang..
 154
 155                         this.tmp = Glib.make_tmp("ROOPKR");
 156
 157                 }
 158
 159
 160                 // this could be another class really..
 161
 162                 public enum ResultType {
 163                         err ,
 164                         warn;
 165                         public string to_string() {
 166                                 switch(this) {
 167                                         case err: return "ERR";
 168                                         case warn: return "WARN";
 169                                         default: assert_not_reached();
 170                                 }
 171
 172                           }
 173                   }
 174                 /**
 175                 *  result of complication - a JSON object containing warnings / errors etc..
 176                 *  FORMAT:
 177                 *     warn-TOTAL : X  (number of warnings.
 178                 *     err-TOTAL: X  (number of errors) << this indicates failure...
 179                 *     warn : {
 180                 *            FILENAME : {
 181                 *                  line : [ Errors,Errors,.... ]
 182                 *     err : {
 183                 *           .. sane format..
 184                 *
 185                 */
 186
 187 #if HAVE_JSON_GLIB
 188
 189                 public Json.Object result;   // output - what's the complication result
 190
 191                 public void  logError(ResultType type, string filename, int line, string message) {
 192
 193                          if (!this.result.has_member(type.to_string()+"-TOTAL")) {
 194                                  this.result.set_int_member(type.to_string()+"-TOTAL", 1);
 195                          } else {
 196                                 this.result.set_int_member(type.to_string()+"-TOTAL",
 197                                         this.result.get_int_member(type.to_string()+"-TOTAL") +1
 198                                 );
 199                          }
 200
 201
 202                          if (!this.result.has_member(type.to_string())) {
 203                                  this.result.set_object_member(type.to_string(), new Json.Object());
 204                          }
 205                          var t = this.result.get_object_member(type.to_string());
 206                          if (!t.has_member(filename)) {
 207                                  t.set_object_member(filename, new Json.Object());
 208                          }
 209                          var tt = t.get_object_member(filename);
 210                          if (!tt.has_member(line.to_string())) {
 211                                  tt.set_array_member(line.to_string(), new Json.Array());
 212                          }
 213                          var tl = tt.get_array_member(line.to_string());
 214                          tl.add_string_element(message);
 215
 216                 }
 217
 218                 public bool hasErrors(string fn)
 219                 {
 220                          if (!this.result.has_member(ResultType.err.to_string())) {
 221                                  return false;
 222                          }
 223
 224                          if (fn.length < 1) {
 225                                 return true;
 226                          }
 227                          var t = this.result.get_object_member(ResultType.err.to_string());
 228
 229                          if (t.has_member(fn)) {
 230                                  return true;
 231                          }
 232                          return false;
 233                 }
 234                 public void dumpErrors(ResultType type)
 235                 {
 236                          if (!this.result.has_member(type.to_string())) {
 237                                  return;
 238                          }
 239                         var t = this.result.get_object_member(type.to_string());
 240                         t.foreach_member((obj, filename, node) => {
 241                                         var linelist = node.dup_object();
 242                                         linelist.foreach_member((linelistobj, linestr, nodear) => {
 243                                                 var errors=  nodear.dup_array();
 244                                                 errors.foreach_element((errorar, ignore, nodestr) => {
 245                                                         print("%s: %s:%s %s\n", type.to_string(), filename, linestr, nodestr.get_string());
 246                                                 });
 247                                         });
 248
 249                         });
 250                 }
 251 #else
 252                 public Gee.HashMap <string,int> result_count;   // output - what's the complication result
 253
 254                 public Gee.HashMap<
 255                                 string /* errtype*/ , Gee.HashMap<string /*fn*/,     Gee.HashMap<int /*line*/, Gee.ArrayList<string>>>
 256                 > result;
 257
 258                 public void  logError(ResultType type, string filename, int line, string message) {
 259
 260
 261                          if (!this.result_count.has_key(type.to_string()+"-TOTAL")) {
 262                                  this.result_count.set(type.to_string()+"-TOTAL", 1);
 263                          } else {
 264                                 this.result_count.set(type.to_string()+"-TOTAL",
 265                                         this.result_count.get(type.to_string()+"-TOTAL") +1
 266                                 );
 267                          }
 268
 269
 270
 271                          if (!this.result.has_key(type.to_string())) {
 272                                  this.result.set(type.to_string(),
 273                                          new Gee.HashMap<string /*fn*/,     Gee.HashMap<int /*line*/, Gee.ArrayList<string>>>()
 274                                  );
 275                          }
 276                          var t = this.result.get(type.to_string());
 277                          if (!t.has_key(filename)) {
 278                                  t.set(filename, new  Gee.HashMap<int /*line*/, Gee.ArrayList<string>>());
 279                          }
 280                          var tt = t.get(filename);
 281                          if (!tt.has_key(line)) {
 282                                  tt.set(line, new Gee.ArrayList<string>());
 283                          }
 284                          var tl = tt.get(line);
 285                          tl.add(message);
 286
 287                 }
 288
 289                 public bool hasErrors(string fn)
 290                 {
 291                          if (!this.result.has_key(ResultType.err.to_string())) {
 292                                  return false;
 293                          }
 294
 295                          if (fn.length < 1) {
 296                                 return true;
 297                          }
 298                          var t = this.result.get(ResultType.err.to_string());
 299
 300                          if (t.has_key(fn)) {
 301                                  return true;
 302                          }
 303                          return false;
 304                 }
 305                 public void dumpErrors(ResultType type)
 306                 {
 307                          if (!this.result.has_key(type.to_string())) {
 308                                  return;
 309                          }
 310                         var t = this.result.get(type.to_string());
 311                         foreach(string filename in t.keys) {
 312                                 var node = t.get(filename);
 313                                 foreach(int line in node.keys) {
 314                                         var errors = node.get(line);
 315                                         foreach(string errstr in errors) {
 316                                                         print("%s: %s:%d %s\n", type.to_string(), filename, line, errstr);
 317                                         }
 318                                 }
 319
 320                         }
 321                 }
 322
 323
 324 #endif
 325
 326
 327
 328                 public void loadSourceIndexes(Gee.ArrayList<string> indexes)
 329                 {
 330                         foreach(var f in indexes) {
 331                                 this.loadSourceIndex(f);
 332                         }
 333                 }
 334
 335                 public void loadFiles(string[] fs)
 336                 {
 337                         // fixme -- prefix baseDir?
 338                         foreach(var f in fs) {
 339                             GLib.debug("add File: %s", f);
 340                                 this.files.add(f); //?? easier way?
 341                         }
 342                 }
 343                 public void loadFile(string f)
 344                 {
 345                     // fixme -- prefix baseDir?
 346                     GLib.debug("add File: %s", f);
 347                         this.files.add(f);
 348                         GLib.debug("FILE LEN: %d", this.files.size);
 349                 }
 350
 351
 352                 public string pack(string target, string targetDebug = "") throws PackerError
 353                 {
 354                     this.target = target;
 355                         this.targetDebug  = targetDebug;
 356
 357                     if (this.files.size < 1) {
 358                                 throw new PackerError.ArgumentError("No Files loaded before pack() called");
 359                         }
 360                         if (this.target.length > 0 ) {
 361                                 this.targetStream = File.new_for_path(this.target).replace(null, false,FileCreateFlags.NONE);
 362                         }
 363                         if (this.targetDebug.length > 0 ) {
 364                                 this.targetDebugStream = File.new_for_path(this.targetDebug).replace(null, false,FileCreateFlags.NONE);
 365                         }
 366                         return this.packAll();
 367                 }
 368
 369
 370
 371
 372
 373                 /**
 374                  * load a dependancy list -f option
 375                  * @param {String} srcfile sourcefile to parse
 376                  *
 377                  */
 378
 379                 public void loadSourceIndex(string in_srcfile)
 380                 {
 381
 382                     var srcfile = in_srcfile;
 383                     if (srcfile[0] != '/') {
 384                                 srcfile = this.baseDir + in_srcfile;
 385                         }
 386                     string str;
 387                     FileUtils.get_contents(srcfile,out str);
 388
 389                     var lines = str.split("\n");
 390                     for(var i =0; i < lines.length;i++) {
 391
 392                             var f = lines[i].strip();
 393                         if (f.length < 1 ||
 394                                 Regex.match_simple ("^/", f) ||
 395                                 !Regex.match_simple ("[a-zA-Z]+", f)
 396                         ){
 397                                 continue; // blank comment or not starting with a-z
 398                         }
 399
 400                         if (Regex.match_simple ("\\.js$", f)) {
 401                             this.files.add( f);
 402                             // js file..
 403                             continue;
 404                         }
 405
 406                                 // this maps Roo.bootstrap.XXX to Roo/bootstrap/xxx.js
 407                                 // should we prefix? =- or should this be done elsewhere?
 408
 409                         var add = f.replace(".", "/") + ".js";
 410
 411                         if (add[0] != '/') {
 412                                         add = this.baseDir + add;
 413                                 }
 414
 415                         if (this.files.contains(add)) {
 416                             continue;
 417                         }
 418
 419
 420
 421                         this.files.add( add );
 422
 423                     }
 424                 }
 425
 426
 427                 private string packAll()   // do the packing (run from constructor)
 428                 {
 429
 430                     //this.transOrigFile= bpath + '/../lang.en.js'; // needs better naming...
 431                     //File.write(this.transfile, "");
 432                     if (this.target.length > 0) {
 433                         this.targetStream.write("".data);
 434                     }
 435
 436                     if (this.targetDebugStream != null) {
 437                             this.targetDebugStream.write("".data);
 438                     }
 439
 440
 441                     foreach(var file in this.files) {
 442
 443                         print("reading %s\n",file );
 444
 445                         if (!FileUtils.test (file, FileTest.EXISTS) || FileUtils.test (file, FileTest.IS_DIR)) {
 446                             print("SKIP (is not a file) %s\n ", file);
 447                             continue;
 448                         }
 449
 450                                 var loaded_string = false;
 451                                 string file_contents = "";
 452                         // debug Target
 453
 454                         if (this.targetDebugStream !=null) {
 455
 456                                 FileUtils.get_contents(file,out file_contents);
 457                             this.targetDebugStream.write(file_contents.data);
 458                             loaded_string = false;
 459                         }
 460                         // it's a good idea to check with 0 compression to see if the code can parse!!
 461
 462                         // debug file..
 463                         //File.append(dout, str +"\n");
 464
 465
 466
 467                         var minfile = this.tmpDir + "/" + file.replace("/", ".");
 468
 469
 470                         // let's see if we have a min file already?
 471                         // this might happen if tmpDir is set ..
 472
 473
 474                         if ( FileUtils.test (minfile, FileTest.EXISTS)) {
 475
 476                                 var otv = File.new_for_path(file).query_info (FileAttribute.TIME_MODIFIED, 0).get_modification_time();
 477                                 var mtv = File.new_for_path(minfile).query_info (FileAttribute.TIME_MODIFIED, 0).get_modification_time();
 478
 479
 480                            // print("%s : compare : Cache file  %s to Orignal Time %s\n", file, mtv.to_iso8601(), otv.to_iso8601());
 481                             if (mtv.tv_usec > otv.tv_usec) {
 482                                 continue; // file is newer or the same time..
 483
 484                             }
 485
 486                         }
 487
 488                         print("COMPRESSING to %s\n", minfile);
 489                         //var codeComp = pack(str, 10, 0, 0);
 490                         if (this.cleanup && FileUtils.test (minfile, FileTest.EXISTS)) {
 491                             FileUtils.remove(minfile);
 492                         }
 493                         if (!loaded_string) {
 494                                 FileUtils.get_contents(file,out file_contents);
 495                         }
 496
 497                          this.packFile(file_contents, file, minfile);
 498
 499
 500                     }
 501
 502                     // at this point if we have errors, we should stop..
 503
 504
 505                         this.dumpErrors(ResultType.warn);
 506                         this.dumpErrors(ResultType.err); // since they are fatal - display them last...
 507
 508
 509
 510
 511                         if (this.dumpTokens || this.hasErrors("")) {
 512
 513                                 GLib.Process.exit(0);
 514                         }
 515                     print("MERGING SOURCE\n");
 516
 517                     for(var i=0; i < this.files.size; i++)  {
 518                         var file = this.files[i];
 519                         var minfile = this.tmpDir + "/" + file.replace("/", ".");
 520
 521
 522                         if ( !FileUtils.test(minfile, FileTest.EXISTS)) {
 523                                 print("skipping source %s - does not exist\n", minfile);
 524                             continue;
 525                         }
 526                         string str;
 527                         FileUtils.get_contents(minfile, out str);
 528                         print("using MIN FILE  %s\n", minfile);
 529                         if (str.length > 0) {
 530                             if (this.targetStream != null) {
 531                                         this.targetStream.write(("// " +
 532                                                 ( (file.length > this.baseDir.length) ? file.substring(this.baseDir.length)  : file ) +
 533                                                 "\n").data);
 534                                         this.targetStream.write((str + "\n").data);
 535
 536                             } else {
 537                                 this.outstr += "//" +
 538                                         ( (file.length > this.baseDir.length) ? file.substring(this.baseDir.length)  : file ) +  "\n";
 539                                 this.outstr += str + "\n";
 540                             }
 541
 542                         }
 543                         if (this.cleanup) {
 544                             FileUtils.remove(minfile);
 545                         }
 546
 547                     }
 548
 549
 550
 551                     if (this.target.length > 0 ) {
 552                             print("Output file: " + this.target);
 553                     }
 554                     if (this.targetDebug.length > 0) {
 555                                  print("Output debug file: %s\n" , this.targetDebug);
 556                         }
 557
 558
 559
 560                         // OUTPUT should be handled by PackerRun (so that this can be used as a library...)
 561                         if (this.outstr.length > 0 ) {
 562                 return this.outstr;
 563                         //      stdout.printf ("%s", this.outstr);
 564                         }
 565                     return "";
 566
 567
 568                 }
 569                 /**
 570                  * Core packing routine  for a file
 571                  *
 572                  * @param str - str source text..
 573                  * @param fn - filename (for reference?)
 574                  * @param minfile - min file location...
 575                  *
 576                  */
 577
 578                 public  string packFile  (string str,string fn, string minfile)
 579                 {
 580
 581                         var tr = new  TokenReader(this);
 582                         tr.keepDocs =true;
 583                         tr.keepWhite = true;
 584                         tr.keepComments = true;
 585                         tr.sepIdents = true;
 586                         tr.collapseWhite = false;
 587                         tr.filename = fn;
 588
 589                         // we can load translation map here...
 590
 591                         TokenArray toks = tr.tokenize(new TextStream(str)); // dont merge xxx + . + yyyy etc.
 592
 593                         if (this.dumpTokens) {
 594                                 toks.dump();
 595                                 return "";
 596                                 //GLib.Process.exit(0);
 597                         }
 598
 599                         this.activeFile = fn;
 600
 601                         // and replace if we are generating a different language..
 602
 603
 604                         //var ts = new TokenStream(toks);
 605                         //print(JSON.stringify(toks, null,4 )); Seed.quit();
 606                         var ts = new Collapse(toks.tokens, this, fn);
 607
 608                         //ts.dumpAll("");                       print("Done collaps"); Process.exit(1);
 609
 610                    // print(JSON.stringify(ts.tokens, null,4 )); Seed.quit();
 611                         //return;//
 612                         if (!this.skipScope) {
 613                                 var sp = new ScopeParser(ts, this, fn);
 614
 615                                 //sp.packer = this;
 616                                 sp.buildSymbolTree();
 617                                 sp.mungeSymboltree();
 618
 619
 620                                 sp.printWarnings();
 621                         }
 622
 623
 624                         //print(sp.warnings.join("\n"));
 625                         //(new TokenStream(toks.tokens)).dumpAll(""); GLib.Process.exit(1);
 626                         // compress works on the original array - in theory the replacements have already been done by now
 627                         var outf = CompressWhite(new TokenStream(toks.tokens), this, this.keepWhite); // do not kill whitespace..
 628
 629
 630                         debug("RESULT: \n %s\n", outf);
 631
 632
 633
 634                         if (outf.length > 0 && minfile.length > 0 && !this.hasErrors(fn)) {
 635                                 FileUtils.set_contents(minfile, outf);
 636
 637                         }
 638
 639
 640                         return outf;
 641
 642
 643
 644                 }
 645
 646
 647                 public string md5(string str)
 648                 {
 649
 650                         return GLib.Checksum.compute_for_string(GLib.ChecksumType.MD5, str);
 651
 652                 }
 653
 654          //stringHandler : function(tok) -- not used...
 655     }
 656
 657 }