hwnd 0.0.0-2024-01-05

Well documented, safe-leaning, sound, low-level API bindings to `HWND`-adjacent APIs
Documentation 
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

use crate::*;
use bytemuck::*;
use std::fmt::{self, Debug, Formatter};
use std::ptr::*;



pub type WndProcNonNull = unsafe extern "system" fn (hwnd: HWnd, msg: WM32, wparam: WPARAM, lparam: LPARAM) -> LRESULT;
pub type WndProc        = Option<WndProcNonNull>;

/// \[[learn.microsoft.com](https://learn.microsoft.com/en-us/windows/win32/api/winuser/ns-winuser-wndclassa)\]
/// WNDCLASSA
///
/// ### See Also
/// *   [register_class_a]
/// *   [About Window Classes](https://learn.microsoft.com/en-us/windows/win32/winmsg/about-window-classes)
#[derive(Clone, Copy)]
#[repr(C)] pub struct WndClassA<'a> {
    pub style:      WindowStyle,
    pub wnd_proc:   WndProc,
    pub cls_extra:  i32,
    pub wnd_extra:  i32,
    pub hinstance:  HInstance<'static>,
    pub hicon:      HIcon<'static>,
    pub hcursor:    HCursor<'static>,
    pub background: HBRUSH,     // TODO: lifetime bound handle?
    pub menu_name:  Option<abistr::CStrNonNull<'a>>, // TODO: OrAtom types?
    pub class_name: Option<abistr::CStrNonNull<'a>>, // TODO: OrAtom types?
}

/// \[[learn.microsoft.com](https://learn.microsoft.com/en-us/windows/win32/api/winuser/ns-winuser-wndclassw)\]
/// WNDCLASSW
///
/// ### See Also
/// *   [register_class_w]
/// *   [About Window Classes](https://learn.microsoft.com/en-us/windows/win32/winmsg/about-window-classes)
#[derive(Clone, Copy)]
#[repr(C)] pub struct WndClassW<'a> {
    pub style:      WindowStyle,
    pub wnd_proc:   WndProc,
    pub cls_extra:  i32,
    pub wnd_extra:  i32,
    pub hinstance:  HInstance<'static>,
    pub hicon:      HIcon<'static>,
    pub hcursor:    HCursor<'static>,
    pub background: HBRUSH,     // TODO: lifetime bound handle?
    pub menu_name:  Option<abistr::CStrNonNull<'a, u16>>, // TODO: OrAtom types?
    pub class_name: Option<abistr::CStrNonNull<'a, u16>>, // TODO: OrAtom types?
}

/// \[[learn.microsoft.com](https://learn.microsoft.com/en-us/windows/win32/api/winuser/ns-winuser-wndclassexa)\]
/// WNDCLASSEXA
///
/// ### See Also
/// *   [register_class_ex_a]
/// *   [About Window Classes](https://learn.microsoft.com/en-us/windows/win32/winmsg/about-window-classes)
#[derive(Clone, Copy)]
#[repr(C)] pub struct WndClassExA<'a> {
    pub size:       u32,
    pub style:      WindowStyle,
    pub wnd_proc:   WndProc,
    pub cls_extra:  i32,
    pub wnd_extra:  i32,
    pub hinstance:  HInstance<'static>,
    pub hicon:      HIcon<'static>,
    pub hcursor:    HCursor<'static>,
    pub background: HBRUSH,     // TODO: lifetime bound handle?
    pub menu_name:  Option<abistr::CStrNonNull<'a>>, // TODO: OrAtom types?
    pub class_name: Option<abistr::CStrNonNull<'a>>, // TODO: OrAtom types?
    pub hicon_sm:   HIcon<'static>,
}

/// \[[learn.microsoft.com](https://learn.microsoft.com/en-us/windows/win32/api/winuser/ns-winuser-wndclassexw)\]
/// WNDCLASSEXW
///
/// ### See Also
/// *   [register_class_ex_w]
/// *   [About Window Classes](https://learn.microsoft.com/en-us/windows/win32/winmsg/about-window-classes)
#[derive(Clone, Copy)]
#[repr(C)] pub struct WndClassExW<'a> {
    pub size:       u32,
    pub style:      WindowStyle,
    pub wnd_proc:   WndProc,
    pub cls_extra:  i32,
    pub wnd_extra:  i32,
    pub hinstance:  HInstance<'static>,
    pub hicon:      HIcon<'static>,
    pub hcursor:    HCursor<'static>,
    pub background: HBRUSH,     // TODO: lifetime bound handle?
    pub menu_name:  Option<abistr::CStrNonNull<'a, u16>>, // TODO: OrAtom types?
    pub class_name: Option<abistr::CStrNonNull<'a, u16>>, // TODO: OrAtom types?
    pub hicon_sm:   HIcon<'static>,
}

unsafe impl Zeroable for WndClassA<'_> {} // wnd_proc
unsafe impl Zeroable for WndClassW<'_> {} // wnd_proc
unsafe impl Zeroable for WndClassExA<'_> {} // wnd_proc
unsafe impl Zeroable for WndClassExW<'_> {} // wnd_proc

impl Default for WndClassA<'_>   { fn default() -> Self { Self::zeroed() } }
impl Default for WndClassW<'_>   { fn default() -> Self { Self::zeroed() } }
impl Default for WndClassExA<'_> { fn default() -> Self { Self { size: size_of_32::<Self>(), ..Self::zeroed() } } }
impl Default for WndClassExW<'_> { fn default() -> Self { Self { size: size_of_32::<Self>(), ..Self::zeroed() } } }

impl Debug for WndClassA<'_> {
    fn fmt(&self, fmt: &mut Formatter) -> fmt::Result {
        fmt.debug_struct("WndClassA")
            .field("style",         &self.style         )
            .field("wnd_proc",      &self.wnd_proc.map_or(null::<()>(), |f| unsafe { std::mem::transmute(f) }))
            .field("cls_extra",     &self.cls_extra     )
            .field("wnd_extra",     &self.wnd_extra     )
            .field("hinstance",     &self.hinstance     )
            .field("hicon",         &self.hicon         )
            .field("hcursor",       &self.hcursor       )
            .field("background",    &self.background    )
            .field("menu_name",     &self.menu_name     )
            .field("class_name",    &self.class_name    )
            .finish()
    }
}

impl Debug for WndClassW<'_> {
    fn fmt(&self, fmt: &mut Formatter) -> fmt::Result {
        fmt.debug_struct("WndClassW")
            .field("style",         &self.style         )
            .field("wnd_proc",      &self.wnd_proc.map_or(null::<()>(), |f| unsafe { std::mem::transmute(f) }))
            .field("cls_extra",     &self.cls_extra     )
            .field("wnd_extra",     &self.wnd_extra     )
            .field("hinstance",     &self.hinstance     )
            .field("hicon",         &self.hicon         )
            .field("hcursor",       &self.hcursor       )
            .field("background",    &self.background    )
            .field("menu_name",     &self.menu_name     )
            .field("class_name",    &self.class_name    )
            .finish()
    }
}

impl Debug for WndClassExA<'_> {
    fn fmt(&self, fmt: &mut Formatter) -> fmt::Result {
        fmt.debug_struct("WndClassExA")
            .field("size",          &self.size          )
            .field("style",         &self.style         )
            .field("wnd_proc",      &self.wnd_proc.map_or(null::<()>(), |f| unsafe { std::mem::transmute(f) }))
            .field("cls_extra",     &self.cls_extra     )
            .field("wnd_extra",     &self.wnd_extra     )
            .field("hinstance",     &self.hinstance     )
            .field("hicon",         &self.hicon         )
            .field("hcursor",       &self.hcursor       )
            .field("background",    &self.background    )
            .field("menu_name",     &self.menu_name     )
            .field("class_name",    &self.class_name    )
            .field("hicon_sm",      &self.hicon_sm      )
            .finish()
    }
}

impl Debug for WndClassExW<'_> {
    fn fmt(&self, fmt: &mut Formatter) -> fmt::Result {
        fmt.debug_struct("WndClassExW")
            .field("size",          &self.size          )
            .field("style",         &self.style         )
            .field("wnd_proc",      &self.wnd_proc.map_or(null::<()>(), |f| unsafe { std::mem::transmute(f) }))
            .field("cls_extra",     &self.cls_extra     )
            .field("wnd_extra",     &self.wnd_extra     )
            .field("hinstance",     &self.hinstance     )
            .field("hicon",         &self.hicon         )
            .field("hcursor",       &self.hcursor       )
            .field("background",    &self.background    )
            .field("menu_name",     &self.menu_name     )
            .field("class_name",    &self.class_name    )
            .field("hicon_sm",      &self.hicon_sm      )
            .finish()
    }
}

convert! {
    WndClassA<'_>   => unsafe { winapi::um::winuser::WNDCLASSA },
    WndClassW<'_>   => unsafe { winapi::um::winuser::WNDCLASSW },
    WndClassExA<'_> => unsafe { winapi::um::winuser::WNDCLASSEXA },
    WndClassExW<'_> => unsafe { winapi::um::winuser::WNDCLASSEXW },
}