/usr/share/gluegen2/src/java/com/jogamp/gluegen/JavaMethodBindingEmitter.java is in libgluegen2-build-java 2.0-rc3-6.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 | /*
* 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.jogamp.gluegen;
import com.jogamp.gluegen.cgram.HeaderParser;
import com.jogamp.gluegen.cgram.types.ArrayType;
import com.jogamp.gluegen.cgram.types.CompoundType;
import com.jogamp.gluegen.cgram.types.EnumType;
import com.jogamp.gluegen.cgram.types.PointerType;
import com.jogamp.gluegen.cgram.types.Type;
import java.io.PrintWriter;
import java.text.MessageFormat;
import java.util.List;
/**
* 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;
private String unsupportedExceptionType;
protected boolean emitBody;
protected boolean eraseBufferAndArrayTypes;
protected boolean directNIOOnly;
protected boolean forImplementingMethodCall;
protected boolean forDirectBufferImplementation;
protected boolean forIndirectBufferAndArrayImplementation;
protected boolean isUnimplemented;
protected boolean tagNativeBinding;
protected MethodBinding binding;
// Manually-specified prologue and epilogue code
protected List<String> prologue;
protected List<String> epilogue;
// 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;
// A suffix used to create a temporary outgoing array of Buffers to
// represent an array of compound type wrappers
private static final String COMPOUND_ARRAY_SUFFIX = "_buf_array_copy";
// Only present to provide more clear comments
private JavaConfiguration cfg;
public JavaMethodBindingEmitter(MethodBinding binding,
PrintWriter output,
String runtimeExceptionType,
String unsupportedExceptionType,
boolean emitBody,
boolean tagNativeBinding,
boolean eraseBufferAndArrayTypes,
boolean directNIOOnly,
boolean forImplementingMethodCall,
boolean forDirectBufferImplementation,
boolean forIndirectBufferAndArrayImplementation,
boolean isUnimplemented,
boolean isInterface,
JavaConfiguration configuration) {
super(output, isInterface);
this.binding = binding;
this.runtimeExceptionType = runtimeExceptionType;
this.unsupportedExceptionType = unsupportedExceptionType;
this.emitBody = emitBody;
this.tagNativeBinding = tagNativeBinding;
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);
}
cfg = configuration;
}
public JavaMethodBindingEmitter(JavaMethodBindingEmitter arg) {
super(arg);
binding = arg.binding;
runtimeExceptionType = arg.runtimeExceptionType;
unsupportedExceptionType = arg.unsupportedExceptionType;
emitBody = arg.emitBody;
tagNativeBinding = arg.tagNativeBinding;
eraseBufferAndArrayTypes = arg.eraseBufferAndArrayTypes;
directNIOOnly = arg.directNIOOnly;
forImplementingMethodCall = arg.forImplementingMethodCall;
forDirectBufferImplementation = arg.forDirectBufferImplementation;
forIndirectBufferAndArrayImplementation = arg.forIndirectBufferAndArrayImplementation;
isUnimplemented = arg.isUnimplemented;
prologue = arg.prologue;
epilogue = arg.epilogue;
returnedArrayLengthExpression = arg.returnedArrayLengthExpression;
cfg = arg.cfg;
}
public final MethodBinding getBinding() { return binding; }
public boolean isForImplementingMethodCall() { return forImplementingMethodCall; }
public boolean isForDirectBufferImplementation() { return forDirectBufferImplementation; }
public boolean isForIndirectBufferAndArrayImplementation() { return forIndirectBufferAndArrayImplementation; }
public String getName() {
return binding.getName();
}
protected String getArgumentName(int i) {
return binding.getArgumentName(i);
}
/** 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;
}
public String getUnsupportedExceptionType() {
return unsupportedExceptionType;
}
/** 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;
}
/** Sets the manually-generated prologue code for this emitter. */
public void setPrologue(List<String> prologue) {
this.prologue = prologue;
}
/** Sets the manually-generated epilogue code for this emitter. */
public void setEpilogue(List<String> epilogue) {
this.epilogue = epilogue;
}
/** 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;
}
/** Accessor for subclasses. */
public void setForDirectBufferImplementation(boolean direct) {
this.forDirectBufferImplementation = direct;
}
/** Accessor for subclasses. */
public void setForIndirectBufferAndArrayImplementation(boolean indirect) {
this.forIndirectBufferAndArrayImplementation = indirect;
}
protected void emitReturnType(PrintWriter writer) {
writer.print(getReturnTypeString(false));
}
protected String erasedTypeString(JavaType type, boolean skipBuffers) {
if (eraseBufferAndArrayTypes) {
if (type.isNIOBuffer()) {
if (!skipBuffers) {
// Direct buffers and arrays sent down as Object (but
// returned as e.g. ByteBuffer)
return "Object";
}
if (!type.isNIOByteBuffer()) {
// Return buffer requiring change of view from ByteBuffer to e.g. LongBuffer
return "ByteBuffer";
}
} else if (type.isPrimitiveArray()) {
if (!skipBuffers) {
// Direct buffers and arrays sent down as Object (but
// returned as e.g. ByteBuffer)
return "Object";
}
} else if (type.isNIOBufferArray()) {
// Arrays of direct Buffers sent down as Object[]
// (Note we don't yet support returning void**)
return "Object[]";
} else if (type.isCompoundTypeWrapper()) {
// Compound type wrappers are unwrapped to ByteBuffer
return "ByteBuffer";
} else if (type.isArrayOfCompoundTypeWrappers()) {
if (skipBuffers) {
return "ByteBuffer";
} else {
// In the case where this is called with a false skipBuffers
// argument we want to erase the array of compound type
// wrappers to ByteBuffer[]
return "ByteBuffer[]";
}
}
}
String name = type.getName();
int index = name.lastIndexOf('.')+1; // always >= 0
name = name.substring(index);
if (type.isArrayOfCompoundTypeWrappers()) {
// We don't want to bake the array specification into the type name
return name + "[]";
}
return name;
}
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) {
writer.print(getImplMethodName());
} 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("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(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));
if(!directNIOOnly) {
writer.print(", boolean " + isNIOArgName(i));
}
} else if (type.isNIOBufferArray()) {
writer.print(", int[] " + byteOffsetArrayArgName(i));
}
}
// Add offset argument after each primitive array
if (type.isPrimitiveArray()) {
if(directNIOOnly) {
throw new RuntimeException("NIODirectOnly "+binding+" is set, but "+getArgumentName(i)+" is a primitive array");
}
writer.print(", int " + offsetArgName(i));
}
}
return numEmitted;
}
protected String getImplMethodName() {
return binding.getName() + ( directNIOOnly ? "0" : "1" );
}
protected String byteOffsetArgName(int i) {
return byteOffsetArgName(getArgumentName(i));
}
protected String byteOffsetArgName(String s) {
return s + "_byte_offset";
}
protected String isNIOArgName(int i) {
return isNIOArgName(binding.getArgumentName(i));
}
protected String isNIOArgName(String s) {
return s + "_is_direct";
}
protected String byteOffsetArrayArgName(int i) {
return getArgumentName(i) + "_byte_offset_array";
}
protected String offsetArgName(int i) {
return getArgumentName(i) + "_offset";
}
protected void emitBody(PrintWriter writer) {
if (!emitBody) {
writer.println(';');
} else {
MethodBinding mBinding = getBinding();
writer.println(" {");
writer.println();
if (isUnimplemented) {
writer.println(" throw new " + getUnsupportedExceptionType() + "(\"Unimplemented\");");
} else {
emitPrologueOrEpilogue(prologue, writer);
emitPreCallSetup(mBinding, writer);
//emitReturnVariableSetup(binding, writer);
emitReturnVariableSetupAndCall(mBinding, writer);
}
writer.println(" }");
}
}
protected void emitPrologueOrEpilogue(List<String> code, PrintWriter writer) {
if (code != null) {
String[] argumentNames = argumentNameArray();
for (String str : code) {
try {
MessageFormat fmt = new MessageFormat(str);
writer.println(" " + fmt.format(argumentNames));
} catch (IllegalArgumentException e) {
// (Poorly) handle case where prologue / epilogue contains blocks of code with braces
writer.println(" " + str);
}
}
}
}
protected void emitPreCallSetup(MethodBinding binding, PrintWriter writer) {
emitArrayLengthAndNIOBufferChecks(binding, writer);
emitCompoundArrayCopies(binding, writer);
}
protected void emitArrayLengthAndNIOBufferChecks(MethodBinding binding, PrintWriter writer) {
// 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 (" + getArgumentName(i) + ".length < " +
arrayType.getLength() + ")");
writer.println(" throw new " + getRuntimeExceptionType() +
"(\"Length of array \\\"" + getArgumentName(i) +
"\\\" was less than the required " + arrayType.getLength() + "\");");
// FIXME: What is this ??? Until resolved - throw an exception !
throw new RuntimeException("????? "+binding+": binding.getCArgumentType("+i+").isArray(): "+type);
} else {
JavaType javaType = binding.getJavaArgumentType(i);
if (javaType.isNIOBuffer()) {
if (directNIOOnly) {
writer.println(" if (!Buffers.isDirect(" + getArgumentName(i) + "))");
writer.println(" throw new " + getRuntimeExceptionType() + "(\"Argument \\\"" +
getArgumentName(i) + "\\\" was not a direct buffer\");");
} else {
writer.print(" boolean " + isNIOArgName(i) + " = ");
writer.println(getArgumentName(i) + " != null && Buffers.isDirect(" + getArgumentName(i) + ");");
}
} else if (javaType.isNIOBufferArray()) {
// All buffers passed down in an array of NIO buffers must be direct
String argName = 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 (!Buffers.isDirect(" + argName + "[_ctr])) {");
writer.println(" throw new " + getRuntimeExceptionType() +
"(\"Element \" + _ctr + \" of argument \\\"" +
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] = Buffers.getDirectBufferByteOffset(");
writer.println(argName + "[_ctr]);");
writer.println(" }");
writer.println(" }");
} else if (javaType.isPrimitiveArray()) {
String argName = 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 emitCompoundArrayCopies(MethodBinding binding, PrintWriter writer) {
// If the method binding uses outgoing arrays of compound type
// wrappers, we need to generate a temporary copy of this array
// into a ByteBuffer[] for processing by the native code
if (binding.signatureUsesArraysOfCompoundTypeWrappers()) {
for (int i = 0; i < binding.getNumArguments(); i++) {
JavaType javaType = binding.getJavaArgumentType(i);
if (javaType.isArrayOfCompoundTypeWrappers()) {
String argName = getArgumentName(i);
String tempArrayName = argName + COMPOUND_ARRAY_SUFFIX;
writer.println(" ByteBuffer[] " + tempArrayName + " = new ByteBuffer[" + argName + ".length];");
writer.println(" for (int _ctr = 0; _ctr < + " + argName + ".length; _ctr++) {");
writer.println(" " + javaType.getName() + " _tmp = " + argName + "[_ctr];");
writer.println(" " + tempArrayName + "[_ctr] = ((_tmp == null) ? null : _tmp.getBuffer());");
writer.println(" }");
}
}
}
}
protected void emitCall(MethodBinding binding, PrintWriter writer) {
writer.print(getImplMethodName());
writer.print("(");
emitCallArguments(binding, writer);
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.isNIOBuffer()) {
writer.println("ByteBuffer _res;");
needsResultAssignment = true;
} else if (returnType.isArrayOfCompoundTypeWrappers()) {
writer.println("ByteBuffer[] _res;");
needsResultAssignment = true;
} else if (((epilogue != null) && (epilogue.size() > 0)) ||
binding.signatureUsesArraysOfCompoundTypeWrappers()) {
emitReturnType(writer);
writer.println(" _res;");
needsResultAssignment = true;
}
}
if (needsResultAssignment) {
writer.print(" _res = ");
} else {
writer.print(" ");
if (!returnType.isVoid()) {
writer.print("return ");
}
}
emitCall(binding, writer);
writer.println();
emitPostCallCleanup(binding, writer);
emitPrologueOrEpilogue(epilogue, writer);
if (needsResultAssignment) {
emitCallResultReturn(binding, writer);
}
}
protected int emitCallArguments(MethodBinding binding, PrintWriter writer) {
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()) {
if(type.isNIOPointerBuffer()) {
if (directNIOOnly) {
writer.print( getArgumentName(i)+ " != null ? " + getArgumentName(i) + ".getBuffer() : null");
} else {
writer.print( isNIOArgName(i) + " ? ( " + getArgumentName(i)+ " != null ? " + getArgumentName(i) + ".getBuffer() : null )");
writer.print( " : Buffers.getArray(" + getArgumentName(i) + ")" );
}
} else {
if (directNIOOnly) {
writer.print( getArgumentName(i) );
} else {
writer.print( isNIOArgName(i) + " ? " + getArgumentName(i) + " : Buffers.getArray(" + getArgumentName(i) + ")" );
}
}
} else if (type.isArrayOfCompoundTypeWrappers()) {
writer.print(getArgumentName(i) + COMPOUND_ARRAY_SUFFIX);
} else {
writer.print(getArgumentName(i));
}
if (type.isCompoundTypeWrapper()) {
writer.print(" == null) ? null : ");
writer.print(getArgumentName(i));
writer.print(".getBuffer())");
}
if (type.isNIOBuffer()) {
if (directNIOOnly) {
writer.print( ", Buffers.getDirectBufferByteOffset(" + getArgumentName(i) + ")");
} else {
writer.print( ", " + isNIOArgName(i) + " ? Buffers.getDirectBufferByteOffset(" + getArgumentName(i) + ")");
writer.print( " : Buffers.getIndirectBufferByteOffset(" + getArgumentName(i) + ")");
}
} else if (type.isNIOBufferArray()) {
writer.print(", " + byteOffsetArrayArgName(i));
} else if (type.isPrimitiveArray()) {
if(type.isFloatArray()) {
writer.print(", Buffers.SIZEOF_FLOAT * ");
} else if(type.isDoubleArray()) {
writer.print(", Buffers.SIZEOF_DOUBLE * ");
} else if(type.isByteArray()) {
writer.print(", ");
} 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 RuntimeException("Unsupported type for calculating array offset argument for " +
getArgumentName(i) +
" -- error occurred while processing Java glue code for " + getName());
}
writer.print(offsetArgName(i));
}
if (type.isNIOBuffer()) {
if (!directNIOOnly) {
writer.print( ", " + isNIOArgName(i) );
}
} else if (type.isPrimitiveArray()) {
if (directNIOOnly) {
throw new RuntimeException("NIODirectOnly "+binding+" is set, but "+getArgumentName(i)+" is a primitive array");
}
writer.print( ", false");
}
needComma = true;
++numArgsEmitted;
}
return numArgsEmitted;
}
protected void emitPostCallCleanup(MethodBinding binding, PrintWriter writer) {
if (binding.signatureUsesArraysOfCompoundTypeWrappers()) {
// For each such array, we need to take the ByteBuffer[] that
// came back from the C method invocation and wrap the
// ByteBuffers back into the wrapper types
for (int i = 0; i < binding.getNumArguments(); i++) {
JavaType javaArgType = binding.getJavaArgumentType(i);
if (javaArgType.isArrayOfCompoundTypeWrappers()) {
String argName = binding.getArgumentName(i);
writer.println(" for (int _ctr = 0; _ctr < " + argName + ".length; _ctr++) {");
writer.println(" if ((" + argName + "[_ctr] == null && " + argName + COMPOUND_ARRAY_SUFFIX + "[_ctr] == null) ||");
writer.println(" (" + argName + "[_ctr] != null && " + argName + "[_ctr].getBuffer() == " + argName + COMPOUND_ARRAY_SUFFIX + "[_ctr])) {");
writer.println(" // No copy back needed");
writer.println(" } else {");
writer.println(" if (" + argName + COMPOUND_ARRAY_SUFFIX + "[_ctr] == null) {");
writer.println(" " + argName + "[_ctr] = null;");
writer.println(" } else {");
writer.println(" " + argName + "[_ctr] = " + javaArgType.getName() + ".create(" + argName + COMPOUND_ARRAY_SUFFIX + "[_ctr]);");
writer.println(" }");
writer.println(" }");
writer.println(" }");
}
}
}
}
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 " + returnType.getName() + ".create(Buffers.nativeOrder(_res))");
} else {
writer.println(" Buffers.nativeOrder(_res);");
String expr = new MessageFormat(fmt).format(argumentNameArray());
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 " + 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 * " + getReturnTypeString(true) + ".size());");
writer.println(" _res.limit ((1 + _count) * " + getReturnTypeString(true) + ".size());");
writer.println(" ByteBuffer _tmp = _res.slice();");
writer.println(" Buffers.nativeOrder(_tmp);");
writer.println(" _res.position(0);");
writer.println(" _res.limit(_res.capacity());");
writer.println(" _retarray[_count] = " + getReturnTypeString(true) + ".create(_tmp);");
writer.println(" }");
writer.print (" return _retarray");
}
writer.println(";");
} else if (returnType.isNIOBuffer()) {
writer.println(" if (_res == null) return null;");
writer.println(" Buffers.nativeOrder(_res);");
if (!returnType.isNIOByteBuffer()) {
// See whether we have to expand pointers to longs
if (getBinding().getCReturnType().pointerDepth() >= 2) {
if (returnType.isNIOPointerBuffer()) {
writer.println(" return PointerBuffer.wrap(_res);");
} else if (returnType.isNIOLongBuffer()) {
writer.println(" return _res.asLongBuffer();");
} else {
throw new RuntimeException("While emitting glue code for " + getName() +
": can not legally make pointers opaque to anything but PointerBuffer or LongBuffer/long");
}
} else if (getBinding().getCReturnType().pointerDepth() == 1 && returnType.isNIOLongBuffer()) {
writer.println(" return _res.asLongBuffer();");
} else {
String returnTypeName = returnType.getName().substring("java.nio.".length());
writer.println(" return _res.as" + returnTypeName + "();");
}
} else {
writer.println(" return _res;");
}
} 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] = " + getReturnTypeString(true) + ".create(_res[_count]);");
writer.println(" }");
writer.println(" return _retarray;");
} else {
// Assume it's a primitive type or other type we don't have to
// do any conversion on
writer.println(" return _res;");
}
}
protected String[] argumentNameArray() {
String[] argumentNames = new String[binding.getNumArguments()];
for (int i = 0; i < binding.getNumArguments(); i++) {
argumentNames[i] = getArgumentName(i);
if (binding.getJavaArgumentType(i).isPrimitiveArray()) {
// Add on _offset argument in comma-separated expression
argumentNames[i] = argumentNames[i] + ", " + offsetArgName(i);
}
}
return argumentNames;
}
public static String javaThisArgumentName() {
return "jthis0";
}
@Override
protected String getCommentStartString() { return "/** "; }
@Override
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: ");
}
protected void emitBindingCSignature(MethodBinding binding, PrintWriter writer) {
writer.print("<code> ");
writer.print(binding.getCSymbol().toString(tagNativeBinding));
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() && !HeaderParser.ANONYMOUS_ENUM_NAME.equals(type.getName())) {
EnumType enumType = (EnumType)type;
writer.println();
writer.print(emitter.getBaseIndentString());
writer.print(" ");
writer.print("@param ");
writer.print(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(getArgumentName(i));
writer.print(" a direct {@link " + javaType.getName() + "}");
}
}
}
}
protected class InterfaceCommentEmitter extends JavaMethodBindingEmitter.DefaultCommentEmitter {
@Override
protected void emitBeginning(FunctionEmitter emitter,
PrintWriter writer) {
writer.print("Interface to C language function: <br> ");
}
}
}
|