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

use crate::Snippet;
use glib::object::Cast;
use glib::object::ObjectType as ObjectType_;
use glib::signal::connect_raw;
use glib::signal::SignalHandlerId;
use glib::translate::*;
use glib::StaticType;
use glib::ToValue;
use std::boxed::Box as Box_;
use std::fmt;
use std::mem::transmute;

glib::wrapper! {
    pub struct SnippetManager(Object<ffi::GtkSourceSnippetManager, ffi::GtkSourceSnippetManagerClass>);

    match fn {
        get_type => || ffi::gtk_source_snippet_manager_get_type(),
    }
}

impl SnippetManager {
    /// Gets the list directories where `self` looks for snippet files.
    ///
    /// Feature: `v5_0`
    ///
    ///
    /// # Returns
    ///
    /// `None`-terminated array
    ///  containing a list of snippet files directories.
    ///  The array is owned by `lm` and must not be modified.
    #[doc(alias = "gtk_source_snippet_manager_get_search_path")]
    pub fn get_search_path(&self) -> Vec<glib::GString> {
        unsafe {
            FromGlibPtrContainer::from_glib_none(ffi::gtk_source_snippet_manager_get_search_path(
                self.to_glib_none().0,
            ))
        }
    }

    /// Queries the known snippets for the first matching `group`, `language_id`,
    /// and/or `trigger`. If `group` or `language_id` are `None`, they will be ignored.
    ///
    /// Feature: `v5_0`
    ///
    /// ## `group`
    /// a group name or `None`
    /// ## `language_id`
    /// a `Language:id` or `None`
    /// ## `trigger`
    /// the trigger for the snippet
    ///
    /// # Returns
    ///
    /// a `Snippet` or `None` if no
    ///  matching snippet was found.
    #[doc(alias = "gtk_source_snippet_manager_get_snippet")]
    pub fn get_snippet(
        &self,
        group: Option<&str>,
        language_id: Option<&str>,
        trigger: &str,
    ) -> Option<Snippet> {
        unsafe {
            from_glib_full(ffi::gtk_source_snippet_manager_get_snippet(
                self.to_glib_none().0,
                group.to_glib_none().0,
                language_id.to_glib_none().0,
                trigger.to_glib_none().0,
            ))
        }
    }

    /// List all the known groups within the snippet manager.
    ///
    /// The result should be freed with `g_free`, and the individual strings are
    /// owned by `self` and should never be freed by the caller.
    ///
    /// Feature: `v5_0`
    ///
    ///
    /// # Returns
    ///
    ///
    ///  An array of strings which should be freed with `g_free`.
    #[doc(alias = "gtk_source_snippet_manager_list_groups")]
    pub fn list_groups(&self) -> Vec<glib::GString> {
        unsafe {
            FromGlibPtrContainer::from_glib_container(ffi::gtk_source_snippet_manager_list_groups(
                self.to_glib_none().0,
            ))
        }
    }

    /// Queries the known snippets for those matching `group`, `language_id`, and/or
    /// `trigger_prefix`. If any of these are `None`, they will be ignored when
    /// filtering the available snippets.
    ///
    /// The `gio::ListModel` only contains information about the available snippets until
    /// `gio::ListModel::get_item` is called for a specific snippet. This helps reduce
    /// the number of `glib::object::Object`'s that are created at runtime to those needed by
    /// the calling application.
    ///
    /// Feature: `v5_0`
    ///
    /// ## `group`
    /// a group name or `None`
    /// ## `language_id`
    /// a `Language:id` or `None`
    /// ## `trigger_prefix`
    /// a prefix for a trigger to activate
    ///
    /// # Returns
    ///
    /// a `gio::ListModel` of `Snippet`.
    #[doc(alias = "gtk_source_snippet_manager_list_matching")]
    pub fn list_matching(
        &self,
        group: Option<&str>,
        language_id: Option<&str>,
        trigger_prefix: Option<&str>,
    ) -> Option<gio::ListModel> {
        unsafe {
            from_glib_full(ffi::gtk_source_snippet_manager_list_matching(
                self.to_glib_none().0,
                group.to_glib_none().0,
                language_id.to_glib_none().0,
                trigger_prefix.to_glib_none().0,
            ))
        }
    }

    /// Sets the list of directories in which the ``GtkSourceSnippetManagerlooks`` for
    /// snippet files. If `dirs` is `None`, the search path is reset to default.
    ///
    /// `<note>`
    ///  `<para>`
    ///  At the moment this function can be called only before the
    ///  snippet files are loaded for the first time. In practice
    ///  to set a custom search path for a `SnippetManager`,
    ///  you have to call this function right after creating it.
    ///  `</para>`
    /// `</note>`
    ///
    /// Feature: `v5_0`
    ///
    /// ## `dirs`
    /// a `None`-terminated array of
    ///  strings or `None`.
    #[doc(alias = "gtk_source_snippet_manager_set_search_path")]
    pub fn set_search_path(&self, dirs: &[&str]) {
        unsafe {
            ffi::gtk_source_snippet_manager_set_search_path(
                self.to_glib_none().0,
                dirs.to_glib_none().0,
            );
        }
    }

    /// Returns the default `SnippetManager` instance.
    ///
    /// Feature: `v5_0`
    ///
    ///
    /// # Returns
    ///
    /// a `SnippetManager` which
    ///  is owned by `View` library and must not be unref'd.
    #[doc(alias = "gtk_source_snippet_manager_get_default")]
    pub fn get_default() -> Option<SnippetManager> {
        assert_initialized_main_thread!();
        unsafe { from_glib_none(ffi::gtk_source_snippet_manager_get_default()) }
    }

    #[cfg(any(feature = "v5_0", feature = "dox"))]
    #[cfg_attr(feature = "dox", doc(cfg(feature = "v5_0")))]
    pub fn connect_property_search_path_notify<F: Fn(&SnippetManager) + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId {
        unsafe extern "C" fn notify_search_path_trampoline<F: Fn(&SnippetManager) + 'static>(
            this: *mut ffi::GtkSourceSnippetManager,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(&from_glib_borrow(this))
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                b"notify::search-path\0".as_ptr() as *const _,
                Some(transmute::<_, unsafe extern "C" fn()>(
                    notify_search_path_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }
}

#[derive(Clone, Default)]
pub struct SnippetManagerBuilder {
    #[cfg(any(feature = "v5_0", feature = "dox"))]
    #[cfg_attr(feature = "dox", doc(cfg(feature = "v5_0")))]
    search_path: Option<Vec<String>>,
}

impl SnippetManagerBuilder {
    pub fn new() -> Self {
        Self::default()
    }

    pub fn build(self) -> SnippetManager {
        let mut properties: Vec<(&str, &dyn ToValue)> = vec![];
        #[cfg(any(feature = "v5_0", feature = "dox"))]
        if let Some(ref search_path) = self.search_path {
            properties.push(("search-path", search_path));
        }
        let ret = glib::Object::new::<SnippetManager>(&properties).expect("object new");
        ret
    }

    #[cfg(any(feature = "v5_0", feature = "dox"))]
    #[cfg_attr(feature = "dox", doc(cfg(feature = "v5_0")))]
    pub fn search_path(mut self, search_path: Vec<String>) -> Self {
        self.search_path = Some(search_path);
        self
    }
}

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