git.roojs.org Git - gnome.introspection-doc-generator/blob - JSDOC/Packer.js

   1 // <script type="text/javascript">
   2 XObject         = imports.XObject.XObject;
   3 File            = imports.File.File;
   4
   5 TokenReader     = imports['JSDOC/TokenReader.js'].TokenReader;
   6 ScopeParser     = imports['JSDOC/ScopeParser.js'].ScopeParser;
   7 TokenStream     = imports['JSDOC/TokenStream.js'].TokenStream;
   8 CompressWhite   = imports['JSDOC/CompressWhite.js'].CompressWhite;
   9
  10 GLib = imports.gi.GLib;
  11 /**
  12  * @namespace JSDOC
  13  * @class  Packer
  14  * Create a new packer
  15  *
  16  * Use with pack.js
  17  *
  18  *
  19  * Usage:
  20  * <code>
  21  *
  22 Packer = imports['JSDOC/Packer.js'].Packer;
  23 var x = new  Packer({
  24
  25     files : [ "/location/of/file1.js", "/location/of/file2.js", ... ],
  26     target : "/tmp/output.js",
  27     debugTarget : "/tmp/output.debug.js", // merged file without compression.
  28     translateJson : "/tmp/translate.json",
  29
  30
  31 );
  32 x.packFiles(
  33     "/location/of/temp_batch_dir",
  34     "/location/of/output-compacted-file.js",
  35     "/location/of/output-debug-merged-file.js"
  36 );
  37
  38  *</code>
  39  *
  40  * Notes for improving compacting:
  41  *  if you add a jsdoc comment
  42  * <code>
  43  * /**
  44  *   eval:var:avarname
  45  *   eval:var:bvarname
  46  *   ....
  47  * </code>
  48  * directly before an eval statement, it will compress all the code around the eval,
  49  * and not rename the variables 'avarname'
  50  *
  51  * Dont try running this on a merged uncompressed large file - it's used to be horrifically slow. not sure about now..
  52  * Best to use lot's of small classes, and use it to merge, as it will cache the compaction
  53  *
  54  *
  55  *
  56  * Notes for translation
  57  *  - translation relies on you using double quotes for strings if they need translating
  58  *  - single quoted strings are ignored.
  59  *
  60  * Generation of indexFiles
  61  *   - translateIndex = the indexfile
  62  *
  63  *
  64  *
  65  *
  66
  67  */
  68 Packer = function(cfg)
  69 {
  70
  71     XObject.extend(this, cfg);
  72     if (!this.files) {
  73         throw "No Files";
  74     }
  75     if (!this.target) {
  76         throw "No Target";
  77     }
  78     if ((typeof(cfg.tmpDir) != 'undefined') && (!cfg.cleanup)) {
  79         this.cleanup = false; // do not clean up files.. = as tmpdir is set.
  80     }
  81     this.tmpFiles = [];
  82     this.timer =  new Date() * 1;
  83     this.packAll();
  84
  85 }
  86 Packer.prototype = {
  87     /**
  88      * @prop files {Array} list of files to compress (must be full path)
  89      */
  90     files : false,
  91     /**
  92      * @prop target {String} target to write files to - must be full path.
  93      */
  94     target : '',
  95     /**
  96      * @prop debugTarget {String} target to write files debug version to (uncompacted)- must be full path.
  97      */
  98     debugTarget : '', // merged file without compression.
  99     /**
 100      * @prop tmpDir {String} (optional) where to put the temporary files.
 101      *      if you set this, then files will not be cleaned up
 102      */
 103     tmpDir : '/tmp',
 104
 105     translateJson : '', // json based list of strings in all files.
 106
 107     tmpFiles : false, // list of temporary files - cleaned up at end..
 108     /**
 109      * @prop cleanup {Boolean} (optional) clean up temp files after done -
 110      *    Defaults to false if you set tmpDir, otherwise true.
 111      */
 112     cleanup : true, //
 113
 114     packAll : function()  // do the packing (run from constructor)
 115     {
 116
 117         //this.transOrigFile= bpath + '/../lang.en.js'; // needs better naming...
 118         //File.write(this.transfile, "");
 119         File.write(this.target, "");
 120         if (this.debugTarget) {
 121             File.write(this.debugTarget, "");
 122         }
 123
 124         for(var i=0; i < this.files.length; i++)  {
 125             var file = this.files[i];
 126
 127             print("reading " +file );
 128             if (!File.exists(file)) {
 129                 print("SKIP (does not exist) " + file);
 130                 continue;
 131             }
 132
 133             if (this.debugTarget) {
 134                 File.append(this.debugTarget, File.read(files[i]));
 135             }
 136             // it's a good idea to check with 0 compression to see if the code can parse!!
 137
 138             // debug file..
 139             //File.append(dout, str +"\n");
 140
 141
 142
 143             var minfile = this.tmpDir + '/' +files.replace(/\//g, '.');
 144
 145
 146             // let's see if we have a min file already?
 147             // this might happen if tmpDir is set ..
 148             if (true && File.exists(minfile)) {
 149                 var mt = File.mtime(minfile);
 150                 var ot = File.mtime(files);
 151                 print("compare : " + mt + "=>" + ot);
 152                 if (mt >= ot) {
 153                     continue;
 154                     /*
 155                     // then the min'files time is > than original..
 156                     var str = File.read(minfile);
 157                     print("using MIN FILE  "+ minfile);
 158                     if (str.length) {
 159                         File.append(outpath, str + "\n");
 160                     }
 161
 162                     continue;
 163                     */
 164                 }
 165
 166             }
 167
 168             print("COMPRESSING ");
 169             //var codeComp = pack(str, 10, 0, 0);
 170             var str = File.read(files);
 171             var str = this.pack(str, files, minfile);
 172             if (str.length) {
 173                 File.write(minfile, str);
 174                 this.tmpFiles.push(minfile);
 175             }
 176
 177
 178
 179         }
 180         if (this.translateJson) {
 181
 182
 183             print("MERGING LANGUAGE");
 184             File.write(outpath, "if (typeof(_T) == 'undefined') { _T={};}\n");
 185
 186             var transfileAll =  bpath + '/_translation_.js';
 187             File.write(transfileAll, "");
 188             for(var i=0; i < files.length; i++)  {
 189                 var transfile= bpath + '/' +files[i].substr(spath.length+1).replace(/\//g, '.') +'.lang.trans';
 190                 var transmd5 = bpath + '/' +files[i].substr(spath.length+1).replace(/\//g, '.') +'.lang';
 191                 if (File.exists(transmd5)) {
 192                     var str = File.read(transmd5);
 193                     if (str.length) {
 194                         File.append(outpath, str + "\n");
 195                     }
 196                 }
 197                 if (File.exists(transfile)) {
 198                     var str = File.read(transfile);
 199                     if (str.length) {
 200                         File.append(transfileAll, str);
 201                     }
 202                 }
 203
 204
 205             }
 206         }
 207         print("MERGING SOURCE");
 208
 209         for(var i=0; i < files.length; i++)  {
 210
 211             var minfile = bpath + '/' +files[i].substr(spath.length+1).replace(/\//g, '.');
 212             if (!File.exists(minfile)) {
 213                 continue;
 214             }
 215             var str = File.read(minfile);
 216             print("using MIN FILE  "+ minfile);
 217             if (str.length) {
 218                 File.append(outpath, str + "\n");
 219             }
 220         }
 221
 222
 223         //File.append(dout, "\n");// end the function
 224
 225
 226
 227     },
 228     /**
 229      * Core packing routine  for a file
 230      *
 231      * @param str - str source text..
 232      * @param fn - filename (for reference?)
 233      * @param minfile - min file location...
 234      *
 235      */
 236
 237     pack : function (str,fn,minfile)
 238     {
 239
 240         var tr = new  TokenReader();
 241         this.timerPrint("START" + fn);
 242
 243         // we can load translation map here...
 244
 245         var toks = tr.tokenize(str,false); // dont merge xxx + . + yyyy etc.
 246
 247         // at this point we can write a language file...
 248         if (this.translate) {
 249             this.writeTranslateFile(fn, minfile, tr.translateMap);
 250         }
 251
 252         this.activeFile = fn;
 253
 254         // and replace if we are generating a different language..
 255
 256
 257
 258
 259         this.timerPrint("Tokenized");
 260         //return;//
 261         var sp = new ScopeParser(new TokenStream(toks, str.length));
 262         this.timerPrint("Converted to Parser");
 263         sp.packer = this;
 264         sp.buildSymbolTree();
 265         this.timerPrint("Built Sym tree");
 266         sp.mungeSymboltree();
 267         this.timerPrint("Munged Sym tree");
 268         print(sp.warnings.join("\n"));
 269         var out = JSDOC.CompressWhite(sp.ts, this);
 270         this.timerPrint("Compressed");
 271         return out;
 272
 273     },
 274
 275     timerPrint: function (str) {
 276         var ntime = new Date() * 1;
 277         var tdif =  ntime -this.timer;
 278         this.timer = ntime;
 279         print('['+tdif+']'+str);
 280     },
 281
 282     /**
 283      *
 284      * Translation concept...
 285      * -> replace text strings with _T....
 286      * -> this file will need inserting at the start of the application....
 287      * -> we need to generate 2 files,
 288      * -> a reference used to do the translation, and the _T file..
 289      *
 290      */
 291
 292     writeTranslateFile : function(fn, minfile, map)
 293     {
 294         var transfile = minfile + '.lang.trans';
 295         var transmd5 = minfile + '.lang';
 296         var i = 0;
 297         var v = '';
 298         if (File.exists(transfile)) {
 299             File.remove(transfile);
 300         }
 301         if (File.exists(transmd5)) {
 302             File.remove(transmd5);
 303         }
 304         for(v in map) { i++; break };
 305         if (!i ) {
 306             return; // no strings in file...
 307         }
 308         var ff = fn.split('/');
 309         var ffn = ff[ff.length-1];
 310
 311
 312         File.write(transfile, "\n" + ffn.toSource() + " : {");
 313         var l = '';
 314         var _tout = {}
 315
 316         File.write(transmd5, '');
 317         for(v in map) {
 318             File.append(transfile, l + "\n\t \"" + v + '" : "' + v + '"');
 319             l = ',';
 320             // strings are raw... - as the where encoded to start with!!!
 321             File.append(transmd5, '_T["' + this.md5(ffn + '-' + v) + '"]="'+v+"\";\n");
 322         }
 323         File.append(transfile, "\n},"); // always one trailing..
 324
 325
 326     },
 327     md5 : function (string)
 328     {
 329
 330         return GLib.compute_checksum_for_string(GLib.ChecksumType.MD5, string, string.length);
 331
 332     },
 333     stringHandler : function(tok)
 334     {
 335         //print("STRING HANDLER");
 336        // callback when outputing compressed file,
 337         if (!this.translate) {
 338          //   print("TURNED OFF");
 339             return tok.outData;
 340         }
 341         if (tok.qc != '"') {
 342             return tok.outData;
 343         }
 344         var sval = tok.data.substring(1,tok.data.length-1);
 345         // blank with tabs or spaces..
 346         //if (!sval.replace(new RegExp("(\\\\n|\\\\t| )+",'g'), '').length) {
 347        //     return tok.outData;
 348        // }
 349
 350
 351
 352
 353         var ff = this.activeFile.split('/');
 354         var ffn = ff[ff.length-1];
 355         return '_T["' + this.md5(ffn + '-' + sval) + '"]';
 356
 357
 358     }
 359
 360
 361 };