summaryrefslogtreecommitdiffstats
path: root/src/classes/com/sun/gluegen/opengl/GLCMethodBindingEmitter.java
diff options
context:
space:
mode:
authorKenneth Russel <[email protected]>2005-12-21 23:32:38 +0000
committerKenneth Russel <[email protected]>2005-12-21 23:32:38 +0000
commit4d1216921e546cb9c38a9ace5d8d99a61385ca44 (patch)
treebb1f30887fc9294df8cbe81b20cab40d54e98dc2 /src/classes/com/sun/gluegen/opengl/GLCMethodBindingEmitter.java
parent17b304bac231962835f93e62d72b707bc423446c (diff)
Refactored glue code generation for APIs requiring run-time lookup of
individual function pointers into generic ProcAddressEmitter. Removed all OpenGL-specific routines and names from this emitter. The new ProcAddressConfiguration is more generic than the GLConfiguration and supports mostly-arbitrary mappings from function names to function pointer typedefs via the new ProcAddressNameExpr directive. Refactored GLEmitter into thin layer on top of this ProcAddressEmitter providing only ignoring of extensions and checking for buffer object variants of functions. Made GLConfiguration a stand-alone class. Deleted ContextVariableName directive in favor of more generic GetProcAddressTableExpr command. Moved resetting of generated ProcAddressTables into GlueGen runtime class ProcAddressHelper; user provides the dynamic lookup function (dlsym, etc.) through new DynamicLookupHelper interface. Fixed bug in generation of Java epilogues for routines returning primitive values. Fixed bugs in AccessControl directive, in particular when generating interfaces. Made small changes to autogenerated comments for routines called through function pointers. These changes do not impact the public API of JOGL -- this has been verified by examining diffs between the current and new autogenerated code. They do make the GlueGen tool more generic and allow it to be easily applied to the task of autogenerating the JOAL API and implementation as well. Also verified by running JOGL demos and JOAL demos in new JOAL workspace. git-svn-id: file:///usr/local/projects/SUN/JOGL/git-svn/svn-server-sync/jogl/trunk@500 232f8b59-042b-4e1e-8c03-345bb8c30851
Diffstat (limited to 'src/classes/com/sun/gluegen/opengl/GLCMethodBindingEmitter.java')
-rwxr-xr-xsrc/classes/com/sun/gluegen/opengl/GLCMethodBindingEmitter.java202
1 files changed, 0 insertions, 202 deletions
diff --git a/src/classes/com/sun/gluegen/opengl/GLCMethodBindingEmitter.java b/src/classes/com/sun/gluegen/opengl/GLCMethodBindingEmitter.java
deleted file mode 100755
index 43053410e..000000000
--- a/src/classes/com/sun/gluegen/opengl/GLCMethodBindingEmitter.java
+++ /dev/null
@@ -1,202 +0,0 @@
-/*
- * 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.opengl;
-
-import java.io.*;
-import java.util.*;
-import com.sun.gluegen.*;
-import com.sun.gluegen.cgram.types.*;
-
-public class GLCMethodBindingEmitter extends CMethodBindingEmitter {
- private static final CommentEmitter defaultCommentEmitter =
- new CGLPAWrapperCommentEmitter();
-
- private boolean callThroughProcAddress;
- private String glFuncPtrTypedefValue;
- private static String procAddressJavaTypeName =
- JavaType.createForClass(Long.TYPE).jniTypeName();
-
- public GLCMethodBindingEmitter(CMethodBindingEmitter methodToWrap,
- final boolean callThroughProcAddress) {
- super(
- new MethodBinding(methodToWrap.getBinding()) {
- public String getName() {
- if (callThroughProcAddress) {
- return GLEmitter.WRAP_PREFIX + super.getName();
- } else {
- return super.getName();
- }
- }
-
- public String getRenamedMethodName() {
- if (callThroughProcAddress) {
- return GLEmitter.WRAP_PREFIX + super.getRenamedMethodName();
- } else {
- return super.getRenamedMethodName();
- }
- }
- },
- methodToWrap.getDefaultOutput(),
- methodToWrap.getDefaultMachineDescription(),
- methodToWrap.getJavaPackageName(),
- methodToWrap.getJavaClassName(),
- methodToWrap.getIsOverloadedBinding(),
- methodToWrap.getIsJavaMethodStatic(),
- true,
- methodToWrap.forIndirectBufferAndArrayImplementation()
- );
-
- if (methodToWrap.getReturnValueCapacityExpression() != null) {
- setReturnValueCapacityExpression(methodToWrap.getReturnValueCapacityExpression());
- }
- if (methodToWrap.getReturnValueLengthExpression() != null) {
- setReturnValueLengthExpression(methodToWrap.getReturnValueLengthExpression());
- }
- setTemporaryCVariableDeclarations(methodToWrap.getTemporaryCVariableDeclarations());
- setTemporaryCVariableAssignments (methodToWrap.getTemporaryCVariableAssignments ());
-
- setCommentEmitter(defaultCommentEmitter);
- this.callThroughProcAddress = callThroughProcAddress;
- }
-
- protected int emitArguments(PrintWriter writer) {
- int numEmitted = super.emitArguments(writer);
- if (callThroughProcAddress) {
- if (numEmitted > 0)
- {
- writer.print(", ");
- }
- //writer.print("long glProcAddress");
- writer.print(procAddressJavaTypeName);
- writer.print(" glProcAddress");
- ++numEmitted;
- }
-
- return numEmitted;
- }
-
- protected void emitBodyVariableDeclarations(PrintWriter writer) {
- if (callThroughProcAddress) {
- // create variable for the function pointer with the right type, and set
- // it to the value of the passed-in glProcAddress
- FunctionSymbol cSym = getBinding().getCSymbol();
- String funcPointerTypedefName =
- GLEmitter.getGLFunctionPointerTypedefName(cSym);
-
- writer.print(" ");
- writer.print(funcPointerTypedefName);
- writer.print(" ptr_");
- writer.print(cSym.getName());
- writer.println(";");
- }
-
- super.emitBodyVariableDeclarations(writer);
- }
-
- protected void emitBodyVariablePreCallSetup(PrintWriter writer,
- boolean emittingPrimitiveArrayCritical) {
- super.emitBodyVariablePreCallSetup(writer, emittingPrimitiveArrayCritical);
-
- if (callThroughProcAddress) {
- if (!emittingPrimitiveArrayCritical) {
- // set the function pointer to the value of the passed-in glProcAddress
- FunctionSymbol cSym = getBinding().getCSymbol();
- String funcPointerTypedefName =
- GLEmitter.getGLFunctionPointerTypedefName(cSym);
-
- String ptrVarName = "ptr_" + cSym.getName();
-
- writer.print(" ");
- writer.print(ptrVarName);
- writer.print(" = (");
- writer.print(funcPointerTypedefName);
- writer.println(") (intptr_t) glProcAddress;");
-
- writer.println(" assert(" + ptrVarName + " != NULL);");
- }
- }
- }
-
- protected void emitBodyCallCFunction(PrintWriter writer) {
- if (!callThroughProcAddress) {
- super.emitBodyCallCFunction(writer);
- } else {
- // Make the call to the actual C function
- writer.print(" ");
-
- // WARNING: this code assumes that the return type has already been
- // typedef-resolved.
- Type cReturnType = binding.getCReturnType();
-
- if (!cReturnType.isVoid()) {
- writer.print("_res = ");
- }
- MethodBinding binding = getBinding();
- if (binding.hasContainingType()) {
- // Cannot call GL func through function pointer
- throw new IllegalStateException(
- "Cannot call GL func through function pointer: " + binding);
- }
-
- // call throught the run-time function pointer
- writer.print("(* ptr_");
- writer.print(binding.getCSymbol().getName());
- writer.print(") ");
- writer.print("(");
- emitBodyPassCArguments(writer);
- writer.println(");");
- }
- }
-
- protected String jniMangle(MethodBinding binding) {
- StringBuffer buf = new StringBuffer(super.jniMangle(binding));
- if (callThroughProcAddress) {
- jniMangle(Long.TYPE, buf, false); // to account for the additional _addr_ parameter
- }
- return buf.toString();
- }
-
- /** This class emits the comment for the wrapper method */
- private static class CGLPAWrapperCommentEmitter extends CMethodBindingEmitter.DefaultCommentEmitter {
- protected void emitBeginning(FunctionEmitter methodEmitter, PrintWriter writer) {
- writer.print(" -- FIXME: IMPLEMENT COMMENT FOR CGLPAWrapperCommentEmitter -- ");
- }
- }
-} // end class GLCMethodBindingEmitter