diff options
| author | Can Celik <ogulcancelik@gmail.com> | 2026-09-10 21:51:57 +0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2026-09-10 21:51:57 +0300 |
| commit | 425c86179791cd32e2d4ce0ae7f269940b4b0663 (patch) | |
| tree | e52c4383a6d69216cbe2a32638bf90841d7e2189 /vendor/libghostty-vt/src/terminal/snapshot/envelope.zig | |
| parent | 90e947a6e26e02f10ec7f1694c4eb5b78a86406b (diff) | |
chore: upgrade libghostty and preserve terminal behavior (#3906)
Diffstat (limited to 'vendor/libghostty-vt/src/terminal/snapshot/envelope.zig')
| -rw-r--r-- | vendor/libghostty-vt/src/terminal/snapshot/envelope.zig | 104 |
1 files changed, 104 insertions, 0 deletions
diff --git a/vendor/libghostty-vt/src/terminal/snapshot/envelope.zig b/vendor/libghostty-vt/src/terminal/snapshot/envelope.zig new file mode 100644 index 00000000..21fcefb9 --- /dev/null +++ b/vendor/libghostty-vt/src/terminal/snapshot/envelope.zig @@ -0,0 +1,104 @@ +//! Snapshot envelope. +//! +//! Every snapshot binary blob begins with exactly one envelope at byte zero. +//! It is followed by a set of records. Each record provides their own +//! tag, payload length, CRC, etc. +//! +//! The envelope identifies the bytes as a terminal snapshot and selects the +//! single version governing the entire blob. A decoder validates both fields +//! before reading any records. +//! +//! The envelope is exactly ten bytes. All integers are unsigned and +//! little-endian. +//! +//! | Offset | Size | Field | +//! | -----: | ---: | :------------------- | +//! | 0 | 8 | Magic (`GHOSTSNP`) | +//! | 8 | 2 | Version (`u16`) | + +const std = @import("std"); +const test_fixture = @import("fixture.zig"); +const io = @import("io.zig"); + +/// Identifies a Ghostty terminal snapshot and rejects unrelated input before +/// any record decoding begins. All eight bytes are part of the wire value. +pub const magic = "GHOSTSNP"; + +/// The complete compatibility boundary for snapshot layout and behavior. +/// Version 1 readers require this value to match exactly. +pub const version: u16 = 1; + +/// Number of bytes in the fixed envelope: magic followed by version. +pub const encoded_len = computeLen(); + +comptime { + // We expect this so if it changes we should think carefully. + std.debug.assert(encoded_len == 10); +} + +pub const DecodeError = std.Io.Reader.Error || error{ + InvalidMagic, + UnsupportedVersion, +}; + +/// Encode the envelope. +pub fn encode(writer: *std.Io.Writer) std.Io.Writer.Error!void { + try writer.writeAll(magic); + try io.writeInt(writer, u16, version); +} + +/// Decode and validate the envelope. +pub fn decode(reader: *std.Io.Reader) DecodeError!void { + var actual_magic: [magic.len]u8 = undefined; + try reader.readSliceAll(&actual_magic); + if (!std.mem.eql(u8, magic, &actual_magic)) return error.InvalidMagic; + + const actual_version = try io.readInt(reader, u16); + if (actual_version != version) return error.UnsupportedVersion; +} + +fn computeLen() usize { + comptime { + var buf: [128]u8 = undefined; + var writer: std.Io.Writer = .fixed(&buf); + encode(&writer) catch unreachable; + return writer.end; + } +} + +const test_golden_fixture = test_fixture.parse(@embedFile("testdata/envelope-v1.hex")); + +test "golden encoding" { + var buf: [encoded_len]u8 = undefined; + var writer: std.Io.Writer = .fixed(&buf); + try encode(&writer); + + try test_fixture.expectEqual( + .bytes, + "src/terminal/snapshot/testdata/envelope-v1.hex", + "snapshot_fixture-envelope-v1.hex", + &test_golden_fixture, + writer.buffered(), + ); + + var reader: std.Io.Reader = .fixed(&test_golden_fixture); + try decode(&reader); +} + +test "reject invalid magic and version" { + var invalid_magic: std.Io.Reader = .fixed("GHOSTSNX\x01\x00"); + try std.testing.expectError(error.InvalidMagic, decode(&invalid_magic)); + + var invalid_version: std.Io.Reader = .fixed("GHOSTSNP\x00\x00"); + try std.testing.expectError( + error.UnsupportedVersion, + decode(&invalid_version), + ); +} + +test "reject every truncation" { + for (0..encoded_len) |len| { + var reader: std.Io.Reader = .fixed(test_golden_fixture[0..len]); + try std.testing.expectError(error.EndOfStream, decode(&reader)); + } +} |
