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