src/JsRender/Roo.vala
[app.Builder.js] / src / JsRender / Roo.vala
1 /*
2  * Renderer for Javascript output (roo library based)
3  * 
4  * - translation support
5  * -  doubleStringProps contains elements that are 'translable'
6  *    ** in the old method this our compression tool could extract them
7  *  - the  new idea is to make a list at the top of the javascript file
8  *    and output a map...
9  *    
10  * 
11  * 
12  * 
13  * 
14  */
15 namespace JsRender {
16
17     static int rid = 0; 
18    
19     class Roo : JsRender 
20     {
21         string region;
22         bool disabled;
23
24
25         
26         public Roo(Project.Project project, string path) {
27             base( project, path);
28             this.xtype = "Roo";
29              this.language = "js";
30             
31             
32             //this.items = false;
33             //if (cfg.json) {
34             //    var jstr =  JSON.parse(cfg.json);
35             //    this.items = [ jstr ];
36             //    //console.log(cfg.items.length);
37             //    delete cfg.json; // not needed!
38             // }
39             this.modOrder = "001"; /// sequence id that this uses.
40             this.region = "center";
41             this.disabled = false;
42             
43             // super?!?!
44             this.id = "file-roo-%d".printf(rid++);
45             //console.dump(this);
46             // various loader methods..
47
48             string[]  dsp = { "title",
49                 "legend",
50                 "loadingText",
51                 "emptyText",
52                 "qtip",
53                 "value",
54                 "text",
55                 "emptyMsg",
56                 "displayMsg" };
57             for (var i=0;i<dsp.length;i++) {
58                 this.doubleStringProps.add(dsp[i]);
59             }
60
61             
62         }
63     
64     /*    
65         setNSID : function(id)
66         {
67             
68             this.items[0]['|module'] = id;
69        
70             
71         },
72         
73         
74         getType: function() {
75             return 'Roo';
76         },
77
78     */
79                 
80         public   override void   removeFiles() {
81                 var html = GLib.Path.get_dirname(this.path) +"/templates/" + name + ".html";
82                 if (FileUtils.test(html, FileTest.EXISTS)) {
83                         GLib.FileUtils.remove(html);
84                 }
85                 var js = GLib.Path.get_dirname(this.path) +"/" + name + ".html";
86                 if (FileUtils.test(js, FileTest.EXISTS)) {
87                         GLib.FileUtils.remove(js);
88                 }
89         }
90                 
91         public  override void  loadItems() throws GLib.Error // : function(cb, sync) == original was async.
92         {
93             
94              
95                 print("load Items!");
96                 if (this.tree != null) {
97                         return;
98                 }
99                 print("load " + this.path);
100
101                 var pa = new Json.Parser();
102                 pa.load_from_file(this.path);
103                 var node = pa.get_root();
104
105                 if (node.get_node_type () != Json.NodeType.OBJECT) {
106                         throw new Error.INVALID_FORMAT ("Unexpected element type %s", node.type_name ());
107                 }
108                 var obj = node.get_object ();
109         
110         
111                 this.modOrder = this.jsonHasOrEmpty(obj, "modOrder");
112                 this.name = this.jsonHasOrEmpty(obj, "name");
113                 this.parent = this.jsonHasOrEmpty(obj, "parent");
114                 this.permname = this.jsonHasOrEmpty(obj, "permname");
115                 this.title = this.jsonHasOrEmpty(obj, "title");
116                 this.modOrder = this.jsonHasOrEmpty(obj, "modOrder");
117
118                 var bjs_version_str = this.jsonHasOrEmpty(obj, "bjs-version");
119                 bjs_version_str = bjs_version_str == "" ? "1" : bjs_version_str;
120
121                 
122                 // load items[0] ??? into tree...
123                 if (obj.has_member("items") 
124                         && 
125                         obj.get_member("items").get_node_type() == Json.NodeType.ARRAY
126                         &&
127                         obj.get_array_member("items").get_length() > 0
128                 ) {
129                         this.tree = new Node(); 
130                         var ar = obj.get_array_member("items");
131                         var tree_base = ar.get_object_element(0);
132                         this.tree.loadFromJson(tree_base, int.parse(bjs_version_str));
133                 }
134
135
136             
137         }
138         /**
139          * old code had broken xtypes and used arrays differently,
140          * this code should try and clean it up..
141          * 
142          * 
143          * /
144         fixItems : function(node, fixthis)
145         {
146             if (fixthis) {
147                 // fix xtype.
148                 var fn = this.guessName(node);
149                 //print("guessname got " + fn);
150                 if (fn) {
151                     var bits = fn.split('.');
152                     node.xtype = bits.pop();
153                     node['|xns'] = bits.join('.');
154                     
155                 }
156                 // fix array???
157                  
158                 
159             }
160             if (!node.items || !node.items.length) {
161                 return;
162             }
163             var _this = this;
164             var aitems = [];
165             var nitems = [];
166             node.items.forEach(function(i) {
167                 
168                 
169                 
170                 _this.fixItems(i, true);
171                 if (i.xtype == 'Array') {
172                     aitems.push(i);
173                     return;
174                 }    
175                 nitems.push(i);
176             });
177             node.items = nitems; 
178             
179             if (!aitems.length) {
180                 return;
181             }
182             
183             aitems.forEach(function(i) {
184                 
185                 if (!i.items || !i.items.length) {
186                     return;
187                 }
188                 var prop = i['*prop'] + '[]';
189                 // colModel to cm?
190                 i.items.forEach(function(c) {
191                     c['*prop']  = prop;
192                     node.items.push(c);
193                     
194                 });
195                 
196                 
197             });
198             
199             
200             // array handling.. 
201             
202             
203             
204             
205             
206         },
207     */
208         
209         public  override  void save()
210         {
211             
212                 print("--- JsRender.Roo.save");
213                 this.saveBJS();
214
215                 // no tree..
216                 if (this.tree == null) {
217                         return;
218                 }
219                 // now write the js file..
220                 string js;
221                 try {
222                         Regex regex = new Regex("\\.(bjs|js)$");
223
224                         js = regex.replace(this.path,this.path.length , 0 , ".js");
225                 } catch (RegexError e) {
226                         this.name = "???";
227                         print("count not make filename from path");
228                         return;
229                 }
230
231
232                 //var d = new Date();
233                 var js_src = this.toSource();            
234                 //print("TO SOURCE in " + ((new Date()) - d) + "ms");
235                 try {
236                         this.writeFile(js, js_src);            
237                 } catch (FileError e ) {
238                         print("Save failed\n");
239                 }
240                 // for bootstrap - we can write the HTML to the templates directory..
241                  
242             //var top = this.guessName(this.items[0]);
243             //print ("TOP = " + top)
244              
245             
246             
247             
248         }
249
250          
251
252          
253         public override void saveHTML ( string html )
254         {
255                  
256                 var top = this.tree.fqn();
257                 print ("TOP = " + top + "\n" );
258                 if (top.index_of("Roo.bootstrap.") < 0 &&
259                     top.index_of("Roo.mailer.") < 0
260                         ) {
261                         return;
262                 }
263                 
264                 
265 // now write the js file..
266                 string fn;
267                 try {
268                         Regex regex = new Regex("\\.(bjs|js)$");
269
270                         fn = regex.replace(this.path,this.path.length , 0 , ".html");
271                 } catch (RegexError e) {
272                         this.name = "???";
273                         print("count not make filename from path");
274                         return;
275                 }
276                 var bn = GLib.Path.get_basename(fn);
277                 var dn = GLib.Path.get_dirname(fn);
278
279                 var targetdir = dn + (
280                         top.index_of("Roo.mailer.") < 0 ? "/templates" : "" );
281                               
282                 
283                 if (!FileUtils.test(targetdir, FileTest.IS_DIR)) {
284                         print("Skip save - templates folder does not exist : %s\n", targetdir);
285                         return;
286                 }
287                 print("SAVE HTML -- %s\n%s\n",targetdir + "/" +  bn, html);
288                 try {
289                         this.writeFile(targetdir + "/" +  bn , html);            
290                 } catch (FileError e ) {
291                         print("SaveHtml failed\n");
292                 }
293             
294             
295             
296         }
297
298         public Gee.ArrayList<string> findxincludes(Node node,   Gee.ArrayList<string> ret)
299         {
300                 
301                 if (node.props.has_key("* xinclude")) {
302                         ret.add(node.props.get("* xinclude"));
303                 }
304                 for (var i =0; i < node.items.size; i++) {
305                         this.findxincludes(node.items.get(i), ret);
306                 }
307                 return ret;
308                         
309         }
310         Gee.HashMap<string,string> transStrings; // map of md5 -> string..
311
312          
313         public void  findTransStrings(Node node )
314         {
315                 // iterate properties...
316                 // use doubleStringProps
317                 
318                 // flagging a translatable string..
319                 // the code would use string _astring to indicate a translatable string
320                 // the to use it it would do String.format(this._message, somedata);
321                 
322                 // loop through and find string starting with '_' 
323                 
324                 
325                 
326                 var iter = node.props.map_iterator();
327                 while (iter.next()) {
328                         // key formats : XXXX
329                         // XXX - plain
330                         // string XXX - with type
331                         // $ XXX - with flag (no type)
332                         // $ string XXX - with flag
333                         string kname;
334                         string ktype;
335                         string kflag;
336                         node.normalize_key(iter.get_key(), out kname, out ktype, out kflag);
337                         if (kflag == "$") {
338                                 continue;
339                         }
340                         var str = iter.get_value();
341                         if (this.doubleStringProps.index_of(kname) > -1) {
342                                 this.transStrings.set(str,  
343                                         GLib.Checksum.compute_for_string (ChecksumType.MD5, str)
344                                 );
345                                 continue;
346                         }
347                         if (ktype == "string" && kname[0] == '_') {
348                                 this.transStrings.set(str,  
349                                         GLib.Checksum.compute_for_string (ChecksumType.MD5, str)
350                                 );
351                                 continue;
352                         }
353                         
354                 }
355                  
356
357                 
358                 // iterate children..
359                 for (var i =0; i < node.items.size; i++) {
360                         this.findTransStrings(node.items.get(i) );
361                 }
362         
363                         
364         }    
365         /**
366          * javascript used in Webkit preview 
367          */
368         
369         public override string  toSourcePreview()
370         {
371                 print("to source preview\n");
372                 if (this.tree == null) {
373                         return "";
374                 }
375                 var top = this.tree.fqn();
376                 var xinc = new Gee.ArrayList<string>(); 
377
378                 this.findxincludes(this.tree, xinc);
379                 print("got %d xincludes\n", xinc.size);
380                 var prefix_data = "";
381                 if (xinc.size > 0 ) {
382                         for(var i = 0; i < xinc.size; i++) {
383                                 print("check xinclude:  %s\n", xinc.get(i));
384                                 var sf = this.project.getByName(xinc.get(i));
385                                 if (sf == null) {
386                                         print("Failed to find file by name?\n");
387                                         continue;
388                                 }
389
390                                 sf.loadItems();
391                                 var xinc_str = sf.toSource();
392                                 
393                                 //string xinc_str;
394                                 //FileUtils.get_contents(js, out xinc_str);
395                                 prefix_data += "\n" + xinc_str + "\n";
396                                 
397                         }
398
399                 }
400
401                 
402                 
403                 //print(JSON.stringify(this.items, null,4));
404                        
405                 if (top == null) {
406                         print ("guessname returned false");
407                         return "";
408                 }
409
410
411                 if (top.contains("Dialog")) {
412                         return prefix_data + this.toSourceDialog(true);
413                 }
414
415                 if (top.contains("Modal")) {
416                         return prefix_data + this.toSourceModal(true);
417                 }
418
419                 return prefix_data + this.toSourceLayout(true);
420             
421             
422             
423         }
424         
425         /**
426          * This needs to use some options on the project
427          * to determine how the file is output..
428          * 
429          * At present we are hard coding it..
430          * 
431          * 
432          */
433         public override string toSource()
434         {
435             // dump the file tree back out to a string.
436             
437             // we have 2 types = dialogs and components
438             // 
439             this.transStrings = new Gee.HashMap<string,string>();
440                         if (this.tree == null) {
441                                 return "";
442                         }
443             var top = this.tree.fqn();
444             if (top == null) {
445                 return "";
446             }
447             this.findTransStrings(this.root);
448             
449             
450             if (top.contains("Dialog")) {
451                 return this.toSourceDialog(false);
452             }
453             
454             if (top.contains("Modal")) {
455                 return this.toSourceModal(false);
456             }
457             return this.toSourceLayout(false);
458             
459             /*
460             eventually support 'classes??'
461              return this.toSourceStdClass();
462             */
463               
464         }
465        
466         public string outputHeader()
467         {
468                 string[] s = {
469                         "//<script type=\"text/javascript\">",
470                         "",
471                         "// Auto generated file - created by app.Builder.js- do not edit directly (at present!)",
472                         ""
473                    
474                 };  
475                 var ret=  string.joinv("\n",s);
476                 var bits = this.name.split(".");
477                 if (bits.length > 1) {
478                         ret += "\nRoo.namespace(\'" + 
479                                 this.name.substring(0, this.name.length - (bits[bits.length-1].length + 1)) +
480                                 "');\n";
481                                 
482                 }
483                 /// genericlly used..
484                   
485                 return ret;
486             
487        
488         }
489         // a standard dialog module.
490         // fixme - this could be alot neater..
491         public string toSourceDialog(bool isPreview) 
492         {
493             
494             //var items = JSON.parse(JSON.stringify(this.items[0]));
495             
496             
497             var o = this.mungeToString("    ");   
498
499  
500             string[] adda = { " = {",
501                 "",
502                 " dialog : false,",
503                 " callback:  false,",
504                 "",   
505                 " show : function(data, cb)",
506                 " {",
507                 "  if (!this.dialog) {",
508                 "   this.create();",
509                 "  }",
510                 "",
511                 "  this.callback = cb;",
512                 "  this.data = data;",
513                 "  this.dialog.show(this.data._el);",
514                 "  if (this.form) {",
515                 "   this.form.reset();",
516                 "   this.form.setValues(data);",
517                 "   this.form.fireEvent('actioncomplete', this.form,  { type: 'setdata', data: data });",
518                 "  }",
519                 "",   
520                 " },",
521                 "",
522                 " create : function()",
523                 " {",
524                 "   var _this = this;",
525                 "   this.dialog = Roo.factory(" 
526             };
527             string[] addb = {  
528                    ");",
529                 " }",
530                 "};",
531                 ""
532             };
533             return  this.outputHeader() + "\n" +
534                 this.name + string.joinv("\n", adda) + o + string.joinv("\n", addb);
535             
536              
537              
538              
539         }
540         
541         public string toSourceModal(bool isPreview) 
542         {
543             
544             
545             //var items = JSON.parse(JSON.stringify(this.items[0]));
546             var o = this.mungeToString("    ");   
547             
548             string[] adda = { " = {",
549                 "",
550                 " dialog : false,",
551                 " callback:  false,",
552                 "",   
553                 " show : function(data, cb)",
554                 " {",
555                 "  if (!this.dialog) {",
556                 "   this.create();",
557                 "  }",
558                 "",
559                 "  this.callback = cb;",
560                 "  this.data = data;",
561                 "  this.dialog.show(this.data._el);",
562                 "  if (this.form) {",
563                 "   this.form.reset();",
564                 "   this.form.setValues(data);",
565                 "   this.form.fireEvent('actioncomplete', this.form,  { type: 'setdata', data: data });",
566                 "  }",
567                 "",   
568                 " },",
569                 "",
570                 " create : function()",
571                 " {",
572                 "  var _this = this;",
573                 "  this.dialog = Roo.factory("
574             };
575             string[] addb =  {
576                 "  );",
577                 " }",
578                 "};",
579                 ""
580             };
581             return this.outputHeader() + "\n" + 
582                 this.name + string.joinv("\n", adda) + o + string.joinv("\n", addb);
583              
584              
585              
586         }
587         
588         
589         public string   pathToPart()
590         {
591             var dir = Path.get_basename(Path.get_dirname(this.path));
592             var ar = dir.split(".");
593             var modname = ar[ar.length-1];
594             
595             // now we have the 'module name'..
596             var fbits = Path.get_basename(this.path).split(".");
597             
598              
599             var npart = fbits[fbits.length - 2]; // this should be 'AdminProjectManager' for example...
600             if (modname.length < npart.length && npart.substring(0, modname.length) == modname) {
601                 npart = npart.substring(modname.length);
602             }
603             return "[" + this.tree.quoteString(modname) + ", " + this.tree.quoteString(npart) + " ]";
604             //return ret;
605             
606             
607             
608             
609         }
610         
611         // a layout compoent 
612         public string toSourceLayout(bool isPreview) 
613         {
614           
615             
616                 if (isPreview) {
617                         //       topItem.region = 'center';
618                         //    topItem.background = false;
619                 }
620             
621                 var o = this.mungeToString("   ");   
622                 var reg = new Regex("[^A-Za-z.]+");
623             
624                 string modkey = this.modOrder + "-" + reg.replace(this.name, this.name.length, 0 , "-");
625             
626                 string  parent =   (this.parent.length > 0 ?  "'" + this.parent + "'" :  "false");
627
628                 
629                 
630                 if (isPreview) {
631                         // set to false to ensure this is the top level..
632                         parent = "false";
633                         var topnode = this.tree.fqn();
634                         print("topnode = %s\n", topnode);
635                         if (GLib.Regex.match_simple("^Roo\\.bootstrap\\.",topnode) &&
636                             topnode != "Roo.bootstrap.Body"
637                         ) {
638                                 parent = "\"#bootstrap-body\"";
639                         }
640                           
641                 }
642             
643           
644                 return 
645                         this.outputHeader() + "\n" +
646                         
647                         this.name  +  " = new Roo.XComponent({\n" +
648                         "  part     :  "+ this.pathToPart() + ",\n" +
649                                 /// critical used by builder to associate modules/parts/persm
650                         "  order    : '" +modkey+"',\n" +
651                         "  region   : '" + this.region   +"',\n" +
652                         "  parent   : "+ parent + ",\n" +
653                         "  name     : " + this.tree.quoteString(this.title.length > 0 ? this.title : "unnamed module") + ",\n" +
654                         "  disabled : " + (this.disabled ? "true" : "false") +", \n" +
655                         "  permname : '" + (this.permname.length > 0 ? this.permname : "") +"', \n" +
656                             
657                        // "    tree : function() { return this._tree(); },\n" +   //BC
658                         "  _tree : function()\n" +
659                         "  {\n" +
660                         "   var _this = this;\n" + // bc
661                         "   var MODULE = this;\n" + /// this looks like a better name.
662                         "   return " + o + ";" +
663                         "  }\n" +
664                         "});\n";
665                          
666              
667             
668         }
669             
670         public new string? guessName (Node? ar) // turns the object into full name.
671         {
672              // eg. xns: Roo, xtype: XXX -> Roo.xxx
673             if (ar == null) {
674                 return null;
675             }
676             
677             string[] ret = {} ;
678             ret += (ar.get("|xns").length < 1 ? "Roo": ar.get("|xns"));
679              
680             
681             if ( ar.get("xtype").length < 1) {
682                 return null;
683             }
684                     
685             var xtype = ar.get("xtype");
686
687             if (xtype[0] == '*') { // prefixes????
688                 xtype  = xtype.substring(1);
689             }
690             if (! Regex.match_simple("^Roo", xtype)) {
691                 
692                 // already starts with roo...
693                 ret = {};
694             }
695             ret += xtype;
696             var str =  string.joinv(".", ret);
697             
698             return str;
699            // 
700             //Palete.Palete.factory("Roo").guessName(str);
701             
702                             
703                                  
704         }
705         
706         string getHelpUrl(string cls)
707         {
708             return "http://www.roojs.com/roojs1/docs/symbols/" + cls + ".html";
709         }
710                  
711      
712     }
713 }