hexchat_unsafe_plugin/

list.rs

// This file is part of Hexchat Plugin API Bindings for Rust
// Copyright (C) 2022 Soni L.
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as
// published by the Free Software Foundation, either version 3 of the
// License, or (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program.  If not, see <https://www.gnu.org/licenses/>.

//! List support module.

use std::borrow::Cow;
use std::ffi::CStr;

use crate::Context;
use crate::wrap_context;

mod sealed {
    pub trait Sealed {
    }
}

/// A list. This trait is sealed.
pub trait List: sealed::Sealed {
    fn name(&self) -> Cow<'static, str>;
}

// List types

/// A "channels" list.
pub struct Contexts;

/// A "dcc" list.
pub struct Dcc;

/// An "ignore" list.
pub struct Ignore;

/// A "notify" list.
pub struct Notify;

/// An "users" list.
pub struct Users;

/// Entries.
pub struct Entries<'a, 'ph, T> {
    pub(crate) context: &'a crate::PluginHandle<'ph>,
    pub(crate) list: *mut crate::internals::HexchatList,
    pub(crate) t: &'a T,
}

/// Fields.
pub struct Fields<'a, 'ph, T> {
    pub(crate) context: &'a crate::PluginHandle<'ph>,
    pub(crate) list: *mut crate::internals::HexchatList,
    pub(crate) _t: &'a T,
}

// impls

impl sealed::Sealed for Contexts {}
impl sealed::Sealed for Dcc {}
impl sealed::Sealed for Ignore {}
impl sealed::Sealed for Notify {}
impl sealed::Sealed for Users {}

impl List for Contexts {
    fn name(&self) -> Cow<'static, str> { "channels".into() }
}

impl List for Dcc {
    fn name(&self) -> Cow<'static, str> { "dcc".into() }
}

impl List for Ignore {
    fn name(&self) -> Cow<'static, str> { "ignore".into() }
}

impl List for Notify {
    fn name(&self) -> Cow<'static, str> { "notify".into() }
}

impl List for Users {
    fn name(&self) -> Cow<'static, str> { "users".into() }
}

impl<'a, 'ph, T> Drop for Entries<'a, 'ph, T> {
    fn drop(&mut self) {
        let ph = &self.context;
        unsafe {
            ph_call!(hexchat_list_free(ph, self.list));
        }
    }
}

impl<'a, 'ph, T> Entries<'a, 'ph, T> {
    /// Returns the next entry on the list, if any.
    pub fn next<'b>(&'b mut self) -> Option<Fields<'b, 'ph, T>> where 'a: 'b {
        let ph = &self.context;
        if unsafe {
            ph_call!(hexchat_list_next(ph, self.list))
        } != 0 {
            Some(Fields {
                context: self.context,
                list: self.list,
                _t: self.t,
            })
        } else {
            None
        }
    }
}

macro_rules! field {
    ($(#[$m:meta])* $f:ident, unsafe {$n:expr}, $r:ty, $ph:ident, $c:ident, $($conv:tt)+) => {
        $(#[$m])* pub fn $f(&self) -> $r {
            let $ph = &self.context;
            const NAME: &'static CStr = unsafe {
                CStr::from_bytes_with_nul_unchecked(
                    $n.as_bytes()
                )
            };
            match unsafe {
                ph_call!($c($ph, self.list, NAME.as_ptr()))
            } {
                $($conv)+
            }
        }
    };
    ($(#[$m:meta])* $f:ident, $r:ty, $ph:ident, $c:ident, $($conv:tt)+) => {
        field!(
            $(#[$m])* $f,
            unsafe { ::std::concat!(::std::stringify!($f), "\0") },
            $r,
            $ph,
            $c,
            $($conv)+
        );
    };
}

macro_rules! field_int {
    ($(#[$m:meta])* $f:ident, unsafe { $n:expr }) => {
        field!($(#[$m])* $f, unsafe { $n }, i32, ph, hexchat_list_int, r => r as i32);
    };
    ($(#[$m:meta])* $f:ident) => {
        field_int!($(#[$m])* $f, unsafe { ::std::concat!(::std::stringify!($f), "\0") });
    };
}

macro_rules! field_bool {
    ($(#[$m:meta])* $f:ident, unsafe { $n:expr }) => {
        field!($(#[$m])* $f, unsafe { $n }, bool, ph, hexchat_list_int, r => r != 0);
    };
    ($(#[$m:meta])* $f:ident) => {
        field_bool!($(#[$m])* $f, unsafe { ::std::concat!(::std::stringify!($f), "\0") });
    };
}

macro_rules! field_str {
    ($(#[$m:meta])* $f:ident, unsafe { $n:expr }) => {
        field!(
            $(#[$m])* $f, unsafe { $n }, Option<String>, ph, hexchat_list_str,
            r if r.is_null() => {
                None
            },
            r => Some(unsafe {
                CStr::from_ptr(r)
            }.to_owned().into_string().unwrap())
        );
    };
    ($(#[$m:meta])* $f:ident) => {
        field_str!($(#[$m])* $f, unsafe { ::std::concat!(::std::stringify!($f), "\0") });
    };
}


macro_rules! field_time {
    ($(#[$m:meta])* $f:ident, unsafe { $n:expr }) => {
        field!($(#[$m])* $f, unsafe { $n }, libc::time_t, ph, hexchat_list_time, r => r as libc::time_t);
    };
    ($(#[$m:meta])* $f:ident) => {
        field_time!($(#[$m])* $f, unsafe { ::std::concat!(::std::stringify!($f), "\0") });
    };
}

/// Contexts fields.
impl<'a, 'ph> Fields<'a, 'ph, Contexts> {
    field_str!(
        /// The context's name.
        name, unsafe { "channel\0" }
    );
    field_str!(
        /// The channel key.
        channelkey
    );
    field_str!(
        /// The server's channel modes. Requires HexChat 2.12.2+.
        chanmodes
    );
    field_str!(
        /// The server's channel types.
        chantypes
    );
    field!(
        /// The context.
        context, Context<'ph>, ph, hexchat_list_str, r => unsafe {
            wrap_context(ph, r as *const _)
        }
    );
    field_int!(
        /// Raw flags about this context.
        raw_flags, unsafe { "flags\0" }
    );
    field_int!(
        /// The server ID.
        server_id, unsafe { "id\0" }
    );
    field_int!(
        /// The latency to server in milliseconds.
        lag
    );
    field_int!(
        /// The maximum number of mode changes per line accepted by the server.
        maxmodes
    );
    field_str!(
        /// The network name.
        network
    );
    field_str!(
        /// The server's nick prefixes.
        nickprefixes
    );
    field_str!(
        /// The server's nick modes.
        nickmodes
    );
    field_int!(
        /// The current length of the send-queue, in bytes.
        queue_len, unsafe { "queue\0" }
    );
    field_str!(
        /// The server's name.
        server
    );
    field_int!(
        /// The context's raw type.
        raw_type, unsafe { "type\0" }
    );
    field_int!(
        /// The number of users in the channel.
        users
    );
}

/// Dcc fields.
impl<'a, 'ph> Fields<'a, 'ph, Dcc> {
    field_int!(
        /// The raw 32-bit IPv4 address of the remote user.
        address32
    );
    field_int!(
        /// The transfer rate (speed), in bytes per second.
        rate, unsafe { "cps\0" }
    );
    field_str!(
        /// The destination file path.
        destfile
    );
    field_str!(
        /// The filename.
        file
    );
    field_str!(
        /// The remote user's nick.
        nick
    );
    field_int!(
        /// The listener's port number.
        port
    );
    field_int!(
        /// File position, LSB 32 bits.
        raw_pos, unsafe { "pos\0" }
    );
    field_int!(
        /// File position, MSB 32 bits.
        raw_poshigh, unsafe { "poshigh\0" }
    );
    field_int!(
        /// Resumed position, LSB 32 bits.
        raw_resume, unsafe { "resume\0" }
    );
    field_int!(
        /// Resumed position, MSB 32 bits.
        raw_resumehigh, unsafe { "resumehigh\0" }
    );
    field_int!(
        /// File size, LSB 32 bits.
        raw_size, unsafe { "size\0" }
    );
    field_int!(
        /// File size, MSB 32 bits.
        raw_sizehigh, unsafe { "sizehigh\0" }
    );
    field_int!(
        /// Raw DCC status.
        raw_status, unsafe { "status\0" }
    );
    field_int!(
        /// Raw type.
        raw_type, unsafe { "type\0" }
    );
}

/// Ignore fields.
impl<'a, 'ph> Fields<'a, 'ph, Ignore> {
    field_str!(
        /// The ignore mask.
        mask
    );
    field_int!(
        /// Raw ignore flags.
        raw_flags, unsafe { "flags\0" }
    );
}

/// Notify fields.
impl<'a, 'ph> Fields<'a, 'ph, Notify> {
    field_str!(
        /// Comma-separated list of networks this notify entry applies to.
        networks
    );
    field_str!(
        /// The nick.
        nick
    );
    field_int!(
        /// Raw flags.
        raw_flags, unsafe { "flags\0" }
    );
    field_time!(
        /// Time when the user went online.
        raw_on, unsafe { "on\0" }
    );
    field_time!(
        /// Time when the user went offline.
        raw_off, unsafe { "off\0" }
    );
    field_time!(
        /// Time when the user was last seen.
        raw_seen, unsafe { "seen\0" }
    );
}

/// Users fields.
impl<'a, 'ph> Fields<'a, 'ph, Users> {
    field_str!(
        /// Account name.
        account
    );
    field_bool!(
        /// Whether the user is away.
        away
    );
    field_time!(
        /// Time when the user last talked.
        raw_lasttalk, unsafe { "lasttalk\0" }
    );
    field_str!(
        /// User's nick.
        nick
    );
    field_str!(
        /// User's user and hostname (`user@host`).
        host
    );
    field_str!(
        /// User's prefix.
        prefix
    );
    field_str!(
        /// User's userdata.
        userdata, unsafe { "realname\0" }
    );
    field_bool!(
        /// Whether the user is selected in the UI.
        selected
    );
}