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