9632145075

Committed 23 Jun 2024 08:39AM UTC coverage: 85.512% (-1.5%) from 86.969%

Build # 9632145075

Build Type

push

github

Committed by

Ortham

Commit Message

Add esp_plugin_resolve_record_ids()

Also esp_get_plugins_metadata() and esp_plugins_metadata_free().

Run Details

2 of 49 new or added lines in 3 files covered. (4.08%)

103 existing lines in 2 files now uncovered.

3382 of 3955 relevant lines covered (85.51%)

33.32 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

32.76

/ffi/src/helpers.rs

use std::ffi::{CStr, CString};

use libc::{c_char, size_t};

use esplugin::GameId;

use crate::{constants::*, error::error};

pub unsafe fn to_str<'a>(c_string: *const c_char) -> Result<&'a str, u32> {
    if c_string.is_null() {
        return Err(error(ESP_ERROR_NULL_POINTER, "Null pointer passed"));
    }

    let rust_c_string = CStr::from_ptr(c_string);

    rust_c_string
        .to_str()
        .map_err(|_| error(ESP_ERROR_NOT_UTF8, "Non-UTF-8 string passed"))
}

pub fn to_c_string(string: &str) -> Result<*mut c_char, u32> {
    CString::new(string)
        .map(CString::into_raw)
        .map_err(|_| ESP_ERROR_TEXT_ENCODE_ERROR)
}

pub fn to_c_string_array(strings: &[String]) -> Result<(*mut *mut c_char, size_t), u32> {
    let mut c_strings = strings
        .iter()
        .map(|s| to_c_string(s))
        .collect::<Result<Vec<*mut c_char>, u32>>()?;

    c_strings.shrink_to_fit();

    let pointer = c_strings.as_mut_ptr();
    let size = c_strings.len();
    std::mem::forget(c_strings);

    Ok((pointer, size))
}

pub fn map_game_id(game_id: u32) -> Result<GameId, u32> {
    match game_id {
        x if x == ESP_GAME_OBLIVION => Ok(GameId::Oblivion),
        x if x == ESP_GAME_SKYRIM => Ok(GameId::Skyrim),
        x if x == ESP_GAME_FALLOUT3 => Ok(GameId::Fallout3),
        x if x == ESP_GAME_FALLOUTNV => Ok(GameId::FalloutNV),
        x if x == ESP_GAME_MORROWIND => Ok(GameId::Morrowind),
        x if x == ESP_GAME_FALLOUT4 => Ok(GameId::Fallout4),
        x if x == ESP_GAME_SKYRIMSE => Ok(GameId::SkyrimSE),
        x if x == ESP_GAME_STARFIELD => Ok(GameId::Starfield),
        _ => Err(error(
            ESP_ERROR_INVALID_GAME_ID,
            &format!("Invalid game ID: {}", game_id),
        )),
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn to_c_string_should_convert_a_string_containing_no_nul_chars() {
        let c_string = to_c_string("test without null").unwrap();
        let rust_c_string = unsafe { CStr::from_ptr(c_string) };

        assert_eq!(
            CString::new("test without null").unwrap().to_bytes(),
            rust_c_string.to_bytes()
        );
    }

    #[test]
    fn to_c_string_should_error_if_a_string_contains_nul_chars() {
        let err = to_c_string("test\0with null").unwrap_err();

        assert_eq!(ESP_ERROR_TEXT_ENCODE_ERROR, err);
    }
}

1	use std::ffi::{CStr, CString};
2
3	use libc::{c_char, size_t};
4
5	use esplugin::GameId;
6
7	use crate::{constants::*, error::error};
8
9	pub unsafe fn to_str<'a>(c_string: *const c_char) -> Result<&'a str, u32> {	×
10	if c_string.is_null() {	×
11	return Err(error(ESP_ERROR_NULL_POINTER, "Null pointer passed"));	×
12	}	×
13		×
14	let rust_c_string = CStr::from_ptr(c_string);	×
15		×
16	rust_c_string	×
17	.to_str()	×
18	.map_err(\|_\| error(ESP_ERROR_NOT_UTF8, "Non-UTF-8 string passed"))	×
19	}	×
20
21	pub fn to_c_string(string: &str) -> Result<*mut c_char, u32> {	2✔
22	CString::new(string)	2✔
23	.map(CString::into_raw)	2✔
24	.map_err(\|_\| ESP_ERROR_TEXT_ENCODE_ERROR)	2✔
25	}	2✔
26
UNCOV 27	pub fn to_c_string_array(strings: &[String]) -> Result<(mut mut c_char, size_t), u32> {	×
UNCOV 28	let mut c_strings = strings	×
UNCOV 29	.iter()	×
UNCOV 30	.map(\|s\| to_c_string(s))	×
UNCOV 31	.collect::<Result<Vec<*mut c_char>, u32>>()?;	×
32
UNCOV 33	c_strings.shrink_to_fit();	×
UNCOV 34		×
UNCOV 35	let pointer = c_strings.as_mut_ptr();	×
UNCOV 36	let size = c_strings.len();	×
UNCOV 37	std::mem::forget(c_strings);	×
UNCOV 38		×
39	Ok((pointer, size))	×
40	}	×
41
42	pub fn map_game_id(game_id: u32) -> Result<GameId, u32> {	×
43	match game_id {	×
44	x if x == ESP_GAME_OBLIVION => Ok(GameId::Oblivion),	×
45	x if x == ESP_GAME_SKYRIM => Ok(GameId::Skyrim),	×
46	x if x == ESP_GAME_FALLOUT3 => Ok(GameId::Fallout3),	×
47	x if x == ESP_GAME_FALLOUTNV => Ok(GameId::FalloutNV),	×
48	x if x == ESP_GAME_MORROWIND => Ok(GameId::Morrowind),	×
49	x if x == ESP_GAME_FALLOUT4 => Ok(GameId::Fallout4),	×
50	x if x == ESP_GAME_SKYRIMSE => Ok(GameId::SkyrimSE),	×
51	x if x == ESP_GAME_STARFIELD => Ok(GameId::Starfield),	×
52	_ => Err(error(	×
UNCOV 53	ESP_ERROR_INVALID_GAME_ID,	×
54	&format!("Invalid game ID: {}", game_id),	×
UNCOV 55	)),	×
56	}
UNCOV 57	}	×
58
59	#[cfg(test)]
60	mod tests {
61	use super::*;
62
63	#[test]
64	fn to_c_string_should_convert_a_string_containing_no_nul_chars() {	1✔
65	let c_string = to_c_string("test without null").unwrap();	1✔
66	let rust_c_string = unsafe { CStr::from_ptr(c_string) };	1✔
67		1✔
68	assert_eq!(	1✔
69	CString::new("test without null").unwrap().to_bytes(),	1✔
70	rust_c_string.to_bytes()	1✔
71	);	1✔
72	}	1✔
73
74	#[test]
75	fn to_c_string_should_error_if_a_string_contains_nul_chars() {	1✔
76	let err = to_c_string("test\0with null").unwrap_err();	1✔
77		1✔
78	assert_eq!(ESP_ERROR_TEXT_ENCODE_ERROR, err);	1✔
79	}	1✔
80	}

Ortham / esplugin / 9632145075

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous