diff --git a/extended/native-image/hello-awtfree/build.gradle.kts b/extended/native-image/hello-awtfree/build.gradle.kts new file mode 100644 index 00000000000..585fc47cae2 --- /dev/null +++ b/extended/native-image/hello-awtfree/build.gradle.kts @@ -0,0 +1,45 @@ +// A Compose desktop application with no AWT in it: no ComposeWindow, no java.awt. The window +// is core-extended's extended/window WindowPlatform (graalvm-macos or graalvm-linux, chosen by +// the operating system this is built on), the scene is hosted by the window scene module, +// and Skia draws into the window's surface, Metal on macOS and GL on Linux. +// +// The window modules come from the local Maven repository: core-extended publishes them with +// `./kotlin publish mavenLocal` in extended/window. +plugins { + kotlin("jvm") version "2.2.20" + kotlin("plugin.compose") version "2.2.20" + id("org.jetbrains.compose") version "1.11.1-extended-dev" +} + +val windowing = "org.thisisthepy.compose.window" +val windowVersion = "0.1.0" +val mac = org.gradle.internal.os.OperatingSystem.current().isMacOsX + +sourceSets.main { + // The one file that names the platform layer and its graphics API. + kotlin.srcDir(if (mac) "src/mac/kotlin" else "src/linux/kotlin") +} + +dependencies { + implementation(compose.desktop.currentOs) + implementation(compose.foundation) + implementation("$windowing:common:$windowVersion") + implementation("$windowing:scene:$windowVersion") + implementation("$windowing:${if (mac) "graalvm-macos" else "graalvm-linux"}:$windowVersion") +} + +compose.desktop.application { + mainClass = "hello.MainKt" + nativeImage { + providers.environmentVariable("SKIKO_STATIC").orNull?.let { skikoStaticDirectory.set(file(it)) } + } +} + +// The classpath the application runs with, for probes that call native-image directly. +tasks.register("writeRuntimeClasspath") { + val classpath = sourceSets.main.get().runtimeClasspath + val out = layout.buildDirectory.file("runtime-classpath.txt") + inputs.files(classpath) + outputs.file(out) + doLast { out.get().asFile.writeText(classpath.files.joinToString(File.pathSeparator)) } +} diff --git a/extended/native-image/hello-awtfree/gradle/wrapper/gradle-wrapper.jar b/extended/native-image/hello-awtfree/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 00000000000..e6441136f3d Binary files /dev/null and b/extended/native-image/hello-awtfree/gradle/wrapper/gradle-wrapper.jar differ diff --git a/extended/native-image/hello-awtfree/gradle/wrapper/gradle-wrapper.properties b/extended/native-image/hello-awtfree/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 00000000000..1a704683a00 --- /dev/null +++ b/extended/native-image/hello-awtfree/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,7 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-9.5.0-bin.zip +networkTimeout=10000 +validateDistributionUrl=true +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/extended/native-image/hello-awtfree/gradlew b/extended/native-image/hello-awtfree/gradlew new file mode 100755 index 00000000000..1aa94a42690 --- /dev/null +++ b/extended/native-image/hello-awtfree/gradlew @@ -0,0 +1,249 @@ +#!/bin/sh + +# +# Copyright © 2015-2021 the original authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +############################################################################## +# +# Gradle start up script for POSIX generated by Gradle. +# +# Important for running: +# +# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is +# noncompliant, but you have some other compliant shell such as ksh or +# bash, then to run this script, type that shell name before the whole +# command line, like: +# +# ksh Gradle +# +# Busybox and similar reduced shells will NOT work, because this script +# requires all of these POSIX shell features: +# * functions; +# * expansions «$var», «${var}», «${var:-default}», «${var+SET}», +# «${var#prefix}», «${var%suffix}», and «$( cmd )»; +# * compound commands having a testable exit status, especially «case»; +# * various built-in commands including «command», «set», and «ulimit». +# +# Important for patching: +# +# (2) This script targets any POSIX shell, so it avoids extensions provided +# by Bash, Ksh, etc; in particular arrays are avoided. +# +# The "traditional" practice of packing multiple parameters into a +# space-separated string is a well documented source of bugs and security +# problems, so this is (mostly) avoided, by progressively accumulating +# options in "$@", and eventually passing that to Java. +# +# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, +# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; +# see the in-line comments for details. +# +# There are tweaks for specific operating systems such as AIX, CygWin, +# Darwin, MinGW, and NonStop. +# +# (3) This script is generated from the Groovy template +# https://github.com/gradle/gradle/blob/HEAD/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt +# within the Gradle project. +# +# You can find Gradle at https://github.com/gradle/gradle/. +# +############################################################################## + +# Attempt to set APP_HOME + +# Resolve links: $0 may be a link +app_path=$0 + +# Need this for daisy-chained symlinks. +while + APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path + [ -h "$app_path" ] +do + ls=$( ls -ld "$app_path" ) + link=${ls#*' -> '} + case $link in #( + /*) app_path=$link ;; #( + *) app_path=$APP_HOME$link ;; + esac +done + +# This is normally unused +# shellcheck disable=SC2034 +APP_BASE_NAME=${0##*/} +# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036) +APP_HOME=$( cd "${APP_HOME:-./}" > /dev/null && pwd -P ) || exit + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD=maximum + +warn () { + echo "$*" +} >&2 + +die () { + echo + echo "$*" + echo + exit 1 +} >&2 + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +nonstop=false +case "$( uname )" in #( + CYGWIN* ) cygwin=true ;; #( + Darwin* ) darwin=true ;; #( + MSYS* | MINGW* ) msys=true ;; #( + NONSTOP* ) nonstop=true ;; +esac + +CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar + + +# Determine the Java command to use to start the JVM. +if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD=$JAVA_HOME/jre/sh/java + else + JAVACMD=$JAVA_HOME/bin/java + fi + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD=java + if ! command -v java >/dev/null 2>&1 + then + die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +fi + +# Increase the maximum file descriptors if we can. +if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then + case $MAX_FD in #( + max*) + # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC2039,SC3045 + MAX_FD=$( ulimit -H -n ) || + warn "Could not query maximum file descriptor limit" + esac + case $MAX_FD in #( + '' | soft) :;; #( + *) + # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC2039,SC3045 + ulimit -n "$MAX_FD" || + warn "Could not set maximum file descriptor limit to $MAX_FD" + esac +fi + +# Collect all arguments for the java command, stacking in reverse order: +# * args from the command line +# * the main class name +# * -classpath +# * -D...appname settings +# * --module-path (only if needed) +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. + +# For Cygwin or MSYS, switch paths to Windows format before running java +if "$cygwin" || "$msys" ; then + APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) + CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) + + JAVACMD=$( cygpath --unix "$JAVACMD" ) + + # Now convert the arguments - kludge to limit ourselves to /bin/sh + for arg do + if + case $arg in #( + -*) false ;; # don't mess with options #( + /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath + [ -e "$t" ] ;; #( + *) false ;; + esac + then + arg=$( cygpath --path --ignore --mixed "$arg" ) + fi + # Roll the args list around exactly as many times as the number of + # args, so each arg winds up back in the position where it started, but + # possibly modified. + # + # NB: a `for` loop captures its iteration list before it begins, so + # changing the positional parameters here affects neither the number of + # iterations, nor the values presented in `arg`. + shift # remove old arg + set -- "$@" "$arg" # push replacement arg + done +fi + + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' + +# Collect all arguments for the java command: +# * DEFAULT_JVM_OPTS, JAVA_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments, +# and any embedded shellness will be escaped. +# * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be +# treated as '${Hostname}' itself on the command line. + +set -- \ + "-Dorg.gradle.appname=$APP_BASE_NAME" \ + -classpath "$CLASSPATH" \ + org.gradle.wrapper.GradleWrapperMain \ + "$@" + +# Stop when "xargs" is not available. +if ! command -v xargs >/dev/null 2>&1 +then + die "xargs is not available" +fi + +# Use "xargs" to parse quoted args. +# +# With -n1 it outputs one arg per line, with the quotes and backslashes removed. +# +# In Bash we could simply go: +# +# readarray ARGS < <( xargs -n1 <<<"$var" ) && +# set -- "${ARGS[@]}" "$@" +# +# but POSIX shell has neither arrays nor command substitution, so instead we +# post-process each arg (as a line of input to sed) to backslash-escape any +# character that might be a shell metacharacter, then use eval to reverse +# that process (while maintaining the separation between arguments), and wrap +# the whole thing up as a single "set" statement. +# +# This will of course break if any of these variables contains a newline or +# an unmatched quote. +# + +eval "set -- $( + printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | + xargs -n1 | + sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | + tr '\n' ' ' + )" '"$@"' + +exec "$JAVACMD" "$@" diff --git a/extended/native-image/hello-awtfree/settings.gradle.kts b/extended/native-image/hello-awtfree/settings.gradle.kts new file mode 100644 index 00000000000..bfd8d19558c --- /dev/null +++ b/extended/native-image/hello-awtfree/settings.gradle.kts @@ -0,0 +1,16 @@ +pluginManagement { + repositories { + mavenLocal() + gradlePluginPortal() + mavenCentral() + google() + } +} +dependencyResolutionManagement { + repositories { + mavenLocal() + mavenCentral() + google() + } +} +rootProject.name = "native-image-hello-awtfree" diff --git a/extended/native-image/hello-awtfree/src/linux/kotlin/Platform.kt b/extended/native-image/hello-awtfree/src/linux/kotlin/Platform.kt new file mode 100644 index 00000000000..6569ac04f9b --- /dev/null +++ b/extended/native-image/hello-awtfree/src/linux/kotlin/Platform.kt @@ -0,0 +1,56 @@ +package hello + +import org.jetbrains.skia.BackendRenderTarget +import org.jetbrains.skia.ColorSpace +import org.jetbrains.skia.DirectContext +import org.jetbrains.skia.PixelGeometry +import org.jetbrains.skia.Surface +import org.jetbrains.skia.SurfaceColorFormat +import org.jetbrains.skia.SurfaceOrigin +import org.jetbrains.skia.SurfaceProps +import org.thisisthepy.compose.window.WindowPlatform +import org.thisisthepy.compose.window.graalvm.linux.X11Upcalls +import org.thisisthepy.compose.window.graalvm.linux.X11Window +import org.thisisthepy.compose.window.scene.FrameTarget +import org.thisisthepy.compose.window.scene.WindowSurface + +private const val GL_RGBA8 = 0x8058 + +internal fun newPlatform(): WindowPlatform = X11Window() + +internal fun newSurface(platform: WindowPlatform): WindowSurface? = GlWindowSurface(platform as X11Window) + +/** Skia over the window's GLX framebuffer, which the window makes current when it opens. */ +private class GlWindowSurface(private val window: X11Window) : WindowSurface { + private val context = DirectContext.makeGL() + + override fun begin(width: Int, height: Int): FrameTarget? { + if (!window.beginFrame()) return null + val target = BackendRenderTarget.makeGL(width, height, 0, 0, 0, GL_RGBA8) + val surface = Surface.makeFromBackendRenderTarget( + context, + target, + SurfaceOrigin.BOTTOM_LEFT, + SurfaceColorFormat.RGBA_8888, + ColorSpace.sRGB, + SurfaceProps(PixelGeometry.RGB_H), + ) + if (surface == null) { + target.close() + return null + } + return object : FrameTarget { + override val surface: Surface = surface + override fun close() { + surface.close() + target.close() + } + } + } + + override fun setResizePainter(paint: (() -> Boolean)?) { + if (paint == null) X11Upcalls.clearFramePainter() else X11Upcalls.setFramePainter(paint) + } + + override fun close() = context.close() +} diff --git a/extended/native-image/hello-awtfree/src/mac/kotlin/Platform.kt b/extended/native-image/hello-awtfree/src/mac/kotlin/Platform.kt new file mode 100644 index 00000000000..e3e3b736949 --- /dev/null +++ b/extended/native-image/hello-awtfree/src/mac/kotlin/Platform.kt @@ -0,0 +1,74 @@ +package hello + +import org.jetbrains.skia.BackendRenderTarget +import org.jetbrains.skia.ColorSpace +import org.jetbrains.skia.DirectContext +import org.jetbrains.skia.PixelGeometry +import org.jetbrains.skia.Surface +import org.jetbrains.skia.SurfaceColorFormat +import org.jetbrains.skia.SurfaceOrigin +import org.jetbrains.skia.SurfaceProps +import org.thisisthepy.compose.window.WindowPlatform +import org.thisisthepy.compose.window.graalvm.macos.AppKitUpcallSlots +import org.thisisthepy.compose.window.graalvm.macos.AppKitWindowPlatform +import org.thisisthepy.compose.window.graalvm.macos.NativeWindow +import org.thisisthepy.compose.window.graalvm.macos.forgetFrameCallback +import org.thisisthepy.compose.window.graalvm.macos.installApplicationMenu +import org.thisisthepy.compose.window.graalvm.macos.registerFrameCallback +import org.thisisthepy.compose.window.scene.FrameTarget +import org.thisisthepy.compose.window.scene.WindowSurface + +internal fun newPlatform(): WindowPlatform = AppKitWindowPlatform() + +internal fun newSurface(platform: WindowPlatform): WindowSurface? { + val window = (platform as AppKitWindowPlatform).nativeWindow ?: return null + // The menu bar every application has: without it command-Q does not quit and command-C + // does not copy. + installApplicationMenu("Hello AWT-free") + return MetalWindowSurface(window) +} + +/** Skia over the Metal drawable AppKit's layer hands out, one frame at a time. */ +private class MetalWindowSurface(private val window: NativeWindow) : WindowSurface { + private val context = DirectContext.makeMetal(window.device, window.queue) + + override fun begin(width: Int, height: Int): FrameTarget? { + // Zero means the system had no drawable to give: frames are made faster than the + // screen takes them, and the answer is to skip one. + val texture = window.beginFrame() + if (texture == 0L) return null + val target = BackendRenderTarget.makeMetal(width, height, texture) + val surface = Surface.makeFromBackendRenderTarget( + context, + target, + SurfaceOrigin.TOP_LEFT, + SurfaceColorFormat.BGRA_8888, + ColorSpace.sRGB, + SurfaceProps(PixelGeometry.RGB_H), + ) + if (surface == null) { + target.close() + window.endFrame() + return null + } + return object : FrameTarget { + override val surface: Surface = surface + override fun close() { + surface.close() + target.close() + } + } + } + + override fun setResizePainter(paint: (() -> Boolean)?) { + if (paint == null) { + AppKitUpcallSlots.frame = null + forgetFrameCallback() + } else { + AppKitUpcallSlots.frame = Runnable { paint() } + registerFrameCallback() + } + } + + override fun close() = context.close() +} diff --git a/extended/native-image/hello-awtfree/src/main/kotlin/Main.kt b/extended/native-image/hello-awtfree/src/main/kotlin/Main.kt new file mode 100644 index 00000000000..6c97cbb3fca --- /dev/null +++ b/extended/native-image/hello-awtfree/src/main/kotlin/Main.kt @@ -0,0 +1,94 @@ +package hello + +import androidx.compose.foundation.background +import androidx.compose.foundation.clickable +import androidx.compose.foundation.layout.Box +import androidx.compose.foundation.layout.Column +import androidx.compose.foundation.layout.fillMaxSize +import androidx.compose.foundation.layout.padding +import androidx.compose.foundation.layout.size +import androidx.compose.foundation.text.BasicText +import androidx.compose.foundation.text.BasicTextField +import androidx.compose.runtime.Composable +import androidx.compose.runtime.getValue +import androidx.compose.runtime.mutableStateOf +import androidx.compose.runtime.remember +import androidx.compose.runtime.setValue +import androidx.compose.ui.Modifier +import androidx.compose.ui.graphics.Color +import androidx.compose.ui.graphics.SolidColor +import androidx.compose.ui.text.TextStyle +import androidx.compose.ui.unit.dp +import androidx.compose.ui.unit.sp +import java.io.File +import org.thisisthepy.compose.window.WindowConfig +import org.thisisthepy.compose.window.scene.ComposeWindowHost + +/** + * Text, a field and a control that changes when it is clicked. Text needs a font manager, a + * shaper and a layout pass, the field needs the platform's text input, and the control shows + * that pointer input reaches the scene. + */ +@Composable +fun Content() { + var clicks by remember { mutableStateOf(0) } + var typed by remember { mutableStateOf("") } + Box(Modifier.fillMaxSize().background(Color(0xFF12321A))) { + Column(Modifier.padding(top = 32.dp, start = 24.dp)) { + BasicText("안녕하세요, no AWT here", style = TextStyle(color = Color.White, fontSize = 24.sp)) + BasicText( + "composed by Compose, painted by Skia, shown by a window of our own", + style = TextStyle(color = Color(0xFF9CCC9C), fontSize = 14.sp), + ) + BasicTextField( + value = typed, + onValueChange = { typed = it }, + modifier = Modifier.padding(top = 16.dp).size(260.dp, 32.dp).background(Color(0xFF1E4620)), + textStyle = TextStyle(color = Color.White, fontSize = 16.sp), + cursorBrush = SolidColor(Color.White), + ) + Box( + Modifier.padding(top = 24.dp).size(220.dp, 56.dp).background(Color(0xFF2E7D32)).clickable { clicks++ }, + ) { + BasicText( + if (clicks == 0) "click me" else "clicked $clicks", + Modifier.padding(16.dp), + style = TextStyle(color = Color.White, fontSize = 18.sp), + ) + } + } + } +} + +/** + * With HELLO_SELF_CHECK set to a path, the window opens, draws a few dozen frames, writes + * how many were presented and how many were drawn at a size other than the window's, and + * quits with status 1 if any was. It is how a build that nobody watches proves that a + * window came up and that every frame it showed was drawn at the size it had. + */ +fun main() { + val check = System.getenv("HELLO_SELF_CHECK") + val host = ComposeWindowHost( + platform = newPlatform(), + config = WindowConfig("Hello AWT-free", 520, 360, minWidth = 240, minHeight = 160), + surfaceFor = ::newSurface, + content = { Content() }, + ) + if (!host.open()) { + System.err.println("hello-awtfree: the window did not open") + System.exit(2) + } + if (check == null) { + host.run() + return + } + val deadline = System.nanoTime() + 20_000_000_000L + try { + while (host.presentLog.frames < 30 && System.nanoTime() < deadline && !host.closed) host.turn(16) + } finally { + val log = host.presentLog + File(check).writeText("frames=${log.frames} mismatched=${log.mismatched}\n") + host.close() + } + if (host.presentLog.frames == 0 || host.presentLog.mismatched != 0) System.exit(1) +}