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

use crate::Buffer;
use crate::SearchSettings;
use crate::Style;
use glib::object::Cast;
use glib::object::IsA;
use glib::object::ObjectType as ObjectType_;
use glib::signal::connect_raw;
use glib::signal::SignalHandlerId;
use glib::translate::*;
use glib::StaticType;
use glib::ToValue;
use std::boxed::Box as Box_;
use std::fmt;
use std::mem;
use std::mem::transmute;
use std::pin::Pin;
use std::ptr;

glib::wrapper! {
    pub struct SearchContext(Object<ffi::GtkSourceSearchContext, ffi::GtkSourceSearchContextClass>);

    match fn {
        get_type => || ffi::gtk_source_search_context_get_type(),
    }
}

impl SearchContext {
    /// Creates a new search context, associated with `buffer`, and customized with
    /// `settings`. If `settings` is `None`, a new `SearchSettings` object will
    /// be created, that you can retrieve with
    /// `SearchContext::get_settings`.
    /// ## `buffer`
    /// a `Buffer`.
    /// ## `settings`
    /// a `SearchSettings`, or `None`.
    ///
    /// # Returns
    ///
    /// a new search context.
    #[doc(alias = "gtk_source_search_context_new")]
    pub fn new<P: IsA<Buffer>, Q: IsA<SearchSettings>>(
        buffer: &P,
        settings: Option<&Q>,
    ) -> SearchContext {
        skip_assert_initialized!();
        unsafe {
            from_glib_full(ffi::gtk_source_search_context_new(
                buffer.as_ref().to_glib_none().0,
                settings.map(|p| p.as_ref()).to_glib_none().0,
            ))
        }
    }

    /// Synchronous backward search. It is recommended to use the asynchronous
    /// functions instead, to not block the user interface. However, if you are sure
    /// that the `buffer` is small, this function is more convenient to use.
    ///
    /// If the `SearchSettings:wrap-around` property is `false`, this function
    /// doesn't try to wrap around.
    ///
    /// The `has_wrapped_around` out parameter is set independently of whether a match
    /// is found. So if this function returns `false`, `has_wrapped_around` will have
    /// the same value as the `SearchSettings:wrap-around` property.
    /// ## `iter`
    /// start of search.
    /// ## `match_start`
    /// return location for start of match, or `None`.
    /// ## `match_end`
    /// return location for end of match, or `None`.
    /// ## `has_wrapped_around`
    /// return location to know whether the
    ///  search has wrapped around, or `None`.
    ///
    /// # Returns
    ///
    /// whether a match was found.
    #[doc(alias = "gtk_source_search_context_backward")]
    pub fn backward(&self, iter: &gtk::TextIter) -> Option<(gtk::TextIter, gtk::TextIter, bool)> {
        unsafe {
            let mut match_start = gtk::TextIter::uninitialized();
            let mut match_end = gtk::TextIter::uninitialized();
            let mut has_wrapped_around = mem::MaybeUninit::uninit();
            let ret = from_glib(ffi::gtk_source_search_context_backward(
                self.to_glib_none().0,
                iter.to_glib_none().0,
                match_start.to_glib_none_mut().0,
                match_end.to_glib_none_mut().0,
                has_wrapped_around.as_mut_ptr(),
            ));
            let has_wrapped_around = has_wrapped_around.assume_init();
            if ret {
                Some((match_start, match_end, from_glib(has_wrapped_around)))
            } else {
                None
            }
        }
    }

    /// The asynchronous version of `SearchContext::backward`.
    ///
    /// See the documentation of `SearchContext::backward` for more
    /// details.
    ///
    /// See the `gio::AsyncResult` documentation to know how to use this function.
    ///
    /// If the operation is cancelled, the `callback` will only be called if
    /// `cancellable` was not `None`. `SearchContext::backward_async` takes
    /// ownership of `cancellable`, so you can unref it after calling this function.
    /// ## `iter`
    /// start of search.
    /// ## `cancellable`
    /// a `gio::Cancellable`, or `None`.
    /// ## `callback`
    /// a `GAsyncReadyCallback` to call when the operation is finished.
    /// ## `user_data`
    /// the data to pass to the `callback` function.
    #[doc(alias = "gtk_source_search_context_backward_async")]
    pub fn backward_async<
        P: IsA<gio::Cancellable>,
        Q: FnOnce(Result<(gtk::TextIter, gtk::TextIter, bool), glib::Error>) + Send + 'static,
    >(
        &self,
        iter: &gtk::TextIter,
        cancellable: Option<&P>,
        callback: Q,
    ) {
        let user_data: Box_<Q> = Box_::new(callback);
        unsafe extern "C" fn backward_async_trampoline<
            Q: FnOnce(Result<(gtk::TextIter, gtk::TextIter, bool), glib::Error>) + Send + 'static,
        >(
            _source_object: *mut glib::gobject_ffi::GObject,
            res: *mut gio::ffi::GAsyncResult,
            user_data: glib::ffi::gpointer,
        ) {
            let mut error = ptr::null_mut();
            let mut match_start = gtk::TextIter::uninitialized();
            let mut match_end = gtk::TextIter::uninitialized();
            let mut has_wrapped_around = mem::MaybeUninit::uninit();
            let _ = ffi::gtk_source_search_context_backward_finish(
                _source_object as *mut _,
                res,
                match_start.to_glib_none_mut().0,
                match_end.to_glib_none_mut().0,
                has_wrapped_around.as_mut_ptr(),
                &mut error,
            );
            let has_wrapped_around = has_wrapped_around.assume_init();
            let result = if error.is_null() {
                Ok((match_start, match_end, from_glib(has_wrapped_around)))
            } else {
                Err(from_glib_full(error))
            };
            let callback: Box_<Q> = Box_::from_raw(user_data as *mut _);
            callback(result);
        }
        let callback = backward_async_trampoline::<Q>;
        unsafe {
            ffi::gtk_source_search_context_backward_async(
                self.to_glib_none().0,
                iter.to_glib_none().0,
                cancellable.map(|p| p.as_ref()).to_glib_none().0,
                Some(callback),
                Box_::into_raw(user_data) as *mut _,
            );
        }
    }

    pub fn backward_async_future(
        &self,
        iter: &gtk::TextIter,
    ) -> Pin<
        Box_<
            dyn std::future::Future<
                    Output = Result<(gtk::TextIter, gtk::TextIter, bool), glib::Error>,
                > + 'static,
        >,
    > {
        let iter = iter.clone();
        Box_::pin(gio::GioFuture::new(self, move |obj, send| {
            let cancellable = gio::Cancellable::new();
            obj.backward_async(&iter, Some(&cancellable), move |res| {
                send.resolve(res);
            });

            cancellable
        }))
    }

    /// Synchronous forward search. It is recommended to use the asynchronous
    /// functions instead, to not block the user interface. However, if you are sure
    /// that the `buffer` is small, this function is more convenient to use.
    ///
    /// If the `SearchSettings:wrap-around` property is `false`, this function
    /// doesn't try to wrap around.
    ///
    /// The `has_wrapped_around` out parameter is set independently of whether a match
    /// is found. So if this function returns `false`, `has_wrapped_around` will have
    /// the same value as the `SearchSettings:wrap-around` property.
    /// ## `iter`
    /// start of search.
    /// ## `match_start`
    /// return location for start of match, or `None`.
    /// ## `match_end`
    /// return location for end of match, or `None`.
    /// ## `has_wrapped_around`
    /// return location to know whether the
    ///  search has wrapped around, or `None`.
    ///
    /// # Returns
    ///
    /// whether a match was found.
    #[doc(alias = "gtk_source_search_context_forward")]
    pub fn forward(&self, iter: &gtk::TextIter) -> Option<(gtk::TextIter, gtk::TextIter, bool)> {
        unsafe {
            let mut match_start = gtk::TextIter::uninitialized();
            let mut match_end = gtk::TextIter::uninitialized();
            let mut has_wrapped_around = mem::MaybeUninit::uninit();
            let ret = from_glib(ffi::gtk_source_search_context_forward(
                self.to_glib_none().0,
                iter.to_glib_none().0,
                match_start.to_glib_none_mut().0,
                match_end.to_glib_none_mut().0,
                has_wrapped_around.as_mut_ptr(),
            ));
            let has_wrapped_around = has_wrapped_around.assume_init();
            if ret {
                Some((match_start, match_end, from_glib(has_wrapped_around)))
            } else {
                None
            }
        }
    }

    /// The asynchronous version of `SearchContext::forward`.
    ///
    /// See the documentation of `SearchContext::forward` for more
    /// details.
    ///
    /// See the `gio::AsyncResult` documentation to know how to use this function.
    ///
    /// If the operation is cancelled, the `callback` will only be called if
    /// `cancellable` was not `None`. `SearchContext::forward_async` takes
    /// ownership of `cancellable`, so you can unref it after calling this function.
    /// ## `iter`
    /// start of search.
    /// ## `cancellable`
    /// a `gio::Cancellable`, or `None`.
    /// ## `callback`
    /// a `GAsyncReadyCallback` to call when the operation is finished.
    /// ## `user_data`
    /// the data to pass to the `callback` function.
    #[doc(alias = "gtk_source_search_context_forward_async")]
    pub fn forward_async<
        P: IsA<gio::Cancellable>,
        Q: FnOnce(Result<(gtk::TextIter, gtk::TextIter, bool), glib::Error>) + Send + 'static,
    >(
        &self,
        iter: &gtk::TextIter,
        cancellable: Option<&P>,
        callback: Q,
    ) {
        let user_data: Box_<Q> = Box_::new(callback);
        unsafe extern "C" fn forward_async_trampoline<
            Q: FnOnce(Result<(gtk::TextIter, gtk::TextIter, bool), glib::Error>) + Send + 'static,
        >(
            _source_object: *mut glib::gobject_ffi::GObject,
            res: *mut gio::ffi::GAsyncResult,
            user_data: glib::ffi::gpointer,
        ) {
            let mut error = ptr::null_mut();
            let mut match_start = gtk::TextIter::uninitialized();
            let mut match_end = gtk::TextIter::uninitialized();
            let mut has_wrapped_around = mem::MaybeUninit::uninit();
            let _ = ffi::gtk_source_search_context_forward_finish(
                _source_object as *mut _,
                res,
                match_start.to_glib_none_mut().0,
                match_end.to_glib_none_mut().0,
                has_wrapped_around.as_mut_ptr(),
                &mut error,
            );
            let has_wrapped_around = has_wrapped_around.assume_init();
            let result = if error.is_null() {
                Ok((match_start, match_end, from_glib(has_wrapped_around)))
            } else {
                Err(from_glib_full(error))
            };
            let callback: Box_<Q> = Box_::from_raw(user_data as *mut _);
            callback(result);
        }
        let callback = forward_async_trampoline::<Q>;
        unsafe {
            ffi::gtk_source_search_context_forward_async(
                self.to_glib_none().0,
                iter.to_glib_none().0,
                cancellable.map(|p| p.as_ref()).to_glib_none().0,
                Some(callback),
                Box_::into_raw(user_data) as *mut _,
            );
        }
    }

    pub fn forward_async_future(
        &self,
        iter: &gtk::TextIter,
    ) -> Pin<
        Box_<
            dyn std::future::Future<
                    Output = Result<(gtk::TextIter, gtk::TextIter, bool), glib::Error>,
                > + 'static,
        >,
    > {
        let iter = iter.clone();
        Box_::pin(gio::GioFuture::new(self, move |obj, send| {
            let cancellable = gio::Cancellable::new();
            obj.forward_async(&iter, Some(&cancellable), move |res| {
                send.resolve(res);
            });

            cancellable
        }))
    }

    ///
    /// # Returns
    ///
    /// the associated buffer.
    #[doc(alias = "gtk_source_search_context_get_buffer")]
    pub fn get_buffer(&self) -> Option<Buffer> {
        unsafe {
            from_glib_none(ffi::gtk_source_search_context_get_buffer(
                self.to_glib_none().0,
            ))
        }
    }

    ///
    /// # Returns
    ///
    /// whether to highlight the search occurrences.
    #[doc(alias = "gtk_source_search_context_get_highlight")]
    pub fn get_highlight(&self) -> bool {
        unsafe {
            from_glib(ffi::gtk_source_search_context_get_highlight(
                self.to_glib_none().0,
            ))
        }
    }

    ///
    /// # Returns
    ///
    /// the `Style` to apply on search matches.
    #[doc(alias = "gtk_source_search_context_get_match_style")]
    pub fn get_match_style(&self) -> Option<Style> {
        unsafe {
            from_glib_none(ffi::gtk_source_search_context_get_match_style(
                self.to_glib_none().0,
            ))
        }
    }

    /// Gets the position of a search occurrence. If the buffer is not already fully
    /// scanned, the position may be unknown, and -1 is returned. If 0 is returned,
    /// it means that this part of the buffer has already been scanned, and that
    /// `match_start` and `match_end` don't delimit an occurrence.
    /// ## `match_start`
    /// the start of the occurrence.
    /// ## `match_end`
    /// the end of the occurrence.
    ///
    /// # Returns
    ///
    /// the position of the search occurrence. The first occurrence has the
    /// position 1 (not 0). Returns 0 if `match_start` and `match_end` don't delimit
    /// an occurrence. Returns -1 if the position is not yet known.
    #[doc(alias = "gtk_source_search_context_get_occurrence_position")]
    pub fn get_occurrence_position(
        &self,
        match_start: &gtk::TextIter,
        match_end: &gtk::TextIter,
    ) -> i32 {
        unsafe {
            ffi::gtk_source_search_context_get_occurrence_position(
                self.to_glib_none().0,
                match_start.to_glib_none().0,
                match_end.to_glib_none().0,
            )
        }
    }

    /// Gets the total number of search occurrences. If the buffer is not already
    /// fully scanned, the total number of occurrences is unknown, and -1 is
    /// returned.
    ///
    /// # Returns
    ///
    /// the total number of search occurrences, or -1 if unknown.
    #[doc(alias = "gtk_source_search_context_get_occurrences_count")]
    pub fn get_occurrences_count(&self) -> i32 {
        unsafe { ffi::gtk_source_search_context_get_occurrences_count(self.to_glib_none().0) }
    }

    /// Regular expression patterns must follow certain rules. If
    /// `SearchSettings:search-text` breaks a rule, the error can be
    /// retrieved with this function. The error domain is `G_REGEX_ERROR`.
    ///
    /// Free the return value with `glib::Error::free`.
    ///
    /// # Returns
    ///
    /// the `glib::Error`, or `None` if the
    ///  pattern is valid.
    #[doc(alias = "gtk_source_search_context_get_regex_error")]
    pub fn get_regex_error(&self) -> Option<glib::Error> {
        unsafe {
            from_glib_full(ffi::gtk_source_search_context_get_regex_error(
                self.to_glib_none().0,
            ))
        }
    }

    ///
    /// # Returns
    ///
    /// the search settings.
    #[doc(alias = "gtk_source_search_context_get_settings")]
    pub fn get_settings(&self) -> Option<SearchSettings> {
        unsafe {
            from_glib_none(ffi::gtk_source_search_context_get_settings(
                self.to_glib_none().0,
            ))
        }
    }

    /// Replaces a search match by another text. If `match_start` and `match_end`
    /// doesn't correspond to a search match, `false` is returned.
    ///
    /// `match_start` and `match_end` iters are revalidated to point to the replacement
    /// text boundaries.
    ///
    /// For a regular expression replacement, you can check if `replace` is valid by
    /// calling `glib::Regex::check_replacement`. The `replace` text can contain
    /// backreferences; read the `glib::Regex::replace` documentation for more details.
    /// ## `match_start`
    /// the start of the match to replace.
    /// ## `match_end`
    /// the end of the match to replace.
    /// ## `replace`
    /// the replacement text.
    /// ## `replace_length`
    /// the length of `replace` in bytes, or -1.
    ///
    /// # Returns
    ///
    /// whether the match has been replaced.
    #[doc(alias = "gtk_source_search_context_replace")]
    pub fn replace(
        &self,
        match_start: &mut gtk::TextIter,
        match_end: &mut gtk::TextIter,
        replace: &str,
    ) -> Result<(), glib::Error> {
        let replace_length = replace.len() as i32;
        unsafe {
            let mut error = ptr::null_mut();
            let _ = ffi::gtk_source_search_context_replace(
                self.to_glib_none().0,
                match_start.to_glib_none_mut().0,
                match_end.to_glib_none_mut().0,
                replace.to_glib_none().0,
                replace_length,
                &mut error,
            );
            if error.is_null() {
                Ok(())
            } else {
                Err(from_glib_full(error))
            }
        }
    }

    /// Replaces all search matches by another text. It is a synchronous function, so
    /// it can block the user interface.
    ///
    /// For a regular expression replacement, you can check if `replace` is valid by
    /// calling `glib::Regex::check_replacement`. The `replace` text can contain
    /// backreferences; read the `glib::Regex::replace` documentation for more details.
    /// ## `replace`
    /// the replacement text.
    /// ## `replace_length`
    /// the length of `replace` in bytes, or -1.
    ///
    /// # Returns
    ///
    /// the number of replaced matches.
    #[doc(alias = "gtk_source_search_context_replace_all")]
    pub fn replace_all(&self, replace: &str) -> Result<(), glib::Error> {
        let replace_length = replace.len() as i32;
        unsafe {
            let mut error = ptr::null_mut();
            let _ = ffi::gtk_source_search_context_replace_all(
                self.to_glib_none().0,
                replace.to_glib_none().0,
                replace_length,
                &mut error,
            );
            if error.is_null() {
                Ok(())
            } else {
                Err(from_glib_full(error))
            }
        }
    }

    /// Enables or disables the search occurrences highlighting.
    /// ## `highlight`
    /// the setting.
    #[doc(alias = "gtk_source_search_context_set_highlight")]
    pub fn set_highlight(&self, highlight: bool) {
        unsafe {
            ffi::gtk_source_search_context_set_highlight(
                self.to_glib_none().0,
                highlight.to_glib(),
            );
        }
    }

    /// Set the style to apply on search matches. If `match_style` is `None`, default
    /// theme's scheme 'match-style' will be used.
    /// To enable or disable the search highlighting, use
    /// `SearchContext::set_highlight`.
    /// ## `match_style`
    /// a `Style`, or `None`.
    #[doc(alias = "gtk_source_search_context_set_match_style")]
    pub fn set_match_style(&self, match_style: Option<&Style>) {
        unsafe {
            ffi::gtk_source_search_context_set_match_style(
                self.to_glib_none().0,
                match_style.to_glib_none().0,
            );
        }
    }

    pub fn connect_property_highlight_notify<F: Fn(&SearchContext) + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId {
        unsafe extern "C" fn notify_highlight_trampoline<F: Fn(&SearchContext) + 'static>(
            this: *mut ffi::GtkSourceSearchContext,
            _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::highlight\0".as_ptr() as *const _,
                Some(transmute::<_, unsafe extern "C" fn()>(
                    notify_highlight_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    pub fn connect_property_match_style_notify<F: Fn(&SearchContext) + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId {
        unsafe extern "C" fn notify_match_style_trampoline<F: Fn(&SearchContext) + 'static>(
            this: *mut ffi::GtkSourceSearchContext,
            _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::match-style\0".as_ptr() as *const _,
                Some(transmute::<_, unsafe extern "C" fn()>(
                    notify_match_style_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    pub fn connect_property_occurrences_count_notify<F: Fn(&SearchContext) + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId {
        unsafe extern "C" fn notify_occurrences_count_trampoline<
            F: Fn(&SearchContext) + 'static,
        >(
            this: *mut ffi::GtkSourceSearchContext,
            _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::occurrences-count\0".as_ptr() as *const _,
                Some(transmute::<_, unsafe extern "C" fn()>(
                    notify_occurrences_count_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    pub fn connect_property_regex_error_notify<F: Fn(&SearchContext) + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId {
        unsafe extern "C" fn notify_regex_error_trampoline<F: Fn(&SearchContext) + 'static>(
            this: *mut ffi::GtkSourceSearchContext,
            _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::regex-error\0".as_ptr() as *const _,
                Some(transmute::<_, unsafe extern "C" fn()>(
                    notify_regex_error_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }
}

#[derive(Clone, Default)]
pub struct SearchContextBuilder {
    buffer: Option<Buffer>,
    highlight: Option<bool>,
    match_style: Option<Style>,
    settings: Option<SearchSettings>,
}

impl SearchContextBuilder {
    pub fn new() -> Self {
        Self::default()
    }

    pub fn build(self) -> SearchContext {
        let mut properties: Vec<(&str, &dyn ToValue)> = vec![];
        if let Some(ref buffer) = self.buffer {
            properties.push(("buffer", buffer));
        }
        if let Some(ref highlight) = self.highlight {
            properties.push(("highlight", highlight));
        }
        if let Some(ref match_style) = self.match_style {
            properties.push(("match-style", match_style));
        }
        if let Some(ref settings) = self.settings {
            properties.push(("settings", settings));
        }
        let ret = glib::Object::new::<SearchContext>(&properties).expect("object new");
        ret
    }

    pub fn buffer<P: IsA<Buffer>>(mut self, buffer: &P) -> Self {
        self.buffer = Some(buffer.clone().upcast());
        self
    }

    pub fn highlight(mut self, highlight: bool) -> Self {
        self.highlight = Some(highlight);
        self
    }

    pub fn match_style(mut self, match_style: &Style) -> Self {
        self.match_style = Some(match_style.clone());
        self
    }

    pub fn settings<P: IsA<SearchSettings>>(mut self, settings: &P) -> Self {
        self.settings = Some(settings.clone().upcast());
        self
    }
}

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