@gtkx/native 0.20.0 → 1.0.0-rc.1

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,185 +0,0 @@
-import { createRequire } from "node:module";
-import { arch, platform } from "node:os";
-import type { Arg, CallbackType, 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 };
-}
-
-/**
- * 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): unknown {
-    return native.call(library, symbol, args, returnType);
-}
-
-/**
- * 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): unknown {
-    return native.start(appId, flags);
-}
-
-/**
- * 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: unknown, type: Type, offset: number): unknown {
-    return native.read(handle, type, offset);
-}
-
-/**
- * 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: unknown, 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): unknown {
-    return native.alloc(size, glibTypeName, lib);
-}
-
-/**
- * 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: unknown): number {
-    return native.getNativeId(handle);
-}
-
-/**
- * Reads a value from memory pointed to by a pointer field.
- *
- * Used for accessing array elements or dereferencing pointer fields.
- * Reads the pointer at ptrOffset, then reads from that location plus elementOffset.
- *
- * @param handle - Native handle pointing to the parent struct
- * @param ptrOffset - Byte offset of the pointer field in the parent
- * @param elementOffset - Byte offset from the dereferenced pointer
- * @returns Native handle pointing to the element (borrowed, non-owning)
- */
-export function readPointer(handle: unknown, ptrOffset: number, elementOffset: number): unknown {
-    return native.readPointer(handle, ptrOffset, elementOffset);
-}
-
-/**
- * Writes a struct value to memory pointed to by a pointer field.
- *
- * Used for setting array elements. Copies the data from source to the
- * destination array element.
- *
- * @param destHandle - Native handle pointing to the parent struct containing the pointer
- * @param ptrOffset - Byte offset of the pointer field in the parent
- * @param elementOffset - Byte offset from the dereferenced pointer (index * elementSize)
- * @param sourceHandle - Native handle of the struct to copy from
- * @param size - Size in bytes of the struct to copy
- */
-export function writePointer(
-    destHandle: unknown,
-    ptrOffset: number,
-    elementOffset: number,
-    sourceHandle: unknown,
-    size: number,
-): void {
-    native.writePointer(destHandle, ptrOffset, elementOffset, sourceHandle, size);
-}
-
-export function freeze(): void {
-    native.freeze();
-}
-
-export function unfreeze(): void {
-    native.unfreeze();
-}
-
-export type { NativeHandle, Ref, Arg, Type, CallbackType };

package/types.ts

@@ -1,119 +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" };
-
-type IntegerType = { type: "int"; size: 8 | 16 | 32 | 64; unsigned: boolean; library?: string; getTypeFn?: string };
-
-type FloatType = { type: "float"; size: 32 | 64 };
-
-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;
-};
-
-type ArrayType = {
-    type: "array";
-    itemType: Type;
-    kind: "array" | "glist" | "gslist" | "gptrarray" | "garray" | "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 NullType = { type: "null" };
-
-type UndefinedType = { type: "undefined" };
-
-export type CallbackType = {
-    type: "callback";
-    kind:
-        | "animationTargetFunc"
-        | "asyncReadyCallback"
-        | "closure"
-        | "destroyNotify"
-        | "drawingAreaDrawFunc"
-        | "pathIntersectionFunc"
-        | "scaleFormatValueFunc"
-        | "shapeRendererFunc"
-        | "shortcutFunc"
-        | "tickCallback"
-        | "treeListModelCreateModelFunc";
-    argTypes: Type[];
-    returnType: Type;
-    sourceType?: Type;
-    resultType?: Type;
-};
-
-/**
- * Discriminated union of all FFI type descriptors.
- *
- * Describes how to marshal values between JavaScript and native code.
- */
-export type Type =
-    | IntegerType
-    | FloatType
-    | BooleanType
-    | StringType
-    | GObjectType
-    | BoxedType
-    | StructType
-    | FundamentalType
-    | ArrayType
-    | HashTableType
-    | RefType
-    | CallbackType
-    | NullType
-    | UndefinedType;
-
-/**
- * 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> = {
-    /** The current value */
-    value: T;
-};