Revision control
Copy as Markdown
Other Tools
// Licensed under the Apache License, Version 2.0
// All files in the project carrying such notice may not be copied, modified, or distributed
// except according to those terms.
//! Macros to make things easier to define
macro_rules! DECLARE_HANDLE {
($name:ident, $inner:ident) => {
pub enum $inner {}
pub type $name = *mut $inner;
};
}
macro_rules! MAKE_HRESULT {
($sev:expr, $fac:expr, $code:expr) => {
($sev << 31) | ($fac << 16) | $code
}
}
macro_rules! MAKE_SCODE {
($sev:expr, $fac:expr, $code:expr) => {
($sev << 31) | ($fac << 16) | $code
}
}
macro_rules! HIDP_ERROR_CODES {
($sev:expr, $code:expr) => {
($sev << 28) | (FACILITY_HID_ERROR_CODE << 16) | $code
}
}
macro_rules! MAKEFOURCC {
($a:expr, $b:expr, $c:expr, $d:expr) => {
($a as u32) | (($b as u32) << 8) | (($c as u32) << 16) | (($d as u32) << 24)
}
}
#[macro_export]
macro_rules! DEFINE_GUID {
(
$name:ident, $l:expr, $w1:expr, $w2:expr,
$b1:expr, $b2:expr, $b3:expr, $b4:expr, $b5:expr, $b6:expr, $b7:expr, $b8:expr
) => {
pub const $name: $crate::shared::guiddef::GUID = $crate::shared::guiddef::GUID {
Data1: $l,
Data2: $w1,
Data3: $w2,
Data4: [$b1, $b2, $b3, $b4, $b5, $b6, $b7, $b8],
};
}
}
macro_rules! DEFINE_BLUETOOTH_UUID128 {
($name:ident, $shortId:expr) => {
DEFINE_GUID!{$name,
$shortId as u32, 0x0000, 0x1000, 0x80, 0x00, 0x00, 0x80, 0x5F, 0x9B, 0x34, 0xFB}
}
}
#[macro_export]
macro_rules! DEFINE_PROPERTYKEY {
(
$name:ident, $l:expr, $w1:expr, $w2:expr,
$b1:expr, $b2:expr, $b3:expr, $b4:expr, $b5:expr, $b6:expr, $b7:expr, $b8:expr,
$pid:expr
) => {
pub const $name: PROPERTYKEY
= PROPERTYKEY {
fmtid: $crate::shared::guiddef::GUID {
Data1: $l,
Data2: $w1,
Data3: $w2,
Data4: [$b1, $b2, $b3, $b4, $b5, $b6, $b7, $b8],
},
pid: $pid,
};
}
}
#[macro_export]
macro_rules! DEFINE_DEVPROPKEY {
(
$name:ident, $l:expr, $w1:expr, $w2:expr,
$b1:expr, $b2:expr, $b3:expr, $b4:expr, $b5:expr, $b6:expr, $b7:expr, $b8:expr,
$pid:expr
) => {
pub const $name: DEVPROPKEY = DEVPROPKEY {
fmtid: $crate::shared::guiddef::GUID {
Data1: $l,
Data2: $w1,
Data3: $w2,
Data4: [$b1, $b2, $b3, $b4, $b5, $b6, $b7, $b8],
},
pid: $pid,
};
}
}
macro_rules! CTL_CODE {
($DeviceType:expr, $Function:expr, $Method:expr, $Access:expr) => {
($DeviceType << 16) | ($Access << 14) | ($Function << 2) | $Method
}
}
macro_rules! BTH_CTL {
($id:expr) => {
CTL_CODE!(FILE_DEVICE_BLUETOOTH, $id, METHOD_BUFFERED, FILE_ANY_ACCESS)
};
}
macro_rules! BTH_KERNEL_CTL {
($id:expr) => {
CTL_CODE!(FILE_DEVICE_BLUETOOTH, $id, METHOD_NEITHER, FILE_ANY_ACCESS)
};
}
macro_rules! HID_CTL_CODE {
($id:expr) => {
CTL_CODE!(FILE_DEVICE_KEYBOARD, $id, METHOD_NEITHER, FILE_ANY_ACCESS)
}
}
macro_rules! HID_BUFFER_CTL_CODE {
($id:expr) => {
CTL_CODE!(FILE_DEVICE_KEYBOARD, $id, METHOD_BUFFERED, FILE_ANY_ACCESS)
}
}
macro_rules! HID_IN_CTL_CODE {
($id:expr) => {
CTL_CODE!(FILE_DEVICE_KEYBOARD, $id, METHOD_IN_DIRECT, FILE_ANY_ACCESS)
}
}
macro_rules! HID_OUT_CTL_CODE {
($id:expr) => {
CTL_CODE!(FILE_DEVICE_KEYBOARD, $id, METHOD_OUT_DIRECT, FILE_ANY_ACCESS)
}
}
macro_rules! AUDCLNT_ERR {
($n:expr) => {
MAKE_HRESULT!(SEVERITY_ERROR, FACILITY_AUDCLNT, $n)
};
}
macro_rules! AUDCLNT_SUCCESS {
($n:expr) => {
MAKE_SCODE!(SEVERITY_SUCCESS, FACILITY_AUDCLNT, $n)
};
}
macro_rules! BCRYPT_MAKE_INTERFACE_VERSION {
($major:expr, $minor:expr) => {
$crate::shared::bcrypt::BCRYPT_INTERFACE_VERSION {
MajorVersion: $major, MinorVersion: $minor,
}
}
}
macro_rules! MAKEINTRESOURCE {
($i:expr) => { $i as u16 as usize as LPWSTR }
}
#[macro_export]
macro_rules! RIDL {
(#[uuid($l:expr, $w1:expr, $w2:expr,
$b1:expr, $b2:expr, $b3:expr, $b4:expr, $b5:expr, $b6:expr, $b7:expr, $b8:expr)]
class $class:ident;) => (
pub enum $class {}
impl $crate::Class for $class {
#[inline]
fn uuidof() -> $crate::shared::guiddef::GUID {
$crate::shared::guiddef::GUID {
Data1: $l,
Data2: $w1,
Data3: $w2,
Data4: [$b1, $b2, $b3, $b4, $b5, $b6, $b7, $b8],
}
}
}
);
(#[uuid($($uuid:expr),+)]
interface $interface:ident ($vtbl:ident) {$(
$(#[$($attrs:tt)*])* fn $method:ident($($p:ident : $t:ty,)*) -> $rtr:ty,
)+}) => (
RIDL!{@vtbl $interface $vtbl () $(
$(#[$($attrs)*])* fn $method($($p: $t,)*) -> $rtr,
)+}
#[repr(C)]
pub struct $interface {
pub lpVtbl: *const $vtbl,
}
impl $interface {
$(RIDL!{@method $(#[$($attrs)*])* fn $method($($p: $t,)*) -> $rtr})+
}
RIDL!{@uuid $interface $($uuid),+}
);
(#[uuid($($uuid:expr),+)]
interface $interface:ident ($vtbl:ident) : $pinterface:ident ($pvtbl:ident) {}) => (
RIDL!{@vtbl $interface $vtbl (pub parent: $pvtbl,)}
#[repr(C)]
pub struct $interface {
pub lpVtbl: *const $vtbl,
}
RIDL!{@deref $interface $pinterface}
RIDL!{@uuid $interface $($uuid),+}
);
(#[uuid($($uuid:expr),+)]
interface $interface:ident ($vtbl:ident) : $pinterface:ident ($pvtbl:ident) {$(
$(#[$($attrs:tt)*])* fn $method:ident($($p:ident : $t:ty,)*) -> $rtr:ty,
)+}) => (
RIDL!{@vtbl $interface $vtbl (pub parent: $pvtbl,) $(
$(#[$($attrs)*])* fn $method($($p: $t,)*) -> $rtr,
)+}
#[repr(C)]
pub struct $interface {
pub lpVtbl: *const $vtbl,
}
impl $interface {
$(RIDL!{@method $(#[$($attrs)*])* fn $method($($p: $t,)*) -> $rtr})+
}
RIDL!{@deref $interface $pinterface}
RIDL!{@uuid $interface $($uuid),+}
);
(@deref $interface:ident $pinterface:ident) => (
impl $crate::_core::ops::Deref for $interface {
type Target = $pinterface;
#[inline]
fn deref(&self) -> &$pinterface {
unsafe { &*(self as *const $interface as *const $pinterface) }
}
}
);
(@method fn $method:ident($($p:ident : $t:ty,)*) -> $rtr:ty) => (
#[inline] pub unsafe fn $method(&self, $($p: $t,)*) -> $rtr {
((*self.lpVtbl).$method)(self as *const _ as *mut _, $($p,)*)
}
);
(@method #[fixme] fn $method:ident($($p:ident : $t:ty,)*) -> $rtr:ty) => (
#[inline] pub unsafe fn $method(&self, $($p: $t,)*) -> $rtr {
let mut ret = $crate::_core::mem::uninitialized();
((*self.lpVtbl).$method)(self as *const _ as *mut _, &mut ret, $($p,)*);
ret
}
);
(@vtbl $interface:ident $vtbl:ident ($($fields:tt)*)
$(fn $method:ident($($p:ident : $t:ty,)*) -> $rtr:ty,)*
) => (
RIDL!{@item #[repr(C)]
pub struct $vtbl {
$($fields)*
$(pub $method: unsafe extern "system" fn(
This: *mut $interface,
$($p: $t,)*
) -> $rtr,)*
}}
);
(@vtbl $interface:ident $vtbl:ident ($($fields:tt)*)
fn $method:ident($($p:ident : $t:ty,)*) -> $rtr:ty,
$($tail:tt)*) => (
RIDL!{@vtbl $interface $vtbl (
$($fields)*
pub $method: unsafe extern "system" fn(
This: *mut $interface,
$($p: $t,)*
) -> $rtr,
) $($tail)*}
);
(@vtbl $interface:ident $vtbl:ident ($($fields:tt)*)
#[fixme] fn $method:ident($($p:ident : $t:ty,)*) -> $rtr:ty,
$($tail:tt)*) => (
RIDL!{@vtbl $interface $vtbl (
$($fields)*
pub $method: unsafe extern "system" fn(
This: *mut $interface,
ret: *mut $rtr,
$($p: $t,)*
) -> *mut $rtr,
) $($tail)*}
);
(@uuid $interface:ident
$l:expr, $w1:expr, $w2:expr,
$b1:expr, $b2:expr, $b3:expr, $b4:expr, $b5:expr, $b6:expr, $b7:expr, $b8:expr
) => (
impl $crate::Interface for $interface {
#[inline]
fn uuidof() -> $crate::shared::guiddef::GUID {
$crate::shared::guiddef::GUID {
Data1: $l,
Data2: $w1,
Data3: $w2,
Data4: [$b1, $b2, $b3, $b4, $b5, $b6, $b7, $b8],
}
}
}
);
(@item $thing:item) => ($thing);
}
macro_rules! UNION {
($(#[$attrs:meta])* union $name:ident {
[$stype:ty; $ssize:expr],
$($variant:ident $variant_mut:ident: $ftype:ty,)+
}) => (
#[repr(C)] $(#[$attrs])*
pub struct $name([$stype; $ssize]);
impl Copy for $name {}
impl Clone for $name {
#[inline]
fn clone(&self) -> $name { *self }
}
#[cfg(feature = "impl-default")]
impl Default for $name {
#[inline]
fn default() -> $name { unsafe { $crate::_core::mem::zeroed() } }
}
impl $name {$(
#[inline]
pub unsafe fn $variant(&self) -> &$ftype {
&*(self as *const _ as *const $ftype)
}
#[inline]
pub unsafe fn $variant_mut(&mut self) -> &mut $ftype {
&mut *(self as *mut _ as *mut $ftype)
}
)+}
);
($(#[$attrs:meta])* union $name:ident {
[$stype32:ty; $ssize32:expr] [$stype64:ty; $ssize64:expr],
$($variant:ident $variant_mut:ident: $ftype:ty,)+
}) => (
#[repr(C)] $(#[$attrs])* #[cfg(target_pointer_width = "32")]
pub struct $name([$stype32; $ssize32]);
#[repr(C)] $(#[$attrs])* #[cfg(target_pointer_width = "64")]
pub struct $name([$stype64; $ssize64]);
impl Copy for $name {}
impl Clone for $name {
#[inline]
fn clone(&self) -> $name { *self }
}
#[cfg(feature = "impl-default")]
impl Default for $name {
#[inline]
fn default() -> $name { unsafe { $crate::_core::mem::zeroed() } }
}
impl $name {$(
#[inline]
pub unsafe fn $variant(&self) -> &$ftype {
&*(self as *const _ as *const $ftype)
}
#[inline]
pub unsafe fn $variant_mut(&mut self) -> &mut $ftype {
&mut *(self as *mut _ as *mut $ftype)
}
)+}
);
}
macro_rules! BITFIELD {
($base:ident $field:ident: $fieldtype:ty [
$($thing:ident $set_thing:ident[$r:expr],)+
]) => {
impl $base {$(
#[inline]
pub fn $thing(&self) -> $fieldtype {
let size = $crate::core::mem::size_of::<$fieldtype>() * 8;
self.$field << (size - $r.end) >> (size - $r.end + $r.start)
}
#[inline]
pub fn $set_thing(&mut self, val: $fieldtype) {
let mask = ((1 << ($r.end - $r.start)) - 1) << $r.start;
self.$field &= !mask;
self.$field |= (val << $r.start) & mask;
}
)+}
}
}
#[macro_export]
macro_rules! ENUM {
{enum $name:ident { $($variant:ident = $value:expr,)+ }} => {
pub type $name = u32;
$(pub const $variant: $name = $value;)+
};
{enum $name:ident { $variant:ident = $value:expr, $($rest:tt)* }} => {
pub type $name = u32;
pub const $variant: $name = $value;
ENUM!{@gen $name $variant, $($rest)*}
};
{enum $name:ident { $variant:ident, $($rest:tt)* }} => {
ENUM!{enum $name { $variant = 0, $($rest)* }}
};
{@gen $name:ident $base:ident,} => {};
{@gen $name:ident $base:ident, $variant:ident = $value:expr, $($rest:tt)*} => {
pub const $variant: $name = $value;
ENUM!{@gen $name $variant, $($rest)*}
};
{@gen $name:ident $base:ident, $variant:ident, $($rest:tt)*} => {
pub const $variant: $name = $base + 1u32;
ENUM!{@gen $name $variant, $($rest)*}
};
}
#[macro_export]
macro_rules! STRUCT {
(#[debug] $($rest:tt)*) => (
STRUCT!{#[cfg_attr(feature = "impl-debug", derive(Debug))] $($rest)*}
);
($(#[$attrs:meta])* struct $name:ident {
$($field:ident: $ftype:ty,)+
}) => (
#[repr(C)] #[derive(Copy)] $(#[$attrs])*
pub struct $name {
$(pub $field: $ftype,)+
}
impl Clone for $name {
#[inline]
fn clone(&self) -> $name { *self }
}
#[cfg(feature = "impl-default")]
impl Default for $name {
#[inline]
fn default() -> $name { unsafe { $crate::_core::mem::zeroed() } }
}
);
}
macro_rules! IFDEF {
($($thing:item)*) => ($($thing)*)
}
macro_rules! FN {
(stdcall $func:ident($($t:ty,)*) -> $ret:ty) => (
pub type $func = Option<unsafe extern "system" fn($($t,)*) -> $ret>;
);
(stdcall $func:ident($($p:ident: $t:ty,)*) -> $ret:ty) => (
pub type $func = Option<unsafe extern "system" fn($($p: $t,)*) -> $ret>;
);
(cdecl $func:ident($($t:ty,)*) -> $ret:ty) => (
pub type $func = Option<unsafe extern "C" fn($($t,)*) -> $ret>;
);
(cdecl $func:ident($($p:ident: $t:ty,)*) -> $ret:ty) => (
pub type $func = Option<unsafe extern "C" fn($($p: $t,)*) -> $ret>;
);
}
macro_rules! _WSAIO {
($x:expr, $y:expr) => {
$crate::shared::ws2def::IOC_VOID | $x | $y
}
}
macro_rules! _WSAIOR {
($x:expr, $y:expr) => {
$crate::shared::ws2def::IOC_OUT | $x | $y
}
}
macro_rules! _WSAIOW {
($x:expr, $y:expr) => {
$crate::shared::ws2def::IOC_IN | $x | $y
}
}
macro_rules! _WSAIORW {
($x:expr, $y:expr) => {
$crate::shared::ws2def::IOC_INOUT | $x | $y
}
}