1 /*
2 * Copyright (c) 2002, 2011, 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 package com.sun.tools.javah;
28
29 import java.util.*;
30 import javax.lang.model.element.Name;
31 import javax.lang.model.element.TypeElement;
32 import javax.lang.model.type.ArrayType;
33 import javax.lang.model.type.DeclaredType;
34 import javax.lang.model.type.NoType;
35 import javax.lang.model.type.PrimitiveType;
36 import javax.lang.model.type.TypeKind;
37 import javax.lang.model.type.TypeMirror;
38 import javax.lang.model.type.TypeVariable;
39 import javax.lang.model.type.TypeVisitor;
40 import javax.lang.model.util.Elements;
41 import javax.lang.model.util.SimpleTypeVisitor8;
42
43 /**
44 * Returns internal type signature.
45 *
46 * <p><b>This is NOT part of any supported API.
47 * If you write code that depends on this, you do so at your own
48 * risk. This code and its internal interfaces are subject to change
49 * or deletion without notice.</b></p>
50 *
51 * @author Sucheta Dambalkar
52 */
53
54 public class TypeSignature {
55 static class SignatureException extends Exception {
56 private static final long serialVersionUID = 1L;
57 SignatureException(String reason) {
58 super(reason);
59 }
60 }
61
62 Elements elems;
63
64 /* Signature Characters */
65
66 private static final String SIG_VOID = "V";
67 private static final String SIG_BOOLEAN = "Z";
68 private static final String SIG_BYTE = "B";
69 private static final String SIG_CHAR = "C";
70 private static final String SIG_SHORT = "S";
71 private static final String SIG_INT = "I";
72 private static final String SIG_LONG = "J";
73 private static final String SIG_FLOAT = "F";
74 private static final String SIG_DOUBLE = "D";
75 private static final String SIG_ARRAY = "[";
76 private static final String SIG_CLASS = "L";
77
78
79
80 public TypeSignature(Elements elems){
81 this.elems = elems;
82 }
83
84 /*
85 * Returns the type signature of a field according to JVM specs
86 */
87 public String getTypeSignature(String javasignature) throws SignatureException {
88 return getParamJVMSignature(javasignature);
89 }
90
91 /*
92 * Returns the type signature of a method according to JVM specs
93 */
94 public String getTypeSignature(String javasignature, TypeMirror returnType)
95 throws SignatureException {
96 String signature = null; //Java type signature.
97 String typeSignature = null; //Internal type signature.
98 List<String> params = new ArrayList<String>(); //List of parameters.
99 String paramsig = null; //Java parameter signature.
100 String paramJVMSig = null; //Internal parameter signature.
101 String returnSig = null; //Java return type signature.
102 String returnJVMType = null; //Internal return type signature.
103 int dimensions = 0; //Array dimension.
104
105 int startIndex = -1;
106 int endIndex = -1;
107 StringTokenizer st = null;
108 int i = 0;
109
110 // Gets the actual java signature without parentheses.
111 if (javasignature != null) {
112 startIndex = javasignature.indexOf("(");
113 endIndex = javasignature.indexOf(")");
114 }
115
116 if (((startIndex != -1) && (endIndex != -1))
117 &&(startIndex+1 < javasignature.length())
118 &&(endIndex < javasignature.length())) {
119 signature = javasignature.substring(startIndex+1, endIndex);
120 }
121
122 // Separates parameters.
123 if (signature != null) {
124 if (signature.indexOf(",") != -1) {
125 st = new StringTokenizer(signature, ",");
126 if (st != null) {
127 while (st.hasMoreTokens()) {
128 params.add(st.nextToken());
129 }
130 }
131 } else {
132 params.add(signature);
133 }
134 }
135
136 /* JVM type signature. */
137 typeSignature = "(";
138
139 // Gets indivisual internal parameter signature.
140 while (params.isEmpty() != true) {
141 paramsig = params.remove(i).trim();
142 paramJVMSig = getParamJVMSignature(paramsig);
143 if (paramJVMSig != null) {
144 typeSignature += paramJVMSig;
145 }
146 }
147
148 typeSignature += ")";
149
150 // Get internal return type signature.
151
152 returnJVMType = "";
153 if (returnType != null) {
154 dimensions = dimensions(returnType);
155 }
156
157 //Gets array dimension of return type.
158 while (dimensions-- > 0) {
159 returnJVMType += "[";
160 }
161 if (returnType != null) {
162 returnSig = qualifiedTypeName(returnType);
163 returnJVMType += getComponentType(returnSig);
164 } else {
165 System.out.println("Invalid return type.");
166 }
167
168 typeSignature += returnJVMType;
169
170 return typeSignature;
171 }
172
173 /*
174 * Returns internal signature of a parameter.
175 */
176 private String getParamJVMSignature(String paramsig) throws SignatureException {
177 String paramJVMSig = "";
178 String componentType ="";
179
180 if(paramsig != null){
181
182 if(paramsig.indexOf("[]") != -1) {
183 // Gets array dimension.
184 int endindex = paramsig.indexOf("[]");
185 componentType = paramsig.substring(0, endindex);
186 String dimensionString = paramsig.substring(endindex);
187 if(dimensionString != null){
188 while(dimensionString.indexOf("[]") != -1){
189 paramJVMSig += "[";
190 int beginindex = dimensionString.indexOf("]") + 1;
191 if(beginindex < dimensionString.length()){
192 dimensionString = dimensionString.substring(beginindex);
193 }else
194 dimensionString = "";
195 }
196 }
197 } else componentType = paramsig;
198
199 paramJVMSig += getComponentType(componentType);
200 }
201 return paramJVMSig;
202 }
203
204 /*
205 * Returns internal signature of a component.
206 */
207 private String getComponentType(String componentType) throws SignatureException {
208
209 String JVMSig = "";
210
211 if(componentType != null){
212 if(componentType.equals("void")) JVMSig += SIG_VOID ;
213 else if(componentType.equals("boolean")) JVMSig += SIG_BOOLEAN ;
214 else if(componentType.equals("byte")) JVMSig += SIG_BYTE ;
215 else if(componentType.equals("char")) JVMSig += SIG_CHAR ;
216 else if(componentType.equals("short")) JVMSig += SIG_SHORT ;
217 else if(componentType.equals("int")) JVMSig += SIG_INT ;
218 else if(componentType.equals("long")) JVMSig += SIG_LONG ;
219 else if(componentType.equals("float")) JVMSig += SIG_FLOAT ;
220 else if(componentType.equals("double")) JVMSig += SIG_DOUBLE ;
221 else {
222 if(!componentType.equals("")){
223 TypeElement classNameDoc = elems.getTypeElement(componentType);
224
225 if(classNameDoc == null){
226 throw new SignatureException(componentType);
227 }else {
228 String classname = classNameDoc.getQualifiedName().toString();
229 String newclassname = classname.replace('.', '/');
230 JVMSig += "L";
231 JVMSig += newclassname;
232 JVMSig += ";";
233 }
234 }
235 }
236 }
237 return JVMSig;
238 }
239
240 int dimensions(TypeMirror t) {
241 if (t.getKind() != TypeKind.ARRAY)
242 return 0;
243 return 1 + dimensions(((ArrayType) t).getComponentType());
244 }
245
246
247 String qualifiedTypeName(TypeMirror type) {
248 TypeVisitor<Name, Void> v = new SimpleTypeVisitor8<Name, Void>() {
249 @Override
250 public Name visitArray(ArrayType t, Void p) {
251 return t.getComponentType().accept(this, p);
252 }
253
254 @Override
255 public Name visitDeclared(DeclaredType t, Void p) {
256 return ((TypeElement) t.asElement()).getQualifiedName();
257 }
258
259 @Override
260 public Name visitPrimitive(PrimitiveType t, Void p) {
261 return elems.getName(t.toString());
262 }
263
264 @Override
265 public Name visitNoType(NoType t, Void p) {
266 if (t.getKind() == TypeKind.VOID)
267 return elems.getName("void");
268 return defaultAction(t, p);
269 }
270
271 @Override
272 public Name visitTypeVariable(TypeVariable t, Void p) {
273 return t.getUpperBound().accept(this, p);
274 }
275 };
276 return v.visit(type).toString();
277 }
278 }