From 9dd35877f28f5d3dce5e1817edd33bb8f6dbbe36 Mon Sep 17 00:00:00 2001 From: Sven Gothel Date: Sun, 18 Jun 2023 03:43:32 +0200 Subject: Bring back produced html5 standalone files, having fixed pandoc usage. See my pandoc-buttondown git repo Latest config fixed creation of standalone html5 files. --- doc/GlueGen_Mapping.html | 1580 ++++++++++++++++++++++++++++++++++++++++++ doc/JogAmpMacOSVersions.html | 577 +++++++++++++++ 2 files changed, 2157 insertions(+) create mode 100644 doc/GlueGen_Mapping.html create mode 100644 doc/JogAmpMacOSVersions.html (limited to 'doc') diff --git a/doc/GlueGen_Mapping.html b/doc/GlueGen_Mapping.html new file mode 100644 index 0000000..20e9265 --- /dev/null +++ b/doc/GlueGen_Mapping.html @@ -0,0 +1,1580 @@ + + + + + + + GlueGen_Mapping.md + + + + + + +

GlueGen Native +Data & Function Mapping for Java™

References

Overview

GlueGen is a compiler +for function and data-structure declarations, generating Java and JNI C +code offline at compile time and allows using native libraries within +your Java application.

It reads ANSI C header files and separate configuration files which +provide control over many aspects of the glue code generation. GlueGen +uses a complete ANSI C parser and an internal representation (IR) +capable of representing all C types to represent the APIs for which it +generates interfaces. It has the ability to perform significant +transformations on the IR before glue code emission.

GlueGen can produce native foreign function bindings to Java as well +as map native data structures to be fully accessible from Java including +potential calls to embedded function pointer.

GlueGen is also capable to bind even low-level APIs such as the Java +Native Interface (JNI) and the AWT Native Interface (JAWT) back up to +the Java programming language.

GlueGen utilizes JCPP, migrated C +preprocessor written in Java.

GlueGen is used for the JogAmp +projects JOAL, JOGL and JOCL.

GlueGen is part of the JogAmp +project.

Primitive Mapping

Gluegen has build-in types (terminal symbols) for:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

type	java-bits	native-bits x32	native bits x64	type	signed	origin
void	0	0	0	void	void	ANSI-C
char	8	8	8	integer	any	ANSI-C
short	16	16	16	integer	any	ANSI-C
int	32	32	32	integer	any	ANSI-C
long	64	32	32†	integer	any	ANSI-C - Windows
long	64	32	64	integer	any	ANSI-C - Unix
float	32	32	32	float	signed	ANSI-C
double	64	64	64	double	signed	ANSI-C
__int32	32	32	32	integer	any	windows
__int64	64	64	64	integer	any	windows
int8_t	8	8	8	integer	signed	stdint.h
uint8_t	8	8	8	integer	unsigned	stdint.h
int16_t	16	16	16	integer	signed	stdint.h
uint16_t	16	16	16	integer	unsigned	stdint.h
int32_t	32	32	32	integer	signed	stdint.h
uint32_t	32	32	32	integer	unsigned	stdint.h
int64_t	64	64	64	integer	signed	stdint.h
uint64_t	64	64	64	integer	unsigned	stdint.h
intptr_t	64	32	64	integer	signed	stdint.h
uintptr_t	64	32	64	integer	unsigned	stdint.h
ptrdiff_t	64	32	64	integer	signed	stddef.h
size_t	64	32	64	integer	unsigned	stddef.h
wchar_t	32	32	32	integer	signed	stddef.h

Warning: Try to avoid unspecified bit sized types, +especially long, since it differs on Unix and +Windows!
+Notes:

† Type long will result in broken code on Windows, +since we don't differentiate the OS and it's bit size is ambiguous.
Anonymous void-pointer void* are mapped to NIO +Buffer.
Pointers to pointer-size types like intptr_t*, +uintptr_t*, ptrdiff_t* and size_t* are mapped +to PointerBuffer, to reflect the architecture depending storage +size.

String Mapping

Function return String +values

Function return values are currently mapped from char* +to Java String using UTF-8 via JNI function

+
jstring NewStringUTF(JNIEnv *env, const char *bytes)
+

FIXME: This might need more flexibility in case UTF-8 is not +suitable for 8-bit wide char mappings or wide characters, +e.g. for UTF-16 needs to be supported.

Function argument String +values

Function argument values are either mapped from char* to +Java String using UTF-8 via JNI function

+
const char * GetStringUTFChars(JNIEnv *env, jstring string, jboolean *isCopy).
+

Alternatively, if a 16-bit wide character type has been +detected, i.e. short, the native character are mapped +to Java using UTF-16 via JNI function

+
void GetStringRegion(JNIEnv *env, jstring str, jsize start, jsize len, jchar *buf).
+

Struct String mapping

String value mapping for Struct fields is performed +solely from the Java side using Charset and is hence most +flexible.

By default, UTF-8 is being used for getter and setter of +String values.
+The Struct class provides two methods to get and set the used +Charset for conversion

  /** Returns the Charset for this class's String mapping, default is StandardCharsets.UTF_8. */
+  public static Charset getCharset() { return _charset; };
+
+  /** Sets the Charset for this class's String mapping, default is StandardCharsets.UTF_8. */
+  public static void setCharset(Charset cs) { _charset = cs; }
+

In case the String length has not been configured via +ReturnedArrayLength, it will be dynamically calculated via +strnlen(aptr, max_len).
+The maximum length default for the strnlen(..) operation is +8192 bytes and can be get and set using:

  /** Returns the maximum number of bytes to read to determine native string length using `strnlen(..)`, default is 8192. */
+  public static int getMaxStrnlen() { return _max_strnlen; };
+
+  /** Sets the maximum number of bytes to read to determine native string length using `strnlen(..)`, default is 8192. */
+  public static void setMaxStrnlen(int v) { _max_strnlen = v; }

FIXME: This only works reliable using an 8-bit Charset +encoding, e.g. the default UTF-8.

Alignment for Compound Data

In general, depending on CPU and it's configuration (OS), alignment +is set up for each type (char, short, int, long, ..).

Compounds (structures) are aligned naturally, i.e. their inner +components are aligned
+and are itself aligned to it's largest element.

See:

Wikipedia +Data Structure Alignment
Wikipedia +Data Structure Alignment - Padding
Viva64 Data +Alignment
Apple: +Darwin 64bit Porting - Data Type Size & Alignment

Simple alignment arithmetic

Modulo operation, where the 2nd handles the case offset == +alignment:

+
padding = ( alignment - ( offset % alignment ) ) % alignment ;
+aligned_offset = offset + padding ;
+

Optimization utilizing alignment as a multiple of 2 +-> x % 2n == x & ( 2n - 1 )

+
remainder = offset & ( alignment - 1 ) ;
+padding = ( remainder > 0 ) ? alignment - remainder : 0 ;
+aligned_offset = offset + padding ;
+

Without branching, using the 2nd modulo operation for the case offset +== alignment:

+
padding = ( alignment - ( offset & ( alignment - 1 ) ) ) & ( +alignment - 1 ) ;
+aligned_offset = offset + padding ;
+

See +com.jogamp.gluegen.cgram.types.SizeThunk.align(..).

Type +Size & Alignment for x86, x86_64, armv6l-32bit-eabi and +Window(mingw/mingw64)

Runtime query is implemented as follows:

   typedef struct {
+     char   fill;  // nibble one byte
+                   // padding to align s1: padding_0 
+     type_t s1;    // 
+   } test_struct_type_t;
+  
+             padding_0 = sizeof(test_struct_type_t) - sizeof(type_t) - sizeof(char) ;
+   alignmentOf(type_t) = sizeof(test_struct_type_t) - sizeof(type_t) ;

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

type	size 32 bit	alignment 32 bit	size 64 bit	alignment 64 bit
char	1	1	1	1
short	2	2	2	2
int	4	4	4	4
float	4	4	4	4
long	4	4	8†,4∗	8†,4∗
pointer	4	4	8	8
long long	8	4†,8∗+	8	8
double	8	4†,8∗+	8	8
long double	12†∗,8+,16-	4†∗,8+,16-	16	16

† Linux, Darwin
++armv7l-eabi
+- MacOsX-32bit-gcc4
+∗ Windows

Struct Mapping

A Struct is a C compound type declaration, which can be +mapped to a Java class.

A Struct may utilize the following data types for its +fields

Primitive, i.e. char, int32_t, ... +
- See Primitive Mapping +above.
- See String Mapping +above.
Struct, i.e. another compound variable
Function Pointer, a typedef'ed and set callable +function pointer

A field may be a direct aggregation, i.e. instance, within the struct +including an array or a reference to a single element or array via a +pointer.

Both, primitive and struct field type mappings only +produce pure Java code, utilizing the GlueGen Runtime. Hence no +additional native code must be compiled nor a resulting additional +library loaded to use the mapping.

Only when mapping function-pointer within structs, +additional native glue-code is produced to call the underlying native +function which has to be compiled and its library loaded.

The generated method +public static boolean usesNativeCode() can be used to +validate whether the produced Java class requires a corresponding +library for additional native code.

GlueGen Struct Settings

ImmutableAccess +symbol

Immutable access can be set for a whole struct or a single field of a +struct.

Immutable access will simply suppress generating setters in the Java +code and hence also reduces the footprint of the generated Java class +for such struct.

ImmutableAccess TK_Struct
+
Immutable access for the whole struct `TK_Struct
+
Sets pseudo-code flag ImmutableAccess, see below.
ImmutableAccess TK_Struct.val
+
Immutable access for the single field val within struct +TK_Struct
+
Sets pseudo-code flag ImmutableAccess, see below.

MaxOneElement +symbol

MaxOneElement TK_Struct.val
+
Sets field pointer val to point to a array with a +maximum of one element and unset initial value (zero elements).
+
Sets pseudo-code flag MaxOneElement, see below.

ReturnedArrayLength +symbol expression

ReturnedArrayLength TK_Struct.val 3
+
Sets field pointer val to point to a array with three +elements.
+
Sets pseudo-code flag ConstElemCount, see below.
+
Having set ConstElemCount also implies native +ownership for a Pointer referenced native +memory.
ReturnedArrayLength TK_Struct.val 1
+
Sets field pointer val to point to a array with one +element.
+
Sets pseudo-code flags ConstElemCount and +MaxOneElement, see below.
+
Having set ConstElemCount also implies native +ownership for a Pointer referenced native +memory.
ReturnedArrayLength TK_Struct.val getValElements()
+
Sets field pointer val to point to a array with a +variable length as described by the field valElements +retrievable via its getter getValElements().
+
Sets pseudo-code flag VariaElemCount, see below.

ReturnsString +symbol

A direct C code char array or indirect array via pointer +can be interpreted as a Java String.

ReturnsString TK_Struct.name
+
Sets field char-array or char-pointer name to be +additionally interpreted as a Java String. Besides the +byte[] and ByteBuffer getter and setter +variants, a String variant will be added.
+
Sets pseudo-code flags String, see below.
+
See String Mapping +above.

ReturnsStringOnly +symbol

ReturnsStringOnly TK_Struct.name
+
Sets field char-array or char-pointer name to be +exclusively interpreted as a Java String. Instead of the +byte[] and ByteBuffer getter and setter +variants, a String variant will be produced.
+
Sets pseudo-code flags StringOnly, see below.
+
See String Mapping +above.

Struct Mapping Notes

ConstElemCount via ReturnedArrayLength +<int> implies native ownership for a +Pointer referenced native memory if the expression is +constant. Otherwise the native memory has java +ownership. See ReturnedArrayLength +Setting above.
Utilizing a flexible elemCount via +ReturnedArrayLength getValElements() renders us unable +to determine ownership of pointer referenced native memory +segment and hence renders ownership mixed or ambiguous, see +[5]. This is due to the fact, that native code may allocate memory +and writes its elemCount into the designated field +valElements. In such cases, the user being aware of the +underlying API shall utilize setVal(..) and +releaseVal() with care.
To release native memory with java ownership, i.e. a +native ByteBuffer, releaseVal() can be used.

Struct Java Signature Table

Please find below signature table as generated by the C +Declaration including its C Modifier, e.g. +const for constant, [const] for const and +non-const and empty for non-const (variable).

Further, the GlueGen Setting (see above) impacts the code +generation as well.

Below table demonstrates primitive types being mapped within +a struct named TK_Struct. A similar mapping is +produced for struct types, i.e. compounds.

C Mod	C Declaration	Java Setter	Java Getter	GlueGen Setting	Ownership	Remarks
			static boolean usesNativeCode()			Java, static, true if using +native code
			static int size()			Java, static, native size in +bytes
			static TK_Struct create()			Java, static ctor
			static TK_Struct create(ByteBuffer)			Java, static ctor w/ existing +ByteBuffer
			static TK_Struct derefPointer(long +addr)			Java, static ctor dereferencing +ByteBuffer at native address of size()
			ByteBuffer getBuffer()			Java, underlying ByteBuffer
			long getDirectBufferAddress()			Java, native address of underlying +getBuffer()
	int32_t val	setVal(int v)	int getVal()		Parent
const	int32_t val	none	int getVal()		Parent	Read only
	int32_t val	none	int getVal()	ImmutableAccess	Parent	Read only
[const]	int32_t* val	setVal(int v) [1][2] +releaseVal()	int getVal() boolean isValNull() +int getValElemCount()	MaxOneElement	Java	Starts w/ null elements, max 1 +element
const	int32_t* val	none	int getVal() boolean isValNull() +static int getValElemCount()	ReturnedArrayLength +1	Native	Const element count 1
	int32_t* val	setVal(int v)	int getVal() boolean isValNull() +static int getValElemCount()	ReturnedArrayLength +1	Native	Const element count 1
	int32_t val[3]	setVal(int[] src, int srcPos, int destPos, +int len)	IntBuffer getVal() int[] getVal(int +srcPos, int[] dest, int destPos, int len)		Parent
const	int32_t val[3]	none	IntBuffer getVal() int[] getVal(int +srcPos, int[] dest, int destPos, int len)		Parent	Read only
const	int32_t* val	none	IntBuffer getVal() int[] getVal(int +srcPos, int[] dest, int destPos, int len) boolean isValNull() +static int getValElemCount()	ReturnedArrayLength +3	Native	Read only Const element count 3
	int32_t* val	setVal(int[] src, int srcPos, int destPos, +int len) [2]	IntBuffer getVal() int[] getVal(int +srcPos, int[] dest, int destPos, int len) boolean isValNull() +static int getValElemCount()	ReturnedArrayLength +3	Native	Const element count 3
	int32_t* val	setVal(boolean subset, int[] src, int +srcPos, int destPos, int len) [3] +releaseVal()	IntBuffer getVal() int[] getVal(int +srcPos, int[] dest, int destPos, int len) boolean isValNull() +int getValElemCount()		Java	Starts w/ null elements
const	int32_t* val	setVal(int[] src, int srcPos, int destPos, +int len) [4] + releaseVal()	IntBuffer getVal() int[] getVal(int +srcPos, int[] dest, int destPos, int len) boolean isValNull() +int getValElemCount()		Java	Starts w/ null elements
[const]	int32_t* val	setVal(int[] src, int srcPos, int destPos, +int len) [5] + releaseVal()	IntBuffer getVal() int[] getVal(int +srcPos, int[] dest, int destPos, int len) boolean isValNull()	ReturnedArrayLength +getValCount()	Ambiguous	Variable element count using field +valCount, which has getter and setter
[const]	char* name	setName(String srcVal) +releaseVal()	String getName() boolean isNameNull() + int getNameElemCount()	ReturnsStringOnly	Java	String only, w/ EOS
[const]	char* name	setName(String srcVal) setName(byte[] +src, int srcPos, int destPos, int len) releaseVal()	String getNameAsString() ByteBuffer +getName() boolean isNameNull() int getNameElemCount()	ReturnsString	Java	String and byte access, w/ EOS

Struct Java Signature +Examples

Signature +`int32_t *` MaxOneElement, Java owned

void com.jogamp.gluegen.test.junit.generation.TK_Field.setVariaInt32PointerMaxOneElemElemCount(int src)
+
Setter for native field variaInt32PointerMaxOneElem, referencing a +Java owned array with variable element count of 0 initial elements.
+
Maximum element count is 1.
+
Native Signature:
+
- field-type (PointerType) 'int32_t ' -> (int32_t) * , size +[fixed false, lnx64 8], const[false], pointer1
- referenced (IntType) typedef 'int32_t', size [fixed true, lnx64 4], +const[false], int
+
Will reuse memory if existing, otherwise allocating memory.

Signature +`const int32_t *` MaxOneElement, Java owned

TK_Field com.jogamp.gluegen.test.junit.generation.TK_Field.setConstInt32PointerMaxOneElem(int src)
+
Setter for native field variaInt32PointerMaxOneElem, referencing a +Java owned array with variable element count of 0 initial elements.
+
Maximum element count is 1.
+
Native Signature:
+
- field-type (PointerType) 'int32_t ' -> (const int32_t) * , +size [fixed false, lnx64 8], const[false], pointer1
- referenced (IntType) typedef 'int32_t', size [fixed true, lnx64 4], +const[native, true], int
+
Always replaces memory due to const value +modifier.

Signature +`int32_t *` ConstElemCount 3, Natively owned

TK_Field com.jogamp.gluegen.test.junit.generation.TK_Field.setVariaInt32PointerConstLen(int[] src, int srcPos, int destPos, int length)
+
Setter for native field variaInt32PointerConstLen, referencing a +natively owned array with fixed element count of 3 elements.
+
Native Signature:
+
- field-type (PointerType) 'int32_t ' -> (int32_t) * , size +[fixed false, lnx64 8], const[false], pointer1
- referenced (IntType) typedef 'int32_t', size [fixed true, lnx64 4], +const[false], int
+
Copies the given source elements into the respective field's existing +memory.
+
Parameters:
+
- src the source array of elements
- srcPos starting element position within the source array with +'srcPos >= 0&&srcPos + length <= src.length`, +otherwise an IndexOutOfBoundsException is thrown
- destPos starting element position within the destination with +'destPos >= 0&&destPos + length <= +elemCount`, otherwise an exception is thrown
- length the element count to be copied with 'length >= +0&&srcPos + length <= +src.length&&destPos + length <= elemCount`, +otherwise an IndexOutOfBoundsException is thrown
+
Returns:
+
- this instance of chaining

Signature +`int32_t *` FreeSize, Java owned

TK_Field com.jogamp.gluegen.test.junit.generation.TK_Field.setVariaInt32PointerVariaLen(boolean subset, int[] src, int srcPos, int destPos, int length)
+
Setter for native field variaInt32PointerVariaLen, referencing a Java +owned array with variable element count of 0 initial elements.
+
Native Signature:
+
- field-type (PointerType) 'int32_t ' -> (int32_t) * , size +[fixed false, lnx64 8], const[false], pointer1
- referenced (IntType) typedef 'int32_t', size [fixed true, lnx64 4], +const[false], int
+
Copies the given source elements into the respective field, either +writing into the existing memory or creating a new memory and +referencing it.
+
Parameters:
+
- subset if true keeps the underlying memory and only +allows to set up to elemCount elements. Otherwise may +replace the underlying memory if +destPos + length != elemCount.
- src the source array of elements
- srcPos starting element position within the source array with +'srcPos >= 0&&srcPos + length <= src.length`, +otherwise an IndexOutOfBoundsException is thrown
- destPos starting element position within the destination with +'destPos >= 0. If subset == true, destPos + +length <= elemCountalso must be betrue`. Otherwise an +exception is thrown
- length the element count to be copied with 'length >= +0&&srcPos + length <= src.length`, otherwise an +IndexOutOfBoundsException is thrown
+
Returns:
+
- this instance of chaining

Signature +`const int32_t *` FreeSize, Java owned

TK_Field com.jogamp.gluegen.test.junit.generation.TK_Field.setConstInt32PointerVariaLen(int[] src, int srcPos, int length)
+
Setter for native field constInt32PointerVariaLen, referencing a Java +owned array with variable element count of 0 initial elements.
+
Native Signature:
+
- field-type (PointerType) 'int32_t ' -> (const int32_t) * , +size [fixed false, lnx64 8], const[false], pointer1
- referenced (IntType) typedef 'int32_t', size [fixed true, lnx64 4], +const[native, true], int
+
Replaces the respective field's memory with a new memory segment +containing given source elements and referencing it.
+
Parameters:
+
- src the source array of elements
- srcPos starting element position within the source array with +'srcPos >= 0&&srcPos + length <= src.length`, +otherwise an IndexOutOfBoundsException is thrown
- length the element count to be copied with 'length >= +0&&srcPos + length <= src.length`, otherwise an +IndexOutOfBoundsException is thrown
+
Returns:
+
- this instance of chaining

Signature +`const int32_t *` CustomSize, Ambiguous, Java owned

TK_Field com.jogamp.gluegen.test.junit.generation.TK_Field.setConstInt32PointerCustomLen(int[] src, int srcPos, int length)
+
Setter for native field constIntxxPointerCustomLen, referencing a +mixed and ambigously owned (warning) array with +variable element count of getConstIntxxPointerCustomLenElemCount() +elements.
+
Native Signature:
+
- field-type (PointerType) 'int32_t ' -> (const int32_t) * , +size [fixed false, lnx64 8], const[false], pointer1
- referenced (IntType) typedef 'int32_t', size [fixed true, lnx64 4], +const[native, true], int
+
Replaces the respective field's memory with a new memory segment +containing given source elements and referencing it.
+
Parameters:
+
- src the source array of elements
- srcPos starting element position within the source array with +'srcPos >= 0&&srcPos + length <= src.length`, +otherwise an IndexOutOfBoundsException is thrown
- length the element count to be copied with 'length >= +0&&srcPos + length <= src.length`, otherwise an +IndexOutOfBoundsException is thrown
+
Returns:
+
- this instance of chaining

Struct Setter Pseudo-Code

ImmutableAccess: Drops setter, immutable
Pointer & ConstValue & +ConstElemCount: Drops setter, native ownership on +const-value
Array & ConstValue : Drops setter, const-value +array
Primitive +
- Single aggregated instance +
  - Store value within native memory
- Array | Pointer +
  - MaxOneElement +
    - Pointer +
      - ConstValue: Allocate new memory and store value
      - VariaValue: +
        +
        ConstElemCount: Reuse native memory and store +value with matching elemCount 1, otherwise Exception
        +
        VariaElemCount: Reuse native memory and store +value with matching elemCount 1, otherwise allocates new memory +(had elemCount 0)
        +
    - Array & VariaValue: Reuse native +memory and store value (has const elemCount 1)
    - else: SKIP setter for const single-primitive +array
  - AnyElementCount +
    - String & isByteBuffer & Pointer +
      - ConstElemCount: Reuse native memory and store +UTF-8 bytes with EOS with matching elemCount, otherwise +Exception +
        +
        StringOnly: End, no more setter for this field, otherwise +continue
        +
      - VariaElemCount: Allocate new native memory and +store UTF-8 bytes with EOS +
        +
        StringOnly: End, no more setter for this field, otherwise +continue
        +
    - ConstValue +
      - Pointer +
        +
        VariaElemCount: Allocates new native memory and +store value
        +
      - else: SKIP setter for const primitive array
    - Array | ConstElemCount: Reuse native +memory and store value with <= elemCount, otherwise +Exception
    - Pointer & VariaElemCount: Reuse +native memory and store value with <= elemCount, +otherwise allocate new native memory
Struct ...

Platform Header Files

GlueGen provides convenient platform headers,
+which can be included in your C header files for native compilation and +GlueGen code generation.

Example:

   #include <gluegen_stdint.h>
+   #include <gluegen_stddef.h>
+ 
+   uint64_t test64;
+   size_t size1;
+   ptrdiff_t ptr1;

To compile this file you have to include the following folder to your +compilers system includes, ie -I:

    gluegen/make/stub_includes/platform

To generate code for this file you have to include the following +folder to your GlueGen includeRefid element:

    gluegen/make/stub_includes/gluegen

Pre-Defined Macros

To identity a GlueGen code generation run, GlueGen defines the +following macros:

     #define __GLUEGEN__ 2

+ + diff --git a/doc/JogAmpMacOSVersions.html b/doc/JogAmpMacOSVersions.html new file mode 100644 index 0000000..3b56244 --- /dev/null +++ b/doc/JogAmpMacOSVersions.html @@ -0,0 +1,577 @@ + + + + + + + JogAmpMacOSVersions.md + + + + + + +

JogAmp's MacOS Version +Support

References

Overview

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

MacOS Version	Release Name	Darwin Version	JogAmp Relation
10.7	Lion	11	Min deployment target

10.13	High Sierra	17	Test node 10.13.6, +`x86_64`
10.14	Mojave	18
10.15	Catalina	19

11	Big Sur	20
12	Monterey	21	Build node 12.6.5, w/ Xcode 14.2, +`x86_64`
13	Ventura	22	Test node 13.1, `arm64`

OpenJDK

Available Java(tm) VMs

OpenJDK build @ Adoptium +
- Adoptium +Supported MacOS Versions +
  - MacOS 10.15, 11, 12, 13 for x86_64 and +arm64

JogAmp Build and Test Setup

MacOS 12.6.5 (Monterey), +Darwin 21, `x86_64`

Build and main test machine
XCode 14.2 w/ SDK 11.3 +
- export SDKROOT=macosx11.3 (MacOS SDK)
- -mmacosx-version-min=10.7 (Miniumum deployment +target)
OpenJDK Temurin 17.0.5+8

MacOS 10.13.6 (High +Sierra), Darwin 17, `x86_64`

Test machine
OpenJDK Temurin 17.0.5+8

MacOS 13.1 (Ventura), Darwin +22, `arm64`

Test machine
OpenJDK Temurin 17.0.5+8

Change History

+ + + + + + + + + + + + + +

Date	Note
2023-05-06	Initial Version for JogAmp Release +2.5.0

+ + -- cgit v1.2.3

GlueGen Native +Data & Function Mapping for Java™

References

Overview

Primitive Mapping

String Mapping

Function return String +values

Function argument String +values

Struct String mapping

Alignment for Compound Data

Simple alignment arithmetic

Type +Size & Alignment for x86, x86_64, armv6l-32bit-eabi and +Window(mingw/mingw64)

Struct Mapping

GlueGen Struct Settings

ImmutableAccess +symbol

MaxOneElement +symbol

ReturnedArrayLength +symbol expression

ReturnsString +symbol

ReturnsStringOnly +symbol

Struct Mapping Notes

Struct Java Signature Table

Struct Java Signature +Examples

Signature +int32_t * MaxOneElement, Java owned

Signature +const int32_t * MaxOneElement, Java owned

Signature +int32_t * ConstElemCount 3, Natively owned

Signature +int32_t * FreeSize, Java owned

Signature +const int32_t * FreeSize, Java owned

Signature +const int32_t * CustomSize, Ambiguous, Java owned

Struct Setter Pseudo-Code

Platform Header Files

Pre-Defined Macros

JogAmp's MacOS Version +Support

Overview

OpenJDK

JogAmp Build and Test Setup

MacOS 12.6.5 (Monterey), +Darwin 21, x86_64

MacOS 10.13.6 (High +Sierra), Darwin 17, x86_64

MacOS 13.1 (Ventura), Darwin +22, arm64

Change History

Signature +`int32_t *` MaxOneElement, Java owned

Signature +`const int32_t *` MaxOneElement, Java owned

Signature +`int32_t *` ConstElemCount 3, Natively owned

Signature +`int32_t *` FreeSize, Java owned

Signature +`const int32_t *` FreeSize, Java owned

Signature +`const int32_t *` CustomSize, Ambiguous, Java owned

MacOS 12.6.5 (Monterey), +Darwin 21, `x86_64`

MacOS 10.13.6 (High +Sierra), Darwin 17, `x86_64`

MacOS 13.1 (Ventura), Darwin +22, `arm64`