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