Roo/XTemplate.js
[roojs1] / 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.MasterTemplate(
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: function()
70     {
71         var s = this.html;
72      
73         s = ['<tpl>', s, '</tpl>'].join('');
74     
75         var re     = /<tpl\b[^>]*>((?:(?=([^<]+))\2|<(?!tpl\b[^>]*>))*?)<\/tpl>/,
76             nameRe = /^<tpl\b[^>]*?for="(.*?)"/,
77             ifRe   = /^<tpl\b[^>]*?if="(.*?)"/,
78             execRe = /^<tpl\b[^>]*?exec="(.*?)"/,
79             m,
80             id     = 0,
81             tpls   = [];
82     
83         while(true == !!(m = s.match(re))){
84             var m2   = m[0].match(nameRe),
85                 m3   = m[0].match(ifRe),
86                 m4   = m[0].match(execRe),
87                 exp  = null, 
88                 fn   = null,
89                 exec = null,
90                 name = m2 && m2[1] ? m2[1] : '';
91                 
92             if (m3) {
93                 // if - puts fn into test..
94                 exp = m3 && m3[1] ? m3[1] : null;
95                 if(exp){
96                    fn = new Function('values', 'parent', 'with(values){ return '+(Roo.util.Format.htmlDecode(exp))+'; }');
97                 }
98             }
99             if (m4) {
100                 // exec - calls a function... returns empty if true is  returned.
101                 exp = m4 && m4[1] ? m4[1] : null;
102                 if(exp){
103                    exec = new Function('values', 'parent', 'with(values){ '+(Roo.util.Format.htmlDecode(exp))+'; }');
104                 }
105             }
106             if (name) {
107                 // for = 
108                 switch(name){
109                     case '.':  name = new Function('values', 'parent', 'with(values){ return values; }'); break;
110                     case '..': name = new Function('values', 'parent', 'with(values){ return parent; }'); break;
111                     default:   name = new Function('values', 'parent', 'with(values){ return '+name+'; }');
112                 }
113             }
114             tpls.push({
115                 id:     id,
116                 target: name,
117                 exec:   exec,
118                 test:   fn,
119                 body:   m[1] || ''
120             });
121             s = s.replace(m[0], '{xtpl'+ id + '}');
122             ++id;
123         }
124         for(var i = tpls.length-1; i >= 0; --i){
125             this.compileTpl(tpls[i]);
126         }
127         this.master = tpls[tpls.length-1];
128         this.tpls = tpls;
129         return this;
130     },
131     
132     applySubTemplate : function(id, values, parent)
133     {
134         var t = this.tpls[id];
135         try { 
136             if(t.test && !t.test.call(this, values, parent)){
137                 return '';
138             }
139             if(t.exec && t.exec.call(this, values, parent)){
140                 return '';
141             }
142             var vs = t.target ? t.target.call(this, values, parent) : values;
143             parent = t.target ? values : parent;
144             if(t.target && vs instanceof Array){
145                 var buf = [];
146                 for(var i = 0, len = vs.length; i < len; i++){
147                     buf[buf.length] = t.compiled.call(this, vs[i], parent);
148                 }
149                 return buf.join('');
150             }
151             return t.compiled.call(this, vs, parent);
152         } catch (e) {
153             Roo.log("Xtemplate.applySubTemplate : Exception thrown");
154             Roo.log(e.toString());
155             Roo.log(e);
156             Roo.log(t);
157             return '';
158         }
159     },
160
161     compileTpl : function(tpl)
162     {
163         var fm = Roo.util.Format;
164         var useF = this.disableFormats !== true;
165         var sep = Roo.isGecko ? "+" : ",";
166         var undef = function(str) {
167             Roo.log("Property not found :"  + str);
168             return '';
169         };
170         
171         var fn = function(m, name, format, args)
172         {
173             Roo.log(arguments);
174             args = args ? args.replace(/\\'/g,"'") : args;
175             //["{TEST:(a,b,c)}", "TEST", "", "a,b,c", 0, "{TEST:(a,b,c)}"]
176             if (typeof(format) == 'undefined') {
177                 format= 'htmlEncode';
178             }
179             if (format == 'raw' ) {
180                 format = false;
181             }
182             
183             if(name.substr(0, 4) == 'xtpl'){
184                 return "'"+ sep +'this.applySubTemplate('+name.substr(4)+', values, parent)'+sep+"'";
185             }
186             
187             // build an array of options to determine if value is undefined..
188             
189             // basically get 'xxxx.yyyy' then do
190             // (typeof(xxxx) == 'undefined' || typeof(xxx.yyyy) == 'undefined') ?
191             //    (function () { Roo.log("Property not found"); return ''; })() :
192             //    ......
193             
194             var udef_ar = [];
195             var lookfor = '';
196             Roo.each(name.split('.'), function(st) {
197                 lookfor += lookfor.length ? '.': '';
198                 udef_ar.push(  "(typeof(" + lookfor + ") == 'undefined')"  );
199             });
200             
201             var udef_st = '(' + udef_ar.join(" || ") +')';
202             
203             
204             if(format && useF){
205                 
206                 args = args ? ',' + args : "";
207                  
208                 if(format.substr(0, 5) != "this."){
209                     format = "fm." + format + '(';
210                 }else{
211                     format = 'this.call("'+ format.substr(5) + '", ';
212                     args = ", values";
213                 }
214                 
215                 return "'"+ sep +        format + name + args + ")"+sep+"'";
216             }
217              
218             if (args.length) {
219                 // called with xxyx.yuu:(test,test)
220                 // change to ()
221                 return "'"+ sep + "("+v+" === undefined ? '' : " + name + '(' +  args + "))"+sep+"'";
222             }
223             // raw.. - :raw modifier..
224             return "'"+ sep + "("+v+" === undefined ? '' : " + name + ")"+sep+"'";
225             
226         };
227         var body;
228         // branched to use + in gecko and [].join() in others
229         if(Roo.isGecko){
230             body = "tpl.compiled = function(values, parent){ Roo.log(values); with(values) { return '" +
231                    tpl.body.replace(/(\r\n|\n)/g, '\\n').replace(/'/g, "\\'").replace(this.re, fn) +
232                     "';};};";
233         }else{
234             body = ["tpl.compiled = function(values, parent){ Roo.log(values); with (values) { return ['"];
235             body.push(tpl.body.replace(/(\r\n|\n)/g,
236                             '\\n').replace(/'/g, "\\'").replace(this.re, fn));
237             body.push("'].join('');};};");
238             body = body.join('');
239         }
240         
241         Roo.log(body.replace(/\\n/,'\n'));
242        
243         /** eval:var:zzzzzzz */
244         eval(body);
245         
246         return this;
247     },
248
249     applyTemplate : function(values){
250         return this.master.compiled.call(this, values, {});
251         //var s = this.subs;
252     },
253
254     apply : function(){
255         return this.applyTemplate.apply(this, arguments);
256     }
257
258  });
259
260 Roo.XTemplate.from = function(el){
261     el = Roo.getDom(el);
262     return new Roo.XTemplate(el.value || el.innerHTML);
263 };