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
194
195
|
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
/// This macro is very similar to xpcom_macro, but works a bit differently:
///
/// When possible, it returns errors via the callback rather than via the return
/// value.
///
/// It implicitly adds the callback argument of type: nsIBitsNewRequestCallback
///
/// It needs an action type, to be specified before the rust name, in square
/// brackets.
///
/// The rustic implementation that the xpcom method calls is expected to return
/// the type: Result<_, BitsTaskError>. If this value is Ok, it will be ignored.
/// If the value is Err, it will be returned via the callback passed.
///
/// Usage like this:
///
/// ```ignore
/// nsIBits_method!(
/// [ActionType]
/// rust_method => XpcomMethod(
/// foo: *const nsACString,
/// bar: *const nsIBar,
/// baz: bool,
/// [optional] qux: *const nsIQux,
/// )
/// );
/// ```
///
/// Results in the macro generating a method like:
///
/// ```ignore
/// unsafe fn XpcomMethod(
/// &self,
/// foo: *const nsACString,
/// bar: *const nsIBar,
/// baz: bool,
/// qux: *const nsIQux,
/// callback: *const nsIBitsNewRequestCallback,
/// ) -> nsresult {
/// let callback: &nsIBitsNewRequestCallback = match xpcom::Ensure::ensure(callback) {
/// Ok(val) => val,
/// Err(result) => return result,
/// };
/// let foo = match xpcom::Ensure::ensure(foo) {
/// Ok(val) => val,
/// Err(_) => {
/// dispatch_pretask_interface_error(BitsTaskError::new(ErrorType::NullArgument, ActionType.into(), ErrorStage::Pretask), callback);
/// return NS_OK;
/// }
/// };
/// let bar = match xpcom::Ensure::ensure(bar) {
/// Ok(val) => val,
/// Err(_) => {
/// dispatch_pretask_interface_error(BitsTaskError::new(ErrorType::NullArgument, ActionType.into(), ErrorStage::Pretask), callback);
/// return NS_OK;
/// }
/// };
/// let baz = match xpcom::Ensure::ensure(baz) {
/// Ok(val) => val,
/// Err(_) => {
/// dispatch_pretask_interface_error(BitsTaskError::new(ErrorType::NullArgument, ActionType.into(), ErrorStage::Pretask), callback);
/// return NS_OK;
/// }
/// };
/// let qux = match xpcom::Ensure::ensure(qux) {
/// Ok(val) => Some(val),
/// Err(_) => None,
/// };
///
/// if let Err(error) = self.rust_method(foo, bar, baz, qux, callback) {
/// dispatch_pretask_interface_error(error, callback);
/// }
///
/// NS_OK
/// }
/// ```
///
/// Which expects a Rustic implementation method like:
///
/// ```ignore
/// fn rust_method(
/// &self,
/// foo: &nsACString,
/// bar: &nsIBar,
/// baz: bool,
/// qux: Option<&nsIQux>,
/// callback: &nsIBitsNewRequestCallback,
/// ) -> Result<(), BitsTaskError> {
/// do_something()
/// }
/// ```
#[macro_export]
macro_rules! nsIBits_method {
// The internal rule @ensure_param converts raw pointer arguments to
// references, calling dispatch_pretask_interface_error and returning if the
// argument is null.
// If, however, the type is optional, the reference will also be wrapped
// in an option and null pointers will be converted to None.
(@ensure_param [optional] $name:ident, $action:expr, $callback:ident) => {
let $name = match Ensure::ensure($name) {
Ok(val) => Some(val),
Err(_) => None,
};
};
(@ensure_param $name:ident, $action:expr, $callback:ident) => {
let $name = match Ensure::ensure($name) {
Ok(val) => val,
Err(_) => {
dispatch_pretask_interface_error(BitsTaskError::new(NullArgument, $action.into(), Pretask), $callback);
return NS_OK;
}
};
};
([$action:expr] $rust_name:ident => $xpcom_name:ident($($([$param_required:ident])* $param_name:ident: $param_type:ty $(,)*)*)) => {
#[allow(non_snake_case)]
unsafe fn $xpcom_name(&self, $($param_name: $param_type, )* callback: *const nsIBitsNewRequestCallback) -> nsresult {
use xpcom::Ensure;
use nserror::NS_OK;
// When no params are passed, the imports below will not be used, so silence the
// warning
#[allow(unused_imports)]
use bits_interface::{
dispatch_callback::dispatch_pretask_interface_error,
error::{BitsTaskError, ErrorStage::Pretask, ErrorType::NullArgument},
};
let callback: &nsIBitsNewRequestCallback = match Ensure::ensure(callback) {
Ok(val) => val,
Err(result) => return result,
};
$(nsIBits_method!(@ensure_param $([$param_required])* $param_name, $action, callback);)*
if let Err(error) = self.$rust_name($($param_name, )* callback) {
dispatch_pretask_interface_error(error, callback);
}
NS_OK
}
};
}
/*
* Same as above, but expects a nsIBitsCallback as its callback.
*/
#[macro_export]
macro_rules! nsIBitsRequest_method {
// The internal rule @ensure_param converts raw pointer arguments to
// references, calling dispatch_pretask_interface_error and returning if the
// argument is null.
// If, however, the type is optional, the reference will also be wrapped
// in an option and null pointers will be converted to None.
(@ensure_param [optional] $name:ident, $action:expr, $callback:ident) => {
let $name = match Ensure::ensure($name) {
Ok(val) => Some(val),
Err(_) => None,
};
};
(@ensure_param $name:ident, $action:expr, $callback:ident) => {
let $name = match Ensure::ensure($name) {
Ok(val) => val,
Err(_) => {
dispatch_pretask_request_error(BitsTaskError::new(NullArgument, $action.into(), Pretask), $callback);
return NS_OK;
}
};
};
([$action:expr] $rust_name:ident => $xpcom_name:ident($($([$param_required:ident])* $param_name:ident: $param_type:ty $(,)*)*)) => {
#[allow(non_snake_case)]
unsafe fn $xpcom_name(&self, $($param_name: $param_type, )* callback: *const nsIBitsCallback) -> nsresult {
use xpcom::Ensure;
use nserror::NS_OK;
// When no params are passed, the imports below will not be used, so silence the
// warning
#[allow(unused_imports)]
use bits_interface::{
dispatch_callback::dispatch_pretask_request_error,
error::{BitsTaskError, ErrorStage::Pretask, ErrorType::NullArgument},
};
let callback: &nsIBitsCallback = match Ensure::ensure(callback) {
Ok(val) => val,
Err(result) => return result,
};
$(nsIBitsRequest_method!(@ensure_param $([$param_required])* $param_name, $action, callback);)*
if let Err(error) = self.$rust_name($($param_name, )* callback) {
dispatch_pretask_request_error(error, callback);
}
NS_OK
}
};
}
|
