iOS: Initial working commit supporting iOS (ipad pro 11)

using our OpenJFK 9 x86_64 and arm64 build.

Test demo class is 'com.jogamp.opengl.demos.ios.Hello',
residing in the new demo folder 'src/demos/com/jogamp/opengl/demos/ios/Hello.java'.

This commit does not yet include a working NEWT
specialization for iOS, but it shall followup soon.

Instead this commit demonstrates JOGL operating on
native UIWindow, UIView and CAEAGLLayer as provided by
Nativewindow's IOSUtil.

Test Video https://www.youtube.com/watch?v=Z4lUQNFTGMI

+++

Notable bug: The FBO used and sharing the COLORBUFFER RENDERBUFFER
memory resources with CAEAGLLayer to be displayed in the UIView
seemingly cannot handle GL_DEPTH_COMPONENT16, GL_DEPTH_COMPONENT24
or GL_DEPTH_COMPONENT32 depth buffer - none at all (Device + Simulation).

Therefor the default demo GLEventListener chosen here
don't require a depth buffer ;-)

This issue can hopefully be mitigated with other means
than using a flat FBO sink similar to FBO multisampling.

2 files changed, 416 insertions, 0 deletions

diff --git a/src/nativewindow/classes/jogamp/nativewindow/ios/IOSDummyUpstreamSurfaceHook.java b/src/nativewindow/classes/jogamp/nativewindow/ios/IOSDummyUpstreamSurfaceHook.java
new file mode 100644
index 000000000..a61287f8b
--- /dev/null
+++ b/src/nativewindow/classes/jogamp/nativewindow/ios/IOSDummyUpstreamSurfaceHook.java
@@ -0,0 +1,83 @@
+/**
+ * Copyright 2019 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 jogamp.nativewindow.ios;
+
+import com.jogamp.nativewindow.NativeSurface;
+import com.jogamp.nativewindow.NativeWindowException;
+import com.jogamp.nativewindow.ProxySurface;
+import com.jogamp.nativewindow.UpstreamSurfaceHook;
+
+import com.jogamp.nativewindow.UpstreamSurfaceHookMutableSize;
+
+public class IOSDummyUpstreamSurfaceHook extends UpstreamSurfaceHookMutableSize {
+    long uiWindow;
+
+    /**
+     * @param width the initial width as returned by {@link NativeSurface#getSurfaceWidth()} via {@link UpstreamSurfaceHook#getSurfaceWidth(ProxySurface)},
+     *        not the actual dummy surface width.
+     *        The latter is platform specific and small
+     * @param height the initial height as returned by {@link NativeSurface#getSurfaceHeight()} via {@link UpstreamSurfaceHook#getSurfaceHeight(ProxySurface)},
+     *        not the actual dummy surface height,
+     *        The latter is platform specific and small
+     */
+    public IOSDummyUpstreamSurfaceHook(final int width, final int height) {
+        super(width, height);
+        uiWindow = 0;
+    }
+
+    @Override
+    public final void create(final ProxySurface s) {
+        if(0 == uiWindow && 0 == s.getSurfaceHandle()) {
+            uiWindow = IOSUtil.CreateUIWindow(0, 0, 64, 64);
+            if(0 == uiWindow) {
+                throw new NativeWindowException("Error UI window 0");
+            }
+            final long uiView = IOSUtil.GetUIView(uiWindow, true);
+            if(0 == uiView) {
+                throw new NativeWindowException("Error UI view 0");
+            }
+            s.setSurfaceHandle(uiView);
+            s.addUpstreamOptionBits( ProxySurface.OPT_PROXY_OWNS_UPSTREAM_SURFACE );
+        }
+        s.addUpstreamOptionBits(ProxySurface.OPT_UPSTREAM_WINDOW_INVISIBLE);
+    }
+
+    @Override
+    public final void destroy(final ProxySurface s) {
+        if( s.containsUpstreamOptionBits( ProxySurface.OPT_PROXY_OWNS_UPSTREAM_SURFACE ) ) {
+            if( 0 == uiWindow || 0 == s.getSurfaceHandle() ) {
+                throw new InternalError("Owns upstream surface, but no IOS view/window: "+s+", uiWindow 0x"+Long.toHexString(uiWindow));
+            }
+            IOSUtil.DestroyUIWindow(uiWindow);
+            uiWindow = 0;
+            s.setSurfaceHandle(0);
+            s.clearUpstreamOptionBits( ProxySurface.OPT_PROXY_OWNS_UPSTREAM_SURFACE );
+        }
+    }
+
+}
diff --git a/src/nativewindow/classes/jogamp/nativewindow/ios/IOSUtil.java b/src/nativewindow/classes/jogamp/nativewindow/ios/IOSUtil.java
new file mode 100644
index 000000000..bd4b36239
--- /dev/null
+++ b/src/nativewindow/classes/jogamp/nativewindow/ios/IOSUtil.java
@@ -0,0 +1,333 @@
+/**
+ * Copyright 2019 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 jogamp.nativewindow.ios;
+
+import com.jogamp.nativewindow.NativeWindowException;
+import com.jogamp.nativewindow.NativeWindowFactory;
+import com.jogamp.nativewindow.util.Insets;
+import com.jogamp.nativewindow.util.Point;
+import com.jogamp.common.util.Function;
+import com.jogamp.common.util.FunctionTask;
+import com.jogamp.common.util.InterruptedRuntimeException;
+import com.jogamp.common.util.RunnableTask;
+
+import jogamp.nativewindow.Debug;
+import jogamp.nativewindow.NWJNILibLoader;
+import jogamp.nativewindow.ToolkitProperties;
+
+public class IOSUtil implements ToolkitProperties {
+    private static boolean isInit = false;
+    private static final boolean DEBUG = Debug.debug("IOSUtil");
+
+    /** FIXME HiDPI: OSX unique and maximum value {@value} */
+    public static final int MAX_PIXELSCALE = 2;
+
+    /**
+     * Called by {@link NativeWindowFactory#initSingleton()}
+     * @see ToolkitProperties
+     */
+    public static synchronized void initSingleton() {
+      if(!isInit) {
+          if(DEBUG) {
+              System.out.println("IOSUtil.initSingleton()");
+          }
+          if(!NWJNILibLoader.loadNativeWindow("ios")) {
+              throw new NativeWindowException("NativeWindow IOS native library load error.");
+          }
+
+          if( !initIDs0() ) {
+              throw new NativeWindowException("IOS: Could not initialized native stub");
+          }
+          isInit = true;
+      }
+    }
+
+    /**
+     * Called by {@link NativeWindowFactory#shutdown()}
+     * @see ToolkitProperties
+     */
+    public static void shutdown() { }
+
+    /**
+     * Called by {@link NativeWindowFactory#initSingleton()}
+     * @see ToolkitProperties
+     */
+    public static boolean requiresToolkitLock() { return false; }
+
+    /**
+     * Called by {@link NativeWindowFactory#initSingleton()}
+     * @see ToolkitProperties
+     */
+    public static final boolean hasThreadingIssues() { return false; }
+
+    public static boolean isCALayer(final long object) {
+        return 0 != object ? isCALayer0(object) : false;
+    }
+
+    public static boolean isCAEAGLLayer(final long object) {
+        return 0 != object ? isCAEAGLLayer0(object) : false;
+    }
+
+    public static boolean isUIView(final long object) {
+        return 0 != object ? isUIView0(object) : false;
+    }
+
+    public static boolean isUIWindow(final long object) {
+        return 0 != object ? isUIWindow0(object) : false;
+    }
+
+    /**
+     * @param windowOrView
+     * @param src_x
+     * @param src_y
+     * @return top-left client-area position in window units
+     */
+    public static Point GetLocationOnScreen(final long windowOrView, final int src_x, final int src_y) {
+      return (Point) GetLocationOnScreen0(windowOrView, src_x, src_y);
+    }
+
+    public static Insets GetInsets(final long windowOrView) {
+      return (Insets) GetInsets0(windowOrView);
+    }
+
+    public static double GetPixelScaleByDisplayID(final int displayID) {
+      if( 0 != displayID ) {
+          return GetPixelScale1(displayID);
+      } else {
+          return 1.0; // default
+      }
+    }
+    public static double GetPixelScale(final long windowOrView) {
+      if( 0 != windowOrView ) {
+          return GetPixelScale2(windowOrView);
+      } else {
+          return 1.0; // default
+      }
+    }
+
+    public static long CreateUIWindow(final int x, final int y, final int width, final int height) {
+      final long res[] = { 0 };
+      RunOnMainThread(true, false /* kickNSApp */, new Runnable() {
+          @Override
+          public void run() {
+              res[0] = CreateUIWindow0(x, y, width, height);
+          } } );
+      return res[0];
+    }
+    public static void DestroyUIWindow(final long uiWindow) {
+      DestroyUIWindow0(uiWindow);
+    }
+    public static long GetCALayer(final long uiView) {
+      return 0 != uiView ? GetCALayer0(uiView) : 0;
+    }
+    public static long GetCAEAGLLayer(final long uiView) {
+      return 0 != uiView ? GetCAEAGLLayer0(uiView) : 0;
+    }
+    public static long GetUIView(final long uiWindow, final boolean onlyEAGL) {
+      return 0 != uiWindow ? GetUIView0(uiWindow, onlyEAGL) : 0;
+    }
+    public static long GetUIWindow(final long uiView) {
+      return 0 != uiView ? GetUIWindow0(uiView) : 0;
+    }
+
+    /**
+     * Set the UIView's pixelScale / contentScale for HiDPI
+     *
+     * @param uiView the mutable UIView instance
+     * @param contentScaleFactor scale for HiDPI support: pixel-dim = window-dim x scale
+     */
+    public static void SetUIViewPixelScale(final long uiView, final float contentScaleFactor) {
+        SetUIViewPixelScale0(uiView, contentScaleFactor);
+    }
+    /**
+     * Get the UIView's pixelScale / contentScale for HiDPI
+     *
+     * @param uiView the UIView instance
+     * @return used scale for HiDPI support: pixel-dim = window-dim x scale
+     */
+    public static float GetUIViewPixelScale(final long uiView) {
+        return GetUIViewPixelScale0(uiView);
+    }
+
+    /**
+     * Set root and sub CALayer pixelScale / contentScale for HiDPI
+     *
+     * @param rootCALayer the root surface layer, maybe null.
+     * @param subCALayer the client surface layer, maybe null.
+     * @param contentsScale scale for HiDPI support: pixel-dim = window-dim x scale
+     */
+    public static void SetCALayerPixelScale(final long rootCALayer, final long subCALayer, final float contentsScale) {
+        if( 0==rootCALayer && 0==subCALayer ) {
+            return;
+        }
+        SetCALayerPixelScale0(rootCALayer, subCALayer, contentsScale);
+    }
+    /**
+     * Get the CALayer's pixelScale / contentScale for HiDPI
+     *
+     * @param caLayer the CALayer instance
+     * @return used scale for HiDPI support: pixel-dim = window-dim x scale
+     */
+    public static float GetCALayerPixelScale(final long caLayer) {
+        return GetCALayerPixelScale0(caLayer);
+    }
+
+    /**
+     * Run on OSX UI main thread.
+     * <p>
+     * 'waitUntilDone' is implemented on Java site via lock/wait on {@link RunnableTask} to not freeze OSX main thread.
+     * </p>
+     *
+     * @param waitUntilDone
+     * @param kickNSApp if <code>true</code> issues {@link #KickUIApp()}
+     * @param runnable
+     */
+    public static void RunOnMainThread(final boolean waitUntilDone, final boolean kickNSApp, final Runnable runnable) {
+        if( IsMainThread0() ) {
+            runnable.run(); // don't leave the JVM
+        } else {
+            // Utilize Java side lock/wait and simply pass the Runnable async to OSX main thread,
+            // otherwise we may freeze the OSX main thread.
+            final Object sync = new Object();
+            final RunnableTask rt = new RunnableTask( runnable, waitUntilDone ? sync : null, true, waitUntilDone ? null : System.err );
+            synchronized(sync) {
+                RunOnMainThread0(kickNSApp, rt);
+                if( waitUntilDone ) {
+                    while( rt.isInQueue() ) {
+                        try {
+                            sync.wait();
+                        } catch (final InterruptedException ie) {
+                            throw new InterruptedRuntimeException(ie);
+                        }
+                        final Throwable throwable = rt.getThrowable();
+                        if(null!=throwable) {
+                            throw new RuntimeException(throwable);
+                        }
+                    }
+                }
+            }
+        }
+    }
+
+    /**
+     * Run later on ..
+     * @param onMain if true, run on main-thread, otherwise on the current OSX thread.
+     * @param runnable
+     * @param delay delay to run the runnable in milliseconds
+     */
+    public static void RunLater(final boolean onMain, final Runnable runnable, final int delay) {
+        RunLater0(onMain, false /* kickNSApp */, new RunnableTask( runnable, null, true, System.err ), delay);
+    }
+
+    private static Runnable _nop = new Runnable() { @Override public void run() {}; };
+
+    /** Issues a {@link #RunOnMainThread(boolean, boolean, Runnable)} w/ an <i>NOP</i> runnable, while waiting until done and issuing {@link #KickUIApp()}. */
+    public static void WaitUntilFinish() {
+        RunOnMainThread(true, true /* kickNSApp */, _nop);
+    }
+
+    /**
+     * Run on OSX UI main thread.
+     * <p>
+     * 'waitUntilDone' is implemented on Java site via lock/wait on {@link FunctionTask} to not freeze OSX main thread.
+     * </p>
+     *
+     * @param waitUntilDone
+     * @param kickUIApp if <code>true</code> issues {@link #KickUIApp()}
+     * @param func
+     */
+    public static <R,A> R RunOnMainThread(final boolean waitUntilDone, final boolean kickUIApp, final Function<R,A> func, final A... args) {
+        if( IsMainThread0() ) {
+            return func.eval(args); // don't leave the JVM
+        } else {
+            // Utilize Java side lock/wait and simply pass the Runnable async to OSX main thread,
+            // otherwise we may freeze the OSX main thread.
+            final Object sync = new Object();
+            final FunctionTask<R,A> rt = new FunctionTask<R,A>( func, waitUntilDone ? sync : null, true, waitUntilDone ? null : System.err );
+            synchronized(sync) {
+                rt.setArgs(args);
+                RunOnMainThread0(kickUIApp, rt);
+                if( waitUntilDone ) {
+                    while( rt.isInQueue() ) {
+                        try {
+                            sync.wait();
+                        } catch (final InterruptedException ie) {
+                            throw new InterruptedRuntimeException(ie);
+                        }
+                        final Throwable throwable = rt.getThrowable();
+                        if(null!=throwable) {
+                            throw new RuntimeException(throwable);
+                        }
+                    }
+                }
+            }
+            return rt.getResult();
+        }
+    }
+
+    public static boolean IsMainThread() {
+        return IsMainThread0();
+    }
+
+    /** Returns the screen refresh rate in Hz. If unavailable, returns 60Hz. */
+    public static int GetScreenRefreshRate(final int scrn_idx) {
+        return GetScreenRefreshRate0(scrn_idx);
+    }
+
+    public static void CreateGLViewDemoA() {
+        CreateGLViewDemoA0();
+    }
+
+    private static native boolean initIDs0();
+    private static native boolean isCALayer0(long object);
+    private static native boolean isCAEAGLLayer0(long object);
+    private static native boolean isUIView0(long object);
+    private static native boolean isUIWindow0(long object);
+    private static native Object GetLocationOnScreen0(long windowOrView, int src_x, int src_y);
+    private static native Object GetInsets0(long windowOrView);
+    private static native double GetPixelScale1(int displayID);
+    private static native double GetPixelScale2(long windowOrView);
+    private static native long CreateUIWindow0(int x, int y, int width, int height);
+    private static native void DestroyUIWindow0(long uiWindow);
+    private static native long GetCALayer0(long uiView);
+    private static native long GetCAEAGLLayer0(long uiView);
+    private static native long GetUIView0(long uiWindow, boolean onlyEAGL);
+    private static native long GetUIWindow0(long uiView);
+    private static native void SetUIViewPixelScale0(final long uiView, final float contentScaleFactor);
+    private static native float GetUIViewPixelScale0(final long uiView);
+    private static native void SetCALayerPixelScale0(long rootCALayer, long subCALayer, float contentsScale);
+    private static native float GetCALayerPixelScale0(final long caLayer);
+
+    private static native void RunOnMainThread0(boolean kickNSApp, Runnable runnable);
+    private static native void RunLater0(boolean onMain, boolean kickNSApp, Runnable runnable, int delay);
+    private static native void KickUIApp0();
+    private static native boolean IsMainThread0();
+    private static native int GetScreenRefreshRate0(int scrn_idx);
+    private static native void CreateGLViewDemoA0();
+
+}