// 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! {
    /// Context for expanding [`SnippetChunk`][crate::SnippetChunk].
    ///
    /// This class is currently used primary as a hashtable. However, the longer
    /// term goal is to have it hold onto a `GjsContext` as well as other languages
    /// so that [`SnippetChunk`][crate::SnippetChunk] can expand themselves by executing
    /// script within the context.
    ///
    /// The [`Snippet`][crate::Snippet] will build the context and then expand each of the
    /// chunks during the insertion/edit phase.
    ///
    /// ## Signals
    ///
    ///
    /// #### `changed`
    ///  The signal is emitted when a change has been
    /// discovered in one of the chunks of the snippet which has
    /// caused a variable or other dynamic data within the context
    /// to have changed.
    ///
    ///
    ///
    /// # Implements
    ///
    /// [`trait@glib::ObjectExt`]
    #[doc(alias = "GtkSourceSnippetContext")]
    pub struct SnippetContext(Object<ffi::GtkSourceSnippetContext, ffi::GtkSourceSnippetContextClass>);

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

impl SnippetContext {
    /// Creates a new #GtkSourceSnippetContext.
    ///
    /// Generally, this isn't needed unless you are controlling the
    /// expansion of snippets manually.
    ///
    /// # Returns
    ///
    /// a #GtkSourceSnippetContext
    #[doc(alias = "gtk_source_snippet_context_new")]
    pub fn new() -> SnippetContext {
        assert_initialized_main_thread!();
        unsafe { from_glib_full(ffi::gtk_source_snippet_context_new()) }
    }

    /// Removes all variables from the context.
    #[doc(alias = "gtk_source_snippet_context_clear_variables")]
    pub fn clear_variables(&self) {
        unsafe {
            ffi::gtk_source_snippet_context_clear_variables(self.to_glib_none().0);
        }
    }

    #[doc(alias = "gtk_source_snippet_context_expand")]
    pub fn expand(&self, input: &str) -> glib::GString {
        unsafe {
            from_glib_full(ffi::gtk_source_snippet_context_expand(
                self.to_glib_none().0,
                input.to_glib_none().0,
            ))
        }
    }

    /// Gets the current value for a variable named @key.
    /// ## `key`
    /// the name of the variable
    ///
    /// # Returns
    ///
    /// the value for the variable, or [`None`]
    #[doc(alias = "gtk_source_snippet_context_get_variable")]
    #[doc(alias = "get_variable")]
    pub fn variable(&self, key: &str) -> Option<glib::GString> {
        unsafe {
            from_glib_none(ffi::gtk_source_snippet_context_get_variable(
                self.to_glib_none().0,
                key.to_glib_none().0,
            ))
        }
    }

    /// Sets a constatnt within the context.
    ///
    /// This is similar to a variable set with [`set_variable()`][Self::set_variable()]
    /// but is expected to not change during use of the snippet.
    ///
    /// Examples would be the date or users name.
    /// ## `key`
    /// the constant name
    /// ## `value`
    /// the value of the constant
    #[doc(alias = "gtk_source_snippet_context_set_constant")]
    pub fn set_constant(&self, key: &str, value: &str) {
        unsafe {
            ffi::gtk_source_snippet_context_set_constant(
                self.to_glib_none().0,
                key.to_glib_none().0,
                value.to_glib_none().0,
            );
        }
    }

    #[doc(alias = "gtk_source_snippet_context_set_line_prefix")]
    pub fn set_line_prefix(&self, line_prefix: &str) {
        unsafe {
            ffi::gtk_source_snippet_context_set_line_prefix(
                self.to_glib_none().0,
                line_prefix.to_glib_none().0,
            );
        }
    }

    #[doc(alias = "gtk_source_snippet_context_set_tab_width")]
    pub fn set_tab_width(&self, tab_width: i32) {
        unsafe {
            ffi::gtk_source_snippet_context_set_tab_width(self.to_glib_none().0, tab_width);
        }
    }

    #[doc(alias = "gtk_source_snippet_context_set_use_spaces")]
    pub fn set_use_spaces(&self, use_spaces: bool) {
        unsafe {
            ffi::gtk_source_snippet_context_set_use_spaces(
                self.to_glib_none().0,
                use_spaces.into_glib(),
            );
        }
    }

    /// Sets a variable within the context.
    ///
    /// This variable may be overridden by future updates to the
    /// context.
    /// ## `key`
    /// the variable name
    /// ## `value`
    /// the value for the variable
    #[doc(alias = "gtk_source_snippet_context_set_variable")]
    pub fn set_variable(&self, key: &str, value: &str) {
        unsafe {
            ffi::gtk_source_snippet_context_set_variable(
                self.to_glib_none().0,
                key.to_glib_none().0,
                value.to_glib_none().0,
            );
        }
    }

    /// The signal is emitted when a change has been
    /// discovered in one of the chunks of the snippet which has
    /// caused a variable or other dynamic data within the context
    /// to have changed.
    #[doc(alias = "changed")]
    pub fn connect_changed<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn changed_trampoline<F: Fn(&SnippetContext) + 'static>(
            this: *mut ffi::GtkSourceSnippetContext,
            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"changed\0".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    changed_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }
}

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