javaquery/api/src/main/java/org/apidesign/bck2brwsr/htmlpage/Knockout.java
author Jaroslav Tulach <jaroslav.tulach@apidesign.org>
Mon, 15 Apr 2013 06:30:08 +0200
branchfx
changeset 987 5d8eea9d2831
parent 981 25377425d7e8
child 989 b41a01a6d998
permissions -rw-r--r--
Unlike bck2brwsr Object[] is not automatically converted to JavaScript Array. Do special conversion - array values are now properly displayed by knockout
     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             + "  scope.KObject.array= function() {"
    86             + "    var arr = new Array(arguments.length);"
    87             + "    for (var i = 0; i < arguments.length; i++) {"
    88             + "      arr[i] = arguments[i];"
    89             + "    }"
    90             + "    return arr;"
    91             + "  };"
    92             + "})(window); window.KObject"
    93             );
    94     }
    95     
    96     static Object toArray(Object[] arr) {
    97         return KObject.call("array", arr);
    98     }
    99     
   100     public static <M> Knockout applyBindings(
   101         Object model, String[] propsGettersAndSetters,
   102         String[] methodsAndSignatures
   103     ) {
   104         Object bindings = KObject.call("create", model);
   105         applyImpl(propsGettersAndSetters, model.getClass(), bindings, model, methodsAndSignatures);
   106         return new Knockout(bindings);
   107     }
   108     public static <M> Knockout applyBindings(
   109         Class<M> modelClass, M model, String[] propsGettersAndSetters,
   110         String[] methodsAndSignatures
   111     ) {
   112         Object bindings = next;
   113         next = null;
   114         if (bindings == null) {
   115             bindings = KObject.call("create", model);
   116         }
   117         applyImpl(propsGettersAndSetters, modelClass, bindings, model, methodsAndSignatures);
   118         applyBindings(bindings);
   119         return new Knockout(bindings);
   120     }
   121 
   122     public void valueHasMutated(String prop) {
   123         LOG.log(Level.INFO, "property mutated: {0}", prop);
   124         try {
   125             JSObject koProp = (JSObject) ((JSObject) model).getMember(prop);
   126             koProp.call("valueHasMutated");
   127         } catch (Throwable t) {
   128             LOG.log(Level.WARNING, "valueHasMutated failed for {0}", model);
   129         }
   130     }
   131     
   132 
   133     @JavaScriptBody(args = { "id", "ev" }, body = "ko.utils.triggerEvent(window.document.getElementById(id), ev.substring(2));")
   134     public static void triggerEvent(String id, String ev) {
   135     }
   136     
   137     @JavaScriptBody(args = { "bindings", "model", "prop", "getter", "setter", "primitive", "array" }, body =
   138           "var bnd = {\n"
   139         + "  'read': function() {\n"
   140         + "    var v = model[getter]();\n"
   141         + "    if (array) v = v.koArray();\n"
   142         + "    return v;\n"
   143         + "  },\n"
   144         + "  'owner': bindings\n"
   145         + "};\n"
   146         + "if (setter != null) {\n"
   147         + "  bnd['write'] = function(val) {\n"
   148         + "    model[setter](primitive ? new Number(val) : val);\n"
   149         + "  };\n"
   150         + "}\n"
   151         + "bindings[prop] = ko['computed'](bnd);"
   152     )
   153     private static void bind(
   154         Object bindings, Object model, String prop, String getter, String setter, boolean primitive, boolean array
   155     ) {
   156         WebEngine e = web();
   157         JSObject bnd = (JSObject) e.executeScript("var x = {}; x.bnd = "
   158         + "new Function('ko', 'bindings', 'model', 'prop', 'getter', 'setter', 'primitive', 'array', '"
   159         + "var bnd = {"
   160         + "  read: function() {"
   161         + "    try {"
   162         + "      var v = model[getter]();"
   163         + "      console.log(\" getter value \" + v + \" for property \" + prop);"
   164         + "      try { v = v.koData(); } catch (ignore) {"
   165         + "        console.log(\"Cannot convert to koData: \" + ignore);"
   166         + "      };"
   167         + "      console.log(\" getter ret value \" + v);"
   168         + "      for (var pn in v) {"
   169         + "         console.log(\"  prop: \" + pn + \" + in + \" + v + \" = \" + v[pn]);"
   170         + "         if (typeof v[pn] == \"function\") console.log(\"  its function value:\" + v[pn]());"
   171         + "      }"
   172         + "      console.log(\" all props printed for \" + (typeof v));"
   173         + "      return v;"
   174         + "    } catch (e) {"
   175         + "      alert(\"Cannot call \" + getter + \" on \" + model + \" error: \" + e);"
   176         + "    }"
   177         + "  },"
   178         + "  owner: bindings,"
   179         + "  deferEvaluation: true"
   180         + "};"
   181         + "if (setter != null) {"
   182         + "  bnd.write = function(val) {"
   183         + "    model[setter](primitive ? new Number(val) : val);"
   184         + "  };"
   185         + "};"
   186         + "bindings[prop] = ko.computed(bnd);'"
   187         + "); x;");
   188         
   189         Object ko = e.executeScript("ko");
   190         try {
   191             KOProperty kop = new KOProperty(model, strip(getter), strip(setter));
   192             bnd.call("bnd", ko, bindings, kop, prop, "get", "set", primitive, array);
   193             LOG.log(Level.INFO, "binding defined for {0}: {1}", new Object[]{prop, ((JSObject)bindings).getMember(prop)});
   194         } catch (Throwable ex) {
   195             LOG.log(Level.INFO, "binding failed for {0} on {1}", new Object[]{prop, bindings});
   196         }
   197     }
   198     
   199     private static String strip(String mangled) {
   200         if (mangled == null) {
   201             return null;
   202         }
   203         int under = mangled.indexOf("__");
   204         return mangled.substring(0, under);
   205     }
   206     @JavaScriptBody(args = { "bindings", "model", "prop", "sig" }, body = 
   207         "bindings[prop] = function(data, ev) { model[sig](data, ev); };"
   208     )
   209     private static void expose(
   210         Object bindings, Object model, String prop, String sig
   211     ) {
   212     }
   213     
   214     @JavaScriptBody(args = { "bindings" }, body = "ko.applyBindings(bindings);")
   215     private static void applyBindings(Object bindings) {
   216         JSObject ko = (JSObject) web().executeScript("ko");
   217         ko.call("applyBindings", bindings);
   218     }
   219     
   220     private static WebEngine web() {
   221         return (WebEngine) System.getProperties().get("webEngine");
   222     }
   223     
   224     
   225     private static void applyImpl(
   226         String[] propsGettersAndSetters,
   227         Class<?> modelClass,
   228         Object bindings,
   229         Object model,
   230         String[] methodsAndSignatures
   231     ) throws IllegalStateException, SecurityException {
   232         for (int i = 0; i < propsGettersAndSetters.length; i += 4) {
   233             try {
   234                 Method getter = modelClass.getMethod(propsGettersAndSetters[i + 3]);
   235                 bind(bindings, model, propsGettersAndSetters[i],
   236                     propsGettersAndSetters[i + 1],
   237                     propsGettersAndSetters[i + 2],
   238                     getter.getReturnType().isPrimitive(),
   239                     List.class.isAssignableFrom(getter.getReturnType()));
   240             } catch (NoSuchMethodException ex) {
   241                 throw new IllegalStateException(ex.getMessage());
   242             }
   243         }
   244         for (int i = 0; i < methodsAndSignatures.length; i += 2) {
   245             expose(
   246                 bindings, model, methodsAndSignatures[i], methodsAndSignatures[i + 1]);
   247         }
   248     }
   249 }