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

use crate::{ffi, Language};
use glib::{
    prelude::*,
    signal::{connect_raw, SignalHandlerId},
    translate::*,
};
use std::boxed::Box as Box_;

glib::wrapper! {
    /// Provides access to [`Language`][crate::Language]s.
    ///
    /// [`LanguageManager`][crate::LanguageManager] is an object which processes language description
    /// files and creates and stores [`Language`][crate::Language] objects, and provides API to
    /// access them.
    ///
    /// Use `get_default()` to retrieve the default
    /// instance of [`LanguageManager`][crate::LanguageManager], and
    /// [`guess_language()`][Self::guess_language()] to get a [`Language`][crate::Language] for
    /// given file name and content type.
    ///
    /// ## Properties
    ///
    ///
    /// #### `language-ids`
    ///  Readable
    ///
    ///
    /// #### `search-path`
    ///  Readable | Writeable
    ///
    /// # Implements
    ///
    /// [`trait@glib::ObjectExt`]
    #[doc(alias = "GtkSourceLanguageManager")]
    pub struct LanguageManager(Object<ffi::GtkSourceLanguageManager, ffi::GtkSourceLanguageManagerClass>);

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

impl LanguageManager {
    /// Creates a new language manager.
    ///
    /// If you do not need more than one language manager or a private language manager
    /// instance then use `get_default()` instead.
    ///
    /// # Returns
    ///
    /// a new #GtkSourceLanguageManager.
    #[doc(alias = "gtk_source_language_manager_new")]
    pub fn new() -> LanguageManager {
        assert_initialized_main_thread!();
        unsafe { from_glib_full(ffi::gtk_source_language_manager_new()) }
    }

    // rustdoc-stripper-ignore-next
    /// Creates a new builder-pattern struct instance to construct [`LanguageManager`] objects.
    ///
    /// This method returns an instance of [`LanguageManagerBuilder`](crate::builders::LanguageManagerBuilder) which can be used to create [`LanguageManager`] objects.
    pub fn builder() -> LanguageManagerBuilder {
        LanguageManagerBuilder::new()
    }

    /// Appends @path to the list of directories where the @manager looks for
    /// language files.
    ///
    /// See [`set_search_path()`][Self::set_search_path()] for details.
    /// ## `path`
    /// a directory or a filename.
    #[cfg(feature = "v5_4")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v5_4")))]
    #[doc(alias = "gtk_source_language_manager_append_search_path")]
    pub fn append_search_path(&self, path: &str) {
        unsafe {
            ffi::gtk_source_language_manager_append_search_path(
                self.to_glib_none().0,
                path.to_glib_none().0,
            );
        }
    }

    /// Gets the [`Language`][crate::Language] identified by the given @id in the language
    /// manager.
    /// ## `id`
    /// a language id.
    ///
    /// # Returns
    ///
    /// a #GtkSourceLanguage, or [`None`]
    /// if there is no language identified by the given @id. Return value is
    /// owned by @self and should not be freed.
    #[doc(alias = "gtk_source_language_manager_get_language")]
    #[doc(alias = "get_language")]
    pub fn language(&self, id: &str) -> Option<Language> {
        unsafe {
            from_glib_none(ffi::gtk_source_language_manager_get_language(
                self.to_glib_none().0,
                id.to_glib_none().0,
            ))
        }
    }

    /// Returns the ids of the available languages.
    ///
    /// # Returns
    ///
    ///
    /// a [`None`]-terminated array of strings containing the ids of the available
    /// languages or [`None`] if no language is available.
    /// The array is sorted alphabetically according to the language name.
    /// The array is owned by @self and must not be modified.
    #[doc(alias = "gtk_source_language_manager_get_language_ids")]
    #[doc(alias = "get_language_ids")]
    #[doc(alias = "language-ids")]
    pub fn language_ids(&self) -> Vec<glib::GString> {
        unsafe {
            FromGlibPtrContainer::from_glib_none(ffi::gtk_source_language_manager_get_language_ids(
                self.to_glib_none().0,
            ))
        }
    }

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

    /// Picks a [`Language`][crate::Language] for given file name and content type,
    /// according to the information in lang files.
    ///
    /// Either @filename or @content_type may be [`None`]. This function can be used as follows:
    ///
    /// **⚠️ The following code is in c ⚠️**
    ///
    /// ```c
    /// GtkSourceLanguage *lang;
    /// GtkSourceLanguageManager *manager;
    /// lm = gtk_source_language_manager_get_default ();
    /// lang = gtk_source_language_manager_guess_language (manager, filename, NULL);
    /// gtk_source_buffer_set_language (buffer, lang);
    /// ```
    ///
    /// or
    ///
    /// **⚠️ The following code is in c ⚠️**
    ///
    /// ```c
    /// GtkSourceLanguage *lang = NULL;
    /// GtkSourceLanguageManager *manager;
    /// gboolean result_uncertain;
    /// gchar *content_type;
    ///
    /// content_type = g_content_type_guess (filename, NULL, 0, &result_uncertain);
    /// if (result_uncertain)
    ///   {
    ///     g_free (content_type);
    ///     content_type = NULL;
    ///   }
    ///
    /// manager = gtk_source_language_manager_get_default ();
    /// lang = gtk_source_language_manager_guess_language (manager, filename, content_type);
    /// gtk_source_buffer_set_language (buffer, lang);
    ///
    /// g_free (content_type);
    /// ```
    ///
    /// etc. Use [`Language::mime_types()`][crate::Language::mime_types()] and [`Language::globs()`][crate::Language::globs()]
    /// if you need full control over file -> language mapping.
    /// ## `filename`
    /// a filename in Glib filename encoding, or [`None`].
    /// ## `content_type`
    /// a content type (as in GIO API), or [`None`].
    ///
    /// # Returns
    ///
    /// a #GtkSourceLanguage, or [`None`] if there
    /// is no suitable language for given @filename and/or @content_type. Return
    /// value is owned by @self and should not be freed.
    #[doc(alias = "gtk_source_language_manager_guess_language")]
    pub fn guess_language(
        &self,
        filename: Option<impl AsRef<std::path::Path>>,
        content_type: Option<&str>,
    ) -> Option<Language> {
        unsafe {
            from_glib_none(ffi::gtk_source_language_manager_guess_language(
                self.to_glib_none().0,
                filename.as_ref().map(|p| p.as_ref()).to_glib_none().0,
                content_type.to_glib_none().0,
            ))
        }
    }

    /// Prepends @path to the list of directories where the @manager looks
    /// for language files.
    ///
    /// See [`set_search_path()`][Self::set_search_path()] for details.
    /// ## `path`
    /// a directory or a filename.
    #[cfg(feature = "v5_4")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v5_4")))]
    #[doc(alias = "gtk_source_language_manager_prepend_search_path")]
    pub fn prepend_search_path(&self, path: &str) {
        unsafe {
            ffi::gtk_source_language_manager_prepend_search_path(
                self.to_glib_none().0,
                path.to_glib_none().0,
            );
        }
    }

    /// Sets the list of directories where the @self looks for
    /// language files.
    ///
    /// If @dirs is [`None`], the search path is reset to default.
    ///
    /// At the moment this function can be called only before the
    /// language files are loaded for the first time. In practice
    /// to set a custom search path for a [`LanguageManager`][crate::LanguageManager],
    /// you have to call this function right after creating it.
    ///
    /// Since GtkSourceView 5.4 this function will allow you to provide
    /// paths in the form of "resource:///" URIs to embedded `GResource`s.
    /// They must contain the path of a directory within the `GResource`.
    /// ## `dirs`
    /// a [`None`]-terminated array of
    ///   strings or [`None`].
    #[doc(alias = "gtk_source_language_manager_set_search_path")]
    #[doc(alias = "search-path")]
    pub fn set_search_path(&self, dirs: &[&str]) {
        unsafe {
            ffi::gtk_source_language_manager_set_search_path(
                self.to_glib_none().0,
                dirs.to_glib_none().0,
            );
        }
    }

    /// Returns the default #GtkSourceLanguageManager instance.
    ///
    /// # Returns
    ///
    /// a #GtkSourceLanguageManager.
    /// Return value is owned by GtkSourceView library and must not be unref'ed.
    #[doc(alias = "gtk_source_language_manager_get_default")]
    #[doc(alias = "get_default")]
    #[allow(clippy::should_implement_trait)]
    pub fn default() -> LanguageManager {
        assert_initialized_main_thread!();
        unsafe { from_glib_none(ffi::gtk_source_language_manager_get_default()) }
    }

    #[doc(alias = "language-ids")]
    pub fn connect_language_ids_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_language_ids_trampoline<F: Fn(&LanguageManager) + 'static>(
            this: *mut ffi::GtkSourceLanguageManager,
            _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::language-ids\0".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_language_ids_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "search-path")]
    pub fn connect_search_path_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_search_path_trampoline<F: Fn(&LanguageManager) + 'static>(
            this: *mut ffi::GtkSourceLanguageManager,
            _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(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_search_path_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }
}

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

// rustdoc-stripper-ignore-next
/// A [builder-pattern] type to construct [`LanguageManager`] objects.
///
/// [builder-pattern]: https://doc.rust-lang.org/1.0.0/style/ownership/builders.html
#[must_use = "The builder must be built to be used"]
pub struct LanguageManagerBuilder {
    builder: glib::object::ObjectBuilder<'static, LanguageManager>,
}

impl LanguageManagerBuilder {
    fn new() -> Self {
        Self {
            builder: glib::object::Object::builder(),
        }
    }

    pub fn search_path(self, search_path: impl Into<glib::StrV>) -> Self {
        Self {
            builder: self.builder.property("search-path", search_path.into()),
        }
    }

    // rustdoc-stripper-ignore-next
    /// Build the [`LanguageManager`].
    #[must_use = "Building the object from the builder is usually expensive and is not expected to have side effects"]
    pub fn build(self) -> LanguageManager {
        self.builder.build()
    }
}