example: rename some examples

example/c-vt-encode-mouse/README.md

@@ -0,0 +1,23 @@
+# Example: `ghostty-vt` C Mouse Encoding
+
+This example demonstrates how to use the `ghostty-vt` C library to encode mouse
+events into terminal escape sequences.
+
+This example specifically shows how to:
+
+1. Create a mouse encoder with the C API
+2. Configure tracking mode and output format (this example uses SGR)
+3. Set terminal geometry for pixel-to-cell coordinate mapping
+4. Create and configure a mouse event
+5. Encode the mouse event into a terminal escape sequence
+
+The example encodes a left button press at pixel position (50, 40) using SGR
+format, producing an escape sequence like `\x1b[<0;6;3M`.
+
+## Usage
+
+Run the program:
+
+```shell-session
+zig build run
+```

example/c-vt-encode-mouse/build.zig

@@ -0,0 +1,42 @@
+const std = @import("std");
+
+pub fn build(b: *std.Build) void {
+    const target = b.standardTargetOptions(.{});
+    const optimize = b.standardOptimizeOption(.{});
+
+    const run_step = b.step("run", "Run the app");
+
+    const exe_mod = b.createModule(.{
+        .target = target,
+        .optimize = optimize,
+    });
+    exe_mod.addCSourceFiles(.{
+        .root = b.path("src"),
+        .files = &.{"main.c"},
+    });
+
+    // You'll want to use a lazy dependency here so that ghostty is only
+    // downloaded if you actually need it.
+    if (b.lazyDependency("ghostty", .{
+        // Setting simd to false will force a pure static build that
+        // doesn't even require libc, but it has a significant performance
+        // penalty. If your embedding app requires libc anyway, you should
+        // always keep simd enabled.
+        // .simd = false,
+    })) |dep| {
+        exe_mod.linkLibrary(dep.artifact("ghostty-vt"));
+    }
+
+    // Exe
+    const exe = b.addExecutable(.{
+        .name = "c_vt_encode_mouse",
+        .root_module = exe_mod,
+    });
+    b.installArtifact(exe);
+
+    // Run
+    const run_cmd = b.addRunArtifact(exe);
+    run_cmd.step.dependOn(b.getInstallStep());
+    if (b.args) |args| run_cmd.addArgs(args);
+    run_step.dependOn(&run_cmd.step);
+}

example/c-vt-encode-mouse/build.zig.zon

@@ -0,0 +1,24 @@
+.{
+    .name = .c_vt,
+    .version = "0.0.0",
+    .fingerprint = 0x413a8529a6dd3c51,
+    .minimum_zig_version = "0.15.1",
+    .dependencies = .{
+        // Ghostty dependency. In reality, you'd probably use a URL-based
+        // dependency like the one showed (and commented out) below this one.
+        // We use a path dependency here for simplicity and to ensure our
+        // examples always test against the source they're bundled with.
+        .ghostty = .{ .path = "../../" },
+
+        // Example of what a URL-based dependency looks like:
+        // .ghostty = .{
+        //     .url = "https://github.com/ghostty-org/ghostty/archive/COMMIT.tar.gz",
+        //     .hash = "N-V-__8AAMVLTABmYkLqhZPLXnMl-KyN38R8UVYqGrxqO36s",
+        // },
+    },
+    .paths = .{
+        "build.zig",
+        "build.zig.zon",
+        "src",
+    },
+}

example/c-vt-encode-mouse/src/main.c

@@ -0,0 +1,52 @@
+#include <assert.h>
+#include <stddef.h>
+#include <stdio.h>
+#include <string.h>
+#include <ghostty/vt.h>
+
+//! [mouse-encode]
+int main() {
+  // Create encoder
+  GhosttyMouseEncoder encoder;
+  GhosttyResult result = ghostty_mouse_encoder_new(NULL, &encoder);
+  assert(result == GHOSTTY_SUCCESS);
+
+  // Configure SGR format with normal tracking
+  ghostty_mouse_encoder_setopt(encoder, GHOSTTY_MOUSE_ENCODER_OPT_EVENT,
+      &(GhosttyMouseTrackingMode){GHOSTTY_MOUSE_TRACKING_NORMAL});
+  ghostty_mouse_encoder_setopt(encoder, GHOSTTY_MOUSE_ENCODER_OPT_FORMAT,
+      &(GhosttyMouseFormat){GHOSTTY_MOUSE_FORMAT_SGR});
+
+  // Set terminal geometry for coordinate mapping
+  ghostty_mouse_encoder_setopt(encoder, GHOSTTY_MOUSE_ENCODER_OPT_SIZE,
+      &(GhosttyMouseEncoderSize){
+          .size = sizeof(GhosttyMouseEncoderSize),
+          .screen_width = 800, .screen_height = 600,
+          .cell_width = 10, .cell_height = 20,
+      });
+
+  // Create and configure a left button press event
+  GhosttyMouseEvent event;
+  result = ghostty_mouse_event_new(NULL, &event);
+  assert(result == GHOSTTY_SUCCESS);
+  ghostty_mouse_event_set_action(event, GHOSTTY_MOUSE_ACTION_PRESS);
+  ghostty_mouse_event_set_button(event, GHOSTTY_MOUSE_BUTTON_LEFT);
+  ghostty_mouse_event_set_position(event,
+      (GhosttyMousePosition){.x = 50.0f, .y = 40.0f});
+
+  // Encode the mouse event
+  char buf[128];
+  size_t written = 0;
+  result = ghostty_mouse_encoder_encode(encoder, event,
+      buf, sizeof(buf), &written);
+  assert(result == GHOSTTY_SUCCESS);
+
+  // Use the encoded sequence (e.g., write to terminal)
+  fwrite(buf, 1, written, stdout);
+
+  // Cleanup
+  ghostty_mouse_event_free(event);
+  ghostty_mouse_encoder_free(encoder);
+  return 0;
+}
+//! [mouse-encode]