aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTristan Partin <tristan@partin.io>2022-11-17 15:48:48 -0600
committerTristan Partin <tristan@partin.io>2022-12-11 14:50:26 -0600
commit2e600ef7104d89e1bee602c1cc56822b7f226f43 (patch)
tree8a6e324429fad3f4edf118b7a00812b9a8c463b5
parentb746e92f624a96bc7511a6e48a285ef480ddc6bf (diff)
downloadmeson-2e600ef7104d89e1bee602c1cc56822b7f226f43.zip
meson-2e600ef7104d89e1bee602c1cc56822b7f226f43.tar.gz
meson-2e600ef7104d89e1bee602c1cc56822b7f226f43.tar.bz2
Rename java.generate_native_headers to java.native_headers
This follows the Meson naming scheme which typically leaves off a verb like generate.
-rw-r--r--docs/markdown/Java-module.md44
-rw-r--r--docs/markdown/snippets/java_native_headers.md4
-rw-r--r--mesonbuild/modules/java.py18
-rw-r--r--test cases/java/9 jni/src/com/mesonbuild/meson.build2
4 files changed, 67 insertions, 1 deletions
diff --git a/docs/markdown/Java-module.md b/docs/markdown/Java-module.md
index 54438e2..aa95f78 100644
--- a/docs/markdown/Java-module.md
+++ b/docs/markdown/Java-module.md
@@ -20,6 +20,50 @@ file. If left empty, Meson will assume that there is no package.
### `generate_native_headers()`
*(added in 0.62.0)*
+*(deprecated in 1.0.0, use `native_headers()`)*
+
+This function will generate native header files for use in Java native module
+development by reading the supplied Java files for `native` method declarations.
+
+Keyword arguments:
+
+- `classes`: The list of class names relative to the `package`, if it exists,
+which contain `native` method declarations. Use `.` separated class names.
+
+- `package`: The [package](https://en.wikipedia.org/wiki/Java_package) of the
+file. If left empty, Meson will assume that there is no package.
+
+Example:
+
+```java
+// Outer.java
+
+package com.mesonbuild;
+
+public class Outer {
+ private static native void outer();
+
+ public static class Inner {
+ private static native void inner();
+ }
+}
+```
+
+With the above file, an invocation would look like the following:
+
+```meson
+java = import('java')
+
+native_headers = java.generate_native_headers(
+ 'Outer.java',
+ package: 'com.mesonbuild',
+ classes: ['Outer', 'Outer.Inner']
+)
+```
+
+### `native_headers()`
+
+*(added in 1.0.0)*
This function will generate native header files for use in Java native module
development by reading the supplied Java files for `native` method declarations.
diff --git a/docs/markdown/snippets/java_native_headers.md b/docs/markdown/snippets/java_native_headers.md
new file mode 100644
index 0000000..0c5df09
--- /dev/null
+++ b/docs/markdown/snippets/java_native_headers.md
@@ -0,0 +1,4 @@
+## Deprecate `java.generate_native_headers`, rename to `java.native_headers`
+
+The functions operate in the exact same way. The new name matches more with
+Meson function name styling.
diff --git a/mesonbuild/modules/java.py b/mesonbuild/modules/java.py
index 7f831c2..edc60d3 100644
--- a/mesonbuild/modules/java.py
+++ b/mesonbuild/modules/java.py
@@ -36,6 +36,7 @@ class JavaModule(NewExtensionModule):
super().__init__()
self.methods.update({
'generate_native_headers': self.generate_native_headers,
+ 'native_headers': self.native_headers,
})
def __get_java_compiler(self, state: ModuleState) -> Compiler:
@@ -44,6 +45,7 @@ class JavaModule(NewExtensionModule):
return state.environment.coredata.compilers[MachineChoice.BUILD]['java']
@FeatureNew('java.generate_native_headers', '0.62.0')
+ @FeatureDeprecated('java.generate_native_headers', '1.0.0')
@typed_pos_args(
'java.generate_native_headers',
varargs=(str, mesonlib.File, Target, CustomTargetIndex, GeneratedList))
@@ -53,6 +55,22 @@ class JavaModule(NewExtensionModule):
KwargInfo('package', str, default=None))
def generate_native_headers(self, state: ModuleState, args: T.Tuple[T.List[mesonlib.FileOrString]],
kwargs: T.Dict[str, T.Optional[str]]) -> ModuleReturnValue:
+ return self.__native_headers(state, args, kwargs)
+
+ @FeatureNew('java.native_headers', '1.0.0')
+ @typed_pos_args(
+ 'java.native_headers',
+ varargs=(str, mesonlib.File, Target, CustomTargetIndex, GeneratedList))
+ @typed_kwargs(
+ 'java.native_headers',
+ KwargInfo('classes', ContainerTypeInfo(list, str), default=[], listify=True, required=True),
+ KwargInfo('package', str, default=None))
+ def native_headers(self, state: ModuleState, args: T.Tuple[T.List[mesonlib.FileOrString]],
+ kwargs: T.Dict[str, T.Optional[str]]) -> ModuleReturnValue:
+ return self.__native_headers(state, args, kwargs)
+
+ def __native_headers(self, state: ModuleState, args: T.Tuple[T.List[mesonlib.FileOrString]],
+ kwargs: T.Dict[str, T.Optional[str]]) -> ModuleReturnValue:
classes = T.cast('T.List[str]', kwargs.get('classes'))
package = kwargs.get('package')
diff --git a/test cases/java/9 jni/src/com/mesonbuild/meson.build b/test cases/java/9 jni/src/com/mesonbuild/meson.build
index 2d88c5e..a505b1a 100644
--- a/test cases/java/9 jni/src/com/mesonbuild/meson.build
+++ b/test cases/java/9 jni/src/com/mesonbuild/meson.build
@@ -6,6 +6,6 @@ configured = configure_file(
sources += configured
-native_headers = javamod.generate_native_headers(
+native_headers = javamod.native_headers(
sources, package: 'com.mesonbuild', classes: ['JniTest'])
native_header_includes = include_directories('.')