firehazard 0.0.0-2022-09-10

use crate::*;
use crate::debug::DebugEvent;

use abistr::AsCStr;

use winapi::shared::minwindef::FALSE;
use winapi::um::debugapi::*;
use winapi::um::winbase::INFINITE;

use core::time::Duration;



/// \[[docs.microsoft.com](https://docs.microsoft.com/en-us/windows/win32/api/debugapi/nf-debugapi-checkremotedebuggerpresent)\]
/// CheckRemoteDebuggerPresent
///
/// ### Example
/// ```
/// # use firehazard::*;
/// let a = is_debugger_present();
/// let b = check_remote_debugger_present(get_current_process()).unwrap();
/// assert_eq!(a, b);
/// ```
pub fn check_remote_debugger_present<'a>(process: impl AsRef<process::PsuedoHandle<'a>>) -> Result<bool, Error> {
    let mut result = 0;
    Error::get_last_if(FALSE == unsafe { CheckRemoteDebuggerPresent(process.as_ref().as_handle(), &mut result) })?;
    Ok(result != FALSE)
}

/// \[[docs.microsoft.com](https://docs.microsoft.com/en-us/windows/win32/api/debugapi/nf-debugapi-continuedebugevent)\]
/// ContinueDebugEvent
pub fn continue_debug_event(process_id: process::Id, thread_id: thread::Id, continue_status: u32) -> Result<(), Error> {
    Error::get_last_if(FALSE == unsafe { ContinueDebugEvent(process_id, thread_id, continue_status) })
}

/// \[[docs.microsoft.com](https://docs.microsoft.com/en-us/windows/win32/api/debugapi/nf-debugapi-debugactiveprocess)\]
/// DebugActiveProcess
///
/// ### Example
/// ```
/// # use firehazard::*;
/// # return;
/// # let pid = 0;
/// # #[cfg(nope)]
/// let pid = ..;
/// debug_active_process(pid).unwrap();
/// ```
pub fn debug_active_process(process_id: process::Id) -> Result<(), Error> {
    Error::get_last_if(FALSE == unsafe { DebugActiveProcess(process_id) })
}

/// \[[docs.microsoft.com](https://docs.microsoft.com/en-us/windows/win32/api/debugapi/nf-debugapi-debugactiveprocessstop)\]
/// DebugActiveProcessStop
///
/// ### Example
/// ```
/// # use firehazard::*;
/// # return;
/// # let pid = 0;
/// # #[cfg(nope)]
/// let pid = ..;
/// debug_active_process(pid).expect("start debugging self");
/// debug_active_process_stop(pid).expect("stop debugging self");
/// ```
pub fn debug_active_process_stop(process_id: process::Id) -> Result<(), Error> {
    Error::get_last_if(FALSE == unsafe { DebugActiveProcessStop(process_id) })
}

/// \[[docs.microsoft.com](https://docs.microsoft.com/en-us/windows/win32/api/debugapi/nf-debugapi-debugbreak)\]
/// DebugBreak
///
/// ### Example
/// ```
/// # use firehazard::*;
/// # return;
/// eprintln!("BUG: something bad happened");
/// debug_break(); // trigegr the debugger
/// ```
pub fn debug_break() {
    unsafe { DebugBreak() }
}

/// \[[docs.microsoft.com](https://docs.microsoft.com/en-us/windows/win32/api/debugapi/nf-debugapi-isdebuggerpresent)\]
/// IsDebuggerPresent
///
/// ### Example
/// ```
/// # use firehazard::*;
/// if is_debugger_present() { println!("Hello, debugger!"); }
/// ```
pub fn is_debugger_present() -> bool {
    FALSE != unsafe { IsDebuggerPresent() }
}

/// \[[docs.microsoft.com](https://docs.microsoft.com/en-us/windows/win32/api/debugapi/nf-debugapi-outputdebugstringa)\]
/// OutputDebugStringA
///
/// ### Example
/// ```
/// # use firehazard::*;
/// # use abistr::*;
/// output_debug_string_a(cstr!("Hello, debugger!"));
/// ```
pub fn output_debug_string_a(output_string: impl AsCStr) {
    unsafe { OutputDebugStringA(output_string.as_cstr()) }
}

/// \[[docs.microsoft.com](https://docs.microsoft.com/en-us/windows/win32/api/debugapi/nf-debugapi-outputdebugstringw)\]
/// OutputDebugStringW
///
/// ### Example
/// ```
/// # use firehazard::*;
/// # use abistr::*;
/// output_debug_string_w(cstr16!("Hello, debugger!"));
/// ```
pub fn output_debug_string_w(output_string: impl AsCStr<u16>) {
    unsafe { OutputDebugStringW(output_string.as_cstr()) }
}

/// \[[docs.microsoft.com](https://docs.microsoft.com/en-us/windows/win32/api/debugapi/nf-debugapi-waitfordebugevent)\]
/// WaitForDebugEvent
pub fn wait_for_debug_event(timeout: impl Into<Option<Duration>>) -> Result<DebugEvent, Error> {
    let timeout_ms = timeout.into().map_or(INFINITE, |d| u32::try_from(d.as_millis()).unwrap_or(INFINITE).max(INFINITE-1));
    let mut de = Default::default();
    Error::get_last_if(FALSE == unsafe { WaitForDebugEvent(&mut de, timeout_ms) })?;
    Ok(unsafe { DebugEvent::from_raw(de) })
}

/// \[[docs.microsoft.com](https://docs.microsoft.com/en-us/windows/win32/api/debugapi/nf-debugapi-waitfordebugeventex)\]
/// WaitForDebugEventEx
pub fn wait_for_debug_event_ex(timeout: impl Into<Option<Duration>>) -> Result<DebugEvent, Error> {
    let timeout_ms = timeout.into().map_or(INFINITE, |d| u32::try_from(d.as_millis()).unwrap_or(INFINITE).max(INFINITE-1));
    let mut de = Default::default();
    Error::get_last_if(FALSE == unsafe { WaitForDebugEventEx(&mut de, timeout_ms) })?;
    Ok(unsafe { DebugEvent::from_raw(de) })
}