src/jdk/internal/dynalink/support/NameCodec.java

changeset 90
5a820fb11814
parent 0
b1a7da25b547
child 962
ac62e33a99b0
equal deleted inserted replaced
89:43e32b36153c 90:5a820fb11814
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 /*
27 * This file is available under and governed by the GNU General Public
28 * License version 2 only, as published by the Free Software Foundation.
29 * However, the following notice accompanied the original version of this
30 * file, and Oracle licenses the original version of this file under the BSD
31 * license:
32 */
33 /*
34 Copyright 2009-2013 Attila Szegedi
35
36 Licensed under both the Apache License, Version 2.0 (the "Apache License")
37 and the BSD License (the "BSD License"), with licensee being free to
38 choose either of the two at their discretion.
39
40 You may not use this file except in compliance with either the Apache
41 License or the BSD License.
42
43 If you choose to use this file in compliance with the Apache License, the
44 following notice applies to you:
45
46 You may obtain a copy of the Apache License at
47
48 http://www.apache.org/licenses/LICENSE-2.0
49
50 Unless required by applicable law or agreed to in writing, software
51 distributed under the License is distributed on an "AS IS" BASIS,
52 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
53 implied. See the License for the specific language governing
54 permissions and limitations under the License.
55
56 If you choose to use this file in compliance with the BSD License, the
57 following notice applies to you:
58
59 Redistribution and use in source and binary forms, with or without
60 modification, are permitted provided that the following conditions are
61 met:
62 * Redistributions of source code must retain the above copyright
63 notice, this list of conditions and the following disclaimer.
64 * Redistributions in binary form must reproduce the above copyright
65 notice, this list of conditions and the following disclaimer in the
66 documentation and/or other materials provided with the distribution.
67 * Neither the name of the copyright holder nor the names of
68 contributors may be used to endorse or promote products derived from
69 this software without specific prior written permission.
70
71 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
72 IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
73 TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
74 PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL COPYRIGHT HOLDER
75 BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
76 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
77 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
78 BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
79 WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
80 OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
81 ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
82 */
83
84 package jdk.internal.dynalink.support;
85
86 import jdk.internal.dynalink.CallSiteDescriptor;
87
88 /**
89 * Implements the name mangling and demangling as specified by John Rose's
90 * <a href="https://blogs.oracle.com/jrose/entry/symbolic_freedom_in_the_vm" target="_blank">"Symbolic Freedom in the
91 * VM"</a> article. It is recommended that implementers of languages on the JVM uniformly adopt this for symbolic
92 * interoperability between languages. Normally, you would mangle the names as you're generating bytecode, and then
93 * demangle them when you're creating {@link CallSiteDescriptor} objects. Note that you are expected to mangle
94 * individual tokens, and not the whole name at the call site, i.e. the colon character normally separating the tokens
95 * is never mangled. I.e. you wouldn't mangle {@code dyn:getProp:color} into {@code dyn\!getProp\!color}, but you would
96 * mangle {@code dyn:getProp:color$} into {@code dyn:getProp:\=color\%} (only mangling the individual token containing
97 * the symbol {@code color$}). {@link CallSiteDescriptorFactory#tokenizeName(String)} (and by implication, all call site
98 * descriptors it creates) will automatically perform demangling on the passed names. If you use this factory, or you
99 * have your own way of creating call site descriptors, but you still delegate to this method of the default factory
100 * (it is recommended that you do), then you have demangling handled for you already, and only need to ensure that you
101 * mangle the names when you're emitting them in the bytecode.
102 *
103 * @author Attila Szegedi
104 */
105 public class NameCodec {
106 private static final char ESCAPE_CHAR = '\\';
107 private static final char EMPTY_ESCAPE = '=';
108 private static final String EMPTY_NAME = new String(new char[] { ESCAPE_CHAR, EMPTY_ESCAPE });
109 private static final char EMPTY_CHAR = 0xFEFF;
110
111 private static final int MIN_ENCODING = '$';
112 private static final int MAX_ENCODING = ']';
113 private static final char[] ENCODING = new char[MAX_ENCODING - MIN_ENCODING + 1];
114 private static final int MIN_DECODING = '!';
115 private static final int MAX_DECODING = '}';
116 private static final char[] DECODING = new char[MAX_DECODING - MIN_DECODING + 1];
117
118 static {
119 addEncoding('/', '|');
120 addEncoding('.', ',');
121 addEncoding(';', '?');
122 addEncoding('$', '%');
123 addEncoding('<', '^');
124 addEncoding('>', '_');
125 addEncoding('[', '{');
126 addEncoding(']', '}');
127 addEncoding(':', '!');
128 addEncoding('\\', '-');
129 DECODING[EMPTY_ESCAPE - MIN_DECODING] = EMPTY_CHAR;
130 }
131
132 private NameCodec() {
133 }
134
135 /**
136 * Encodes ("mangles") an unencoded symbolic name.
137 * @param name the symbolic name to mangle
138 * @return the mangled form of the symbolic name.
139 */
140 public static String encode(String name) {
141 final int l = name.length();
142 if(l == 0) {
143 return EMPTY_NAME;
144 }
145 StringBuilder b = null;
146 int lastEscape = -1;
147 for(int i = 0; i < l; ++i) {
148 final int encodeIndex = name.charAt(i) - MIN_ENCODING;
149 if(encodeIndex >= 0 && encodeIndex < ENCODING.length) {
150 final char e = ENCODING[encodeIndex];
151 if(e != 0) {
152 if(b == null) {
153 b = new StringBuilder(name.length() + 3);
154 if(name.charAt(0) != ESCAPE_CHAR && i > 0) {
155 b.append(EMPTY_NAME);
156 }
157 b.append(name, 0, i);
158 } else {
159 b.append(name, lastEscape + 1, i);
160 }
161 b.append(ESCAPE_CHAR).append(e);
162 lastEscape = i;
163 }
164 }
165 }
166 if(b == null) {
167 return name.toString();
168 }
169 assert lastEscape != -1;
170 b.append(name, lastEscape + 1, l);
171 return b.toString();
172 }
173
174 /**
175 * Decodes ("demangles") an encoded symbolic name.
176 * @param name the symbolic name to demangle
177 * @return the demangled form of the symbolic name.
178 */
179 public static String decode(String name) {
180 if(name.charAt(0) != ESCAPE_CHAR) {
181 return name;
182 }
183 final int l = name.length();
184 if(l == 2 && name.charAt(1) == EMPTY_CHAR) {
185 return "";
186 }
187 StringBuilder b = new StringBuilder(name.length());
188 int lastEscape = -2;
189 int lastBackslash = -1;
190 for(;;) {
191 int nextBackslash = name.indexOf(ESCAPE_CHAR, lastBackslash + 1);
192 if(nextBackslash == -1 || nextBackslash == l - 1) {
193 break;
194 }
195 final int decodeIndex = name.charAt(nextBackslash + 1) - MIN_DECODING;
196 if(decodeIndex >= 0 && decodeIndex < DECODING.length) {
197 final char d = DECODING[decodeIndex];
198 if(d == EMPTY_CHAR) {
199 // "\=" is only valid at the beginning of a mangled string
200 if(nextBackslash == 0) {
201 lastEscape = 0;
202 }
203 } else if(d != 0) {
204 b.append(name, lastEscape + 2, nextBackslash).append(d);
205 lastEscape = nextBackslash;
206 }
207 }
208 lastBackslash = nextBackslash;
209 }
210 b.append(name, lastEscape + 2, l);
211 return b.toString();
212 }
213
214 private static void addEncoding(char from, char to) {
215 ENCODING[from - MIN_ENCODING] = to;
216 DECODING[to - MIN_DECODING] = from;
217 }
218 }

mercurial