@vui-rs/core 0.1.0

package/dist/native/ffi-symbols.d.ts

@@ -0,0 +1,453 @@
+import { FFIType } from "bun:ffi";
+
+//#region src/native/ffi-symbols.d.ts
+/**
+ * FFI ABI contract for vui-core. This file is the single source of truth that
+ * MUST stay in lockstep with the `#[unsafe(no_mangle)] extern "C"` exports in
+ * `crates/vui-core/src/ffi/` and the `#[repr(C)]` `Cell`. Any change here is an
+ * ABI change — bump `ABI_VERSION` in `crates/vui-core/src/lib.rs` and
+ * `EXPECTED_ABI_VERSION` below together.
+ */
+declare const EXPECTED_ABI_VERSION = 12;
+/**
+ * Size of one native `Cell` in bytes (`ch:u32, fg:Rgba, bg:Rgba, attrs:u16` +
+ * padding). The loader verifies this against `vui_cell_size_bytes()` so a JS
+ * typed-array view over the back buffer can never silently mis-stride.
+ */
+declare const CELL_BYTES = 16;
+/** Status codes returned by the renderer/buffer exports (`ffi::status`). */
+declare const Status: {
+  readonly OK: 0;
+  readonly NULL_PTR: 1;
+  readonly PANIC: 2;
+  readonly BAD_ARG: 3;
+};
+/** Text attribute bitflags, mirroring `buffer::attr` on the Rust side. */
+declare const Attr: {
+  readonly BOLD: number;
+  readonly DIM: number;
+  readonly ITALIC: number;
+  readonly UNDERLINE: number;
+  readonly STRIKETHROUGH: number;
+  readonly INVERSE: number;
+  readonly WIDE_CONTINUATION: number;
+};
+/**
+ * Bit position of the OSC 8 link id within a cell's `attrs` (mirrors
+ * `buffer::attr::LINK_SHIFT`). The high byte holds the id (1..255, 0 = no link);
+ * the host ORs `id << LINK_SHIFT` into a run's attrs and the emitter wraps those
+ * cells in a hyperlink. Not an SGR flag — kept out of the low byte deliberately.
+ */
+declare const LINK_SHIFT = 8;
+/**
+ * Size of one packed `StyleFfi` in bytes (7 u32 enums + 2 f32 + 25 DimFfi at 8
+ * bytes each = 236). The loader verifies this against `vui_style_ffi_size()`, so
+ * a drift between the TS packer (`style.ts`) and the Rust struct fails loud.
+ */
+declare const STYLE_FFI_BYTES = 236;
+/** Node kinds for `vui_node_new` (mirrors `node::NodeKind::from_u8`). */
+declare const NodeKindCode: {
+  readonly Box: 1;
+  readonly Text: 2;
+  readonly Edit: 3;
+};
+/** Cursor motion codes for the JS-host edit model (`EditRenderable.move`). */
+declare const EditMotion: {
+  readonly Left: 0;
+  readonly Right: 1;
+  readonly WordLeft: 2;
+  readonly WordRight: 3;
+  readonly Home: 4;
+  readonly End: 5;
+  readonly Up: 6;
+  readonly Down: 7;
+  readonly DocStart: 8;
+  readonly DocEnd: 9;
+};
+type EditMotionCode = (typeof EditMotion)[keyof typeof EditMotion];
+declare const NativeTextWrap: {
+  readonly None: 0;
+  readonly Char: 1;
+  readonly Word: 2;
+};
+type NativeTextWrapCode = (typeof NativeTextWrap)[keyof typeof NativeTextWrap];
+declare const symbols: {
+  readonly vui_version: {
+    readonly args: readonly [];
+    readonly returns: FFIType.uint32_t;
+  };
+  readonly vui_abi_version: {
+    readonly args: readonly [];
+    readonly returns: FFIType.uint32_t;
+  };
+  readonly vui_char_width: {
+    readonly args: readonly [FFIType.uint32_t];
+    readonly returns: FFIType.uint32_t;
+  };
+  readonly vui_renderer_new: {
+    readonly args: readonly [FFIType.uint32_t, FFIType.uint32_t];
+    readonly returns: FFIType.ptr;
+  };
+  readonly vui_renderer_free: {
+    readonly args: readonly [FFIType.ptr];
+    readonly returns: FFIType.void;
+  };
+  readonly vui_renderer_resize: {
+    readonly args: readonly [FFIType.ptr, FFIType.uint32_t, FFIType.uint32_t];
+    readonly returns: FFIType.uint32_t;
+  };
+  readonly vui_renderer_back_buffer_ptr: {
+    readonly args: readonly [FFIType.ptr];
+    readonly returns: FFIType.ptr;
+  };
+  readonly vui_renderer_buffer_len: {
+    readonly args: readonly [FFIType.ptr];
+    readonly returns: "usize";
+  };
+  readonly vui_cell_size_bytes: {
+    readonly args: readonly [];
+    readonly returns: "usize";
+  };
+  readonly vui_buffer_draw_text: {
+    readonly args: readonly [FFIType.ptr, FFIType.uint32_t, FFIType.uint32_t, FFIType.ptr, "usize", FFIType.uint32_t, FFIType.uint32_t, FFIType.uint16_t];
+    readonly returns: FFIType.uint32_t;
+  };
+  readonly vui_buffer_fill_rect: {
+    readonly args: readonly [FFIType.ptr, FFIType.uint32_t, FFIType.uint32_t, FFIType.uint32_t, FFIType.uint32_t, FFIType.uint32_t];
+    readonly returns: FFIType.uint32_t;
+  };
+  readonly vui_buffer_set_cell: {
+    readonly args: readonly [FFIType.ptr, FFIType.uint32_t, FFIType.uint32_t, FFIType.uint32_t, FFIType.uint32_t, FFIType.uint32_t, FFIType.uint16_t];
+    readonly returns: FFIType.uint32_t;
+  };
+  readonly vui_buffer_clear: {
+    readonly args: readonly [FFIType.ptr, FFIType.uint32_t];
+    readonly returns: FFIType.uint32_t;
+  };
+  readonly vui_renderer_render: {
+    readonly args: readonly [FFIType.ptr];
+    readonly returns: FFIType.uint32_t;
+  };
+  readonly vui_renderer_flush: {
+    readonly args: readonly [FFIType.ptr];
+    readonly returns: FFIType.uint32_t;
+  };
+  readonly vui_renderer_clear_links: {
+    readonly args: readonly [FFIType.ptr];
+    readonly returns: FFIType.uint32_t;
+  };
+  readonly vui_renderer_stage_link: {
+    readonly args: readonly [FFIType.ptr, FFIType.uint16_t, FFIType.ptr, "usize"];
+    readonly returns: FFIType.uint32_t;
+  };
+  readonly vui_renderer_stage_passthrough: {
+    readonly args: readonly [FFIType.ptr, FFIType.ptr, "usize"];
+    readonly returns: FFIType.uint32_t;
+  };
+  readonly vui_image_decode: {
+    readonly args: readonly [FFIType.ptr, "usize", FFIType.uint32_t, FFIType.uint32_t];
+    readonly returns: FFIType.ptr;
+  };
+  readonly vui_renderer_stage_image_placement: {
+    readonly args: readonly [FFIType.ptr, FFIType.uint32_t, FFIType.int32_t, FFIType.int32_t];
+    readonly returns: FFIType.uint32_t;
+  };
+  readonly vui_renderer_clear_image_placements: {
+    readonly args: readonly [FFIType.ptr];
+    readonly returns: FFIType.uint32_t;
+  };
+  readonly vui_image_decode_bytes: {
+    readonly args: readonly [FFIType.ptr, "usize", FFIType.uint32_t, FFIType.uint32_t];
+    readonly returns: FFIType.ptr;
+  };
+  readonly vui_image_width: {
+    readonly args: readonly [FFIType.ptr];
+    readonly returns: FFIType.uint32_t;
+  };
+  readonly vui_image_height: {
+    readonly args: readonly [FFIType.ptr];
+    readonly returns: FFIType.uint32_t;
+  };
+  readonly vui_image_rgba_ptr: {
+    readonly args: readonly [FFIType.ptr];
+    readonly returns: FFIType.ptr;
+  };
+  readonly vui_image_rgba_len: {
+    readonly args: readonly [FFIType.ptr];
+    readonly returns: "usize";
+  };
+  readonly vui_image_free: {
+    readonly args: readonly [FFIType.ptr];
+    readonly returns: FFIType.void;
+  };
+  readonly vui_buffer_draw_text_clipped: {
+    readonly args: readonly [FFIType.ptr, FFIType.int32_t, FFIType.int32_t, FFIType.ptr, "usize", FFIType.uint32_t, FFIType.uint32_t, FFIType.uint16_t, FFIType.ptr];
+    readonly returns: FFIType.uint32_t;
+  };
+  readonly vui_buffer_fill_rect_clipped: {
+    readonly args: readonly [FFIType.ptr, FFIType.int32_t, FFIType.int32_t, FFIType.uint32_t, FFIType.uint32_t, FFIType.uint32_t, FFIType.ptr];
+    readonly returns: FFIType.uint32_t;
+  };
+  readonly vui_buffer_set_cell_clipped: {
+    readonly args: readonly [FFIType.ptr, FFIType.int32_t, FFIType.int32_t, FFIType.uint32_t, FFIType.uint32_t, FFIType.uint32_t, FFIType.uint16_t, FFIType.ptr];
+    readonly returns: FFIType.uint32_t;
+  };
+  readonly vui_buffer_blit: {
+    readonly args: readonly [FFIType.ptr, FFIType.ptr, FFIType.int32_t, FFIType.int32_t, FFIType.ptr];
+    readonly returns: FFIType.uint32_t;
+  };
+  readonly vui_buffer_draw_textbuffer: {
+    readonly args: readonly [FFIType.ptr, FFIType.ptr, FFIType.int32_t, FFIType.int32_t, FFIType.uint32_t, FFIType.uint32_t, FFIType.uint8_t, FFIType.uint16_t, FFIType.ptr];
+    readonly returns: FFIType.uint32_t;
+  };
+  readonly vui_buffer_draw_editor: {
+    readonly args: readonly [FFIType.ptr, FFIType.ptr, FFIType.int32_t, FFIType.int32_t, FFIType.uint32_t, FFIType.uint32_t, FFIType.uint32_t, FFIType.uint16_t, FFIType.ptr];
+    readonly returns: FFIType.uint32_t;
+  };
+  readonly vui_textbuf_new: {
+    readonly args: readonly [];
+    readonly returns: FFIType.ptr;
+  };
+  readonly vui_textbuf_free: {
+    readonly args: readonly [FFIType.ptr];
+    readonly returns: FFIType.void;
+  };
+  readonly vui_textbuf_set_text: {
+    readonly args: readonly [FFIType.ptr, FFIType.ptr, "usize"];
+    readonly returns: FFIType.uint32_t;
+  };
+  readonly vui_textbuf_set_runs: {
+    readonly args: readonly [FFIType.ptr, FFIType.ptr, "usize", FFIType.ptr, "usize"];
+    readonly returns: FFIType.uint32_t;
+  };
+  readonly vui_textbuf_line_count: {
+    readonly args: readonly [FFIType.ptr];
+    readonly returns: FFIType.uint32_t;
+  };
+  readonly vui_textbuf_length: {
+    readonly args: readonly [FFIType.ptr];
+    readonly returns: FFIType.uint32_t;
+  };
+  readonly vui_textview_new: {
+    readonly args: readonly [FFIType.ptr];
+    readonly returns: FFIType.ptr;
+  };
+  readonly vui_textview_free: {
+    readonly args: readonly [FFIType.ptr];
+    readonly returns: FFIType.void;
+  };
+  readonly vui_textview_set_wrap: {
+    readonly args: readonly [FFIType.ptr, FFIType.uint8_t];
+    readonly returns: FFIType.uint32_t;
+  };
+  readonly vui_textview_set_width: {
+    readonly args: readonly [FFIType.ptr, FFIType.uint32_t];
+    readonly returns: FFIType.uint32_t;
+  };
+  readonly vui_textview_measure: {
+    readonly args: readonly [FFIType.ptr, FFIType.uint32_t, FFIType.uint8_t, FFIType.ptr];
+    readonly returns: FFIType.uint32_t;
+  };
+  readonly vui_editbuf_new: {
+    readonly args: readonly [];
+    readonly returns: FFIType.ptr;
+  };
+  readonly vui_editbuf_free: {
+    readonly args: readonly [FFIType.ptr];
+    readonly returns: FFIType.void;
+  };
+  readonly vui_editbuf_set_value: {
+    readonly args: readonly [FFIType.ptr, FFIType.ptr, "usize"];
+    readonly returns: FFIType.uint32_t;
+  };
+  readonly vui_editbuf_value_len: {
+    readonly args: readonly [FFIType.ptr];
+    readonly returns: "usize";
+  };
+  readonly vui_editbuf_copy_value: {
+    readonly args: readonly [FFIType.ptr, FFIType.ptr, "usize"];
+    readonly returns: "usize";
+  };
+  readonly vui_editbuf_insert: {
+    readonly args: readonly [FFIType.ptr, FFIType.ptr, "usize"];
+    readonly returns: FFIType.uint32_t;
+  };
+  readonly vui_editbuf_backspace: {
+    readonly args: readonly [FFIType.ptr];
+    readonly returns: FFIType.uint32_t;
+  };
+  readonly vui_editbuf_delete: {
+    readonly args: readonly [FFIType.ptr];
+    readonly returns: FFIType.uint32_t;
+  };
+  readonly vui_editbuf_newline: {
+    readonly args: readonly [FFIType.ptr];
+    readonly returns: FFIType.uint32_t;
+  };
+  readonly vui_editbuf_move: {
+    readonly args: readonly [FFIType.ptr, FFIType.uint8_t, FFIType.uint8_t];
+    readonly returns: FFIType.uint32_t;
+  };
+  readonly vui_editbuf_select_all: {
+    readonly args: readonly [FFIType.ptr];
+    readonly returns: FFIType.uint32_t;
+  };
+  readonly vui_editbuf_has_selection: {
+    readonly args: readonly [FFIType.ptr];
+    readonly returns: FFIType.uint32_t;
+  };
+  readonly vui_editbuf_selected_len: {
+    readonly args: readonly [FFIType.ptr];
+    readonly returns: "usize";
+  };
+  readonly vui_editbuf_copy_selected: {
+    readonly args: readonly [FFIType.ptr, FFIType.ptr, "usize"];
+    readonly returns: "usize";
+  };
+  readonly vui_editbuf_delete_selection: {
+    readonly args: readonly [FFIType.ptr, FFIType.ptr];
+    readonly returns: FFIType.uint32_t;
+  };
+  readonly vui_editbuf_undo: {
+    readonly args: readonly [FFIType.ptr, FFIType.ptr];
+    readonly returns: FFIType.uint32_t;
+  };
+  readonly vui_editbuf_redo: {
+    readonly args: readonly [FFIType.ptr, FFIType.ptr];
+    readonly returns: FFIType.uint32_t;
+  };
+  readonly vui_editbuf_can_undo: {
+    readonly args: readonly [FFIType.ptr];
+    readonly returns: FFIType.uint32_t;
+  };
+  readonly vui_editbuf_can_redo: {
+    readonly args: readonly [FFIType.ptr];
+    readonly returns: FFIType.uint32_t;
+  };
+  readonly vui_editbuf_cursor: {
+    readonly args: readonly [FFIType.ptr, FFIType.ptr, FFIType.ptr];
+    readonly returns: FFIType.uint32_t;
+  };
+  readonly vui_editor_new: {
+    readonly args: readonly [FFIType.ptr, FFIType.uint32_t, FFIType.uint32_t];
+    readonly returns: FFIType.ptr;
+  };
+  readonly vui_editor_free: {
+    readonly args: readonly [FFIType.ptr];
+    readonly returns: FFIType.void;
+  };
+  readonly vui_editor_set_wrap: {
+    readonly args: readonly [FFIType.ptr, FFIType.uint8_t];
+    readonly returns: FFIType.uint32_t;
+  };
+  readonly vui_editor_set_viewport: {
+    readonly args: readonly [FFIType.ptr, FFIType.uint32_t, FFIType.uint32_t];
+    readonly returns: FFIType.uint32_t;
+  };
+  readonly vui_editor_set_focused: {
+    readonly args: readonly [FFIType.ptr, FFIType.uint8_t];
+    readonly returns: FFIType.uint32_t;
+  };
+  readonly vui_editor_move: {
+    readonly args: readonly [FFIType.ptr, FFIType.uint8_t, FFIType.uint8_t];
+    readonly returns: FFIType.uint32_t;
+  };
+  readonly vui_editor_measure: {
+    readonly args: readonly [FFIType.ptr, FFIType.uint32_t, FFIType.uint8_t, FFIType.ptr];
+    readonly returns: FFIType.uint32_t;
+  };
+  readonly vui_cbuf_new: {
+    readonly args: readonly [FFIType.uint32_t, FFIType.uint32_t];
+    readonly returns: FFIType.ptr;
+  };
+  readonly vui_cbuf_free: {
+    readonly args: readonly [FFIType.ptr];
+    readonly returns: FFIType.void;
+  };
+  readonly vui_cbuf_resize: {
+    readonly args: readonly [FFIType.ptr, FFIType.uint32_t, FFIType.uint32_t];
+    readonly returns: FFIType.uint32_t;
+  };
+  readonly vui_cbuf_ptr: {
+    readonly args: readonly [FFIType.ptr];
+    readonly returns: FFIType.ptr;
+  };
+  readonly vui_cbuf_len: {
+    readonly args: readonly [FFIType.ptr];
+    readonly returns: "usize";
+  };
+  readonly vui_cbuf_clear: {
+    readonly args: readonly [FFIType.ptr, FFIType.uint32_t];
+    readonly returns: FFIType.uint32_t;
+  };
+  readonly vui_cbuf_draw_text: {
+    readonly args: readonly [FFIType.ptr, FFIType.uint32_t, FFIType.uint32_t, FFIType.ptr, "usize", FFIType.uint32_t, FFIType.uint32_t, FFIType.uint16_t];
+    readonly returns: FFIType.uint32_t;
+  };
+  readonly vui_cbuf_fill_rect: {
+    readonly args: readonly [FFIType.ptr, FFIType.uint32_t, FFIType.uint32_t, FFIType.uint32_t, FFIType.uint32_t, FFIType.uint32_t];
+    readonly returns: FFIType.uint32_t;
+  };
+  readonly vui_cbuf_set_cell: {
+    readonly args: readonly [FFIType.ptr, FFIType.uint32_t, FFIType.uint32_t, FFIType.uint32_t, FFIType.uint32_t, FFIType.uint32_t, FFIType.uint16_t];
+    readonly returns: FFIType.uint32_t;
+  };
+  readonly vui_renderer_set_root: {
+    readonly args: readonly [FFIType.ptr];
+    readonly returns: FFIType.uint32_t;
+  };
+  readonly vui_node_new: {
+    readonly args: readonly [FFIType.ptr, FFIType.uint8_t];
+    readonly returns: FFIType.uint32_t;
+  };
+  readonly vui_node_free: {
+    readonly args: readonly [FFIType.ptr, FFIType.uint32_t];
+    readonly returns: FFIType.uint32_t;
+  };
+  readonly vui_node_append_child: {
+    readonly args: readonly [FFIType.ptr, FFIType.uint32_t, FFIType.uint32_t];
+    readonly returns: FFIType.uint32_t;
+  };
+  readonly vui_node_insert_before: {
+    readonly args: readonly [FFIType.ptr, FFIType.uint32_t, FFIType.uint32_t, FFIType.uint32_t];
+    readonly returns: FFIType.uint32_t;
+  };
+  readonly vui_node_remove_child: {
+    readonly args: readonly [FFIType.ptr, FFIType.uint32_t, FFIType.uint32_t];
+    readonly returns: FFIType.uint32_t;
+  };
+  readonly vui_node_set_text: {
+    readonly args: readonly [FFIType.ptr, FFIType.uint32_t, FFIType.ptr, "usize"];
+    readonly returns: FFIType.uint32_t;
+  };
+  readonly vui_node_set_text_runs: {
+    readonly args: readonly [FFIType.ptr, FFIType.uint32_t, FFIType.ptr, "usize", FFIType.ptr, "usize"];
+    readonly returns: FFIType.uint32_t;
+  };
+  readonly vui_node_set_text_wrap: {
+    readonly args: readonly [FFIType.ptr, FFIType.uint32_t, FFIType.uint8_t];
+    readonly returns: FFIType.uint32_t;
+  };
+  readonly vui_node_set_style: {
+    readonly args: readonly [FFIType.ptr, FFIType.uint32_t, FFIType.ptr];
+    readonly returns: FFIType.uint32_t;
+  };
+  readonly vui_style_ffi_size: {
+    readonly args: readonly [];
+    readonly returns: "usize";
+  };
+  readonly vui_debug_tree_hash: {
+    readonly args: readonly [FFIType.ptr];
+    readonly returns: FFIType.uint64_t;
+  };
+  readonly vui_layout_compute: {
+    readonly args: readonly [FFIType.ptr, FFIType.uint32_t, FFIType.uint32_t];
+    readonly returns: FFIType.uint32_t;
+  };
+  readonly vui_node_rect: {
+    readonly args: readonly [FFIType.ptr, FFIType.uint32_t, FFIType.ptr];
+    readonly returns: FFIType.uint32_t;
+  };
+};
+//#endregion
+export { Attr, CELL_BYTES, EXPECTED_ABI_VERSION, EditMotion, EditMotionCode, LINK_SHIFT, NativeTextWrap, NativeTextWrapCode, NodeKindCode, STYLE_FFI_BYTES, Status, symbols };