@gtkx/native 0.21.0 → 1.0.0-rc.2

package/dist/types.d.ts

@@ -1,161 +0,0 @@
-/**
- * Opaque handle for a native value.
- *
- * Wraps GObject, Boxed, and Fundamental type instances.
- * This branded type ensures type safety for native object references.
- */
-export type NativeHandle = {
-    readonly __brand: "NativeHandle";
-};
-/**
- * Union of all possible FFI return value types.
- *
- * Returned by `call()` and `read()` where the concrete type
- * depends on the type descriptor passed to the function.
- */
-export type FfiValue = NativeHandle | number | string | boolean | FfiValue[] | null | undefined;
-type Int8Type = {
-    type: "int8";
-};
-type Uint8Type = {
-    type: "uint8";
-};
-type Int16Type = {
-    type: "int16";
-};
-type Uint16Type = {
-    type: "uint16";
-};
-type Int32Type = {
-    type: "int32";
-};
-type Uint32Type = {
-    type: "uint32";
-};
-type Int64Type = {
-    type: "int64";
-};
-type Uint64Type = {
-    type: "uint64";
-};
-type Float32Type = {
-    type: "float32";
-};
-type Float64Type = {
-    type: "float64";
-};
-type EnumType = {
-    type: "enum";
-    library: string;
-    getTypeFn: string;
-    signed: boolean;
-};
-type FlagsType = {
-    type: "flags";
-    library: string;
-    getTypeFn: string;
-    signed: boolean;
-};
-type BooleanType = {
-    type: "boolean";
-};
-type Ownership = "full" | "borrowed";
-type StringType = {
-    type: "string";
-    ownership: Ownership;
-    length?: number;
-};
-type GObjectType = {
-    type: "gobject";
-    ownership: Ownership;
-};
-type BoxedType = {
-    type: "boxed";
-    ownership: Ownership;
-    innerType: string;
-    library?: string;
-    getTypeFn?: string;
-};
-type StructType = {
-    type: "struct";
-    ownership: Ownership;
-    innerType: string;
-    size?: number;
-};
-type FundamentalType = {
-    type: "fundamental";
-    ownership: Ownership;
-    library: string;
-    refFn: string;
-    unrefFn: string;
-    typeName?: string;
-};
-type ArrayType = {
-    type: "array";
-    itemType: Type;
-    kind: "array" | "glist" | "gslist" | "gptrarray" | "garray" | "gbytearray" | "sized" | "fixed";
-    ownership: Ownership;
-    elementSize?: number;
-    sizeParamIndex?: number;
-    fixedSize?: number;
-};
-type HashTableType = {
-    type: "hashtable";
-    keyType: Type;
-    valueType: Type;
-    ownership: Ownership;
-};
-type RefType = {
-    type: "ref";
-    innerType: Type;
-};
-type UnicharType = {
-    type: "unichar";
-};
-type VoidType = {
-    type: "void";
-};
-export type CallbackType = {
-    type: "callback";
-    kind: "closure";
-    argTypes: Type[];
-    returnType: Type;
-};
-export type TrampolineType = {
-    type: "trampoline";
-    argTypes: Type[];
-    returnType: Type;
-    hasDestroy?: boolean;
-    userDataIndex?: number;
-    scope?: "call" | "notified" | "async" | "forever";
-};
-/**
- * Discriminated union of all FFI type descriptors.
- *
- * Describes how to marshal values between JavaScript and native code.
- */
-export type Type = Int8Type | Uint8Type | Int16Type | Uint16Type | Int32Type | Uint32Type | Int64Type | Uint64Type | Float32Type | Float64Type | EnumType | FlagsType | BooleanType | StringType | GObjectType | BoxedType | StructType | FundamentalType | ArrayType | HashTableType | RefType | CallbackType | TrampolineType | UnicharType | VoidType;
-/**
- * An argument for an FFI call.
- *
- * Combines a value with its type information for marshaling.
- */
-export type Arg = {
-    /** Type descriptor for marshaling */
-    type: Type;
-    /** The argument value */
-    value: unknown;
-    /** Whether the argument can be null/undefined */
-    optional?: boolean;
-};
-/**
- * A mutable reference wrapper for out-parameters.
- *
- * @typeParam T - The type of the referenced value
- */
-export type Ref<T> = {
-    readonly __brand: "Ref";
-    value: T;
-};
-export {};
-//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../types.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,MAAM,YAAY,GAAG;IAAE,QAAQ,CAAC,OAAO,EAAE,cAAc,CAAA;CAAE,CAAC;AAEhE;;;;;GAKG;AACH,MAAM,MAAM,QAAQ,GAAG,YAAY,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,QAAQ,EAAE,GAAG,IAAI,GAAG,SAAS,CAAC;AAEhG,KAAK,QAAQ,GAAG;IAAE,IAAI,EAAE,MAAM,CAAA;CAAE,CAAC;AACjC,KAAK,SAAS,GAAG;IAAE,IAAI,EAAE,OAAO,CAAA;CAAE,CAAC;AACnC,KAAK,SAAS,GAAG;IAAE,IAAI,EAAE,OAAO,CAAA;CAAE,CAAC;AACnC,KAAK,UAAU,GAAG;IAAE,IAAI,EAAE,QAAQ,CAAA;CAAE,CAAC;AACrC,KAAK,SAAS,GAAG;IAAE,IAAI,EAAE,OAAO,CAAA;CAAE,CAAC;AACnC,KAAK,UAAU,GAAG;IAAE,IAAI,EAAE,QAAQ,CAAA;CAAE,CAAC;AACrC,KAAK,SAAS,GAAG;IAAE,IAAI,EAAE,OAAO,CAAA;CAAE,CAAC;AACnC,KAAK,UAAU,GAAG;IAAE,IAAI,EAAE,QAAQ,CAAA;CAAE,CAAC;AAErC,KAAK,WAAW,GAAG;IAAE,IAAI,EAAE,SAAS,CAAA;CAAE,CAAC;AACvC,KAAK,WAAW,GAAG;IAAE,IAAI,EAAE,SAAS,CAAA;CAAE,CAAC;AAEvC,KAAK,QAAQ,GAAG;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,CAAC;IAAC,SAAS,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,OAAO,CAAA;CAAE,CAAC;AACtF,KAAK,SAAS,GAAG;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,OAAO,EAAE,MAAM,CAAC;IAAC,SAAS,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,OAAO,CAAA;CAAE,CAAC;AAExF,KAAK,WAAW,GAAG;IAAE,IAAI,EAAE,SAAS,CAAA;CAAE,CAAC;AAEvC,KAAK,SAAS,GAAG,MAAM,GAAG,UAAU,CAAC;AAErC,KAAK,UAAU,GAAG;IAAE,IAAI,EAAE,QAAQ,CAAC;IAAC,SAAS,EAAE,SAAS,CAAC;IAAC,MAAM,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC;AAE5E,KAAK,WAAW,GAAG;IAAE,IAAI,EAAE,SAAS,CAAC;IAAC,SAAS,EAAE,SAAS,CAAA;CAAE,CAAC;AAE7D,KAAK,SAAS,GAAG;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,SAAS,EAAE,SAAS,CAAC;IAAC,SAAS,EAAE,MAAM,CAAC;IAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAAC,SAAS,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC;AAElH,KAAK,UAAU,GAAG;IAAE,IAAI,EAAE,QAAQ,CAAC;IAAC,SAAS,EAAE,SAAS,CAAC;IAAC,SAAS,EAAE,MAAM,CAAC;IAAC,IAAI,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC;AAE7F,KAAK,eAAe,GAAG;IACnB,IAAI,EAAE,aAAa,CAAC;IACpB,SAAS,EAAE,SAAS,CAAC;IACrB,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF,KAAK,SAAS,GAAG;IACb,IAAI,EAAE,OAAO,CAAC;IACd,QAAQ,EAAE,IAAI,CAAC;IACf,IAAI,EAAE,OAAO,GAAG,OAAO,GAAG,QAAQ,GAAG,WAAW,GAAG,QAAQ,GAAG,YAAY,GAAG,OAAO,GAAG,OAAO,CAAC;IAC/F,SAAS,EAAE,SAAS,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,SAAS,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF,KAAK,aAAa,GAAG;IACjB,IAAI,EAAE,WAAW,CAAC;IAClB,OAAO,EAAE,IAAI,CAAC;IACd,SAAS,EAAE,IAAI,CAAC;IAChB,SAAS,EAAE,SAAS,CAAC;CACxB,CAAC;AAEF,KAAK,OAAO,GAAG;IAAE,IAAI,EAAE,KAAK,CAAC;IAAC,SAAS,EAAE,IAAI,CAAA;CAAE,CAAC;AAEhD,KAAK,WAAW,GAAG;IAAE,IAAI,EAAE,SAAS,CAAA;CAAE,CAAC;AAEvC,KAAK,QAAQ,GAAG;IAAE,IAAI,EAAE,MAAM,CAAA;CAAE,CAAC;AAEjC,MAAM,MAAM,YAAY,GAAG;IACvB,IAAI,EAAE,UAAU,CAAC;IACjB,IAAI,EAAE,SAAS,CAAC;IAChB,QAAQ,EAAE,IAAI,EAAE,CAAC;IACjB,UAAU,EAAE,IAAI,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG;IACzB,IAAI,EAAE,YAAY,CAAC;IACnB,QAAQ,EAAE,IAAI,EAAE,CAAC;IACjB,UAAU,EAAE,IAAI,CAAC;IACjB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,KAAK,CAAC,EAAE,MAAM,GAAG,UAAU,GAAG,OAAO,GAAG,SAAS,CAAC;CACrD,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,IAAI,GACV,QAAQ,GACR,SAAS,GACT,SAAS,GACT,UAAU,GACV,SAAS,GACT,UAAU,GACV,SAAS,GACT,UAAU,GACV,WAAW,GACX,WAAW,GACX,QAAQ,GACR,SAAS,GACT,WAAW,GACX,UAAU,GACV,WAAW,GACX,SAAS,GACT,UAAU,GACV,eAAe,GACf,SAAS,GACT,aAAa,GACb,OAAO,GACP,YAAY,GACZ,cAAc,GACd,WAAW,GACX,QAAQ,CAAC;AAEf;;;;GAIG;AACH,MAAM,MAAM,GAAG,GAAG;IACd,qCAAqC;IACrC,IAAI,EAAE,IAAI,CAAC;IACX,yBAAyB;IACzB,KAAK,EAAE,OAAO,CAAC;IACf,iDAAiD;IACjD,QAAQ,CAAC,EAAE,OAAO,CAAC;CACtB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,GAAG,CAAC,CAAC,IAAI;IACjB,QAAQ,CAAC,OAAO,EAAE,KAAK,CAAC;IACxB,KAAK,EAAE,CAAC,CAAC;CACZ,CAAC"}

package/dist/types.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../types.ts"],"names":[],"mappings":""}

package/index.ts

@@ -1,152 +0,0 @@
-import { createRequire } from "node:module";
-import { arch, platform } from "node:os";
-import type { Arg, CallbackType, FfiValue, NativeHandle, Ref, Type } from "./types.js";
-
-const require = createRequire(import.meta.url);
-
-function loadNativeBinding() {
-    const currentPlatform = platform();
-    const currentArch = arch();
-
-    if (currentPlatform !== "linux") {
-        throw new Error(`Unsupported platform: ${currentPlatform}, only Linux is supported`);
-    }
-
-    if (currentArch !== "x64" && currentArch !== "arm64") {
-        throw new Error(`Unsupported architecture: ${currentArch}, only x64 and arm64 are supported`);
-    }
-
-    const packageName = `@gtkx/native-linux-${currentArch}`;
-
-    try {
-        return require(packageName);
-    } catch (error) {
-        const originalError = error instanceof Error ? error.message : String(error);
-        throw new Error(`Failed to load native binding for ${currentPlatform}-${currentArch}: ${originalError}`);
-    }
-}
-
-const native = loadNativeBinding();
-
-/**
- * Creates a mutable reference wrapper.
- *
- * Used for out-parameters in FFI calls where the native function
- * needs to write a value back.
- *
- * @typeParam T - The type of the referenced value
- * @param value - Initial value
- * @returns A reference object containing the value
- *
- * @example
- * ```tsx
- * const errorRef = createRef<GError | null>(null);
- * const result = someFunction(errorRef);
- * if (errorRef.value) {
- *   console.error(errorRef.value.message);
- * }
- * ```
- */
-export function createRef<T>(value: T): Ref<T> {
-    return { value } as Ref<T>;
-}
-
-/**
- * Makes a low-level FFI call to a native library.
- *
- * This is the core FFI mechanism. Most code should use the generated
- * bindings in `@gtkx/ffi` instead of calling this directly.
- *
- * @param library - Shared library name (e.g., "libgtk-4.so.1")
- * @param symbol - Function symbol name
- * @param args - Function arguments with type information
- * @param returnType - Expected return type
- * @returns The function return value
- */
-export function call(library: string, symbol: string, args: Arg[], returnType: Type): FfiValue {
-    return native.call(library, symbol, args, returnType) as FfiValue;
-}
-
-/**
- * Starts the GTK runtime and creates an application.
- *
- * @param appId - Application ID in reverse domain notation
- * @param flags - Optional GIO application flags
- * @returns Native application pointer
- *
- * @internal Use `@gtkx/ffi` start() instead
- */
-export function start(appId: string, flags?: number): NativeHandle {
-    return native.start(appId, flags) as NativeHandle;
-}
-
-/**
- * Stops the GTK runtime.
- *
- * @internal Use `@gtkx/ffi` stop() instead
- */
-export function stop(): void {
-    native.stop();
-}
-
-/**
- * Reads a value from native memory.
- *
- * @param handle - Native handle pointing to the memory
- * @param type - Type of value to read
- * @param offset - Byte offset from the handle pointer
- * @returns The read value
- */
-export function read(handle: NativeHandle, type: Type, offset: number): FfiValue {
-    return native.read(handle, type, offset) as FfiValue;
-}
-
-/**
- * Writes a value to native memory.
- *
- * @param handle - Native handle pointing to the memory
- * @param type - Type of value to write
- * @param offset - Byte offset from the handle pointer
- * @param value - Value to write
- */
-export function write(handle: NativeHandle, type: Type, offset: number, value: unknown): void {
-    native.write(handle, type, offset, value);
-}
-
-/**
- * Allocates memory for a boxed type or plain struct.
- *
- * @param size - Size in bytes to allocate
- * @param glibTypeName - GLib type name for boxed types (optional for plain structs)
- * @param lib - Optional library containing the type
- * @returns Native pointer to allocated memory
- */
-export function alloc(size: number, glibTypeName?: string, lib?: string): NativeHandle {
-    return native.alloc(size, glibTypeName, lib) as NativeHandle;
-}
-
-/**
- * Gets the internal handle ID for a native pointer.
- *
- * Used for comparing object identity.
- *
- * @param handle - Native handle
- * @returns Internal handle ID
- */
-export function getNativeId(handle: NativeHandle): number {
-    return native.getNativeId(handle);
-}
-
-export function isNativeHandle(value: unknown): value is NativeHandle {
-    return native.isNativeHandle(value);
-}
-
-export function freeze(): void {
-    native.freeze();
-}
-
-export function unfreeze(): void {
-    native.unfreeze();
-}
-
-export type { Arg, CallbackType, FfiValue, NativeHandle, Ref, Type };

package/types.ts

@@ -1,146 +0,0 @@
-/**
- * Opaque handle for a native value.
- *
- * Wraps GObject, Boxed, and Fundamental type instances.
- * This branded type ensures type safety for native object references.
- */
-export type NativeHandle = { readonly __brand: "NativeHandle" };
-
-/**
- * Union of all possible FFI return value types.
- *
- * Returned by `call()` and `read()` where the concrete type
- * depends on the type descriptor passed to the function.
- */
-export type FfiValue = NativeHandle | number | string | boolean | FfiValue[] | null | undefined;
-
-type Int8Type = { type: "int8" };
-type Uint8Type = { type: "uint8" };
-type Int16Type = { type: "int16" };
-type Uint16Type = { type: "uint16" };
-type Int32Type = { type: "int32" };
-type Uint32Type = { type: "uint32" };
-type Int64Type = { type: "int64" };
-type Uint64Type = { type: "uint64" };
-
-type Float32Type = { type: "float32" };
-type Float64Type = { type: "float64" };
-
-type EnumType = { type: "enum"; library: string; getTypeFn: string; signed: boolean };
-type FlagsType = { type: "flags"; library: string; getTypeFn: string; signed: boolean };
-
-type BooleanType = { type: "boolean" };
-
-type Ownership = "full" | "borrowed";
-
-type StringType = { type: "string"; ownership: Ownership; length?: number };
-
-type GObjectType = { type: "gobject"; ownership: Ownership };
-
-type BoxedType = { type: "boxed"; ownership: Ownership; innerType: string; library?: string; getTypeFn?: string };
-
-type StructType = { type: "struct"; ownership: Ownership; innerType: string; size?: number };
-
-type FundamentalType = {
-    type: "fundamental";
-    ownership: Ownership;
-    library: string;
-    refFn: string;
-    unrefFn: string;
-    typeName?: string;
-};
-
-type ArrayType = {
-    type: "array";
-    itemType: Type;
-    kind: "array" | "glist" | "gslist" | "gptrarray" | "garray" | "gbytearray" | "sized" | "fixed";
-    ownership: Ownership;
-    elementSize?: number;
-    sizeParamIndex?: number;
-    fixedSize?: number;
-};
-
-type HashTableType = {
-    type: "hashtable";
-    keyType: Type;
-    valueType: Type;
-    ownership: Ownership;
-};
-
-type RefType = { type: "ref"; innerType: Type };
-
-type UnicharType = { type: "unichar" };
-
-type VoidType = { type: "void" };
-
-export type CallbackType = {
-    type: "callback";
-    kind: "closure";
-    argTypes: Type[];
-    returnType: Type;
-};
-
-export type TrampolineType = {
-    type: "trampoline";
-    argTypes: Type[];
-    returnType: Type;
-    hasDestroy?: boolean;
-    userDataIndex?: number;
-    scope?: "call" | "notified" | "async" | "forever";
-};
-
-/**
- * Discriminated union of all FFI type descriptors.
- *
- * Describes how to marshal values between JavaScript and native code.
- */
-export type Type =
-    | Int8Type
-    | Uint8Type
-    | Int16Type
-    | Uint16Type
-    | Int32Type
-    | Uint32Type
-    | Int64Type
-    | Uint64Type
-    | Float32Type
-    | Float64Type
-    | EnumType
-    | FlagsType
-    | BooleanType
-    | StringType
-    | GObjectType
-    | BoxedType
-    | StructType
-    | FundamentalType
-    | ArrayType
-    | HashTableType
-    | RefType
-    | CallbackType
-    | TrampolineType
-    | UnicharType
-    | VoidType;
-
-/**
- * An argument for an FFI call.
- *
- * Combines a value with its type information for marshaling.
- */
-export type Arg = {
-    /** Type descriptor for marshaling */
-    type: Type;
-    /** The argument value */
-    value: unknown;
-    /** Whether the argument can be null/undefined */
-    optional?: boolean;
-};
-
-/**
- * A mutable reference wrapper for out-parameters.
- *
- * @typeParam T - The type of the referenced value
- */
-export type Ref<T> = {
-    readonly __brand: "Ref";
-    value: T;
-};