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