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