Add GLRendererQuirks; Fix shared EGL/ES resources;

Add GLRendererQuirks:
  - Contains centralized 'tagged' workarounds for GL renderer bugs (quirks)
  - Accessible via GLContext and GLDrawableFactory
  - Initialized in GLContext.setAvailability*
  -

Simplify GLGraphicsConfigurationUtil.fixOffscreenGLCapabilities(..) & use Quirks
  - use quirks
  - instead of passing booleans for each config, pass factory & device

Fix shared EGL/ES resources:
  - GLProfile needs to initialize EGLDrawableFactory's shared resources before desktop,
    so EGLDrawableFactory can use the fallback defaultDisplay & defaultSharedResource
    for host mapped sharedResources (hack).

  - If using defaultSharedResources for host mapped ones,
    do not go through initialization cycles - simply map (sharedResource + context).

  - EGLDrawableFactory: Use device's unique-key instead of connection only,
    since the latter causes a collision (EGL-connection == X11-connection).

3 files changed, 103 insertions, 31 deletions

diff --git a/src/jogl/classes/javax/media/opengl/GLContext.java b/src/jogl/classes/javax/media/opengl/GLContext.java
index a5e639c74..93b9bfe82 100644
--- a/src/jogl/classes/javax/media/opengl/GLContext.java
+++ b/src/jogl/classes/javax/media/opengl/GLContext.java
@@ -55,6 +55,7 @@ import com.jogamp.common.os.Platform;
 import com.jogamp.common.util.locks.LockFactory;
 import com.jogamp.common.util.locks.RecursiveLock;
 import com.jogamp.opengl.GLExtensions;
+import com.jogamp.opengl.GLRendererQuirks;
 
 /** Abstraction for an OpenGL rendering context. In order to perform
     OpenGL rendering, a context must be "made current" on the current
@@ -159,6 +160,7 @@ public abstract class GLContext {
   protected int ctxOptions;
   protected String ctxVersionString;
   private int currentSwapInterval;
+  protected GLRendererQuirks glRendererQuirks;
 
   protected void resetStates() {
       if (DEBUG) {
@@ -172,8 +174,31 @@ public abstract class GLContext {
       attachedObjects.clear();
       contextHandle=0;
       currentSwapInterval = -1;
+      glRendererQuirks = null;
   }
 
+  /** 
+   * Returns the instance of {@link GLRendererQuirks}, allowing one to determine workarounds.
+   * @return instance of {@link GLRendererQuirks} if context was made current once, otherwise <code>null</code>.
+   */
+  public final GLRendererQuirks getRendererQuirks() { return glRendererQuirks; }
+  
+  /**
+   * Returns true if the <code>quirk</code> exist in {@link #getRendererQuirks()}, otherwise false.
+   * <p>
+   * Convenience method for:
+   * <pre>
+   *    final GLRendererQuirks glrq = ctx.getRendererQuirks();
+   *    boolean hasQuirk = null != glrq ? glrq.exist(quirk) : false ;
+   * </pre>
+   * </p>
+   * @param quirk the quirk to be tested, e.g. {@link GLRendererQuirks#NoDoubleBufferedPBuffer}.
+   * @throws IllegalArgumentException if the quirk is out of range
+   */
+  public final boolean hasRendererQuirk(int quirk) throws IllegalArgumentException { 
+      return null != glRendererQuirks ? glRendererQuirks.exist(quirk) : false ; 
+  }
+  
   /**
    * Sets the read/write drawable for framebuffer operations.
    * <p>
@@ -464,6 +489,12 @@ public abstract class GLContext {
     sb.append(toHexString(contextHandle));
     sb.append(", ");
     sb.append(getGL());
+    sb.append(",\n\t quirks: ");
+    if(null != glRendererQuirks) {
+        glRendererQuirks.toString(sb);
+    } else {
+        sb.append("n/a");
+    }
     if(getGLDrawable()!=getGLReadDrawable()) {
         sb.append(",\n\tRead Drawable : ");
         sb.append(getGLReadDrawable());
@@ -473,8 +504,6 @@ public abstract class GLContext {
         sb.append(",\n\tDrawable: ");
         sb.append(getGLDrawable());
     }
-    sb.append(", lock ");
-    sb.append(lock.toString());
     return sb;
   }
 
@@ -666,13 +695,15 @@ public abstract class GLContext {
       if( hasFullFBOSupport() ) {
           final GL gl = getGL();
           final int[] val = new int[] { 0 } ;
-          gl.glGetIntegerv(GL2GL3.GL_MAX_SAMPLES, val, 0);
-          final int glerr = gl.glGetError();
-          if(GL.GL_NO_ERROR == glerr) {
-              return val[0];
-          } else if(DEBUG) {
-              System.err.println("GLContext.getMaxRenderbufferSamples: GL_MAX_SAMPLES query GL Error 0x"+Integer.toHexString(glerr));
-          }
+          try {
+              gl.glGetIntegerv(GL2GL3.GL_MAX_SAMPLES, val, 0);
+              final int glerr = gl.glGetError();
+              if(GL.GL_NO_ERROR == glerr) {
+                  return val[0];
+              } else if(DEBUG) {
+                  System.err.println("GLContext.getMaxRenderbufferSamples: GL_MAX_SAMPLES query GL Error 0x"+Integer.toHexString(glerr));
+              }
+          } catch (GLException gle) { gle.printStackTrace(); }
       }
       return 0;
   }
@@ -1369,6 +1400,6 @@ public abstract class GLContext {
   protected static String getThreadName() {
     return Thread.currentThread().getName();
   }
-
+  
 }
 
diff --git a/src/jogl/classes/javax/media/opengl/GLDrawableFactory.java b/src/jogl/classes/javax/media/opengl/GLDrawableFactory.java
index b6e7b0576..ae49eeeff 100644
--- a/src/jogl/classes/javax/media/opengl/GLDrawableFactory.java
+++ b/src/jogl/classes/javax/media/opengl/GLDrawableFactory.java
@@ -49,6 +49,7 @@ import com.jogamp.common.JogampRuntimeException;
 
 import com.jogamp.common.util.ReflectionUtil;
 import com.jogamp.opengl.GLAutoDrawableDelegate;
+import com.jogamp.opengl.GLRendererQuirks;
 
 import javax.media.nativewindow.AbstractGraphicsDevice;
 import javax.media.nativewindow.AbstractGraphicsScreen;
@@ -308,6 +309,42 @@ public abstract class GLDrawableFactory {
   protected abstract boolean createSharedResource(AbstractGraphicsDevice device);
   
   /**
+   * Returns true if the <code>quirk</code> exist in the shared resource's context {@link GLRendererQuirks}.
+   * <p>
+   * Convenience method for:
+   * <pre>
+      final GLRendererQuirks glrq = factory.getRendererQuirks(device);
+      return null != glrq ? glrq.exist(quirk) : false;
+   * </pre>
+   * </p>
+   * 
+   * @param device which {@link javax.media.nativewindow.AbstractGraphicsDevice#getConnection() connection} denotes the shared the target device, may be <code>null</code> for the platform's default device.
+   * @param quirk the quirk to be tested, e.g. {@link GLRendererQuirks#NoDoubleBufferedPBuffer}.
+   * @throws IllegalArgumentException if the quirk is out of range
+   * @see #getRendererQuirks()
+   * @see GLRendererQuirks
+   */
+  public final boolean hasRendererQuirk(AbstractGraphicsDevice device, int quirk) {
+      final GLRendererQuirks glrq = getRendererQuirks(device);
+      return null != glrq ? glrq.exist(quirk) : false;
+  }
+  
+  /**
+   * Returns the shared resource's context {@link GLRendererQuirks}.
+   * <p>
+   * Implementation calls {@link GLContext#getRendererQuirks()} on the shared resource context.
+   * </p>
+   * <p>
+   * In case no shared device exist yet or the implementation doesn't support tracking quirks,
+   * the result is always <code>null</code>.
+   * </p>
+   * @param device which {@link javax.media.nativewindow.AbstractGraphicsDevice#getConnection() connection} denotes the shared the target device, may be <code>null</code> for the platform's default device.
+   * @see GLContext#getRendererQuirks()
+   * @see GLRendererQuirks
+   */
+  public abstract GLRendererQuirks getRendererQuirks(AbstractGraphicsDevice device);
+  
+  /**
    * Returns the sole GLDrawableFactory instance for the desktop (X11, WGL, ..) if exist or null
    */
   public static GLDrawableFactory getDesktopFactory() {
diff --git a/src/jogl/classes/javax/media/opengl/GLProfile.java b/src/jogl/classes/javax/media/opengl/GLProfile.java
index 23d789afd..aabda465e 100644
--- a/src/jogl/classes/javax/media/opengl/GLProfile.java
+++ b/src/jogl/classes/javax/media/opengl/GLProfile.java
@@ -1445,10 +1445,6 @@ public class GLProfile {
             }
         } else {
             defaultDesktopDevice = desktopFactory.getDefaultDevice();
-            defaultDevice        = defaultDesktopDevice; 
-            if(DEBUG) {
-                System.err.println("Info: GLProfile.init - Default device is desktop derived: "+defaultDevice);
-            }
         }
 
         if ( !disableOpenGLES && ReflectionUtil.isClassAvailable("jogamp.opengl.egl.EGLDrawableFactory", classloader) ) {
@@ -1490,7 +1486,7 @@ public class GLProfile {
             }
         }
 
-        final AbstractGraphicsDevice defaultEGLDevice;        
+        final AbstractGraphicsDevice defaultEGLDevice;
         if(null == eglFactory) {
             hasGLES2Impl     = false;
             hasGLES1Impl     = false;
@@ -1499,25 +1495,33 @@ public class GLProfile {
                 System.err.println("Info: GLProfile.init - EGL GLDrawable factory not available");
             }
         } else {
-            defaultEGLDevice = eglFactory.getDefaultDevice();
-            if(null == defaultDevice) {
-                defaultDevice = defaultEGLDevice;
-                if(DEBUG) {
-                    System.err.println("Info: GLProfile.init - Default device is EGL derived: "+defaultDevice);
-                }
-            }
+            defaultEGLDevice = eglFactory.getDefaultDevice();            
         }
 
-        /** Should not be required .. but keep it here if simple probe on defaultDevice ain't enough. 
-        final boolean addedDesktopProfile = initProfilesForDevice(defaultDesktopDevice); 
-        final boolean addedEGLProfile     = initProfilesForDevice(defaultEGLDevice); 
-        final boolean addedAnyProfile =  addedDesktopProfile || addedEGLProfile ;
-         */
-        final boolean addedAnyProfile =  initProfilesForDevice(defaultDevice);
-
+        if( null != defaultDesktopDevice ) {
+            defaultDevice = defaultDesktopDevice;
+            if(DEBUG) {
+                System.err.println("Info: GLProfile.init - Default device is desktop derived: "+defaultDevice);
+            }            
+        } else if ( null != defaultEGLDevice ) {
+            defaultDevice = defaultEGLDevice;
+            if(DEBUG) {
+                System.err.println("Info: GLProfile.init - Default device is EGL derived: "+defaultDevice);
+            }
+        } else {
+            if(DEBUG) {
+                System.err.println("Info: GLProfile.init - Default device not available");
+            }
+            defaultDevice = null;
+        }
+                
+        // we require to initialize the EGL device 1st, if available
+        final boolean addedEGLProfile     = null != defaultEGLDevice     ? initProfilesForDevice(defaultEGLDevice)     : false;
+        final boolean addedDesktopProfile = null != defaultDesktopDevice ? initProfilesForDevice(defaultDesktopDevice) : false;        
+        final boolean addedAnyProfile     = addedEGLProfile || addedDesktopProfile ;
+            
         if(DEBUG) {
-            // System.err.println("GLProfile.init addedAnyProfile      "+addedAnyProfile+" (desktop: "+addedDesktopProfile+", egl "+addedEGLProfile+")");
-            System.err.println("GLProfile.init addedAnyProfile       "+addedAnyProfile);
+            System.err.println("GLProfile.init addedAnyProfile       "+addedAnyProfile+" (desktop: "+addedDesktopProfile+", egl "+addedEGLProfile+")");
             System.err.println("GLProfile.init isAWTAvailable        "+isAWTAvailable);
             System.err.println("GLProfile.init hasDesktopGLFactory   "+hasDesktopGLFactory);
             System.err.println("GLProfile.init hasGL234Impl          "+hasGL234Impl);