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