1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
|
/*
* Copyright (c) 2006 Sun Microsystems, Inc. All Rights Reserved.
* Copyright (c) 2010 JogAmp Community. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are
* met:
*
* - Redistribution of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* - Redistribution in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* Neither the name of Sun Microsystems, Inc. or the names of
* contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* This software is provided "AS IS," without a warranty of any kind. ALL
* EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND WARRANTIES,
* INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A
* PARTICULAR PURPOSE OR NON-INFRINGEMENT, ARE HEREBY EXCLUDED. SUN
* MICROSYSTEMS, INC. ("SUN") AND ITS LICENSORS SHALL NOT BE LIABLE FOR
* ANY DAMAGES SUFFERED BY LICENSEE AS A RESULT OF USING, MODIFYING OR
* DISTRIBUTING THIS SOFTWARE OR ITS DERIVATIVES. IN NO EVENT WILL SUN OR
* ITS LICENSORS BE LIABLE FOR ANY LOST REVENUE, PROFIT OR DATA, OR FOR
* DIRECT, INDIRECT, SPECIAL, CONSEQUENTIAL, INCIDENTAL OR PUNITIVE
* DAMAGES, HOWEVER CAUSED AND REGARDLESS OF THE THEORY OF LIABILITY,
* ARISING OUT OF THE USE OF OR INABILITY TO USE THIS SOFTWARE, EVEN IF
* SUN HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
*
* You acknowledge that this software is not designed or intended for use
* in the design, construction, operation or maintenance of any nuclear
* facility.
*
* Sun gratefully acknowledges that this software was originally authored
* and developed by Kenneth Bradley Russell and Christopher John Kline.
*/
package com.jogamp.gluegen.opengl.nativesig;
import com.jogamp.gluegen.GlueGenException;
import com.jogamp.gluegen.JavaMethodBindingEmitter;
import com.jogamp.gluegen.JavaType;
import com.jogamp.gluegen.MethodBinding;
import com.jogamp.gluegen.cgram.types.Type;
import com.jogamp.gluegen.opengl.GLEmitter;
import com.jogamp.gluegen.opengl.GLJavaMethodBindingEmitter;
import com.jogamp.gluegen.procaddress.ProcAddressJavaMethodBindingEmitter;
import java.io.PrintWriter;
/** Review: This Package/Class is not used and subject to be deleted. */
public class NativeSignatureJavaMethodBindingEmitter extends GLJavaMethodBindingEmitter {
public NativeSignatureJavaMethodBindingEmitter(final GLJavaMethodBindingEmitter methodToWrap) {
super(methodToWrap);
}
public NativeSignatureJavaMethodBindingEmitter(final ProcAddressJavaMethodBindingEmitter methodToWrap, final GLEmitter emitter, final boolean bufferObjectVariant) {
super(methodToWrap, emitter, bufferObjectVariant);
}
public NativeSignatureJavaMethodBindingEmitter(final JavaMethodBindingEmitter methodToWrap, final NativeSignatureEmitter emitter) {
super(methodToWrap, false, null, false, false, emitter);
}
@Override
protected void emitSignature(final PrintWriter writer) {
writer.print(getBaseIndentString());
emitNativeSignatureAnnotation(writer);
super.emitSignature(writer);
}
protected void emitNativeSignatureAnnotation(final PrintWriter writer) {
if (hasModifier(JavaMethodBindingEmitter.NATIVE)) {
// Emit everything as a leaf for now
// FIXME: make this configurable
writer.print("@NativeSignature(\"l");
final MethodBinding binding = getBinding();
if (callThroughProcAddress) {
writer.print("p");
}
writer.print("(");
if (callThroughProcAddress) {
writer.print("P");
}
for (int i = 0; i < binding.getNumArguments(); i++) {
emitNativeSignatureElement(writer, binding.getJavaArgumentType(i), binding.getCArgumentType(i), i);
}
writer.print(")");
emitNativeSignatureElement(writer, binding.getJavaReturnType(), binding.getCReturnType(), -1);
writer.println("\")");
}
}
protected void emitNativeSignatureElement(final PrintWriter writer, final JavaType type, final Type cType, final int index) {
if (type.isVoid()) {
if (index > 0) {
throw new InternalError("Error parsing arguments -- void should not be seen aside from argument 0");
}
return;
}
if (type.isNIOBuffer()) {
writer.print("A");
} else if (type.isPrimitiveArray()) {
writer.print("MO");
} else if (type.isPrimitive()) {
final Class<?> clazz = type.getJavaClass();
if (clazz == Byte.TYPE) { writer.print("B"); }
else if (clazz == Character.TYPE) { writer.print("C"); }
else if (clazz == Double.TYPE) { writer.print("D"); }
else if (clazz == Float.TYPE) { writer.print("F"); }
else if (clazz == Integer.TYPE) { writer.print("I"); }
else if (clazz == Long.TYPE) {
// See if this is intended to be a pointer at the C level
if (cType.isPointer()) {
writer.print("A");
} else {
writer.print("J");
}
}
else if (clazz == Short.TYPE) { writer.print("S"); }
else if (clazz == Boolean.TYPE) { writer.print("Z"); }
else throw new InternalError("Unhandled primitive type " + clazz);
} else if (type.isString()) {
writer.print("A");
} else {
throw new RuntimeException("Type not yet handled: " + type);
}
}
@Override
protected String getReturnTypeString(final boolean skipArray) {
if (isPrivateNativeMethod()) {
final JavaType returnType = getBinding().getJavaReturnType();
if (returnType.isString() || returnType.isNIOByteBuffer()) {
// Treat these as addresses
return "long";
}
}
return super.getReturnTypeString(skipArray);
}
@Override
protected void emitPreCallSetup(final MethodBinding binding, final PrintWriter writer) {
super.emitPreCallSetup(binding, writer);
for (int i = 0; i < binding.getNumArguments(); i++) {
final JavaType type = binding.getJavaArgumentType(i);
if (type.isNIOBuffer() && !useNIODirectOnly ) {
// Emit declarations for variables holding primitive arrays as type Object
// We don't know 100% sure we're going to use these at this point in the code, though
writer.println(" Object " + getNIOBufferArrayName(i) + " = (_direct ? null : Buffers.getArray(" +
getArgumentName(i) + "));");
} else if (type.isString()) {
writer.println(" long " + binding.getArgumentName(i) + "_c_str = BuffersInternal.newCString(" + binding.getArgumentName(i) + ");");
}
// FIXME: going to need more of these for Buffer[] and String[], at least
}
}
protected String getNIOBufferArrayName(final int argNumber) {
return "__buffer_array_" + argNumber;
}
@Override
protected int emitArguments(final PrintWriter writer)
{
boolean needComma = false;
int numEmitted = 0;
if (callThroughProcAddress) {
if (changeNameAndArguments) {
writer.print("long procAddress");
++numEmitted;
needComma = true;
}
}
if (isPrivateNativeMethod() && binding.hasContainingType()) {
if (needComma) {
writer.print(", ");
}
// Always emit outgoing "this" argument
writer.print("long ");
writer.print(javaThisArgumentName());
++numEmitted;
needComma = true;
}
for (int i = 0; i < binding.getNumArguments(); i++) {
final JavaType type = binding.getJavaArgumentType(i);
if (type.isVoid()) {
// Make sure this is the only param to the method; if it isn't,
// there's something wrong with our parsing of the headers.
if (binding.getNumArguments() != 1) {
throw new InternalError(
"\"void\" argument type found in " +
"multi-argument function \"" + binding + "\"");
}
continue;
}
if (type.isJNIEnv() || binding.isArgumentThisPointer(i)) {
// Don't need to expose these at the Java level
continue;
}
if (needComma) {
writer.print(", ");
}
if (isPrivateNativeMethod() &&
(isForDirectBufferImplementation() && type.isNIOBuffer() ||
type.isString())) {
// Direct Buffers and Strings go out as longs
writer.print("long");
// FIXME: will need more tests here to handle other constructs like String and direct Buffer arrays
} else {
writer.print(erasedTypeString(type, false));
}
writer.print(" ");
writer.print(getArgumentName(i));
++numEmitted;
needComma = true;
// Add Buffer and array index offset arguments after each associated argument
if (isForIndirectBufferAndArrayImplementation()) {
if (type.isNIOBuffer()) {
writer.print(", int " + byteOffsetArgName(i));
} else if (type.isNIOBufferArray()) {
writer.print(", int[] " +
byteOffsetArrayArgName(i));
}
}
// Add offset argument after each primitive array
if (type.isPrimitiveArray()) {
writer.print(", int " + offsetArgName(i));
}
}
return numEmitted;
}
@Override
protected void emitReturnVariableSetupAndCall(final MethodBinding binding, final PrintWriter writer) {
writer.print(" ");
final JavaType returnType = binding.getJavaReturnType();
boolean needsResultAssignment = false;
if (!returnType.isVoid()) {
if (returnType.isCompoundTypeWrapper() ||
returnType.isNIOByteBuffer()) {
writer.println("final java.nio.ByteBuffer _res;");
needsResultAssignment = true;
} else if (returnType.isArrayOfCompoundTypeWrappers()) {
writer.println("final java.nio.ByteBuffer[] _res;");
needsResultAssignment = true;
} else if (returnType.isString() || returnType.isNIOByteBuffer()) {
writer.print("final ");
writer.print(returnType);
writer.println(" _res;");
needsResultAssignment = true;
} else {
// Always assign to "_res" variable so we can clean up
// outgoing String arguments, for example
writer.print("final ");
emitReturnType(writer);
writer.println(" _res;");
needsResultAssignment = true;
}
}
if (binding.signatureCanUseIndirectNIO() && !useNIODirectOnly) {
// Must generate two calls for this gated on whether the NIO
// buffers coming in are all direct or indirect
writer.println("if (_direct) {");
writer.print (" ");
}
if (needsResultAssignment) {
writer.print(" _res = ");
if (returnType.isString()) {
writer.print("BuffersInternal.newJavaString(");
} else if (returnType.isNIOByteBuffer()) {
writer.print("BuffersInternal.newDirectByteBuffer(");
}
} else {
writer.print(" ");
if (!returnType.isVoid()) {
writer.print("return ");
}
}
if (binding.signatureUsesJavaPrimitiveArrays() &&
!binding.signatureCanUseIndirectNIO()) {
// FIXME: what happens with a C function of the form
// void foo(int* arg0, void* arg1);
// ?
// Only one call being made in this body, going to indirect
// buffer / array entry point
emitCall(binding, writer);
if (returnType.isString() || returnType.isNIOByteBuffer()) {
writer.print(")");
}
writer.print(";");
writer.println();
} else {
emitCall(binding, writer);
if (returnType.isString() || returnType.isNIOByteBuffer()) {
writer.print(")");
}
writer.print(";");
}
if (binding.signatureCanUseIndirectNIO() && !useNIODirectOnly) {
// Must generate two calls for this gated on whether the NIO
// buffers coming in are all direct or indirect
writer.println();
writer.println(" } else {");
writer.print (" ");
if (needsResultAssignment) {
writer.print(" _res = ");
} else {
writer.print(" ");
if (!returnType.isVoid()) {
writer.print("return ");
}
}
emitCall(binding, writer);
writer.print(";");
writer.println();
writer.println(" }");
} else {
writer.println();
}
emitPrologueOrEpilogue(epilogue, writer);
if (needsResultAssignment) {
emitCallResultReturn(binding, writer);
}
}
protected int emitCallArguments(final MethodBinding binding, final PrintWriter writer, final boolean direct) {
// Note that we override this completely because we both need to
// move the potential location of the outgoing proc address as
// well as change the way we pass out Buffers, arrays, Strings, etc.
boolean needComma = false;
int numArgsEmitted = 0;
if (callThroughProcAddress) {
writer.print("__addr_");
needComma = true;
++numArgsEmitted;
}
if (binding.hasContainingType()) {
// Emit this pointer
assert(binding.getContainingType().isCompoundTypeWrapper());
writer.print("BuffersInternal.getDirectBufferAddress(");
writer.print("getBuffer()");
writer.print(")");
needComma = true;
++numArgsEmitted;
}
for (int i = 0; i < binding.getNumArguments(); i++) {
final JavaType type = binding.getJavaArgumentType(i);
if (type.isJNIEnv() || binding.isArgumentThisPointer(i)) {
// Don't need to expose these at the Java level
continue;
}
if (type.isVoid()) {
// Make sure this is the only param to the method; if it isn't,
// there's something wrong with our parsing of the headers.
assert(binding.getNumArguments() == 1);
continue;
}
if (needComma) {
writer.print(", ");
}
if (type.isCompoundTypeWrapper()) {
writer.print("BuffersInternal.getDirectBufferAddress(");
writer.print("((");
}
if (type.isNIOBuffer()) {
if (!direct) {
writer.print(getNIOBufferArrayName(i));
} else {
writer.print("BuffersInternal.getDirectBufferAddress(");
writer.print(getArgumentName(i));
writer.print(")");
}
} else {
writer.print(getArgumentName(i));
}
if (type.isCompoundTypeWrapper()) {
writer.print(" == null) ? null : ");
writer.print(getArgumentName(i));
writer.print(".getBuffer())");
writer.print(")");
}
if (type.isNIOBuffer()) {
if (direct) {
writer.print("+ Buffers.getDirectBufferByteOffset(" + getArgumentName(i) + ")");
} else {
writer.print(", BuffersInternal.arrayBaseOffset(" +
getNIOBufferArrayName(i) +
") + Buffers.getIndirectBufferByteOffset(" + getArgumentName(i) + ")");
}
} else if (type.isNIOBufferArray()) {
writer.print(", " + byteOffsetArrayArgName(i));
}
// Add Array offset parameter for primitive arrays
if (type.isPrimitiveArray()) {
writer.print(", ");
writer.print("BuffersInternal.arrayBaseOffset(" + getArgumentName(i) + ") + ");
if(type.isFloatArray()) {
writer.print("Buffers.SIZEOF_FLOAT * ");
} else if(type.isDoubleArray()) {
writer.print("Buffers.SIZEOF_DOUBLE * ");
} else if(type.isByteArray()) {
writer.print("1 * ");
} else if(type.isLongArray()) {
writer.print("Buffers.SIZEOF_LONG * ");
} else if(type.isShortArray()) {
writer.print("Buffers.SIZEOF_SHORT * ");
} else if(type.isIntArray()) {
writer.print("Buffers.SIZEOF_INT * ");
} else {
throw new GlueGenException("Unsupported type for calculating array offset argument for " +
getArgumentName(i) +
"-- error occurred while processing Java glue code for " + binding.getCSymbol().getAliasedString(),
binding.getCSymbol().getASTLocusTag());
}
writer.print(offsetArgName(i));
}
if (type.isString()) {
writer.print("_c_str");
}
if (type.isCompoundTypeWrapper()) {
writer.print(")");
}
needComma = true;
++numArgsEmitted;
}
return numArgsEmitted;
}
@Override
protected void emitCallResultReturn(final MethodBinding binding, final PrintWriter writer) {
for (int i = 0; i < binding.getNumArguments(); i++) {
final JavaType type = binding.getJavaArgumentType(i);
if (type.isString()) {
writer.println(";");
writer.println(" BuffersInternal.freeCString(" + binding.getArgumentName(i) + "_c_str);");
}
// FIXME: will need more of these cleanups for things like Buffer[] and String[] (see above)
}
super.emitCallResultReturn(binding, writer);
}
@Override
public String getNativeName() {
final String res = super.getNativeName();
if (isPrivateNativeMethod() && bufferObjectVariant) {
return res + "BufObj";
}
return res;
}
protected String getImplMethodName(final boolean direct) {
String name = null;
if (direct) {
name = binding.getName() + "$0";
} else {
name = binding.getName() + "$1";
}
if (bufferObjectVariant) {
return name + "BufObj";
}
return name;
}
}
|