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                 
214                 this.transStrings = new Gee.HashMap<string,string>();
215                 this.findTransStrings(this.tree);
216                 
217                 this.saveBJS();
218
219                 // no tree..
220                 if (this.tree == null) {
221                         return;
222                 }
223                 // now write the js file..
224                 string js;
225                 try {
226                         Regex regex = new Regex("\\.(bjs|js)$");
227
228                         js = regex.replace(this.path,this.path.length , 0 , ".js");
229                 } catch (RegexError e) {
230                         this.name = "???";
231                         print("count not make filename from path");
232                         return;
233                 }
234
235
236                 //var d = new Date();
237                 var js_src = this.toSource();            
238                 //print("TO SOURCE in " + ((new Date()) - d) + "ms");
239                 try {
240                         this.writeFile(js, js_src);            
241                 } catch (FileError e ) {
242                         print("Save failed\n");
243                 }
244                 // for bootstrap - we can write the HTML to the templates directory..
245                  
246             //var top = this.guessName(this.items[0]);
247             //print ("TOP = " + top)
248              
249             
250             
251             
252         }
253
254          
255
256          
257         public override void saveHTML ( string html )
258         {
259                  
260                 var top = this.tree.fqn();
261                 print ("TOP = " + top + "\n" );
262                 if (top.index_of("Roo.bootstrap.") < 0 &&
263                     top.index_of("Roo.mailer.") < 0
264                         ) {
265                         return;
266                 }
267                 
268                 
269                 //now write the js file..
270                 string fn;
271                 try {
272                         Regex regex = new Regex("\\.(bjs|js)$");
273
274                         fn = regex.replace(this.path,this.path.length , 0 , ".html");
275                 } catch (RegexError e) {
276                         this.name = "???";
277                         print("count not make filename from path");
278                         return;
279                 }
280                 var bn = GLib.Path.get_basename(fn);
281                 var dn = GLib.Path.get_dirname(fn);
282
283                 var targetdir = dn + (
284                         top.index_of("Roo.mailer.") < 0 ? "/templates" : "" );
285                               
286                 
287                 if (!FileUtils.test(targetdir, FileTest.IS_DIR)) {
288                         print("Skip save - templates folder does not exist : %s\n", targetdir);
289                         return;
290                 }
291                 print("SAVE HTML -- %s\n%s\n",targetdir + "/" +  bn, html);
292                 try {
293                         this.writeFile(targetdir + "/" +  bn , html);            
294                 } catch (FileError e ) {
295                         print("SaveHtml failed\n");
296                 }
297             
298             
299             
300         }
301
302                 public Gee.ArrayList<string> findxincludes(Node node,   Gee.ArrayList<string> ret)
303                 {
304                         
305                         if (node.props.has_key("* xinclude")) {
306                                 ret.add(node.props.get("* xinclude"));
307                         }
308                         for (var i =0; i < node.items.size; i++) {
309                                 this.findxincludes(node.items.get(i), ret);
310                         }
311                         return ret;
312                                 
313                 }
314                  
315
316                  
317                 public void  findTransStrings(Node node )
318                 {
319                         // iterate properties...
320                         // use doubleStringProps
321                         
322                         // flagging a translatable string..
323                         // the code would use string _astring to indicate a translatable string
324                         // the to use it it would do String.format(this._message, somedata);
325                         
326                         // loop through and find string starting with '_' 
327                         if (node == null) {
328                                 return;
329                         }               
330                         
331                         var iter = node.props.map_iterator();
332                         while (iter.next()) {
333                                 // key formats : XXXX
334                                 // XXX - plain
335                                 // string XXX - with type
336                                 // $ XXX - with flag (no type)
337                                 // $ string XXX - with flag
338                                 string kname;
339                                 string ktype;
340                                 string kflag;
341                                 node.normalize_key(iter.get_key(), out kname, out kflag, out ktype);
342                                 if (kflag == "$") {
343                                         continue;
344                                 }
345                                 var str = iter.get_value();
346                                 if (this.doubleStringProps.index_of(kname) > -1) {
347                                         this.transStrings.set(str,  
348                                                 GLib.Checksum.compute_for_string (ChecksumType.MD5, str)
349                                         );
350                                         continue;
351                                 }
352                                 print("flag=%s type=%s name=%s\n", kflag,ktype,kname);
353                                 if (ktype.ascii_casecmp("string") == 0 && kname[0] == '_') {
354                                         this.transStrings.set(str,  
355                                                 GLib.Checksum.compute_for_string (ChecksumType.MD5, str)
356                                         );
357                                         continue;
358                                 }
359                                 
360                         }
361                          
362
363                         
364                         // iterate children..
365                         for (var i =0; i < node.items.size; i++) {
366                                 this.findTransStrings(node.items.get(i) );
367                         }
368                 
369                                 
370                 }  
371                 
372                 public string  transStringsToJs()
373                 {
374                         if (this.transStrings.size < 1) {
375                                 return "";
376                         }
377                         string ret = " strings : {\n";
378                         string[] kvs = {};
379                         var iter = this.transStrings.map_iterator();
380                         while (iter.next()) {
381                                 kvs += "  " + (this.tree.quoteString(iter.get_value()) + ":" + 
382                                         this.tree.quoteString(iter.get_key())
383                                         )
384                         }
385                         return " strings : {\n " + string.joinv(",\n", kvs) + "\n" + 
386                                 " },";
387                                 
388                 
389               
390                         
391                 }
392                   
393         /**
394          * javascript used in Webkit preview 
395          */
396         
397         public override string  toSourcePreview()
398         {
399                         print("to source preview\n");
400                         if (this.tree == null) {
401                                 return "";
402                         }
403                         var top = this.tree.fqn();
404                         var xinc = new Gee.ArrayList<string>(); 
405
406                         this.findxincludes(this.tree, xinc);
407                         print("got %d xincludes\n", xinc.size);
408                         var prefix_data = "";
409                         if (xinc.size > 0 ) {
410                                 for(var i = 0; i < xinc.size; i++) {
411                                         print("check xinclude:  %s\n", xinc.get(i));
412                                         var sf = this.project.getByName(xinc.get(i));
413                                         if (sf == null) {
414                                                 print("Failed to find file by name?\n");
415                                                 continue;
416                                         }
417
418                                         sf.loadItems();
419                                         var xinc_str = sf.toSource();
420                                         
421                                         //string xinc_str;
422                                         //FileUtils.get_contents(js, out xinc_str);
423                                         prefix_data += "\n" + xinc_str + "\n";
424                                         
425                                 }
426
427                         }
428
429                         
430                         
431                         //print(JSON.stringify(this.items, null,4));
432                                    
433                         if (top == null) {
434                                 print ("guessname returned false");
435                                 return "";
436                         }
437
438
439                         if (top.contains("Dialog")) {
440                                 return prefix_data + this.toSourceDialog(true);
441                         }
442
443                         if (top.contains("Modal")) {
444                                 return prefix_data + this.toSourceModal(true);
445                         }
446
447                         return prefix_data + this.toSourceLayout(true);
448                                 
449                                 
450             
451         }
452         
453         /**
454          * This needs to use some options on the project
455          * to determine how the file is output..
456          * 
457          * At present we are hard coding it..
458          * 
459          * 
460          */
461         public override string toSource()
462         {
463             // dump the file tree back out to a string.
464             
465             // we have 2 types = dialogs and components
466             // 
467             
468             
469                         if (this.tree == null) {
470                                 return "";
471                         }
472             var top = this.tree.fqn();
473             if (top == null) {
474                 return "";
475             }
476             // get the translatable strings..
477             
478             
479             
480             if (top.contains("Dialog")) {
481                 return this.toSourceDialog(false);
482             }
483             
484             if (top.contains("Modal")) {
485                 return this.toSourceModal(false);
486             }
487             return this.toSourceLayout(false);
488             
489             /*
490             eventually support 'classes??'
491              return this.toSourceStdClass();
492             */
493               
494         }
495        
496         public string outputHeader()
497         {
498                 string[] s = {
499                         "//<script type=\"text/javascript\">",
500                         "",
501                         "// Auto generated file - created by app.Builder.js- do not edit directly (at present!)",
502                         ""
503                    
504                 };  
505                 var ret=  string.joinv("\n",s);
506                 var bits = this.name.split(".");
507                 if (bits.length > 1) {
508                         ret += "\nRoo.namespace(\'" + 
509                                 this.name.substring(0, this.name.length - (bits[bits.length-1].length + 1)) +
510                                 "');\n";
511                                 
512                 }
513                 /// genericlly used..
514                   
515                 return ret;
516             
517        
518         }
519         // a standard dialog module.
520         // fixme - this could be alot neater..
521         public string toSourceDialog(bool isPreview) 
522         {
523             
524             //var items = JSON.parse(JSON.stringify(this.items[0]));
525             
526             
527             var o = this.mungeToString("    ");   
528
529  
530             string[] adda = { " = {",
531                 "",
532                 this.transStringsToJs() + ","
533                 "",
534                 " dialog : false,",
535                 " callback:  false,",
536                 "",   
537                 " show : function(data, cb)",
538                 " {",
539                 "  if (!this.dialog) {",
540                 "   this.create();",
541                 "  }",
542                 "",
543                 "  this.callback = cb;",
544                 "  this.data = data;",
545                 "  this.dialog.show(this.data._el);",
546                 "  if (this.form) {",
547                 "   this.form.reset();",
548                 "   this.form.setValues(data);",
549                 "   this.form.fireEvent('actioncomplete', this.form,  { type: 'setdata', data: data });",
550                 "  }",
551                 "",   
552                 " },",
553                 "",
554                 " create : function()",
555                 " {",
556                 "   var _this = this;",
557                 "   this.dialog = Roo.factory(" 
558             };
559             string[] addb = {  
560                    ");",
561                 " }",
562                 "};",
563                 ""
564             };
565             return  this.outputHeader() + "\n" +
566                 this.name + string.joinv("\n", adda) + o + string.joinv("\n", addb);
567             
568              
569              
570              
571         }
572         
573         public string toSourceModal(bool isPreview) 
574         {
575             
576             
577             //var items = JSON.parse(JSON.stringify(this.items[0]));
578             var o = this.mungeToString("    ");   
579             
580             string[] adda = { " = {",
581                 "",
582                 this.transStringsToJs() + ","
583                 "",
584                 " dialog : false,",
585                 " callback:  false,",
586                 "",   
587                 " show : function(data, cb)",
588                 " {",
589                 "  if (!this.dialog) {",
590                 "   this.create();",
591                 "  }",
592                 "",
593                 "  this.callback = cb;",
594                 "  this.data = data;",
595                 "  this.dialog.show(this.data._el);",
596                 "  if (this.form) {",
597                 "   this.form.reset();",
598                 "   this.form.setValues(data);",
599                 "   this.form.fireEvent('actioncomplete', this.form,  { type: 'setdata', data: data });",
600                 "  }",
601                 "",   
602                 " },",
603                 "",
604                 " create : function()",
605                 " {",
606                 "  var _this = this;",
607                 "  this.dialog = Roo.factory("
608             };
609             string[] addb =  {
610                 "  );",
611                 " }",
612                 "};",
613                 ""
614             };
615             return this.outputHeader() + "\n" + 
616                 this.name + string.joinv("\n", adda) + o + string.joinv("\n", addb);
617              
618              
619              
620         }
621         
622         
623         public string   pathToPart()
624         {
625             var dir = Path.get_basename(Path.get_dirname(this.path));
626             var ar = dir.split(".");
627             var modname = ar[ar.length-1];
628             
629             // now we have the 'module name'..
630             var fbits = Path.get_basename(this.path).split(".");
631             
632              
633             var npart = fbits[fbits.length - 2]; // this should be 'AdminProjectManager' for example...
634             if (modname.length < npart.length && npart.substring(0, modname.length) == modname) {
635                 npart = npart.substring(modname.length);
636             }
637             return "[" + this.tree.quoteString(modname) + ", " + this.tree.quoteString(npart) + " ]";
638             //return ret;
639             
640             
641             
642             
643         }
644         
645         // a layout compoent 
646         public string toSourceLayout(bool isPreview) 
647         {
648           
649             
650                 if (isPreview) {
651                         //       topItem.region = 'center';
652                         //    topItem.background = false;
653                 }
654             
655                 var o = this.mungeToString("   ");   
656                 var reg = new Regex("[^A-Za-z.]+");
657             
658                 string modkey = this.modOrder + "-" + reg.replace(this.name, this.name.length, 0 , "-");
659             
660                 string  parent =   (this.parent.length > 0 ?  "'" + this.parent + "'" :  "false");
661
662                 
663                 
664                 if (isPreview) {
665                         // set to false to ensure this is the top level..
666                         parent = "false";
667                         var topnode = this.tree.fqn();
668                         print("topnode = %s\n", topnode);
669                         if (GLib.Regex.match_simple("^Roo\\.bootstrap\\.",topnode) &&
670                             topnode != "Roo.bootstrap.Body"
671                         ) {
672                                 parent = "\"#bootstrap-body\"";
673                         }
674                           
675                 }
676             
677           
678                 return 
679                         this.outputHeader() + "\n" +
680                         
681                         this.name  +  " = new Roo.XComponent({\n" +
682                         ""
683                         this.transStringsToJs() + ","
684                 "",
685                         "  part     :  "+ this.pathToPart() + ",\n" +
686                                 /// critical used by builder to associate modules/parts/persm
687                         "  order    : '" +modkey+"',\n" +
688                         "  region   : '" + this.region   +"',\n" +
689                         "  parent   : "+ parent + ",\n" +
690                         "  name     : " + this.tree.quoteString(this.title.length > 0 ? this.title : "unnamed module") + ",\n" +
691                         "  disabled : " + (this.disabled ? "true" : "false") +", \n" +
692                         "  permname : '" + (this.permname.length > 0 ? this.permname : "") +"', \n" +
693                             
694                        // "    tree : function() { return this._tree(); },\n" +   //BC
695                         "  _tree : function()\n" +
696                         "  {\n" +
697                         "   var _this = this;\n" + // bc
698                         "   var MODULE = this;\n" + /// this looks like a better name.
699                         "   return " + o + ";" +
700                         "  }\n" +
701                         "});\n";
702                          
703               
704         }
705             
706         public new string? guessName (Node? ar) // turns the object into full name.
707         {
708              // eg. xns: Roo, xtype: XXX -> Roo.xxx
709             if (ar == null) {
710                 return null;
711             }
712             
713             string[] ret = {} ;
714             ret += (ar.get("|xns").length < 1 ? "Roo": ar.get("|xns"));
715              
716             
717             if ( ar.get("xtype").length < 1) {
718                 return null;
719             }
720                     
721             var xtype = ar.get("xtype");
722
723             if (xtype[0] == '*') { // prefixes????
724                 xtype  = xtype.substring(1);
725             }
726             if (! Regex.match_simple("^Roo", xtype)) {
727                 
728                 // already starts with roo...
729                 ret = {};
730             }
731             ret += xtype;
732             var str =  string.joinv(".", ret);
733             
734             return str;
735            // 
736             //Palete.Palete.factory("Roo").guessName(str);
737             
738                             
739                                  
740         }
741         
742         string getHelpUrl(string cls)
743         {
744             return "http://www.roojs.com/roojs1/docs/symbols/" + cls + ".html";
745         }
746                  
747      
748     }
749 }