retour-utils-impl is a procedural macro. It will run at compile time and transform your program's source code.

Adding `retour-utils-impl` macro(s) as a dependency

Run this command in a terminal, in your project's directory:

cargo add retour-utils-impl

To add it manually, edit your project's Cargo.toml file and add to the [dependencies] section:

retour-utils-impl = "0.2.0"

You may need to import the macro(s) with use retour_utils_impl::*.

Read the retour_utils_impl documentation.

Back to the crate overview.

Readme

retour-utils

This crate is meant to help creating detours with the retour crate. If you're creating lots of detours, it's very repetitive, so this crate adds some a few helper functions and macro to greatly simplify/streamline the process. It works on both Unix and Windows.

Example

use retour_utils::hook_module;

#[hook_module("lua52.dll")]
mod lua {
    // #[hook_module] will create this
    // const MODULE_NAME: &str = "lua52.dll"
    // and
    // pub unsafe init_detours() -> crate::Result<()> {..}
    // which will initialize all the StaticDetours generated by the macro inside this module

    #[allow(non_camel_case_types)]
    type lua_State = ();
    #[allow(non_camel_case_types)]
    type lua_Alloc = ();
    
    // Creates a StaticDetour called Lua_newstate with the same function type as our function 
    // (minus abi/unsafe to work with retour crate)
    #[hook(unsafe extern "C" Lua_newstate, symbol = "Lua_newstate")]
    pub fn newstate(f: *mut lua_Alloc, ud: *mut std::ffi::c_void) -> *mut lua_State {
        unsafe {
            Lua_newstate.call(f, ud)
        }
    }
    // More lua hooks
}


// #[hook_module] creates a `init_hooks` function that initializes and enables all the hooks
lua::init_hooks().unwrap()

This is very much in the early stages, with some noticable rough areas

No docs yet
Naming of macros and fns likely to change for consistency/clarity

Adding retour-utils-impl macro(s) as a dependency

Adding `retour-utils-impl` macro(s) as a dependency