// 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::translate::*;
#[cfg(feature = "v5_2")]
#[cfg_attr(docsrs, doc(cfg(feature = "v5_2")))]
use std::boxed::Box as Box_;

/// Like GTK_SOURCE_CHECK_VERSION, but the check for gtk_source_check_version is
/// at runtime instead of compile time. This is useful for compiling
/// against older versions of GtkSourceView, but using features from newer
/// versions.
/// ## `major`
/// the major version to check
/// ## `minor`
/// the minor version to check
/// ## `micro`
/// the micro version to check
///
/// # Returns
///
/// [`true`] if the version of the GtkSourceView currently loaded
/// is the same as or newer than the passed-in version.
#[doc(alias = "gtk_source_check_version")]
pub fn check_version(major: u32, minor: u32, micro: u32) -> bool {
    assert_initialized_main_thread!();
    unsafe { from_glib(ffi::gtk_source_check_version(major, minor, micro)) }
}

/// Free the resources allocated by GtkSourceView. For example it unrefs the
/// singleton objects.
///
/// It is not mandatory to call this function, it's just to be friendlier to
/// memory debugging tools. This function is meant to be called at the end of
/// main(). It can be called several times.
#[doc(alias = "gtk_source_finalize")]
pub fn finalize() {
    assert_initialized_main_thread!();
    unsafe {
        ffi::gtk_source_finalize();
    }
}

/// Returns the major version number of the GtkSourceView library.
/// (e.g. in GtkSourceView version 3.20.0 this is 3.)
///
/// This function is in the library, so it represents the GtkSourceView library
/// your code is running against. Contrast with the #GTK_SOURCE_MAJOR_VERSION
/// macro, which represents the major version of the GtkSourceView headers you
/// have included when compiling your code.
///
/// # Returns
///
/// the major version number of the GtkSourceView library
#[doc(alias = "gtk_source_get_major_version")]
#[doc(alias = "get_major_version")]
pub fn major_version() -> u32 {
    assert_initialized_main_thread!();
    unsafe { ffi::gtk_source_get_major_version() }
}

/// Returns the micro version number of the GtkSourceView library.
/// (e.g. in GtkSourceView version 3.20.0 this is 0.)
///
/// This function is in the library, so it represents the GtkSourceView library
/// your code is running against. Contrast with the #GTK_SOURCE_MICRO_VERSION
/// macro, which represents the micro version of the GtkSourceView headers you
/// have included when compiling your code.
///
/// # Returns
///
/// the micro version number of the GtkSourceView library
#[doc(alias = "gtk_source_get_micro_version")]
#[doc(alias = "get_micro_version")]
pub fn micro_version() -> u32 {
    assert_initialized_main_thread!();
    unsafe { ffi::gtk_source_get_micro_version() }
}

/// Returns the minor version number of the GtkSourceView library.
/// (e.g. in GtkSourceView version 3.20.0 this is 20.)
///
/// This function is in the library, so it represents the GtkSourceView library
/// your code is running against. Contrast with the #GTK_SOURCE_MINOR_VERSION
/// macro, which represents the minor version of the GtkSourceView headers you
/// have included when compiling your code.
///
/// # Returns
///
/// the minor version number of the GtkSourceView library
#[doc(alias = "gtk_source_get_minor_version")]
#[doc(alias = "get_minor_version")]
pub fn minor_version() -> u32 {
    assert_initialized_main_thread!();
    unsafe { ffi::gtk_source_get_minor_version() }
}

/// Initializes the GtkSourceView library (e.g. for the internationalization).
///
/// This function can be called several times, but is meant to be called at the
/// beginning of main(), before any other GtkSourceView function call.
#[doc(alias = "gtk_source_init")]
pub fn init() {
    assert_initialized_main_thread!();
    unsafe {
        ffi::gtk_source_init();
    }
}

/// Simplified version of [`scheduler_add_full()`][crate::scheduler_add_full()].
/// ## `callback`
/// the callback to execute
#[cfg(feature = "v5_2")]
#[cfg_attr(docsrs, doc(cfg(feature = "v5_2")))]
#[doc(alias = "gtk_source_scheduler_add")]
pub fn scheduler_add<P: FnOnce(i64) -> bool + Send + Sync + 'static>(callback: P) -> usize {
    assert_initialized_main_thread!();
    let callback_data: Box_<P> = Box_::new(callback);
    unsafe extern "C" fn callback_func<P: FnOnce(i64) -> bool + Send + Sync + 'static>(
        deadline: i64,
        user_data: glib::ffi::gpointer,
    ) -> glib::ffi::gboolean {
        let callback = Box_::from_raw(user_data as *mut P);
        (*callback)(deadline).into_glib()
    }
    let callback = Some(callback_func::<P> as _);
    let super_callback0: Box_<P> = callback_data;
    unsafe { ffi::gtk_source_scheduler_add(callback, Box_::into_raw(super_callback0) as *mut _) }
}

/// Adds a new callback that will be executed as time permits on the main thread.
///
/// This is useful when you need to do a lot of background work but want to do
/// it incrementally.
///
/// @callback will be provided a deadline that it should complete it's work by
/// (or near) and can be checked using `get_monotonic_time()` for comparison.
///
/// Use [`scheduler_remove()`][crate::scheduler_remove()] to remove the handler.
/// ## `callback`
/// the callback to execute
/// ## `notify`
/// closure notify for @user_data
#[cfg(feature = "v5_2")]
#[cfg_attr(docsrs, doc(cfg(feature = "v5_2")))]
#[doc(alias = "gtk_source_scheduler_add_full")]
pub fn scheduler_add_full<P: Fn(i64) -> bool + Send + Sync + 'static>(callback: P) -> usize {
    assert_initialized_main_thread!();
    let callback_data: Box_<P> = Box_::new(callback);
    unsafe extern "C" fn callback_func<P: Fn(i64) -> bool + Send + Sync + 'static>(
        deadline: i64,
        user_data: glib::ffi::gpointer,
    ) -> glib::ffi::gboolean {
        let callback = &*(user_data as *mut P);
        (*callback)(deadline).into_glib()
    }
    let callback = Some(callback_func::<P> as _);
    unsafe extern "C" fn notify_func<P: Fn(i64) -> bool + Send + Sync + 'static>(
        data: glib::ffi::gpointer,
    ) {
        let _callback = Box_::from_raw(data as *mut P);
    }
    let destroy_call2 = Some(notify_func::<P> as _);
    let super_callback0: Box_<P> = callback_data;
    unsafe {
        ffi::gtk_source_scheduler_add_full(
            callback,
            Box_::into_raw(super_callback0) as *mut _,
            destroy_call2,
        )
    }
}

/// Removes a scheduler callback previously registered with
/// [`scheduler_add()`][crate::scheduler_add()] or [`scheduler_add_full()`][crate::scheduler_add_full()].
/// ## `handler_id`
/// the handler id
#[cfg(feature = "v5_2")]
#[cfg_attr(docsrs, doc(cfg(feature = "v5_2")))]
#[doc(alias = "gtk_source_scheduler_remove")]
pub fn scheduler_remove(handler_id: usize) {
    assert_initialized_main_thread!();
    unsafe {
        ffi::gtk_source_scheduler_remove(handler_id);
    }
}

/// Use this function to escape the following characters: `\n`, `\r`, `\t` and `\`.
///
/// For a regular expression search, use g_regex_escape_string() instead.
///
/// One possible use case is to take the #GtkTextBuffer's selection and put it in a
/// search entry. The selection can contain tabulations, newlines, etc. So it's
/// better to escape those special characters to better fit in the search entry.
///
/// See also: [`utils_unescape_search_text()`][crate::utils_unescape_search_text()].
///
/// <warning>
/// Warning: the escape and unescape functions are not reciprocal! For example,
/// escape (unescape (\)) = \\. So avoid cycles such as: search entry -> unescape
/// -> search settings -> escape -> search entry. The original search entry text
/// may be modified.
/// </warning>
/// ## `text`
/// the text to escape.
///
/// # Returns
///
/// the escaped @text.
#[doc(alias = "gtk_source_utils_escape_search_text")]
pub fn utils_escape_search_text(text: &str) -> glib::GString {
    assert_initialized_main_thread!();
    unsafe {
        from_glib_full(ffi::gtk_source_utils_escape_search_text(
            text.to_glib_none().0,
        ))
    }
}

/// Use this function before [`SearchSettingsExt::set_search_text()`][crate::prelude::SearchSettingsExt::set_search_text()], to
/// unescape the following sequences of characters: `\n`, `\r`, `\t` and `\\`.
/// The purpose is to easily write those characters in a search entry.
///
/// Note that unescaping the search text is not needed for regular expression
/// searches.
///
/// See also: [`utils_escape_search_text()`][crate::utils_escape_search_text()].
/// ## `text`
/// the text to unescape.
///
/// # Returns
///
/// the unescaped @text.
#[doc(alias = "gtk_source_utils_unescape_search_text")]
pub fn utils_unescape_search_text(text: &str) -> glib::GString {
    assert_initialized_main_thread!();
    unsafe {
        from_glib_full(ffi::gtk_source_utils_unescape_search_text(
            text.to_glib_none().0,
        ))
    }
}