feat: add functionality to handle the new argument name hints in the decompiler

Author: 0xdea

CHANGELOG.md

@@ -5,10 +5,11 @@ All notable changes to this project are documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [0.10.0] - 2026-07-27
+## [0.10.0] - TODO
 
 ### Added
 
+- Add functionality to handle the new argument name hints in the Hex-Rays decompiler.
 - Add an integration test to check naming and decompilation functionalities.
 
 ### Changed

CLAUDE.md

@@ -23,9 +23,6 @@ The build script (`build.rs`) checks common default locations as a fallback, but
 cargo build            # debug (debug info stripped for faster startup)
 cargo build --release  # optimized, LTO, stripped
 
-# Test (unit tests only, no IDA Pro required)
-cargo test --lib
-
 # Test (integration tests, custom harness, tests against ./tests/data/ls)
 cargo test
 cargo test --test tests -- --nocapture   # verbose
@@ -72,6 +69,6 @@ The crate-level documentation in `src/lib.rs` is assembled in a specific order t
 
 ## Tests
 
-**Unit tests** live in `src/lib.rs` under `#[cfg(test)] mod tests`. They do not require IDA Pro and run with `cargo test --lib`. Only executed in CI on Linux; macOS and Windows cannot run them because `dyld`/the Windows loader requires all linked dylibs (including `libida`) to be present at process startup, whereas Linux's lazy binding allows the test binary to start without resolving IDA symbols. They cover `prepare_output_dir` (create, empty-dir recreate, non-empty failure) and `sanitize_filename` (plain names, reserved-char replacement, truncation).
+**Unit tests** live in `src/lib.rs` under `#[cfg(test)] mod tests`. They cover `prepare_output_dir` (create, empty-dir recreate, non-empty failure) and `sanitize_filename` (plain names, reserved-char replacement, truncation).
 
 **Integration tests** live in `tests/main.rs` with `harness = false` (custom runner). They require IDA Pro to be available and `IDADIR` set. The test binary is `tests/data/ls` (x86-64 ELF). Tests validate function count, output file count, output directory behavior (non-empty dir error, empty-dir success), the `decompile_to_file` API, pseudocode content, a spot-check of a known output file (`sub_4AD0@4AD0.c`) to verify the naming scheme, and error-path behavior (read-only files, path length limits, invalid filenames).

Cargo.lock

@@ -29,6 +29,11 @@ thiserror = "2.0"
 [build-dependencies]
 idalib-build = "0.10"
 
+[patch.crates-io]
+idalib = { git = "https://github.com/0xdea/idalib", branch = "feature/hexrays-improvements" }
+idalib-build = { git = "https://github.com/0xdea/idalib", branch = "feature/hexrays-improvements" }
+idalib-sys = { git = "https://github.com/0xdea/idalib", branch = "feature/hexrays-improvements" }
+
 [[test]]
 name = "tests"
 path = "tests/main.rs"

Cargo.toml

@@ -36,6 +36,30 @@ pub enum HaruspexError {
     FileWriteFailed(#[from] io::Error),
 }
 
+/// Argument name hints mode for function calls in pseudocode.
+#[derive(Debug, Copy, Clone, PartialEq, Eq)]
+#[repr(u8)]
+#[non_exhaustive]
+pub enum ArgHintsMode {
+    /// Argument name hints are disabled.
+    Disabled = 0,
+    /// Argument names are displayed as comments (/*param=*/).
+    Comment,
+    /// Argument names are displayed as inlay hints (param:).
+    Inlay,
+}
+
+impl ArgHintsMode {
+    /// Returns the directive to use for setting the argument hints mode.
+    #[expect(
+        clippy::as_conversions,
+        reason = "argument hints mode is stored as a `u8`"
+    )]
+    fn directive(self) -> String {
+        format!("ARG_HINTS_MODE = {}", self as u8)
+    }
+}
+
 /// Extracts pseudocode of functions in the binary file at `filepath` and saves it in `filepath.dec`.
 ///
 /// Returns how many functions were decompiled.
@@ -91,7 +115,7 @@ pub fn run(filepath: impl AsRef<Path>) -> anyhow::Result<usize> {
             clippy::arithmetic_side_effects,
             reason = "`usize` can hardly overflow here"
         )]
-        match decompile_to_file(&idb, &f, &output_path) {
+        match decompile_to_file(&idb, &f, &output_path, ArgHintsMode::Disabled) {
             // Print the output path in case of successful function decompilation.
             Ok(()) => {
                 println!("{func_name} -> `{}`", output_path.display());
@@ -152,7 +176,7 @@ pub fn run(filepath: impl AsRef<Path>) -> anyhow::Result<usize> {
 ///     .find(|(_, f)| f.name().unwrap() == "main")
 ///     .unwrap();
 ///
-/// haruspex::decompile_to_file(&idb, &func, &output_file)?;
+/// haruspex::decompile_to_file(&idb, &func, &output_file, haruspex::ArgHintsMode::Disabled)?;
 /// # std::fs::remove_file(output_file)?;
 /// # Ok::<(), anyhow::Error>(())
 /// ```
@@ -161,7 +185,11 @@ pub fn decompile_to_file(
     idb: &IDB,
     func: &Function,
     filepath: impl AsRef<Path>,
+    hints_mode: ArgHintsMode,
 ) -> Result<(), HaruspexError> {
+    // Set argument name hints mode.
+    idb.change_hexrays_config(hints_mode.directive())?;
+
     // Decompile function.
     let decomp = idb.decompile(func)?;
     let source = decomp.pseudocode();

src/lib.rs

@@ -3,7 +3,7 @@
 use std::fs;
 use std::path::Path;
 
-use haruspex::HaruspexError;
+use haruspex::{ArgHintsMode, HaruspexError};
 use idalib::idb::IDB;
 
 /// Custom harness for integration tests.
@@ -82,7 +82,7 @@ fn main() -> anyhow::Result<()> {
         .find(|f| f.1.name().expect("invalid function name") == "main")
         .expect("failed to find function `main`");
     let output_file = dirpath.join("main.c");
-    haruspex::decompile_to_file(&idb, &func, &output_file)?;
+    haruspex::decompile_to_file(&idb, &func, &output_file, ArgHintsMode::Disabled)?;
     assert!(
         output_file.metadata()?.len() > 0,
         "output file `{}` is empty",
@@ -120,7 +120,7 @@ fn main() -> anyhow::Result<()> {
     let mut perms = output_file.metadata()?.permissions();
     perms.set_readonly(true);
     fs::set_permissions(&output_file, perms)?;
-    let result = haruspex::decompile_to_file(&idb, &func, &output_file);
+    let result = haruspex::decompile_to_file(&idb, &func, &output_file, ArgHintsMode::Disabled);
     assert!(result.is_err(), "file write succeeded unexpectedly");
     assert!(
         matches!(result, Err(HaruspexError::FileWriteFailed(_))),
@@ -136,7 +136,7 @@ fn main() -> anyhow::Result<()> {
     // Check `decompile_to_file` handles file length limitations.
     print!("[*] Checking `decompile_to_file` handles file length limitations... ");
     let output_file = dirpath.join("A".repeat(2048));
-    let result = haruspex::decompile_to_file(&idb, &func, &output_file);
+    let result = haruspex::decompile_to_file(&idb, &func, &output_file, ArgHintsMode::Disabled);
     assert!(result.is_err(), "file write succeeded unexpectedly");
     assert!(
         matches!(result, Err(HaruspexError::FileWriteFailed(_))),
@@ -150,7 +150,7 @@ fn main() -> anyhow::Result<()> {
     let output_file = dirpath.join("invalid/filename");
     #[cfg(windows)]
     let output_file = dirpath.join("invalid<>?*filename");
-    let result = haruspex::decompile_to_file(&idb, &func, &output_file);
+    let result = haruspex::decompile_to_file(&idb, &func, &output_file, ArgHintsMode::Disabled);
     assert!(result.is_err(), "file write succeeded unexpectedly");
     assert!(
         matches!(result, Err(HaruspexError::FileWriteFailed(_))),