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
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
use EventLoopHandle;
use std::cell::RefCell;
use std::io::Error as IoError;
use std::io::Write;
use std::os::raw::{c_int, c_void};
use std::os::unix::io::RawFd;
use std::rc::Rc;
use wayland_sys::server::*;

/// fd_event_source
///
/// A handle to a registered FD event source
///
/// Dropping this struct does not remove the event source,
/// use the `remove` method for that.
pub struct FdEventSource<ID> {
    ptr: *mut wl_event_source,
    data: *mut (FdEventSourceImpl<ID>, *mut EventLoopHandle, ID),
}

bitflags!{
    /// Flags to register interest on a file descriptor
    pub struct FdInterest: u32 {
        /// Interest to be notified when the file descriptor is readable
        const READ  = 0x01;
        /// Interest to be notified when the file descriptor is writable
        const WRITE = 0x02;
    }
}

pub fn make_fd_event_source<ID: 'static>(ptr: *mut wl_event_source,
                                         data: Box<(FdEventSourceImpl<ID>, *mut EventLoopHandle, ID)>)
                                         -> FdEventSource<ID> {
    FdEventSource {
        ptr: ptr,
        data: Box::into_raw(data),
    }
}

impl<ID> FdEventSource<ID> {
    /// Change the registered interest for this FD
    pub fn update_mask(&mut self, mask: FdInterest) {
        unsafe {
            ffi_dispatch!(
                WAYLAND_SERVER_HANDLE,
                wl_event_source_fd_update,
                self.ptr,
                mask.bits()
            );
        }
    }

    /// Remove this event source from its event loop
    ///
    /// Returns the implementation data in case you have something to do with it.
    pub fn remove(self) -> ID {
        unsafe {
            ffi_dispatch!(WAYLAND_SERVER_HANDLE, wl_event_source_remove, self.ptr);
            let data = Box::from_raw(self.data);
            data.2
        }
    }
}

/// Implementation for FD events
pub struct FdEventSourceImpl<ID> {
    /// The FD is ready to be read/written
    ///
    /// Details of the capability state are given as argument.
    pub ready: fn(evlh: &mut EventLoopHandle, idata: &mut ID, fd: RawFd, mask: FdInterest),
    /// An error occured with this FD
    ///
    /// Most likely it won't be usable any longer
    pub error: fn(evlh: &mut EventLoopHandle, idata: &mut ID, fd: RawFd, mask: IoError),
}


pub unsafe extern "C" fn event_source_fd_dispatcher<ID>(fd: c_int, mask: u32, data: *mut c_void) -> c_int
where
    ID: 'static,
{
    // We don't need to worry about panic-safeness, because if there is a panic,
    // we'll abort the process, so no access to corrupted data is possible.
    let ret = ::std::panic::catch_unwind(move || {
        let data = &mut *(data as *mut (FdEventSourceImpl<ID>, *mut EventLoopHandle, ID));
        let implem = &data.0;
        let evlh = &mut *(data.1);
        let idata = &mut data.2;
        if mask & 0x08 > 0 {
            // EPOLLERR
            use nix::sys::socket;
            let err = match socket::getsockopt(fd, socket::sockopt::SocketError) {
                Ok(err) => err,
                Err(_) => {
                    // error while retrieving the error code ???
                    let _ = write!(
                        ::std::io::stderr(),
                        "[wayland-server error] Error while retrieving error code on socket {}, aborting.",
                        fd
                    );
                    ::libc::abort();
                }
            };
            (implem.error)(evlh, idata, fd, IoError::from_raw_os_error(err));
        } else if mask & 0x04 > 0 {
            // EPOLLHUP
            (implem.error)(
                evlh,
                idata,
                fd,
                IoError::new(::std::io::ErrorKind::ConnectionAborted, ""),
            )
        } else {
            let mut bits = FdInterest::empty();
            if mask & 0x02 > 0 {
                bits = bits | FdInterest::WRITE;
            }
            if mask & 0x01 > 0 {
                bits = bits | FdInterest::READ;
            }
            (implem.ready)(evlh, idata, fd, bits)
        }
    });
    match ret {
        Ok(()) => return 0, // all went well
        Err(_) => {
            // a panic occured
            let _ = write!(
                ::std::io::stderr(),
                "[wayland-server error] A handler for fd {} event source panicked, aborting.",
                fd
            );
            ::libc::abort();
        }
    }
}

/// timer_event_source
///
/// A handle to a registered timer event source
///
/// Dropping this struct does not remove the event source,
/// use the `remove` method for that.
pub struct TimerEventSource<ID> {
    ptr: *mut wl_event_source,
    data: *mut (TimerEventSourceImpl<ID>, *mut EventLoopHandle, ID),
}


pub fn make_timer_event_source<ID>(ptr: *mut wl_event_source,
                                   data: Box<(TimerEventSourceImpl<ID>, *mut EventLoopHandle, ID)>)
                                   -> TimerEventSource<ID> {
    TimerEventSource {
        ptr: ptr,
        data: Box::into_raw(data),
    }
}

impl<ID> TimerEventSource<ID> {
    /// Set the delay of this timer
    ///
    /// The callback will be called during the next dispatch of the
    /// event loop after this time (in milliseconds) is elapsed.
    ///
    /// Manually the delay to 0 stops the timer (the callback won't be
    /// called).
    pub fn set_delay_ms(&mut self, delay: i32) {
        unsafe {
            ffi_dispatch!(
                WAYLAND_SERVER_HANDLE,
                wl_event_source_timer_update,
                self.ptr,
                delay
            );
        }
    }

    /// Remove this event source from its event loop
    ///
    /// Returns the implementation data in case you have something to do with it.
    pub fn remove(self) -> ID {
        unsafe {
            ffi_dispatch!(WAYLAND_SERVER_HANDLE, wl_event_source_remove, self.ptr);
            let data = Box::from_raw(self.data);
            data.2
        }
    }
}

/// Called when the countdown reaches 0
pub type TimerEventSourceImpl<ID> = fn(&mut EventLoopHandle, idata: &mut ID);

pub unsafe extern "C" fn event_source_timer_dispatcher<ID>(data: *mut c_void) -> c_int
where
    ID: 'static,
{
    // We don't need to worry about panic-safeness, because if there is a panic,
    // we'll abort the process, so no access to corrupted data is possible.
    let ret = ::std::panic::catch_unwind(move || {
        let data = &mut *(data as *mut (TimerEventSourceImpl<ID>, *mut EventLoopHandle, ID));
        let cb = data.0;
        let evlh = &mut *(data.1);
        let idata = &mut data.2;
        cb(evlh, idata);
    });
    match ret {
        Ok(()) => return 0, // all went well
        Err(_) => {
            // a panic occured
            let _ = write!(
                ::std::io::stderr(),
                "[wayland-server error] A handler for a timer event source panicked, aborting.",
            );
            ::libc::abort();
        }
    }
}

/// signal_event_source
///
/// A handle to a registered signal event source
///
/// Dropping this struct does not remove the event source,
/// use the `remove` method for that.
pub struct SignalEventSource<ID> {
    ptr: *mut wl_event_source,
    data: *mut (SignalEventSourceImpl<ID>, *mut EventLoopHandle, ID),
}


pub fn make_signal_event_source<ID: 'static>(ptr: *mut wl_event_source,
                                             data: Box<
    (SignalEventSourceImpl<ID>, *mut EventLoopHandle, ID),
>)
                                             -> SignalEventSource<ID> {
    SignalEventSource {
        ptr: ptr,
        data: Box::into_raw(data),
    }
}

impl<ID> SignalEventSource<ID> {
    /// Remove this event source from its event loop
    ///
    /// Returns the implementation data in case you have something to do with it.
    pub fn remove(self) -> ID {
        unsafe {
            ffi_dispatch!(WAYLAND_SERVER_HANDLE, wl_event_source_remove, self.ptr);
            let data = Box::from_raw(self.data);
            data.2
        }
    }
}

/// A signal has been received
///
/// The signal number is given has argument
pub type SignalEventSourceImpl<ID> = fn(
                                      &mut EventLoopHandle,
                                      idata: &mut ID,
                                      signal: ::nix::sys::signal::Signal,
);

pub unsafe extern "C" fn event_source_signal_dispatcher<ID>(signal: c_int, data: *mut c_void) -> c_int
where
    ID: 'static,
{
    // We don't need to worry about panic-safeness, because if there is a panic,
    // we'll abort the process, so no access to corrupted data is possible.
    let ret = ::std::panic::catch_unwind(move || {
        let data = &mut *(data as *mut (SignalEventSourceImpl<ID>, *mut EventLoopHandle, ID));
        let cb = data.0;
        let evlh = &mut *(data.1);
        let idata = &mut data.2;
        let sig = match ::nix::sys::signal::Signal::from_c_int(signal) {
            Ok(sig) => sig,
            Err(_) => {
                // Actually, this cannot happen, as we cannot register an event source for
                // an unknown signal...
                let _ = write!(
                    ::std::io::stderr(),
                    "[wayland-server error] Unknown signal in signal event source: {}, aborting.",
                    signal
                );
                ::libc::abort();
            }
        };
        cb(evlh, idata, sig);
    });
    match ret {
        Ok(()) => return 0, // all went well
        Err(_) => {
            // a panic occured
            let _ = write!(
                ::std::io::stderr(),
                "[wayland-server error] A handler for a timer event source panicked, aborting.",
            );
            ::libc::abort();
        }
    }
}

/// Idle event source
///
/// A handle to an idle event source
///
/// Dropping this struct does not remove the event source,
/// use the `remove` method for that.
pub struct IdleEventSource<ID> {
    ptr: *mut wl_event_source,
    data: Rc<RefCell<(IdleEventSourceImpl<ID>, *mut EventLoopHandle, ID, bool)>>,
}

pub fn make_idle_event_source<ID>(ptr: *mut wl_event_source,
                                  data: Rc<
    RefCell<(IdleEventSourceImpl<ID>, *mut EventLoopHandle, ID, bool)>,
>)
                                  -> IdleEventSource<ID> {
    IdleEventSource {
        ptr: ptr,
        data: data,
    }
}

/// The idle-throttled callback
pub type IdleEventSourceImpl<ID> = fn(&mut EventLoopHandle, idata: &mut ID);

impl<ID> IdleEventSource<ID> {
    /// Remove this event source from its event loop
    ///
    /// If this idle callback was not yet dispatched, cancel it.
    ///
    /// Returns the implementation data in case you have something to do with it.
    pub fn remove(self) -> ID {
        let dispatched = self.data.borrow().3;
        if !dispatched {
            unsafe {
                // unregister this event source
                ffi_dispatch!(WAYLAND_SERVER_HANDLE, wl_event_source_remove, self.ptr);
                // recreate the outstanding reference that was not consumed
                let _ = Rc::from_raw(&*self.data);
            }
        }
        // we are now the only oustanding reference
        let data = Rc::try_unwrap(self.data)
            .unwrap_or_else(|_| panic!("Idle Rc was not singly owned."))
            .into_inner();
        data.2
    }
}

pub unsafe extern "C" fn event_source_idle_dispatcher<ID>(data: *mut c_void)
where
    ID: 'static,
{
    // We don't need to worry about panic-safeness, because if there is a panic,
    // we'll abort the process, so no access to corrupted data is possible.
    let ret = ::std::panic::catch_unwind(move || {
        let data = &*(data as *mut RefCell<(IdleEventSourceImpl<ID>, *mut EventLoopHandle, ID, bool)>);
        let mut data = data.borrow_mut();
        let cb = data.0;
        let evlh = &mut *(data.1);
        let idata = &mut data.2;
        cb(evlh, idata);
    });
    match ret {
        Ok(()) => {
            // all went well
            // free the refence to the idata, as this event source cannot be called again
            let data =
                Rc::from_raw(data as *mut RefCell<(IdleEventSourceImpl<ID>, *mut EventLoopHandle, ID, bool)>);
            // store that the dispatching occured
            data.borrow_mut().3 = true;
        }
        Err(_) => {
            // a panic occured
            let _ = write!(
                ::std::io::stderr(),
                "[wayland-server error] A handler for a timer event source panicked, aborting.",
            );
            ::libc::abort();
        }
    }
}