2 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
4 * Copyright 2013-2014 Oracle and/or its affiliates. All rights reserved.
6 * Oracle and Java are registered trademarks of Oracle and/or its affiliates.
7 * Other names may be trademarks of their respective owners.
9 * The contents of this file are subject to the terms of either the GNU
10 * General Public License Version 2 only ("GPL") or the Common
11 * Development and Distribution License("CDDL") (collectively, the
12 * "License"). You may not use this file except in compliance with the
13 * License. You can obtain a copy of the License at
14 * http://www.netbeans.org/cddl-gplv2.html
15 * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
16 * specific language governing permissions and limitations under the
17 * License. When distributing the software, include this License Header
18 * Notice in each file and include the License file at
19 * nbbuild/licenses/CDDL-GPL-2-CP. Oracle designates this
20 * particular file as subject to the "Classpath" exception as provided
21 * by Oracle in the GPL Version 2 section of the License file that
22 * accompanied this code. If applicable, add the following below the
23 * License Header, with the fields enclosed by brackets [] replaced by
24 * your own identifying information:
25 * "Portions Copyrighted [year] [name of copyright owner]"
29 * The Original Software is NetBeans. The Initial Developer of the Original
30 * Software is Oracle. Portions Copyright 2013-2014 Oracle. All Rights Reserved.
32 * If you wish your version of this file to be governed by only the CDDL
33 * or only the GPL Version 2, indicate your decision by adding
34 * "[Contributor] elects to include this software in this distribution
35 * under the [CDDL or GPL Version 2] license." If you do not indicate a
36 * single choice of license, a recipient has the option to distribute
37 * your version of this file under either the CDDL, the GPL Version 2 or
38 * to extend the choice of license to its licensees as provided above.
39 * However, if you add GPL Version 2 code and therefore, elected the GPL
40 * Version 2 license, then the option applies only if the new code is
41 * made subject to such option by the copyright holder.
43 package org.apidesign.html.boot.spi;
45 import java.io.Closeable;
46 import java.io.InputStream;
47 import java.io.InputStreamReader;
48 import java.io.Reader;
50 import java.util.HashMap;
51 import java.util.HashSet;
54 import java.util.concurrent.Executor;
55 import net.java.html.js.JavaScriptBody;
56 import org.netbeans.html.boot.impl.FnContext;
58 /** Represents single JavaScript function that can be invoked.
59 * Created via {@link Presenter#defineFn(java.lang.String, java.lang.String...)}.
61 * @author Jaroslav Tulach <jaroslav.tulach@apidesign.org>
63 public abstract class Fn {
64 private final Presenter presenter;
67 * @deprecated Ineffective as of 0.6.
68 * Provide a presenter via {@link #Fn(org.apidesign.html.boot.spi.Fn.Presenter)}
76 /** Creates new function object and associates it with given presenter.
78 * @param presenter the browser presenter associated with this function
81 protected Fn(Presenter presenter) {
82 this.presenter = presenter;
85 /** True, if currently active presenter is the same as presenter this
86 * function has been created for via {@link #Fn(org.apidesign.html.boot.spi.Fn.Presenter)}.
88 * @return true, if proper presenter is used
90 public final boolean isValid() {
91 return presenter != null && FnContext.currentPresenter(false) == presenter;
94 /** Helper method to check if the provided instance is valid function.
95 * Checks if the parameter is non-null and if so, does {@link #isValid()}
98 * @param fnOrNull function or <code>null</code>
99 * @return true if the parameter is non-null and valid
102 public static boolean isValid(Fn fnOrNull) {
103 return fnOrNull != null && fnOrNull.isValid();
106 /** Helper method to find current presenter and ask it to define new
107 * function by calling {@link Presenter#defineFn(java.lang.String, java.lang.String...)}.
109 * @param caller the class who wishes to define the function
110 * @param code the body of the function (can reference <code>this</code> and <code>names</code> variables)
111 * @param names names of individual parameters
112 * @return the function object that can be {@link Fn#invoke(java.lang.Object, java.lang.Object...) invoked}
113 * - can return <code>null</code> if there is {@link #activePresenter() no presenter}
116 public static Fn define(Class<?> caller, String code, String... names) {
117 final Presenter p = FnContext.currentPresenter(false);
118 return p == null ? null : p.defineFn(code, names);
121 private static final Map<String,Set<Presenter>> LOADED = new HashMap<String, Set<Presenter>>();
123 /** Wraps function to ensure that the script represented by <code>resource</code>
124 * gets loaded into the browser environment before the function <code>fn</code>
127 * @param fn original function to call
128 * @param caller the class who wishes to define/call the function
129 * @param resource resources (accessible via {@link ClassLoader#getResource(java.lang.String)})
130 * with a <em>JavaScript</em> that is supposed to loaded into the browser
132 * @return function that ensures the script is loaded and then delegates
136 public static Fn preload(final Fn fn, final Class<?> caller, final String resource) {
139 public Object invoke(Object thiz, Object... args) throws Exception {
140 final Presenter p = FnContext.currentPresenter(false);
141 Set<Presenter> there = LOADED.get(resource);
143 there = new HashSet<Presenter>();
144 LOADED.put(resource, there);
147 InputStream is = caller.getClassLoader().getResourceAsStream(resource);
149 InputStreamReader r = new InputStreamReader(is, "UTF-8");
155 return fn.invoke(thiz, args);
160 /** The currently active presenter.
162 * @return the currently active presenter or <code>null</code>
165 public static Presenter activePresenter() {
166 return FnContext.currentPresenter(false);
169 /** Activates given presenter. Used by the code generated by
170 * {@link JavaScriptBody} annotation:
172 * try ({@link Closeable} c = Fn.activate(presenter)) {
173 * doCallsInPresenterContext();
177 * @param p the presenter that should be active until closable is closed
178 * @return the closable to close
181 public static Closeable activate(Presenter p) {
182 return FnContext.activate(p);
185 /** Invokes the defined function with specified <code>this</code> and
186 * appropriate arguments.
188 * @param thiz the meaning of <code>this</code> inside of the JavaScript
189 * function - can be <code>null</code>
190 * @param args arguments for the function
191 * @return return value from the function
192 * @throws Exception if something goes wrong, as exception may be thrown
194 public abstract Object invoke(Object thiz, Object... args) throws Exception;
196 /** Provides the function implementation access to the presenter provided
197 * in {@link #Fn(org.apidesign.html.boot.spi.Fn.Presenter) the constructor}.
199 * @return presenter passed in the constructor (may be, but should not be <code>null</code>)
202 protected final Presenter presenter() {
206 /** The representation of a <em>presenter</em> - usually a browser window.
207 * Should be provided by a library included in the application and registered
208 * in <code>META-INF/services</code>, for example with
209 * <code>@ServiceProvider(service = Fn.Presenter.class)</code> annotation.
211 * Since 0.7 a presenter may implement {@link Executor} interface, in case
212 * it supports single threaded execution environment. The executor's
213 * {@link Executor#execute(java.lang.Runnable)} method is then supposed
214 * to invoke the runnable immediately (in case we are on the right thread
215 * already) or return and asynchronously invoke the runnable later on the
216 * right thread (if we are on wrong thread).
218 public interface Presenter {
219 /** Creates new function with given parameter names and provided body.
221 * @param code the body of the function. Can refer to variables named
222 * as <code>names</code>
223 * @param names names of parameters of the function - these will be
224 * available when the <code>code</code> body executes
226 * @return function that can be later invoked
228 public Fn defineFn(String code, String... names);
230 /** Opens the browser, loads provided page and when the
231 * page is ready, it calls back to the provider runnable.
233 * @param page the URL for the page to display
234 * @param onPageLoad callback when the page is ready
236 public void displayPage(URL page, Runnable onPageLoad);
238 /** Loads a script into the browser JavaScript interpreter and
240 * @param code the script to execute
241 * @throws Exception if something goes wrong, throw an exception
243 public void loadScript(Reader code) throws Exception;
246 /** Additional interface to be implemented by {@link Presenter}s that
247 * wish to control what objects are passed into the JavaScript virtual
250 * If a JavaScript engine makes callback to Java method that returns
251 * a value, the {@link #toJavaScript(java.lang.Object)} method is
252 * consulted to convert the Java value to something reasonable inside
255 * <em>Note:</em> The implementation based on <em>JavaFX</em> <code>WebView</code>
256 * uses this interface to convert Java arrays to JavaScript ones.
261 public interface ToJavaScript {
262 /** Convert a Java return value into some object suitable for
263 * JavaScript virtual machine.
265 * @param toReturn the Java object to be returned
266 * @return the replacement value to return instead
268 public Object toJavaScript(Object toReturn);
271 /** Additional interface to be implemented by {@link Presenter}s that
272 * need to convert JavaScript object (usually array) to Java object
273 * when calling back from JavaScript to Java.
275 * <em>Note:</em> The implementation based on <em>JavaFX</em>
276 * <code>WebView</code> uses this interface to convert JavaScript arrays to
281 public interface FromJavaScript {
282 /** Convert a JavaScript object into suitable Java representation
283 * before a Java method is called with this object as an argument.
285 * @param js the JavaScript object
286 * @return replacement object for
288 public Object toJava(Object js);