@gtkx/ffi 0.15.0 → 0.17.1

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

@@ -1,5 +1,631 @@
 import { NativeObject } from "../../native/base.js";
+import { call } from "../../native/lifecycle.js";
+import { NativeError } from "../../native/error.js";
+import { getNativeObject } from "../../native/object.js";
+import { GError } from "./error.js";
+import { OptionGroup } from "./option-group.js";
 /** Stub class for OptionContext (opaque type not fully generated) */
 export class OptionContext extends NativeObject {
     static objectType = "boxed";
+    /**
+     * Adds a #GOptionGroup to the `context`, so that parsing with `context`
+     * will recognize the options in the group. Note that this will take
+     * ownership of the `group` and thus the `group` should not be freed.
+     */
+    addGroup(group) {
+        call("libgobject-2.0.so.0,libglib-2.0.so.0", "g_option_context_add_group", [
+            {
+                type: {
+                    type: "boxed",
+                    ownership: "borrowed",
+                    innerType: "GOptionContext",
+                    library: "libgobject-2.0.so.0,libglib-2.0.so.0",
+                },
+                value: this.handle,
+            },
+            {
+                type: {
+                    type: "boxed",
+                    ownership: "full",
+                    innerType: "GOptionGroup",
+                    library: "libgobject-2.0.so.0,libglib-2.0.so.0",
+                    getTypeFn: "g_option_group_get_type",
+                },
+                value: group.handle,
+            },
+        ], {
+            type: "undefined",
+        });
+    }
+    /**
+     * A convenience function which creates a main group if it doesn't
+     * exist, adds the `entries` to it and sets the translation domain.
+     */
+    addMainEntries(entries, translationDomain) {
+        call("libgobject-2.0.so.0,libglib-2.0.so.0", "g_option_context_add_main_entries", [
+            {
+                type: {
+                    type: "boxed",
+                    ownership: "borrowed",
+                    innerType: "GOptionContext",
+                    library: "libgobject-2.0.so.0,libglib-2.0.so.0",
+                },
+                value: this.handle,
+            },
+            {
+                type: {
+                    type: "array",
+                    itemType: {
+                        type: "struct",
+                        ownership: "borrowed",
+                        innerType: "OptionEntry",
+                    },
+                    kind: "array",
+                    ownership: "borrowed",
+                },
+                value: entries.map((item) => item.handle),
+            },
+            {
+                type: {
+                    type: "string",
+                    ownership: "borrowed",
+                },
+                value: translationDomain,
+                optional: true,
+            },
+        ], {
+            type: "undefined",
+        });
+    }
+    /**
+     * Frees context and all the groups which have been
+     * added to it.
+     *
+     * Please note that parsed arguments need to be freed separately (see
+     * #GOptionEntry).
+     */
+    free() {
+        call("libgobject-2.0.so.0,libglib-2.0.so.0", "g_option_context_free", [
+            {
+                type: {
+                    type: "boxed",
+                    ownership: "full",
+                    innerType: "GOptionContext",
+                    library: "libgobject-2.0.so.0,libglib-2.0.so.0",
+                },
+                value: this.handle,
+            },
+        ], {
+            type: "undefined",
+        });
+    }
+    /** Returns the description. See g_option_context_set_description(). */
+    getDescription() {
+        return call("libgobject-2.0.so.0,libglib-2.0.so.0", "g_option_context_get_description", [
+            {
+                type: {
+                    type: "boxed",
+                    ownership: "borrowed",
+                    innerType: "GOptionContext",
+                    library: "libgobject-2.0.so.0,libglib-2.0.so.0",
+                },
+                value: this.handle,
+            },
+        ], {
+            type: "string",
+            ownership: "borrowed",
+        });
+    }
+    /**
+     * Returns a formatted, translated help text for the given context.
+     * To obtain the text produced by `--help`, call
+     * `g_option_context_get_help (context, TRUE, NULL)`.
+     * To obtain the text produced by `--help-all`, call
+     * `g_option_context_get_help (context, FALSE, NULL)`.
+     * To obtain the help text for an option group, call
+     * `g_option_context_get_help (context, FALSE, group)`.
+     */
+    getHelp(mainHelp, group) {
+        return call("libgobject-2.0.so.0,libglib-2.0.so.0", "g_option_context_get_help", [
+            {
+                type: {
+                    type: "boxed",
+                    ownership: "borrowed",
+                    innerType: "GOptionContext",
+                    library: "libgobject-2.0.so.0,libglib-2.0.so.0",
+                },
+                value: this.handle,
+            },
+            {
+                type: {
+                    type: "boolean",
+                },
+                value: mainHelp,
+            },
+            {
+                type: {
+                    type: "boxed",
+                    ownership: "borrowed",
+                    innerType: "GOptionGroup",
+                    library: "libgobject-2.0.so.0,libglib-2.0.so.0",
+                    getTypeFn: "g_option_group_get_type",
+                },
+                value: group?.handle,
+                optional: true,
+            },
+        ], {
+            type: "string",
+            ownership: "full",
+        });
+    }
+    /**
+     * Returns whether automatic `--help` generation
+     * is turned on for `context`. See g_option_context_set_help_enabled().
+     */
+    getHelpEnabled() {
+        return call("libgobject-2.0.so.0,libglib-2.0.so.0", "g_option_context_get_help_enabled", [
+            {
+                type: {
+                    type: "boxed",
+                    ownership: "borrowed",
+                    innerType: "GOptionContext",
+                    library: "libgobject-2.0.so.0,libglib-2.0.so.0",
+                },
+                value: this.handle,
+            },
+        ], {
+            type: "boolean",
+        });
+    }
+    /**
+     * Returns whether unknown options are ignored or not. See
+     * g_option_context_set_ignore_unknown_options().
+     */
+    getIgnoreUnknownOptions() {
+        return call("libgobject-2.0.so.0,libglib-2.0.so.0", "g_option_context_get_ignore_unknown_options", [
+            {
+                type: {
+                    type: "boxed",
+                    ownership: "borrowed",
+                    innerType: "GOptionContext",
+                    library: "libgobject-2.0.so.0,libglib-2.0.so.0",
+                },
+                value: this.handle,
+            },
+        ], {
+            type: "boolean",
+        });
+    }
+    /** Returns a pointer to the main group of `context`. */
+    getMainGroup() {
+        const ptr = call("libgobject-2.0.so.0,libglib-2.0.so.0", "g_option_context_get_main_group", [
+            {
+                type: {
+                    type: "boxed",
+                    ownership: "borrowed",
+                    innerType: "GOptionContext",
+                    library: "libgobject-2.0.so.0,libglib-2.0.so.0",
+                },
+                value: this.handle,
+            },
+        ], {
+            type: "boxed",
+            ownership: "borrowed",
+            innerType: "GOptionGroup",
+            library: "libgobject-2.0.so.0,libglib-2.0.so.0",
+            getTypeFn: "g_option_group_get_type",
+        });
+        return getNativeObject(ptr, OptionGroup);
+    }
+    /**
+     * Returns whether strict POSIX code is enabled.
+     *
+     * See g_option_context_set_strict_posix() for more information.
+     */
+    getStrictPosix() {
+        return call("libgobject-2.0.so.0,libglib-2.0.so.0", "g_option_context_get_strict_posix", [
+            {
+                type: {
+                    type: "boxed",
+                    ownership: "borrowed",
+                    innerType: "GOptionContext",
+                    library: "libgobject-2.0.so.0,libglib-2.0.so.0",
+                },
+                value: this.handle,
+            },
+        ], {
+            type: "boolean",
+        });
+    }
+    /** Returns the summary. See g_option_context_set_summary(). */
+    getSummary() {
+        return call("libgobject-2.0.so.0,libglib-2.0.so.0", "g_option_context_get_summary", [
+            {
+                type: {
+                    type: "boxed",
+                    ownership: "borrowed",
+                    innerType: "GOptionContext",
+                    library: "libgobject-2.0.so.0,libglib-2.0.so.0",
+                },
+                value: this.handle,
+            },
+        ], {
+            type: "string",
+            ownership: "borrowed",
+        });
+    }
+    /**
+     * Parses the command line arguments, recognizing options
+     * which have been added to `context`. A side-effect of
+     * calling this function is that g_set_prgname() will be
+     * called.
+     *
+     * If the parsing is successful, any parsed arguments are
+     * removed from the array and `argc` and `argv` are updated
+     * accordingly. A '--' option is stripped from `argv`
+     * unless there are unparsed options before and after it,
+     * or some of the options after it start with '-'. In case
+     * of an error, `argc` and `argv` are left unmodified.
+     *
+     * If automatic `--help` support is enabled
+     * (see g_option_context_set_help_enabled()), and the
+     * `argv` array contains one of the recognized help options,
+     * this function will produce help output to stdout and
+     * call `exit (0)`.
+     *
+     * Note that function depends on the
+     * current locale for automatic
+     * character set conversion of string and filename arguments.
+     */
+    parse(argc, argv) {
+        const error = { value: null };
+        const result = call("libgobject-2.0.so.0,libglib-2.0.so.0", "g_option_context_parse", [
+            {
+                type: {
+                    type: "boxed",
+                    ownership: "borrowed",
+                    innerType: "GOptionContext",
+                    library: "libgobject-2.0.so.0,libglib-2.0.so.0",
+                },
+                value: this.handle,
+            },
+            {
+                type: {
+                    type: "ref",
+                    innerType: {
+                        type: "int",
+                        size: 32,
+                        unsigned: false,
+                    },
+                },
+                value: argc,
+                optional: true,
+            },
+            {
+                type: {
+                    type: "ref",
+                    innerType: {
+                        type: "array",
+                        itemType: {
+                            type: "string",
+                            ownership: "full",
+                        },
+                        kind: "sized",
+                        sizeParamIndex: 1,
+                        ownership: "full",
+                    },
+                },
+                value: argv,
+                optional: true,
+            },
+            {
+                type: {
+                    type: "ref",
+                    innerType: {
+                        type: "boxed",
+                        ownership: "full",
+                        innerType: "GError",
+                        library: "libgobject-2.0.so.0",
+                        getTypeFn: "g_error_get_type",
+                    },
+                },
+                value: error,
+            },
+        ], {
+            type: "boolean",
+        });
+        if (error.value !== null) {
+            throw new NativeError(getNativeObject(error.value, GError));
+        }
+        return result;
+    }
+    /**
+     * Parses the command line arguments.
+     *
+     * This function is similar to g_option_context_parse() except that it
+     * respects the normal memory rules when dealing with a strv instead of
+     * assuming that the passed-in array is the argv of the main function.
+     *
+     * In particular, strings that are removed from the arguments list will
+     * be freed using g_free().
+     *
+     * On Windows, the strings are expected to be in UTF-8.  This is in
+     * contrast to g_option_context_parse() which expects them to be in the
+     * system codepage, which is how they are passed as `argv` to main().
+     * See g_win32_get_command_line() for a solution.
+     *
+     * This function is useful if you are trying to use #GOptionContext with
+     * #GApplication.
+     */
+    parseStrv(arguments_) {
+        const error = { value: null };
+        const result = call("libgobject-2.0.so.0,libglib-2.0.so.0", "g_option_context_parse_strv", [
+            {
+                type: {
+                    type: "boxed",
+                    ownership: "borrowed",
+                    innerType: "GOptionContext",
+                    library: "libgobject-2.0.so.0,libglib-2.0.so.0",
+                },
+                value: this.handle,
+            },
+            {
+                type: {
+                    type: "ref",
+                    innerType: {
+                        type: "array",
+                        itemType: {
+                            type: "string",
+                            ownership: "full",
+                        },
+                        kind: "array",
+                        ownership: "full",
+                    },
+                },
+                value: arguments_,
+                optional: true,
+            },
+            {
+                type: {
+                    type: "ref",
+                    innerType: {
+                        type: "boxed",
+                        ownership: "full",
+                        innerType: "GError",
+                        library: "libgobject-2.0.so.0",
+                        getTypeFn: "g_error_get_type",
+                    },
+                },
+                value: error,
+            },
+        ], {
+            type: "boolean",
+        });
+        if (error.value !== null) {
+            throw new NativeError(getNativeObject(error.value, GError));
+        }
+        return result;
+    }
+    /**
+     * Adds a string to be displayed in `--help` output after the list
+     * of options. This text often includes a bug reporting address.
+     *
+     * Note that the summary is translated (see
+     * g_option_context_set_translate_func()).
+     */
+    setDescription(description) {
+        call("libgobject-2.0.so.0,libglib-2.0.so.0", "g_option_context_set_description", [
+            {
+                type: {
+                    type: "boxed",
+                    ownership: "borrowed",
+                    innerType: "GOptionContext",
+                    library: "libgobject-2.0.so.0,libglib-2.0.so.0",
+                },
+                value: this.handle,
+            },
+            {
+                type: {
+                    type: "string",
+                    ownership: "borrowed",
+                },
+                value: description,
+                optional: true,
+            },
+        ], {
+            type: "undefined",
+        });
+    }
+    /**
+     * Enables or disables automatic generation of `--help` output.
+     * By default, g_option_context_parse() recognizes `--help`, `-h`,
+     * `-?`, `--help-all` and `--help-groupname` and creates suitable
+     * output to stdout.
+     */
+    setHelpEnabled(helpEnabled) {
+        call("libgobject-2.0.so.0,libglib-2.0.so.0", "g_option_context_set_help_enabled", [
+            {
+                type: {
+                    type: "boxed",
+                    ownership: "borrowed",
+                    innerType: "GOptionContext",
+                    library: "libgobject-2.0.so.0,libglib-2.0.so.0",
+                },
+                value: this.handle,
+            },
+            {
+                type: {
+                    type: "boolean",
+                },
+                value: helpEnabled,
+            },
+        ], {
+            type: "undefined",
+        });
+    }
+    /**
+     * Sets whether to ignore unknown options or not. If an argument is
+     * ignored, it is left in the `argv` array after parsing. By default,
+     * g_option_context_parse() treats unknown options as error.
+     *
+     * This setting does not affect non-option arguments (i.e. arguments
+     * which don't start with a dash). But note that GOption cannot reliably
+     * determine whether a non-option belongs to a preceding unknown option.
+     */
+    setIgnoreUnknownOptions(ignoreUnknown) {
+        call("libgobject-2.0.so.0,libglib-2.0.so.0", "g_option_context_set_ignore_unknown_options", [
+            {
+                type: {
+                    type: "boxed",
+                    ownership: "borrowed",
+                    innerType: "GOptionContext",
+                    library: "libgobject-2.0.so.0,libglib-2.0.so.0",
+                },
+                value: this.handle,
+            },
+            {
+                type: {
+                    type: "boolean",
+                },
+                value: ignoreUnknown,
+            },
+        ], {
+            type: "undefined",
+        });
+    }
+    /**
+     * Sets a #GOptionGroup as main group of the `context`.
+     * This has the same effect as calling g_option_context_add_group(),
+     * the only difference is that the options in the main group are
+     * treated differently when generating `--help` output.
+     */
+    setMainGroup(group) {
+        call("libgobject-2.0.so.0,libglib-2.0.so.0", "g_option_context_set_main_group", [
+            {
+                type: {
+                    type: "boxed",
+                    ownership: "borrowed",
+                    innerType: "GOptionContext",
+                    library: "libgobject-2.0.so.0,libglib-2.0.so.0",
+                },
+                value: this.handle,
+            },
+            {
+                type: {
+                    type: "boxed",
+                    ownership: "full",
+                    innerType: "GOptionGroup",
+                    library: "libgobject-2.0.so.0,libglib-2.0.so.0",
+                    getTypeFn: "g_option_group_get_type",
+                },
+                value: group.handle,
+            },
+        ], {
+            type: "undefined",
+        });
+    }
+    /**
+     * Sets strict POSIX mode.
+     *
+     * By default, this mode is disabled.
+     *
+     * In strict POSIX mode, the first non-argument parameter encountered
+     * (eg: filename) terminates argument processing.  Remaining arguments
+     * are treated as non-options and are not attempted to be parsed.
+     *
+     * If strict POSIX mode is disabled then parsing is done in the GNU way
+     * where option arguments can be freely mixed with non-options.
+     *
+     * As an example, consider "ls foo -l".  With GNU style parsing, this
+     * will list "foo" in long mode.  In strict POSIX style, this will list
+     * the files named "foo" and "-l".
+     *
+     * It may be useful to force strict POSIX mode when creating "verb
+     * style" command line tools.  For example, the "gsettings" command line
+     * tool supports the global option "--schemadir" as well as many
+     * subcommands ("get", "set", etc.) which each have their own set of
+     * arguments.  Using strict POSIX mode will allow parsing the global
+     * options up to the verb name while leaving the remaining options to be
+     * parsed by the relevant subcommand (which can be determined by
+     * examining the verb name, which should be present in argv[1] after
+     * parsing).
+     */
+    setStrictPosix(strictPosix) {
+        call("libgobject-2.0.so.0,libglib-2.0.so.0", "g_option_context_set_strict_posix", [
+            {
+                type: {
+                    type: "boxed",
+                    ownership: "borrowed",
+                    innerType: "GOptionContext",
+                    library: "libgobject-2.0.so.0,libglib-2.0.so.0",
+                },
+                value: this.handle,
+            },
+            {
+                type: {
+                    type: "boolean",
+                },
+                value: strictPosix,
+            },
+        ], {
+            type: "undefined",
+        });
+    }
+    /**
+     * Adds a string to be displayed in `--help` output before the list
+     * of options. This is typically a summary of the program functionality.
+     *
+     * Note that the summary is translated (see
+     * g_option_context_set_translate_func() and
+     * g_option_context_set_translation_domain()).
+     */
+    setSummary(summary) {
+        call("libgobject-2.0.so.0,libglib-2.0.so.0", "g_option_context_set_summary", [
+            {
+                type: {
+                    type: "boxed",
+                    ownership: "borrowed",
+                    innerType: "GOptionContext",
+                    library: "libgobject-2.0.so.0,libglib-2.0.so.0",
+                },
+                value: this.handle,
+            },
+            {
+                type: {
+                    type: "string",
+                    ownership: "borrowed",
+                },
+                value: summary,
+                optional: true,
+            },
+        ], {
+            type: "undefined",
+        });
+    }
+    /**
+     * A convenience function to use gettext() for translating
+     * user-visible strings.
+     */
+    setTranslationDomain(domain) {
+        call("libgobject-2.0.so.0,libglib-2.0.so.0", "g_option_context_set_translation_domain", [
+            {
+                type: {
+                    type: "boxed",
+                    ownership: "borrowed",
+                    innerType: "GOptionContext",
+                    library: "libgobject-2.0.so.0,libglib-2.0.so.0",
+                },
+                value: this.handle,
+            },
+            {
+                type: {
+                    type: "string",
+                    ownership: "borrowed",
+                },
+                value: domain,
+            },
+        ], {
+            type: "undefined",
+        });
+    }
 }

package/dist/generated/glib/option-entry.d.ts

@@ -1,5 +1,57 @@
 import { NativeObject } from "../../native/base.js";
-/** Stub class for OptionEntry (opaque type not fully generated) */
+export type OptionEntryInit = {
+    shortName?: number;
+    flags?: number;
+};
+/**
+ * - %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 declare class OptionEntry extends NativeObject {
-    static readonly objectType: "boxed";
+    static readonly objectType: "struct";
+    constructor(init?: OptionEntryInit);
+    /**
+     * 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(): string;
+    /**
+     * 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(): number;
+    /** Flags from #GOptionFlags */
+    getFlags(): number;
+    /**
+     * 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(): string;
+    /**
+     * 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(): string;
 }