git.roojs.org Git - roojs1/blob - Roo/XTemplate.js

   1 /*
   2  * Based on:
   3  * Ext JS Library 1.1.1
   4  * Copyright(c) 2006-2007, Ext JS, LLC.
   5  *
   6  * Originally Released Under LGPL - original licence link has changed is not relivant.
   7  *
   8  * Fork - LGPL
   9  * <script type="text/javascript">
  10  */
  11
  12
  13 /**
  14  * @class Roo.XTemplate
  15  * @extends Roo.Template
  16  * Provides a template that can have nested templates for loops or conditionals. The syntax is:
  17 <pre><code>
  18 var t = new Roo.XTemplate(
  19         '&lt;select name="{name}"&gt;',
  20                 '&lt;tpl for="options"&gt;&lt;option value="{value:trim}"&gt;{text:ellipsis(10)}&lt;/option&gt;&lt;/tpl&gt;',
  21         '&lt;/select&gt;'
  22 );
  23
  24 // then append, applying the master template values
  25  </code></pre>
  26  *
  27  * Supported features:
  28  *
  29  *  Tags:
  30  *    {a_variable} - output encoded.
  31  *    {a_variable.format:("Y-m-d")} - call a method on the variable
  32  *    {a_variable:raw} - unencoded output
  33  *    {a_variable:toFixed(1,2)} - Roo.util.Format."toFixed"
  34  *    {a_variable:this.method_on_template(...)} - call a method on the template object.
  35  *
  36  *  Tpl:
  37  *      &lt;tpl for="a_variable or condition.."&gt;&lt;/tpl&gt;
  38  *      &lt;tpl if="a_variable or condition"&gt;&lt;/tpl&gt;
  39  *      &lt;tpl exec="some javascript"&gt;&lt;/tpl&gt;
  40  *
  41  *      &lt;tpl for="."&gt;&lt;/tpl&gt; - just iterate the property..
  42  *      &lt;tpl for=".."&gt;&lt;/tpl&gt; - iterates with the parent (probably the template)
  43  *
  44  *
  45  */
  46 Roo.XTemplate = function()
  47 {
  48     Roo.XTemplate.superclass.constructor.apply(this, arguments);
  49     if (this.html) {
  50         this.compile();
  51     }
  52 };
  53
  54
  55 Roo.extend(Roo.XTemplate, Roo.Template, {
  56
  57     /**
  58      *
  59      * basic tag replacing syntax
  60      * WORD:WORD()
  61      *
  62      * // you can fake an object call by doing this
  63      *  x.t:(test,tesT)
  64      *
  65      */
  66     re : /\{([\w-\.]+)(?:\:([\w\.]*)(?:\((.*?)?\))?)?\}/g,
  67
  68     /**
  69      * compile the template
  70      *
  71      * This is not recursive, so I'm not sure how nested templates are really going to be handled..
  72      *
  73      */
  74     compile: function()
  75     {
  76         var s = this.html;
  77
  78         s = ['<tpl>', s, '</tpl>'].join('');
  79
  80         var re     = /<tpl\b[^>]*>((?:(?=([^<]+))\2|<(?!tpl\b[^>]*>))*?)<\/tpl>/,
  81             nameRe = /^<tpl\b[^>]*?for="(.*?)"/,
  82             ifRe   = /^<tpl\b[^>]*?if="(.*?)"/,
  83             execRe = /^<tpl\b[^>]*?exec="(.*?)"/,
  84             namedRe = /^<tpl\b[^>]*?name="(\w+)"/,  // named templates..
  85             m,
  86             id     = 0,
  87             tpls   = [];
  88
  89         while(true == !!(m = s.match(re))){
  90             var forMatch   = m[0].match(nameRe),
  91                 ifMatch   = m[0].match(ifRe),
  92                 execMatch   = m[0].match(execRe),
  93                 namedMatch   = m[0].match(namedRe),
  94
  95                 exp  = null,
  96                 fn   = null,
  97                 exec = null,
  98                 name = forMatch && forMatch[1] ? forMatch[1] : '';
  99
 100             if (ifMatch) {
 101                 // if - puts fn into test..
 102                 exp = ifMatch && ifMatch[1] ? ifMatch[1] : null;
 103                 if(exp){
 104                    fn = new Function('values', 'parent', 'with(values){ return '+(Roo.util.Format.htmlDecode(exp))+'; }');
 105                 }
 106             }
 107
 108             if (execMatch) {
 109                 // exec - calls a function... returns empty if true is  returned.
 110                 exp = execMatch && execMatch[1] ? execMatch[1] : null;
 111                 if(exp){
 112                    exec = new Function('values', 'parent', 'with(values){ '+(Roo.util.Format.htmlDecode(exp))+'; }');
 113                 }
 114             }
 115
 116
 117             if (name) {
 118                 // for =
 119                 switch(name){
 120                     case '.':  name = new Function('values', 'parent', 'with(values){ return values; }'); break;
 121                     case '..': name = new Function('values', 'parent', 'with(values){ return parent; }'); break;
 122                     default:   name = new Function('values', 'parent', 'with(values){ return '+name+'; }');
 123                 }
 124             }
 125             var uid = namedMatch ? namedMatch[1] : id;
 126
 127
 128             tpls[uid] = {
 129                 id:     namedMatch ? namedMatch[1] : id,
 130                 target: name,
 131                 exec:   exec,
 132                 test:   fn,
 133                 body:   m[1] || ''
 134             };
 135             if (namedMatch) {
 136                 s = s.replace(m[0], '');
 137             } else {
 138                 s = s.replace(m[0], '{xtpl'+ id + '}');
 139             }
 140             ++id;
 141         }
 142         for(var i = tpls.length-1; i >= 0; --i){
 143             this.compileTpl(tpls[i]);
 144         }
 145         this.master = tpls[tpls.length-1];
 146         this.tpls = tpls;
 147         return this;
 148     },
 149     /**
 150      * same as applyTemplate, except it's done to one of the subTemplates
 151      * @param {Number} id of the template
 152      * @param {Object} values to apply to template
 153      * @param {Object} parent (normaly the instance of this object)
 154      */
 155     applySubTemplate : function(id, values, parent)
 156     {
 157         var t = this.tpls[id];
 158         try {
 159             if(t.test && !t.test.call(this, values, parent)){
 160                 return '';
 161             }
 162         } catch(e) {
 163             Roo.log("Xtemplate.applySubTemplate 'test': Exception thrown");
 164             Roo.log(e.toString());
 165             Roo.log(t.test);
 166             return ''
 167         }
 168         try {
 169
 170             if(t.exec && t.exec.call(this, values, parent)){
 171                 return '';
 172             }
 173         } catch(e) {
 174             Roo.log("Xtemplate.applySubTemplate 'exec': Exception thrown");
 175             Roo.log(e.toString());
 176             Roo.log(t.exec);
 177             return ''
 178         }
 179         try {
 180             var vs = t.target ? t.target.call(this, values, parent) : values;
 181             parent = t.target ? values : parent;
 182             if(t.target && vs instanceof Array){
 183                 var buf = [];
 184                 for(var i = 0, len = vs.length; i < len; i++){
 185                     buf[buf.length] = t.compiled.call(this, vs[i], parent);
 186                 }
 187                 return buf.join('');
 188             }
 189             return t.compiled.call(this, vs, parent);
 190         } catch (e) {
 191             Roo.log("Xtemplate.applySubTemplate : Exception thrown");
 192             Roo.log(e.toString());
 193             Roo.log(t.compiled);
 194             return '';
 195         }
 196     },
 197
 198     compileTpl : function(tpl)
 199     {
 200         var fm = Roo.util.Format;
 201         var useF = this.disableFormats !== true;
 202         var sep = Roo.isGecko ? "+" : ",";
 203         var undef = function(str) {
 204             Roo.log("Property not found :"  + str);
 205             return '';
 206         };
 207
 208         var fn = function(m, name, format, args)
 209         {
 210             //Roo.log(arguments);
 211             args = args ? args.replace(/\\'/g,"'") : args;
 212             //["{TEST:(a,b,c)}", "TEST", "", "a,b,c", 0, "{TEST:(a,b,c)}"]
 213             if (typeof(format) == 'undefined') {
 214                 format= 'htmlEncode';
 215             }
 216             if (format == 'raw' ) {
 217                 format = false;
 218             }
 219
 220             if(name.substr(0, 4) == 'xtpl'){
 221                 return "'"+ sep +'this.applySubTemplate('+name.substr(4)+', values, parent)'+sep+"'";
 222             }
 223
 224             // build an array of options to determine if value is undefined..
 225
 226             // basically get 'xxxx.yyyy' then do
 227             // (typeof(xxxx) == 'undefined' || typeof(xxx.yyyy) == 'undefined') ?
 228             //    (function () { Roo.log("Property not found"); return ''; })() :
 229             //    ......
 230
 231             var udef_ar = [];
 232             var lookfor = '';
 233             Roo.each(name.split('.'), function(st) {
 234                 lookfor += (lookfor.length ? '.': '') + st;
 235                 udef_ar.push(  "(typeof(" + lookfor + ") == 'undefined')"  );
 236             });
 237
 238             var udef_st = '((' + udef_ar.join(" || ") +") ? undef('" + name + "') : "; // .. needs )
 239
 240
 241             if(format && useF){
 242
 243                 args = args ? ',' + args : "";
 244
 245                 if(format.substr(0, 5) != "this."){
 246                     format = "fm." + format + '(';
 247                 }else{
 248                     format = 'this.call("'+ format.substr(5) + '", ';
 249                     args = ", values";
 250                 }
 251
 252                 return "'"+ sep +   udef_st   +    format + name + args + "))"+sep+"'";
 253             }
 254
 255             if (args.length) {
 256                 // called with xxyx.yuu:(test,test)
 257                 // change to ()
 258                 return "'"+ sep + udef_st  + name + '(' +  args + "))"+sep+"'";
 259             }
 260             // raw.. - :raw modifier..
 261             return "'"+ sep + udef_st  + name + ")"+sep+"'";
 262
 263         };
 264         var body;
 265         // branched to use + in gecko and [].join() in others
 266         if(Roo.isGecko){
 267             body = "tpl.compiled = function(values, parent){  with(values) { return '" +
 268                    tpl.body.replace(/(\r\n|\n)/g, '\\n').replace(/'/g, "\\'").replace(this.re, fn) +
 269                     "';};};";
 270         }else{
 271             body = ["tpl.compiled = function(values, parent){  with (values) { return ['"];
 272             body.push(tpl.body.replace(/(\r\n|\n)/g,
 273                             '\\n').replace(/'/g, "\\'").replace(this.re, fn));
 274             body.push("'].join('');};};");
 275             body = body.join('');
 276         }
 277
 278         Roo.debug && Roo.log(body.replace(/\\n/,'\n'));
 279
 280         /** eval:var:zzzzzzz */
 281         eval(body);
 282
 283         return this;
 284     },
 285
 286     applyTemplate : function(values){
 287         return this.master.compiled.call(this, values, {});
 288         //var s = this.subs;
 289     },
 290
 291     apply : function(){
 292         return this.applyTemplate.apply(this, arguments);
 293     }
 294
 295  });
 296
 297 Roo.XTemplate.from = function(el){
 298     el = Roo.getDom(el);
 299     return new Roo.XTemplate(el.value || el.innerHTML);
 300 };