ScriptUtils.java revision 1057:a8d44c7c2ac0
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 26package jdk.nashorn.api.scripting; 27 28import static jdk.nashorn.internal.runtime.ECMAErrors.typeError; 29 30import java.lang.invoke.MethodHandle; 31import jdk.internal.dynalink.beans.StaticClass; 32import jdk.internal.dynalink.linker.LinkerServices; 33import jdk.nashorn.internal.runtime.Context; 34import jdk.nashorn.internal.runtime.ScriptFunction; 35import jdk.nashorn.internal.runtime.ScriptObject; 36import jdk.nashorn.internal.runtime.ScriptRuntime; 37import jdk.nashorn.internal.runtime.linker.Bootstrap; 38 39/** 40 * Utilities that are to be called from script code. 41 */ 42public final class ScriptUtils { 43 private ScriptUtils() {} 44 45 /** 46 * Returns AST as JSON compatible string. This is used to 47 * implement "parse" function in resources/parse.js script. 48 * 49 * @param code code to be parsed 50 * @param name name of the code source (used for location) 51 * @param includeLoc tells whether to include location information for nodes or not 52 * @return JSON string representation of AST of the supplied code 53 */ 54 public static String parse(final String code, final String name, final boolean includeLoc) { 55 return ScriptRuntime.parse(code, name, includeLoc); 56 } 57 58 /** 59 * Method which converts javascript types to java types for the 60 * String.format method (jrunscript function sprintf). 61 * 62 * @param format a format string 63 * @param args arguments referenced by the format specifiers in format 64 * @return a formatted string 65 */ 66 public static String format(final String format, final Object[] args) { 67 return Formatter.format(format, args); 68 } 69 70 /** 71 * Create a wrapper function that calls {@code func} synchronized on {@code sync} or, if that is undefined, 72 * {@code self}. Used to implement "sync" function in resources/mozilla_compat.js. 73 * 74 * @param func the function to wrap 75 * @param sync the object to synchronize on 76 * @return a synchronizing wrapper function 77 */ 78 public static Object makeSynchronizedFunction(final ScriptFunction func, final Object sync) { 79 return func.makeSynchronizedFunction(unwrap(sync)); 80 } 81 82 /** 83 * Make a script object mirror on given object if needed. 84 * 85 * @param obj object to be wrapped 86 * @return wrapped object 87 */ 88 public static ScriptObjectMirror wrap(final ScriptObject obj) { 89 return (ScriptObjectMirror) ScriptObjectMirror.wrap(obj, Context.getGlobal()); 90 } 91 92 /** 93 * Unwrap a script object mirror if needed. 94 * 95 * @param obj object to be unwrapped 96 * @return unwrapped object 97 */ 98 public static Object unwrap(final Object obj) { 99 if (obj instanceof ScriptObjectMirror) { 100 return ScriptObjectMirror.unwrap(obj, Context.getGlobal()); 101 } 102 103 return obj; 104 } 105 106 /** 107 * Wrap an array of object to script object mirrors if needed. 108 * 109 * @param args array to be unwrapped 110 * @return wrapped array 111 */ 112 public static Object[] wrapArray(final Object[] args) { 113 if (args == null || args.length == 0) { 114 return args; 115 } 116 117 return ScriptObjectMirror.wrapArray(args, Context.getGlobal()); 118 } 119 120 /** 121 * Unwrap an array of script object mirrors if needed. 122 * 123 * @param args array to be unwrapped 124 * @return unwrapped array 125 */ 126 public static Object[] unwrapArray(final Object[] args) { 127 if (args == null || args.length == 0) { 128 return args; 129 } 130 131 return ScriptObjectMirror.unwrapArray(args, Context.getGlobal()); 132 } 133 134 /** 135 * Convert the given object to the given type. 136 * 137 * @param obj object to be converted 138 * @param type destination type to convert to 139 * @return converted object 140 */ 141 public static Object convert(final Object obj, final Object type) { 142 if (obj == null) { 143 return null; 144 } 145 146 final Class<?> clazz; 147 if (type instanceof Class) { 148 clazz = (Class<?>)type; 149 } else if (type instanceof StaticClass) { 150 clazz = ((StaticClass)type).getRepresentedClass(); 151 } else { 152 throw new IllegalArgumentException("type expected"); 153 } 154 155 final LinkerServices linker = Bootstrap.getLinkerServices(); 156 final Object objToConvert = unwrap(obj); 157 final MethodHandle converter = linker.getTypeConverter(objToConvert.getClass(), clazz); 158 if (converter == null) { 159 // no supported conversion! 160 throw new UnsupportedOperationException("conversion not supported"); 161 } 162 163 try { 164 return converter.invoke(objToConvert); 165 } catch (final RuntimeException | Error e) { 166 throw e; 167 } catch (final Throwable t) { 168 throw new RuntimeException(t); 169 } 170 } 171} 172