aoqi@0: /* aoqi@0: * Copyright (c) 2010, 2013, Oracle and/or its affiliates. All rights reserved. aoqi@0: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. aoqi@0: * aoqi@0: * This code is free software; you can redistribute it and/or modify it aoqi@0: * under the terms of the GNU General Public License version 2 only, as aoqi@0: * published by the Free Software Foundation. Oracle designates this aoqi@0: * particular file as subject to the "Classpath" exception as provided aoqi@0: * by Oracle in the LICENSE file that accompanied this code. aoqi@0: * aoqi@0: * This code is distributed in the hope that it will be useful, but WITHOUT aoqi@0: * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or aoqi@0: * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License aoqi@0: * version 2 for more details (a copy is included in the LICENSE file that aoqi@0: * accompanied this code). aoqi@0: * aoqi@0: * You should have received a copy of the GNU General Public License version aoqi@0: * 2 along with this work; if not, write to the Free Software Foundation, aoqi@0: * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. aoqi@0: * aoqi@0: * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA aoqi@0: * or visit www.oracle.com if you need additional information or have any aoqi@0: * questions. aoqi@0: */ aoqi@0: aoqi@0: /* aoqi@0: * This file is available under and governed by the GNU General Public aoqi@0: * License version 2 only, as published by the Free Software Foundation. aoqi@0: * However, the following notice accompanied the original version of this aoqi@0: * file, and Oracle licenses the original version of this file under the BSD aoqi@0: * license: aoqi@0: */ aoqi@0: /* aoqi@0: Copyright 2009-2013 Attila Szegedi aoqi@0: aoqi@0: Licensed under both the Apache License, Version 2.0 (the "Apache License") aoqi@0: and the BSD License (the "BSD License"), with licensee being free to aoqi@0: choose either of the two at their discretion. aoqi@0: aoqi@0: You may not use this file except in compliance with either the Apache aoqi@0: License or the BSD License. aoqi@0: aoqi@0: If you choose to use this file in compliance with the Apache License, the aoqi@0: following notice applies to you: aoqi@0: aoqi@0: You may obtain a copy of the Apache License at aoqi@0: aoqi@0: http://www.apache.org/licenses/LICENSE-2.0 aoqi@0: aoqi@0: Unless required by applicable law or agreed to in writing, software aoqi@0: distributed under the License is distributed on an "AS IS" BASIS, aoqi@0: WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or aoqi@0: implied. See the License for the specific language governing aoqi@0: permissions and limitations under the License. aoqi@0: aoqi@0: If you choose to use this file in compliance with the BSD License, the aoqi@0: following notice applies to you: aoqi@0: aoqi@0: Redistribution and use in source and binary forms, with or without aoqi@0: modification, are permitted provided that the following conditions are aoqi@0: met: aoqi@0: * Redistributions of source code must retain the above copyright aoqi@0: notice, this list of conditions and the following disclaimer. aoqi@0: * Redistributions in binary form must reproduce the above copyright aoqi@0: notice, this list of conditions and the following disclaimer in the aoqi@0: documentation and/or other materials provided with the distribution. aoqi@0: * Neither the name of the copyright holder nor the names of aoqi@0: contributors may be used to endorse or promote products derived from aoqi@0: this software without specific prior written permission. aoqi@0: aoqi@0: THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS aoqi@0: IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED aoqi@0: TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A aoqi@0: PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL COPYRIGHT HOLDER aoqi@0: BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR aoqi@0: CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF aoqi@0: SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR aoqi@0: BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, aoqi@0: WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR aoqi@0: OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF aoqi@0: ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. aoqi@0: */ aoqi@0: aoqi@0: package jdk.internal.dynalink.support; aoqi@0: aoqi@0: import jdk.internal.dynalink.CallSiteDescriptor; aoqi@0: aoqi@0: /** aoqi@0: * Implements the name mangling and demangling as specified by John Rose's aoqi@0: * "Symbolic Freedom in the aoqi@0: * VM" article. It is recommended that implementers of languages on the JVM uniformly adopt this for symbolic aoqi@0: * interoperability between languages. Normally, you would mangle the names as you're generating bytecode, and then aoqi@0: * demangle them when you're creating {@link CallSiteDescriptor} objects. Note that you are expected to mangle aoqi@0: * individual tokens, and not the whole name at the call site, i.e. the colon character normally separating the tokens aoqi@0: * is never mangled. I.e. you wouldn't mangle {@code dyn:getProp:color} into {@code dyn\!getProp\!color}, but you would aoqi@0: * mangle {@code dyn:getProp:color$} into {@code dyn:getProp:\=color\%} (only mangling the individual token containing aoqi@0: * the symbol {@code color$}). {@link CallSiteDescriptorFactory#tokenizeName(String)} (and by implication, all call site aoqi@0: * descriptors it creates) will automatically perform demangling on the passed names. If you use this factory, or you aoqi@0: * have your own way of creating call site descriptors, but you still delegate to this method of the default factory aoqi@0: * (it is recommended that you do), then you have demangling handled for you already, and only need to ensure that you aoqi@0: * mangle the names when you're emitting them in the bytecode. aoqi@0: * aoqi@0: * @author Attila Szegedi aoqi@0: */ aoqi@0: public class NameCodec { aoqi@0: private static final char ESCAPE_CHAR = '\\'; aoqi@0: private static final char EMPTY_ESCAPE = '='; aoqi@0: private static final String EMPTY_NAME = new String(new char[] { ESCAPE_CHAR, EMPTY_ESCAPE }); aoqi@0: private static final char EMPTY_CHAR = 0xFEFF; aoqi@0: aoqi@0: private static final int MIN_ENCODING = '$'; aoqi@0: private static final int MAX_ENCODING = ']'; aoqi@0: private static final char[] ENCODING = new char[MAX_ENCODING - MIN_ENCODING + 1]; aoqi@0: private static final int MIN_DECODING = '!'; aoqi@0: private static final int MAX_DECODING = '}'; aoqi@0: private static final char[] DECODING = new char[MAX_DECODING - MIN_DECODING + 1]; aoqi@0: aoqi@0: static { aoqi@0: addEncoding('/', '|'); aoqi@0: addEncoding('.', ','); aoqi@0: addEncoding(';', '?'); aoqi@0: addEncoding('$', '%'); aoqi@0: addEncoding('<', '^'); aoqi@0: addEncoding('>', '_'); aoqi@0: addEncoding('[', '{'); aoqi@0: addEncoding(']', '}'); aoqi@0: addEncoding(':', '!'); aoqi@0: addEncoding('\\', '-'); aoqi@0: DECODING[EMPTY_ESCAPE - MIN_DECODING] = EMPTY_CHAR; aoqi@0: } aoqi@0: aoqi@0: private NameCodec() { aoqi@0: } aoqi@0: aoqi@0: /** aoqi@0: * Encodes ("mangles") an unencoded symbolic name. aoqi@0: * @param name the symbolic name to mangle aoqi@0: * @return the mangled form of the symbolic name. aoqi@0: */ aoqi@0: public static String encode(String name) { aoqi@0: final int l = name.length(); aoqi@0: if(l == 0) { aoqi@0: return EMPTY_NAME; aoqi@0: } aoqi@0: StringBuilder b = null; aoqi@0: int lastEscape = -1; aoqi@0: for(int i = 0; i < l; ++i) { aoqi@0: final int encodeIndex = name.charAt(i) - MIN_ENCODING; aoqi@0: if(encodeIndex >= 0 && encodeIndex < ENCODING.length) { aoqi@0: final char e = ENCODING[encodeIndex]; aoqi@0: if(e != 0) { aoqi@0: if(b == null) { aoqi@0: b = new StringBuilder(name.length() + 3); aoqi@0: if(name.charAt(0) != ESCAPE_CHAR && i > 0) { aoqi@0: b.append(EMPTY_NAME); aoqi@0: } aoqi@0: b.append(name, 0, i); aoqi@0: } else { aoqi@0: b.append(name, lastEscape + 1, i); aoqi@0: } aoqi@0: b.append(ESCAPE_CHAR).append(e); aoqi@0: lastEscape = i; aoqi@0: } aoqi@0: } aoqi@0: } aoqi@0: if(b == null) { aoqi@0: return name.toString(); aoqi@0: } aoqi@0: assert lastEscape != -1; aoqi@0: b.append(name, lastEscape + 1, l); aoqi@0: return b.toString(); aoqi@0: } aoqi@0: aoqi@0: /** aoqi@0: * Decodes ("demangles") an encoded symbolic name. aoqi@0: * @param name the symbolic name to demangle aoqi@0: * @return the demangled form of the symbolic name. aoqi@0: */ aoqi@0: public static String decode(String name) { aoqi@0: if(name.charAt(0) != ESCAPE_CHAR) { aoqi@0: return name; aoqi@0: } aoqi@0: final int l = name.length(); aoqi@0: if(l == 2 && name.charAt(1) == EMPTY_CHAR) { aoqi@0: return ""; aoqi@0: } aoqi@0: StringBuilder b = new StringBuilder(name.length()); aoqi@0: int lastEscape = -2; aoqi@0: int lastBackslash = -1; aoqi@0: for(;;) { aoqi@0: int nextBackslash = name.indexOf(ESCAPE_CHAR, lastBackslash + 1); aoqi@0: if(nextBackslash == -1 || nextBackslash == l - 1) { aoqi@0: break; aoqi@0: } aoqi@0: final int decodeIndex = name.charAt(nextBackslash + 1) - MIN_DECODING; aoqi@0: if(decodeIndex >= 0 && decodeIndex < DECODING.length) { aoqi@0: final char d = DECODING[decodeIndex]; aoqi@0: if(d == EMPTY_CHAR) { aoqi@0: // "\=" is only valid at the beginning of a mangled string aoqi@0: if(nextBackslash == 0) { aoqi@0: lastEscape = 0; aoqi@0: } aoqi@0: } else if(d != 0) { aoqi@0: b.append(name, lastEscape + 2, nextBackslash).append(d); aoqi@0: lastEscape = nextBackslash; aoqi@0: } aoqi@0: } aoqi@0: lastBackslash = nextBackslash; aoqi@0: } aoqi@0: b.append(name, lastEscape + 2, l); aoqi@0: return b.toString(); aoqi@0: } aoqi@0: aoqi@0: private static void addEncoding(char from, char to) { aoqi@0: ENCODING[from - MIN_ENCODING] = to; aoqi@0: DECODING[to - MIN_DECODING] = from; aoqi@0: } aoqi@0: }