From b9db62966263a99d28282d1c2cf9b1930f9f5d0e Mon Sep 17 00:00:00 2001
From: Mitchell Hashimoto <mitchell.hashimoto@gmail.com>
Date: Fri, 18 Aug 2023 14:42:59 -0700
Subject: [PATCH] terminal: kitty graphics command/control structs

---
 src/terminal/kitty.zig          |   5 +
 src/terminal/kitty/graphics.zig | 199 ++++++++++++++++++++++++++++++++
 2 files changed, 204 insertions(+)
 create mode 100644 src/terminal/kitty/graphics.zig

diff --git a/src/terminal/kitty.zig b/src/terminal/kitty.zig
index 9b7e6fc3c..497dd4aba 100644
--- a/src/terminal/kitty.zig
+++ b/src/terminal/kitty.zig
@@ -1,3 +1,8 @@
 //! Types and functions related to Kitty protocols.
 
+pub const graphics = @import("kitty/graphics.zig");
 pub usingnamespace @import("kitty/key.zig");
+
+test {
+    @import("std").testing.refAllDecls(@This());
+}
diff --git a/src/terminal/kitty/graphics.zig b/src/terminal/kitty/graphics.zig
new file mode 100644
index 000000000..f2c954d9f
--- /dev/null
+++ b/src/terminal/kitty/graphics.zig
@@ -0,0 +1,199 @@
+//! Kitty graphics protocol support.
+//!
+//! Documentation:
+//! https://sw.kovidgoyal.net/kitty/graphics-protocol
+
+const std = @import("std");
+
+pub const Command = struct {
+    control: Control,
+    quiet: Quiet = .no,
+
+    pub const Action = enum {
+        query, // q
+        transmit, // t
+        transmit_and_display, // T
+        display, // p
+        delete, // d
+        transmit_animation_frame, // f
+        control_animation, // a
+        compose_animation, // c
+    };
+
+    pub const Quiet = enum {
+        no, // 0
+        ok, // 1
+        failures, // 2
+    };
+
+    pub const Control = union(Action) {
+        query: Transmission,
+        transmit: Transmission,
+        transmit_and_display: struct {
+            transmission: Transmission,
+            display: Display,
+        },
+        display: Display,
+        delete: Delete,
+        transmit_animation_frame: AnimationFrameLoading,
+        control_animation: AnimationControl,
+        compose_animation: AnimationFrameComposition,
+    };
+};
+
+pub const Transmission = struct {
+    format: Format = .rgb, // f
+    medium: Medium = .direct, // t
+    width: u32 = 0, // s
+    height: u32 = 0, // v
+    size: u32 = 0, // S
+    offset: u32 = 0, // O
+    image_id: u32 = 0, // i
+    image_number: u32 = 0, // I
+    placement_id: u32 = 0, // p
+    compression: Compression = .none, // o
+    more_chunks: bool = false, // m
+
+    pub const Format = enum {
+        rgb, // 24
+        rgba, // 32
+        png, // 100
+    };
+
+    pub const Medium = enum {
+        direct, // d
+        file, // f
+        temporary_file, // t
+        shared_memory, // s
+    };
+
+    pub const Compression = enum {
+        none,
+        zlib_deflate, // z
+    };
+};
+
+pub const Display = struct {
+    x: u32 = 0, // x
+    y: u32 = 0, // y
+    width: u32 = 0, // w
+    height: u32 = 0, // h
+    x_offset: u32 = 0, // X
+    y_offset: u32 = 0, // Y
+    columns: u32 = 0, // c
+    rows: u32 = 0, // r
+    cursor_movement: CursorMovement = .after, // C
+    virtual_placement: bool = false, // U
+    z: u32 = 0, // z
+
+    pub const CursorMovement = enum {
+        after, // 0
+        none, // 1
+    };
+};
+
+pub const AnimationFrameLoading = struct {
+    x: u32 = 0, // x
+    y: u32 = 0, // y
+    create_frame: u32 = 0, // c
+    edit_frame: u32 = 0, // r
+    gap_ms: u32 = 0, // z
+    composition_mode: CompositionMode = .alpha_blend, // X
+    background: Background = .{}, // Y
+
+    pub const Background = packed struct(u32) {
+        r: u8 = 0,
+        g: u8 = 0,
+        b: u8 = 0,
+        a: u8 = 0,
+    };
+};
+
+pub const AnimationFrameComposition = struct {
+    frame: u32 = 0, // c
+    edit_frame: u32 = 0, // r
+    x: u32 = 0, // x
+    y: u32 = 0, // y
+    width: u32 = 0, // w
+    height: u32 = 0, // h
+    left_edge: u32 = 0, // X
+    top_edge: u32 = 0, // Y
+    composition_mode: CompositionMode = .alpha_blend, // C
+};
+
+pub const AnimationControl = struct {
+    action: AnimationAction = .invalid, // s
+    frame: u32 = 0, // r
+    gap_ms: u32 = 0, // z
+    current_frame: u32 = 0, // c
+    loops: u32 = 0, // v
+
+    pub const AnimationAction = enum {
+        stop, // 1
+        run_wait, // 2
+        run, // 3
+    };
+};
+
+pub const Delete = union(enum) {
+    // a/A
+    all: bool,
+
+    // i/I
+    id: struct {
+        delete: bool = false, // uppercase
+        image_id: u32 = 0, // i
+        placement_id: u32 = 0, // p
+    },
+
+    // n/N
+    newest: struct {
+        delete: bool = false, // uppercase
+        count: u32 = 0, // I
+        placement_id: u32 = 0, // p
+    },
+
+    // c/C,
+    intersect_cursor: bool,
+
+    // f/F
+    animation_frames: bool,
+
+    // p/P
+    intersect_cell: struct {
+        delete: bool = false, // uppercase
+        x: u32 = 0, // x
+        y: u32 = 0, // y
+    },
+
+    // q/Q
+    intersect_cell_z: struct {
+        delete: bool = false, // uppercase
+        x: u32 = 0, // x
+        y: u32 = 0, // y
+        z: u32 = 0, // z
+    },
+
+    // x/X
+    column: struct {
+        delete: bool = false, // uppercase
+        x: u32 = 0, // x
+    },
+
+    // y/Y
+    row: struct {
+        delete: bool = false, // uppercase
+        y: u32 = 0, // y
+    },
+
+    // z/Z
+    z: struct {
+        delete: bool = false, // uppercase
+        z: u32 = 0, // z
+    },
+};
+
+pub const CompositionMode = enum {
+    alpha_blend, // 0
+    overwrite, // 1
+};