// This file was generated by gir (https://github.com/gtk-rs/gir)
// from gir-files (https://github.com/gtk-rs/gir-files)
// DO NOT EDIT

use crate::{Buildable, TextTag};
use glib::{
    prelude::*,
    signal::{connect_raw, SignalHandlerId},
    translate::*,
};
use std::{boxed::Box as Box_, fmt, mem::transmute};

glib::wrapper! {
    /// The collection of tags in a [`TextBuffer`][crate::TextBuffer]
    ///
    /// You may wish to begin by reading the
    /// [text widget conceptual overview](section-text-widget.html),
    /// which gives an overview of all the objects and data types
    /// related to the text widget and how they work together.
    ///
    /// # GtkTextTagTables as GtkBuildable
    ///
    /// The [`TextTagTable`][crate::TextTagTable] implementation of the [`Buildable`][crate::Buildable] interface
    /// supports adding tags by specifying “tag” as the “type” attribute
    /// of a `<child>` element.
    ///
    /// An example of a UI definition fragment specifying tags:
    /// ```xml
    /// <object class="GtkTextTagTable">
    ///  <child type="tag">
    ///    <object class="GtkTextTag"/>
    ///  </child>
    /// </object>
    /// ```
    ///
    /// ## Signals
    ///
    ///
    /// #### `tag-added`
    ///  Emitted every time a new tag is added in the [`TextTagTable`][crate::TextTagTable].
    ///
    ///
    ///
    ///
    /// #### `tag-changed`
    ///  Emitted every time a tag in the [`TextTagTable`][crate::TextTagTable] changes.
    ///
    ///
    ///
    ///
    /// #### `tag-removed`
    ///  Emitted every time a tag is removed from the [`TextTagTable`][crate::TextTagTable].
    ///
    /// The @tag is still valid by the time the signal is emitted, but
    /// it is not associated with a tag table any more.
    ///
    ///
    ///
    /// # Implements
    ///
    /// [`trait@glib::ObjectExt`], [`BuildableExt`][trait@crate::prelude::BuildableExt]
    #[doc(alias = "GtkTextTagTable")]
    pub struct TextTagTable(Object<ffi::GtkTextTagTable>) @implements Buildable;

    match fn {
        type_ => || ffi::gtk_text_tag_table_get_type(),
    }
}

impl TextTagTable {
    /// Creates a new [`TextTagTable`][crate::TextTagTable].
    ///
    /// The table contains no tags by default.
    ///
    /// # Returns
    ///
    /// a new [`TextTagTable`][crate::TextTagTable]
    #[doc(alias = "gtk_text_tag_table_new")]
    pub fn new() -> TextTagTable {
        assert_initialized_main_thread!();
        unsafe { from_glib_full(ffi::gtk_text_tag_table_new()) }
    }

    /// Add a tag to the table.
    ///
    /// The tag is assigned the highest priority in the table.
    ///
    /// @tag must not be in a tag table already, and may not have
    /// the same name as an already-added tag.
    /// ## `tag`
    /// a [`TextTag`][crate::TextTag]
    ///
    /// # Returns
    ///
    /// [`true`] on success.
    #[doc(alias = "gtk_text_tag_table_add")]
    pub fn add(&self, tag: &impl IsA<TextTag>) -> bool {
        unsafe {
            from_glib(ffi::gtk_text_tag_table_add(
                self.to_glib_none().0,
                tag.as_ref().to_glib_none().0,
            ))
        }
    }

    /// Calls @func on each tag in @self, with user data @data.
    ///
    /// Note that the table may not be modified while iterating
    /// over it (you can’t add/remove tags).
    /// ## `func`
    /// a function to call on each tag
    #[doc(alias = "gtk_text_tag_table_foreach")]
    pub fn foreach<P: FnMut(&TextTag)>(&self, func: P) {
        let func_data: P = func;
        unsafe extern "C" fn func_func<P: FnMut(&TextTag)>(
            tag: *mut ffi::GtkTextTag,
            data: glib::ffi::gpointer,
        ) {
            let tag = from_glib_borrow(tag);
            let callback: *mut P = data as *const _ as usize as *mut P;
            (*callback)(&tag)
        }
        let func = Some(func_func::<P> as _);
        let super_callback0: &P = &func_data;
        unsafe {
            ffi::gtk_text_tag_table_foreach(
                self.to_glib_none().0,
                func,
                super_callback0 as *const _ as usize as *mut _,
            );
        }
    }

    /// Returns the size of the table (number of tags)
    ///
    /// # Returns
    ///
    /// number of tags in @self
    #[doc(alias = "gtk_text_tag_table_get_size")]
    #[doc(alias = "get_size")]
    pub fn size(&self) -> i32 {
        unsafe { ffi::gtk_text_tag_table_get_size(self.to_glib_none().0) }
    }

    /// Look up a named tag.
    /// ## `name`
    /// name of a tag
    ///
    /// # Returns
    ///
    /// The tag
    #[doc(alias = "gtk_text_tag_table_lookup")]
    pub fn lookup(&self, name: &str) -> Option<TextTag> {
        unsafe {
            from_glib_none(ffi::gtk_text_tag_table_lookup(
                self.to_glib_none().0,
                name.to_glib_none().0,
            ))
        }
    }

    /// Remove a tag from the table.
    ///
    /// If a [`TextBuffer`][crate::TextBuffer] has @self as its tag table, the tag is
    /// removed from the buffer. The table’s reference to the tag is
    /// removed, so the tag will end up destroyed if you don’t have
    /// a reference to it.
    /// ## `tag`
    /// a [`TextTag`][crate::TextTag]
    #[doc(alias = "gtk_text_tag_table_remove")]
    pub fn remove(&self, tag: &impl IsA<TextTag>) {
        unsafe {
            ffi::gtk_text_tag_table_remove(self.to_glib_none().0, tag.as_ref().to_glib_none().0);
        }
    }

    /// Emitted every time a new tag is added in the [`TextTagTable`][crate::TextTagTable].
    /// ## `tag`
    /// the added tag.
    #[doc(alias = "tag-added")]
    pub fn connect_tag_added<F: Fn(&Self, &TextTag) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn tag_added_trampoline<F: Fn(&TextTagTable, &TextTag) + 'static>(
            this: *mut ffi::GtkTextTagTable,
            tag: *mut ffi::GtkTextTag,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(&from_glib_borrow(this), &from_glib_borrow(tag))
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                b"tag-added\0".as_ptr() as *const _,
                Some(transmute::<_, unsafe extern "C" fn()>(
                    tag_added_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    /// Emitted every time a tag in the [`TextTagTable`][crate::TextTagTable] changes.
    /// ## `tag`
    /// the changed tag.
    /// ## `size_changed`
    /// whether the change affects the [`TextView`][crate::TextView] layout.
    #[doc(alias = "tag-changed")]
    pub fn connect_tag_changed<F: Fn(&Self, &TextTag, bool) + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId {
        unsafe extern "C" fn tag_changed_trampoline<
            F: Fn(&TextTagTable, &TextTag, bool) + 'static,
        >(
            this: *mut ffi::GtkTextTagTable,
            tag: *mut ffi::GtkTextTag,
            size_changed: glib::ffi::gboolean,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(
                &from_glib_borrow(this),
                &from_glib_borrow(tag),
                from_glib(size_changed),
            )
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                b"tag-changed\0".as_ptr() as *const _,
                Some(transmute::<_, unsafe extern "C" fn()>(
                    tag_changed_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    /// Emitted every time a tag is removed from the [`TextTagTable`][crate::TextTagTable].
    ///
    /// The @tag is still valid by the time the signal is emitted, but
    /// it is not associated with a tag table any more.
    /// ## `tag`
    /// the removed tag.
    #[doc(alias = "tag-removed")]
    pub fn connect_tag_removed<F: Fn(&Self, &TextTag) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn tag_removed_trampoline<F: Fn(&TextTagTable, &TextTag) + 'static>(
            this: *mut ffi::GtkTextTagTable,
            tag: *mut ffi::GtkTextTag,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(&from_glib_borrow(this), &from_glib_borrow(tag))
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                b"tag-removed\0".as_ptr() as *const _,
                Some(transmute::<_, unsafe extern "C" fn()>(
                    tag_removed_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }
}

impl Default for TextTagTable {
    fn default() -> Self {
        Self::new()
    }
}

impl fmt::Display for TextTagTable {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        f.write_str("TextTagTable")
    }
}