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