GLEventListenerState: Moved to public package 'com.jogamp.opengl.util'

2 files changed, 365 insertions, 1 deletions

diff --git a/src/jogl/classes/com/jogamp/opengl/util/GLDrawableUtil.java b/src/jogl/classes/com/jogamp/opengl/util/GLDrawableUtil.java
index 83414ddb0..1d68a402a 100644
--- a/src/jogl/classes/com/jogamp/opengl/util/GLDrawableUtil.java
+++ b/src/jogl/classes/com/jogamp/opengl/util/GLDrawableUtil.java
@@ -34,7 +34,6 @@ import javax.media.opengl.GLDrawable;
 import javax.media.opengl.GLEventListener;
 
 import jogamp.opengl.Debug;
-import jogamp.opengl.GLEventListenerState;
 
 /**
  * Providing utility functions dealing w/ {@link GLDrawable}s, {@link GLAutoDrawable} and their {@link GLEventListener}.
diff --git a/src/jogl/classes/com/jogamp/opengl/util/GLEventListenerState.java b/src/jogl/classes/com/jogamp/opengl/util/GLEventListenerState.java
new file mode 100644
index 000000000..ff250d27f
--- /dev/null
+++ b/src/jogl/classes/com/jogamp/opengl/util/GLEventListenerState.java
@@ -0,0 +1,365 @@
+/**
+ * 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.util;
+
+import java.util.ArrayList;
+import java.util.List;
+
+import javax.media.nativewindow.AbstractGraphicsConfiguration;
+import javax.media.nativewindow.AbstractGraphicsDevice;
+import javax.media.nativewindow.AbstractGraphicsScreen;
+import javax.media.nativewindow.NativeSurface;
+import javax.media.nativewindow.NativeWindowFactory;
+import javax.media.nativewindow.ProxySurface;
+import javax.media.nativewindow.VisualIDHolder;
+import javax.media.opengl.GLAnimatorControl;
+import javax.media.opengl.GLAutoDrawable;
+import javax.media.opengl.GLCapabilitiesImmutable;
+import javax.media.opengl.GLContext;
+import javax.media.opengl.GLEventListener;
+import javax.media.opengl.GLException;
+import javax.media.opengl.GLRunnable;
+
+import jogamp.opengl.Debug;
+
+import com.jogamp.nativewindow.MutableGraphicsConfiguration;
+
+/**
+ * GLEventListenerState is holding {@link GLAutoDrawable} components crucial 
+ * to relocating all its {@link GLEventListener} w/ their operating {@link GLContext}, etc.
+ * The components are:
+ * <ul>
+ *   <li>{@link GLContext}</li>
+ *   <li>All {@link GLEventListener}, incl. their init state</li>
+ *   <li>{@link GLAnimatorControl}</li>
+ *   <li>{@link GLCapabilitiesImmutable} for compatibility check</li>
+ *   <li>{@link AbstractGraphicsScreen} for compatibility check and preserving the {@link AbstractGraphicsDevice}</li>
+ * </ul>
+ * <p>
+ * A GLEventListenerState instance can be created while components are {@link #moveFrom(GLAutoDrawable) moved from} a {@link GLAutoDrawable}
+ * to the new instance, which gains {@link #isOwner() ownership} of the moved components.
+ * </p>
+ * <p>
+ * A GLEventListenerState instance's components can be {@link #moveTo(GLAutoDrawable) moved to} a {@link GLAutoDrawable},
+ * while loosing {@link #isOwner() ownership} of the moved components.
+ * </p>
+ * <p>
+ */
+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) {
+        this.upstreamScreen = upstreamScreen;
+        this.proxyOwnsUpstreamDevice = proxyOwnsUpstreamDevice;
+        this.screen = screen;
+        this.caps = caps;
+        this.context = context;
+        this.listeners = new GLEventListener[count];
+        this.listenersInit = new boolean[count];
+        this.anim = anim;
+        this.owner = true;
+    }
+    /**
+     * Returns <code>true</code>, if this instance is the current owner of the components, 
+     * otherwise <code>false</code>.
+     * <p>
+     * Ownership is lost if {@link #moveTo(GLAutoDrawable)} is being called successfully
+     * and all components are transferred to the new {@link GLAutoDrawable}. 
+     * </p>
+     */
+    public final boolean isOwner() { return owner; }
+    
+    public final int listenerCount() { return listeners.length; }
+
+    public final AbstractGraphicsScreen upstreamScreen;
+    public final boolean proxyOwnsUpstreamDevice;
+    public final AbstractGraphicsScreen screen;
+    public final GLCapabilitiesImmutable caps;
+    public final GLContext context;
+    public final GLEventListener[] listeners;
+    public final boolean[] listenersInit;    
+    public final GLAnimatorControl anim;
+    
+    private boolean owner;
+
+    /**
+     * Last resort to destroy and loose ownership
+     */
+    public void destroy() {
+        if( owner ) {
+            final int aSz = listenerCount();
+            for(int i=0; i<aSz; i++) {
+                listeners[i] = null;
+            }
+            // context.destroy(); - NPE (null drawable)
+            screen.getDevice().close();
+            owner = false;
+        }
+    }
+
+    private static AbstractGraphicsScreen cloneScreen(AbstractGraphicsScreen aScreen) {
+        final AbstractGraphicsDevice aDevice2 = (AbstractGraphicsDevice) aScreen.getDevice().clone();
+        return NativeWindowFactory.createScreen( aDevice2, aScreen.getIndex() );        
+    }
+    
+    /**
+     * Moves all GLEventListenerState components from the given {@link GLAutoDrawable} 
+     * to a newly created instance.
+     * <p>
+     * Note that all components are removed from the {@link GLAutoDrawable},
+     * i.e. the {@link GLContext}, all {@link GLEventListener}.
+     * </p>
+     * <p> 
+     * If the {@link GLAutoDrawable} was added to a {@link GLAnimatorControl}, it is removed
+     * and the {@link GLAnimatorControl} added to the GLEventListenerState.
+     * </p>
+     * <p>
+     * The returned GLEventListenerState instance is the {@link #isOwner() owner of the components}. 
+     * </p>
+     * 
+     * @param a {@link GLAutoDrawable} source to move components from
+     * @return new GLEventListenerState instance {@link #isOwner() owning} moved components.
+     * 
+     * @see #moveTo(GLAutoDrawable)
+     */
+    public static GLEventListenerState moveFrom(GLAutoDrawable a) {
+        final int aSz = a.getGLEventListenerCount();
+
+        // Create new AbstractGraphicsScreen w/ cloned AbstractGraphicsDevice for future GLAutoDrawable
+        // allowing this AbstractGraphicsDevice to loose ownership -> not closing display/device!
+        final NativeSurface aSurface = a.getNativeSurface();
+        final AbstractGraphicsConfiguration aCfg = aSurface.getGraphicsConfiguration();
+        final AbstractGraphicsScreen aScreen1 = aCfg.getScreen();
+        final GLCapabilitiesImmutable caps = (GLCapabilitiesImmutable) aCfg.getChosenCapabilities();
+        final AbstractGraphicsScreen aScreen2 = cloneScreen(aScreen1);
+        if( DEBUG ) {
+            System.err.println("X00 NativeSurface:              "+aSurface.getClass().getName()+", "+aSurface);
+        }
+        aScreen1.getDevice().clearHandleOwner();  // don't close device handle
+
+        final AbstractGraphicsScreen aUpScreen2;
+        final boolean proxyOwnsUpstreamDevice;
+        {
+            AbstractGraphicsScreen _aUpScreen2=null;
+            if(aSurface instanceof ProxySurface) {
+                final ProxySurface aProxy = (ProxySurface)aSurface;
+                proxyOwnsUpstreamDevice = aProxy.containsUpstreamOptionBits( ProxySurface.OPT_PROXY_OWNS_UPSTREAM_DEVICE );
+                final NativeSurface aUpSurface = aProxy.getUpstreamSurface();
+                if(DEBUG && null != aUpSurface) {
+                    System.err.println("X00 UpstreamSurface:            "+aUpSurface.getClass().getName()+", "+aUpSurface);
+                }
+                if(null != aUpSurface) {
+                    final AbstractGraphicsScreen aUpScreen1 = aUpSurface.getGraphicsConfiguration().getScreen();
+                    _aUpScreen2 = cloneScreen(aUpScreen1);
+                    if(null != aUpScreen1) {
+                        aUpScreen1.getDevice().clearHandleOwner(); // don't close device handle
+                    }
+                    if(DEBUG) {
+                        System.err.println("X0X NativeSurface:              "+aSurface.getClass().getName()+", "+aSurface);
+                        System.err.println("X0X UpstreamSurface:            "+aUpSurface.getClass().getName()+", "+aUpSurface);
+                    }
+                }
+            } else {
+                proxyOwnsUpstreamDevice = false;
+            }
+            aUpScreen2=_aUpScreen2;
+        }
+        
+        final GLAnimatorControl aAnim = a.getAnimator();    
+        if( null != aAnim ) {
+            aAnim.remove(a); // also handles ECT
+        }
+        
+        final GLEventListenerState glls = new GLEventListenerState(aUpScreen2, proxyOwnsUpstreamDevice, aScreen2, caps, a.getContext(), aSz, aAnim); 
+
+        //
+        // remove and cache all GLEventListener and their init-state
+        //
+        for(int i=0; i<aSz; i++) {
+            final GLEventListener l = a.getGLEventListener(0);
+            glls.listenersInit[i] = a.getGLEventListenerInitState(l);
+            glls.listeners[i] = a.removeGLEventListener( l );
+        }    
+
+        //
+        // trigger glFinish to sync GL ctx
+        //
+        a.invoke(true, glFinish);
+
+        a.setContext( null, false );
+        
+        return glls;
+    }
+
+    /**
+     * Moves all GLEventListenerState components to the given {@link GLAutoDrawable} 
+     * from this instance, while loosing {@link #isOwner() ownership}.
+     * <p> 
+     * If the previous {@link GLAutoDrawable} was removed from a {@link GLAnimatorControl} by previous {@link #moveFrom(GLAutoDrawable)},
+     * the given {@link GLAutoDrawable} is added to the cached {@link GLAnimatorControl}.
+     * This operation is skipped, if the given {@link GLAutoDrawable} is already added to a {@link GLAnimatorControl} instance.  
+     * </p>
+     * <p>
+     * Note: After this operation, the GLEventListenerState reference should be released. 
+     * </p>
+     * 
+     * @param a {@link GLAutoDrawable} destination to move GLEventListenerState components to
+     * 
+     * @throws GLException if the {@link GLAutoDrawable}'s configuration is incompatible, i.e. different {@link GLCapabilitiesImmutable}.
+     * 
+     * @see #moveFrom(GLAutoDrawable)
+     * @see #isOwner()
+     */
+    public final void moveTo(GLAutoDrawable a) {
+        final List<GLRunnable> aGLCmds = new ArrayList<GLRunnable>();
+        final int aSz = listenerCount();
+        
+        final NativeSurface aSurface = a.getNativeSurface();
+        final MutableGraphicsConfiguration aCfg = (MutableGraphicsConfiguration) aSurface.getGraphicsConfiguration();
+        final GLCapabilitiesImmutable aCaps = (GLCapabilitiesImmutable) aCfg.getChosenCapabilities();
+        if( caps.getVisualID(VisualIDHolder.VIDType.INTRINSIC) != aCaps.getVisualID(VisualIDHolder.VIDType.INTRINSIC) || 
+            caps.getVisualID(VisualIDHolder.VIDType.NATIVE) != aCaps.getVisualID(VisualIDHolder.VIDType.NATIVE) ) {
+            throw new GLException("Incompatible Capabilities - Prev-Holder: "+caps+", New-Holder "+caps);
+        }
+        // Destroy and remove currently associated GLContext, if any (will be replaced)
+        a.setContext( null, true );
+        final boolean aRealized = a.isRealized();
+        if( aRealized ) {
+            a.setRealized(false);
+        }
+        // Set new Screen and close previous one
+        {
+            if( DEBUG ) {
+                System.err.println("XX0 NativeSurface:              "+aSurface.getClass().getName()+", "+aSurface);
+            }
+            final AbstractGraphicsScreen aScreen1 = aCfg.getScreen();
+            aCfg.setScreen( screen );
+            aScreen1.getDevice().close();
+            if( DEBUG ) {
+                System.err.println("XXX NativeSurface:              "+aSurface.getClass().getName()+", "+aSurface);
+            }
+        }
+        
+        // If using a ProxySurface w/ an upstream surface, set new Screen and close previous one on it
+        {
+            boolean upstreamSet = false;
+            if(aSurface instanceof ProxySurface) {
+                final ProxySurface aProxy = (ProxySurface)aSurface;
+                final NativeSurface aUpSurface = aProxy.getUpstreamSurface();            
+                if(null != aUpSurface) {
+                    final MutableGraphicsConfiguration aUpCfg = (MutableGraphicsConfiguration) aUpSurface.getGraphicsConfiguration();
+                    if( null != upstreamScreen ) {
+                        if( DEBUG ) {
+                            System.err.println("XX0 UpstreamSurface:            "+aUpSurface.getClass().getName()+", "+aUpSurface+", "+aProxy.getUpstreamOptionBits(null).toString());
+                        }
+                        aUpCfg.getScreen().getDevice().close();
+                        aUpCfg.setScreen( upstreamScreen );
+                        if( proxyOwnsUpstreamDevice ) {
+                            aProxy.addUpstreamOptionBits( ProxySurface.OPT_PROXY_OWNS_UPSTREAM_DEVICE );
+                        }
+                        upstreamSet = true;
+                        if( DEBUG ) {
+                            System.err.println("XXX UpstreamSurface:            "+aUpSurface.getClass().getName()+", "+aUpSurface+", "+aProxy.getUpstreamOptionBits(null).toString());
+                        }
+                    } else {
+                        throw new GLException("Incompatible Surface config - Has Upstream-Surface: Prev-Holder = false, New-Holder = true");
+                    }
+                }
+            }
+            if( !upstreamSet && null != upstreamScreen ) {
+                throw new GLException("Incompatible Surface config - Has Upstream-Surface: Prev-Holder = true, New-Holder = false");
+            }
+        }
+        
+        if( aRealized ) {
+            a.setRealized(true);
+        }
+        final boolean surfaceLocked = false; // NativeSurface.LOCK_SURFACE_NOT_READY < aSurface.lockSurface();
+        try {
+            a.setContext( context, false );
+        } finally {
+            if( surfaceLocked ) {
+                aSurface.unlockSurface();
+            }
+        }
+        owner = false;
+        
+        //
+        // Trigger GL-Viewport reset and reshape of all initialized GLEventListeners
+        //
+        aGLCmds.add(setViewport);
+        for(int i=0; i<aSz; i++) {
+            if( listenersInit[i] ) {
+                aGLCmds.add(new ReshapeGLEventListener( listeners[i] ) );
+            }
+        }
+        aGLCmds.add(glFinish);
+        a.invoke(aRealized, aGLCmds); // only wait if already realized
+
+        // add all cached GLEventListener to their destination and fix their init-state
+        for(int i=0; i<aSz; i++) {
+            final GLEventListener l = listeners[i];
+            a.addGLEventListener( l );
+            a.setGLEventListenerInitState(l, listenersInit[i]);
+            listeners[i] = null;
+        }
+        
+        if( null != anim && null == a.getAnimator() ) {
+            anim.add(a); // also handles ECT
+        }
+    }
+
+    public static GLRunnable setViewport = new GLRunnable() {
+        @Override
+        public boolean run(GLAutoDrawable drawable) {
+            drawable.getGL().glViewport(0, 0, drawable.getWidth(), drawable.getHeight());
+            return true;
+        }            
+    };
+
+    public static GLRunnable glFinish = new GLRunnable() {
+        @Override
+        public boolean run(GLAutoDrawable drawable) {
+            drawable.getGL().glFinish();
+            return true;
+        }            
+    };
+
+    public static class ReshapeGLEventListener implements GLRunnable {
+        private GLEventListener listener;
+        public ReshapeGLEventListener(GLEventListener listener) {
+            this.listener = listener;
+        }
+        @Override
+        public boolean run(GLAutoDrawable drawable) {
+            listener.reshape(drawable, 0, 0, drawable.getWidth(), drawable.getHeight());
+            return true;
+        }      
+    }
+}