javaquery/api/src/main/java/org/apidesign/bck2brwsr/htmlpage/Knockout.java
author Jaroslav Tulach <jaroslav.tulach@apidesign.org>
Thu, 11 Apr 2013 20:44:46 +0200
branchfx
changeset 969 df08556c5c7c
parent 852 671fc517fe17
parent 909 e51a474fcf79
child 970 8fefdd067b9e
permissions -rw-r--r--
Merging in default branch before release 0.6 is created. Code compiles.
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@851
    60
    }
jaroslav@851
    61
    
jaroslav@851
    62
    
jaroslav@909
    63
    Knockout(Object model) {
jaroslav@909
    64
        this.model = model == null ? this : model;
jaroslav@492
    65
    }
jaroslav@492
    66
    
jaroslav@496
    67
    public static <M> Knockout applyBindings(
jaroslav@909
    68
        Object model, String[] propsGettersAndSetters,
jaroslav@909
    69
        String[] methodsAndSignatures
jaroslav@909
    70
    ) {
jaroslav@909
    71
        applyImpl(propsGettersAndSetters, model.getClass(), model, model, methodsAndSignatures);
jaroslav@909
    72
        return new Knockout(model);
jaroslav@909
    73
    }
jaroslav@909
    74
    public static <M> Knockout applyBindings(
jaroslav@879
    75
        Class<M> modelClass, M model, String[] propsGettersAndSetters,
jaroslav@879
    76
        String[] methodsAndSignatures
jaroslav@492
    77
    ) {
jaroslav@851
    78
        Object bindings = next;
jaroslav@499
    79
        next = null;
jaroslav@499
    80
        if (bindings == null) {
jaroslav@851
    81
            bindings = web().executeScript("new Object()");
jaroslav@499
    82
        }
jaroslav@909
    83
        applyImpl(propsGettersAndSetters, modelClass, bindings, model, methodsAndSignatures);
jaroslav@492
    84
        applyBindings(bindings);
jaroslav@851
    85
        return new Knockout(bindings);
jaroslav@496
    86
    }
jaroslav@496
    87
jaroslav@909
    88
    public void valueHasMutated(String prop) {
jaroslav@852
    89
        LOG.log(Level.FINE, "property mutated: {0}", prop);
jaroslav@969
    90
        JSObject koProp = (JSObject) ((JSObject)model).getMember(prop);
jaroslav@851
    91
        koProp.call("valueHasMutated");
jaroslav@492
    92
    }
jaroslav@492
    93
    
jaroslav@530
    94
jaroslav@530
    95
    @JavaScriptBody(args = { "id", "ev" }, body = "ko.utils.triggerEvent(window.document.getElementById(id), ev.substring(2));")
jaroslav@530
    96
    public static void triggerEvent(String id, String ev) {
jaroslav@530
    97
    }
jaroslav@530
    98
    
jaroslav@887
    99
    @JavaScriptBody(args = { "bindings", "model", "prop", "getter", "setter", "primitive", "array" }, body =
jaroslav@492
   100
          "var bnd = {\n"
lubomir@869
   101
        + "  'read': function() {\n"
jaroslav@492
   102
        + "    var v = model[getter]();\n"
jaroslav@887
   103
        + "    if (array) v = v.koArray();\n"
jaroslav@492
   104
        + "    return v;\n"
jaroslav@492
   105
        + "  },\n"
lubomir@869
   106
        + "  'owner': bindings\n"
jaroslav@492
   107
        + "};\n"
jaroslav@492
   108
        + "if (setter != null) {\n"
lubomir@869
   109
        + "  bnd['write'] = function(val) {\n"
jaroslav@530
   110
        + "    model[setter](primitive ? new Number(val) : val);\n"
jaroslav@492
   111
        + "  };\n"
jaroslav@492
   112
        + "}\n"
lubomir@869
   113
        + "bindings[prop] = ko['computed'](bnd);"
jaroslav@492
   114
    )
jaroslav@492
   115
    private static void bind(
jaroslav@887
   116
        Object bindings, Object model, String prop, String getter, String setter, boolean primitive, boolean array
jaroslav@492
   117
    ) {
jaroslav@851
   118
        WebEngine e = web();
jaroslav@851
   119
        JSObject bnd = (JSObject) e.executeScript("var x = {}; x.bnd = "
jaroslav@851
   120
        + "new Function('ko', 'bindings', 'model', 'prop', 'getter', 'setter', 'primitive', '"
jaroslav@851
   121
        + "var bnd = {"
jaroslav@851
   122
        + "  read: function() {"
jaroslav@851
   123
        + "    try {"
jaroslav@851
   124
        + "      return model[getter]();"
jaroslav@851
   125
        + "    } catch (e) {"
jaroslav@851
   126
        + "      alert(\"Cannot call \" + getter + \" on \" + model + \" error: \" + e);"
jaroslav@851
   127
        + "    }"
jaroslav@851
   128
        + "  },"
jaroslav@851
   129
        + "  owner: bindings"
jaroslav@851
   130
        + "};"
jaroslav@851
   131
        + "if (setter != null) {"
jaroslav@851
   132
        + "  bnd.write = function(val) {"
jaroslav@851
   133
        + "    model[setter](primitive ? new Number(val) : val);"
jaroslav@851
   134
        + "  };"
jaroslav@851
   135
        + "};"
jaroslav@851
   136
        + "bindings[prop] = ko.computed(bnd);'"
jaroslav@851
   137
        + "); x;");
jaroslav@851
   138
        
jaroslav@851
   139
        Object ko = e.executeScript("ko");
jaroslav@851
   140
        bnd.call("bnd", ko, bindings, model, prop, strip(getter), strip(setter), primitive);
jaroslav@852
   141
        LOG.log(Level.FINE, "binding defined for {0}: {1}", new Object[]{prop, ((JSObject)bindings).getMember(prop)});
jaroslav@492
   142
    }
jaroslav@851
   143
    
jaroslav@851
   144
    private static String strip(String mangled) {
jaroslav@851
   145
        if (mangled == null) {
jaroslav@851
   146
            return null;
jaroslav@851
   147
        }
jaroslav@851
   148
        int under = mangled.indexOf("__");
jaroslav@851
   149
        return mangled.substring(0, under);
jaroslav@532
   150
    }
jaroslav@879
   151
    @JavaScriptBody(args = { "bindings", "model", "prop", "sig" }, body = 
jaroslav@879
   152
        "bindings[prop] = function(data, ev) { model[sig](data, ev); };"
jaroslav@879
   153
    )
jaroslav@879
   154
    private static void expose(
jaroslav@879
   155
        Object bindings, Object model, String prop, String sig
jaroslav@879
   156
    ) {
jaroslav@879
   157
    }
jaroslav@492
   158
    
jaroslav@492
   159
    @JavaScriptBody(args = { "bindings" }, body = "ko.applyBindings(bindings);")
jaroslav@851
   160
    private static void applyBindings(Object bindings) {
jaroslav@851
   161
        JSObject ko = (JSObject) web().executeScript("ko");
jaroslav@851
   162
        ko.call("applyBindings", bindings);
jaroslav@851
   163
    }
jaroslav@851
   164
    
jaroslav@851
   165
    private static WebEngine web() {
jaroslav@851
   166
        return (WebEngine) System.getProperties().get("webEngine");
jaroslav@851
   167
    }
jaroslav@851
   168
    
jaroslav@909
   169
    
jaroslav@909
   170
    private static void applyImpl(
jaroslav@909
   171
        String[] propsGettersAndSetters,
jaroslav@909
   172
        Class<?> modelClass,
jaroslav@909
   173
        Object bindings,
jaroslav@909
   174
        Object model,
jaroslav@909
   175
        String[] methodsAndSignatures
jaroslav@909
   176
    ) throws IllegalStateException, SecurityException {
jaroslav@909
   177
        for (int i = 0; i < propsGettersAndSetters.length; i += 4) {
jaroslav@909
   178
            try {
jaroslav@909
   179
                Method getter = modelClass.getMethod(propsGettersAndSetters[i + 3]);
jaroslav@909
   180
                bind(bindings, model, propsGettersAndSetters[i],
jaroslav@909
   181
                    propsGettersAndSetters[i + 1],
jaroslav@909
   182
                    propsGettersAndSetters[i + 2],
jaroslav@909
   183
                    getter.getReturnType().isPrimitive(),
jaroslav@909
   184
                    List.class.isAssignableFrom(getter.getReturnType()));
jaroslav@909
   185
            } catch (NoSuchMethodException ex) {
jaroslav@909
   186
                throw new IllegalStateException(ex.getMessage());
jaroslav@909
   187
            }
jaroslav@909
   188
        }
jaroslav@909
   189
        for (int i = 0; i < methodsAndSignatures.length; i += 2) {
jaroslav@909
   190
            expose(
jaroslav@909
   191
                bindings, model, methodsAndSignatures[i], methodsAndSignatures[i + 1]);
jaroslav@909
   192
        }
jaroslav@909
   193
    }
jaroslav@492
   194
}