javaquery/api/src/main/java/org/apidesign/bck2brwsr/htmlpage/Knockout.java
author Jaroslav Tulach <jaroslav.tulach@apidesign.org>
Thu, 18 Apr 2013 23:09:30 +0200
branchfx
changeset 1016 6dc2c6c752df
parent 1015 d7cff2cba6e5
permissions -rw-r--r--
Can execute 'dual' tests: bck2brwsr can use regular launcher, javaquery.api can use FX Web View one
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@909
    43
    Knockout(Object model) {
jaroslav@909
    44
        this.model = model == null ? this : model;
jaroslav@492
    45
    }
jaroslav@492
    46
    
jaroslav@979
    47
    public Object koData() {
jaroslav@979
    48
        return model;
jaroslav@979
    49
    }
jaroslav@979
    50
jaroslav@987
    51
    static Object toArray(Object[] arr) {
jaroslav@1016
    52
        return InvokeJS.KObject.call("array", arr);
jaroslav@987
    53
    }
jaroslav@987
    54
    
jaroslav@496
    55
    public static <M> Knockout applyBindings(
jaroslav@909
    56
        Object model, String[] propsGettersAndSetters,
jaroslav@909
    57
        String[] methodsAndSignatures
jaroslav@909
    58
    ) {
jaroslav@1016
    59
        Object bindings = InvokeJS.KObject.call("create", model);
jaroslav@979
    60
        applyImpl(propsGettersAndSetters, model.getClass(), bindings, model, methodsAndSignatures);
jaroslav@979
    61
        return new Knockout(bindings);
jaroslav@909
    62
    }
jaroslav@909
    63
    public static <M> Knockout applyBindings(
jaroslav@879
    64
        Class<M> modelClass, M model, String[] propsGettersAndSetters,
jaroslav@879
    65
        String[] methodsAndSignatures
jaroslav@492
    66
    ) {
jaroslav@851
    67
        Object bindings = next;
jaroslav@499
    68
        next = null;
jaroslav@499
    69
        if (bindings == null) {
jaroslav@1016
    70
            bindings = InvokeJS.KObject.call("create", model);
jaroslav@499
    71
        }
jaroslav@909
    72
        applyImpl(propsGettersAndSetters, modelClass, bindings, model, methodsAndSignatures);
jaroslav@492
    73
        applyBindings(bindings);
jaroslav@851
    74
        return new Knockout(bindings);
jaroslav@496
    75
    }
jaroslav@496
    76
jaroslav@909
    77
    public void valueHasMutated(String prop) {
jaroslav@993
    78
        LOG.log(Level.FINE, "property mutated: {0}", prop);
jaroslav@973
    79
        try {
jaroslav@973
    80
            JSObject koProp = (JSObject) ((JSObject) model).getMember(prop);
jaroslav@973
    81
            koProp.call("valueHasMutated");
jaroslav@973
    82
        } catch (Throwable t) {
jaroslav@980
    83
            LOG.log(Level.WARNING, "valueHasMutated failed for {0}", model);
jaroslav@973
    84
        }
jaroslav@492
    85
    }
jaroslav@492
    86
    
jaroslav@530
    87
jaroslav@530
    88
    @JavaScriptBody(args = { "id", "ev" }, body = "ko.utils.triggerEvent(window.document.getElementById(id), ev.substring(2));")
jaroslav@530
    89
    public static void triggerEvent(String id, String ev) {
jaroslav@1015
    90
        JSObject js = (JSObject) web().executeScript("(function () {"
jaroslav@1015
    91
            + "  var x = {}; "
jaroslav@1015
    92
            + "  x.trigger= function(id, ev) { "
jaroslav@1015
    93
            + "    ko.utils.triggerEvent(window.document.getElementById(id), ev.substring(2));;\n"
jaroslav@1015
    94
            + "  };"
jaroslav@1015
    95
            + "  return x;"
jaroslav@1015
    96
            + "})()");
jaroslav@1015
    97
        js.call("trigger", id, ev);
jaroslav@530
    98
    }
jaroslav@530
    99
    
jaroslav@887
   100
    @JavaScriptBody(args = { "bindings", "model", "prop", "getter", "setter", "primitive", "array" }, body =
jaroslav@492
   101
          "var bnd = {\n"
lubomir@869
   102
        + "  'read': function() {\n"
jaroslav@492
   103
        + "    var v = model[getter]();\n"
jaroslav@887
   104
        + "    if (array) v = v.koArray();\n"
jaroslav@492
   105
        + "    return v;\n"
jaroslav@492
   106
        + "  },\n"
lubomir@869
   107
        + "  'owner': bindings\n"
jaroslav@492
   108
        + "};\n"
jaroslav@492
   109
        + "if (setter != null) {\n"
lubomir@869
   110
        + "  bnd['write'] = function(val) {\n"
jaroslav@530
   111
        + "    model[setter](primitive ? new Number(val) : val);\n"
jaroslav@492
   112
        + "  };\n"
jaroslav@492
   113
        + "}\n"
lubomir@869
   114
        + "bindings[prop] = ko['computed'](bnd);"
jaroslav@492
   115
    )
jaroslav@492
   116
    private static void bind(
jaroslav@887
   117
        Object bindings, Object model, String prop, String getter, String setter, boolean primitive, boolean array
jaroslav@492
   118
    ) {
jaroslav@851
   119
        WebEngine e = web();
jaroslav@1016
   120
        if (e == null) {
jaroslav@1016
   121
            return;
jaroslav@1016
   122
        }
jaroslav@851
   123
        JSObject bnd = (JSObject) e.executeScript("var x = {}; x.bnd = "
jaroslav@970
   124
        + "new Function('ko', 'bindings', 'model', 'prop', 'getter', 'setter', 'primitive', 'array', '"
jaroslav@851
   125
        + "var bnd = {"
jaroslav@851
   126
        + "  read: function() {"
jaroslav@851
   127
        + "    try {"
jaroslav@970
   128
        + "      var v = model[getter]();"
jaroslav@993
   129
//        + "      console.log(\" getter value \" + v + \" for property \" + prop);"
jaroslav@979
   130
        + "      try { v = v.koData(); } catch (ignore) {"
jaroslav@993
   131
//        + "        console.log(\"Cannot convert to koData: \" + ignore);"
jaroslav@979
   132
        + "      };"
jaroslav@993
   133
//        + "      console.log(\" getter ret value \" + v);"
jaroslav@993
   134
//        + "      for (var pn in v) {"
jaroslav@993
   135
//        + "         console.log(\"  prop: \" + pn + \" + in + \" + v + \" = \" + v[pn]);"
jaroslav@993
   136
//        + "         if (typeof v[pn] == \"function\") console.log(\"  its function value:\" + v[pn]());"
jaroslav@993
   137
//        + "      }"
jaroslav@993
   138
//        + "      console.log(\" all props printed for \" + (typeof v));"
jaroslav@970
   139
        + "      return v;"
jaroslav@851
   140
        + "    } catch (e) {"
jaroslav@851
   141
        + "      alert(\"Cannot call \" + getter + \" on \" + model + \" error: \" + e);"
jaroslav@851
   142
        + "    }"
jaroslav@851
   143
        + "  },"
jaroslav@979
   144
        + "  owner: bindings,"
jaroslav@979
   145
        + "  deferEvaluation: true"
jaroslav@851
   146
        + "};"
jaroslav@851
   147
        + "if (setter != null) {"
jaroslav@851
   148
        + "  bnd.write = function(val) {"
jaroslav@851
   149
        + "    model[setter](primitive ? new Number(val) : val);"
jaroslav@851
   150
        + "  };"
jaroslav@851
   151
        + "};"
jaroslav@851
   152
        + "bindings[prop] = ko.computed(bnd);'"
jaroslav@851
   153
        + "); x;");
jaroslav@1016
   154
jaroslav@851
   155
        Object ko = e.executeScript("ko");
jaroslav@973
   156
        try {
jaroslav@975
   157
            KOProperty kop = new KOProperty(model, strip(getter), strip(setter));
jaroslav@975
   158
            bnd.call("bnd", ko, bindings, kop, prop, "get", "set", primitive, array);
jaroslav@990
   159
            
jaroslav@990
   160
            ((JSObject)bindings).setMember("koModel", model);
jaroslav@993
   161
            LOG.log(Level.FINE, "binding defined for {0}: {1}", new Object[]{prop, ((JSObject)bindings).getMember(prop)});
jaroslav@973
   162
        } catch (Throwable ex) {
jaroslav@993
   163
            LOG.log(Level.WARNING, "binding failed for {0} on {1}", new Object[]{prop, bindings});
jaroslav@973
   164
        }
jaroslav@492
   165
    }
jaroslav@851
   166
    
jaroslav@851
   167
    private static String strip(String mangled) {
jaroslav@851
   168
        if (mangled == null) {
jaroslav@851
   169
            return null;
jaroslav@851
   170
        }
jaroslav@851
   171
        int under = mangled.indexOf("__");
jaroslav@851
   172
        return mangled.substring(0, under);
jaroslav@532
   173
    }
jaroslav@879
   174
    @JavaScriptBody(args = { "bindings", "model", "prop", "sig" }, body = 
jaroslav@879
   175
        "bindings[prop] = function(data, ev) { model[sig](data, ev); };"
jaroslav@879
   176
    )
jaroslav@879
   177
    private static void expose(
jaroslav@879
   178
        Object bindings, Object model, String prop, String sig
jaroslav@879
   179
    ) {
jaroslav@1016
   180
        WebEngine e = web();
jaroslav@1016
   181
        if (e == null) {
jaroslav@1016
   182
            return;
jaroslav@1016
   183
        }
jaroslav@990
   184
        try {
jaroslav@990
   185
            KOFunction f = new KOFunction(model, strip(sig));
jaroslav@1016
   186
            InvokeJS.KObject.call("expose", bindings, f, prop, "call");
jaroslav@990
   187
        } catch (Throwable ex) {
jaroslav@990
   188
            LOG.log(Level.SEVERE, "Cannot define binding for " + prop + " in model " + model, ex);
jaroslav@990
   189
        }
jaroslav@879
   190
    }
jaroslav@492
   191
    
jaroslav@492
   192
    @JavaScriptBody(args = { "bindings" }, body = "ko.applyBindings(bindings);")
jaroslav@851
   193
    private static void applyBindings(Object bindings) {
jaroslav@1016
   194
        if (web() != null) {
jaroslav@1016
   195
            JSObject ko = (JSObject) web().executeScript("ko");
jaroslav@1016
   196
            ko.call("applyBindings", bindings);
jaroslav@1016
   197
        }
jaroslav@851
   198
    }
jaroslav@851
   199
    
jaroslav@851
   200
    private static WebEngine web() {
jaroslav@851
   201
        return (WebEngine) System.getProperties().get("webEngine");
jaroslav@851
   202
    }
jaroslav@851
   203
    
jaroslav@909
   204
    
jaroslav@909
   205
    private static void applyImpl(
jaroslav@909
   206
        String[] propsGettersAndSetters,
jaroslav@909
   207
        Class<?> modelClass,
jaroslav@909
   208
        Object bindings,
jaroslav@909
   209
        Object model,
jaroslav@909
   210
        String[] methodsAndSignatures
jaroslav@909
   211
    ) throws IllegalStateException, SecurityException {
jaroslav@909
   212
        for (int i = 0; i < propsGettersAndSetters.length; i += 4) {
jaroslav@909
   213
            try {
jaroslav@909
   214
                Method getter = modelClass.getMethod(propsGettersAndSetters[i + 3]);
jaroslav@909
   215
                bind(bindings, model, propsGettersAndSetters[i],
jaroslav@909
   216
                    propsGettersAndSetters[i + 1],
jaroslav@909
   217
                    propsGettersAndSetters[i + 2],
jaroslav@909
   218
                    getter.getReturnType().isPrimitive(),
jaroslav@909
   219
                    List.class.isAssignableFrom(getter.getReturnType()));
jaroslav@909
   220
            } catch (NoSuchMethodException ex) {
jaroslav@909
   221
                throw new IllegalStateException(ex.getMessage());
jaroslav@909
   222
            }
jaroslav@909
   223
        }
jaroslav@909
   224
        for (int i = 0; i < methodsAndSignatures.length; i += 2) {
jaroslav@909
   225
            expose(
jaroslav@909
   226
                bindings, model, methodsAndSignatures[i], methodsAndSignatures[i + 1]);
jaroslav@909
   227
        }
jaroslav@909
   228
    }
jaroslav@1016
   229
    
jaroslav@1016
   230
    private static final class InvokeJS {
jaroslav@1016
   231
        static final JSObject KObject;
jaroslav@1016
   232
jaroslav@1016
   233
        static {
jaroslav@1016
   234
            BufferedReader r = new BufferedReader(new InputStreamReader(Knockout.class.getResourceAsStream("knockout-2.2.1.js")));
jaroslav@1016
   235
            StringBuilder sb = new StringBuilder();
jaroslav@1016
   236
            for (;;) {
jaroslav@1016
   237
                try {
jaroslav@1016
   238
                    String l = r.readLine();
jaroslav@1016
   239
                    if (l == null) {
jaroslav@1016
   240
                        break;
jaroslav@1016
   241
                    }
jaroslav@1016
   242
                    sb.append(l).append('\n');
jaroslav@1016
   243
                } catch (IOException ex) {
jaroslav@1016
   244
                    throw new IllegalStateException(ex);
jaroslav@1016
   245
                }
jaroslav@1016
   246
            }
jaroslav@1016
   247
            web().executeScript(sb.toString());
jaroslav@1016
   248
            Object ko = web().executeScript("ko");
jaroslav@1016
   249
            assert ko != null : "Knockout library successfully defined 'ko'";
jaroslav@1016
   250
jaroslav@1016
   251
            Console.register(web());
jaroslav@1016
   252
            KObject = (JSObject) web().executeScript(
jaroslav@1016
   253
                "(function(scope) {"
jaroslav@1016
   254
                + "  var kCnt = 0; "
jaroslav@1016
   255
                + "  scope.KObject = {};"
jaroslav@1016
   256
                + "  scope.KObject.create= function(value) {"
jaroslav@1016
   257
                + "    var cnt = ++kCnt;"
jaroslav@1016
   258
                + "    var ret = {};"
jaroslav@1016
   259
                + "    ret.toString = function() { return 'KObject' + cnt + ' value: ' + value + ' props: ' + Object.keys(this); };"
jaroslav@1016
   260
                + "    return ret;"
jaroslav@1016
   261
                + "  };"
jaroslav@1016
   262
                + "  scope.KObject.array= function() {"
jaroslav@1016
   263
                + "    return Array.prototype.slice.call(arguments);"
jaroslav@1016
   264
                + "  };"
jaroslav@1016
   265
                + "  scope.KObject.expose = function(bindings, model, prop, sig) {"
jaroslav@1016
   266
                + "    bindings[prop] = function(data, ev) {"
jaroslav@1016
   267
                //            + "         console.log(\"  callback on prop: \" + prop);"
jaroslav@1016
   268
                + "      model[sig](data, ev);"
jaroslav@1016
   269
                + "    };"
jaroslav@1016
   270
                + "  };"
jaroslav@1016
   271
                + "})(window); window.KObject");
jaroslav@1016
   272
        }
jaroslav@1016
   273
        
jaroslav@1016
   274
    }
jaroslav@492
   275
}