javaquery/api/src/main/java/org/apidesign/bck2brwsr/htmlpage/Knockout.java
author Jaroslav Tulach <jaroslav.tulach@apidesign.org>
Thu, 18 Apr 2013 20:09:45 +0200
branchfx
changeset 1015 d7cff2cba6e5
parent 993 08e7b312664f
child 1016 6dc2c6c752df
permissions -rw-r--r--
Knockout tests pass OK in FX Web View now
     1 /**
     2  * Back 2 Browser Bytecode Translator
     3  * Copyright (C) 2012 Jaroslav Tulach <jaroslav.tulach@apidesign.org>
     4  *
     5  * This program is free software: you can redistribute it and/or modify
     6  * it under the terms of the GNU General Public License as published by
     7  * the Free Software Foundation, version 2 of the License.
     8  *
     9  * This program is distributed in the hope that it will be useful,
    10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
    11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    12  * GNU General Public License for more details.
    13  *
    14  * You should have received a copy of the GNU General Public License
    15  * along with this program. Look for COPYING file in the top folder.
    16  * If not, see http://opensource.org/licenses/GPL-2.0.
    17  */
    18 package org.apidesign.bck2brwsr.htmlpage;
    19 
    20 import java.io.BufferedReader;
    21 import java.io.IOException;
    22 import java.io.InputStreamReader;
    23 import java.lang.reflect.Method;
    24 import java.util.List;
    25 import java.util.logging.Level;
    26 import java.util.logging.Logger;
    27 import javafx.scene.web.WebEngine;
    28 import netscape.javascript.JSObject;
    29 import org.apidesign.bck2brwsr.core.ExtraJavaScript;
    30 import org.apidesign.bck2brwsr.core.JavaScriptBody;
    31 
    32 /** Provides binding between models and 
    33  *
    34  * @author Jaroslav Tulach <jtulach@netbeans.org>
    35  */
    36 @ExtraJavaScript(resource = "/org/apidesign/bck2brwsr/htmlpage/knockout-2.2.1.js")
    37 public class Knockout {
    38     private static final Logger LOG = Logger.getLogger(Knockout.class.getName());
    39     /** used by tests */
    40     static Knockout next;
    41     private final Object model;
    42 
    43     static {
    44         BufferedReader r = new BufferedReader(new InputStreamReader(Knockout.class.getResourceAsStream("knockout-2.2.1.js")));
    45         StringBuilder sb = new StringBuilder();
    46         for (;;) {
    47             try {
    48                 String l = r.readLine();
    49                 if (l == null) {
    50                     break;
    51                 }
    52                 sb.append(l).append('\n');
    53             } catch (IOException ex) {
    54                 throw new IllegalStateException(ex);
    55             }
    56         }
    57         web().executeScript(sb.toString());
    58         Object ko = web().executeScript("ko");
    59         assert ko != null : "Knockout library successfully defined 'ko'";
    60         
    61         Console.register(web());
    62     }
    63     
    64     
    65     Knockout(Object model) {
    66         this.model = model == null ? this : model;
    67     }
    68     
    69     public Object koData() {
    70         return model;
    71     }
    72 
    73     private static final JSObject KObject;
    74     static {
    75         KObject = (JSObject) web().executeScript(
    76             "(function(scope) {"
    77             + "  var kCnt = 0; "
    78             + "  scope.KObject = {};"
    79             + "  scope.KObject.create= function(value) {"
    80             + "    var cnt = ++kCnt;"
    81             + "    var ret = {};"
    82             + "    ret.toString = function() { return 'KObject' + cnt + ' value: ' + value + ' props: ' + Object.keys(this); };"
    83             + "    return ret;"
    84             + "  };"
    85             
    86             + "  scope.KObject.array= function() {"
    87             + "    return Array.prototype.slice.call(arguments);"
    88             + "  };"
    89             
    90             + "  scope.KObject.expose = function(bindings, model, prop, sig) {"
    91             + "    bindings[prop] = function(data, ev) {"
    92 //            + "         console.log(\"  callback on prop: \" + prop);"
    93             + "      model[sig](data, ev);"
    94             + "    };"
    95             + "  };"
    96             
    97             + "})(window); window.KObject"
    98             );
    99     }
   100     
   101     static Object toArray(Object[] arr) {
   102         return KObject.call("array", arr);
   103     }
   104     
   105     public static <M> Knockout applyBindings(
   106         Object model, String[] propsGettersAndSetters,
   107         String[] methodsAndSignatures
   108     ) {
   109         Object bindings = KObject.call("create", model);
   110         applyImpl(propsGettersAndSetters, model.getClass(), bindings, model, methodsAndSignatures);
   111         return new Knockout(bindings);
   112     }
   113     public static <M> Knockout applyBindings(
   114         Class<M> modelClass, M model, String[] propsGettersAndSetters,
   115         String[] methodsAndSignatures
   116     ) {
   117         Object bindings = next;
   118         next = null;
   119         if (bindings == null) {
   120             bindings = KObject.call("create", model);
   121         }
   122         applyImpl(propsGettersAndSetters, modelClass, bindings, model, methodsAndSignatures);
   123         applyBindings(bindings);
   124         return new Knockout(bindings);
   125     }
   126 
   127     public void valueHasMutated(String prop) {
   128         LOG.log(Level.FINE, "property mutated: {0}", prop);
   129         try {
   130             JSObject koProp = (JSObject) ((JSObject) model).getMember(prop);
   131             koProp.call("valueHasMutated");
   132         } catch (Throwable t) {
   133             LOG.log(Level.WARNING, "valueHasMutated failed for {0}", model);
   134         }
   135     }
   136     
   137 
   138     @JavaScriptBody(args = { "id", "ev" }, body = "ko.utils.triggerEvent(window.document.getElementById(id), ev.substring(2));")
   139     public static void triggerEvent(String id, String ev) {
   140         JSObject js = (JSObject) web().executeScript("(function () {"
   141             + "  var x = {}; "
   142             + "  x.trigger= function(id, ev) { "
   143             + "    ko.utils.triggerEvent(window.document.getElementById(id), ev.substring(2));;\n"
   144             + "  };"
   145             + "  return x;"
   146             + "})()");
   147         js.call("trigger", id, ev);
   148     }
   149     
   150     @JavaScriptBody(args = { "bindings", "model", "prop", "getter", "setter", "primitive", "array" }, body =
   151           "var bnd = {\n"
   152         + "  'read': function() {\n"
   153         + "    var v = model[getter]();\n"
   154         + "    if (array) v = v.koArray();\n"
   155         + "    return v;\n"
   156         + "  },\n"
   157         + "  'owner': bindings\n"
   158         + "};\n"
   159         + "if (setter != null) {\n"
   160         + "  bnd['write'] = function(val) {\n"
   161         + "    model[setter](primitive ? new Number(val) : val);\n"
   162         + "  };\n"
   163         + "}\n"
   164         + "bindings[prop] = ko['computed'](bnd);"
   165     )
   166     private static void bind(
   167         Object bindings, Object model, String prop, String getter, String setter, boolean primitive, boolean array
   168     ) {
   169         WebEngine e = web();
   170         JSObject bnd = (JSObject) e.executeScript("var x = {}; x.bnd = "
   171         + "new Function('ko', 'bindings', 'model', 'prop', 'getter', 'setter', 'primitive', 'array', '"
   172         + "var bnd = {"
   173         + "  read: function() {"
   174         + "    try {"
   175         + "      var v = model[getter]();"
   176 //        + "      console.log(\" getter value \" + v + \" for property \" + prop);"
   177         + "      try { v = v.koData(); } catch (ignore) {"
   178 //        + "        console.log(\"Cannot convert to koData: \" + ignore);"
   179         + "      };"
   180 //        + "      console.log(\" getter ret value \" + v);"
   181 //        + "      for (var pn in v) {"
   182 //        + "         console.log(\"  prop: \" + pn + \" + in + \" + v + \" = \" + v[pn]);"
   183 //        + "         if (typeof v[pn] == \"function\") console.log(\"  its function value:\" + v[pn]());"
   184 //        + "      }"
   185 //        + "      console.log(\" all props printed for \" + (typeof v));"
   186         + "      return v;"
   187         + "    } catch (e) {"
   188         + "      alert(\"Cannot call \" + getter + \" on \" + model + \" error: \" + e);"
   189         + "    }"
   190         + "  },"
   191         + "  owner: bindings,"
   192         + "  deferEvaluation: true"
   193         + "};"
   194         + "if (setter != null) {"
   195         + "  bnd.write = function(val) {"
   196         + "    model[setter](primitive ? new Number(val) : val);"
   197         + "  };"
   198         + "};"
   199         + "bindings[prop] = ko.computed(bnd);'"
   200         + "); x;");
   201         
   202         Object ko = e.executeScript("ko");
   203         try {
   204             KOProperty kop = new KOProperty(model, strip(getter), strip(setter));
   205             bnd.call("bnd", ko, bindings, kop, prop, "get", "set", primitive, array);
   206             
   207             ((JSObject)bindings).setMember("koModel", model);
   208             LOG.log(Level.FINE, "binding defined for {0}: {1}", new Object[]{prop, ((JSObject)bindings).getMember(prop)});
   209         } catch (Throwable ex) {
   210             LOG.log(Level.WARNING, "binding failed for {0} on {1}", new Object[]{prop, bindings});
   211         }
   212     }
   213     
   214     private static String strip(String mangled) {
   215         if (mangled == null) {
   216             return null;
   217         }
   218         int under = mangled.indexOf("__");
   219         return mangled.substring(0, under);
   220     }
   221     @JavaScriptBody(args = { "bindings", "model", "prop", "sig" }, body = 
   222         "bindings[prop] = function(data, ev) { model[sig](data, ev); };"
   223     )
   224     private static void expose(
   225         Object bindings, Object model, String prop, String sig
   226     ) {
   227         try {
   228             KOFunction f = new KOFunction(model, strip(sig));
   229             KObject.call("expose", bindings, f, prop, "call");
   230         } catch (Throwable ex) {
   231             LOG.log(Level.SEVERE, "Cannot define binding for " + prop + " in model " + model, ex);
   232         }
   233     }
   234     
   235     @JavaScriptBody(args = { "bindings" }, body = "ko.applyBindings(bindings);")
   236     private static void applyBindings(Object bindings) {
   237         JSObject ko = (JSObject) web().executeScript("ko");
   238         ko.call("applyBindings", bindings);
   239     }
   240     
   241     private static WebEngine web() {
   242         return (WebEngine) System.getProperties().get("webEngine");
   243     }
   244     
   245     
   246     private static void applyImpl(
   247         String[] propsGettersAndSetters,
   248         Class<?> modelClass,
   249         Object bindings,
   250         Object model,
   251         String[] methodsAndSignatures
   252     ) throws IllegalStateException, SecurityException {
   253         for (int i = 0; i < propsGettersAndSetters.length; i += 4) {
   254             try {
   255                 Method getter = modelClass.getMethod(propsGettersAndSetters[i + 3]);
   256                 bind(bindings, model, propsGettersAndSetters[i],
   257                     propsGettersAndSetters[i + 1],
   258                     propsGettersAndSetters[i + 2],
   259                     getter.getReturnType().isPrimitive(),
   260                     List.class.isAssignableFrom(getter.getReturnType()));
   261             } catch (NoSuchMethodException ex) {
   262                 throw new IllegalStateException(ex.getMessage());
   263             }
   264         }
   265         for (int i = 0; i < methodsAndSignatures.length; i += 2) {
   266             expose(
   267                 bindings, model, methodsAndSignatures[i], methodsAndSignatures[i + 1]);
   268         }
   269     }
   270 }