Handle Array Arguments Better #21

vixalien · 2023-12-19T23:23:26Z

Hello again. This PR is currently a draft because while it does not depend on #17, the code there needs to be merged before this one because by doing so, the code in this PR will be vastly simplified.

This PR does 3 main things:

1. Unbox C Arrays into TypedArrays (`Uint8Array`, `Uint16Array` etc..)

This is similar to GJS behaviour and differs from the current behaviour where each element would be unboxed into an argument. This doesn't work for stuff like GLib.file_get_contents, which returns an array, but the array is of random data. This PR would, for example, produce a Uint8Array instead of an array of numbers.

2. Utilise the lengthArg to unboxArrays

Functions that return an array usually have a length parameter. For the GLib.file_get_contents case, that parameter is called length. The bindings now automatically infer the array's length from the related parameter.

3. Omit the length parameter from being returned.

In the case of the above function, since GLib.file_get_contents returns an array, the length parameter is no longer required as we can infer that from Uint8Array.length and adds to the noise. This behaviour is what GJS does, too.

TODO in a separate PR: Handle different arrays based on the GIArrayType. Currently, deno_gi only handles C arrays, but there are other types of arrays namely: GArray, GPtrArray and GByteArray. Adding support for them should be pretty straightforward. Maybe an issue needs to be filed to keep track of this.

vixalien · 2024-01-06T03:07:46Z

src/types/argument.js

@@ -24,15 +24,19 @@ export function initArgument(type) {
      g.base_info.unref(info);
      return result;
    }
+    default: {
+      return cast_ptr_u64(cast_buf_ptr(new Uint8Array(1)));


Actually, I believe all arguments should be initialised to an empty pointer (GIArgInfo)

src/types/argument.js

@@ -24,15 +24,19 @@ export function initArgument(type) {
      g.base_info.unref(info);
      return result;
    }
+    default: {
+      return cast_ptr_u64(cast_buf_ptr(new Uint8Array(1)));


src/types/callable.js

vixalien · 2024-01-15T18:18:30Z

~~TODO: handle return values' length~~ DONE

Here's some test code for this:

import { require } from "../mod.ts";

const GLib = require("GLib", "2.0");

const encoder = new TextEncoder();
const decoder = new TextDecoder();

const bfr = encoder.encode("Hello, World!");

const bytes = GLib.Bytes.new(bfr, bfr.length);

// console.log("size", bytes.getSize());

const data = bytes.getData();
console.log("data", data);

Although currently, it seems GLib.Bytes.getData() doesn't set the size argument. this needs to be investigated.

except arguments of course

and don't return the length argument. It's just noise since you can already get the length of an array using JS's .length and is ommitted in GJS as well. the code doesn't read too well though

ensures that the return argument's length can be inferred

For example, `GLib.Bytes.getData`. This needs to be investigated

vixalien force-pushed the arrays branch from a0c5154 to 73c2fc0 Compare December 26, 2023 22:19

vixalien force-pushed the arrays branch from 73c2fc0 to 9a1da18 Compare January 6, 2024 02:49

vixalien mentioned this pull request Jan 6, 2024

Handle different array types based on the GIArrayType #24

Open

vixalien commented Jan 6, 2024

View reviewed changes

vixalien force-pushed the arrays branch from 9a1da18 to 73c65d0 Compare January 6, 2024 14:26

vixalien commented Jan 15, 2024

View reviewed changes

vixalien force-pushed the arrays branch from f60bea6 to 0ed1582 Compare January 17, 2024 12:20

vixalien force-pushed the arrays branch from 0ed1582 to f76b398 Compare January 26, 2024 09:23

vixalien added 8 commits January 31, 2024 20:51

allocate a new pointer for Arrays in initArgument

99b040a

unbox C arrays by returning the corresponding TypedArray

7323318

initialise an empty pointer for all arguments

96aa302

except arguments of course

unbox arrays using the provided length arg

b55cc27

and don't return the length argument. It's just noise since you can already get the length of an array using JS's .length and is ommitted in GJS as well. the code doesn't read too well though

initialise number args to zero

5203177

simplify array unboxing code and use direct pointer

721169d

parse the outArgs in one go

43f4c99

ensures that the return argument's length can be inferred

TEMPORARY FIX: some functions don't set the length arg

5d0be65

For example, `GLib.Bytes.getData`. This needs to be investigated

vixalien force-pushed the arrays branch from f76b398 to 5d0be65 Compare January 31, 2024 18:54

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Handle Array Arguments Better #21

Handle Array Arguments Better #21

This comment was marked as duplicate.

This comment was marked as duplicate.

Handle Array Arguments Better #21

Are you sure you want to change the base?

Handle Array Arguments Better #21

Conversation

1. Unbox C Arrays into TypedArrays (Uint8Array, Uint16Array etc..)

2. Utilise the lengthArg to unboxArrays

3. Omit the length parameter from being returned.

Choose a reason for hiding this comment

This comment was marked as duplicate.

This comment was marked as duplicate.

1. Unbox C Arrays into TypedArrays (`Uint8Array`, `Uint16Array` etc..)