Merge branch 'java-native-access:master' into master

Author: stmuecke

.github/workflows/ci.yaml

@@ -16,13 +16,9 @@ jobs:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        java: [8, 11, 17, 21, 23-ea]
+        java: [8, 21, 24]
         # macos-13 is x86, macos-latest is aarch64
-        os: [ubuntu-latest, macos-13, macos-latest]
-        exclude:
-          # 23-ea is not available for mac OS
-          - java: 23-ea
-            os: macos-latest
+        os: [ubuntu-latest, ubuntu-24.04-arm, macos-latest, macos-13]
       # Run all tests even if one fails
       fail-fast: false
     name: Test JDK ${{ matrix.java }}, ${{ matrix.os }}
@@ -36,7 +32,9 @@ jobs:
           distribution: 'zulu'
       - name: Linux requirements
         if: contains(matrix.os, 'ubuntu')
-        run: sudo apt-get install -yq --force-yes zip unzip libtool automake libltdl-dev texinfo ant ant-optional debhelper-compat default-jdk javahelper libasm-java libffi-dev libx11-dev libxt-dev maven-repo-helper pkg-config
+        run: |
+          sudo apt-get update
+          sudo apt-get install -yq --allow-downgrades zip unzip libtool automake libltdl-dev texinfo ant ant-optional debhelper-compat default-jdk javahelper libasm-java libffi-dev libx11-dev libxt-dev maven-repo-helper pkg-config
       - name: macOS requirements
         if: contains(matrix.os, 'macos')
         run: |

CHANGES.md

@@ -2,9 +2,33 @@ NOTE: as of JNA 4.0, JNA is now dual-licensed under LGPL and AL 2.0 (see LICENSE
 
 NOTE: JNI native support is typically incompatible between minor versions, and almost always incompatible between major versions.
 
-Next Release (5.16.0)
+Next Release (5.18.0)
 =====================
 
+Features
+--------
+* [#1671](https://github.com/java-native-access/jna/pull/1671): Add `isRISCV` to `c.s.j.Platform` - [@Glavo](https://github.com/Glavo).
+* [#1672](https://github.com/java-native-access/jna/pull/1672): Add `CFLocale`, `CFLocaleCopyCurrent`, `CFCFDateFormatter`, `CFDateFormatterStyle`, `CFDateFormatterCreate` and `CFDateFormatterGetFormat` to `c.s.j.p.mac.CoreFoundation` - [@dbwiddis](https://github.com/dbwiddis).
+
+Bug Fixes
+---------
+
+
+Release (5.17.0)
+================
+
+Features
+--------
+* [#1658](https://github.com/java-native-access/jna/pull/1658):  Add win32 power event constants, types, and functions - [@eranl](https://github.com/eranl).
+
+Bug Fixes
+---------
+* [#1647](https://github.com/java-native-access/jna/issues/1647): Fix calls to jnidispatch on Android with 16KB page size (part 2) - [@BugsBeGone](https://github.com/BugsBeGone).
+
+
+Release 5.16.0
+==============
+
 Features
 --------
 * [#1626](https://github.com/java-native-access/jna/pull/1626): Add caching of field list and field validation in `Structure` along with more efficient reentrant read-write locking instead of synchronized() blocks - [@BrettWooldridge](https://github.com/brettwooldridge)

LICENSE

@@ -1,4 +1,4 @@
-SPDX-License-Identifier: Apache-2.0 OR LGPL-2.1
+SPDX-License-Identifier: Apache-2.0 OR LGPL-2.1-or-later
 
 Java Native Access (JNA) is licensed under the LGPL, version 2.1
 or later, or (from version 4.0 onward) the Apache License,

README.md

@@ -7,7 +7,7 @@
 Java Native Access (JNA)
 ========================
 
-The definitive JNA reference (including an overview and usage details) is in the [JavaDoc](http://java-native-access.github.io/jna/5.15.0/javadoc/).  Please read the [overview](http://java-native-access.github.io/jna/5.15.0/javadoc/overview-summary.html#overview_description).  Questions, comments, or exploratory conversations should begin on the [mailing list](http://groups.google.com/group/jna-users), although you may find it easier to find answers to already-solved problems on [StackOverflow](http://stackoverflow.com/questions/tagged/jna).
+The definitive JNA reference (including an overview and usage details) is in the [JavaDoc](http://java-native-access.github.io/jna/5.17.0/javadoc/).  Please read the [overview](http://java-native-access.github.io/jna/5.17.0/javadoc/overview-summary.html#overview_description).  Questions, comments, or exploratory conversations should begin on the [mailing list](http://groups.google.com/group/jna-users), although you may find it easier to find answers to already-solved problems on [StackOverflow](http://stackoverflow.com/questions/tagged/jna).
 
 JNA provides Java programs easy access to native shared libraries without writing anything but Java code - no JNI or native code is required. This functionality is comparable to Windows' Platform/Invoke and Python's ctypes.
 
@@ -66,20 +66,20 @@ Pre-built platform support may be found [here](https://github.com/java-native-ac
 Download
 ========
 
-Version 5.15.0
+Version 5.17.0
 
 JNA
 ---
 
-[![Maven Central](https://img.shields.io/maven-central/v/net.java.dev.jna/jna.svg?label=Maven%20Central)](https://search.maven.org/artifact/net.java.dev.jna/jna/5.15.0/jar) [jna-5.15.0.jar](https://repo1.maven.org/maven2/net/java/dev/jna/jna/5.15.0/jna-5.15.0.jar) [jna-jpms-5.15.0.jar](https://repo1.maven.org/maven2/net/java/dev/jna/jna-jpms/5.15.0/jna-jpms-5.15.0.jar)
+[![Maven Central](https://img.shields.io/maven-central/v/net.java.dev.jna/jna.svg?label=Maven%20Central)](https://search.maven.org/artifact/net.java.dev.jna/jna/5.17.0/jar) [jna-5.17.0.jar](https://repo1.maven.org/maven2/net/java/dev/jna/jna/5.17.0/jna-5.17.0.jar) [jna-jpms-5.17.0.jar](https://repo1.maven.org/maven2/net/java/dev/jna/jna-jpms/5.17.0/jna-jpms-5.17.0.jar)
 
 This is the core artifact of JNA and contains only the binding library and the
 core helper classes.
 
 JNA Platform
 ------------
 
-[![Maven Central](https://img.shields.io/maven-central/v/net.java.dev.jna/jna-platform.svg?label=Maven%20Central)](https://search.maven.org/artifact/net.java.dev.jna/jna-platform/5.15.0/jar) [jna-platform-5.15.0.jar](https://repo1.maven.org/maven2/net/java/dev/jna/jna-platform/5.15.0/jna-platform-5.15.0.jar) [jna-platform-jpms-5.15.0.jar](https://repo1.maven.org/maven2/net/java/dev/jna/jna-platform-jpms/5.15.0/jna-platform-jpms-5.15.0.jar)
+[![Maven Central](https://img.shields.io/maven-central/v/net.java.dev.jna/jna-platform.svg?label=Maven%20Central)](https://search.maven.org/artifact/net.java.dev.jna/jna-platform/5.17.0/jar) [jna-platform-5.17.0.jar](https://repo1.maven.org/maven2/net/java/dev/jna/jna-platform/5.17.0/jna-platform-5.17.0.jar) [jna-platform-jpms-5.17.0.jar](https://repo1.maven.org/maven2/net/java/dev/jna/jna-platform-jpms/5.17.0/jna-platform-jpms-5.17.0.jar)
 
 This artifact holds cross-platform mappings and mappings for a number of commonly used platform
 functions, including a large number of Win32 mappings as well as a set of utility classes
@@ -147,12 +147,12 @@ Using the Library
 * [Platform Library](https://github.com/java-native-access/jna/blob/master/www/PlatformLibrary.md)
 * [Direct Method Mapping](https://github.com/java-native-access/jna/blob/master/www/DirectMapping.md) (Optimization)
 * [Frequently Asked Questions (FAQ)](https://github.com/java-native-access/jna/blob/master/www/FrequentlyAskedQuestions.md)
-* [Avoiding Crashes](http://java-native-access.github.io/jna/5.15.0/javadoc/overview-summary.html#crash-protection)
+* [Avoiding Crashes](http://java-native-access.github.io/jna/5.17.0/javadoc/overview-summary.html#crash-protection)
 
 Primary Documentation (JavaDoc)
 ===============================
 
-The definitive JNA reference is in the [JavaDoc](http://java-native-access.github.io/jna/5.15.0/javadoc/).
+The definitive JNA reference is in the [JavaDoc](http://java-native-access.github.io/jna/5.17.0/javadoc/).
 
 Developers
 ==========

build.xml

@@ -424,6 +424,7 @@ osname=macosx;processor=aarch64
               <attribute name="Multi-Release" value="true"/>
           </manifest>
           <manifest file="@{target}" mode="update" unless:true="@{module-info}">
+              <attribute name="ModuleMainClass" value="com.sun.jna.Native"/>
               <attribute name="Automatic-Module-Name" value="com.sun.jna"/>
           </manifest>
       </sequential>
@@ -433,6 +434,7 @@ osname=macosx;processor=aarch64
     <build-manifest target="${build}/manifest/module.mf" module-info="true"/>
     <build-manifest target="${build}/manifest/automatic.mf" module-info="false"/>
     <ModuleGenerator
+        mainClass="com.sun.jna.Native"
         targetFile="${build}/manifest/module-info.class"
         name="com.sun.jna"
         version="${jna.major}.${jna.minor}.${jna.revision}"
@@ -1235,6 +1237,10 @@ cd ..
       <propertyref prefix="java.awt.headless"/>
     </propertyset>
     <junit fork="${test.fork}" forkmode="${test.forkmode}" failureproperty="testfailure" tempdir="${build}">
+      <!-- let JVM ignore unknown flags -->
+      <jvmarg value="-XX:+IgnoreUnrecognizedVMOptions" />
+      <!-- enable JNI on JDK 24+ -->
+      <jvmarg value="--enable-native-access=ALL-UNNAMED" />
       <jvmarg if:set="test.jdwp" value="${test.jdwp}" />
       <!-- optionally run headless -->
       <syspropertyset refid="headless"/>
@@ -1315,6 +1321,7 @@ cd ..
     <javadoc package="true"
              windowtitle="JNA API"
              encoding="UTF-8"
+             locale="en_US"
              sourcepathref="javadoc.src.path"
              classpathref="javadoc.compile.path"
              maxmemory="256m"
@@ -1343,7 +1350,16 @@ cd ..
       <group title="Platform Specific" packages="com.sun.jna.platform.*"/>
 
       <arg value="-notimestamp"/>
+      <!-- force locale to be "en_US", as Javadoc tool ignores locale parameter for some texts -->
+      <arg line="-J-Duser.language=en -J-Duser.country=US"/>
     </javadoc>
+    <!--
+    Create an empty resources/fonts/dejavu.css - the file is reference by default
+    javadoc output, yet not provided by it. People seem to be irritated by the
+    generated 404, so provide an empty file.
+    -->
+    <mkdir dir="${javadoc}/resources/fonts/" />
+    <echo file="${javadoc}/resources/fonts/dejavu.css">/* Intentionally left empty */</echo>
     <jar jarfile="${platform-javadoc-jar}" createUnicodeExtraFields="never" encoding="UTF-8">
       <fileset dir="${javadoc}" />
     </jar>

common.xml

@@ -8,7 +8,7 @@
 
     <!-- JNA library release version - android versionCode is derived from mjar/minor/revision -->
     <property name="jna.major" value="5"/>
-    <property name="jna.minor" value="16"/>
+    <property name="jna.minor" value="18"/>
     <property name="jna.revision" value="0"/>
     <property name="jna.build" value="0"/> <!--${build.number}-->
     <condition property="version.suffix" value="" else="-SNAPSHOT">
@@ -22,7 +22,7 @@
     <!-- jnidispatch library release version -->
     <property name="jni.major" value="7"/>
     <property name="jni.minor" value="0"/>
-    <property name="jni.revision" value="3"/>
+    <property name="jni.revision" value="4"/>
     <property name="jni.build" value="0"/> <!--${build.number}-->
     <property name="jni.version" value="${jni.major}.${jni.minor}.${jni.revision}"/>
     <property name="jni.md5" value="5fb98531302accd485c534c452dd952a"/>

contrib/platform/build.xml

@@ -317,6 +317,10 @@ com.sun.jna.platform.wince;version="${osgi.version}";uses:="com.s
         <propertyref name="w32.ascii"/>
       </propertyset>
       <junit fork="${test.fork}" failureproperty="testfailure" tempdir="${build}">
+        <!-- let JVM ignore unknown flags -->
+        <jvmarg value="-XX:+IgnoreUnrecognizedVMOptions" />
+        <!-- enable JNI on JDK 24+ -->
+        <jvmarg value="--enable-native-access=ALL-UNNAMED" />
         <jvmarg if:set="test.jdwp" value="${test.jdwp}" />
         <!-- optionally run headless -->
         <syspropertyset refid="headless"/>

contrib/platform/src/com/sun/jna/platform/mac/CoreFoundation.java

@@ -1142,4 +1142,70 @@ CFMutableDictionaryRef CFDictionaryCreateMutable(CFAllocatorRef alloc, CFIndex c
      * @return The type identifier for the {@code CFString} opaque type.
      */
     CFTypeID CFStringGetTypeID();
+
+    /**
+     * The CFLocale opaque type provides support for obtaining available locales, obtaining localized locale names, and converting among locale data formats.
+     */
+    class CFLocale extends CFTypeRef {
+    }
+
+    /**
+     * Returns a copy of the logical locale for the current user.
+     * @return The logical locale for the current user that is formed from the settings for the current user’s
+     *         chosen system locale overlaid with any custom settings the user has specified in System Preferences.
+     *         May return a retained cached object, not a new object.
+     *         <p>
+     *         This reference must be released with {@link #CFRelease} to avoid leaking references.
+     */
+    CFLocale CFLocaleCopyCurrent();
+
+    /**
+     * CFDateFormatter objects format the textual representations of CFDate and CFAbsoluteTime objects, and convert textual representations of dates and times into CFDate and CFAbsoluteTime objects.
+     */
+    class CFDateFormatter extends CFTypeRef {
+    }
+
+    /**
+     * Enum of values used for {@link CFDateFormatterStyle} in {@link #CFDateFormatterCreate}.
+     * Use {@link CFDateFormatterStyle#index} for the expected integer value corresponding to the C-style enum.
+     */
+    enum CFDateFormatterStyle {
+        kCFDateFormatterNoStyle,
+        kCFDateFormatterShortStyle,
+        kCFDateFormatterMediumStyle,
+        kCFDateFormatterLongStyle,
+        kCFDateFormatterFullStyle;
+
+        /**
+         * Style for the type of {@link CFDateFormatterStyle} stored.
+         *
+         * @return a {@link CFIndex} representing the enum ordinal.
+         */
+        public CFIndex index() {
+            return new CFIndex(this.ordinal());
+        }
+    }
+
+    /**
+     * Creates a new CFDateFormatter object, localized to the given locale, which will format dates to the given date and time styles.
+     * @param allocator The allocator to use to allocate memory for the new object.
+     *                  Pass {@code null} or {@code kCFAllocatorDefault} to use the current default allocator.
+     * @param locale    The locale to use for localization.
+     *                  If {@code null} uses the default system locale.
+     *                  Use {@link #CFLocaleCopyCurrent()} to specify the locale of the current user.
+     * @param dateStyle The date style to use when formatting dates.
+     * @param timeStyle The time style to use when formatting times.
+     * @return A new date formatter, localized to the given locale, which will format dates to the given date and time styles.
+     *         Returns {@code null} if there was a problem creating the object.
+     *         <p>
+     *         This reference must be released with {@link #CFRelease} to avoid leaking references.
+     */
+    CFDateFormatter CFDateFormatterCreate(CFAllocatorRef allocator, CFLocale locale, CFIndex dateStyle, CFIndex timeStyle);
+
+    /**
+     * Returns a format string for the given date formatter object.
+     * @param formatter The date formatter to examine.
+     * @return The format string for {@code formatter}.
+     */
+    CFStringRef CFDateFormatterGetFormat(CFDateFormatter formatter);
 }

contrib/platform/src/com/sun/jna/platform/win32/WinNT.java

@@ -4420,4 +4420,6 @@ public IO_COUNTERS(Pointer memory) {
     class TOKEN_ELEVATION extends Structure {
         public int TokenIsElevated;
     }
+
+    Guid.GUID GUID_CONSOLE_DISPLAY_STATE = new Guid.GUID("6FE69556-704A-47A0-8F24-C28D936FDA47");
 }

contrib/platform/src/com/sun/jna/platform/win32/WinUser.java

@@ -30,7 +30,6 @@
 import com.sun.jna.Structure.FieldOrder;
 import com.sun.jna.Union;
 import com.sun.jna.platform.win32.BaseTSD.ULONG_PTR;
-import com.sun.jna.platform.win32.WinDef.HKL;
 import com.sun.jna.platform.win32.WinNT.HANDLE;
 import com.sun.jna.win32.StdCallLibrary.StdCallCallback;
 import com.sun.jna.win32.W32APITypeMapper;
@@ -2088,4 +2087,79 @@ public String toString() {
      * Bitmask for the RESERVED2 key modifier.
      */
     int MODIFIER_RESERVED2_MASK = 32;
+
+    class HPOWERNOTIFY extends PVOID {
+        public HPOWERNOTIFY() {
+        }
+
+        public HPOWERNOTIFY(Pointer pointer) {
+            super(pointer);
+        }
+    }
+
+    /**
+     * Registers the application to receive power setting notifications for the specific power setting event.
+     * @param hRecipient Handle indicating where the power setting notifications are to be sent.
+     *                   For interactive applications, the Flags parameter should be DEVICE_NOTIFY_WINDOW_HANDLE,
+     *                   and the hRecipient parameter should be a window handle.
+     *                   For services, the Flags parameter should be DEVICE_NOTIFY_SERVICE_HANDLE, and the hRecipient
+     *                   parameter should be a SERVICE_STATUS_HANDLE as returned from RegisterServiceCtrlHandlerEx.
+     * @param PowerSettingGuid The GUID of the power setting for which notifications are to be sent.
+     * @param Flags
+     *   <li>DEVICE_NOTIFY_WINDOW_HANDLE - Notifications are sent using WM_POWERBROADCAST messages
+     *   with a wParam parameter of PBT_POWERSETTINGCHANGE.
+     *   <li>DEVICE_NOTIFY_SERVICE_HANDLE - Notifications are sent to the HandlerEx callback function with a dwControl
+     *   parameter of SERVICE_CONTROL_POWEREVENT and a dwEventType of PBT_POWERSETTINGCHANGE.
+     * @return a notification handle for unregistering for power notifications. If the function fails, the return
+     * value is NULL. To get extended error information, call GetLastError.
+     */
+    HPOWERNOTIFY RegisterPowerSettingNotification(
+            /*[in]*/ HANDLE hRecipient,
+            /*[in]*/ Guid.GUID PowerSettingGuid,
+            /*[in]*/ int Flags);
+
+    /**
+     * Unregisters the power setting notification.
+     * @param Handle The handle returned from the RegisterPowerSettingNotification function.
+     * @return If the function succeeds, the return value is nonzero.
+     * If the function fails, the return value is zero. To get extended error information, call GetLastError.
+     */
+    BOOL UnregisterPowerSettingNotification(
+            /*[in]*/ HPOWERNOTIFY Handle
+    );
+
+    int WM_POWERBROADCAST = 0x0218;
+
+    int PBT_APMQUERYSUSPEND = 0x0000;
+    int PBT_APMQUERYSTANDBY = 0x0001;
+    int PBT_APMQUERYSUSPENDFAILED = 0x0002;
+    int PBT_APMQUERYSTANDBYFAILED = 0x0003;
+    int PBT_APMSUSPEND = 0x0004;
+    int PBT_APMSTANDBY = 0x0005;
+    int PBT_APMRESUMECRITICAL = 0x0006;
+    int PBT_APMRESUMESUSPEND = 0x0007;
+    int PBT_APMRESUMESTANDBY = 0x0008;
+    int PBT_APMBATTERYLOW = 0x0009;
+    int PBT_APMPOWERSTATUSCHANGE = 0x000A;
+    int PBT_APMOEMEVENT = 0x000B;
+    int PBT_APMRESUMEAUTOMATIC = 0x0012;
+    int PBT_POWERSETTINGCHANGE = 0x8013;
+
+    @FieldOrder({"PowerSetting", "DataLength", "Data"})
+    class POWERBROADCAST_SETTING extends Structure {
+        public Guid.GUID PowerSetting;
+        public int DataLength;
+        public byte Data[] = new byte[1];
+
+        public POWERBROADCAST_SETTING(Pointer p) {
+            super(p);
+            read();
+        }
+
+        @Override
+        public final void read() {
+            Data = new byte[getPointer().getInt(fieldOffset("DataLength"))];
+            super.read();
+        }
+    }
 }