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

use crate::{Completion, CompletionActivation, CompletionProposal, CompletionProvider};
use glib::{
    prelude::*,
    signal::{connect_raw, SignalHandlerId},
    translate::*,
};
use std::{boxed::Box as Box_, fmt, mem::transmute};

glib::wrapper! {
    ///
    ///
    /// ## Properties
    ///
    ///
    /// #### `activation`
    ///  The completion activation
    ///
    /// Readable | Writeable | Construct
    ///
    ///
    /// #### `completion`
    ///  The [`Completion`][crate::Completion] associated with the context.
    ///
    /// Readable | Writeable | Construct Only
    ///
    ///
    /// #### `iter`
    ///  The [`gtk::TextIter`][crate::gtk::TextIter] at which the completion is invoked.
    ///
    /// Readable | Writeable
    ///
    /// ## Signals
    ///
    ///
    /// #### `cancelled`
    ///  Emitted when the current population of proposals has been cancelled.
    /// Providers adding proposals asynchronously should connect to this signal
    /// to know when to cancel running proposal queries.
    ///
    /// Action
    ///
    /// # Implements
    ///
    /// [`CompletionContextExt`][trait@crate::prelude::CompletionContextExt]
    #[doc(alias = "GtkSourceCompletionContext")]
    pub struct CompletionContext(Object<ffi::GtkSourceCompletionContext, ffi::GtkSourceCompletionContextClass>);

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

impl CompletionContext {
    pub const NONE: Option<&'static CompletionContext> = None;

    // 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()
    }
}

// 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 activation
    pub fn activation(self, activation: CompletionActivation) -> Self {
        Self {
            builder: self.builder.property("activation", activation),
        }
    }

    /// The [`Completion`][crate::Completion] associated with the context.
    pub fn completion(self, completion: &impl IsA<Completion>) -> Self {
        Self {
            builder: self
                .builder
                .property("completion", completion.clone().upcast()),
        }
    }

    /// The [`gtk::TextIter`][crate::gtk::TextIter] at which the completion is invoked.
    pub fn iter(self, iter: &gtk::TextIter) -> Self {
        Self {
            builder: self.builder.property("iter", iter),
        }
    }

    // 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()
    }
}

mod sealed {
    pub trait Sealed {}
    impl<T: super::IsA<super::CompletionContext>> Sealed for T {}
}

/// Trait containing all [`struct@CompletionContext`] methods.
///
/// # Implementors
///
/// [`CompletionContext`][struct@crate::CompletionContext]
pub trait CompletionContextExt: IsA<CompletionContext> + sealed::Sealed + 'static {
    /// Providers can use this function to add proposals to the completion. They
    /// can do so asynchronously by means of the `finished` argument. Providers must
    /// ensure that they always call this function with `finished` set to [`true`]
    /// once each population (even if no proposals need to be added).
    /// Population occurs when the [`CompletionProviderExt::populate()`][crate::prelude::CompletionProviderExt::populate()]
    /// function is called.
    /// ## `provider`
    /// a [`CompletionProvider`][crate::CompletionProvider].
    /// ## `proposals`
    /// The list of proposals to add.
    /// ## `finished`
    /// Whether the provider is finished adding proposals.
    #[doc(alias = "gtk_source_completion_context_add_proposals")]
    fn add_proposals(
        &self,
        provider: &impl IsA<CompletionProvider>,
        proposals: &[CompletionProposal],
        finished: bool,
    ) {
        unsafe {
            ffi::gtk_source_completion_context_add_proposals(
                self.as_ref().to_glib_none().0,
                provider.as_ref().to_glib_none().0,
                proposals.to_glib_none().0,
                finished.into_glib(),
            );
        }
    }

    /// Get the context activation.
    ///
    /// # Returns
    ///
    /// The context activation.
    #[doc(alias = "gtk_source_completion_context_get_activation")]
    #[doc(alias = "get_activation")]
    fn activation(&self) -> CompletionActivation {
        unsafe {
            from_glib(ffi::gtk_source_completion_context_get_activation(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    /// Get the iter at which the completion was invoked. Providers can use this
    /// to determine how and if to match proposals.
    ///
    /// # Returns
    ///
    /// [`true`] if `iter` is correctly set, [`false`] otherwise.
    ///
    /// ## `iter`
    /// a [`gtk::TextIter`][crate::gtk::TextIter].
    #[doc(alias = "gtk_source_completion_context_get_iter")]
    #[doc(alias = "get_iter")]
    fn iter(&self) -> Option<gtk::TextIter> {
        unsafe {
            let mut iter = gtk::TextIter::uninitialized();
            let ret = from_glib(ffi::gtk_source_completion_context_get_iter(
                self.as_ref().to_glib_none().0,
                iter.to_glib_none_mut().0,
            ));
            if ret {
                Some(iter)
            } else {
                None
            }
        }
    }

    /// The completion activation
    fn set_activation(&self, activation: CompletionActivation) {
        ObjectExt::set_property(self.as_ref(), "activation", activation)
    }

    /// The [`Completion`][crate::Completion] associated with the context.
    fn completion(&self) -> Option<Completion> {
        ObjectExt::property(self.as_ref(), "completion")
    }

    /// The [`gtk::TextIter`][crate::gtk::TextIter] at which the completion is invoked.
    fn set_iter(&self, iter: Option<&gtk::TextIter>) {
        ObjectExt::set_property(self.as_ref(), "iter", iter)
    }

    /// Emitted when the current population of proposals has been cancelled.
    /// Providers adding proposals asynchronously should connect to this signal
    /// to know when to cancel running proposal queries.
    #[doc(alias = "cancelled")]
    fn connect_cancelled<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn cancelled_trampoline<
            P: IsA<CompletionContext>,
            F: Fn(&P) + 'static,
        >(
            this: *mut ffi::GtkSourceCompletionContext,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(CompletionContext::from_glib_borrow(this).unsafe_cast_ref())
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                b"cancelled\0".as_ptr() as *const _,
                Some(transmute::<_, unsafe extern "C" fn()>(
                    cancelled_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    fn emit_cancelled(&self) {
        self.emit_by_name::<()>("cancelled", &[]);
    }

    #[doc(alias = "activation")]
    fn connect_activation_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_activation_trampoline<
            P: IsA<CompletionContext>,
            F: Fn(&P) + 'static,
        >(
            this: *mut ffi::GtkSourceCompletionContext,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(CompletionContext::from_glib_borrow(this).unsafe_cast_ref())
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                b"notify::activation\0".as_ptr() as *const _,
                Some(transmute::<_, unsafe extern "C" fn()>(
                    notify_activation_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "iter")]
    fn connect_iter_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_iter_trampoline<
            P: IsA<CompletionContext>,
            F: Fn(&P) + 'static,
        >(
            this: *mut ffi::GtkSourceCompletionContext,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(CompletionContext::from_glib_borrow(this).unsafe_cast_ref())
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                b"notify::iter\0".as_ptr() as *const _,
                Some(transmute::<_, unsafe extern "C" fn()>(
                    notify_iter_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }
}

impl<O: IsA<CompletionContext>> CompletionContextExt for O {}

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