// 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;
use glib::{
    prelude::*,
    signal::{connect_raw, SignalHandlerId},
    translate::*,
};
use std::boxed::Box as Box_;

glib::wrapper! {
    /// Represents a syntax highlighted language.
    ///
    /// A [`Language`][crate::Language] represents a programming or markup language, affecting
    /// syntax highlighting and [context classes](./class.Buffer.html#context-classes).
    ///
    /// Use [`LanguageManager`][crate::LanguageManager] to obtain a [`Language`][crate::Language] instance, and
    /// [`BufferExt::set_language()`][crate::prelude::BufferExt::set_language()] to apply it to a [`Buffer`][crate::Buffer].
    ///
    /// ## Properties
    ///
    ///
    /// #### `hidden`
    ///  Readable
    ///
    ///
    /// #### `id`
    ///  Readable
    ///
    ///
    /// #### `name`
    ///  Readable
    ///
    ///
    /// #### `section`
    ///  Readable
    ///
    /// # Implements
    ///
    /// [`trait@glib::ObjectExt`]
    #[doc(alias = "GtkSourceLanguage")]
    pub struct Language(Object<ffi::GtkSourceLanguage, ffi::GtkSourceLanguageClass>);

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

impl Language {
    /// Returns the globs associated to this language.
    ///
    /// This is just an utility wrapper around [`metadata()`][Self::metadata()] to
    /// retrieve the "globs" metadata property and split it into an array.
    ///
    /// # Returns
    ///
    ///
    /// a newly-allocated [`None`] terminated array containing the globs or [`None`]
    /// if no globs are found.
    /// The returned array must be freed with g_strfreev().
    #[doc(alias = "gtk_source_language_get_globs")]
    #[doc(alias = "get_globs")]
    pub fn globs(&self) -> Vec<glib::GString> {
        unsafe {
            FromGlibPtrContainer::from_glib_full(ffi::gtk_source_language_get_globs(
                self.to_glib_none().0,
            ))
        }
    }

    /// Returns whether the language should be hidden from the user.
    ///
    /// # Returns
    ///
    /// [`true`] if the language should be hidden, [`false`] otherwise.
    #[doc(alias = "gtk_source_language_get_hidden")]
    #[doc(alias = "get_hidden")]
    #[doc(alias = "hidden")]
    pub fn is_hidden(&self) -> bool {
        unsafe { from_glib(ffi::gtk_source_language_get_hidden(self.to_glib_none().0)) }
    }

    /// Returns the ID of the language.
    ///
    /// The ID is not locale-dependent.The returned string is owned by @self
    /// and should not be freed or modified.
    ///
    /// # Returns
    ///
    /// the ID of @self.
    #[doc(alias = "gtk_source_language_get_id")]
    #[doc(alias = "get_id")]
    pub fn id(&self) -> glib::GString {
        unsafe { from_glib_none(ffi::gtk_source_language_get_id(self.to_glib_none().0)) }
    }

    /// ## `name`
    /// metadata property name.
    ///
    /// # Returns
    ///
    /// value of property @name stored in
    /// the metadata of @self or [`None`] if language does not contain the
    /// specified metadata property.
    /// The returned string is owned by @self and should not be freed
    /// or modified.
    #[doc(alias = "gtk_source_language_get_metadata")]
    #[doc(alias = "get_metadata")]
    pub fn metadata(&self, name: &str) -> Option<glib::GString> {
        unsafe {
            from_glib_none(ffi::gtk_source_language_get_metadata(
                self.to_glib_none().0,
                name.to_glib_none().0,
            ))
        }
    }

    /// Returns the mime types associated to this language.
    ///
    /// This is just an utility wrapper around [`metadata()`][Self::metadata()] to
    /// retrieve the "mimetypes" metadata property and split it into an
    /// array.
    ///
    /// # Returns
    ///
    ///
    /// a newly-allocated [`None`] terminated array containing the mime types
    /// or [`None`] if no mime types are found.
    /// The returned array must be freed with g_strfreev().
    #[doc(alias = "gtk_source_language_get_mime_types")]
    #[doc(alias = "get_mime_types")]
    pub fn mime_types(&self) -> Vec<glib::GString> {
        unsafe {
            FromGlibPtrContainer::from_glib_full(ffi::gtk_source_language_get_mime_types(
                self.to_glib_none().0,
            ))
        }
    }

    /// Returns the localized name of the language.
    ///
    /// The returned string is owned by @self and should not be freed
    /// or modified.
    ///
    /// # Returns
    ///
    /// the name of @self.
    #[doc(alias = "gtk_source_language_get_name")]
    #[doc(alias = "get_name")]
    pub fn name(&self) -> glib::GString {
        unsafe { from_glib_none(ffi::gtk_source_language_get_name(self.to_glib_none().0)) }
    }

    /// Returns the localized section of the language.
    ///
    /// Each language belong to a section (ex. HTML belongs to the
    /// Markup section).
    /// The returned string is owned by @self and should not be freed
    /// or modified.
    ///
    /// # Returns
    ///
    /// the section of @self.
    #[doc(alias = "gtk_source_language_get_section")]
    #[doc(alias = "get_section")]
    pub fn section(&self) -> glib::GString {
        unsafe { from_glib_none(ffi::gtk_source_language_get_section(self.to_glib_none().0)) }
    }

    /// Returns the ID of the style to use if the specified @style_id
    /// is not present in the current style scheme.
    /// ## `style_id`
    /// a style ID.
    ///
    /// # Returns
    ///
    /// the ID of the style to use if the
    /// specified @style_id is not present in the current style scheme or [`None`]
    /// if the style has no fallback defined.
    /// The returned string is owned by the @self and must not be modified.
    #[doc(alias = "gtk_source_language_get_style_fallback")]
    #[doc(alias = "get_style_fallback")]
    pub fn style_fallback(&self, style_id: &str) -> Option<glib::GString> {
        unsafe {
            from_glib_none(ffi::gtk_source_language_get_style_fallback(
                self.to_glib_none().0,
                style_id.to_glib_none().0,
            ))
        }
    }

    /// Returns the ids of the styles defined by this @self.
    ///
    /// # Returns
    ///
    ///
    /// a newly-allocated [`None`] terminated array containing ids of the
    /// styles defined by this @self or [`None`] if no style is defined.
    /// The returned array must be freed with g_strfreev().
    #[doc(alias = "gtk_source_language_get_style_ids")]
    #[doc(alias = "get_style_ids")]
    pub fn style_ids(&self) -> Vec<glib::GString> {
        unsafe {
            FromGlibPtrContainer::from_glib_full(ffi::gtk_source_language_get_style_ids(
                self.to_glib_none().0,
            ))
        }
    }

    /// Returns the name of the style with ID @style_id defined by this @self.
    /// ## `style_id`
    /// a style ID.
    ///
    /// # Returns
    ///
    /// the name of the style with ID @style_id
    /// defined by this @self or [`None`] if the style has no name or there is no
    /// style with ID @style_id defined by this @self.
    /// The returned string is owned by the @self and must not be modified.
    #[doc(alias = "gtk_source_language_get_style_name")]
    #[doc(alias = "get_style_name")]
    pub fn style_name(&self, style_id: &str) -> Option<glib::GString> {
        unsafe {
            from_glib_none(ffi::gtk_source_language_get_style_name(
                self.to_glib_none().0,
                style_id.to_glib_none().0,
            ))
        }
    }

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

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

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

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

impl std::fmt::Display for Language {
    #[inline]
    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
        f.write_str(&self.name())
    }
}