1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
#![allow(non_camel_case_types, non_snake_case)]

use crate::kernel::decl::{GetLastError, HINSTANCE, IdStr, SysResult, WString};
use crate::kernel::privs::ptr_to_sysresult_handle;
use crate::prelude::Handle;
use crate::user;
use crate::user::decl::{
	ATOM, DLGPROC, HACCEL, HMENU, HWND, IdIdcStr, IdIdiStr, WNDCLASSEX,
};
use crate::user::guard::{DestroyCursorGuard, DestroyIconGuard};

impl user_Hinstance for HINSTANCE {}

/// This trait is enabled with the `user` feature, and provides methods for
/// [`HINSTANCE`](crate::HINSTANCE).
///
/// Prefer importing this trait through the prelude:
///
/// ```rust,no_run
/// use winsafe::prelude::*;
/// ```
pub trait user_Hinstance: Handle {
	/// [`CreateDialogParam`](https://learn.microsoft.com/en-us/windows/win32/api/winuser/nf-winuser-createdialogparamw)
	/// method.
	///
	/// # Safety
	///
	/// To create a dialog, you must provide a dialog procedure.
	unsafe fn CreateDialogParam(&self,
		resource_id: IdStr,
		hwnd_parent: Option<&HWND>,
		dialog_proc: DLGPROC,
		init_param: Option<isize>,
	) -> SysResult<HWND>
	{
		ptr_to_sysresult_handle(
			unsafe {
				user::ffi::CreateDialogParamW(
					self.ptr(),
					resource_id.as_ptr(),
					hwnd_parent.map_or(std::ptr::null_mut(), |h| h.ptr()),
					dialog_proc as _,
					init_param.unwrap_or_default(),
				)
			},
		)
	}

	/// [`DialogBoxParam`](https://learn.microsoft.com/en-us/windows/win32/api/winuser/nf-winuser-dialogboxparamw)
	/// method.
	///
	/// # Safety
	///
	/// To create a dialog, you must provide a dialog procedure.
	unsafe fn DialogBoxParam(&self,
		resource_id: IdStr,
		hwnd_parent: Option<&HWND>,
		dialog_proc: DLGPROC,
		init_param: Option<isize>,
	) -> SysResult<isize>
	{
		match unsafe {
			user::ffi::DialogBoxParamW(
				self.ptr(),
				resource_id.as_ptr(),
				hwnd_parent.map_or(std::ptr::null_mut(), |h| h.ptr()),
				dialog_proc as _,
				init_param.unwrap_or_default(),
			)
		} {
			-1 => Err(GetLastError()),
			res => Ok(res), // assumes hWndParent as valid, so no check for zero
		}
	}

	/// [`GetClassInfoEx`](https://learn.microsoft.com/en-us/windows/win32/api/winuser/nf-winuser-getclassinfoexw)
	/// method.
	///
	/// # Examples
	///
	/// Retrieving information of a window class created in our application:
	///
	/// ```rust,no_run
	/// use winsafe::prelude::*;
	/// use winsafe::{HINSTANCE, WNDCLASSEX};
	///
	/// let mut wcx = WNDCLASSEX::default();
	/// HINSTANCE::GetModuleHandle(None)?
	///     .GetClassInfoEx("SOME_CLASS_NAME", &mut wcx)?;
	/// # Ok::<_, winsafe::co::ERROR>(())
	/// ```
	fn GetClassInfoEx(&self,
		class_name: &str, wcx: &mut WNDCLASSEX) -> SysResult<ATOM>
	{
		match unsafe {
			user::ffi::GetClassInfoExW(
				self.ptr(),
				WString::from_str(class_name).as_ptr(),
				wcx as *mut _ as _,
			)
		} {
			0 => Err(GetLastError()),
			atom => Ok(unsafe { ATOM::from_raw(atom as _) }),
		}
	}

	/// [`LoadAccelerators`](https://learn.microsoft.com/en-us/windows/win32/api/winuser/nf-winuser-loadacceleratorsw)
	/// method.
	#[must_use]
	fn LoadAccelerators(&self, table_name: IdStr) -> SysResult<HACCEL> {
		ptr_to_sysresult_handle(
			unsafe {
				user::ffi::LoadAcceleratorsW(self.ptr(), table_name.as_ptr())
			},
		)
	}

	/// [`LoadCursor`](https://learn.microsoft.com/en-us/windows/win32/api/winuser/nf-winuser-loadcursorw)
	/// method.
	///
	/// # Examples
	///
	/// Loading a system cursor:
	///
	/// ```rust,no_run
	/// use winsafe::prelude::*;
	/// use winsafe::{co, HINSTANCE, IdIdcStr};
	///
	/// let sys_cursor = HINSTANCE::NULL
	///     .LoadCursor(IdIdcStr::Idc(co::IDC::ARROW))?;
	/// # Ok::<_, co::ERROR>(())
	/// ```
	#[must_use]
	fn LoadCursor(&self,
		resource_id: IdIdcStr) -> SysResult<DestroyCursorGuard>
	{
		unsafe {
			ptr_to_sysresult_handle(
				user::ffi::LoadCursorW(self.ptr(), resource_id.as_ptr()),
			).map(|h| DestroyCursorGuard::new(h))
		}
	}

	/// [`LoadIcon`](https://learn.microsoft.com/en-us/windows/win32/api/winuser/nf-winuser-loadiconw)
	/// method.
	///
	/// # Examples
	///
	/// Loading a system icon:
	///
	/// ```rust,no_run
	/// use winsafe::prelude::*;
	/// use winsafe::{co, IdIdiStr, HINSTANCE};
	///
	/// let sys_icon = HINSTANCE::NULL
	///     .LoadIcon(IdIdiStr::Idi(co::IDI::INFORMATION))?;
	/// # Ok::<_, co::ERROR>(())
	/// ```
	#[must_use]
	fn LoadIcon(&self, icon_id: IdIdiStr) -> SysResult<DestroyIconGuard> {
		unsafe {
			ptr_to_sysresult_handle(
				user::ffi::LoadIconW(self.ptr(), icon_id.as_ptr()),
			).map(|h| DestroyIconGuard::new(h))
		}
	}

	/// [`LoadMenu`](https://learn.microsoft.com/en-us/windows/win32/api/winuser/nf-winuser-loadmenuw)
	/// method.
	#[must_use]
	fn LoadMenu(&self, resource_id: IdStr) -> SysResult<HMENU> {
		ptr_to_sysresult_handle(
			unsafe { user::ffi::LoadMenuW(self.ptr(), resource_id.as_ptr()) },
		)
	}

	/// [`LoadString`](https://learn.microsoft.com/en-us/windows/win32/api/winuser/nf-winuser-loadstringw)
	/// method.
	#[must_use]
	fn LoadString(&self, id: u16) -> SysResult<String> {
		let mut pdata: *const u16 = std::ptr::null_mut();
		match unsafe {
			user::ffi::LoadStringW(
				self.ptr(),
				id as _,
				&mut pdata as *mut _ as  _, 0,
			)
		} {
			0 => Err(GetLastError()),
			len => Ok(WString::from_wchars_count(pdata, len as _).to_string())
		}
	}
}