Bug 665: Allow re-association of GLContext/GLEventListener to a GLDrawable (Part 4)

Note:

  - GLEventListenerState preservs the GLAutoDrawable state,
    i.e. GLContext, all GLEventListener and the GLAnimatorControl association.

  - GLEventListenerState may be utilized to move the state from a dying GLAutoDrawable,
    to be moved to a new created GLAutoDrawable at a later time.

  - GLEventListenerState will be made public soon.

+++

Exessive unit tests cover the new feature, tested manually on GNU/Linux/X11 and OSX(Java6/Java7).

+++

- GLAutoDrawable
  - Change 'setContext(..)' to allow the destruction of the unbound old context:
      'setContext(GLContext newCtx)' -> 'setContext(GLContext newCtx, boolean destroyPrevCtx)'

  - Implementations: Properly implement 'setRealized(..)' incl. obeying threading constraints if exists.
    Method is being utilized at least for GLEventListenerState.moveTo(..)
    to unrealize and realize the drawable resources.

+++

Fix propagation of GLContext/GLDrawable association change (Bottom -> Top):

  GLDrawableImpl.associateContext
      GLContextImpl.associateDrawable
          GLContextImpl.makeCurrent
          GLContextImpl.destroy
          GLContext.setGLDrawable
              ...
              GLDrawableHelper.switchContext
                  GLAutoDrawble.setContext

associateDrawable(..)/associateContext(..) unifies and hence:
    - GLContextImpl.contextRealized() (removed)
    - GLDrawableImpl.contextRealized() (removed)
    - GLDrawableImpl.associateContext(..) (merged)
    - MacOSXCGLContext.drawableChangedNotify(..) (removed)

+++

- EGLUpstreamSurfaceHook.evalUpstreamSurface() validates the surface's device for reusage,
  which is valid in case of GLEventListenerState.moveTo(..)

- MacOSXCGLContext.NSOpenGLImpl: pixelFormat replaces NSOpenGLLayerPfmt and has simplified lifecycle [create..destroy],
  while native NSOpenGLLayer code only holds the reference until released.

1 files changed, 37 insertions, 22 deletions

diff --git a/src/jogl/classes/jogamp/opengl/GLContextImpl.java b/src/jogl/classes/jogamp/opengl/GLContextImpl.java
index 42364dbfd..4121e8f77 100644
--- a/src/jogl/classes/jogamp/opengl/GLContextImpl.java
+++ b/src/jogl/classes/jogamp/opengl/GLContextImpl.java
@@ -133,9 +133,6 @@ public abstract class GLContextImpl extends GLContext {
     GLContextShareSet.synchronizeBufferObjectSharing(shareWith, this);
 
     this.drawable = drawable;
-    if(null != drawable) {
-        drawable.associateContext(this, true);
-    }
     this.drawableRead = drawable;
 
     this.glDebugHandler = new GLDebugMessageHandler(this);
@@ -207,25 +204,36 @@ public abstract class GLContextImpl extends GLContext {
         return drawable; // no change.
     }
     final Thread currentThread = Thread.currentThread();
+    if( lock.isLockedByOtherThread() ) {
+        throw new GLException("GLContext current by other thread "+lock.getOwner().getName()+", operation not allowed on this thread "+currentThread.getName());
+    }    
     final boolean lockHeld = lock.isOwner(currentThread);
+    if( lockHeld && lock.getHoldCount() > 1 ) {
+        // would need to makeCurrent * holdCount
+        throw new GLException("GLContext is recursively locked - unsupported for setGLDrawable(..)");
+    }
+    final GLDrawableImpl old = drawable;
+    if( isCreated() && null != old && old.isRealized() ) {
+        if(!lockHeld) {
+            makeCurrent();
+        }
+        associateDrawable(false);
+        if(!lockHeld) {
+            release();
+        }
+    }
     if(lockHeld) {
         release();
-    } else if(lock.isLockedByOtherThread()) { // still could glitch ..
-        throw new GLException("GLContext current by other thread "+lock.getOwner().getName()+", operation not allowed on this thread "+currentThread.getName());
-    }    
+    }
     if( !setWriteOnly || drawableRead == drawable ) { // if !setWriteOnly || !explicitReadDrawable
         drawableRead = (GLDrawableImpl) readWrite;
     }
-    final GLDrawableImpl old = drawable;
-    if( null != old ) {
-        old.associateContext(this, false);
-    }
     drawableRetargeted |= null != drawable && readWrite != drawable;
     drawable = (GLDrawableImpl) readWrite ;
-    if( null != drawable ) {
-        drawable.associateContext(this, true);
-        if( lockHeld ) {
-            makeCurrent();
+    if( isCreated() && null != drawable && drawable.isRealized() ) {
+        makeCurrent(true); // implicit: associateDrawable(true)
+        if( !lockHeld ) {
+            release();
         }
     }
     return old;
@@ -363,8 +371,7 @@ public abstract class GLContextImpl extends GLContext {
                       makeCurrent();
                   }
                   try {
-                      contextRealized(false);
-                      drawable.associateContext(this, false);
+                      associateDrawable(false);
                   } catch (Throwable t) {
                       drawableContextRealizedException = t;
                   }
@@ -467,7 +474,11 @@ public abstract class GLContextImpl extends GLContext {
    * @see #destroyContextARBImpl
    */
   @Override
-  public int makeCurrent() throws GLException {
+  public final int makeCurrent() throws GLException {
+      return makeCurrent(false);
+  }
+  
+  protected final int makeCurrent(boolean forceDrawableAssociation) throws GLException {
     if( TRACE_SWITCH ) {
         System.err.println(getThreadName() +": GLContext.ContextSwitch[makeCurrent.0]: obj " + toHexString(hashCode()) + ", ctx "+toHexString(contextHandle)+", surf "+toHexString(drawable.getHandle())+" - "+lock);
     }      
@@ -561,7 +572,11 @@ public abstract class GLContextImpl extends GLContext {
             gl = gl.getContext().setGL( GLPipelineFactory.create("javax.media.opengl.Trace", null, gl, new Object[] { System.err } ) );
         }
         
-        contextRealized(true);        
+        forceDrawableAssociation = true;
+      }
+      
+      if( forceDrawableAssociation ) {
+          associateDrawable(true);
       }
       
       contextMadeCurrent(true);
@@ -662,14 +677,14 @@ public abstract class GLContextImpl extends GLContext {
   protected abstract void makeCurrentImpl() throws GLException;
 
   /**
-   * @see GLDrawableImpl#contextRealized(GLContext, boolean) 
+   * Calls {@link GLDrawableImpl#associateContext(GLContext, boolean)} 
    */ 
-  protected void contextRealized(boolean realized) {
-      drawable.contextRealized(this, realized);
+  protected void associateDrawable(boolean bound) { 
+      drawable.associateContext(this, bound);      
   }
   
   /**
-   * @see GLDrawableImpl#contextMadeCurrent(GLContext, boolean) 
+   * Calls {@link GLDrawableImpl#contextMadeCurrent(GLContext, boolean)} 
    */ 
   protected void contextMadeCurrent(boolean current) {
       drawable.contextMadeCurrent(this, current);