1 /*
2 * Copyright (c) 2010, 2013, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation. Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
25
26 package jdk.nashorn.api.scripting;
27
28 import java.lang.invoke.MethodHandle;
29 import jdk.internal.dynalink.beans.StaticClass;
30 import jdk.internal.dynalink.linker.LinkerServices;
31 import jdk.nashorn.internal.runtime.Context;
32 import jdk.nashorn.internal.runtime.ScriptFunction;
33 import jdk.nashorn.internal.runtime.ScriptObject;
34 import jdk.nashorn.internal.runtime.ScriptRuntime;
35 import jdk.nashorn.internal.runtime.linker.Bootstrap;
36
37 /**
38 * Utilities that are to be called from script code.
39 *
40 * @since 1.8u40
41 */
42 @jdk.Exported
43 public final class ScriptUtils {
44 private ScriptUtils() {}
45
46 /**
47 * Returns AST as JSON compatible string. This is used to
48 * implement "parse" function in resources/parse.js script.
49 *
50 * @param code code to be parsed
51 * @param name name of the code source (used for location)
52 * @param includeLoc tells whether to include location information for nodes or not
53 * @return JSON string representation of AST of the supplied code
54 */
55 public static String parse(final String code, final String name, final boolean includeLoc) {
56 return ScriptRuntime.parse(code, name, includeLoc);
57 }
58
59 /**
60 * Method which converts javascript types to java types for the
61 * String.format method (jrunscript function sprintf).
62 *
63 * @param format a format string
64 * @param args arguments referenced by the format specifiers in format
65 * @return a formatted string
66 */
67 public static String format(final String format, final Object[] args) {
68 return Formatter.format(format, args);
69 }
70
71 /**
72 * Create a wrapper function that calls {@code func} synchronized on {@code sync} or, if that is undefined,
73 * {@code self}. Used to implement "sync" function in resources/mozilla_compat.js.
74 *
75 * @param func the function to wrap
76 * @param sync the object to synchronize on
77 * @return a synchronizing wrapper function
78 */
79 public static Object makeSynchronizedFunction(final ScriptFunction func, final Object sync) {
80 return func.makeSynchronizedFunction(unwrap(sync));
81 }
82
83 /**
84 * Make a script object mirror on given object if needed.
85 *
86 * @param obj object to be wrapped
87 * @return wrapped object
88 */
89 public static ScriptObjectMirror wrap(final ScriptObject obj) {
90 return (ScriptObjectMirror) ScriptObjectMirror.wrap(obj, Context.getGlobal());
91 }
92
93 /**
94 * Unwrap a script object mirror if needed.
95 *
96 * @param obj object to be unwrapped
97 * @return unwrapped object
98 */
99 public static Object unwrap(final Object obj) {
100 if (obj instanceof ScriptObjectMirror) {
101 return ScriptObjectMirror.unwrap(obj, Context.getGlobal());
102 }
103
104 return obj;
105 }
106
107 /**
108 * Wrap an array of object to script object mirrors if needed.
109 *
110 * @param args array to be unwrapped
111 * @return wrapped array
112 */
113 public static Object[] wrapArray(final Object[] args) {
114 if (args == null || args.length == 0) {
115 return args;
116 }
117
118 return ScriptObjectMirror.wrapArray(args, Context.getGlobal());
119 }
120
121 /**
122 * Unwrap an array of script object mirrors if needed.
123 *
124 * @param args array to be unwrapped
125 * @return unwrapped array
126 */
127 public static Object[] unwrapArray(final Object[] args) {
128 if (args == null || args.length == 0) {
129 return args;
130 }
131
132 return ScriptObjectMirror.unwrapArray(args, Context.getGlobal());
133 }
134
135 /**
136 * Convert the given object to the given type.
137 *
138 * @param obj object to be converted
139 * @param type destination type to convert to
140 * @return converted object
141 */
142 public static Object convert(final Object obj, final Object type) {
143 if (obj == null) {
144 return null;
145 }
146
147 final Class<?> clazz;
148 if (type instanceof Class) {
149 clazz = (Class<?>)type;
150 } else if (type instanceof StaticClass) {
151 clazz = ((StaticClass)type).getRepresentedClass();
152 } else {
153 throw new IllegalArgumentException("type expected");
154 }
155
156 final LinkerServices linker = Bootstrap.getLinkerServices();
157 final Object objToConvert = unwrap(obj);
158 final MethodHandle converter = linker.getTypeConverter(objToConvert.getClass(), clazz);
159 if (converter == null) {
160 // no supported conversion!
161 throw new UnsupportedOperationException("conversion not supported");
162 }
163
164 try {
165 return converter.invoke(objToConvert);
166 } catch (final RuntimeException | Error e) {
167 throw e;
168 } catch (final Throwable t) {
169 throw new RuntimeException(t);
170 }
171 }
172 }