JOGL/NativeWindow: Push down JOGL's X11AWTGLXGraphicsConfigurationFactory to NativeWindow X11AWTGraphicsConfigurationFactory

X11AWTGraphicsConfigurationFactory properly construct a AWTGraphicsConfiguration
encapsulated a native X11GraphicsConfiguration, now available for non JOGL modules, ie NEWT.

AWTGraphicsConfiguration's create() utilizes the X11AWTGraphicsConfigurationFactory
via the generic factory mechanism and hence allows encapsulating a native [X11]GraphicsConfiguration.

NewtCanvasAWT creates/destroys the JAWT NativeWindow on addNotify/removeNotify (reparentWindow) again.
Hence the JAWTWindow is instantiated completly only, instead of utilizing updateConfiguration(..),
which simplifies the mechanism.

4 files changed, 214 insertions, 55 deletions

diff --git a/src/nativewindow/classes/javax/media/nativewindow/GraphicsConfigurationFactory.java b/src/nativewindow/classes/javax/media/nativewindow/GraphicsConfigurationFactory.java
index 3f8746e2a..259644467 100644
--- a/src/nativewindow/classes/javax/media/nativewindow/GraphicsConfigurationFactory.java
+++ b/src/nativewindow/classes/javax/media/nativewindow/GraphicsConfigurationFactory.java
@@ -40,7 +40,6 @@ import java.util.Collections;
 import java.util.HashMap;
 import java.util.Map;
 
-
 /**
  * Provides the mechanism by which the graphics configuration for a
  * window can be chosen before the window is created. The graphics 
@@ -81,10 +80,12 @@ public abstract class GraphicsConfigurationFactory {
             } catch (Exception e) {
                 throw new RuntimeException(e);
             }
-            try {
-                ReflectionUtil.callStaticMethod("jogamp.nativewindow.x11.awt.X11AWTGraphicsConfigurationFactory", 
-                                                "registerFactory", null, null, GraphicsConfigurationFactory.class.getClassLoader());                
-            } catch (Exception e) { /* n/a */ }
+            if(NativeWindowFactory.isAWTAvailable()) {
+                try {
+                    ReflectionUtil.callStaticMethod("jogamp.nativewindow.x11.awt.X11AWTGraphicsConfigurationFactory", 
+                                                    "registerFactory", null, null, GraphicsConfigurationFactory.class.getClassLoader());                
+                } catch (Exception e) { /* n/a */ }
+            }
         }
     }
 
diff --git a/src/nativewindow/classes/javax/media/nativewindow/NativeSurface.java b/src/nativewindow/classes/javax/media/nativewindow/NativeSurface.java
index d0b586f59..e255dc051 100644
--- a/src/nativewindow/classes/javax/media/nativewindow/NativeSurface.java
+++ b/src/nativewindow/classes/javax/media/nativewindow/NativeSurface.java
@@ -169,7 +169,7 @@ public interface NativeSurface extends SurfaceUpdatedListener {
    * Returns the graphics configuration corresponding to this window.
    * <p>
    * In case the implementation utilizes a delegation pattern to wrap abstract toolkits,
-   * this method shall return the native {@link AbstractGraphicsConfiguration}.
+   * this method shall return the native {@link AbstractGraphicsConfiguration} via {@link AbstractGraphicsConfiguration#getNativeGraphicsConfiguration()}.
    * </p>
    * @see AbstractGraphicsConfiguration#getNativeGraphicsConfiguration()
    * @see javax.media.nativewindow.GraphicsConfigurationFactory#chooseGraphicsConfiguration(Capabilities, CapabilitiesChooser, AbstractGraphicsScreen)
diff --git a/src/nativewindow/classes/javax/media/nativewindow/awt/AWTGraphicsConfiguration.java b/src/nativewindow/classes/javax/media/nativewindow/awt/AWTGraphicsConfiguration.java
index 012c952f1..45a3db838 100644
--- a/src/nativewindow/classes/javax/media/nativewindow/awt/AWTGraphicsConfiguration.java
+++ b/src/nativewindow/classes/javax/media/nativewindow/awt/AWTGraphicsConfiguration.java
@@ -47,6 +47,7 @@ import java.awt.GraphicsConfiguration;
 import java.awt.GraphicsDevice;
 import java.awt.image.ColorModel;
 import javax.media.nativewindow.AbstractGraphicsConfiguration;
+
 import jogamp.nativewindow.Debug;
 
 /** A wrapper for an AWT GraphicsConfiguration allowing it to be
@@ -70,67 +71,39 @@ public class AWTGraphicsConfiguration extends DefaultGraphicsConfiguration imple
     this.config = config;
     this.encapsulated=null;
   }
-
+  
   /**
    * @param capsChosen if null, <code>capsRequested</code> is copied and aligned 
-   *        with the graphics capabilties of the AWT Component to produce the chosen Capabilties.
+   *        with the graphics Capabilities of the AWT Component to produce the chosen Capabilities.
    *        Otherwise the <code>capsChosen</code> is used.
    */
-  public static AWTGraphicsConfiguration create(Component awtComp, CapabilitiesImmutable capsChosen, CapabilitiesImmutable capsRequested)
-  {
-      AWTGraphicsScreen awtScreen = null;
-      AWTGraphicsDevice awtDevice = null;
-      GraphicsDevice awtGraphicsDevice = null;
-      GraphicsConfiguration awtGfxConfig = awtComp.getGraphicsConfiguration();
-      if(null!=awtGfxConfig) {
-          awtGraphicsDevice = awtGfxConfig.getDevice();
-          if(null!=awtGraphicsDevice) {
-              // Create Device/Screen
-              awtDevice = new AWTGraphicsDevice(awtGraphicsDevice, AbstractGraphicsDevice.DEFAULT_UNIT);
-              awtScreen = new AWTGraphicsScreen(awtDevice);
-          }
+  public static AWTGraphicsConfiguration create(Component awtComp, CapabilitiesImmutable capsChosen, CapabilitiesImmutable capsRequested) {
+      final GraphicsConfiguration awtGfxConfig = awtComp.getGraphicsConfiguration();
+      if(null==awtGfxConfig) {
+          throw new NativeWindowException("AWTGraphicsConfiguration.create: Null AWT GraphicsConfiguration @ "+awtComp);          
       }
-      if(null==awtScreen) {
-          // use defaults since no native peer is available yet
-          awtScreen = (AWTGraphicsScreen) AWTGraphicsScreen.createScreenDevice(-1, AbstractGraphicsDevice.DEFAULT_UNIT);
-          awtDevice = (AWTGraphicsDevice) awtScreen.getDevice();
-          awtGraphicsDevice = awtDevice.getGraphicsDevice();
+      final GraphicsDevice awtGraphicsDevice = awtGfxConfig.getDevice();
+      if(null==awtGraphicsDevice) {
+          throw new NativeWindowException("AWTGraphicsConfiguration.create: Null AWT GraphicsDevice @ "+awtGfxConfig);
       }
 
+      // Create Device/Screen
+      final AWTGraphicsDevice awtDevice = new AWTGraphicsDevice(awtGraphicsDevice, AbstractGraphicsDevice.DEFAULT_UNIT);
+      final AWTGraphicsScreen awtScreen = new AWTGraphicsScreen(awtDevice);
+
       if(null==capsChosen) {
           GraphicsConfiguration gc = awtGraphicsDevice.getDefaultConfiguration();
-          capsChosen = setupCapabilitiesRGBABits(capsRequested, gc);
+          capsChosen = AWTGraphicsConfiguration.setupCapabilitiesRGBABits(capsRequested, gc);
+      }
+      final GraphicsConfigurationFactory factory = GraphicsConfigurationFactory.getFactory(awtDevice);
+      final AbstractGraphicsConfiguration config = factory.chooseGraphicsConfiguration(capsChosen, capsRequested, null, awtScreen);
+      if(config instanceof AWTGraphicsConfiguration) {
+          return (AWTGraphicsConfiguration) config;
       }
+      // System.err.println("Info: AWTGraphicsConfiguration.create: Expected AWTGraphicsConfiguration got: "+config.getClass()+" w/ factory "+factory.getClass()+" - Unable to encapsulate native GraphicsConfiguration.");
       return new AWTGraphicsConfiguration(awtScreen, capsChosen, capsRequested, awtGfxConfig);
-      // FIXME: use encapsulated X11 as used in X11AWTGLXGraphicsConfigurationFactory
   }
 
-  public void updateGraphicsConfiguration(Component awtComp)
-  {
-      AWTGraphicsScreen awtScreen = null;
-      AWTGraphicsDevice awtDevice = null;
-      GraphicsDevice awtGraphicsDevice = null;
-      GraphicsConfiguration awtGfxConfig = awtComp.getGraphicsConfiguration();
-      if(null!=awtGfxConfig) {
-          awtGraphicsDevice = awtGfxConfig.getDevice();
-          if(null!=awtGraphicsDevice) {
-              // Create Device/Screen
-              awtDevice = new AWTGraphicsDevice(awtGraphicsDevice, AbstractGraphicsDevice.DEFAULT_UNIT);
-              awtScreen = new AWTGraphicsScreen(awtDevice);
-          }
-      }
-      if(null==awtScreen) {
-          throw new NativeWindowException("native peer n/a: "+awtComp);
-      }
-      config = awtGfxConfig;
-      setScreen(awtScreen);
-
-      CapabilitiesImmutable caps = ( null != getChosenCapabilities() ) ? getChosenCapabilities() : getRequestedCapabilities();
-      GraphicsConfiguration gc = awtGraphicsDevice.getDefaultConfiguration();
-      setChosenCapabilities(setupCapabilitiesRGBABits(caps, gc));
-      // FIXME: use encapsulated X11 as used in X11AWTGLXGraphicsConfigurationFactory
-  }
-  
   // open access to superclass method
   public void setChosenCapabilities(CapabilitiesImmutable capsChosen) {
       super.setChosenCapabilities(capsChosen);
@@ -190,7 +163,7 @@ public class AWTGraphicsConfiguration extends DefaultGraphicsConfiguration imple
     return capabilities;
   }
 
-    @Override
+  @Override
   public String toString() {
     return getClass().getSimpleName()+"[" + getScreen() +
                                    ",\n\tchosen    " + capabilitiesChosen+
diff --git a/src/nativewindow/classes/jogamp/nativewindow/x11/awt/X11AWTGraphicsConfigurationFactory.java b/src/nativewindow/classes/jogamp/nativewindow/x11/awt/X11AWTGraphicsConfigurationFactory.java
new file mode 100644
index 000000000..252a97078
--- /dev/null
+++ b/src/nativewindow/classes/jogamp/nativewindow/x11/awt/X11AWTGraphicsConfigurationFactory.java
@@ -0,0 +1,185 @@
+/*
+ * Copyright (c) 2008 Sun Microsystems, Inc. All Rights Reserved.
+ * Copyright (c) 2010 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:
+ * 
+ * - 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.
+ */
+
+package jogamp.nativewindow.x11.awt;
+
+import java.awt.Component;
+import java.awt.GraphicsConfiguration;
+import java.awt.GraphicsDevice;
+
+import javax.media.nativewindow.AbstractGraphicsConfiguration;
+import javax.media.nativewindow.AbstractGraphicsDevice;
+import javax.media.nativewindow.AbstractGraphicsScreen;
+import javax.media.nativewindow.CapabilitiesChooser;
+import javax.media.nativewindow.CapabilitiesImmutable;
+import javax.media.nativewindow.GraphicsConfigurationFactory;
+import javax.media.nativewindow.NativeWindowException;
+import javax.media.nativewindow.NativeWindowFactory;
+import javax.media.nativewindow.ToolkitLock;
+import javax.media.nativewindow.awt.AWTGraphicsConfiguration;
+import javax.media.nativewindow.awt.AWTGraphicsDevice;
+import javax.media.nativewindow.awt.AWTGraphicsScreen;
+import javax.media.nativewindow.x11.X11GraphicsConfiguration;
+import javax.media.nativewindow.x11.X11GraphicsDevice;
+import javax.media.nativewindow.x11.X11GraphicsScreen;
+
+import jogamp.nativewindow.jawt.x11.X11SunJDKReflection;
+import jogamp.nativewindow.x11.X11Util;
+
+public class X11AWTGraphicsConfigurationFactory extends GraphicsConfigurationFactory {
+    
+    public static void registerFactory() {
+        GraphicsConfigurationFactory.registerFactory(javax.media.nativewindow.awt.AWTGraphicsDevice.class, new X11AWTGraphicsConfigurationFactory());
+    }    
+    private X11AWTGraphicsConfigurationFactory() {
+    }
+
+    protected AbstractGraphicsConfiguration chooseGraphicsConfigurationImpl(
+            CapabilitiesImmutable capsChosen, CapabilitiesImmutable capsRequested,
+            CapabilitiesChooser chooser, AbstractGraphicsScreen absScreen) {    
+        if (absScreen != null &&
+            !(absScreen instanceof AWTGraphicsScreen)) {
+            throw new IllegalArgumentException("This GraphicsConfigurationFactory accepts only AWTGraphicsScreen objects");
+        }
+        if(null==absScreen) {
+            absScreen = AWTGraphicsScreen.createDefault();
+        }
+
+        return chooseGraphicsConfigurationStatic(capsChosen, capsRequested, chooser, (AWTGraphicsScreen)absScreen);
+    }
+    
+    public static AWTGraphicsConfiguration chooseGraphicsConfigurationStatic(
+            CapabilitiesImmutable capsChosen, CapabilitiesImmutable capsRequested,
+            CapabilitiesChooser chooser, AWTGraphicsScreen awtScreen) {
+        if(DEBUG) {
+            System.err.println("X11AWTGraphicsConfigurationFactory: got "+awtScreen);
+        }
+        
+        final GraphicsDevice device = ((AWTGraphicsDevice)awtScreen.getDevice()).getGraphicsDevice();
+
+        long displayHandle = X11SunJDKReflection.graphicsDeviceGetDisplay(device);
+        boolean owner = false;
+        if(0==displayHandle) {
+            displayHandle = X11Util.openDisplay(null);
+            owner = true;
+            if(DEBUG) {
+                System.err.println(Thread.currentThread().getName() + " - X11AWTGraphicsConfigurationFactory: create local X11 display");
+            }
+        } else {
+            /**
+             * Using the AWT display handle works fine with NVidia.
+             * However we experienced different results w/ AMD drivers, 
+             * some work, but some behave erratic. 
+             * I.e. hangs in XQueryExtension(..) via X11GraphicsScreen.
+             */
+            final String displayName = X11Util.XDisplayString(displayHandle);
+            if(DEBUG) {
+                System.err.println(Thread.currentThread().getName() + " - X11AWTGraphicsConfigurationFactory: create X11 display @ "+displayName+" / 0x"+Long.toHexString(displayHandle));
+            }
+            displayHandle = X11Util.openDisplay(displayName);
+            owner = true;
+        }
+        final ToolkitLock lock = owner ? 
+                NativeWindowFactory.getNullToolkitLock() : // own non-shared X11 display connection, no lock
+                NativeWindowFactory.createDefaultToolkitLock(NativeWindowFactory.TYPE_X11, NativeWindowFactory.TYPE_AWT, displayHandle);
+        final X11GraphicsDevice x11Device = new X11GraphicsDevice(displayHandle, AbstractGraphicsDevice.DEFAULT_UNIT, lock, owner); 
+        final X11GraphicsScreen x11Screen = new X11GraphicsScreen(x11Device, awtScreen.getIndex());
+        if(DEBUG) {
+            System.err.println("X11AWTGraphicsConfigurationFactory: made "+x11Screen);
+        }
+        
+        final GraphicsConfigurationFactory factory = GraphicsConfigurationFactory.getFactory(x11Device);
+        X11GraphicsConfiguration x11Config = (X11GraphicsConfiguration) factory.chooseGraphicsConfiguration(capsChosen, capsRequested, chooser, x11Screen);
+        if (x11Config == null) {
+            throw new NativeWindowException("Unable to choose a GraphicsConfiguration (1): "+capsChosen+",\n\t"+chooser+"\n\t"+x11Screen);
+        }
+        if(DEBUG) {
+            System.err.println("X11AWTGraphicsConfigurationFactory: chosen x11Config: "+x11Config);
+        }
+        
+        //
+        // Match the X11/GL Visual with AWT:
+        //   - choose a config AWT agnostic and then
+        //   - try to find the visual within the GraphicsConfiguration
+        //
+        // The resulting GraphicsConfiguration has to be 'forced' on the AWT native peer,
+        // ie. returned by GLCanvas's getGraphicsConfiguration() befor call by super.addNotify().
+        //        
+        final GraphicsConfiguration[] configs = device.getConfigurations();
+        long visualID = x11Config.getVisualID();
+        for (int i = 0; i < configs.length; i++) {
+            GraphicsConfiguration gc = configs[i];
+            if (gc != null) {
+                if (X11SunJDKReflection.graphicsConfigurationGetVisualID(gc) == visualID) {
+                    if(DEBUG) {
+                        System.err.println("Found matching AWT visual: 0x"+Long.toHexString(visualID) +" -> "+x11Config);
+                    }
+                    return new AWTGraphicsConfiguration(awtScreen,
+                                                        x11Config.getChosenCapabilities(), x11Config.getRequestedCapabilities(),
+                                                        gc, x11Config);
+                }
+            }
+        }
+
+        // try again using an AWT Colormodel compatible configuration
+        GraphicsConfiguration gc = device.getDefaultConfiguration();
+        capsChosen = AWTGraphicsConfiguration.setupCapabilitiesRGBABits(capsChosen, gc);
+        x11Config = (X11GraphicsConfiguration) factory.chooseGraphicsConfiguration(capsChosen, capsRequested, chooser, x11Screen);
+        if (x11Config == null) {
+            throw new NativeWindowException("Unable to choose a GraphicsConfiguration (2): "+capsChosen+",\n\t"+chooser+"\n\t"+x11Screen);
+        }
+        visualID = x11Config.getVisualID();
+        for (int i = 0; i < configs.length; i++) {
+            gc = configs[i];
+            if (X11SunJDKReflection.graphicsConfigurationGetVisualID(gc) == visualID) {
+                if(DEBUG) {
+                    System.err.println("Found matching default AWT visual: 0x"+Long.toHexString(visualID) +" -> "+x11Config);
+                }
+                return new AWTGraphicsConfiguration(awtScreen,
+                                                    x11Config.getChosenCapabilities(), x11Config.getRequestedCapabilities(),
+                                                    gc, x11Config);
+            }
+        }
+
+        // Either we weren't able to reflectively introspect on the
+        // X11GraphicsConfig or something went wrong in the steps above;
+        // Let's take the default configuration as used on Windows and MacOSX then ..
+        if(DEBUG) {
+            System.err.println("!!! Using default configuration");
+        }
+
+        gc = device.getDefaultConfiguration();
+        return new AWTGraphicsConfiguration(awtScreen, x11Config.getChosenCapabilities(), x11Config.getRequestedCapabilities(), gc, x11Config);
+    }
+}
+