#![cfg(unix)]
use std::env;
use std::error::Error;
use std::ffi::OsString;
use std::mem::{align_of, size_of};
use std::path::Path;
use std::process::{Command, Stdio};
use std::str;
use tempfile::Builder;
use vte_sys::*;
static PACKAGES: &[&str] = &["vte-2.91"];
#[derive(Clone, Debug)]
struct Compiler {
pub args: Vec<String>,
}
impl Compiler {
pub fn new() -> Result<Self, Box<dyn Error>> {
let mut args = get_var("CC", "cc")?;
args.push("-Wno-deprecated-declarations".to_owned());
args.push("-std=c11".to_owned());
args.push("-D__USE_MINGW_ANSI_STDIO".to_owned());
args.extend(get_var("CFLAGS", "")?);
args.extend(get_var("CPPFLAGS", "")?);
args.extend(pkg_config_cflags(PACKAGES)?);
Ok(Self { args })
}
pub fn compile(&self, src: &Path, out: &Path) -> Result<(), Box<dyn Error>> {
let mut cmd = self.to_command();
cmd.arg(src);
cmd.arg("-o");
cmd.arg(out);
let status = cmd.spawn()?.wait()?;
if !status.success() {
return Err(format!("compilation command {cmd:?} failed, {status}").into());
}
Ok(())
}
fn to_command(&self) -> Command {
let mut cmd = Command::new(&self.args[0]);
cmd.args(&self.args[1..]);
cmd
}
}
fn get_var(name: &str, default: &str) -> Result<Vec<String>, Box<dyn Error>> {
match env::var(name) {
Ok(value) => Ok(shell_words::split(&value)?),
Err(env::VarError::NotPresent) => Ok(shell_words::split(default)?),
Err(err) => Err(format!("{name} {err}").into()),
}
}
fn pkg_config_cflags(packages: &[&str]) -> Result<Vec<String>, Box<dyn Error>> {
if packages.is_empty() {
return Ok(Vec::new());
}
let pkg_config = env::var_os("PKG_CONFIG").unwrap_or_else(|| OsString::from("pkg-config"));
let mut cmd = Command::new(pkg_config);
cmd.arg("--cflags");
cmd.args(packages);
cmd.stderr(Stdio::inherit());
let out = cmd.output()?;
if !out.status.success() {
let (status, stdout) = (out.status, String::from_utf8_lossy(&out.stdout));
return Err(format!("command {cmd:?} failed, {status:?}\nstdout: {stdout}").into());
}
let stdout = str::from_utf8(&out.stdout)?;
Ok(shell_words::split(stdout.trim())?)
}
#[derive(Copy, Clone, Debug, Eq, PartialEq)]
struct Layout {
size: usize,
alignment: usize,
}
#[derive(Copy, Clone, Debug, Default, Eq, PartialEq)]
struct Results {
passed: usize,
failed: usize,
}
impl Results {
fn record_passed(&mut self) {
self.passed += 1;
}
fn record_failed(&mut self) {
self.failed += 1;
}
fn summary(&self) -> String {
format!("{} passed; {} failed", self.passed, self.failed)
}
fn expect_total_success(&self) {
if self.failed == 0 {
println!("OK: {}", self.summary());
} else {
panic!("FAILED: {}", self.summary());
};
}
}
#[test]
fn cross_validate_constants_with_c() {
let mut c_constants: Vec<(String, String)> = Vec::new();
for l in get_c_output("constant").unwrap().lines() {
let (name, value) = l.split_once(';').expect("Missing ';' separator");
c_constants.push((name.to_owned(), value.to_owned()));
}
let mut results = Results::default();
for ((rust_name, rust_value), (c_name, c_value)) in
RUST_CONSTANTS.iter().zip(c_constants.iter())
{
if rust_name != c_name {
results.record_failed();
eprintln!("Name mismatch:\nRust: {rust_name:?}\nC: {c_name:?}");
continue;
}
if rust_value != c_value {
results.record_failed();
eprintln!(
"Constant value mismatch for {rust_name}\nRust: {rust_value:?}\nC: {c_value:?}",
);
continue;
}
results.record_passed();
}
results.expect_total_success();
}
#[test]
fn cross_validate_layout_with_c() {
let mut c_layouts = Vec::new();
for l in get_c_output("layout").unwrap().lines() {
let (name, value) = l.split_once(';').expect("Missing first ';' separator");
let (size, alignment) = value.split_once(';').expect("Missing second ';' separator");
let size = size.parse().expect("Failed to parse size");
let alignment = alignment.parse().expect("Failed to parse alignment");
c_layouts.push((name.to_owned(), Layout { size, alignment }));
}
let mut results = Results::default();
for ((rust_name, rust_layout), (c_name, c_layout)) in RUST_LAYOUTS.iter().zip(c_layouts.iter())
{
if rust_name != c_name {
results.record_failed();
eprintln!("Name mismatch:\nRust: {rust_name:?}\nC: {c_name:?}");
continue;
}
if rust_layout != c_layout {
results.record_failed();
eprintln!("Layout mismatch for {rust_name}\nRust: {rust_layout:?}\nC: {c_layout:?}",);
continue;
}
results.record_passed();
}
results.expect_total_success();
}
fn get_c_output(name: &str) -> Result<String, Box<dyn Error>> {
let tmpdir = Builder::new().prefix("abi").tempdir()?;
let exe = tmpdir.path().join(name);
let c_file = Path::new("tests").join(name).with_extension("c");
let cc = Compiler::new().expect("configured compiler");
cc.compile(&c_file, &exe)?;
let mut cmd = Command::new(exe);
cmd.stderr(Stdio::inherit());
let out = cmd.output()?;
if !out.status.success() {
let (status, stdout) = (out.status, String::from_utf8_lossy(&out.stdout));
return Err(format!("command {cmd:?} failed, {status:?}\nstdout: {stdout}").into());
}
Ok(String::from_utf8(out.stdout)?)
}
const RUST_LAYOUTS: &[(&str, Layout)] = &[
(
"VteAlign",
Layout {
size: size_of::<VteAlign>(),
alignment: align_of::<VteAlign>(),
},
),
(
"VteCursorBlinkMode",
Layout {
size: size_of::<VteCursorBlinkMode>(),
alignment: align_of::<VteCursorBlinkMode>(),
},
),
(
"VteCursorShape",
Layout {
size: size_of::<VteCursorShape>(),
alignment: align_of::<VteCursorShape>(),
},
),
(
"VteEraseBinding",
Layout {
size: size_of::<VteEraseBinding>(),
alignment: align_of::<VteEraseBinding>(),
},
),
(
"VteFeatureFlags",
Layout {
size: size_of::<VteFeatureFlags>(),
alignment: align_of::<VteFeatureFlags>(),
},
),
(
"VteFormat",
Layout {
size: size_of::<VteFormat>(),
alignment: align_of::<VteFormat>(),
},
),
(
"VteProgressHint",
Layout {
size: size_of::<VteProgressHint>(),
alignment: align_of::<VteProgressHint>(),
},
),
(
"VtePropertyFlags",
Layout {
size: size_of::<VtePropertyFlags>(),
alignment: align_of::<VtePropertyFlags>(),
},
),
(
"VtePropertyId",
Layout {
size: size_of::<VtePropertyId>(),
alignment: align_of::<VtePropertyId>(),
},
),
(
"VtePropertyType",
Layout {
size: size_of::<VtePropertyType>(),
alignment: align_of::<VtePropertyType>(),
},
),
(
"VtePtyError",
Layout {
size: size_of::<VtePtyError>(),
alignment: align_of::<VtePtyError>(),
},
),
(
"VtePtyFlags",
Layout {
size: size_of::<VtePtyFlags>(),
alignment: align_of::<VtePtyFlags>(),
},
),
(
"VteRegexError",
Layout {
size: size_of::<VteRegexError>(),
alignment: align_of::<VteRegexError>(),
},
),
(
"VteSystemdContextExitCondition",
Layout {
size: size_of::<VteSystemdContextExitCondition>(),
alignment: align_of::<VteSystemdContextExitCondition>(),
},
),
(
"VteSystemdContextOperation",
Layout {
size: size_of::<VteSystemdContextOperation>(),
alignment: align_of::<VteSystemdContextOperation>(),
},
),
(
"VteSystemdContextType",
Layout {
size: size_of::<VteSystemdContextType>(),
alignment: align_of::<VteSystemdContextType>(),
},
),
(
"VteSystemdPropertyId",
Layout {
size: size_of::<VteSystemdPropertyId>(),
alignment: align_of::<VteSystemdPropertyId>(),
},
),
(
"VteTerminal",
Layout {
size: size_of::<VteTerminal>(),
alignment: align_of::<VteTerminal>(),
},
),
(
"VteTerminalClass",
Layout {
size: size_of::<VteTerminalClass>(),
alignment: align_of::<VteTerminalClass>(),
},
),
(
"VteTextBlinkMode",
Layout {
size: size_of::<VteTextBlinkMode>(),
alignment: align_of::<VteTextBlinkMode>(),
},
),
(
"VteUuidFormat",
Layout {
size: size_of::<VteUuidFormat>(),
alignment: align_of::<VteUuidFormat>(),
},
),
(
"VteWriteFlags",
Layout {
size: size_of::<VteWriteFlags>(),
alignment: align_of::<VteWriteFlags>(),
},
),
];
const RUST_CONSTANTS: &[(&str, &str)] = &[
("(gint) VTE_ALIGN_CENTER", "1"),
("(gint) VTE_ALIGN_END", "2"),
("(gint) VTE_ALIGN_START", "0"),
("(gint) VTE_CURSOR_BLINK_OFF", "2"),
("(gint) VTE_CURSOR_BLINK_ON", "1"),
("(gint) VTE_CURSOR_BLINK_SYSTEM", "0"),
("(gint) VTE_CURSOR_SHAPE_BLOCK", "0"),
("(gint) VTE_CURSOR_SHAPE_IBEAM", "1"),
("(gint) VTE_CURSOR_SHAPE_UNDERLINE", "2"),
("(gint) VTE_ERASE_ASCII_BACKSPACE", "1"),
("(gint) VTE_ERASE_ASCII_DELETE", "2"),
("(gint) VTE_ERASE_AUTO", "0"),
("(gint) VTE_ERASE_DELETE_SEQUENCE", "3"),
("(gint) VTE_ERASE_TTY", "4"),
("(guint) VTE_FEATURE_FLAGS_MASK", "4294967295"),
("(guint) VTE_FEATURE_FLAG_BIDI", "1"),
("(guint) VTE_FEATURE_FLAG_ICU", "2"),
("(guint) VTE_FEATURE_FLAG_SIXEL", "8"),
("(guint) VTE_FEATURE_FLAG_SYSTEMD", "4"),
("(gint) VTE_FORMAT_HTML", "2"),
("(gint) VTE_FORMAT_TEXT", "1"),
("VTE_MAJOR_VERSION", "0"),
("VTE_MICRO_VERSION", "0"),
("VTE_MINOR_VERSION", "85"),
("(gint) VTE_PROGRESS_HINT_ACTIVE", "1"),
("(gint) VTE_PROGRESS_HINT_ERROR", "2"),
("(gint) VTE_PROGRESS_HINT_INACTIVE", "0"),
("(gint) VTE_PROGRESS_HINT_INDETERMINATE", "3"),
("(gint) VTE_PROGRESS_HINT_PAUSED", "4"),
("(gint) VTE_PROPERTY_BOOL", "1"),
("(gint) VTE_PROPERTY_DATA", "8"),
("(gint) VTE_PROPERTY_DOUBLE", "4"),
("(guint) VTE_PROPERTY_FLAG_EPHEMERAL", "1"),
("(guint) VTE_PROPERTY_FLAG_NONE", "0"),
("(gint) VTE_PROPERTY_ID_CONTAINER_NAME", "3"),
("(gint) VTE_PROPERTY_ID_CONTAINER_RUNTIME", "4"),
("(gint) VTE_PROPERTY_ID_CONTAINER_UID", "5"),
("(gint) VTE_PROPERTY_ID_CURRENT_DIRECTORY_URI", "0"),
("(gint) VTE_PROPERTY_ID_CURRENT_FILE_URI", "1"),
("(gint) VTE_PROPERTY_ID_ICON_COLOR", "11"),
("(gint) VTE_PROPERTY_ID_ICON_IMAGE", "12"),
("(gint) VTE_PROPERTY_ID_PROGRESS_HINT", "9"),
("(gint) VTE_PROPERTY_ID_PROGRESS_VALUE", "10"),
("(gint) VTE_PROPERTY_ID_SHELL_POSTEXEC", "8"),
("(gint) VTE_PROPERTY_ID_SHELL_PRECMD", "6"),
("(gint) VTE_PROPERTY_ID_SHELL_PREEXEC", "7"),
("(gint) VTE_PROPERTY_ID_XTERM_TITLE", "2"),
("(gint) VTE_PROPERTY_IMAGE", "11"),
("(gint) VTE_PROPERTY_INT", "2"),
("(gint) VTE_PROPERTY_RGB", "5"),
("(gint) VTE_PROPERTY_RGBA", "6"),
("(gint) VTE_PROPERTY_STRING", "7"),
("(gint) VTE_PROPERTY_UINT", "3"),
("(gint) VTE_PROPERTY_URI", "10"),
("(gint) VTE_PROPERTY_UUID", "9"),
("(gint) VTE_PROPERTY_VALUELESS", "0"),
("(guint) VTE_PTY_DEFAULT", "0"),
("(gint) VTE_PTY_ERROR_PTY98_FAILED", "1"),
("(gint) VTE_PTY_ERROR_PTY_HELPER_FAILED", "0"),
("(guint) VTE_PTY_NO_CTTY", "64"),
("(guint) VTE_PTY_NO_FALLBACK", "16"),
("(guint) VTE_PTY_NO_HELPER", "8"),
("(guint) VTE_PTY_NO_LASTLOG", "1"),
("(guint) VTE_PTY_NO_SESSION", "32"),
("(guint) VTE_PTY_NO_UTMP", "2"),
("(guint) VTE_PTY_NO_WTMP", "4"),
("(gint) VTE_REGEX_ERROR_INCOMPATIBLE", "2147483646"),
("(gint) VTE_REGEX_ERROR_NOT_SUPPORTED", "2147483647"),
("VTE_REGEX_FLAGS_DEFAULT", "1075314688"),
("VTE_SPAWN_NO_PARENT_ENVV", "33554432"),
("VTE_SPAWN_NO_SYSTEMD_SCOPE", "67108864"),
("VTE_SPAWN_REQUIRE_SYSTEMD_SCOPE", "134217728"),
("(gint) VTE_SYSTEMD_CONTEXT_EXIT_CONDITION_CRASH", "1"),
("(gint) VTE_SYSTEMD_CONTEXT_EXIT_CONDITION_FAILURE", "2"),
("(gint) VTE_SYSTEMD_CONTEXT_EXIT_CONDITION_INTERRUPT", "3"),
("(gint) VTE_SYSTEMD_CONTEXT_EXIT_CONDITION_SUCCESS", "0"),
("(gint) VTE_SYSTEMD_CONTEXT_OPERATION_END", "2"),
("(gint) VTE_SYSTEMD_CONTEXT_OPERATION_START", "1"),
("(gint) VTE_SYSTEMD_CONTEXT_TYPE_APP", "1"),
("(gint) VTE_SYSTEMD_CONTEXT_TYPE_BOOT", "2"),
("(gint) VTE_SYSTEMD_CONTEXT_TYPE_BUILTIN", "0"),
("(gint) VTE_SYSTEMD_CONTEXT_TYPE_CHPRIV", "3"),
("(gint) VTE_SYSTEMD_CONTEXT_TYPE_COMMAND", "4"),
("(gint) VTE_SYSTEMD_CONTEXT_TYPE_CONTAINER", "5"),
("(gint) VTE_SYSTEMD_CONTEXT_TYPE_ELEVATE", "6"),
("(gint) VTE_SYSTEMD_CONTEXT_TYPE_REMOTE", "7"),
("(gint) VTE_SYSTEMD_CONTEXT_TYPE_SERVICE", "8"),
("(gint) VTE_SYSTEMD_CONTEXT_TYPE_SESSION", "9"),
("(gint) VTE_SYSTEMD_CONTEXT_TYPE_SHELL", "10"),
("(gint) VTE_SYSTEMD_CONTEXT_TYPE_SUBCONTEXT", "11"),
("(gint) VTE_SYSTEMD_CONTEXT_TYPE_VM", "12"),
("VTE_SYSTEMD_PROPERTY_BOOT_ID", "bootid"),
("VTE_SYSTEMD_PROPERTY_COMM", "comm"),
("VTE_SYSTEMD_PROPERTY_COMMAND_LINE", "cmdline"),
("VTE_SYSTEMD_PROPERTY_CONTAINER", "container"),
("VTE_SYSTEMD_PROPERTY_CONTEXT_ID", "context-id"),
("VTE_SYSTEMD_PROPERTY_CONTEXT_TYPE", "type"),
("VTE_SYSTEMD_PROPERTY_CURRENT_DIRECTORY", "cwd"),
("VTE_SYSTEMD_PROPERTY_EXIT_CONDITION", "exit"),
("VTE_SYSTEMD_PROPERTY_EXIT_SIGNAL", "signal"),
("VTE_SYSTEMD_PROPERTY_EXIT_STATUS", "status"),
("VTE_SYSTEMD_PROPERTY_HOSTNAME", "hostname"),
("(gint) VTE_SYSTEMD_PROPERTY_ID_BOOT_ID", "1"),
("(gint) VTE_SYSTEMD_PROPERTY_ID_COMM", "2"),
("(gint) VTE_SYSTEMD_PROPERTY_ID_COMMAND_LINE", "3"),
("(gint) VTE_SYSTEMD_PROPERTY_ID_CONTAINER", "4"),
("(gint) VTE_SYSTEMD_PROPERTY_ID_CONTEXT_ID", "0"),
("(gint) VTE_SYSTEMD_PROPERTY_ID_CONTEXT_TYPE", "5"),
("(gint) VTE_SYSTEMD_PROPERTY_ID_CURRENT_DIRECTORY", "6"),
("(gint) VTE_SYSTEMD_PROPERTY_ID_EXIT_CONDITION", "7"),
("(gint) VTE_SYSTEMD_PROPERTY_ID_EXIT_SIGNAL", "8"),
("(gint) VTE_SYSTEMD_PROPERTY_ID_EXIT_STATUS", "9"),
("(gint) VTE_SYSTEMD_PROPERTY_ID_HOSTNAME", "10"),
("(gint) VTE_SYSTEMD_PROPERTY_ID_MACHINE_ID", "11"),
("(gint) VTE_SYSTEMD_PROPERTY_ID_PID", "12"),
("(gint) VTE_SYSTEMD_PROPERTY_ID_PIDFD_INODE", "13"),
("(gint) VTE_SYSTEMD_PROPERTY_ID_TARGET_HOST", "14"),
("(gint) VTE_SYSTEMD_PROPERTY_ID_TARGET_USER", "15"),
("(gint) VTE_SYSTEMD_PROPERTY_ID_USER", "16"),
("(gint) VTE_SYSTEMD_PROPERTY_ID_VM", "17"),
("VTE_SYSTEMD_PROPERTY_MACHINE_ID", "machineid"),
("VTE_SYSTEMD_PROPERTY_PID", "pid"),
("VTE_SYSTEMD_PROPERTY_PIDFD_INODE", "pidfdid"),
("VTE_SYSTEMD_PROPERTY_TARGET_HOST", "targethost"),
("VTE_SYSTEMD_PROPERTY_TARGET_USER", "targetuser"),
("VTE_SYSTEMD_PROPERTY_USER", "user"),
("VTE_SYSTEMD_PROPERTY_VM", "vm"),
("VTE_TERMPROP_CONTAINER_NAME", "vte.container.name"),
("VTE_TERMPROP_CONTAINER_RUNTIME", "vte.container.runtime"),
("VTE_TERMPROP_CONTAINER_UID", "vte.container.uid"),
("VTE_TERMPROP_CURRENT_DIRECTORY_URI", "vte.cwd"),
("VTE_TERMPROP_CURRENT_FILE_URI", "vte.cwf"),
("VTE_TERMPROP_ICON_COLOR", "vte.icon.color"),
("VTE_TERMPROP_ICON_IMAGE", "vte.icon.image"),
("VTE_TERMPROP_NAME_PREFIX", "vte.ext."),
("VTE_TERMPROP_PROGRESS_HINT", "vte.progress.hint"),
("VTE_TERMPROP_PROGRESS_VALUE", "vte.progress.value"),
("VTE_TERMPROP_SHELL_POSTEXEC", "vte.shell.postexec"),
("VTE_TERMPROP_SHELL_PRECMD", "vte.shell.precmd"),
("VTE_TERMPROP_SHELL_PREEXEC", "vte.shell.preexec"),
("VTE_TERMPROP_XTERM_TITLE", "xterm.title"),
("VTE_TEST_FLAGS_ALL", "18446744073709551615"),
("VTE_TEST_FLAGS_NONE", "0"),
("(gint) VTE_TEXT_BLINK_ALWAYS", "3"),
("(gint) VTE_TEXT_BLINK_FOCUSED", "1"),
("(gint) VTE_TEXT_BLINK_NEVER", "0"),
("(gint) VTE_TEXT_BLINK_UNFOCUSED", "2"),
("(guint) VTE_UUID_FORMAT_ANY", "7"),
("(guint) VTE_UUID_FORMAT_ANY_ID128", "15"),
("(guint) VTE_UUID_FORMAT_BRACED", "2"),
("(guint) VTE_UUID_FORMAT_ID128", "8"),
("(guint) VTE_UUID_FORMAT_SIMPLE", "1"),
("(guint) VTE_UUID_FORMAT_URN", "4"),
("(gint) VTE_WRITE_DEFAULT", "0"),
];