rev 1131 : 8068431: @since and @jdk.Exported are missing in jdk.nashorn.api.scripting classes and package-info.java files
Reviewed-by: attila, lagergren

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