Add GLStateKeeper handling GLEventListenerState preservation and restauration for GLAutoDrawable

- New GLStateKeeper interface, package com.jogamp.opengl

  Implemented by:
    - GLAutoDrawableBase

  Currently supported by:
    - NEWT GLWindow

- GLEventListenerState package move:
   com.jogamp.opengl.util ->  com.jogamp.opengl

4 files changed, 140 insertions, 15 deletions

diff --git a/src/jogl/classes/com/jogamp/opengl/util/GLEventListenerState.java b/src/jogl/classes/com/jogamp/opengl/GLEventListenerState.java
index 5b02e1fec..5c0954584 100644
--- a/src/jogl/classes/com/jogamp/opengl/util/GLEventListenerState.java
+++ b/src/jogl/classes/com/jogamp/opengl/GLEventListenerState.java
@@ -25,7 +25,7 @@
  * authors and should not be interpreted as representing official policies, either expressed
  * or implied, of JogAmp Community.
  */
-package com.jogamp.opengl.util;
+package com.jogamp.opengl;
 
 import java.util.ArrayList;
 import java.util.List;
@@ -74,7 +74,7 @@ public class GLEventListenerState {
     private static final boolean DEBUG = Debug.debug("GLDrawable");
     
     private GLEventListenerState(AbstractGraphicsScreen upstreamScreen, boolean proxyOwnsUpstreamDevice, AbstractGraphicsScreen screen, GLCapabilitiesImmutable caps, 
-                                 GLContext context, int count, GLAnimatorControl anim) {
+                                 GLContext context, int count, GLAnimatorControl anim, boolean animStarted) {
         this.upstreamScreen = upstreamScreen;
         this.proxyOwnsUpstreamDevice = proxyOwnsUpstreamDevice;
         this.screen = screen;
@@ -83,6 +83,8 @@ public class GLEventListenerState {
         this.listeners = new GLEventListener[count];
         this.listenersInit = new boolean[count];
         this.anim = anim;
+        this.animStarted = animStarted;
+        
         this.owner = true;
     }
     /**
@@ -105,6 +107,7 @@ public class GLEventListenerState {
     public final GLEventListener[] listeners;
     public final boolean[] listenersInit;    
     public final GLAnimatorControl anim;
+    public final boolean animStarted;
     
     private boolean owner;
 
@@ -191,12 +194,16 @@ public class GLEventListenerState {
             aUpScreen2=_aUpScreen2;
         }
         
-        final GLAnimatorControl aAnim = a.getAnimator();    
+        final GLAnimatorControl aAnim = a.getAnimator();
+        final boolean aAnimStarted;
         if( null != aAnim ) {
+            aAnimStarted = aAnim.isStarted();
             aAnim.remove(a); // also handles ECT
+        } else {        
+            aAnimStarted = false;
         }
         
-        final GLEventListenerState glls = new GLEventListenerState(aUpScreen2, proxyOwnsUpstreamDevice, aScreen2, caps, a.getContext(), aSz, aAnim); 
+        final GLEventListenerState glls = new GLEventListenerState(aUpScreen2, proxyOwnsUpstreamDevice, aScreen2, caps, a.getContext(), aSz, aAnim, aAnimStarted); 
 
         //
         // remove and cache all GLEventListener and their init-state
@@ -332,6 +339,9 @@ public class GLEventListenerState {
         
         if( null != anim && null == a.getAnimator() ) {
             anim.add(a); // also handles ECT
+            if(animStarted) {
+                anim.start();
+            }
         }
     }
 
diff --git a/src/jogl/classes/com/jogamp/opengl/GLStateKeeper.java b/src/jogl/classes/com/jogamp/opengl/GLStateKeeper.java
new file mode 100644
index 000000000..410907bee
--- /dev/null
+++ b/src/jogl/classes/com/jogamp/opengl/GLStateKeeper.java
@@ -0,0 +1,87 @@
+/**
+ * Copyright 2013 JogAmp Community. All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without modification, are
+ * permitted provided that the following conditions are met:
+ * 
+ *    1. Redistributions of source code must retain the above copyright notice, this list of
+ *       conditions and the following disclaimer.
+ * 
+ *    2. Redistributions 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.
+ * 
+ * THIS SOFTWARE IS PROVIDED BY JogAmp Community ``AS IS'' AND ANY EXPRESS OR IMPLIED
+ * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
+ * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL JogAmp Community OR
+ * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+ * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
+ * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ * 
+ * The views and conclusions contained in the software and documentation are those of the
+ * authors and should not be interpreted as representing official policies, either expressed
+ * or implied, of JogAmp Community.
+ */
+package com.jogamp.opengl;
+
+/**
+ * Interface adding a {@link GLEventListenerState} protocol to {@link GLAutoDrawable}s
+ * or other self-contained compound types combining {@link GLDrawable}, {@link GLContext} and {@link GLEventListener}.
+ * <p>
+ * Implementing classes {@link #isGLStatePreservationSupported() may support} preservation 
+ * of the {@link GLContext} state and it's associated {@link GLEventListener}. 
+ * </p> 
+ */
+public interface GLStateKeeper {
+    
+    /** Listener for preserve and restore notifications. */
+    public static interface Listener {
+        /** Invoked before preservation. */
+        void glStatePreserveNotify(GLStateKeeper glsk);
+        /** Invoked after restoration. */
+        void glStateRestored(GLStateKeeper glsk);
+    }
+    
+    /** 
+     * Sets a {@link Listener}, overriding the old one.
+     * @param l the new {@link Listener}.
+     * @return the previous {@link Listener}.
+     */
+    public Listener setGLStateKeeperListener(Listener l);
+    
+    /**
+     * @return <code>true</code> if GL state preservation is supported in implementation and on current platform, <code>false</code> otherwise.
+     * @see #preserveGLStateAtDestroy(boolean)
+     * @see #getPreservedGLState()
+     */
+    public boolean isGLStatePreservationSupported();
+    
+    /**
+     * If set to <code>true</code>, the next {@link GLAutoDrawable#destroy()} operation will
+     * {@link #pullGLEventListenerState() pull} to preserve the {@link GLEventListenerState}.
+     * <p>
+     * This is a one-shot flag, i.e. after preserving the {@link GLEventListenerState},
+     * the flag is cleared.
+     * </p>
+     * <p>
+     * A preserved {@link GLEventListenerState} will be {@link #pushGLEventListenerState() pushed} 
+     * if realized again. 
+     * </p>
+     * @return <code>true</code> if supported and successful, <code>false</code> otherwise.
+     * @see #isGLStatePreservationSupported()
+     * @see #getPreservedGLState()
+     */
+    public boolean preserveGLStateAtDestroy(boolean value);
+    
+    /**
+     * Returns the preserved {@link GLEventListenerState} if preservation was performed,
+     * otherwise <code>null</code>. 
+     * @see #isGLStatePreservationSupported()
+     * @see #preserveGLStateAtDestroy(boolean)
+     */
+    public GLEventListenerState getPreservedGLState();
+
+}
diff --git a/src/jogl/classes/com/jogamp/opengl/util/GLDrawableUtil.java b/src/jogl/classes/com/jogamp/opengl/util/GLDrawableUtil.java
index 1d68a402a..68d94d2e2 100644
--- a/src/jogl/classes/com/jogamp/opengl/util/GLDrawableUtil.java
+++ b/src/jogl/classes/com/jogamp/opengl/util/GLDrawableUtil.java
@@ -33,6 +33,8 @@ import javax.media.opengl.GLContext;
 import javax.media.opengl.GLDrawable;
 import javax.media.opengl.GLEventListener;
 
+import com.jogamp.opengl.GLEventListenerState;
+
 import jogamp.opengl.Debug;
 
 /**
diff --git a/src/jogl/classes/jogamp/opengl/GLAutoDrawableBase.java b/src/jogl/classes/jogamp/opengl/GLAutoDrawableBase.java
index 592607819..2f405a8c6 100644
--- a/src/jogl/classes/jogamp/opengl/GLAutoDrawableBase.java
+++ b/src/jogl/classes/jogamp/opengl/GLAutoDrawableBase.java
@@ -50,7 +50,8 @@ import javax.media.opengl.GLRunnable;
 
 import com.jogamp.common.util.locks.RecursiveLock;
 import com.jogamp.opengl.GLAutoDrawableDelegate;
-import com.jogamp.opengl.util.GLEventListenerState;
+import com.jogamp.opengl.GLEventListenerState;
+import com.jogamp.opengl.GLStateKeeper;
 
 
 /**
@@ -61,7 +62,7 @@ import com.jogamp.opengl.util.GLEventListenerState;
  * @see GLPBufferImpl
  * @see GLWindow
  */
-public abstract class GLAutoDrawableBase implements GLAutoDrawable, FPSCounter {
+public abstract class GLAutoDrawableBase implements GLAutoDrawable, GLStateKeeper, FPSCounter {
     public static final boolean DEBUG = GLDrawableImpl.DEBUG;
     
     protected final GLDrawableHelper helper = new GLDrawableHelper();
@@ -71,6 +72,7 @@ public abstract class GLAutoDrawableBase implements GLAutoDrawable, FPSCounter {
     protected GLContextImpl context;
     protected boolean preserveGLELSAtDestroy;
     protected GLEventListenerState glels;
+    protected GLStateKeeper.Listener glStateKeeperListener;
     protected final boolean ownsDevice;
     protected int additionalCtxCreationFlags = 0;
     protected volatile boolean sendReshape = false; // volatile: maybe written by WindowManager thread w/o locking
@@ -93,6 +95,7 @@ public abstract class GLAutoDrawableBase implements GLAutoDrawable, FPSCounter {
         this.context = context;
         this.preserveGLELSAtDestroy = false;
         this.glels = null;
+        this.glStateKeeperListener = null;
         this.ownsDevice = ownsDevice;
         if(null != context && null != drawable) {
             context.setGLDrawable(drawable, false);
@@ -103,18 +106,35 @@ public abstract class GLAutoDrawableBase implements GLAutoDrawable, FPSCounter {
     /** Returns the recursive lock object of the upstream implementation, which synchronizes multithreaded access. */ 
     protected abstract RecursiveLock getLock();
 
+    @Override
+    public final GLStateKeeper.Listener setGLStateKeeperListener(Listener l) {
+        final GLStateKeeper.Listener pre = glStateKeeperListener;
+        glStateKeeperListener = l;
+        return pre;        
+    }
     
-    /**
-     * If set to <code>true</code>, the next {@link #destroy()} operation will 
-     * {@link #pullGLEventListenerState() pull} to preserve the {@link GLEventListenerState}.
-     */
-    public final void setPreserveGLStateAtDestroy(boolean value) {
-        if( DEBUG ) {
-            System.err.println("GLAutoDrawableBase.setPreserveGLStateAtDestroy: ("+Thread.currentThread().getName()+"): "+preserveGLELSAtDestroy+" -> "+value+" - surfaceHandle 0x"+Long.toHexString(getNativeSurface().getSurfaceHandle()));
+    @Override
+    public final boolean preserveGLStateAtDestroy(boolean value) {
+        final boolean res = isGLStatePreservationSupported() ? true : false;
+        if( res ) {
+            if( DEBUG ) {
+                System.err.println("GLAutoDrawableBase.setPreserveGLStateAtDestroy: ("+Thread.currentThread().getName()+"): "+preserveGLELSAtDestroy+" -> "+value+" - surfaceHandle 0x"+Long.toHexString(getNativeSurface().getSurfaceHandle()));
+            }
+            preserveGLELSAtDestroy = value;
+        } else {
+            
         }
-        preserveGLELSAtDestroy = value;
+        return res;
     }
     
+    @Override
+    public boolean isGLStatePreservationSupported() { return false; }
+    
+    @Override
+    public final GLEventListenerState getPreservedGLState() {
+        return glels;
+    }
+
     /**
      * Pulls the {@link GLEventListenerState} from this {@link GLAutoDrawable}.
      * 
@@ -130,6 +150,9 @@ public abstract class GLAutoDrawableBase implements GLAutoDrawable, FPSCounter {
             throw new IllegalStateException("GLEventListenerState already pulled");            
         }
         if( null != context && context.isCreated() ) {
+            if( null!= glStateKeeperListener) {
+                glStateKeeperListener.glStatePreserveNotify(this);
+            }
             glels = GLEventListenerState.moveFrom(this);
             return null != glels;
         }
@@ -149,6 +172,9 @@ public abstract class GLAutoDrawableBase implements GLAutoDrawable, FPSCounter {
         if( null != glels ) {
             glels.moveTo(this);
             glels = null;
+            if( null!= glStateKeeperListener) {
+                glStateKeeperListener.glStateRestored(this);
+            }            
             return true;
         }
         return false;        
@@ -286,7 +312,7 @@ public abstract class GLAutoDrawableBase implements GLAutoDrawable, FPSCounter {
      */
     protected void destroyImplInLock() {
         if( preserveGLELSAtDestroy ) {
-            setPreserveGLStateAtDestroy(false);
+            preserveGLStateAtDestroy(false);
             pullGLEventListenerState();
         }
         if( null != context ) {