@opentui/core 0.1.28 → 0.1.29

package/README.md

@@ -30,6 +30,16 @@ bun install
 bun run src/examples/index.ts
 ```
 
+## Benchmarks
+
+Run native performance benchmarks:
+
+```bash
+bun run bench:native
+```
+
+See [src/zig/bench.zig](src/zig/bench.zig) for available options like `--filter` and `--mem`.
+
 ## CLI Renderer
 
 ### Renderables

package/Renderable.d.ts

@@ -140,6 +140,7 @@ export declare abstract class Renderable extends BaseRenderable {
     protected _positionType: PositionTypeString;
     protected _overflow: OverflowString;
     protected _position: Position;
+    private _flexShrink;
     private renderableMapById;
     protected _childrenInLayoutOrder: Renderable[];
     protected _childrenInZIndexOrder: Renderable[];
@@ -201,33 +202,33 @@ export declare abstract class Renderable extends BaseRenderable {
     getChildrenSortedByPrimaryAxis(): Renderable[];
     private setupYogaProperties;
     private setupMarginAndPadding;
-    set position(positionType: PositionTypeString);
+    set position(positionType: PositionTypeString | null | undefined);
     get overflow(): OverflowString;
-    set overflow(overflow: OverflowString);
+    set overflow(overflow: OverflowString | null | undefined);
     setPosition(position: Position): void;
     private updateYogaPosition;
-    set flexGrow(grow: number);
-    set flexShrink(shrink: number);
-    set flexDirection(direction: FlexDirectionString);
-    set flexWrap(wrap: WrapString);
-    set alignItems(alignItems: AlignString);
-    set justifyContent(justifyContent: JustifyString);
-    set alignSelf(alignSelf: AlignString);
-    set flexBasis(basis: number | "auto" | undefined);
-    set minWidth(minWidth: number | `${number}%` | undefined);
-    set maxWidth(maxWidth: number | `${number}%` | undefined);
-    set minHeight(minHeight: number | `${number}%` | undefined);
-    set maxHeight(maxHeight: number | `${number}%` | undefined);
-    set margin(margin: number | "auto" | `${number}%` | undefined);
-    set marginTop(margin: number | "auto" | `${number}%` | undefined);
-    set marginRight(margin: number | "auto" | `${number}%` | undefined);
-    set marginBottom(margin: number | "auto" | `${number}%` | undefined);
-    set marginLeft(margin: number | "auto" | `${number}%` | undefined);
-    set padding(padding: number | `${number}%` | undefined);
-    set paddingTop(padding: number | `${number}%` | undefined);
-    set paddingRight(padding: number | `${number}%` | undefined);
-    set paddingBottom(padding: number | `${number}%` | undefined);
-    set paddingLeft(padding: number | `${number}%` | undefined);
+    set flexGrow(grow: number | null | undefined);
+    set flexShrink(shrink: number | null | undefined);
+    set flexDirection(direction: FlexDirectionString | null | undefined);
+    set flexWrap(wrap: WrapString | null | undefined);
+    set alignItems(alignItems: AlignString | null | undefined);
+    set justifyContent(justifyContent: JustifyString | null | undefined);
+    set alignSelf(alignSelf: AlignString | null | undefined);
+    set flexBasis(basis: number | "auto" | null | undefined);
+    set minWidth(minWidth: number | `${number}%` | null | undefined);
+    set maxWidth(maxWidth: number | `${number}%` | null | undefined);
+    set minHeight(minHeight: number | `${number}%` | null | undefined);
+    set maxHeight(maxHeight: number | `${number}%` | null | undefined);
+    set margin(margin: number | "auto" | `${number}%` | null | undefined);
+    set marginTop(margin: number | "auto" | `${number}%` | null | undefined);
+    set marginRight(margin: number | "auto" | `${number}%` | null | undefined);
+    set marginBottom(margin: number | "auto" | `${number}%` | null | undefined);
+    set marginLeft(margin: number | "auto" | `${number}%` | null | undefined);
+    set padding(padding: number | `${number}%` | null | undefined);
+    set paddingTop(padding: number | `${number}%` | null | undefined);
+    set paddingRight(padding: number | `${number}%` | null | undefined);
+    set paddingBottom(padding: number | `${number}%` | null | undefined);
+    set paddingLeft(padding: number | `${number}%` | null | undefined);
     getLayoutNode(): YogaNode;
     updateFromLayout(): void;
     protected onLayoutResize(width: number, height: number): void;

package/buffer.d.ts

@@ -1,9 +1,10 @@
-import type { TextBuffer } from "./text-buffer";
 import { RGBA } from "./lib";
 import { type RenderLib } from "./zig";
 import { type Pointer } from "bun:ffi";
 import { type BorderStyle, type BorderSides } from "./lib";
 import { type WidthMethod } from "./types";
+import type { TextBufferView } from "./text-buffer-view";
+import type { EditorView } from "./editor-view";
 export declare class OptimizedBuffer {
     private static fbIdCounter;
     id: string;
@@ -47,12 +48,8 @@ export declare class OptimizedBuffer {
     fillRect(x: number, y: number, width: number, height: number, bg: RGBA): void;
     drawFrameBuffer(destX: number, destY: number, frameBuffer: OptimizedBuffer, sourceX?: number, sourceY?: number, sourceWidth?: number, sourceHeight?: number): void;
     destroy(): void;
-    drawTextBuffer(textBuffer: TextBuffer, x: number, y: number, clipRect?: {
-        x: number;
-        y: number;
-        width: number;
-        height: number;
-    }): void;
+    drawTextBuffer(textBufferView: TextBufferView, x: number, y: number): void;
+    drawEditorView(editorView: EditorView, x: number, y: number): void;
     drawSuperSampleBuffer(x: number, y: number, pixelDataPtr: Pointer, pixelDataLength: number, format: "bgra8unorm" | "rgba8unorm", alignedBytesPerRow: number): void;
     drawPackedBuffer(dataPtr: Pointer, dataLen: number, posX: number, posY: number, terminalWidthCells: number, terminalHeightCells: number): void;
     resize(width: number, height: number): void;

package/edit-buffer.d.ts

@@ -0,0 +1,76 @@
+import { type RenderLib } from "./zig";
+import { type Pointer } from "bun:ffi";
+import { type WidthMethod, type Highlight } from "./types";
+import { RGBA } from "./lib/RGBA";
+import { EventEmitter } from "events";
+import type { SyntaxStyle } from "./syntax-style";
+export interface CursorPosition {
+    line: number;
+    visualColumn: number;
+    offset: number;
+}
+/**
+ * EditBuffer provides a text editing buffer with cursor management,
+ * incremental editing, and grapheme-aware operations.
+ */
+export declare class EditBuffer extends EventEmitter {
+    private static registry;
+    private static nativeEventsSubscribed;
+    private lib;
+    private bufferPtr;
+    private textBufferPtr;
+    readonly id: number;
+    private _destroyed;
+    private _textBytes;
+    private _singleTextBytes;
+    private _singleTextMemId;
+    private _syntaxStyle?;
+    constructor(lib: RenderLib, ptr: Pointer);
+    static create(widthMethod: WidthMethod): EditBuffer;
+    private static subscribeToNativeEvents;
+    private guard;
+    get ptr(): Pointer;
+    setText(text: string, opts?: {
+        history?: boolean;
+    }): void;
+    setTextOwned(text: string, opts?: {
+        history?: boolean;
+    }): void;
+    getText(): string;
+    insertChar(char: string): void;
+    insertText(text: string): void;
+    deleteChar(): void;
+    deleteCharBackward(): void;
+    newLine(): void;
+    deleteLine(): void;
+    moveCursorLeft(): void;
+    moveCursorRight(): void;
+    moveCursorUp(): void;
+    moveCursorDown(): void;
+    gotoLine(line: number): void;
+    setCursor(line: number, col: number): void;
+    setCursorToLineCol(line: number, col: number): void;
+    setCursorByOffset(offset: number): void;
+    getCursorPosition(): CursorPosition;
+    debugLogRope(): void;
+    undo(): string | null;
+    redo(): string | null;
+    canUndo(): boolean;
+    canRedo(): boolean;
+    clearHistory(): void;
+    setDefaultFg(fg: RGBA | null): void;
+    setDefaultBg(bg: RGBA | null): void;
+    setDefaultAttributes(attributes: number | null): void;
+    resetDefaults(): void;
+    setPlaceholder(text: string | null): void;
+    setPlaceholderColor(color: RGBA): void;
+    setSyntaxStyle(style: SyntaxStyle | null): void;
+    getSyntaxStyle(): SyntaxStyle | null;
+    addHighlight(lineIdx: number, highlight: Highlight): void;
+    addHighlightByCharRange(highlight: Highlight): void;
+    removeHighlightsByRef(hlRef: number): void;
+    clearLineHighlights(lineIdx: number): void;
+    clearAllHighlights(): void;
+    getLineHighlights(lineIdx: number): Array<Highlight>;
+    destroy(): void;
+}

package/editor-view.d.ts

@@ -0,0 +1,50 @@
+import { RGBA } from "./lib/RGBA";
+import { type RenderLib, type VisualCursor, type LineInfo } from "./zig";
+import { type Pointer } from "bun:ffi";
+import type { EditBuffer } from "./edit-buffer";
+export interface Viewport {
+    offsetY: number;
+    offsetX: number;
+    height: number;
+    width: number;
+}
+export type { VisualCursor };
+export declare class EditorView {
+    private lib;
+    private viewPtr;
+    private editBuffer;
+    private _destroyed;
+    constructor(lib: RenderLib, ptr: Pointer, editBuffer: EditBuffer);
+    static create(editBuffer: EditBuffer, viewportWidth: number, viewportHeight: number): EditorView;
+    private guard;
+    get ptr(): Pointer;
+    setViewportSize(width: number, height: number): void;
+    getViewport(): Viewport;
+    setScrollMargin(margin: number): void;
+    setWrapMode(mode: "none" | "char" | "word"): void;
+    getVirtualLineCount(): number;
+    getTotalVirtualLineCount(): number;
+    setSelection(start: number, end: number, bgColor?: RGBA, fgColor?: RGBA): void;
+    resetSelection(): void;
+    getSelection(): {
+        start: number;
+        end: number;
+    } | null;
+    hasSelection(): boolean;
+    setLocalSelection(anchorX: number, anchorY: number, focusX: number, focusY: number, bgColor?: RGBA, fgColor?: RGBA): boolean;
+    resetLocalSelection(): void;
+    getSelectedText(): string;
+    getCursor(): {
+        row: number;
+        col: number;
+    };
+    getText(): string;
+    getVisualCursor(): VisualCursor;
+    moveUpVisual(): void;
+    moveDownVisual(): void;
+    deleteSelectedText(): void;
+    setCursorByOffset(offset: number): void;
+    getLineInfo(): LineInfo;
+    getLogicalLineInfo(): LineInfo;
+    destroy(): void;
+}