Moved GlueGen out of the JOGL workspace and into its own project.

Restructured JOGL and JOAL build processes to separately invoke
GlueGen's main build.xml before using it to generate their code.
Refactored OS/CPU detection code into gluegen-cpptasks.xml build file
in GlueGen workspace, which is now imported by both the JOGL and JOAL
build processes. Unfortunately it seems to be somewhat difficult to
completely factor out the C compiler configuration into the GlueGen
workspace so this has been left for a later date. Added missed
ALProcAddressLookup file to JOAL workspace. Updated JOGL and JOAL
build documentation. More documentation for the GlueGen workspace is
forthcoming.


git-svn-id: file:///usr/local/projects/SUN/JOGL/git-svn/../svn-server-sync/gluegen/trunk@3 a78bb65f-1512-4460-ba86-f6dc96a7bf27

1 files changed, 179 insertions, 0 deletions

diff --git a/src/java/com/sun/gluegen/opengl/GLEmitter.java b/src/java/com/sun/gluegen/opengl/GLEmitter.java
new file mode 100644
index 000000000..8e7484a73
--- /dev/null
+++ b/src/java/com/sun/gluegen/opengl/GLEmitter.java
@@ -0,0 +1,179 @@
+/*
+ * 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.text.MessageFormat;
+import java.util.*;
+import com.sun.gluegen.*;
+import com.sun.gluegen.cgram.types.*;
+import com.sun.gluegen.procaddress.*;
+import com.sun.gluegen.runtime.*;
+
+/**
+ * A subclass of ProcAddressEmitter with special OpenGL-specific
+ * configuration abilities.
+ */
+public class GLEmitter extends ProcAddressEmitter
+{
+  // Keeps track of which MethodBindings were created for handling
+  // Buffer Object variants. Used as a Set rather than a Map.
+  private Map/*<MethodBinding>*/ bufferObjectMethodBindings = new IdentityHashMap();
+
+  static class BufferObjectKind {
+    private BufferObjectKind() {}
+
+    static final BufferObjectKind UNPACK_PIXEL = new BufferObjectKind();
+    static final BufferObjectKind PACK_PIXEL   = new BufferObjectKind();
+    static final BufferObjectKind ARRAY        = new BufferObjectKind();
+    static final BufferObjectKind ELEMENT      = new BufferObjectKind();
+  }
+  
+  public void beginEmission(GlueEmitterControls controls) throws IOException
+  {
+    getGLConfig().parseGLHeaders(controls);
+    super.beginEmission(controls);
+  }
+
+  protected JavaConfiguration createConfig() {
+    return new GLConfiguration(this);
+  }
+
+  /** In order to implement Buffer Object variants of certain
+      functions we generate another MethodBinding which maps the void*
+      argument to a Java long. The generation of emitters then takes
+      place as usual. We do however need to keep track of the modified
+      MethodBinding object so that we can also modify the emitters
+      later to inform them that their argument has changed. We might
+      want to push this functionality down into the MethodBinding
+      (i.e., mutators for argument names). We also would need to
+      inform the CMethodBindingEmitter that it is overloaded in this
+      case (though we default to true currently). */
+  protected List/*<MethodBinding>*/ expandMethodBinding(MethodBinding binding) {
+    List/*<MethodBinding>*/ bindings = super.expandMethodBinding(binding);
+    
+    if (!getGLConfig().isBufferObjectFunction(binding.getName())) {
+      return bindings;
+    }
+
+    List/*<MethodBinding>*/ newBindings = new ArrayList();
+    newBindings.addAll(bindings);
+
+    // Need to expand each one of the generated bindings to take a
+    // Java long instead of a Buffer for each void* argument
+    for (Iterator iter = bindings.iterator(); iter.hasNext(); ) {
+      MethodBinding cur = (MethodBinding) iter.next();
+      
+      // Some of these routines (glBitmap) take strongly-typed
+      // primitive pointers as arguments which are expanded into
+      // non-void* arguments
+      // This test (rather than !signatureUsesNIO) is used to catch
+      // more unexpected situations
+      if (cur.signatureUsesJavaPrimitiveArrays()) {
+        continue;
+      }
+
+      MethodBinding result = cur;
+      for (int i = 0; i < cur.getNumArguments(); i++) {
+        if (cur.getJavaArgumentType(i).isNIOBuffer()) {
+          result = result.replaceJavaArgumentType(i, JavaType.createForClass(Long.TYPE));
+        }
+      }
+
+      if (result == cur) {
+        throw new RuntimeException("Error: didn't find any void* arguments for BufferObject function " +
+                                   binding.getName());
+      }
+
+      newBindings.add(result);
+      // Now need to flag this MethodBinding so that we generate the
+      // correct flags in the emitters later
+      bufferObjectMethodBindings.put(result, result);
+    }
+
+    return newBindings;
+  }
+
+  protected boolean needsModifiedEmitters(FunctionSymbol sym) {
+    if ((!needsProcAddressWrapper(sym) && !needsBufferObjectVariant(sym)) ||
+        getConfig().isUnimplemented(sym.getName())) {
+      return false;
+    }
+
+    return true;
+  }
+
+  public boolean isBufferObjectMethodBinding(MethodBinding binding) {
+    return bufferObjectMethodBindings.containsKey(binding);
+  }
+
+  //----------------------------------------------------------------------
+  // Internals only below this point
+  //
+  
+  protected void generateModifiedEmitters(JavaMethodBindingEmitter baseJavaEmitter, List emitters) {
+    List superEmitters = new ArrayList();
+    super.generateModifiedEmitters(baseJavaEmitter, superEmitters);
+
+    // See whether this is one of the Buffer Object variants
+    boolean bufferObjectVariant = bufferObjectMethodBindings.containsKey(baseJavaEmitter.getBinding());
+
+    if (bufferObjectVariant) {
+      for (Iterator iter = superEmitters.iterator(); iter.hasNext(); ) {
+        JavaMethodBindingEmitter emitter = (JavaMethodBindingEmitter) iter.next();
+        if (emitter instanceof ProcAddressJavaMethodBindingEmitter) {
+          emitters.add(new GLJavaMethodBindingEmitter((ProcAddressJavaMethodBindingEmitter) emitter, bufferObjectVariant));
+        } else {
+          emitters.add(emitter);
+        }
+      }
+    } else {
+      emitters.addAll(superEmitters);
+    }
+  }
+
+  protected boolean needsBufferObjectVariant(FunctionSymbol sym) {
+    return getGLConfig().isBufferObjectFunction(sym.getName());
+  }
+  
+  protected GLConfiguration getGLConfig() {
+    return (GLConfiguration) getConfig();
+  }
+}