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
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
//! Macros for helping with common operations in Calloop.

/// Register a set of event sources. Effectively calls
/// [`EventSource::register()`] for all the sources provided.
///
/// Usage:
///
/// ```none,actually-rust-but-see-https://github.com/rust-lang/rust/issues/63193
/// calloop::batch_register!(
///     poll, token_factory,
///     self.source_one,
///     self.source_two,
///     self.source_three,
///     self.source_four,
/// )
/// ```
///
/// Note that there is no scope for customisation; if you need to do special
/// things with a particular source, you'll need to leave it off the list. Also
/// note that this only does try-or-early-return error handling in the order
/// that you list the sources; if you need anything else, don't use this macro.
///
/// [`EventSource::register()`]: crate::EventSource::register()
#[macro_export]
macro_rules! batch_register {
    ($poll:ident, $token_fac:ident, $( $source:expr ),* $(,)?) => {
        {
            $(
                $source.register($poll, $token_fac)?;
            )*
                $crate::Result::<_>::Ok(())
        }
    };
}

/// Reregister a set of event sources. Effectively calls
/// [`EventSource::reregister()`] for all the sources provided.
///
/// Usage:
///
/// ```none,actually-rust-but-see-https://github.com/rust-lang/rust/issues/63193
/// calloop::batch_reregister!(
///     poll, token_factory,
///     self.source_one,
///     self.source_two,
///     self.source_three,
///     self.source_four,
/// )
/// ```
///
/// Note that there is no scope for customisation; if you need to do special
/// things with a particular source, you'll need to leave it off the list. Also
/// note that this only does try-or-early-return error handling in the order
/// that you list the sources; if you need anything else, don't use this macro.
///
/// [`EventSource::reregister()`]: crate::EventSource::reregister()
#[macro_export]
macro_rules! batch_reregister {
    ($poll:ident, $token_fac:ident, $( $source:expr ),* $(,)?) => {
        {
            $(
                $source.reregister($poll, $token_fac)?;
            )*
                $crate::Result::<_>::Ok(())
        }
    };
}

/// Unregister a set of event sources. Effectively calls
/// [`EventSource::unregister()`] for all the sources provided.
///
/// Usage:
///
/// ```none,actually-rust-but-see-https://github.com/rust-lang/rust/issues/63193
/// calloop::batch_unregister!(
///     poll,
///     self.source_one,
///     self.source_two,
///     self.source_three,
///     self.source_four,
/// )
/// ```
///
/// Note that there is no scope for customisation; if you need to do special
/// things with a particular source, you'll need to leave it off the list. Also
/// note that this only does try-or-early-return error handling in the order
/// that you list the sources; if you need anything else, don't use this macro.
///
/// [`EventSource::unregister()`]: crate::EventSource::unregister()
#[macro_export]
macro_rules! batch_unregister {
    ($poll:ident, $( $source:expr ),* $(,)?) => {
        {
            $(
                $source.unregister($poll)?;
            )*
                $crate::Result::<_>::Ok(())
        }
    };
}

#[cfg(test)]
mod tests {
    use std::time::Duration;

    use crate::{
        ping::{make_ping, PingSource},
        EventSource, PostAction,
    };

    struct BatchSource {
        ping0: PingSource,
        ping1: PingSource,
        ping2: PingSource,
    }

    impl EventSource for BatchSource {
        type Event = usize;
        type Metadata = ();
        type Ret = ();
        type Error = Box<dyn std::error::Error + Sync + Send>;

        fn process_events<F>(
            &mut self,
            readiness: crate::Readiness,
            token: crate::Token,
            mut callback: F,
        ) -> Result<crate::PostAction, Self::Error>
        where
            F: FnMut(Self::Event, &mut Self::Metadata) -> Self::Ret,
        {
            self.ping0
                .process_events(readiness, token, |_, m| callback(0, m))?;
            self.ping1
                .process_events(readiness, token, |_, m| callback(1, m))?;
            self.ping2
                .process_events(readiness, token, |_, m| callback(2, m))?;
            Ok(PostAction::Continue)
        }

        fn register(
            &mut self,
            poll: &mut crate::Poll,
            token_factory: &mut crate::TokenFactory,
        ) -> crate::Result<()> {
            crate::batch_register!(poll, token_factory, self.ping0, self.ping1, self.ping2)
        }

        fn reregister(
            &mut self,
            poll: &mut crate::Poll,
            token_factory: &mut crate::TokenFactory,
        ) -> crate::Result<()> {
            crate::batch_reregister!(poll, token_factory, self.ping0, self.ping1, self.ping2)
        }

        fn unregister(&mut self, poll: &mut crate::Poll) -> crate::Result<()> {
            crate::batch_unregister!(poll, self.ping0, self.ping1, self.ping2)
        }
    }

    #[test]
    fn test_batch_operations() {
        let mut fired = [false; 3];

        let (send0, ping0) = make_ping().unwrap();
        let (send1, ping1) = make_ping().unwrap();
        let (send2, ping2) = make_ping().unwrap();

        let top = BatchSource {
            ping0,
            ping1,
            ping2,
        };

        let mut event_loop = crate::EventLoop::<[bool; 3]>::try_new().unwrap();
        let handle = event_loop.handle();

        let token = handle
            .insert_source(top, |idx, _, fired| {
                fired[idx] = true;
            })
            .unwrap();

        send0.ping();
        send1.ping();
        send2.ping();

        event_loop
            .dispatch(Duration::new(0, 0), &mut fired)
            .unwrap();

        assert_eq!(fired, [true; 3]);

        fired = [false; 3];

        handle.update(&token).unwrap();

        send0.ping();
        send1.ping();
        send2.ping();

        event_loop
            .dispatch(Duration::new(0, 0), &mut fired)
            .unwrap();

        assert_eq!(fired, [true; 3]);

        fired = [false; 3];

        handle.remove(token);

        send0.ping();
        send1.ping();
        send2.ping();

        event_loop
            .dispatch(Duration::new(0, 0), &mut fired)
            .unwrap();

        assert_eq!(fired, [false; 3]);
    }
}