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  *      <tpl for="a_variable or condition.."></tpl>
38  *      <tpl if="a_variable or condition"></tpl>
39  *      <tpl exec="some javascript"></tpl>
40  *
41  *      <tpl for="."></tpl> - just iterate the property..
42  *      <tpl for=".."></tpl> - iterates witht 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         if(t.test && !t.test.call(this, values, parent)){
136             return '';
137         }
138         if(t.exec && t.exec.call(this, values, parent)){
139             return '';
140         }
141         var vs = t.target ? t.target.call(this, values, parent) : values;
142         parent = t.target ? values : parent;
143         if(t.target && vs instanceof Array){
144             var buf = [];
145             for(var i = 0, len = vs.length; i < len; i++){
146                 buf[buf.length] = t.compiled.call(this, vs[i], parent);
147             }
148             return buf.join('');
149         }
150         return t.compiled.call(this, vs, parent);
151     },
152
153     compileTpl : function(tpl)
154     {
155         var fm = Roo.util.Format;
156         var useF = this.disableFormats !== true;
157         var sep = Roo.isGecko ? "+" : ",";
158         var fn = function(m, name, format, args){
159             //["{TEST:(a,b,c)}", "TEST", "", "a,b,c", 0, "{TEST:(a,b,c)}"]
160             if (typeof(format) == 'undefined') {
161                 format= 'htmlEncode';
162             }
163             if (format == 'raw' ) {
164                 format = false;
165             }
166             
167             if(name.substr(0, 4) == 'xtpl'){
168                 return "'"+ sep +'this.applySubTemplate('+name.substr(4)+', values, parent)'+sep+"'";
169             }
170             
171             var v;
172             //if(name.indexOf('.') != -1){
173                 v = name;
174             //}else{
175             //    v = "values['" + name + "']";
176             //}
177             if(format && useF){
178                 
179                 args = args ? ',' + args : "";
180                  
181                 if(format.substr(0, 5) != "this."){
182                     format = "fm." + format + '(';
183                 }else{
184                     format = 'this.call("'+ format.substr(5) + '", ';
185                     args = ", values";
186                 }
187                 return "'"+ sep + format + v + args + ")"+sep+"'";
188             }
189              
190             if (args.length) {
191                 // called with xxyx.yuu:(test,test)
192                 // change to ()
193                 return "'"+ sep + "("+v+" === undefined ? '' : " + v + '(' +  args + "))"+sep+"'";
194             }
195             // raw.. - :raw modifier..
196             return "'"+ sep + "("+v+" === undefined ? '' : " + v + ")"+sep+"'";
197             
198         };
199         var body;
200         // branched to use + in gecko and [].join() in others
201         if(Roo.isGecko){
202             body = "tpl.compiled = function(values, parent){ with(values) { return '" +
203                    tpl.body.replace(/(\r\n|\n)/g, '\\n').replace(/'/g, "\\'").replace(this.re, fn) +
204                     "';};};";
205         }else{
206             body = ["tpl.compiled = function(values, parent){ with (values) { return ['"];
207             body.push(tpl.body.replace(/(\r\n|\n)/g, '\\n').replace(/'/g, "\\'").replace(this.re, fn));
208             body.push("'].join('');};};");
209             body = body.join('');
210         }
211         
212         /** eval:var:zzzzzzz */
213         eval(body);
214         Roo.log(body.replace(/\\n/,'\n'));
215         
216         return this;
217     },
218
219     applyTemplate : function(values){
220         return this.master.compiled.call(this, values, {});
221         //var s = this.subs;
222     },
223
224     apply : function(){
225         return this.applyTemplate.apply(this, arguments);
226     }
227
228  });
229
230 Roo.XTemplate.from = function(el){
231     el = Roo.getDom(el);
232     return new Roo.XTemplate(el.value || el.innerHTML);
233 };