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

glib::wrapper! {
    /// The context of a completion.
    ///
    /// [`CompletionContext`][crate::CompletionContext] contains information about an attept to display
    /// completion proposals to the user based on typed text in the [`View`][crate::View].
    ///
    /// When typing, [`Completion`][crate::Completion] may use registered
    /// [`CompletionProvider`][crate::CompletionProvider] to determine if there may be results which
    /// could be displayed. If so, a [`CompletionContext`][crate::CompletionContext] is created with
    /// information that is provided to the [`CompletionProvider`][crate::CompletionProvider] to populate
    /// results which might be useful to the user.
    ///
    /// [`CompletionProvider`][crate::CompletionProvider] are expected to provide [`gio::ListModel`][crate::gio::ListModel] with
    /// [`CompletionProposal`][crate::CompletionProposal] which may be joined together in a list of
    /// results for the user. They are also responsible for how the contents are
    /// displayed using [`CompletionCell`][crate::CompletionCell] which allows for some level of
    /// customization.
    ///
    /// ## Properties
    ///
    ///
    /// #### `busy`
    ///  The "busy" property is [`true`] while the completion context is
    /// populating completion proposals.
    ///
    /// Readable
    ///
    ///
    /// #### `completion`
    ///  The "completion" is the #GtkSourceCompletion that was used to create the context.
    ///
    /// Readable | Writeable | Construct Only
    ///
    ///
    /// #### `empty`
    ///  The "empty" property is [`true`] when there are no results.
    ///
    /// It will be notified when the first result is added or the last
    /// result is removed.
    ///
    /// Readable
    ///
    /// ## Signals
    ///
    ///
    /// #### `provider-model-changed`
    ///  Emitted when a provider changes a model.
    ///
    /// This signal is primarily useful for #GtkSourceCompletionProvider's
    /// that want to track other providers in context. For example, it can
    /// be used to create a "top results" provider.
    ///
    ///
    /// <details><summary><h4>ListModel</h4></summary>
    ///
    ///
    /// #### `items-changed`
    ///  This signal is emitted whenever items were added to or removed
    /// from @list. At @position, @removed items were removed and @added
    /// items were added in their place.
    ///
    /// Note: If `removed != added`, the positions of all later items
    /// in the model change.
    ///
    ///
    /// </details>
    ///
    /// # Implements
    ///
    /// [`trait@glib::ObjectExt`], [`trait@gio::prelude::ListModelExt`]
    #[doc(alias = "GtkSourceCompletionContext")]
    pub struct CompletionContext(Object<ffi::GtkSourceCompletionContext, ffi::GtkSourceCompletionContextClass>) @implements gio::ListModel;

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

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

    /// Gets the mode for which the context was activated.
    #[doc(alias = "gtk_source_completion_context_get_activation")]
    #[doc(alias = "get_activation")]
    pub fn activation(&self) -> CompletionActivation {
        unsafe {
            from_glib(ffi::gtk_source_completion_context_get_activation(
                self.to_glib_none().0,
            ))
        }
    }

    /// Gets the bounds for the completion, which is the beginning of the
    /// current word (taking break characters into account) to the current
    /// insertion cursor.
    ///
    /// If @begin is non-[`None`], it will be set to the start position of the
    /// current word being completed.
    ///
    /// If @end is non-[`None`], it will be set to the insertion cursor for the
    /// current word being completed.
    ///
    /// # Returns
    ///
    /// [`true`] if the marks are still valid and @begin or @end was set.
    ///
    /// ## `begin`
    /// a #GtkTextIter
    ///
    /// ## `end`
    /// a #GtkTextIter
    #[doc(alias = "gtk_source_completion_context_get_bounds")]
    #[doc(alias = "get_bounds")]
    pub fn bounds(&self) -> Option<(gtk::TextIter, gtk::TextIter)> {
        unsafe {
            let mut begin = gtk::TextIter::uninitialized();
            let mut end = gtk::TextIter::uninitialized();
            let ret = from_glib(ffi::gtk_source_completion_context_get_bounds(
                self.to_glib_none().0,
                begin.to_glib_none_mut().0,
                end.to_glib_none_mut().0,
            ));
            if ret {
                Some((begin, end))
            } else {
                None
            }
        }
    }

    /// Gets the underlying buffer used by the context.
    ///
    /// This is a convenience function to get the buffer via the #GtkSourceCompletion
    /// property.
    ///
    /// # Returns
    ///
    /// a #GtkTextBuffer or [`None`]
    #[doc(alias = "gtk_source_completion_context_get_buffer")]
    #[doc(alias = "get_buffer")]
    pub fn buffer(&self) -> Option<Buffer> {
        unsafe {
            from_glib_none(ffi::gtk_source_completion_context_get_buffer(
                self.to_glib_none().0,
            ))
        }
    }

    /// Gets the "busy" property. This is set to [`true`] while the completion
    /// context is actively fetching proposals from registered
    /// #GtkSourceCompletionProvider's.
    ///
    /// # Returns
    ///
    /// [`true`] if the context is busy
    #[doc(alias = "gtk_source_completion_context_get_busy")]
    #[doc(alias = "get_busy")]
    #[doc(alias = "busy")]
    pub fn is_busy(&self) -> bool {
        unsafe {
            from_glib(ffi::gtk_source_completion_context_get_busy(
                self.to_glib_none().0,
            ))
        }
    }

    /// Gets the #GtkSourceCompletion that created the context.
    ///
    /// # Returns
    ///
    /// an #GtkSourceCompletion or [`None`]
    #[doc(alias = "gtk_source_completion_context_get_completion")]
    #[doc(alias = "get_completion")]
    pub fn completion(&self) -> Option<Completion> {
        unsafe {
            from_glib_none(ffi::gtk_source_completion_context_get_completion(
                self.to_glib_none().0,
            ))
        }
    }

    /// Checks if any proposals have been provided to the context.
    ///
    /// Out of convenience, this function will return [`true`] if @self is [`None`].
    ///
    /// # Returns
    ///
    /// [`true`] if there are no proposals in the context
    #[doc(alias = "gtk_source_completion_context_get_empty")]
    #[doc(alias = "get_empty")]
    #[doc(alias = "empty")]
    pub fn is_empty(&self) -> bool {
        unsafe {
            from_glib(ffi::gtk_source_completion_context_get_empty(
                self.to_glib_none().0,
            ))
        }
    }

    /// Gets the language of the underlying buffer, if any.
    ///
    /// # Returns
    ///
    /// a #GtkSourceLanguage or [`None`]
    #[doc(alias = "gtk_source_completion_context_get_language")]
    #[doc(alias = "get_language")]
    pub fn language(&self) -> Option<Language> {
        unsafe {
            from_glib_none(ffi::gtk_source_completion_context_get_language(
                self.to_glib_none().0,
            ))
        }
    }

    /// Gets the #GListModel associated with the provider.
    ///
    /// You can connect to #GtkSourceCompletionContext::model-changed to receive
    /// notifications about when the model has been replaced by a new model.
    /// ## `provider`
    /// a #GtkSourceCompletionProvider
    ///
    /// # Returns
    ///
    /// a #GListModel or [`None`]
    #[cfg(feature = "v5_6")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v5_6")))]
    #[doc(alias = "gtk_source_completion_context_get_proposals_for_provider")]
    #[doc(alias = "get_proposals_for_provider")]
    pub fn proposals_for_provider(
        &self,
        provider: &impl IsA<CompletionProvider>,
    ) -> Option<gio::ListModel> {
        unsafe {
            from_glib_none(
                ffi::gtk_source_completion_context_get_proposals_for_provider(
                    self.to_glib_none().0,
                    provider.as_ref().to_glib_none().0,
                ),
            )
        }
    }

    /// Gets the text view for the context.
    ///
    /// # Returns
    ///
    /// a #GtkSourceView or [`None`]
    #[doc(alias = "gtk_source_completion_context_get_view")]
    #[doc(alias = "get_view")]
    pub fn view(&self) -> Option<View> {
        unsafe {
            from_glib_none(ffi::gtk_source_completion_context_get_view(
                self.to_glib_none().0,
            ))
        }
    }

    /// Gets the word that is being completed up to the position of the insert mark.
    ///
    /// # Returns
    ///
    /// a string containing the current word
    #[doc(alias = "gtk_source_completion_context_get_word")]
    #[doc(alias = "get_word")]
    pub fn word(&self) -> glib::GString {
        unsafe {
            from_glib_full(ffi::gtk_source_completion_context_get_word(
                self.to_glib_none().0,
            ))
        }
    }

    /// Gets the providers that are associated with the context.
    ///
    /// # Returns
    ///
    /// a #GListModel of #GtkSourceCompletionProvider
    #[cfg(feature = "v5_6")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v5_6")))]
    #[doc(alias = "gtk_source_completion_context_list_providers")]
    pub fn list_providers(&self) -> gio::ListModel {
        unsafe {
            from_glib_full(ffi::gtk_source_completion_context_list_providers(
                self.to_glib_none().0,
            ))
        }
    }

    /// This function allows providers to update their results for a context
    /// outside of a call to [`CompletionProviderExt::populate_async()`][crate::prelude::CompletionProviderExt::populate_async()].
    ///
    /// This can be used to immediately return results for a provider while it does
    /// additional asynchronous work. Doing so will allow the completions to
    /// update while the operation is in progress.
    /// ## `provider`
    /// an #GtkSourceCompletionProvider
    /// ## `results`
    /// a #GListModel or [`None`]
    #[doc(alias = "gtk_source_completion_context_set_proposals_for_provider")]
    pub fn set_proposals_for_provider(
        &self,
        provider: &impl IsA<CompletionProvider>,
        results: Option<&impl IsA<gio::ListModel>>,
    ) {
        unsafe {
            ffi::gtk_source_completion_context_set_proposals_for_provider(
                self.to_glib_none().0,
                provider.as_ref().to_glib_none().0,
                results.map(|p| p.as_ref()).to_glib_none().0,
            );
        }
    }

    /// Emitted when a provider changes a model.
    ///
    /// This signal is primarily useful for #GtkSourceCompletionProvider's
    /// that want to track other providers in context. For example, it can
    /// be used to create a "top results" provider.
    /// ## `provider`
    /// a #GtkSourceCompletionProvider
    /// ## `model`
    /// a #GListModel
    #[cfg(feature = "v5_6")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v5_6")))]
    #[doc(alias = "provider-model-changed")]
    pub fn connect_provider_model_changed<
        F: Fn(&Self, &CompletionProvider, Option<&gio::ListModel>) + 'static,
    >(
        &self,
        f: F,
    ) -> SignalHandlerId {
        unsafe extern "C" fn provider_model_changed_trampoline<
            F: Fn(&CompletionContext, &CompletionProvider, Option<&gio::ListModel>) + 'static,
        >(
            this: *mut ffi::GtkSourceCompletionContext,
            provider: *mut ffi::GtkSourceCompletionProvider,
            model: *mut gio::ffi::GListModel,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(
                &from_glib_borrow(this),
                &from_glib_borrow(provider),
                Option::<gio::ListModel>::from_glib_borrow(model)
                    .as_ref()
                    .as_ref(),
            )
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                b"provider-model-changed\0".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    provider_model_changed_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

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

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

// rustdoc-stripper-ignore-next
/// A [builder-pattern] type to construct [`CompletionContext`] 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 CompletionContextBuilder {
    builder: glib::object::ObjectBuilder<'static, CompletionContext>,
}

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

    /// The "completion" is the #GtkSourceCompletion that was used to create the context.
    pub fn completion(self, completion: &Completion) -> Self {
        Self {
            builder: self.builder.property("completion", completion.clone()),
        }
    }

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