mirrors/ghostty
1
0
Fork 0
mirror of https://github.com/ghostty-org/ghostty.git synced 2026-07-10 11:19:45 +00:00
Code Issues Packages Projects Releases Wiki Activity

fix(lib-vt): pass RGB color inputs by pointer (#13238)

Browse Source 
Fixes C ABI compatibility issue on arm64 macOS by passing color by
reference instead of by value. I ran into an
[issue](https://github.com/elias8/libghostty/actions/runs/28889437162/job/85698207979?pr=93)
while working on the Dart bindings, where tests passed on Linux and
x86_64 macOS locally, but failed on arm64 macOS. The Dart FFI appears to
lower the argument (3 byte struct) differently on arm64 macOS. So the
change addresses that by changing the arguments to by reference and
aligns with the preexisting APIs.

_AI disclosure: I used codex 5.5 to assist with debugging and making the
changes. However, I have reviewed all changes manually and verified by
running the tests both locally and on CI with the fix applied._
This commit is contained in:
Mitchell Hashimoto
2026-07-07 13:05:51 -07:00
committed by GitHub
parent e7a3a1fc8c 20a1bfa5fd
commit 5a4f8106a3
2 changed files with 55 additions and 40 deletions
Download Patch File Download Diff File Expand all files Collapse all files

31
include/ghostty/vt/color.h
View File

@@ -88,8 +88,8 @@
* ghostty_color_palette_generate(
* palette,
* &skip,
* background,
* foreground,
* &background,
* &foreground,
* true,
* palette);
* @endcode
@@ -265,14 +265,14 @@ typedef struct {
* from a GhosttyColorRgb value. Primarily useful in WebAssembly environments
* where accessing struct fields directly is difficult.
*
* @param color The RGB color value
* @param color Pointer to the RGB color value
* @param r Pointer to store the red component (0-255)
* @param g Pointer to store the green component (0-255)
* @param b Pointer to store the blue component (0-255)
*
* @ingroup color
*/
GHOSTTY_API void ghostty_color_rgb_get(GhosttyColorRgb color,
GHOSTTY_API void ghostty_color_rgb_get(const GhosttyColorRgb* color,
uint8_t* r,
uint8_t* g,
uint8_t* b);
@@ -374,8 +374,8 @@ GHOSTTY_API void ghostty_color_palette_default(GhosttyColorRgb* out);
* values, or NULL to use Ghostty's default palette
* @param skip The palette indices to preserve from @p base, or NULL for
* an empty mask
* @param bg The terminal background color
* @param fg The terminal foreground color
* @param bg The terminal background color (must not be NULL)
* @param fg The terminal foreground color (must not be NULL)
* @param harmonious Whether light themes keep background-to-foreground
* orientation
* @param[out] out The output palette, an array of exactly 256
@@ -386,8 +386,8 @@ GHOSTTY_API void ghostty_color_palette_default(GhosttyColorRgb* out);
GHOSTTY_API void ghostty_color_palette_generate(
const GhosttyColorRgb* base,
const GhosttyColorPaletteMask* skip,
GhosttyColorRgb bg,
GhosttyColorRgb fg,
const GhosttyColorRgb* bg,
const GhosttyColorRgb* fg,
bool harmonious,
GhosttyColorRgb* out);
@@ -397,12 +397,12 @@ GHOSTTY_API void ghostty_color_palette_generate(
* Returns a normalized value from 0.0 for black to 1.0 for white.
* See https://www.w3.org/TR/WCAG20/#relativeluminancedef.
*
* @param color The RGB color
* @param color The RGB color (must not be NULL)
* @return Relative luminance in the range 0.0 to 1.0
*
* @ingroup color
*/
GHOSTTY_API double ghostty_color_luminance(GhosttyColorRgb color);
GHOSTTY_API double ghostty_color_luminance(const GhosttyColorRgb* color);
/**
* Calculate perceived luminance for an RGB color.
@@ -412,12 +412,12 @@ GHOSTTY_API double ghostty_color_luminance(GhosttyColorRgb color);
* This is not the metric used internally by
* ghostty_color_palette_generate(), which uses CIELAB lightness.
*
* @param color The RGB color
* @param color The RGB color (must not be NULL)
* @return Perceived luminance in the range 0.0 to 1.0
*
* @ingroup color
*/
GHOSTTY_API double ghostty_color_perceived_luminance(GhosttyColorRgb color);
GHOSTTY_API double ghostty_color_perceived_luminance(const GhosttyColorRgb* color);
/**
* Calculate the WCAG contrast ratio between two RGB colors.
@@ -425,13 +425,14 @@ GHOSTTY_API double ghostty_color_perceived_luminance(GhosttyColorRgb color);
* The contrast ratio is symmetric and ranges from 1.0 for identical
* colors to 21.0 for black and white.
*
* @param a The first RGB color
* @param b The second RGB color
* @param a The first RGB color (must not be NULL)
* @param b The second RGB color (must not be NULL)
* @return WCAG contrast ratio in the range 1.0 to 21.0
*
* @ingroup color
*/
GHOSTTY_API double ghostty_color_contrast(GhosttyColorRgb a, GhosttyColorRgb b);
GHOSTTY_API double ghostty_color_contrast(const GhosttyColorRgb* a,
const GhosttyColorRgb* b);
/**
* Get Ghostty's X11 color name table.

64
src/terminal/c/color.zig
View File

@@ -40,7 +40,7 @@ const x11_entries: [x11_color.entries.len + 1]X11Entry = entries: {
};
pub fn rgb_get(
c: color.RGB.C,
c: *const color.RGB.C,
r: *u8,
g: *u8,
b: *u8,
@@ -81,8 +81,8 @@ pub fn palette_default(out: *color.PaletteC) callconv(lib.calling_conv) void {
pub fn palette_generate(
base_: ?*const color.PaletteC,
skip_: ?*const PaletteMask,
bg: color.RGB.C,
fg: color.RGB.C,
bg: *const color.RGB.C,
fg: *const color.RGB.C,
harmonious: bool,
out: *color.PaletteC,
) callconv(lib.calling_conv) void {
@@ -97,8 +97,8 @@ pub fn palette_generate(
const result = color.generate256Color(
base,
skip,
.fromC(bg),
.fromC(fg),
.fromC(bg.*),
.fromC(fg.*),
harmonious,
);
out.* = color.paletteCval(&result);
@@ -125,16 +125,16 @@ pub fn parse_palette_entry(
return .success;
}
pub fn luminance(c: color.RGB.C) callconv(lib.calling_conv) f64 {
return color.RGB.fromC(c).luminance();
pub fn luminance(c: *const color.RGB.C) callconv(lib.calling_conv) f64 {
return color.RGB.fromC(c.*).luminance();
}
pub fn perceived_luminance(c: color.RGB.C) callconv(lib.calling_conv) f64 {
return color.RGB.fromC(c).perceivedLuminance();
pub fn perceived_luminance(c: *const color.RGB.C) callconv(lib.calling_conv) f64 {
return color.RGB.fromC(c.*).perceivedLuminance();
}
pub fn contrast(a: color.RGB.C, b: color.RGB.C) callconv(lib.calling_conv) f64 {
return color.RGB.fromC(a).contrast(.fromC(b));
pub fn contrast(a: *const color.RGB.C, b: *const color.RGB.C) callconv(lib.calling_conv) f64 {
return color.RGB.fromC(a.*).contrast(.fromC(b.*));
}
fn expectRgb(expected: color.RGB, actual: color.RGB.C) !void {
@@ -155,7 +155,9 @@ fn generatePalette(
harmonious: bool,
) color.PaletteC {
var out: color.PaletteC = undefined;
palette_generate(base_, skip_, bg.cval(), fg.cval(), harmonious, &out);
const bg_c = bg.cval();
const fg_c = fg.cval();
palette_generate(base_, skip_, &bg_c, &fg_c, harmonious, &out);
return out;
}
@@ -485,7 +487,9 @@ test "color: palette_generate in-place" {
const fg = color.RGB{ .r = 255, .g = 255, .b = 255 };
const expected = generatePalette(&base, null, bg, fg, false);
palette_generate(&base, null, bg.cval(), fg.cval(), false, &base);
const bg_c = bg.cval();
const fg_c = fg.cval();
palette_generate(&base, null, &bg_c, &fg_c, false, &base);
try expectPaletteC(&expected, &base);
}
@@ -494,8 +498,10 @@ test "color: luminance" {
const black = color.RGB{ .r = 0, .g = 0, .b = 0 };
const white = color.RGB{ .r = 255, .g = 255, .b = 255 };
try testing.expectApproxEqAbs(@as(f64, 0.0), luminance(black.cval()), 0.000001);
try testing.expectApproxEqAbs(@as(f64, 1.0), luminance(white.cval()), 0.000001);
const black_c = black.cval();
const white_c = white.cval();
try testing.expectApproxEqAbs(@as(f64, 0.0), luminance(&black_c), 0.000001);
try testing.expectApproxEqAbs(@as(f64, 1.0), luminance(&white_c), 0.000001);
const samples = [_]color.RGB{
.{ .r = 40, .g = 44, .b = 52 },
@@ -503,7 +509,8 @@ test "color: luminance" {
.{ .r = 12, .g = 34, .b = 56 },
};
for (samples) |sample| {
try testing.expectApproxEqAbs(sample.luminance(), luminance(sample.cval()), 0.000001);
const sample_c = sample.cval();
try testing.expectApproxEqAbs(sample.luminance(), luminance(&sample_c), 0.000001);
}
}
@@ -513,10 +520,13 @@ test "color: perceived_luminance" {
const black = color.RGB{ .r = 0, .g = 0, .b = 0 };
const white = color.RGB{ .r = 255, .g = 255, .b = 255 };
const dark = color.RGB{ .r = 0x28, .g = 0x2C, .b = 0x34 };
try testing.expectApproxEqAbs(@as(f64, 0.0), perceived_luminance(black.cval()), 0.000001);
try testing.expectApproxEqAbs(@as(f64, 1.0), perceived_luminance(white.cval()), 0.000001);
try testing.expect(perceived_luminance(dark.cval()) < 0.5);
try testing.expect(perceived_luminance(white.cval()) > 0.5);
const black_c = black.cval();
const white_c = white.cval();
const dark_c = dark.cval();
try testing.expectApproxEqAbs(@as(f64, 0.0), perceived_luminance(&black_c), 0.000001);
try testing.expectApproxEqAbs(@as(f64, 1.0), perceived_luminance(&white_c), 0.000001);
try testing.expect(perceived_luminance(&dark_c) < 0.5);
try testing.expect(perceived_luminance(&white_c) > 0.5);
const samples = [_]color.RGB{
dark,
@@ -524,9 +534,10 @@ test "color: perceived_luminance" {
.{ .r = 12, .g = 34, .b = 56 },
};
for (samples) |sample| {
const sample_c = sample.cval();
try testing.expectApproxEqAbs(
sample.perceivedLuminance(),
perceived_luminance(sample.cval()),
perceived_luminance(&sample_c),
0.000001,
);
}
@@ -538,14 +549,17 @@ test "color: contrast" {
const black = color.RGB{ .r = 0, .g = 0, .b = 0 };
const white = color.RGB{ .r = 255, .g = 255, .b = 255 };
const gray = color.RGB{ .r = 128, .g = 128, .b = 128 };
const black_c = black.cval();
const white_c = white.cval();
const gray_c = gray.cval();
try testing.expectApproxEqAbs(@as(f64, 21.0), contrast(white.cval(), black.cval()), 0.000001);
try testing.expectApproxEqAbs(@as(f64, 21.0), contrast(&white_c, &black_c), 0.000001);
try testing.expectApproxEqAbs(
contrast(black.cval(), white.cval()),
contrast(white.cval(), black.cval()),
contrast(&black_c, &white_c),
contrast(&white_c, &black_c),
0.000001,
);
try testing.expectApproxEqAbs(@as(f64, 1.0), contrast(gray.cval(), gray.cval()), 0.000001);
try testing.expectApproxEqAbs(@as(f64, 1.0), contrast(&gray_c, &gray_c), 0.000001);
}
test "color: x11_names" {