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

glib::wrapper! {
    ///
    ///
    /// ## Properties
    ///
    ///
    /// #### `at-word-boundaries`
    ///  If [`true`], a search match must start and end a word. The match can
    /// span multiple words.
    ///
    /// Readable | Writeable | Construct
    ///
    ///
    /// #### `case-sensitive`
    ///  Whether the search is case sensitive.
    ///
    /// Readable | Writeable | Construct
    ///
    ///
    /// #### `regex-enabled`
    ///  Search by regular expressions with
    /// [`search-text`][struct@crate::SearchSettings#search-text] as the pattern.
    ///
    /// Readable | Writeable | Construct
    ///
    ///
    /// #### `search-text`
    ///  A search string, or [`None`] if the search is disabled. If the regular
    /// expression search is enabled, [`search-text`][struct@crate::SearchSettings#search-text] is
    /// the pattern.
    ///
    /// Readable | Writeable | Construct
    ///
    ///
    /// #### `wrap-around`
    ///  For a forward search, continue at the beginning of the buffer if no
    /// search occurrence is found. For a backward search, continue at the
    /// end of the buffer.
    ///
    /// Readable | Writeable | Construct
    ///
    /// # Implements
    ///
    /// [`SearchSettingsExt`][trait@crate::prelude::SearchSettingsExt]
    #[doc(alias = "GtkSourceSearchSettings")]
    pub struct SearchSettings(Object<ffi::GtkSourceSearchSettings, ffi::GtkSourceSearchSettingsClass>);

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

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

    /// Creates a new search settings object.
    ///
    /// # Returns
    ///
    /// a new search settings object.
    #[doc(alias = "gtk_source_search_settings_new")]
    pub fn new() -> SearchSettings {
        assert_initialized_main_thread!();
        unsafe { from_glib_full(ffi::gtk_source_search_settings_new()) }
    }

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

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

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

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

    /// If [`true`], a search match must start and end a word. The match can
    /// span multiple words.
    pub fn at_word_boundaries(self, at_word_boundaries: bool) -> Self {
        Self {
            builder: self
                .builder
                .property("at-word-boundaries", at_word_boundaries),
        }
    }

    /// Whether the search is case sensitive.
    pub fn case_sensitive(self, case_sensitive: bool) -> Self {
        Self {
            builder: self.builder.property("case-sensitive", case_sensitive),
        }
    }

    /// Search by regular expressions with
    /// [`search-text`][struct@crate::SearchSettings#search-text] as the pattern.
    pub fn regex_enabled(self, regex_enabled: bool) -> Self {
        Self {
            builder: self.builder.property("regex-enabled", regex_enabled),
        }
    }

    /// A search string, or [`None`] if the search is disabled. If the regular
    /// expression search is enabled, [`search-text`][struct@crate::SearchSettings#search-text] is
    /// the pattern.
    pub fn search_text(self, search_text: impl Into<glib::GString>) -> Self {
        Self {
            builder: self.builder.property("search-text", search_text.into()),
        }
    }

    /// For a forward search, continue at the beginning of the buffer if no
    /// search occurrence is found. For a backward search, continue at the
    /// end of the buffer.
    pub fn wrap_around(self, wrap_around: bool) -> Self {
        Self {
            builder: self.builder.property("wrap-around", wrap_around),
        }
    }

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

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

/// Trait containing all [`struct@SearchSettings`] methods.
///
/// # Implementors
///
/// [`SearchSettings`][struct@crate::SearchSettings]
pub trait SearchSettingsExt: IsA<SearchSettings> + sealed::Sealed + 'static {
    ///
    /// # Returns
    ///
    /// whether to search at word boundaries.
    #[doc(alias = "gtk_source_search_settings_get_at_word_boundaries")]
    #[doc(alias = "get_at_word_boundaries")]
    fn is_at_word_boundaries(&self) -> bool {
        unsafe {
            from_glib(ffi::gtk_source_search_settings_get_at_word_boundaries(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    ///
    /// # Returns
    ///
    /// whether the search is case sensitive.
    #[doc(alias = "gtk_source_search_settings_get_case_sensitive")]
    #[doc(alias = "get_case_sensitive")]
    fn is_case_sensitive(&self) -> bool {
        unsafe {
            from_glib(ffi::gtk_source_search_settings_get_case_sensitive(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    ///
    /// # Returns
    ///
    /// whether to search by regular expressions.
    #[doc(alias = "gtk_source_search_settings_get_regex_enabled")]
    #[doc(alias = "get_regex_enabled")]
    fn is_regex_enabled(&self) -> bool {
        unsafe {
            from_glib(ffi::gtk_source_search_settings_get_regex_enabled(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    /// Gets the text to search. The return value must not be freed.
    ///
    /// You may be interested to call `gtk_source_utils_escape_search_text()` after
    /// this function.
    ///
    /// # Returns
    ///
    /// the text to search, or [`None`] if the search is disabled.
    #[doc(alias = "gtk_source_search_settings_get_search_text")]
    #[doc(alias = "get_search_text")]
    fn search_text(&self) -> Option<glib::GString> {
        unsafe {
            from_glib_none(ffi::gtk_source_search_settings_get_search_text(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    ///
    /// # Returns
    ///
    /// whether to wrap around the search.
    #[doc(alias = "gtk_source_search_settings_get_wrap_around")]
    #[doc(alias = "get_wrap_around")]
    fn wraps_around(&self) -> bool {
        unsafe {
            from_glib(ffi::gtk_source_search_settings_get_wrap_around(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    /// Change whether the search is done at word boundaries. If `at_word_boundaries`
    /// is [`true`], a search match must start and end a word. The match can span
    /// multiple words. See also [`gtk::TextIter::starts_word()`][crate::gtk::TextIter::starts_word()] and
    /// [`gtk::TextIter::ends_word()`][crate::gtk::TextIter::ends_word()].
    /// ## `at_word_boundaries`
    /// the setting.
    #[doc(alias = "gtk_source_search_settings_set_at_word_boundaries")]
    fn set_at_word_boundaries(&self, at_word_boundaries: bool) {
        unsafe {
            ffi::gtk_source_search_settings_set_at_word_boundaries(
                self.as_ref().to_glib_none().0,
                at_word_boundaries.into_glib(),
            );
        }
    }

    /// Enables or disables the case sensitivity for the search.
    /// ## `case_sensitive`
    /// the setting.
    #[doc(alias = "gtk_source_search_settings_set_case_sensitive")]
    fn set_case_sensitive(&self, case_sensitive: bool) {
        unsafe {
            ffi::gtk_source_search_settings_set_case_sensitive(
                self.as_ref().to_glib_none().0,
                case_sensitive.into_glib(),
            );
        }
    }

    /// Enables or disables whether to search by regular expressions.
    /// If enabled, the [`search-text`][struct@crate::SearchSettings#search-text] property contains the
    /// pattern of the regular expression.
    ///
    /// [`SearchContext`][crate::SearchContext] uses `GRegex` when regex search is enabled. See the
    /// [Regular expression syntax](https://developer.gnome.org/glib/stable/glib-regex-syntax.html)
    /// page in the GLib reference manual.
    /// ## `regex_enabled`
    /// the setting.
    #[doc(alias = "gtk_source_search_settings_set_regex_enabled")]
    fn set_regex_enabled(&self, regex_enabled: bool) {
        unsafe {
            ffi::gtk_source_search_settings_set_regex_enabled(
                self.as_ref().to_glib_none().0,
                regex_enabled.into_glib(),
            );
        }
    }

    /// Sets the text to search. If `search_text` is [`None`] or is empty, the search
    /// will be disabled. A copy of `search_text` will be made, so you can safely free
    /// `search_text` after a call to this function.
    ///
    /// You may be interested to call `gtk_source_utils_unescape_search_text()` before
    /// this function.
    /// ## `search_text`
    /// the nul-terminated text to search, or [`None`] to disable the search.
    #[doc(alias = "gtk_source_search_settings_set_search_text")]
    fn set_search_text(&self, search_text: Option<&str>) {
        unsafe {
            ffi::gtk_source_search_settings_set_search_text(
                self.as_ref().to_glib_none().0,
                search_text.to_glib_none().0,
            );
        }
    }

    /// Enables or disables the wrap around search. If `wrap_around` is [`true`], the
    /// forward search continues at the beginning of the buffer if no search
    /// occurrences are found. Similarly, the backward search continues to search at
    /// the end of the buffer.
    /// ## `wrap_around`
    /// the setting.
    #[doc(alias = "gtk_source_search_settings_set_wrap_around")]
    fn set_wrap_around(&self, wrap_around: bool) {
        unsafe {
            ffi::gtk_source_search_settings_set_wrap_around(
                self.as_ref().to_glib_none().0,
                wrap_around.into_glib(),
            );
        }
    }

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

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

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

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

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

impl<O: IsA<SearchSettings>> SearchSettingsExt for O {}

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