Windows RegisterClass: Use new RegisteredClassFactory (window class), Misc.

This solves the issue when an applet is started/stop and started again,
or another applet runs in the same JVM.
Also soves the issue for multiple JVMs.

RegisteredClassFactory can be instanced to manage one shared window class,
currently in use for GDI's dummy window and NEWT.
A class base name and a window proc handle must be passed in the factory cstr.

Before registering, the class is tested if already exists,
eg another applet in the same JVM.
If registration fails, the class name will iterate until successful or MAX_INT reached,
eg if multiple JVMs are running.

Added NativeWindow Common Native Code.

4 files changed, 204 insertions, 14 deletions

diff --git a/src/nativewindow/classes/com/jogamp/nativewindow/impl/x11/X11Util.java b/src/nativewindow/classes/com/jogamp/nativewindow/impl/x11/X11Util.java
index f3b7f4a4e..c56f632d8 100644
--- a/src/nativewindow/classes/com/jogamp/nativewindow/impl/x11/X11Util.java
+++ b/src/nativewindow/classes/com/jogamp/nativewindow/impl/x11/X11Util.java
@@ -34,10 +34,11 @@
 package com.jogamp.nativewindow.impl.x11;
 
 import com.jogamp.common.util.LongObjectHashMap;
+import com.jogamp.nativewindow.impl.Debug;
+import com.jogamp.nativewindow.impl.NWJNILibLoader;
 
 import javax.media.nativewindow.*;
 
-import com.jogamp.nativewindow.impl.*;
 import java.nio.Buffer;
 import java.nio.IntBuffer;
 import java.nio.ShortBuffer;
diff --git a/src/nativewindow/classes/javax/media/nativewindow/NativeWindowFactory.java b/src/nativewindow/classes/javax/media/nativewindow/NativeWindowFactory.java
index a36440873..9e0aa28fa 100644
--- a/src/nativewindow/classes/javax/media/nativewindow/NativeWindowFactory.java
+++ b/src/nativewindow/classes/javax/media/nativewindow/NativeWindowFactory.java
@@ -80,6 +80,7 @@ public abstract class NativeWindowFactory {
     public static final String AWTComponentClassName = "java.awt.Component" ;
     public static final String JAWTUtilClassName = "com.jogamp.nativewindow.impl.jawt.JAWTUtil" ;
     public static final String X11UtilClassName = "com.jogamp.nativewindow.impl.x11.X11Util";
+    public static final String GDIClassName = "com.jogamp.nativewindow.impl.windows.GDI";
     public static final String X11JAWTToolkitLockClassName = "com.jogamp.nativewindow.impl.jawt.x11.X11JAWTToolkitLock" ;
     public static final String X11ToolkitLockClassName = "com.jogamp.nativewindow.impl.x11.X11ToolkitLock" ;
     private static Class  jawtUtilClass;
@@ -117,6 +118,20 @@ public abstract class NativeWindowFactory {
 
     static boolean initialized = false;
 
+    private static void initNativeImpl(final boolean firstUIActionOnProcess, final ClassLoader cl) {
+        String clazzName = null;
+        if( TYPE_X11.equals(nativeWindowingTypePure) ) {
+            clazzName = X11UtilClassName;
+        } else if( TYPE_WINDOWS.equals(nativeWindowingTypePure) ) {
+            clazzName = GDIClassName;
+        }
+        if( null != clazzName ) {
+            ReflectionUtil.callStaticMethod(clazzName, "initSingleton",
+                                            new Class[] { boolean.class },
+                                            new Object[] { new Boolean(firstUIActionOnProcess) }, cl );
+        }
+    }
+
     /**
      * Static one time initialization of this factory.<br>
      * This initialization method <b>must be called</b> once by the program or utilizing modules!<br>
@@ -144,15 +159,14 @@ public abstract class NativeWindowFactory {
                 nativeWindowingTypeCustom = nativeOSNameCustom;
             }
 
-            ClassLoader cl = NativeWindowFactory.class.getClassLoader();
+            final ClassLoader cl = NativeWindowFactory.class.getClassLoader();
 
-            if( TYPE_X11.equals(nativeWindowingTypePure) ) {
-                // explicit initialization of X11Util
-                ReflectionUtil.callStaticMethod(X11UtilClassName, "initSingleton", 
-                                                new Class[] { boolean.class }, 
-                                                new Object[] { new Boolean(firstUIActionOnProcess) }, cl );
+            if(firstUIActionOnProcess) {
+                // X11 initialization before possible AWT initialization
+                initNativeImpl(firstUIActionOnProcess, cl);
             }
             isFirstUIActionOnProcess = firstUIActionOnProcess;
+            isAWTAvailable = false; // may be set to true below
 
             if( !Debug.getBooleanProperty("java.awt.headless", true, acc) &&
                 ReflectionUtil.isClassAvailable(AWTComponentClassName, cl) &&
@@ -180,16 +194,13 @@ public abstract class NativeWindowFactory {
                         // AWT is only available in case all above classes are available
                         // and AWT is not int headless mode
                         isAWTAvailable = ((Boolean)resO).equals(Boolean.FALSE);
-                    } else {
-                        isAWTAvailable = false;
                     }
-                } else {
-                    isAWTAvailable = false;
                 }
-            } else {
-                isAWTAvailable = false;
             }
-
+            if(!firstUIActionOnProcess) {
+                // X11 initialization after possible AWT initialization
+                initNativeImpl(firstUIActionOnProcess, cl);
+            }
             registeredFactories = Collections.synchronizedMap(new HashMap());
 
             // register our default factory -> NativeWindow
diff --git a/src/nativewindow/classes/javax/media/nativewindow/windows/RegisteredClass.java b/src/nativewindow/classes/javax/media/nativewindow/windows/RegisteredClass.java
new file mode 100644
index 000000000..f42c2cbc0
--- /dev/null
+++ b/src/nativewindow/classes/javax/media/nativewindow/windows/RegisteredClass.java
@@ -0,0 +1,44 @@
+/**
+ * Copyright 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:
+ *
+ *    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 javax.media.nativewindow.windows;
+
+public class RegisteredClass {
+    long hInstance;
+    String className;
+
+    RegisteredClass(long hInst, String name) {
+        hInstance = hInst;
+        className = name;
+    }
+
+    public final long getHandle() { return hInstance; }
+    public final String getName() { return className; }
+
+    public final String toString() { return "RegisteredClass[handle 0x"+Long.toHexString(hInstance)+", "+className+"]"; }
+}
diff --git a/src/nativewindow/classes/javax/media/nativewindow/windows/RegisteredClassFactory.java b/src/nativewindow/classes/javax/media/nativewindow/windows/RegisteredClassFactory.java
new file mode 100644
index 000000000..2378bb9a8
--- /dev/null
+++ b/src/nativewindow/classes/javax/media/nativewindow/windows/RegisteredClassFactory.java
@@ -0,0 +1,134 @@
+/**
+ * Copyright 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:
+ *
+ *    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 javax.media.nativewindow.windows;
+
+import com.jogamp.nativewindow.impl.Debug;
+import com.jogamp.nativewindow.impl.windows.GDI;
+import java.util.ArrayList;
+import javax.media.nativewindow.NativeWindowException;
+
+public class RegisteredClassFactory {
+    static final boolean DEBUG = Debug.debug("RegisteredClass");
+    private static ArrayList sharedClasses = new ArrayList();
+    private String classBaseName;
+    long wndProc;
+
+    private RegisteredClass sharedClass = null;
+    private int classIter = 0;
+    private int sharedRefCount = 0;
+    private Object sync = new Object();
+
+    /**
+     * Intended for a JVM shutdown hook, hence little synchronization
+     */
+    public static void shutdownSharedClasses() {
+        synchronized(sharedClasses) {
+            for(int i=0; i<sharedClasses.size(); i++) {
+                RegisteredClass sc = (RegisteredClass) sharedClasses.get(i);
+                GDI.DestroyWindowClass(sc.getHandle(), sc.getName());
+                if(DEBUG) {
+                  System.err.println("RegisteredClassFactory shutdownSharedClasses "+i+"/"+sharedClasses.size()+": "+sc);
+                }
+            }
+            sharedClasses.clear();
+        }
+    }
+
+    public RegisteredClassFactory(String classBaseName, long wndProc) {
+        this.classBaseName = classBaseName;
+        this.wndProc = wndProc;
+    }
+
+    public RegisteredClass getSharedClass() throws NativeWindowException {
+      synchronized(sync) {
+          if( 0 == sharedRefCount ) {
+              if( null != sharedClass ) {
+                  throw new InternalError("Error ("+sharedRefCount+"): SharedClass not null: "+sharedClass);
+              }
+              long hInstance = GDI.GetApplicationHandle();
+              if( 0 == hInstance ) {
+                  throw new NativeWindowException("Error: Null ModuleHandle for Application");
+              }
+              String clazzName = null;
+              boolean registered = false;
+              while ( !registered && Integer.MAX_VALUE >= classIter ) {
+                  // Retry with next clazz name, this could happen if more than one JVM is running
+                  clazzName = classBaseName + classIter;
+                  classIter++;
+                  registered = GDI.CreateWindowClass(hInstance, clazzName, wndProc);
+              }
+              if( !registered ) {
+                  throw new NativeWindowException("Error: Could not create WindowClass: "+clazzName);
+              }
+              sharedClass = new RegisteredClass(hInstance, clazzName);
+              synchronized(sharedClasses) {
+                  sharedClasses.add(sharedClass);
+              }
+              if(DEBUG) {
+                  System.err.println("RegisteredClassFactory getSharedClass ("+sharedRefCount+") initialized: "+sharedClass);
+              }
+          } else if ( null == sharedClass ) {
+              throw new InternalError("Error ("+sharedRefCount+"): SharedClass is null");
+          }
+          sharedRefCount++;
+      }
+      return sharedClass;
+    }
+
+    public void releaseSharedClass() {
+      synchronized(sync) {
+          if( 0 == sharedRefCount ) {
+              if( null != sharedClass ) {
+                  throw new InternalError("Error ("+sharedRefCount+"): SharedClass not null: "+sharedClass);
+              }
+              return;
+          }
+          sharedRefCount--;
+          if( null == sharedClass ) {
+              throw new InternalError("Error ("+sharedRefCount+"): SharedClass is null");
+          }
+          if( 0 == sharedRefCount ) {
+              GDI.DestroyWindowClass(sharedClass.getHandle(), sharedClass.getName());
+              synchronized(sharedClasses) {
+                  sharedClasses.remove(sharedClass);
+              }
+              if(DEBUG) {
+                  System.err.println("RegisteredClassFactory releaseSharedClass ("+sharedRefCount+") released: "+sharedClass);
+              }
+              sharedClass = null;
+              sharedRefCount = 0;
+              classIter = 0;
+          }
+      }
+    }
+
+    public int getSharedRefCount() {
+        return sharedRefCount;
+    }
+}