@gtkx/ffi 0.15.0 → 0.17.1

package/dist/generated/glib/option-entry.js

@@ -1,5 +1,96 @@
+import { alloc, read, write } from "../../native/lifecycle.js";
 import { NativeObject } from "../../native/base.js";
-/** Stub class for OptionEntry (opaque type not fully generated) */
+/**
+ * - %G_OPTION_ARG_NONE: %gboolean
+ *     - %G_OPTION_ARG_STRING: %gchar*
+ *     - %G_OPTION_ARG_INT: %gint
+ *     - %G_OPTION_ARG_FILENAME: %gchar*
+ *     - %G_OPTION_ARG_STRING_ARRAY: %gchar**
+ *     - %G_OPTION_ARG_FILENAME_ARRAY: %gchar**
+ *     - %G_OPTION_ARG_DOUBLE: %gdouble
+ *
+ *     If `arg` type is %G_OPTION_ARG_STRING or %G_OPTION_ARG_FILENAME,
+ *     the location will contain a newly allocated string if the option
+ *     was given. That string needs to be freed by the callee using g_free().
+ *     Likewise if `arg` type is %G_OPTION_ARG_STRING_ARRAY or
+ *     %G_OPTION_ARG_FILENAME_ARRAY, the data should be freed using g_strfreev().
+ * A GOptionEntry struct defines a single option. To have an effect, they
+ * must be added to a #GOptionGroup with g_option_context_add_main_entries()
+ * or g_option_group_add_entries().
+ */
 export class OptionEntry extends NativeObject {
-    static objectType = "boxed";
+    static objectType = "struct";
+    constructor(init = {}) {
+        super();
+        this.handle = alloc(48);
+        if (init.shortName !== undefined)
+            write(this.handle, {
+                type: "int",
+                size: 8,
+                unsigned: false,
+            }, 8, init.shortName);
+        if (init.flags !== undefined)
+            write(this.handle, {
+                type: "int",
+                size: 32,
+                unsigned: false,
+            }, 12, init.flags);
+    }
+    /**
+     * The long name of an option can be used to specify it
+     *     in a commandline as `--long_name`. Every option must have a
+     *     long name. To resolve conflicts if multiple option groups contain
+     *     the same long name, it is also possible to specify the option as
+     *     `--groupname-long_name`.
+     */
+    getLongName() {
+        return read(this.handle, {
+            type: "string",
+            ownership: "full",
+        }, 0);
+    }
+    /**
+     * If an option has a short name, it can be specified
+     *     `-short_name` in a commandline. `short_name` must be  a printable
+     *     ASCII character different from '-', or zero if the option has no
+     *     short name.
+     */
+    getShortName() {
+        return read(this.handle, {
+            type: "int",
+            size: 8,
+            unsigned: false,
+        }, 8);
+    }
+    /** Flags from #GOptionFlags */
+    getFlags() {
+        return read(this.handle, {
+            type: "int",
+            size: 32,
+            unsigned: false,
+        }, 12);
+    }
+    /**
+     * the description for the option in `--help`
+     *     output. The `description` is translated using the `translate_func`
+     *     of the group, see g_option_group_set_translation_domain().
+     */
+    getDescription() {
+        return read(this.handle, {
+            type: "string",
+            ownership: "full",
+        }, 32);
+    }
+    /**
+     * The placeholder to use for the extra argument parsed
+     *     by the option in `--help` output. The `arg_description` is translated
+     *     using the `translate_func` of the group, see
+     *     g_option_group_set_translation_domain().
+     */
+    getArgDescription() {
+        return read(this.handle, {
+            type: "string",
+            ownership: "full",
+        }, 40);
+    }
 }

package/dist/generated/glib/option-group.js

@@ -1,4 +1,4 @@
-import { call } from "../../batch.js";
+import { call } from "../../native/lifecycle.js";
 import { getNativeObject } from "../../native/object.js";
 import { NativeObject } from "../../native/base.js";
 import { registerNativeClass } from "../../registry.js";
@@ -61,16 +61,20 @@ export class OptionGroup extends NativeObject {
             {
                 type: {
                     type: "callback",
-                    trampoline: "destroy",
+                    kind: "destroyNotify",
+                    argTypes: [],
+                    returnType: {
+                        type: "undefined",
+                    },
                 },
                 value: destroy,
                 optional: true,
             },
         ], {
             type: "boxed",
-            ownership: "borrowed",
+            ownership: "full",
             innerType: "GOptionGroup",
-            lib: "libgobject-2.0.so.0,libglib-2.0.so.0",
+            library: "libgobject-2.0.so.0,libglib-2.0.so.0",
             getTypeFn: "g_option_group_get_type",
         });
     }
@@ -82,7 +86,7 @@ export class OptionGroup extends NativeObject {
                     type: "boxed",
                     ownership: "borrowed",
                     innerType: "GOptionGroup",
-                    lib: "libgobject-2.0.so.0,libglib-2.0.so.0",
+                    library: "libgobject-2.0.so.0,libglib-2.0.so.0",
                     getTypeFn: "g_option_group_get_type",
                 },
                 value: this.handle,
@@ -95,7 +99,7 @@ export class OptionGroup extends NativeObject {
                         ownership: "borrowed",
                         innerType: "OptionEntry",
                     },
-                    listType: "array",
+                    kind: "array",
                     ownership: "borrowed",
                 },
                 value: entries.map((item) => item.handle),
@@ -115,7 +119,7 @@ export class OptionGroup extends NativeObject {
                     type: "boxed",
                     ownership: "borrowed",
                     innerType: "GOptionGroup",
-                    lib: "libgobject-2.0.so.0,libglib-2.0.so.0",
+                    library: "libgobject-2.0.so.0,libglib-2.0.so.0",
                     getTypeFn: "g_option_group_get_type",
                 },
                 value: this.handle,
@@ -132,7 +136,7 @@ export class OptionGroup extends NativeObject {
                     type: "boxed",
                     ownership: "borrowed",
                     innerType: "GOptionGroup",
-                    lib: "libgobject-2.0.so.0,libglib-2.0.so.0",
+                    library: "libgobject-2.0.so.0,libglib-2.0.so.0",
                     getTypeFn: "g_option_group_get_type",
                 },
                 value: this.handle,
@@ -141,7 +145,7 @@ export class OptionGroup extends NativeObject {
             type: "boxed",
             ownership: "full",
             innerType: "GOptionGroup",
-            lib: "libgobject-2.0.so.0,libglib-2.0.so.0",
+            library: "libgobject-2.0.so.0,libglib-2.0.so.0",
             getTypeFn: "g_option_group_get_type",
         });
         return getNativeObject(ptr, OptionGroup);
@@ -157,7 +161,7 @@ export class OptionGroup extends NativeObject {
                     type: "boxed",
                     ownership: "borrowed",
                     innerType: "GOptionGroup",
-                    lib: "libgobject-2.0.so.0,libglib-2.0.so.0",
+                    library: "libgobject-2.0.so.0,libglib-2.0.so.0",
                     getTypeFn: "g_option_group_get_type",
                 },
                 value: this.handle,
@@ -185,7 +189,7 @@ export class OptionGroup extends NativeObject {
                     type: "boxed",
                     ownership: "borrowed",
                     innerType: "GOptionGroup",
-                    lib: "libgobject-2.0.so.0,libglib-2.0.so.0",
+                    library: "libgobject-2.0.so.0,libglib-2.0.so.0",
                     getTypeFn: "g_option_group_get_type",
                 },
                 value: this.handle,

package/dist/generated/glib/path-buf.d.ts

@@ -2,4 +2,142 @@ import { NativeObject } from "../../native/base.js";
 /** Stub class for PathBuf (opaque type not fully generated) */
 export declare class PathBuf extends NativeObject {
     static readonly objectType: "boxed";
+    /**
+     * Clears the contents of the path buffer.
+     *
+     * This function should be use to free the resources in a stack-allocated
+     * `GPathBuf` initialized using g_path_buf_init() or
+     * g_path_buf_init_from_path().
+     */
+    clear(): void;
+    /**
+     * Clears the contents of the path buffer and returns the built path.
+     *
+     * This function returns `NULL` if the `GPathBuf` is empty.
+     *
+     * See also: g_path_buf_to_path()
+     */
+    clearToPath(): string | null;
+    /** Frees a `GPathBuf` allocated by g_path_buf_new(). */
+    free(): void;
+    /**
+     * Frees a `GPathBuf` allocated by g_path_buf_new(), and
+     * returns the path inside the buffer.
+     *
+     * This function returns `NULL` if the `GPathBuf` is empty.
+     *
+     * See also: g_path_buf_to_path()
+     */
+    freeToPath(): string | null;
+    /** Initializes a `GPathBuf` instance. */
+    init(): PathBuf;
+    /** Initializes a `GPathBuf` instance with the given path. */
+    initFromPath(path?: string | null): PathBuf;
+    /**
+     * Removes the last element of the path buffer.
+     *
+     * If there is only one element in the path buffer (for example, `/` on
+     * Unix-like operating systems or the drive on Windows systems), it will
+     * not be removed and %FALSE will be returned instead.
+     *
+     * |[<!-- language="C" -->
+     * GPathBuf buf, cmp;
+     *
+     * g_path_buf_init_from_path (&buf, "/bin/sh");
+     *
+     * g_path_buf_pop (&buf);
+     * g_path_buf_init_from_path (&cmp, "/bin");
+     * g_assert_true (g_path_buf_equal (&buf, &cmp));
+     * g_path_buf_clear (&cmp);
+     *
+     * g_path_buf_pop (&buf);
+     * g_path_buf_init_from_path (&cmp, "/");
+     * g_assert_true (g_path_buf_equal (&buf, &cmp));
+     * g_path_buf_clear (&cmp);
+     *
+     * g_path_buf_clear (&buf);
+     * ]|
+     */
+    pop(): boolean;
+    /**
+     * Extends the given path buffer with `path`.
+     *
+     * If `path` is absolute, it replaces the current path.
+     *
+     * If `path` contains a directory separator, the buffer is extended by
+     * as many elements the path provides.
+     *
+     * On Windows, both forward slashes and backslashes are treated as
+     * directory separators. On other platforms, %G_DIR_SEPARATOR_S is the
+     * only directory separator.
+     *
+     * |[<!-- language="C" -->
+     * GPathBuf buf, cmp;
+     *
+     * g_path_buf_init_from_path (&buf, "/tmp");
+     * g_path_buf_push (&buf, ".X11-unix/X0");
+     * g_path_buf_init_from_path (&cmp, "/tmp/.X11-unix/X0");
+     * g_assert_true (g_path_buf_equal (&buf, &cmp));
+     * g_path_buf_clear (&cmp);
+     *
+     * g_path_buf_push (&buf, "/etc/locale.conf");
+     * g_path_buf_init_from_path (&cmp, "/etc/locale.conf");
+     * g_assert_true (g_path_buf_equal (&buf, &cmp));
+     * g_path_buf_clear (&cmp);
+     *
+     * g_path_buf_clear (&buf);
+     * ]|
+     */
+    push(path: string): PathBuf;
+    /**
+     * Adds an extension to the file name in the path buffer.
+     *
+     * If `extension` is `NULL`, the extension will be unset.
+     *
+     * If the path buffer does not have a file name set, this function returns
+     * `FALSE` and leaves the path buffer unmodified.
+     */
+    setExtension(extension?: string | null): boolean;
+    /**
+     * Sets the file name of the path.
+     *
+     * If the path buffer is empty, the filename is left unset and this
+     * function returns `FALSE`.
+     *
+     * If the path buffer only contains the root element (on Unix-like operating
+     * systems) or the drive (on Windows), this is the equivalent of pushing
+     * the new `file_name`.
+     *
+     * If the path buffer contains a path, this is the equivalent of
+     * popping the path buffer and pushing `file_name`, creating a
+     * sibling of the original path.
+     *
+     * |[<!-- language="C" -->
+     * GPathBuf buf, cmp;
+     *
+     * g_path_buf_init_from_path (&buf, "/");
+     *
+     * g_path_buf_set_filename (&buf, "bar");
+     * g_path_buf_init_from_path (&cmp, "/bar");
+     * g_assert_true (g_path_buf_equal (&buf, &cmp));
+     * g_path_buf_clear (&cmp);
+     *
+     * g_path_buf_set_filename (&buf, "baz.txt");
+     * g_path_buf_init_from_path (&cmp, "/baz.txt");
+     * g_assert_true (g_path_buf_equal (&buf, &cmp);
+     * g_path_buf_clear (&cmp);
+     *
+     * g_path_buf_clear (&buf);
+     * ]|
+     */
+    setFilename(fileName: string): boolean;
+    /**
+     * Retrieves the built path from the path buffer.
+     *
+     * On Windows, the result contains backslashes as directory separators,
+     * even if forward slashes were used in input.
+     *
+     * If the path buffer is empty, this function returns `NULL`.
+     */
+    toPath(): string | null;
 }

package/dist/generated/glib/path-buf.js

@@ -1,5 +1,341 @@
 import { NativeObject } from "../../native/base.js";
+import { call } from "../../native/lifecycle.js";
+import { getNativeObject } from "../../native/object.js";
 /** Stub class for PathBuf (opaque type not fully generated) */
 export class PathBuf extends NativeObject {
     static objectType = "boxed";
+    /**
+     * Clears the contents of the path buffer.
+     *
+     * This function should be use to free the resources in a stack-allocated
+     * `GPathBuf` initialized using g_path_buf_init() or
+     * g_path_buf_init_from_path().
+     */
+    clear() {
+        call("libgobject-2.0.so.0,libglib-2.0.so.0", "g_path_buf_clear", [
+            {
+                type: {
+                    type: "boxed",
+                    ownership: "borrowed",
+                    innerType: "GPathBuf",
+                    library: "libgobject-2.0.so.0,libglib-2.0.so.0",
+                },
+                value: this.handle,
+            },
+        ], {
+            type: "undefined",
+        });
+    }
+    /**
+     * Clears the contents of the path buffer and returns the built path.
+     *
+     * This function returns `NULL` if the `GPathBuf` is empty.
+     *
+     * See also: g_path_buf_to_path()
+     */
+    clearToPath() {
+        return call("libgobject-2.0.so.0,libglib-2.0.so.0", "g_path_buf_clear_to_path", [
+            {
+                type: {
+                    type: "boxed",
+                    ownership: "borrowed",
+                    innerType: "GPathBuf",
+                    library: "libgobject-2.0.so.0,libglib-2.0.so.0",
+                },
+                value: this.handle,
+            },
+        ], {
+            type: "string",
+            ownership: "full",
+        });
+    }
+    /** Frees a `GPathBuf` allocated by g_path_buf_new(). */
+    free() {
+        call("libgobject-2.0.so.0,libglib-2.0.so.0", "g_path_buf_free", [
+            {
+                type: {
+                    type: "boxed",
+                    ownership: "full",
+                    innerType: "GPathBuf",
+                    library: "libgobject-2.0.so.0,libglib-2.0.so.0",
+                },
+                value: this.handle,
+            },
+        ], {
+            type: "undefined",
+        });
+    }
+    /**
+     * Frees a `GPathBuf` allocated by g_path_buf_new(), and
+     * returns the path inside the buffer.
+     *
+     * This function returns `NULL` if the `GPathBuf` is empty.
+     *
+     * See also: g_path_buf_to_path()
+     */
+    freeToPath() {
+        return call("libgobject-2.0.so.0,libglib-2.0.so.0", "g_path_buf_free_to_path", [
+            {
+                type: {
+                    type: "boxed",
+                    ownership: "full",
+                    innerType: "GPathBuf",
+                    library: "libgobject-2.0.so.0,libglib-2.0.so.0",
+                },
+                value: this.handle,
+            },
+        ], {
+            type: "string",
+            ownership: "full",
+        });
+    }
+    /** Initializes a `GPathBuf` instance. */
+    init() {
+        const ptr = call("libgobject-2.0.so.0,libglib-2.0.so.0", "g_path_buf_init", [
+            {
+                type: {
+                    type: "boxed",
+                    ownership: "borrowed",
+                    innerType: "GPathBuf",
+                    library: "libgobject-2.0.so.0,libglib-2.0.so.0",
+                },
+                value: this.handle,
+            },
+        ], {
+            type: "struct",
+            ownership: "borrowed",
+            innerType: "PathBuf",
+        });
+        return getNativeObject(ptr, PathBuf);
+    }
+    /** Initializes a `GPathBuf` instance with the given path. */
+    initFromPath(path) {
+        const ptr = call("libgobject-2.0.so.0,libglib-2.0.so.0", "g_path_buf_init_from_path", [
+            {
+                type: {
+                    type: "boxed",
+                    ownership: "borrowed",
+                    innerType: "GPathBuf",
+                    library: "libgobject-2.0.so.0,libglib-2.0.so.0",
+                },
+                value: this.handle,
+            },
+            {
+                type: {
+                    type: "string",
+                    ownership: "borrowed",
+                },
+                value: path,
+                optional: true,
+            },
+        ], {
+            type: "struct",
+            ownership: "borrowed",
+            innerType: "PathBuf",
+        });
+        return getNativeObject(ptr, PathBuf);
+    }
+    /**
+     * Removes the last element of the path buffer.
+     *
+     * If there is only one element in the path buffer (for example, `/` on
+     * Unix-like operating systems or the drive on Windows systems), it will
+     * not be removed and %FALSE will be returned instead.
+     *
+     * |[<!-- language="C" -->
+     * GPathBuf buf, cmp;
+     *
+     * g_path_buf_init_from_path (&buf, "/bin/sh");
+     *
+     * g_path_buf_pop (&buf);
+     * g_path_buf_init_from_path (&cmp, "/bin");
+     * g_assert_true (g_path_buf_equal (&buf, &cmp));
+     * g_path_buf_clear (&cmp);
+     *
+     * g_path_buf_pop (&buf);
+     * g_path_buf_init_from_path (&cmp, "/");
+     * g_assert_true (g_path_buf_equal (&buf, &cmp));
+     * g_path_buf_clear (&cmp);
+     *
+     * g_path_buf_clear (&buf);
+     * ]|
+     */
+    pop() {
+        return call("libgobject-2.0.so.0,libglib-2.0.so.0", "g_path_buf_pop", [
+            {
+                type: {
+                    type: "boxed",
+                    ownership: "borrowed",
+                    innerType: "GPathBuf",
+                    library: "libgobject-2.0.so.0,libglib-2.0.so.0",
+                },
+                value: this.handle,
+            },
+        ], {
+            type: "boolean",
+        });
+    }
+    /**
+     * Extends the given path buffer with `path`.
+     *
+     * If `path` is absolute, it replaces the current path.
+     *
+     * If `path` contains a directory separator, the buffer is extended by
+     * as many elements the path provides.
+     *
+     * On Windows, both forward slashes and backslashes are treated as
+     * directory separators. On other platforms, %G_DIR_SEPARATOR_S is the
+     * only directory separator.
+     *
+     * |[<!-- language="C" -->
+     * GPathBuf buf, cmp;
+     *
+     * g_path_buf_init_from_path (&buf, "/tmp");
+     * g_path_buf_push (&buf, ".X11-unix/X0");
+     * g_path_buf_init_from_path (&cmp, "/tmp/.X11-unix/X0");
+     * g_assert_true (g_path_buf_equal (&buf, &cmp));
+     * g_path_buf_clear (&cmp);
+     *
+     * g_path_buf_push (&buf, "/etc/locale.conf");
+     * g_path_buf_init_from_path (&cmp, "/etc/locale.conf");
+     * g_assert_true (g_path_buf_equal (&buf, &cmp));
+     * g_path_buf_clear (&cmp);
+     *
+     * g_path_buf_clear (&buf);
+     * ]|
+     */
+    push(path) {
+        const ptr = call("libgobject-2.0.so.0,libglib-2.0.so.0", "g_path_buf_push", [
+            {
+                type: {
+                    type: "boxed",
+                    ownership: "borrowed",
+                    innerType: "GPathBuf",
+                    library: "libgobject-2.0.so.0,libglib-2.0.so.0",
+                },
+                value: this.handle,
+            },
+            {
+                type: {
+                    type: "string",
+                    ownership: "borrowed",
+                },
+                value: path,
+            },
+        ], {
+            type: "struct",
+            ownership: "borrowed",
+            innerType: "PathBuf",
+        });
+        return getNativeObject(ptr, PathBuf);
+    }
+    /**
+     * Adds an extension to the file name in the path buffer.
+     *
+     * If `extension` is `NULL`, the extension will be unset.
+     *
+     * If the path buffer does not have a file name set, this function returns
+     * `FALSE` and leaves the path buffer unmodified.
+     */
+    setExtension(extension) {
+        return call("libgobject-2.0.so.0,libglib-2.0.so.0", "g_path_buf_set_extension", [
+            {
+                type: {
+                    type: "boxed",
+                    ownership: "borrowed",
+                    innerType: "GPathBuf",
+                    library: "libgobject-2.0.so.0,libglib-2.0.so.0",
+                },
+                value: this.handle,
+            },
+            {
+                type: {
+                    type: "string",
+                    ownership: "borrowed",
+                },
+                value: extension,
+                optional: true,
+            },
+        ], {
+            type: "boolean",
+        });
+    }
+    /**
+     * Sets the file name of the path.
+     *
+     * If the path buffer is empty, the filename is left unset and this
+     * function returns `FALSE`.
+     *
+     * If the path buffer only contains the root element (on Unix-like operating
+     * systems) or the drive (on Windows), this is the equivalent of pushing
+     * the new `file_name`.
+     *
+     * If the path buffer contains a path, this is the equivalent of
+     * popping the path buffer and pushing `file_name`, creating a
+     * sibling of the original path.
+     *
+     * |[<!-- language="C" -->
+     * GPathBuf buf, cmp;
+     *
+     * g_path_buf_init_from_path (&buf, "/");
+     *
+     * g_path_buf_set_filename (&buf, "bar");
+     * g_path_buf_init_from_path (&cmp, "/bar");
+     * g_assert_true (g_path_buf_equal (&buf, &cmp));
+     * g_path_buf_clear (&cmp);
+     *
+     * g_path_buf_set_filename (&buf, "baz.txt");
+     * g_path_buf_init_from_path (&cmp, "/baz.txt");
+     * g_assert_true (g_path_buf_equal (&buf, &cmp);
+     * g_path_buf_clear (&cmp);
+     *
+     * g_path_buf_clear (&buf);
+     * ]|
+     */
+    setFilename(fileName) {
+        return call("libgobject-2.0.so.0,libglib-2.0.so.0", "g_path_buf_set_filename", [
+            {
+                type: {
+                    type: "boxed",
+                    ownership: "borrowed",
+                    innerType: "GPathBuf",
+                    library: "libgobject-2.0.so.0,libglib-2.0.so.0",
+                },
+                value: this.handle,
+            },
+            {
+                type: {
+                    type: "string",
+                    ownership: "borrowed",
+                },
+                value: fileName,
+            },
+        ], {
+            type: "boolean",
+        });
+    }
+    /**
+     * Retrieves the built path from the path buffer.
+     *
+     * On Windows, the result contains backslashes as directory separators,
+     * even if forward slashes were used in input.
+     *
+     * If the path buffer is empty, this function returns `NULL`.
+     */
+    toPath() {
+        return call("libgobject-2.0.so.0,libglib-2.0.so.0", "g_path_buf_to_path", [
+            {
+                type: {
+                    type: "boxed",
+                    ownership: "borrowed",
+                    innerType: "GPathBuf",
+                    library: "libgobject-2.0.so.0,libglib-2.0.so.0",
+                },
+                value: this.handle,
+            },
+        ], {
+            type: "string",
+            ownership: "full",
+        });
+    }
 }