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
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
|
/*
* Copyright (c) 2003 Sun Microsystems, Inc. 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.sun.gluegen;
import java.io.*;
import java.util.*;
import java.text.MessageFormat;
import com.sun.gluegen.cgram.types.*;
import com.sun.gluegen.cgram.*;
/**
* An emitter that emits only the interface for a Java<->C JNI binding.
*/
public class JavaMethodBindingEmitter extends FunctionEmitter
{
public static final EmissionModifier PUBLIC = new EmissionModifier("public");
public static final EmissionModifier PROTECTED = new EmissionModifier("protected");
public static final EmissionModifier PRIVATE = new EmissionModifier("private");
public static final EmissionModifier ABSTRACT = new EmissionModifier("abstract");
public static final EmissionModifier FINAL = new EmissionModifier("final");
public static final EmissionModifier NATIVE = new EmissionModifier("native");
public static final EmissionModifier SYNCHRONIZED = new EmissionModifier("synchronized");
protected final CommentEmitter defaultJavaCommentEmitter = new DefaultCommentEmitter();
protected final CommentEmitter defaultInterfaceCommentEmitter =
new InterfaceCommentEmitter();
// Exception type raised in the generated code if runtime checks fail
private String runtimeExceptionType;
protected boolean emitBody;
protected boolean eraseBufferAndArrayTypes;
protected boolean directNIOOnly;
protected boolean forImplementingMethodCall;
protected boolean forDirectBufferImplementation;
protected boolean forIndirectBufferAndArrayImplementation;
protected boolean isUnimplemented;
protected MethodBinding binding;
// A non-null value indicates that rather than returning a compound
// type accessor we are returning an array of such accessors; this
// expression is a MessageFormat string taking the names of the
// incoming Java arguments as parameters and computing as an int the
// number of elements of the returned array.
private String returnedArrayLengthExpression;
public JavaMethodBindingEmitter(MethodBinding binding,
PrintWriter output,
String runtimeExceptionType,
boolean emitBody,
boolean eraseBufferAndArrayTypes,
boolean directNIOOnly,
boolean forImplementingMethodCall,
boolean forDirectBufferImplementation,
boolean forIndirectBufferAndArrayImplementation,
boolean isUnimplemented)
{
super(output);
this.binding = binding;
this.runtimeExceptionType = runtimeExceptionType;
this.emitBody = emitBody;
this.eraseBufferAndArrayTypes = eraseBufferAndArrayTypes;
this.directNIOOnly = directNIOOnly;
this.forImplementingMethodCall = forImplementingMethodCall;
this.forDirectBufferImplementation = forDirectBufferImplementation;
this.forIndirectBufferAndArrayImplementation = forIndirectBufferAndArrayImplementation;
this.isUnimplemented = isUnimplemented;
if (forImplementingMethodCall) {
setCommentEmitter(defaultJavaCommentEmitter);
} else {
setCommentEmitter(defaultInterfaceCommentEmitter);
}
}
public JavaMethodBindingEmitter(JavaMethodBindingEmitter arg) {
super(arg);
binding = arg.binding;
runtimeExceptionType = arg.runtimeExceptionType;
emitBody = arg.emitBody;
eraseBufferAndArrayTypes = arg.eraseBufferAndArrayTypes;
directNIOOnly = arg.directNIOOnly;
forImplementingMethodCall = arg.forImplementingMethodCall;
forDirectBufferImplementation = arg.forDirectBufferImplementation;
forIndirectBufferAndArrayImplementation = arg.forIndirectBufferAndArrayImplementation;
isUnimplemented = arg.isUnimplemented;
returnedArrayLengthExpression = arg.returnedArrayLengthExpression;
}
public final MethodBinding getBinding() { return binding; }
public boolean isForImplementingMethodCall() { return forImplementingMethodCall; }
public String getName() {
return binding.getName();
}
/** The type of exception (must subclass
<code>java.lang.RuntimeException</code>) raised if runtime
checks fail in the generated code. */
public String getRuntimeExceptionType() {
return runtimeExceptionType;
}
/** If the underlying function returns an array (currently only
arrays of compound types are supported) as opposed to a pointer
to an object, this method should be called to provide a
MessageFormat string containing an expression that computes the
number of elements of the returned array. The parameters to the
MessageFormat expression are the names of the incoming Java
arguments. */
public void setReturnedArrayLengthExpression(String expr) {
returnedArrayLengthExpression = expr;
}
/** Indicates whether this emitter will print only a signature, or
whether it will emit Java code for the body of the method as
well. */
public boolean signatureOnly() {
return !emitBody;
}
/** Accessor for subclasses. */
public void setEmitBody(boolean emitBody) {
this.emitBody = emitBody;
}
/** Accessor for subclasses. */
public void setEraseBufferAndArrayTypes(boolean erase) {
this.eraseBufferAndArrayTypes = erase;
}
/** Accessor for subclasses. */
public void setForImplementingMethodCall(boolean impl) {
this.forImplementingMethodCall = impl;
}
protected void emitReturnType(PrintWriter writer)
{
writer.print(getReturnTypeString(false));
}
protected String erasedTypeString(JavaType type, boolean skipBuffers) {
if (eraseBufferAndArrayTypes) {
if (type.isNIOBuffer() ||
type.isPrimitiveArray()) {
if (!skipBuffers) {
// Direct buffers and arrays sent down as Object (but
// returned as e.g. ByteBuffer)
return "Object";
}
} else if (type.isCompoundTypeWrapper()) {
// Compound type wrappers are unwrapped to ByteBuffer
return "java.nio.ByteBuffer";
} else if (type.isArrayOfCompoundTypeWrappers()) {
return "java.nio.ByteBuffer";
}
}
return type.getName();
}
protected String getReturnTypeString(boolean skipArray) {
// The first arm of the "if" clause is used by the glue code
// generation for arrays of compound type wrappers
if (skipArray ||
// The following arm is used by most other kinds of return types
(getReturnedArrayLengthExpression() == null &&
!binding.getJavaReturnType().isArrayOfCompoundTypeWrappers()) ||
// The following arm is used specifically to get the splitting up
// of one returned ByteBuffer into an array of compound type
// wrappers to work (e.g., XGetVisualInfo)
(eraseBufferAndArrayTypes &&
binding.getJavaReturnType().isCompoundTypeWrapper() &&
(getReturnedArrayLengthExpression() != null))) {
return erasedTypeString(binding.getJavaReturnType(), true);
}
return erasedTypeString(binding.getJavaReturnType(), true) + "[]";
}
protected void emitName(PrintWriter writer)
{
if (forImplementingMethodCall) {
if (forIndirectBufferAndArrayImplementation) {
writer.print(getImplMethodName(false));
} else {
writer.print(getImplMethodName(true));
}
} else {
writer.print(getName());
}
}
protected int emitArguments(PrintWriter writer)
{
boolean needComma = false;
int numEmitted = 0;
if (forImplementingMethodCall && binding.hasContainingType()) {
// Always emit outgoing "this" argument
writer.print("java.nio.ByteBuffer ");
writer.print(javaThisArgumentName());
++numEmitted;
needComma = true;
}
for (int i = 0; i < binding.getNumArguments(); i++) {
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(", ");
}
writer.print(erasedTypeString(type, false));
writer.print(" ");
writer.print(binding.getArgumentName(i));
++numEmitted;
needComma = true;
// Add Buffer and array index offset arguments after each associated argument
if (forDirectBufferImplementation || forIndirectBufferAndArrayImplementation) {
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;
}
protected String getImplMethodName(boolean direct) {
if (direct) {
return binding.getName() + "0";
} else {
return binding.getName() + "1";
}
}
protected String byteOffsetArgName(int i) {
return byteOffsetArgName(binding.getArgumentName(i));
}
protected String byteOffsetArgName(String s) {
return s + "_byte_offset";
}
protected String byteOffsetArrayArgName(int i) {
return binding.getArgumentName(i) + "_byte_offset_array";
}
protected String offsetArgName(int i) {
return binding.getArgumentName(i) + "_offset";
}
protected void emitBody(PrintWriter writer)
{
if (!emitBody) {
writer.println(';');
} else {
MethodBinding binding = getBinding();
writer.println();
writer.println(" {");
if (isUnimplemented) {
writer.println(" throw new " + getRuntimeExceptionType() + "(\"Unimplemented\");");
} else {
emitPreCallSetup(binding, writer);
//emitReturnVariableSetup(binding, writer);
emitReturnVariableSetupAndCall(binding, writer);
}
writer.println(" }");
}
}
protected void emitPreCallSetup(MethodBinding binding, PrintWriter writer) {
emitArrayLengthAndNIOBufferChecks(binding, writer);
}
protected void emitArrayLengthAndNIOBufferChecks(MethodBinding binding, PrintWriter writer) {
int numBufferOffsetArrayArgs = 0;
boolean firstBuffer = true;
// Check lengths of any incoming arrays if necessary
for (int i = 0; i < binding.getNumArguments(); i++) {
Type type = binding.getCArgumentType(i);
if (type.isArray()) {
ArrayType arrayType = type.asArray();
writer.println(" if (" + binding.getArgumentName(i) + ".length < " +
arrayType.getLength() + ")");
writer.println(" throw new " + getRuntimeExceptionType() +
"(\"Length of array \\\"" + binding.getArgumentName(i) +
"\\\" was less than the required " + arrayType.getLength() + "\");");
} else {
JavaType javaType = binding.getJavaArgumentType(i);
if (javaType.isNIOBuffer()) {
if (directNIOOnly) {
writer.println(" if (!BufferFactory.isDirect(" + binding.getArgumentName(i) + "))");
writer.println(" throw new " + getRuntimeExceptionType() + "(\"Argument \\\"" +
binding.getArgumentName(i) + "\\\" was not a direct buffer\");");
} else {
if(firstBuffer) {
firstBuffer = false;
writer.println(" boolean _direct = BufferFactory.isDirect(" + binding.getArgumentName(i) + ");");
} else {
writer.println(" if (_direct != BufferFactory.isDirect(" + binding.getArgumentName(i) + "))");
writer.println(" throw new " + getRuntimeExceptionType() +
"(\"Argument \\\"" + binding.getArgumentName(i) +
"\\\" : Buffers passed to this method must all be either direct or indirect\");");
}
}
} else if (javaType.isNIOBufferArray()) {
// All buffers passed down in an array of NIO buffers must be direct
String argName = binding.getArgumentName(i);
String arrayName = byteOffsetArrayArgName(i);
writer.println(" int[] " + arrayName + " = new int[" + argName + ".length];");
// Check direct buffer properties of all buffers within
writer.println(" if (" + argName + " != null) {");
writer.println(" for (int _ctr = 0; _ctr < " + argName + ".length; _ctr++) {");
writer.println(" if (!BufferFactory.isDirect(" + argName + "[_ctr])) {");
writer.println(" throw new " + getRuntimeExceptionType() +
"(\"Element \" + _ctr + \" of argument \\\"" +
binding.getArgumentName(i) + "\\\" was not a direct buffer\");");
writer.println(" }");
// get the Buffer Array offset values and save them into another array to send down to JNI
writer.print (" " + arrayName + "[_ctr] = BufferFactory.getDirectBufferByteOffset(");
writer.println(argName + "[_ctr]);");
writer.println(" }");
writer.println(" }");
} else if (javaType.isPrimitiveArray()) {
String argName = binding.getArgumentName(i);
String offsetArg = offsetArgName(i);
writer.println(" if(" + argName + " != null && " + argName + ".length <= " + offsetArg + ")");
writer.print (" throw new " + getRuntimeExceptionType());
writer.println("(\"array offset argument \\\"" + offsetArg + "\\\" (\" + " + offsetArg +
" + \") equals or exceeds array length (\" + " + argName + ".length + \")\");");
}
}
}
}
protected void emitCall(MethodBinding binding, PrintWriter writer, boolean direct) {
writer.print(getImplMethodName(direct));
writer.print("(");
emitCallArguments(binding, writer, direct);
writer.print(");");
}
protected void emitReturnVariableSetupAndCall(MethodBinding binding, PrintWriter writer) {
writer.print(" ");
JavaType returnType = binding.getJavaReturnType();
boolean needsResultAssignment = false;
if (!returnType.isVoid()) {
if (returnType.isCompoundTypeWrapper() ||
returnType.isNIOByteBuffer()) {
writer.println("ByteBuffer _res;");
needsResultAssignment = true;
} else if (returnType.isArrayOfCompoundTypeWrappers()) {
writer.println("ByteBuffer[] _res;");
needsResultAssignment = true;
}
}
if (binding.signatureCanUseIndirectNIO() && !directNIOOnly) {
// 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 = ");
} 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, false);
writer.println();
} else {
emitCall(binding, writer, true);
}
if (binding.signatureCanUseIndirectNIO() && !directNIOOnly) {
// 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, false);
writer.println();
writer.println(" }");
} else {
writer.println();
}
if (needsResultAssignment) {
emitCallResultReturn(binding, writer);
}
}
protected int emitCallArguments(MethodBinding binding, PrintWriter writer, boolean direct) {
boolean needComma = false;
int numArgsEmitted = 0;
if (binding.hasContainingType()) {
// Emit this pointer
assert(binding.getContainingType().isCompoundTypeWrapper());
writer.print("getBuffer()");
needComma = true;
++numArgsEmitted;
}
for (int i = 0; i < binding.getNumArguments(); i++) {
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("((");
}
if (type.isNIOBuffer() && !direct) {
writer.print("BufferFactory.getArray(" + binding.getArgumentName(i) + ")");
} else {
writer.print(binding.getArgumentName(i));
}
if (type.isCompoundTypeWrapper()) {
writer.print(" == null) ? null : ");
writer.print(binding.getArgumentName(i));
writer.print(".getBuffer())");
}
needComma = true;
++numArgsEmitted;
if (type.isNIOBuffer()) {
if (direct) {
writer.print(", BufferFactory.getDirectBufferByteOffset(" + binding.getArgumentName(i) + ")");
} else {
writer.print(", BufferFactory.getIndirectBufferByteOffset(" + binding.getArgumentName(i) + ")");
}
} else if (type.isNIOBufferArray()) {
writer.print(", " + byteOffsetArrayArgName(i));
}
// Add Array offset parameter for primitive arrays
if (type.isPrimitiveArray()) {
if(type.isFloatArray()) {
writer.print(", BufferFactory.SIZEOF_FLOAT * ");
} else if(type.isDoubleArray()) {
writer.print(", BufferFactory.SIZEOF_DOUBLE * ");
} else if(type.isByteArray()) {
writer.print(", ");
} else if(type.isLongArray()) {
writer.print(", BufferFactory.SIZEOF_LONG * ");
} else if(type.isShortArray()) {
writer.print(", BufferFactory.SIZEOF_SHORT * ");
} else if(type.isIntArray()) {
writer.print(", BufferFactory.SIZEOF_INT * ");
} else {
throw new RuntimeException("Unsupported type for calculating array offset argument for " +
binding.getArgumentName(i) +
"-- error occurred while processing Java glue code for " + binding.getName());
}
writer.print(offsetArgName(i));
}
}
return numArgsEmitted;
}
protected void emitCallResultReturn(MethodBinding binding, PrintWriter writer) {
JavaType returnType = binding.getJavaReturnType();
if (returnType.isCompoundTypeWrapper()) {
String fmt = getReturnedArrayLengthExpression();
writer.println(" if (_res == null) return null;");
if (fmt == null) {
writer.print(" return new " + returnType.getName() + "(_res.order(ByteOrder.nativeOrder()))");
} else {
writer.println(" _res.order(ByteOrder.nativeOrder());");
String[] argumentNames = new String[binding.getNumArguments()];
for (int i = 0; i < binding.getNumArguments(); i++) {
argumentNames[i] = binding.getArgumentName(i);
}
String expr = new MessageFormat(fmt).format(argumentNames);
PointerType cReturnTypePointer = binding.getCReturnType().asPointer();
CompoundType cReturnType = null;
if (cReturnTypePointer != null) {
cReturnType = cReturnTypePointer.getTargetType().asCompound();
}
if (cReturnType == null) {
throw new RuntimeException("ReturnedArrayLength directive currently only supported for pointers to compound types " +
"(error occurred while generating Java glue code for " + binding.getName() + ")");
}
writer.println(" " + getReturnTypeString(false) + " _retarray = new " + getReturnTypeString(true) + "[" + expr + "];");
writer.println(" for (int _count = 0; _count < " + expr + "; _count++) {");
// Create temporary ByteBuffer slice
// FIXME: probably need Type.getAlignedSize() for arrays of
// compound types (rounding up to machine-dependent alignment)
writer.println(" _res.position(_count * " + cReturnType.getSize() + ");");
writer.println(" _res.limit ((1 + _count) * " + cReturnType.getSize() + ");");
writer.println(" ByteBuffer _tmp = _res.slice();");
writer.println(" _tmp.order(ByteOrder.nativeOrder());");
writer.println(" _res.position(0);");
writer.println(" _res.limit(_res.capacity());");
writer.println(" _retarray[_count] = new " + getReturnTypeString(true) + "(_tmp);");
writer.println(" }");
writer.print (" return _retarray");
}
writer.println(";");
} else if (returnType.isNIOBuffer()) {
writer.println(" if (_res == null) return null;");
writer.println(" return _res.order(ByteOrder.nativeOrder());");
} else if (returnType.isArrayOfCompoundTypeWrappers()) {
writer.println(" if (_res == null) return null;");
writer.println(" " + getReturnTypeString(false) + " _retarray = new " + getReturnTypeString(true) + "[_res.length];");
writer.println(" for (int _count = 0; _count < _res.length; _count++) {");
writer.println(" _retarray[_count] = new " + getReturnTypeString(true) + "(_res[_count]);");
writer.println(" }");
writer.println(" return _retarray;");
}
}
public static String javaThisArgumentName() {
return "jthis0";
}
protected String getCommentStartString() { return "/** "; }
protected String getBaseIndentString() { return " "; }
protected String getReturnedArrayLengthExpression() {
return returnedArrayLengthExpression;
}
/**
* Class that emits a generic comment for JavaMethodBindingEmitters; the comment
* includes the C signature of the native method that is being bound by the
* emitter java method.
*/
protected class DefaultCommentEmitter implements CommentEmitter {
public void emit(FunctionEmitter emitter, PrintWriter writer) {
emitBeginning(emitter, writer);
emitBindingCSignature(((JavaMethodBindingEmitter)emitter).getBinding(), writer);
emitEnding(emitter, writer);
}
protected void emitBeginning(FunctionEmitter emitter, PrintWriter writer) {
writer.print("Entry point to C language function: <br> ");
}
protected void emitBindingCSignature(MethodBinding binding, PrintWriter writer) {
writer.print("<code> ");
writer.print(binding.getCSymbol());
writer.print(" </code> ");
}
protected void emitEnding(FunctionEmitter emitter, PrintWriter writer) {
// If argument type is a named enum, then emit a comment detailing the
// acceptable values of that enum.
// If we're emitting a direct buffer variant only, then declare
// that the NIO buffer arguments must be direct.
MethodBinding binding = ((JavaMethodBindingEmitter)emitter).getBinding();
for (int i = 0; i < binding.getNumArguments(); i++) {
Type type = binding.getCArgumentType(i);
JavaType javaType = binding.getJavaArgumentType(i);
// don't emit param comments for anonymous enums, since we can't
// distinguish between the values found within multiple anonymous
// enums in the same C translation unit.
if (type.isEnum() && type.getName() != HeaderParser.ANONYMOUS_ENUM_NAME) {
EnumType enumType = (EnumType)type;
writer.println();
writer.print(emitter.getBaseIndentString());
writer.print(" ");
writer.print("@param ");
writer.print(binding.getArgumentName(i));
writer.print(" valid values are: <code>");
for (int j = 0; j < enumType.getNumEnumerates(); ++j) {
if (j>0) writer.print(", ");
writer.print(enumType.getEnumName(j));
}
writer.println("</code>");
} else if (directNIOOnly && javaType.isNIOBuffer()) {
writer.println();
writer.print(emitter.getBaseIndentString());
writer.print(" ");
writer.print("@param ");
writer.print(binding.getArgumentName(i));
writer.print(" a direct {@link " + javaType.getName() + "}");
}
}
}
}
protected class InterfaceCommentEmitter
extends JavaMethodBindingEmitter.DefaultCommentEmitter
{
protected void emitBeginning(FunctionEmitter emitter,
PrintWriter writer) {
writer.print("Interface to C language function: <br> ");
}
}
}
|