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

1 files changed, 198 insertions, 0 deletions

diff --git a/src/classes/com/sun/gluegen/opengl/GLConfiguration.java b/src/classes/com/sun/gluegen/opengl/GLConfiguration.java
new file mode 100755
index 000000000..a44f3fe9f
--- /dev/null
+++ b/src/classes/com/sun/gluegen/opengl/GLConfiguration.java
@@ -0,0 +1,198 @@
+/*
+ * Copyright (c) 2003-2005 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.procaddress.*;
+
+public class GLConfiguration extends ProcAddressConfiguration {
+  // The following data members support ignoring an entire extension at a time
+  private List/*<String>*/ glHeaders = new ArrayList();
+  private Set/*<String>*/ ignoredExtensions = new HashSet();
+  private BuildStaticGLInfo glInfo;
+  // Maps function names to the kind of buffer object it deals with
+  private Map/*<String,GLEmitter.BufferObjectKind>*/ bufferObjectKinds = new HashMap();
+  private GLEmitter emitter;
+
+  public GLConfiguration(GLEmitter emitter) {
+    super();
+    this.emitter = emitter;
+    try {
+      setProcAddressNameExpr("PFN $UPPERCASE({0}) PROC");
+    } catch (NoSuchElementException e) {
+      throw new RuntimeException("Error configuring ProcAddressNameExpr", e);
+    }
+  }
+
+  protected void dispatch(String cmd, StringTokenizer tok, File file, String filename, int lineNo) throws IOException {
+    if (cmd.equalsIgnoreCase("IgnoreExtension"))
+      {
+        String sym = readString("IgnoreExtension", tok, filename, lineNo);
+        ignoredExtensions.add(sym);
+      }
+    else if (cmd.equalsIgnoreCase("GLHeader"))
+      {
+        String sym = readString("GLHeader", tok, filename, lineNo);
+        glHeaders.add(sym);
+      }
+    else if (cmd.equalsIgnoreCase("BufferObjectKind"))
+      {
+        readBufferObjectKind(tok, filename, lineNo);
+      }
+    else
+      {
+        super.dispatch(cmd,tok,file,filename,lineNo);
+      }
+  }  
+
+  protected void readBufferObjectKind(StringTokenizer tok, String filename, int lineNo) {
+    try {
+      String kindString = tok.nextToken();
+      GLEmitter.BufferObjectKind kind = null;
+      String target = tok.nextToken();
+      if (kindString.equalsIgnoreCase("UnpackPixel")) {
+        kind = GLEmitter.BufferObjectKind.UNPACK_PIXEL;
+      } else if (kindString.equalsIgnoreCase("PackPixel")) {
+        kind = GLEmitter.BufferObjectKind.PACK_PIXEL;
+      } else if (kindString.equalsIgnoreCase("Array")) {
+        kind = GLEmitter.BufferObjectKind.ARRAY;
+      } else if (kindString.equalsIgnoreCase("Element")) {
+        kind = GLEmitter.BufferObjectKind.ELEMENT;
+      } else {
+        throw new RuntimeException("Error parsing \"BufferObjectKind\" command at line " + lineNo +
+                                   " in file \"" + filename + "\": illegal BufferObjectKind \"" +
+                                   kindString + "\", expected one of UnpackPixel, PackPixel, Array, or Element");
+      }
+
+      bufferObjectKinds.put(target, kind);
+    } catch (NoSuchElementException e) {
+      throw new RuntimeException("Error parsing \"BufferObjectKind\" command at line " + lineNo +
+                                 " in file \"" + filename + "\"", e);
+    }
+  }
+
+  /** Overrides javaPrologueForMethod in superclass and
+      automatically generates prologue code for functions associated
+      with buffer objects. */
+  public List/*<String>*/ javaPrologueForMethod(MethodBinding binding,
+                                                boolean forImplementingMethodCall,
+                                                boolean eraseBufferAndArrayTypes) {
+    List/*<String>*/ res = super.javaPrologueForMethod(binding,
+                                                       forImplementingMethodCall,
+                                                       eraseBufferAndArrayTypes);
+    GLEmitter.BufferObjectKind kind = getBufferObjectKind(binding.getName());
+    if (kind != null) {
+      // Need to generate appropriate prologue based on both buffer
+      // object kind and whether this variant of the MethodBinding
+      // is the one accepting a "long" as argument
+      if (res == null) {
+        res = new ArrayList();
+      }
+
+      String prologue = "check";
+
+      if (kind == GLEmitter.BufferObjectKind.UNPACK_PIXEL) {
+        prologue = prologue + "UnpackPBO";
+      } else if (kind == GLEmitter.BufferObjectKind.PACK_PIXEL) {
+        prologue = prologue + "PackPBO";
+      } else if (kind == GLEmitter.BufferObjectKind.ARRAY) {
+        prologue = prologue + "ArrayVBO";
+      } else if (kind == GLEmitter.BufferObjectKind.ELEMENT) {
+        prologue = prologue + "ElementVBO";
+      } else {
+        throw new RuntimeException("Unknown BufferObjectKind " + kind);
+      }
+
+      if (emitter.isBufferObjectMethodBinding(binding)) {
+        prologue = prologue + "Enabled";
+      } else {
+        prologue = prologue + "Disabled";
+      }
+
+      prologue = prologue + "();";
+
+      res.add(0, prologue);
+    }
+
+    return res;
+  }
+
+  public boolean shouldIgnore(String symbol) {
+    // Check ignored extensions based on our knowledge of the static GL info
+    if (glInfo != null) {
+      String extension = glInfo.getExtension(symbol);
+      if (extension != null &&
+          ignoredExtensions.contains(extension)) {
+        return true;
+      }
+    }
+
+    return super.shouldIgnore(symbol);
+  }
+
+  /** Returns the kind of buffer object this function deals with, or
+      null if none. */
+  public GLEmitter.BufferObjectKind getBufferObjectKind(String name) {
+    return (GLEmitter.BufferObjectKind) bufferObjectKinds.get(name);
+  }
+
+  public boolean isBufferObjectFunction(String name) {
+    return (getBufferObjectKind(name) != null);
+  }
+
+  /** Parses any GL headers specified in the configuration file for
+      the purpose of being able to ignore an extension at a time. */
+  public void parseGLHeaders(GlueEmitterControls controls) throws IOException {
+    if (!glHeaders.isEmpty()) {
+      glInfo = new BuildStaticGLInfo();
+      for (Iterator iter = glHeaders.iterator(); iter.hasNext(); ) {
+        String file = (String) iter.next();
+        String fullPath = controls.findHeaderFile(file);
+        if (fullPath == null) {
+          throw new IOException("Unable to locate header file \"" + file + "\"");
+        }
+        glInfo.parse(fullPath);
+      }
+    }
+  }
+}