diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/GlueGen_Mapping.html | 101 | ||||
| -rw-r--r-- | doc/GlueGen_Mapping.md | 65 |
2 files changed, 97 insertions, 69 deletions
diff --git a/doc/GlueGen_Mapping.html b/doc/GlueGen_Mapping.html index 7bec555..d484ff8 100644 --- a/doc/GlueGen_Mapping.html +++ b/doc/GlueGen_Mapping.html @@ -463,8 +463,10 @@ <li><a href="#javacallback-example-1">JavaCallback Example 1</a></li> <li><a href="#javacallback-example-2a-default-keyclass">JavaCallback Example 2a (Default <em>KeyClass</em>)</a></li> - <li><a href="#javacallback-example-2b-custom-keyclass">JavaCallback - Example 2b (Custom <em>KeyClass</em>)</a></li> + <li><a + href="#javacallback-example-2b-custom-keyclass-different-key-parameter-order">JavaCallback + Example 2b (Custom <em>KeyClass</em>, different key-parameter + order)</a></li> <li><a href="#javacallback-example-11a-homogeneous-struct-type">JavaCallback Example 11a (<em>Homogeneous Struct Type</em>)</a></li> @@ -2027,27 +2029,29 @@ Object</em> to be passed to the users' <h3 id="javacallback-configuration"><em>JavaCallback</em> Configuration</h3> <p>Configuration directives are as follows:</p> -<pre><code>JavaCallbackDef <SetCallbackFunctionName> [<SetCallback-UserParamIndex>] <CallbackFunctionType> <CallbackFunction-UserParamIndex> [<SetCallback-KeyClassName>] -JavaCallbackKey <SetCallbackFunctionName> (SetCallback-ParamIdx)*</code></pre> +<pre><code>JavaCallbackDef <SetCallbackFunctionName> <SetCallback-UserParamIndex> <CallbackFunctionType> <CallbackFunction-UserParamIndex> [<SetCallback-KeyClassName>] +JavaCallbackKey <SetCallbackFunctionName> <SetCallback-ParamIndex>* <CallbackFunctionType> <CallbackFunction-ParamIndex>*</code></pre> <p><code>JavaCallbackDef</code> and <code>JavaCallbackKey</code> use the name of the <code>SetCallbackFunction</code> as its first attribute, as -it is core to the semantic mapping of all resources.</p> +it is core to the semantic mapping of all resources. They also have to +use the same <code>CallbackFunctionType</code>.</p> <p><code>JavaCallbackDef</code> attributes:</p> <ul> <li><code>SetCallbackFunction</code>: <code>SetCallbackFunction</code> name of the native toolkit API responsible to set the callback</li> -<li><code>SetCallback-UserParamIndex</code>: Optional -<code>UserParam</code> parameter-index of the -<code>SetCallbackFunction</code>, allowing to <a -href="#struct-type-user-param-heterogeneous">indicate a heterogeneous -<code>UserParam</code></a></li> +<li><code>SetCallback-UserParamIndex</code>: <code>UserParam</code> +parameter-index of the <code>SetCallbackFunction</code></li> <li><code>CallbackFunctionType</code>: The native toolkit API typedef-name of the function-pointer-type, aka the callback type name</li> <li><code>CallbackFunction-UserParamIndex</code>: The <code>userParam</code> parameter-index of the -<code>CallbackFunctionType</code></li> -<li><code>SetCallback-KeyClassName</code>: Name of an optional +<code>CallbackFunctionType</code>, allowing to accommodate a potential +parameter-type collision between <code>SetCallbackFunction</code> and +<code>CallbackFunction</code>. It also allows to <a +href="#struct-type-user-param-heterogeneous">indicate a heterogeneous +<code>UserParam</code></a></li> +<li><code>SetCallback-KeyClassName</code>: Optional name of a user-implemented <code>SetCallback-KeyClass</code>, providing the hash-map-key - see below</li> </ul> @@ -2056,7 +2060,7 @@ hash-map-key - see below</li> <code>null</code> for the <code>CallbackFunction</code>.</p> <p>If mapping the <code>CallbackFunction</code> to keys, the user must specify the same key arguments when setting and removing the -``CallbackFunction`.</p> +<code>CallbackFunction</code>.</p> <h4 id="javacallback-key-definition"><em>JavaCallback</em> Key Definition</h4> <p>If no keys are defined via <code>JavaCallbackKey</code> or not @@ -2068,17 +2072,27 @@ public <code>SetCallback-KeyClass</code> is being generated covering the defined keys.</p> <p>Keys allow to limit the scope, i.e. map multiple <code>CallbackFunction</code> to the different keys.</p> -<p>Key arguments must match in <code>SetCallbackFunction</code> to -remove a previously set <code>CallbackFunction</code>.</p> +<p>To remove a previously set <code>CallbackFunction</code> via +<code>SetCallbackFunction</code>, the key arguments must match.</p> <p><code>JavaCallbackKey</code> attributes</p> <ul> <li><code>SetCallbackFunction</code>: <code>SetCallbackFunction</code> name of the native toolkit API responsible to set the callback</li> -<li><code>SetCallback-ParamIdx</code>: List of parameter indices of the -<code>SetCallbackFunction</code>, denoting the key(s) limiting the +<li><code>SetCallback-ParamIndex</code>: List of parameter indices of +the <code>SetCallbackFunction</code>, denoting the key(s) limiting the callback scope, i.e. the callback and all resources will be mapped to this key. The optional <code>SetCallback-KeyClass</code> may override this semantic.</li> +<li><code>CallbackFunctionType</code>: The native toolkit API +typedef-name of the function-pointer-type, the same callback type name +as defined in <code>JavaCallbackDef</code></li> +<li><code>CallbackFunction-ParamIndex</code>: List of parameter indices +of the <code>CallbackFunctionType</code>, matching the semantic +parameter of <code>SetCallback-ParamIndex</code> to accommodate +potential different parameter order or argument names between +<code>SetCallbackFunction</code> and <code>CallbackFunction</code>. The +indexed parameters must be semantical equivalent as specified by the +<code>SetCallback-ParamIndex</code> list.</li> </ul> <h4 id="custom-setcallback-keyclass">Custom <code>SetCallback-KeyClass</code></h4> @@ -2196,7 +2210,7 @@ and the native callback dispatcher <strong>are thread-safe</strong></li> <li>...</li> </ul> <h3 id="javacallback-example-1">JavaCallback Example 1</h3> -<p>This examples demonstrates a <a +<p>This example demonstrates a <a href="#pure-java-object-user-type-default">homogeneous <em>Java Object</em> <code>UserParam</code> mapping</a> with a <a href="#javacallback-key-definition">globally scoped</a> @@ -2230,7 +2244,7 @@ ArgumentIsString InjectMessageCallback01 1 # - `T2_CallbackFunc01 getMessageCallback01()` returns the global T2_CallbackFunc01, null if not mapped # - `Object getMessageCallback01UserParam()` returns the global `usrParam` object, null if not mapped # - `void releaseMessageCallback01()` releases callback data skipping toolkit API. Favor passing `null` callback ref to `MessageCallback01(..)` -JavaCallbackDef MessageCallback01 T2_CallbackFunc01 2</code></pre> +JavaCallbackDef MessageCallback01 1 T2_CallbackFunc01 2</code></pre> <p>Note that <a href="#libraryonload-librarybasename-for-jni_onload-"><code>LibraryOnLoad Bindingtest2</code></a> must be specified in exactly one native code-unit within the library. It @@ -2269,18 +2283,18 @@ the current thread to the <code>JavaVM*</code> generating a new public void InjectMessageCallback01(long id, String msg);</code></pre> <h3 id="javacallback-example-2a-default-keyclass">JavaCallback Example 2a (Default <em>KeyClass</em>)</h3> -<p>This examples demonstrates a <a +<p>This example demonstrates a <a href="#pure-java-object-user-type-default">homogeneous <em>Java Object</em> <code>UserParam</code> mapping</a> with a <a href="#javacallback-key-definition">key-mapped</a> <code>CallbackFunction</code> and <code>UserParam</code>.</p> -<p>This examples is derived from OpenAL's +<p>This example is derived from OpenAL's <code>AL_SOFT_callback_buffer</code> extension.</p> <p>The callback <code>ALBUFFERCALLBACKTYPESOFT</code> is mapped to <code>buffer</code> name, i.e. one callback can be set for each buffer.</p> <p>C-API Header snipped</p> -<pre><code> typedef void ( * ALBUFFERCALLBACKTYPESOFT)(int buffer, void *userptr, int sampledata, int numbytes); +<pre><code> typedef void ( * ALBUFFERCALLBACKTYPESOFT)(int buffer /* key */, void *userptr, int sampledata, int numbytes); void alBufferCallback0(int buffer /* key */, int format, int freq, ALBUFFERCALLBACKTYPESOFT callback, void *userptr); @@ -2302,8 +2316,8 @@ buffer.</p> # - `Object getAlBufferCallback0UserParam(AlBufferCallback0Key)` returns the `buffer` mapped `userptr` object, null if not mapped # - `void releaseAllAlBufferCallback0()` releases all callback data mapped via Key { int buffer } skipping toolkit API. Favor passing `null` callback ref to `alBufferCallback0(..)` # - `void releaseAlBufferCallback0(AlBufferCallback0Key)` releases callback data mapped to Key { int buffer } skipping toolkit API. Favor passing `null` callback ref to `alBufferCallback0(..)` - JavaCallbackDef alBufferCallback0 ALBUFFERCALLBACKTYPESOFT 1 - JavaCallbackKey alBufferCallback0 0</code></pre> + JavaCallbackDef alBufferCallback0 4 ALBUFFERCALLBACKTYPESOFT 1 + JavaCallbackKey alBufferCallback0 0 ALBUFFERCALLBACKTYPESOFT 0</code></pre> <p>leading to the following interface</p> <pre><code> /** JavaCallback interface: ALBUFFERCALLBACKTYPESOFT -> void (*ALBUFFERCALLBACKTYPESOFT)(int buffer, void * userptr, int sampledata, int numbytes) */ public static interface ALBUFFERCALLBACKTYPESOFT { @@ -2363,22 +2377,27 @@ buffer.</p> /** Entry point (through function pointer) to C language function: <br> <code>void alEventCallbackInject(int eventType, int object, int param, const char * msg)</code><br> */ public void alEventCallbackInject(int eventType, int object, int param, String msg); </code></pre> -<h3 id="javacallback-example-2b-custom-keyclass">JavaCallback Example 2b -(Custom <em>KeyClass</em>)</h3> -<p>This examples demonstrates a <a -href="#pure-java-object-user-type-default">homogeneous <em>Java -Object</em> <code>UserParam</code> mapping</a> with a <a +<h3 +id="javacallback-example-2b-custom-keyclass-different-key-parameter-order">JavaCallback +Example 2b (Custom <em>KeyClass</em>, different key-parameter +order)</h3> +<p>Similar example as example 2a, but using a <a href="#custom-setcallback-keyclass">custom <em>KeyClass</em></a> to map -<code>CallbackFunction</code> and <code>UserParam</code>.</p> -<p>Same as example 2a, but implementing a custom -<code>SetCallback-KeyClass</code>.</p> -<p>Instead of <code>Callback0</code>, the unit <code>test2.*</code> uses -<code>Callback1</code> to differentiate this case.</p> +<code>CallbackFunction</code> and <code>UserParam</code> and also +accommodating a different key-parameter order between +<code>SetCallbackFunction</code> and <code>CallbackFunction</code>.</p> +<p>C-API Header snipped</p> +<pre><code> typedef void ( * ALBUFFERCALLBACKTYPESOFT)(int buffer /* key */, void *userptr, int sampledata, int numbytes); + + void alBufferCallback1(void *user_ptr, int buffer_key /* key */, int format, int freq, ALBUFFERCALLBACKTYPESOFT callback); + + void alBufferCallback1Inject(int buffer, int sampledata, int numbytes);</code></pre> <p>GlueGen configuration snippet with the added option attribute for the <code>SetCallback-KeyClass</code> in directive <code>JavaCallbackDef</code>.</p> -<pre><code>JavaCallbackDef alBufferCallback1 ALBUFFERCALLBACKTYPESOFT 1 com.jogamp.gluegen.test.junit.generation.Test4JavaCallback.CustomAlBufferCallback1Key -JavaCallbackKey alBufferCallback1 0</code></pre> +<pre><code>JavaCallbackDef alBufferCallback1 0 ALBUFFERCALLBACKTYPESOFT 1 com.jogamp.gluegen.test.junit.generation.Test4JavaCallback.CustomAlBufferCallback1Key +JavaCallbackKey alBufferCallback1 1 ALBUFFERCALLBACKTYPESOFT 0 +</code></pre> <p>Implementation utilizes a custom <code>SetCallback-KeyClass</code> implementation for <code>void alBufferCallback1(int buffer, int format, int freq, ALBUFFERCALLBACKTYPESOFT callback, Object userptr)</code>, @@ -2410,7 +2429,7 @@ which uses one key, i.e. <code>buffer</code>.</p> }</code></pre> <h3 id="javacallback-example-11a-homogeneous-struct-type">JavaCallback Example 11a (<em>Homogeneous Struct Type</em>)</h3> -<p>This examples demonstrates a <a +<p>This example demonstrates a <a href="#struct-type-user-param-homogeneous">homogeneous <em>Struct</em> <code>UserParam</code> mapping</a> with a <a href="#javacallback-key-definition">key-mapped</a> @@ -2432,8 +2451,8 @@ method <code>MessageCallback11b(..)</code>.</p> void MessageCallback11a(size_t id /* key */, T2_CallbackFunc11 cbFunc, const T2_Callback11UserType* usrParam); void MessageCallback11aInject(size_t id, long val); </code></pre> <p>and the following GlueGen configuration</p> -<pre><code> JavaCallbackDef MessageCallback11a T2_CallbackFunc11 1 - JavaCallbackKey MessageCallback11a 0</code></pre> +<pre><code> JavaCallbackDef MessageCallback11a 2 T2_CallbackFunc11 1 + JavaCallbackKey MessageCallback11a 0 T2_CallbackFunc11 0</code></pre> <p>leading to the following interface</p> <pre><code> /** JavaCallback interface: T2_CallbackFunc11 -> void (*T2_CallbackFunc11)(size_t id, const T2_Callback11UserType * usrParam, long val) */ public static interface T2_CallbackFunc11 { @@ -2473,7 +2492,7 @@ method <code>MessageCallback11b(..)</code>.</p> <h3 id="javacallback-example-11b-heterogeneous-pointerstruct-type">JavaCallback Example 11b (<em>Heterogeneous Pointer/Struct Type</em>)</h3> -<p>This examples demonstrates a <a +<p>This example demonstrates a <a href="#struct-type-user-param-heterogeneous">heterogeneous <em>Struct</em> <code>UserParam</code> mapping</a> with a <a href="#javacallback-key-definition">key-mapped</a> @@ -2499,7 +2518,7 @@ users' <code>void*</code> pointer with the void MessageCallback11bInject(size_t id, long val);</code></pre> <p>and the following GlueGen configuration</p> <pre><code> JavaCallbackDef MessageCallback11b 2 T2_CallbackFunc11 1 - JavaCallbackKey MessageCallback11b 0</code></pre> + JavaCallbackKey MessageCallback11b 0 T2_CallbackFunc11 0</code></pre> <p>leading to the following interface</p> <pre><code> /** JavaCallback interface: T2_CallbackFunc11 -> void (*T2_CallbackFunc11)(size_t id, const T2_Callback11UserType * usrParam, long val) */ public static interface T2_CallbackFunc11 { diff --git a/doc/GlueGen_Mapping.md b/doc/GlueGen_Mapping.md index 7a72733..2f8e9e1 100644 --- a/doc/GlueGen_Mapping.md +++ b/doc/GlueGen_Mapping.md @@ -816,22 +816,22 @@ The static Java callback dispatcher dereferences the received native struct addr Configuration directives are as follows: - JavaCallbackDef <SetCallbackFunctionName> [<SetCallback-UserParamIndex>] <CallbackFunctionType> <CallbackFunction-UserParamIndex> [<SetCallback-KeyClassName>] - JavaCallbackKey <SetCallbackFunctionName> (SetCallback-ParamIdx)* + JavaCallbackDef <SetCallbackFunctionName> <SetCallback-UserParamIndex> <CallbackFunctionType> <CallbackFunction-UserParamIndex> [<SetCallback-KeyClassName>] + JavaCallbackKey <SetCallbackFunctionName> <SetCallback-ParamIndex>* <CallbackFunctionType> <CallbackFunction-ParamIndex>* `JavaCallbackDef` and `JavaCallbackKey` use the name of the `SetCallbackFunction` as its first attribute, -as it is core to the semantic mapping of all resources. +as it is core to the semantic mapping of all resources. They also have to use the same `CallbackFunctionType`. `JavaCallbackDef` attributes: - `SetCallbackFunction`: `SetCallbackFunction` name of the native toolkit API responsible to set the callback -- `SetCallback-UserParamIndex`: Optional `UserParam` parameter-index of the `SetCallbackFunction`, allowing to [indicate a heterogeneous `UserParam`](#struct-type-user-param-heterogeneous) +- `SetCallback-UserParamIndex`: `UserParam` parameter-index of the `SetCallbackFunction` - `CallbackFunctionType`: The native toolkit API typedef-name of the function-pointer-type, aka the callback type name -- `CallbackFunction-UserParamIndex`: The `userParam` parameter-index of the `CallbackFunctionType` -- `SetCallback-KeyClassName`: Name of an optional user-implemented `SetCallback-KeyClass`, providing the hash-map-key - see below +- `CallbackFunction-UserParamIndex`: The `userParam` parameter-index of the `CallbackFunctionType`, allowing to accommodate a potential parameter-type collision between `SetCallbackFunction` and `CallbackFunction`. It also allows to [indicate a heterogeneous `UserParam`](#struct-type-user-param-heterogeneous) +- `SetCallback-KeyClassName`: Optional name of a user-implemented `SetCallback-KeyClass`, providing the hash-map-key - see below The `SetCallbackFunction` is utilized to set the `CallbackFunction` as well as to remove it passing `null` for the `CallbackFunction`. -If mapping the `CallbackFunction` to keys, the user must specify the same key arguments when setting and removing the ``CallbackFunction`. +If mapping the `CallbackFunction` to keys, the user must specify the same key arguments when setting and removing the `CallbackFunction`. #### *JavaCallback* Key Definition @@ -843,11 +843,14 @@ a public `SetCallback-KeyClass` is being generated covering the defined keys. Keys allow to limit the scope, i.e. map multiple `CallbackFunction` to the different keys. -Key arguments must match in `SetCallbackFunction` to remove a previously set `CallbackFunction`. +To remove a previously set `CallbackFunction` via `SetCallbackFunction`, the key arguments must match. `JavaCallbackKey` attributes - `SetCallbackFunction`: `SetCallbackFunction` name of the native toolkit API responsible to set the callback -- `SetCallback-ParamIdx`: List of parameter indices of the `SetCallbackFunction`, denoting the key(s) limiting the callback scope, i.e. the callback and all resources will be mapped to this key. The optional `SetCallback-KeyClass` may override this semantic. +- `SetCallback-ParamIndex`: List of parameter indices of the `SetCallbackFunction`, denoting the key(s) limiting the callback scope, i.e. the callback and all resources will be mapped to this key. The optional `SetCallback-KeyClass` may override this semantic. +- `CallbackFunctionType`: The native toolkit API typedef-name of the function-pointer-type, the same callback type name as defined in `JavaCallbackDef` +- `CallbackFunction-ParamIndex`: List of parameter indices of the `CallbackFunctionType`, matching the semantic parameter of `SetCallback-ParamIndex` to accommodate potential different parameter order or argument names between `SetCallbackFunction` and `CallbackFunction`. The indexed parameters must be semantical equivalent as specified by the `SetCallback-ParamIndex` list. + #### Custom `SetCallback-KeyClass` @@ -908,7 +911,7 @@ Please consider the following *currently enabled* constraints using JavaCallback - ... ### JavaCallback Example 1 -This examples demonstrates a [homogeneous *Java Object* `UserParam` mapping](#pure-java-object-user-type-default) with a [globally scoped](#javacallback-key-definition) `CallbackFunction` and `UserParam`. +This example demonstrates a [homogeneous *Java Object* `UserParam` mapping](#pure-java-object-user-type-default) with a [globally scoped](#javacallback-key-definition) `CallbackFunction` and `UserParam`. The callback `T2_CallbackFunc01` has global scope, i.e. is not mapped to any key and can be only set globally. @@ -943,7 +946,7 @@ ArgumentIsString InjectMessageCallback01 1 # - `T2_CallbackFunc01 getMessageCallback01()` returns the global T2_CallbackFunc01, null if not mapped # - `Object getMessageCallback01UserParam()` returns the global `usrParam` object, null if not mapped # - `void releaseMessageCallback01()` releases callback data skipping toolkit API. Favor passing `null` callback ref to `MessageCallback01(..)` -JavaCallbackDef MessageCallback01 T2_CallbackFunc01 2 +JavaCallbackDef MessageCallback01 1 T2_CallbackFunc01 2 ``` Note that [`LibraryOnLoad Bindingtest2`](#libraryonload-librarybasename-for-jni_onload-) must be specified in exactly one native code-unit within the library. @@ -983,15 +986,15 @@ public interface Bindingtest2 { ### JavaCallback Example 2a (Default *KeyClass*) -This examples demonstrates a [homogeneous *Java Object* `UserParam` mapping](#pure-java-object-user-type-default) with a [key-mapped](#javacallback-key-definition) `CallbackFunction` and `UserParam`. +This example demonstrates a [homogeneous *Java Object* `UserParam` mapping](#pure-java-object-user-type-default) with a [key-mapped](#javacallback-key-definition) `CallbackFunction` and `UserParam`. -This examples is derived from OpenAL's `AL_SOFT_callback_buffer` extension. +This example is derived from OpenAL's `AL_SOFT_callback_buffer` extension. The callback `ALBUFFERCALLBACKTYPESOFT` is mapped to `buffer` name, i.e. one callback can be set for each buffer. C-API Header snipped ``` - typedef void ( * ALBUFFERCALLBACKTYPESOFT)(int buffer, void *userptr, int sampledata, int numbytes); + typedef void ( * ALBUFFERCALLBACKTYPESOFT)(int buffer /* key */, void *userptr, int sampledata, int numbytes); void alBufferCallback0(int buffer /* key */, int format, int freq, ALBUFFERCALLBACKTYPESOFT callback, void *userptr); @@ -1016,8 +1019,8 @@ and the following GlueGen configuration # - `Object getAlBufferCallback0UserParam(AlBufferCallback0Key)` returns the `buffer` mapped `userptr` object, null if not mapped # - `void releaseAllAlBufferCallback0()` releases all callback data mapped via Key { int buffer } skipping toolkit API. Favor passing `null` callback ref to `alBufferCallback0(..)` # - `void releaseAlBufferCallback0(AlBufferCallback0Key)` releases callback data mapped to Key { int buffer } skipping toolkit API. Favor passing `null` callback ref to `alBufferCallback0(..)` - JavaCallbackDef alBufferCallback0 ALBUFFERCALLBACKTYPESOFT 1 - JavaCallbackKey alBufferCallback0 0 + JavaCallbackDef alBufferCallback0 4 ALBUFFERCALLBACKTYPESOFT 1 + JavaCallbackKey alBufferCallback0 0 ALBUFFERCALLBACKTYPESOFT 0 ``` leading to the following interface @@ -1082,18 +1085,24 @@ leading to the following interface public void alEventCallbackInject(int eventType, int object, int param, String msg); ``` -### JavaCallback Example 2b (Custom *KeyClass*) - -This examples demonstrates a [homogeneous *Java Object* `UserParam` mapping](#pure-java-object-user-type-default) with a [custom *KeyClass*](#custom-setcallback-keyclass) to map `CallbackFunction` and `UserParam`. +### JavaCallback Example 2b (Custom *KeyClass*, different key-parameter order) -Same as example 2a, but implementing a custom `SetCallback-KeyClass`. +Similar example as example 2a, but using a [custom *KeyClass*](#custom-setcallback-keyclass) to map `CallbackFunction` and `UserParam` and also accommodating a different key-parameter order between `SetCallbackFunction` and `CallbackFunction`. -Instead of `Callback0`, the unit `test2.*` uses `Callback1` to differentiate this case. +C-API Header snipped +``` + typedef void ( * ALBUFFERCALLBACKTYPESOFT)(int buffer /* key */, void *userptr, int sampledata, int numbytes); + + void alBufferCallback1(void *user_ptr, int buffer_key /* key */, int format, int freq, ALBUFFERCALLBACKTYPESOFT callback); + + void alBufferCallback1Inject(int buffer, int sampledata, int numbytes); +``` GlueGen configuration snippet with the added option attribute for the `SetCallback-KeyClass` in directive `JavaCallbackDef`. ``` -JavaCallbackDef alBufferCallback1 ALBUFFERCALLBACKTYPESOFT 1 com.jogamp.gluegen.test.junit.generation.Test4JavaCallback.CustomAlBufferCallback1Key -JavaCallbackKey alBufferCallback1 0 +JavaCallbackDef alBufferCallback1 0 ALBUFFERCALLBACKTYPESOFT 1 com.jogamp.gluegen.test.junit.generation.Test4JavaCallback.CustomAlBufferCallback1Key +JavaCallbackKey alBufferCallback1 1 ALBUFFERCALLBACKTYPESOFT 0 + ``` Implementation utilizes a custom `SetCallback-KeyClass` implementation for `void alBufferCallback1(int buffer, int format, int freq, ALBUFFERCALLBACKTYPESOFT callback, Object userptr)`, @@ -1128,7 +1137,7 @@ which uses one key, i.e. `buffer`. ### JavaCallback Example 11a (*Homogeneous Struct Type*) -This examples demonstrates a [homogeneous *Struct* `UserParam` mapping](#struct-type-user-param-homogeneous) with a [key-mapped](#javacallback-key-definition) `CallbackFunction` and `UserParam`. +This example demonstrates a [homogeneous *Struct* `UserParam` mapping](#struct-type-user-param-homogeneous) with a [key-mapped](#javacallback-key-definition) `CallbackFunction` and `UserParam`. The callback `T2_CallbackFunc11` is passed by the toolkit to the `CallbackFunction` and by the user to the registration method `MessageCallback11b(..)`. @@ -1150,8 +1159,8 @@ C-API Header snipped and the following GlueGen configuration ``` - JavaCallbackDef MessageCallback11a T2_CallbackFunc11 1 - JavaCallbackKey MessageCallback11a 0 + JavaCallbackDef MessageCallback11a 2 T2_CallbackFunc11 1 + JavaCallbackKey MessageCallback11a 0 T2_CallbackFunc11 0 ``` leading to the following interface @@ -1195,7 +1204,7 @@ leading to the following interface ### JavaCallback Example 11b (*Heterogeneous Pointer/Struct Type*) -This examples demonstrates a [heterogeneous *Struct* `UserParam` mapping](#struct-type-user-param-heterogeneous) with a [key-mapped](#javacallback-key-definition) `CallbackFunction` and `UserParam`. +This example demonstrates a [heterogeneous *Struct* `UserParam` mapping](#struct-type-user-param-heterogeneous) with a [key-mapped](#javacallback-key-definition) `CallbackFunction` and `UserParam`. The callback `T2_CallbackFunc11` is managed by the toolkit and passed to the callback function, while user passes a `void*` as a `long` value to the registration method `MessageCallback11b(..)`. The toolkit associates the users' `void*` pointer with the `T2_CallbackFunc11`. @@ -1219,7 +1228,7 @@ C-API Header snipped and the following GlueGen configuration ``` JavaCallbackDef MessageCallback11b 2 T2_CallbackFunc11 1 - JavaCallbackKey MessageCallback11b 0 + JavaCallbackKey MessageCallback11b 0 T2_CallbackFunc11 0 ``` leading to the following interface |