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

macro_rules! fn_context     { ( $cpp:path => $rust:path ) => {} }
macro_rules! fn_succeeded   { ( $expr:expr ) => { if false == abibool::b32::from($expr) { Err($crate::Error::new_gle()) } else { Ok(()) } }}
macro_rules! fn_err         { (               $error:expr ) => { Err($crate::Error(($error).into())) } }
macro_rules! fn_error       { (               $error:expr ) => {     $crate::Error(($error).into())  } }
macro_rules! fn_param_error { ( $_param:expr, $error:expr ) => {     $crate::Error(($error).into())  } }
macro_rules! fn_error_gle   { (                           ) => {     $crate::Error::new_gle()        } }
macro_rules! fn_error_gle_nz{ (                           ) => {     $crate::Error::new_gle_nz()     } }

macro_rules! mods {
    ( $( #[$attr:meta] )* inl      mod $mod:ident ;                $($tt:tt)* ) => { $(#[$attr])*      mod $mod;                       #[allow(unused_imports)] pub use $mod::*; mods!{ $($tt)* } };
    ( $( #[$attr:meta] )* inl      mod $mod:ident { $($body:tt)* } $($tt:tt)* ) => { $(#[$attr])*      mod $mod { mods!{ $($body)* } } #[allow(unused_imports)] pub use $mod::*; mods!{ $($tt)* } };
    ( $( #[$attr:meta] )* $vis:vis mod $mod:ident ;                $($tt:tt)* ) => { $(#[$attr])* $vis mod $mod;                                                                 mods!{ $($tt)* } };
    ( $( #[$attr:meta] )* $vis:vis mod $mod:ident { $($body:tt)* } $($tt:tt)* ) => { $(#[$attr])* $vis mod $mod { mods!{ $($body)* } }                                           mods!{ $($tt)* } };
    () => {};
}

/// ### Usage
/// ```no_compile
/// convert!(Rect <=> unsafe { winapi::shared::windef::RECT, winapi::shared::windef::RECTL, winapi::shared::d3d9types::D3DRECT });
/// ```
macro_rules! convert {
    ( $( $self:ident <=> unsafe { $($path:path),+ $(,)? } ),* $(,)? ) => {
        $(
            impl AsRef<$self> for $self { fn as_ref(&    self) -> &    $self { self } }
            impl AsMut<$self> for $self { fn as_mut(&mut self) -> &mut $self { self } }

            $(
                impl From< $path> for $self { fn from(r: $path) -> Self { unsafe { std::mem::transmute(r) } } }
                impl From< $self> for $path { fn from(r: $self) -> Self { unsafe { std::mem::transmute(r) } } }
                impl AsRef<$path> for $self { fn as_ref(&    self) -> &    $path { unsafe { std::mem::transmute(self) } } }
                impl AsRef<$self> for $path { fn as_ref(&    self) -> &    $self { unsafe { std::mem::transmute(self) } } }
                impl AsMut<$path> for $self { fn as_mut(&mut self) -> &mut $path { unsafe { std::mem::transmute(self) } } }
                impl AsMut<$self> for $path { fn as_mut(&mut self) -> &mut $self { unsafe { std::mem::transmute(self) } } }
            )*
        )*

        #[test] fn layout() {
            use std::mem::*;
            $($(
            assert_eq!(size_of ::<$self>(), size_of ::<$path>());
            assert_eq!(align_of::<$self>(), align_of::<$path>());
            )*)*
        }
    };
    ( $( $self:ident => unsafe { $($path:path),+ $(,)? } ),* $(,)? ) => {
        $(
            impl AsRef<$self> for $self { fn as_ref(&    self) -> &    $self { self } }
            impl AsMut<$self> for $self { fn as_mut(&mut self) -> &mut $self { self } }

            $(
                impl From<$self> for $path { fn from(r: $self) -> Self { unsafe { std::mem::transmute(r) } } }
                impl AsRef<$path> for $self { fn as_ref(&self) -> &$path { unsafe { std::mem::transmute(self) } } }
            )*
        )*

        #[test] fn layout() {
            use std::mem::*;
            $($(
            assert_eq!(size_of ::<$self>(), size_of ::<$path>(), "size_of {}", stringify!($path));
            assert_eq!(align_of::<$self>(), align_of::<$path>(), "align_of {}", stringify!($path));
            )*)*
        }
    };
    ( $( $self:ident<'_> => unsafe { $($path:path),+ $(,)? } ),* $(,)? ) => {
        $(
            //impl AsRef<$self<'_>> for $self<'_> { fn as_ref(&    self) -> &    $self { self } }
            //impl AsMut<$self<'_>> for $self<'_> { fn as_mut(&mut self) -> &mut $self { self } }

            $(
                impl From<$self<'_>> for $path { fn from(r: $self) -> Self { unsafe { std::mem::transmute(r) } } }
                impl AsRef<$path> for $self<'_> { fn as_ref(&self) -> &$path { unsafe { std::mem::transmute(self) } } }
            )*
        )*

        #[test] fn layout() {
            use std::mem::*;
            $($(
            assert_eq!(size_of ::<$self>(), size_of ::<$path>(), "size_of {}", stringify!($path));
            assert_eq!(align_of::<$self>(), align_of::<$path>(), "align_of {}", stringify!($path));
            )*)*
        }
    };
}

macro_rules! impl_ops_for_flag {( $flag:ty ) => {
    impl std::ops::Not              for $flag { type Output = $flag; fn not(self) -> Self { Self(!self.0) } }

    impl std::ops::BitOr            for $flag { type Output = $flag; fn bitor (self, other: Self) -> Self { Self(self.0 | other.0) } }
    impl std::ops::BitAnd           for $flag { type Output = $flag; fn bitand(self, other: Self) -> Self { Self(self.0 & other.0) } }
    impl std::ops::BitXor           for $flag { type Output = $flag; fn bitxor(self, other: Self) -> Self { Self(self.0 ^ other.0) } }

    impl std::ops::BitOrAssign      for $flag { fn bitor_assign (&mut self, other: Self) { self.0 |= other.0 } }
    impl std::ops::BitAndAssign     for $flag { fn bitand_assign(&mut self, other: Self) { self.0 &= other.0 } }
    impl std::ops::BitXorAssign     for $flag { fn bitxor_assign(&mut self, other: Self) { self.0 ^= other.0 } }

    impl $flag {
        /// `true` if all bits of `other` are set in `self`<br>
        /// `true` if `other` is `0`
        pub const fn has_all(self, other: Self) -> bool { self.0 & other.0 == other.0 }

        /// `true` if all bits of `other` are set in `self`<br>
        /// `false` if `other` is `0`
        pub const fn has_any(self, other: Self) -> bool { self.0 & other.0 != 0 }
    }
}}

macro_rules! impl_debug_for_enum {( $flag:ty => { $($path:path),* $(,)? } ) => {
    impl std::fmt::Debug for $flag {
        fn fmt(&self, fmt: &mut std::fmt::Formatter) -> std::fmt::Result {
            let s = match *self {
            $(  $path   => stringify!($path), )*
                _       => return write!(fmt, "{}", self.0),
            };
            fmt.write_str(s)
        }
    }
}}

macro_rules! impl_debug_for_flags {( $flag:ty => { $($path:path),* $(,)? } ) => {
    impl std::fmt::Debug for $flag {
        fn fmt(&self, fmt: &mut std::fmt::Formatter) -> std::fmt::Result {
            match *self {
            $(  $path   => return fmt.write_str(stringify!($path)), )*
                #[allow(unreachable_patterns)]
                Self(0) => return fmt.write_str("0"),
                _       => {},
            };
            let mut remaining = *self;
            $(
                if $path.0 != 0 && remaining.has_all($path) {
                    if *self != remaining { fmt.write_str(" | ")?; }
                    fmt.write_str(stringify!($path))?;
                    remaining &=! $path;
                }
            )*

            if remaining.0 != 0 {
                if *self != remaining { fmt.write_str(" | ")?; }
                write!(fmt, "0x{:X}", self.0)?;
            }

            Ok(())
        }
    }
}}