@gtkx/ffi 0.6.0 → 0.7.0

package/dist/generated/vte/constants.d.ts

@@ -0,0 +1,145 @@
+/**
+ * The major version number of the VTE library
+ * (e.g. in version 3.1.4 this is 3).
+ */
+export declare const MAJOR_VERSION = 0;
+/**
+ * The micro version number of the VTE library
+ * (e.g. in version 3.1.4 this is 4).
+ */
+export declare const MICRO_VERSION = 2;
+/**
+ * The minor version number of the VTE library
+ * (e.g. in version 3.1.4 this is 1).
+ */
+export declare const MINOR_VERSION = 82;
+export declare const REGEX_FLAGS_DEFAULT = 1075314688;
+/**
+ * Use this as a spawn flag (together with flags from #GSpawnFlags) in
+ * vte_pty_spawn_async().
+ *
+ * Normally, the spawned process inherits the environment from the parent
+ * process; when this flag is used, only the environment variables passed
+ * to vte_pty_spawn_async() etc. are passed to the child process.
+ */
+export declare const SPAWN_NO_PARENT_ENVV = 33554432;
+/**
+ * Use this as a spawn flag (together with flags from #GSpawnFlags) in
+ * vte_pty_spawn_async().
+ *
+ * Prevents vte_pty_spawn_async() etc. from moving the newly created child
+ * process to a systemd user scope.
+ */
+export declare const SPAWN_NO_SYSTEMD_SCOPE = 67108864;
+/**
+ * Use this as a spawn flag (together with flags from #GSpawnFlags) in
+ * vte_pty_spawn_async().
+ *
+ * Requires vte_pty_spawn_async() etc. to move the newly created child
+ * process to a systemd user scope; if that fails, the whole spawn fails.
+ *
+ * This is supported on Linux only.
+ */
+export declare const SPAWN_REQUIRE_SYSTEMD_SCOPE = 134217728;
+/**
+ * A %VTE_PROPERTY_STRING termprop that stores the name of the
+ * container.
+ */
+export declare const TERMPROP_CONTAINER_NAME = "vte.container.name";
+/**
+ * A %VTE_PROPERTY_STRING termprop that stores the runtime of the
+ * container.
+ */
+export declare const TERMPROP_CONTAINER_RUNTIME = "vte.container.runtime";
+/**
+ * A %VTE_PROPERTY_UINT termprop that stores the user ID of the
+ * container.
+ */
+export declare const TERMPROP_CONTAINER_UID = "vte.container.uid";
+/**
+ * A %VTE_PROPERTY_URI termprop that stores the current directory
+ * URI as set by OSC 7.
+ * Use this with vte_terminal_ref_termprop_uri() instead of using
+ * vte_terminal_get_current_directory_uri().
+ *
+ * Note that this termprop is not settable via the termprop OSC.
+ */
+export declare const TERMPROP_CURRENT_DIRECTORY_URI = "vte.cwd";
+/**
+ * A %VTE_PROPERTY_URI termprop that stores the current file URI
+ * as set by OSC 6.
+ * Use this with vte_terminal_ref_termprop_uri() instead of using
+ * vte_terminal_get_current_file_uri().
+ *
+ * Note that this termprop is not settable via the termprop OSC.
+ */
+export declare const TERMPROP_CURRENT_FILE_URI = "vte.cwf";
+export declare const TERMPROP_ICON_COLOR = "vte.icon.color";
+/**
+ * A %VTE_PROPERTY_IMAGE termprop to specify an image for use
+ * as a favicon.
+ *
+ * Applications should prefer to use this termprop, if set, over
+ * the %VTE_TERMPROP_ICON_COLOR color.
+ *
+ * Note that in this vte version, this termprop is always unset.
+ */
+export declare const TERMPROP_ICON_IMAGE = "vte.icon.image";
+/**
+ * The string prefix that any termprop's name must start with to be installed
+ * by vte_install_termprop().
+ */
+export declare const TERMPROP_NAME_PREFIX = "vte.ext.";
+/**
+ * A %VTE_PROPERTY_INT termprop that stores a hint how to interpret
+ * the %VTE_TERMPROP_PROGRESS_VALUE termprop value. If set, this
+ * termprop's value will be from the #VteProgressHint enumeration.
+ * An unset termprop should be treated as if it had value
+ * %VTE_PROGRESS_HINT_ACTIVE if the %VTE_TERMPROP_PROGRESS_VALUE
+ * termprop has a value
+ *
+ * Note that this termprop never will have the value
+ * %VTE_PROGRESS_HINT_INACTIVE.
+ *
+ * The value of this termprop should be ignored unless the
+ * %VTE_TERMPROP_PROGRESS_VALUE termprop has a value.
+ *
+ * Note that before version 0.82, this termprop could not be set by
+ * the termprop OSC, but instead only by OSC 9 ; 4 (ConEmu progress).
+ */
+export declare const TERMPROP_PROGRESS_HINT = "vte.progress.hint";
+/**
+ * A %VTE_PROPERTY_UINT termprop that stores the progress of the running
+ * command as a value between 0 and 100.
+ *
+ * Note that before version 0.82, this termprop could not be set by
+ * the termprop OSC, but instead only by OSC 9 ; 4 (ConEmu progress).
+ */
+export declare const TERMPROP_PROGRESS_VALUE = "vte.progress.value";
+/**
+ * An ephemeral %VTE_PROPERTY_UINT termprop that signals that the shell
+ * has executed the commands entered at the prompt and these commands
+ * have returned. The termprop value is the exit code.
+ */
+export declare const TERMPROP_SHELL_POSTEXEC = "vte.shell.postexec";
+/**
+ * A %VTE_PROPERTY_VALUELESS termprop that signals that the shell
+ * is going to prompt.
+ */
+export declare const TERMPROP_SHELL_PRECMD = "vte.shell.precmd";
+/**
+ * A %VTE_PROPERTY_VALUELESS termprop that signals that the shell
+ * is preparing to execute the command entered at the prompt.
+ */
+export declare const TERMPROP_SHELL_PREEXEC = "vte.shell.preexec";
+/**
+ * A %VTE_PROPERTY_STRING termprop that stores the xterm window title
+ * as set by OSC 0 and OSC 2.
+ * Use this with vte_terminal_get_termprop_string() instead of using
+ * vte_terminal_get_window_title().
+ *
+ * Note that this termprop is not settable via the termprop OSC.
+ */
+export declare const TERMPROP_XTERM_TITLE = "xterm.title";
+export declare const TEST_FLAGS_ALL = 18446744073709552000;
+export declare const TEST_FLAGS_NONE = 0;

package/dist/generated/vte/constants.js

@@ -0,0 +1,145 @@
+/**
+ * The major version number of the VTE library
+ * (e.g. in version 3.1.4 this is 3).
+ */
+export const MAJOR_VERSION = 0;
+/**
+ * The micro version number of the VTE library
+ * (e.g. in version 3.1.4 this is 4).
+ */
+export const MICRO_VERSION = 2;
+/**
+ * The minor version number of the VTE library
+ * (e.g. in version 3.1.4 this is 1).
+ */
+export const MINOR_VERSION = 82;
+export const REGEX_FLAGS_DEFAULT = 1075314688;
+/**
+ * Use this as a spawn flag (together with flags from #GSpawnFlags) in
+ * vte_pty_spawn_async().
+ *
+ * Normally, the spawned process inherits the environment from the parent
+ * process; when this flag is used, only the environment variables passed
+ * to vte_pty_spawn_async() etc. are passed to the child process.
+ */
+export const SPAWN_NO_PARENT_ENVV = 33554432;
+/**
+ * Use this as a spawn flag (together with flags from #GSpawnFlags) in
+ * vte_pty_spawn_async().
+ *
+ * Prevents vte_pty_spawn_async() etc. from moving the newly created child
+ * process to a systemd user scope.
+ */
+export const SPAWN_NO_SYSTEMD_SCOPE = 67108864;
+/**
+ * Use this as a spawn flag (together with flags from #GSpawnFlags) in
+ * vte_pty_spawn_async().
+ *
+ * Requires vte_pty_spawn_async() etc. to move the newly created child
+ * process to a systemd user scope; if that fails, the whole spawn fails.
+ *
+ * This is supported on Linux only.
+ */
+export const SPAWN_REQUIRE_SYSTEMD_SCOPE = 134217728;
+/**
+ * A %VTE_PROPERTY_STRING termprop that stores the name of the
+ * container.
+ */
+export const TERMPROP_CONTAINER_NAME = "vte.container.name";
+/**
+ * A %VTE_PROPERTY_STRING termprop that stores the runtime of the
+ * container.
+ */
+export const TERMPROP_CONTAINER_RUNTIME = "vte.container.runtime";
+/**
+ * A %VTE_PROPERTY_UINT termprop that stores the user ID of the
+ * container.
+ */
+export const TERMPROP_CONTAINER_UID = "vte.container.uid";
+/**
+ * A %VTE_PROPERTY_URI termprop that stores the current directory
+ * URI as set by OSC 7.
+ * Use this with vte_terminal_ref_termprop_uri() instead of using
+ * vte_terminal_get_current_directory_uri().
+ *
+ * Note that this termprop is not settable via the termprop OSC.
+ */
+export const TERMPROP_CURRENT_DIRECTORY_URI = "vte.cwd";
+/**
+ * A %VTE_PROPERTY_URI termprop that stores the current file URI
+ * as set by OSC 6.
+ * Use this with vte_terminal_ref_termprop_uri() instead of using
+ * vte_terminal_get_current_file_uri().
+ *
+ * Note that this termprop is not settable via the termprop OSC.
+ */
+export const TERMPROP_CURRENT_FILE_URI = "vte.cwf";
+export const TERMPROP_ICON_COLOR = "vte.icon.color";
+/**
+ * A %VTE_PROPERTY_IMAGE termprop to specify an image for use
+ * as a favicon.
+ *
+ * Applications should prefer to use this termprop, if set, over
+ * the %VTE_TERMPROP_ICON_COLOR color.
+ *
+ * Note that in this vte version, this termprop is always unset.
+ */
+export const TERMPROP_ICON_IMAGE = "vte.icon.image";
+/**
+ * The string prefix that any termprop's name must start with to be installed
+ * by vte_install_termprop().
+ */
+export const TERMPROP_NAME_PREFIX = "vte.ext.";
+/**
+ * A %VTE_PROPERTY_INT termprop that stores a hint how to interpret
+ * the %VTE_TERMPROP_PROGRESS_VALUE termprop value. If set, this
+ * termprop's value will be from the #VteProgressHint enumeration.
+ * An unset termprop should be treated as if it had value
+ * %VTE_PROGRESS_HINT_ACTIVE if the %VTE_TERMPROP_PROGRESS_VALUE
+ * termprop has a value
+ *
+ * Note that this termprop never will have the value
+ * %VTE_PROGRESS_HINT_INACTIVE.
+ *
+ * The value of this termprop should be ignored unless the
+ * %VTE_TERMPROP_PROGRESS_VALUE termprop has a value.
+ *
+ * Note that before version 0.82, this termprop could not be set by
+ * the termprop OSC, but instead only by OSC 9 ; 4 (ConEmu progress).
+ */
+export const TERMPROP_PROGRESS_HINT = "vte.progress.hint";
+/**
+ * A %VTE_PROPERTY_UINT termprop that stores the progress of the running
+ * command as a value between 0 and 100.
+ *
+ * Note that before version 0.82, this termprop could not be set by
+ * the termprop OSC, but instead only by OSC 9 ; 4 (ConEmu progress).
+ */
+export const TERMPROP_PROGRESS_VALUE = "vte.progress.value";
+/**
+ * An ephemeral %VTE_PROPERTY_UINT termprop that signals that the shell
+ * has executed the commands entered at the prompt and these commands
+ * have returned. The termprop value is the exit code.
+ */
+export const TERMPROP_SHELL_POSTEXEC = "vte.shell.postexec";
+/**
+ * A %VTE_PROPERTY_VALUELESS termprop that signals that the shell
+ * is going to prompt.
+ */
+export const TERMPROP_SHELL_PRECMD = "vte.shell.precmd";
+/**
+ * A %VTE_PROPERTY_VALUELESS termprop that signals that the shell
+ * is preparing to execute the command entered at the prompt.
+ */
+export const TERMPROP_SHELL_PREEXEC = "vte.shell.preexec";
+/**
+ * A %VTE_PROPERTY_STRING termprop that stores the xterm window title
+ * as set by OSC 0 and OSC 2.
+ * Use this with vte_terminal_get_termprop_string() instead of using
+ * vte_terminal_get_window_title().
+ *
+ * Note that this termprop is not settable via the termprop OSC.
+ */
+export const TERMPROP_XTERM_TITLE = "xterm.title";
+export const TEST_FLAGS_ALL = 18446744073709551615;
+export const TEST_FLAGS_NONE = 0;

package/dist/generated/vte/index.d.ts

@@ -4,3 +4,4 @@ export * from "./uuid.js";
 export * from "./pty.js";
 export * from "./terminal.js";
 export * from "./functions.js";
+export * from "./constants.js";

package/dist/generated/vte/index.js

@@ -4,3 +4,4 @@ export * from "./uuid.js";
 export * from "./pty.js";
 export * from "./terminal.js";
 export * from "./functions.js";
+export * from "./constants.js";

package/dist/generated/vte/pty.d.ts

@@ -81,6 +81,48 @@ export declare class Pty extends GObject.GObject {
      * @param childPid - a location to store the child PID, or %NULL
      */
     spawnFinish(result: Gio.AsyncResult, childPid?: Ref<number> | null): boolean;
+    /**
+     * Initializes the object implementing the interface.
+     *
+     * This method is intended for language bindings. If writing in C,
+     * g_initable_new() should typically be used instead.
+     *
+     * The object must be initialized before any real use after initial
+     * construction, either with this function or g_async_initable_init_async().
+     *
+     * Implementations may also support cancellation. If `cancellable` is not %NULL,
+     * then initialization can be cancelled by triggering the cancellable object
+     * from another thread. If the operation was cancelled, the error
+     * %G_IO_ERROR_CANCELLED will be returned. If `cancellable` is not %NULL and
+     * the object doesn't support cancellable initialization the error
+     * %G_IO_ERROR_NOT_SUPPORTED will be returned.
+     *
+     * If the object is not initialized, or initialization returns with an
+     * error, then all operations on the object except g_object_ref() and
+     * g_object_unref() are considered to be invalid, and have undefined
+     * behaviour. See the [description][iface@Gio.Initable#description] for more details.
+     *
+     * Callers should not assume that a class which implements #GInitable can be
+     * initialized multiple times, unless the class explicitly documents itself as
+     * supporting this. Generally, a class’ implementation of init() can assume
+     * (and assert) that it will only be called once. Previously, this documentation
+     * recommended all #GInitable implementations should be idempotent; that
+     * recommendation was relaxed in GLib 2.54.
+     *
+     * If a class explicitly supports being initialized multiple times, it is
+     * recommended that the method is idempotent: multiple calls with the same
+     * arguments should return the same results. Only the first call initializes
+     * the object; further calls return the result of the first call.
+     *
+     * One reason why a class might need to support idempotent initialization is if
+     * it is designed to be used via the singleton pattern, with a
+     * #GObjectClass.constructor that sometimes returns an existing instance.
+     * In this pattern, a caller would expect to be able to call g_initable_init()
+     * on the result of g_object_new(), regardless of whether it is in fact a new
+     * instance.
+     * @param cancellable - optional #GCancellable object, %NULL to ignore.
+     */
+    init(cancellable?: Gio.Cancellable | null): boolean;
     connect(signal: "notify", handler: (self: Pty, pspec: GObject.ParamSpec) => void, after?: boolean): number;
     connect(signal: string, handler: (...args: any[]) => any, after?: boolean): number;
 }

package/dist/generated/vte/pty.js

@@ -66,6 +66,7 @@ export class Pty extends GObject.GObject {
      * @param cancellable - a #GCancellable, or %NULL
      */
     static newSync(flags, cancellable) {
+        const error = { value: null };
         const ptr = call("libvte-2.91-gtk4.so.0", "vte_pty_new_sync", [
             {
                 type: { type: "int", size: 32, unsigned: false },
@@ -76,7 +77,21 @@ export class Pty extends GObject.GObject {
                 value: cancellable?.id ?? cancellable,
                 optional: true,
             },
+            {
+                type: {
+                    type: "ref",
+                    innerType: {
+                        type: "boxed",
+                        innerType: "GError",
+                        lib: "libglib-2.0.so.0",
+                    },
+                },
+                value: error,
+            },
         ], { type: "gobject", borrowed: false });
+        if (error.value !== null) {
+            throw new NativeError(error.value);
+        }
         return getObject(ptr);
     }
     childSetup() {
@@ -267,6 +282,76 @@ export class Pty extends GObject.GObject {
         }
         return _result;
     }
+    /**
+     * Initializes the object implementing the interface.
+     *
+     * This method is intended for language bindings. If writing in C,
+     * g_initable_new() should typically be used instead.
+     *
+     * The object must be initialized before any real use after initial
+     * construction, either with this function or g_async_initable_init_async().
+     *
+     * Implementations may also support cancellation. If `cancellable` is not %NULL,
+     * then initialization can be cancelled by triggering the cancellable object
+     * from another thread. If the operation was cancelled, the error
+     * %G_IO_ERROR_CANCELLED will be returned. If `cancellable` is not %NULL and
+     * the object doesn't support cancellable initialization the error
+     * %G_IO_ERROR_NOT_SUPPORTED will be returned.
+     *
+     * If the object is not initialized, or initialization returns with an
+     * error, then all operations on the object except g_object_ref() and
+     * g_object_unref() are considered to be invalid, and have undefined
+     * behaviour. See the [description][iface@Gio.Initable#description] for more details.
+     *
+     * Callers should not assume that a class which implements #GInitable can be
+     * initialized multiple times, unless the class explicitly documents itself as
+     * supporting this. Generally, a class’ implementation of init() can assume
+     * (and assert) that it will only be called once. Previously, this documentation
+     * recommended all #GInitable implementations should be idempotent; that
+     * recommendation was relaxed in GLib 2.54.
+     *
+     * If a class explicitly supports being initialized multiple times, it is
+     * recommended that the method is idempotent: multiple calls with the same
+     * arguments should return the same results. Only the first call initializes
+     * the object; further calls return the result of the first call.
+     *
+     * One reason why a class might need to support idempotent initialization is if
+     * it is designed to be used via the singleton pattern, with a
+     * #GObjectClass.constructor that sometimes returns an existing instance.
+     * In this pattern, a caller would expect to be able to call g_initable_init()
+     * on the result of g_object_new(), regardless of whether it is in fact a new
+     * instance.
+     * @param cancellable - optional #GCancellable object, %NULL to ignore.
+     */
+    init(cancellable) {
+        const error = { value: null };
+        const result = call("libvte-2.91-gtk4.so.0", "g_initable_init", [
+            {
+                type: { type: "gobject" },
+                value: this.id,
+            },
+            {
+                type: { type: "gobject", borrowed: true },
+                value: cancellable?.id ?? cancellable,
+                optional: true,
+            },
+            {
+                type: {
+                    type: "ref",
+                    innerType: {
+                        type: "boxed",
+                        innerType: "GError",
+                        lib: "libglib-2.0.so.0",
+                    },
+                },
+                value: error,
+            },
+        ], { type: "boolean" });
+        if (error.value !== null) {
+            throw new NativeError(error.value);
+        }
+        return result;
+    }
     connect(signal, handler, after = false) {
         const selfType = { type: "gobject", borrowed: true };
         const argTypes = [selfType];

package/dist/generated/vte/regex.js

@@ -1,4 +1,4 @@
-import { call, NativeError, getObject, registerType } from "@gtkx/ffi";
+import { call, NativeError, getObject, getBoxed, registerType, } from "@gtkx/ffi";
 export class Regex {
     static glibTypeName = "VteRegex";
     id;
@@ -207,7 +207,7 @@ export class Regex {
             innerType: "VteRegex",
             lib: "libvte-2.91-gtk4.so.0",
         });
-        return getObject(ptr);
+        return getBoxed(ptr, "VteRegex");
     }
     /**
      * See man:pcre2api(3) and man:pcre2_substitute(3) for more information.
@@ -276,7 +276,7 @@ export class Regex {
             innerType: "VteRegex",
             lib: "libvte-2.91-gtk4.so.0",
         });
-        return getObject(ptr);
+        return getBoxed(ptr, "VteRegex");
     }
 }
 registerType(Regex);

package/dist/generated/vte/terminal.d.ts

@@ -1239,6 +1239,89 @@ export declare class Terminal extends Gtk.Widget {
      * @param cancellable - a #GCancellable object, or %NULL
      */
     writeContentsSync(stream: Gio.OutputStream, flags: WriteFlags, cancellable?: Gio.Cancellable | null): boolean;
+    /**
+     * Updates the position of the caret.
+     *
+     * Implementations of the `GtkAccessibleText` interface should call this
+     * function every time the caret has moved, in order to notify assistive
+     * technologies.
+     */
+    updateCaretPosition(): void;
+    /**
+     * Notifies assistive technologies of a change in contents.
+     *
+     * Implementations of the `GtkAccessibleText` interface should call this
+     * function every time their contents change as the result of an operation,
+     * like an insertion or a removal.
+     *
+     * Note: If the change is a deletion, this function must be called *before*
+     * removing the contents, if it is an insertion, it must be called *after*
+     * inserting the new contents.
+     * @param change - the type of change in the contents
+     * @param start - the starting offset of the change, in characters
+     * @param end - the end offset of the change, in characters
+     */
+    updateContents(change: Gtk.AccessibleTextContentChange, start: number, end: number): void;
+    /**
+     * Updates the boundary of the selection.
+     *
+     * Implementations of the `GtkAccessibleText` interface should call this
+     * function every time the selection has moved, in order to notify assistive
+     * technologies.
+     */
+    updateSelectionBound(): void;
+    /**
+     * Returns the size of a non-scrolling border around the
+     * outside of the scrollable.
+     *
+     * An example for this would be treeview headers. GTK can use
+     * this information to display overlaid graphics, like the
+     * overshoot indication, at the right position.
+     * @param border - return location for the results
+     */
+    getBorder(border: Gtk.Border): boolean;
+    /**
+     * Retrieves the `GtkAdjustment` used for horizontal scrolling.
+     */
+    getHadjustment(): Gtk.Adjustment | null;
+    /**
+     * Gets the horizontal `GtkScrollablePolicy`.
+     */
+    getHscrollPolicy(): Gtk.ScrollablePolicy;
+    /**
+     * Retrieves the `GtkAdjustment` used for vertical scrolling.
+     */
+    getVadjustment(): Gtk.Adjustment | null;
+    /**
+     * Gets the vertical `GtkScrollablePolicy`.
+     */
+    getVscrollPolicy(): Gtk.ScrollablePolicy;
+    /**
+     * Sets the horizontal adjustment of the `GtkScrollable`.
+     * @param hadjustment - a `GtkAdjustment`
+     */
+    setHadjustment(hadjustment?: Gtk.Adjustment | null): void;
+    /**
+     * Sets the `GtkScrollablePolicy`.
+     *
+     * The policy determines whether horizontal scrolling should start
+     * below the minimum width or below the natural width.
+     * @param policy - the horizontal `GtkScrollablePolicy`
+     */
+    setHscrollPolicy(policy: Gtk.ScrollablePolicy): void;
+    /**
+     * Sets the vertical adjustment of the `GtkScrollable`.
+     * @param vadjustment - a `GtkAdjustment`
+     */
+    setVadjustment(vadjustment?: Gtk.Adjustment | null): void;
+    /**
+     * Sets the `GtkScrollablePolicy`.
+     *
+     * The policy determines whether vertical scrolling should start
+     * below the minimum height or below the natural height.
+     * @param policy - the vertical `GtkScrollablePolicy`
+     */
+    setVscrollPolicy(policy: Gtk.ScrollablePolicy): void;
     connect(signal: "bell", handler: (self: Terminal) => void, after?: boolean): number;
     connect(signal: "char-size-changed", handler: (self: Terminal, width: number, height: number) => void, after?: boolean): number;
     connect(signal: "child-exited", handler: (self: Terminal, status: number) => void, after?: boolean): number;