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
use libc::{c_char, c_int};
use std::borrow::Cow;
use std::ffi::CStr;
use std::os::raw::c_void;
use std::ptr;

use weechat_sys::{t_gui_buffer, t_weechat_plugin};

use super::Hook;
use crate::buffer::Buffer;
use crate::{LossyCString, ReturnCode, Weechat};

/// Hook for a signal, the hook is removed when the object is dropped.
pub struct SignalHook {
    _hook: Hook,
    _hook_data: Box<SignalHookData>,
}

struct SignalHookData {
    callback: Box<dyn SignalCallback>,
    weechat_ptr: *mut t_weechat_plugin,
}

/// Enum over the different data types a signal may send.
#[non_exhaustive]
pub enum SignalData<'a> {
    /// String data
    String(Cow<'a, str>),
    /// Integer data
    Integer(i32),
    /// Buffer that was sent with the signal.
    Buffer(Buffer<'a>),
}

impl<'a> Into<SignalData<'a>> for &'a str {
    fn into(self) -> SignalData<'a> {
        SignalData::String(Cow::from(self))
    }
}

impl<'a> Into<SignalData<'a>> for String {
    fn into(self) -> SignalData<'a> {
        SignalData::String(Cow::from(self))
    }
}

impl<'a> Into<SignalData<'a>> for i32 {
    fn into(self) -> SignalData<'a> {
        SignalData::Integer(self)
    }
}

impl<'a> Into<SignalData<'a>> for Buffer<'a> {
    fn into(self) -> SignalData<'a> {
        SignalData::Buffer(self)
    }
}

impl<'a> SignalData<'a> {
    fn pointer_is_buffer(signal_name: &str) -> bool {
        // This table is taken from the Weechat plugin API docs
        //
        // https://weechat.org/files/doc/stable/weechat_plugin_api.en.html#_hook_signal
        match signal_name {
            "irc_channel_opened" | "irc_pv_opened" | "irc_server_opened" => {
                true
            }

            "logger_start" | "logger_stop" | "logger_backlog" => true,

            "spell_suggest" => true,

            "buffer_opened" | "buffer_closing" | "buffer_closed"
            | "buffer_cleared" => true,

            "buffer_filters_enabled"
            | "buffer_filters_disabled"
            | "buffer_hidden"
            | "buffer_unhidden" => true,

            "buffer_lines_hidden"
            | "buffer_localvar_added"
            | "buffer_localvar_changed"
            | "buffer_localvar_removed"
            | "buffer_merged"
            | "buffer_unmerged"
            | "buffer_moved"
            | "buffer_renamed"
            | "buffer_switch"
            | "buffer_title_changed"
            | "buffer_type_changed" => true,

            "buffer_zoomed" | "buffer_unzoomed" => true,

            "hotlist_changed" => true,

            "input_search"
            | "input_text_changed"
            | "input_text_cursor_moved" => true,

            // TODO nicklist group signals have a string representation of a
            // pointer concatenated to the group name

            // TODO some signals send out pointers to windows.
            // TODO some signals send out pointers to infolists.
            _ => false,
        }
    }

    fn from_type_and_name(
        weechat: &'a Weechat,
        signal_name: &str,
        data_type: &str,
        data: *mut c_void,
    ) -> Option<SignalData<'a>> {
        // Some signals don't send any data, some other signals might send out a
        // buffer pointer that might be null, in either case check if the
        // pointer is valid first.
        if data.is_null() {
            return None;
        }

        match data_type {
            "string" => unsafe {
                Some(SignalData::String(
                    CStr::from_ptr(data as *const c_char).to_string_lossy(),
                ))
            },
            "integer" => {
                let data = data as *const c_int;
                unsafe { Some(SignalData::Integer(*(data))) }
            }
            "pointer" => {
                if SignalData::pointer_is_buffer(signal_name) {
                    Some(SignalData::Buffer(
                        weechat.buffer_from_ptr(data as *mut t_gui_buffer),
                    ))
                } else {
                    None
                }
            }
            _ => None,
        }
    }
}

/// Trait for the signal callback.
///
/// A blanket implementation for pure `FnMut` functions exists, if data needs to
/// be passed to the callback implement this over your struct.
pub trait SignalCallback {
    /// Callback that will be called when a signal is fired.
    /// input field.
    ///
    /// # Arguments
    ///
    /// * `weechat` - A Weechat context.
    ///
    /// * `signal_name` - The name of the signal that fired the callback.
    ///
    /// * `data` - The data that was passed on by the signal.
    fn callback(
        &mut self,
        weechat: &Weechat,
        signal_name: &str,
        data: Option<SignalData>,
    ) -> ReturnCode;
}

impl<T: FnMut(&Weechat, &str, Option<SignalData>) -> ReturnCode + 'static>
    SignalCallback for T
{
    fn callback(
        &mut self,
        weechat: &Weechat,
        signal_name: &str,
        data: Option<SignalData>,
    ) -> ReturnCode {
        self(weechat, signal_name, data)
    }
}

impl SignalHook {
    /// Hook a signal.
    ///
    /// # Arguments
    ///
    /// * `signal_name` - The signal to hook (wildcard `*` is allowed).
    ///
    /// * `callback` - A function or a struct that implements SignalCallback,
    /// the callback method of the trait will be called when the signal is
    /// fired.
    ///
    /// # Panics
    ///
    /// Panics if the method is not called from the main Weechat thread.
    ///
    /// # Example
    ///
    /// ```no_run
    /// # use weechat::{Weechat, ReturnCode};
    /// # use weechat::hooks::{SignalData, SignalHook};
    /// let signal_hook = SignalHook::new(
    ///     "buffer_switch",
    ///     |_weechat: &Weechat, _signal_name: &str, data: Option<SignalData>| {
    ///         if let Some(data) = data {
    ///             match data {
    ///                 SignalData::Buffer(buffer) => {
    ///                     buffer.print("Switched buffer")
    ///                 }
    ///                 _ => (),
    ///             }
    ///         }
    ///
    ///         ReturnCode::Ok
    ///     },
    /// );
    ///
    /// ```
    pub fn new(
        signal_name: &str,
        callback: impl SignalCallback + 'static,
    ) -> Result<Self, ()> {
        unsafe extern "C" fn c_hook_cb(
            pointer: *const c_void,
            _data: *mut c_void,
            signal_name: *const c_char,
            data_type: *const c_char,
            signal_data: *mut c_void,
        ) -> c_int {
            let hook_data: &mut SignalHookData =
                { &mut *(pointer as *mut SignalHookData) };
            let cb = &mut hook_data.callback;

            let data_type =
                CStr::from_ptr(data_type).to_str().unwrap_or_default();
            let signal_name =
                CStr::from_ptr(signal_name).to_str().unwrap_or_default();

            let weechat = Weechat::from_ptr(hook_data.weechat_ptr);
            let data = SignalData::from_type_and_name(
                &weechat,
                signal_name,
                data_type,
                signal_data,
            );

            cb.callback(&weechat, signal_name, data) as i32
        }

        Weechat::check_thread();
        let weechat = unsafe { Weechat::weechat() };

        let data = Box::new(SignalHookData {
            callback: Box::new(callback),
            weechat_ptr: weechat.ptr,
        });

        let data_ref = Box::leak(data);
        let hook_signal = weechat.get().hook_signal.unwrap();

        let signal_name = LossyCString::new(signal_name);

        let hook_ptr = unsafe {
            hook_signal(
                weechat.ptr,
                signal_name.as_ptr(),
                Some(c_hook_cb),
                data_ref as *const _ as *const c_void,
                ptr::null_mut(),
            )
        };

        let hook_data = unsafe { Box::from_raw(data_ref) };
        let hook = Hook {
            ptr: hook_ptr,
            weechat_ptr: weechat.ptr,
        };

        if hook_ptr.is_null() {
            Err(())
        } else {
            Ok(SignalHook {
                _hook: hook,
                _hook_data: hook_data,
            })
        }
    }
}

impl Weechat {
    /// Send a signal.
    ///
    /// This will send out a signal and callbacks that are registered with a
    /// `SignalHook` to listen to that signal wil get called.
    ///
    /// # Arguments
    ///
    /// * `signal_name` - The name of the signal that should be sent out. Common
    ///     signals can be found in the Weechat plugin API [reference].
    ///
    /// * `data` - Data that should be provided to the signal callback. This can
    ///     be a string, an i32 number, or a buffer.
    ///
    /// ```no_run
    /// # use weechat::Weechat;
    /// # use weechat::buffer::BufferSettings;
    /// # let buffer_handle = Weechat::buffer_new(BufferSettings::new("test"))
    /// #    .unwrap();
    /// # let buffer = buffer_handle.upgrade().unwrap();
    ///
    /// // Fetch the chat history for the buffer.
    /// Weechat::hook_signal_send("logger_backlog", buffer);
    ///
    /// // Signal that the input text changed.
    /// Weechat::hook_signal_send("input_text_changed", "");
    /// ```
    ///
    /// [reference]: https://weechat.org/files/doc/stable/weechat_plugin_api.en.html#_hook_signal_send
    pub fn hook_signal_send<'a, D: Into<SignalData<'a>>>(
        signal_name: &str,
        data: D,
    ) -> ReturnCode {
        Weechat::check_thread();
        let weechat = unsafe { Weechat::weechat() };

        let signal_name = LossyCString::new(signal_name);
        let signal_send = weechat.get().hook_signal_send.unwrap();
        let data = data.into();

        let ret = if let SignalData::String(string) = data {
            let string = LossyCString::new(string);
            unsafe {
                signal_send(
                    signal_name.as_ptr(),
                    weechat_sys::WEECHAT_HOOK_SIGNAL_STRING as *const _
                        as *const i8,
                    string.as_ptr() as *mut _,
                )
            }
        } else {
            let (ptr, data_type) = match data {
                SignalData::Integer(number) => (
                    number as *mut _,
                    weechat_sys::WEECHAT_HOOK_SIGNAL_INT as *const u8,
                ),
                SignalData::Buffer(buffer) => (
                    buffer.ptr() as *mut _,
                    weechat_sys::WEECHAT_HOOK_SIGNAL_POINTER as *const u8,
                ),
                SignalData::String(_) => unreachable!(),
            };
            unsafe {
                signal_send(signal_name.as_ptr(), data_type as *const i8, ptr)
            }
        };

        match ret {
            weechat_sys::WEECHAT_RC_OK => ReturnCode::Ok,
            weechat_sys::WEECHAT_RC_OK_EAT => ReturnCode::OkEat,
            weechat_sys::WEECHAT_RC_ERROR => ReturnCode::Error,
            _ => ReturnCode::Error,
        }
    }
}