// 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::{Buffer, CompressionType, Encoding, File, NewlineType};
use glib::{prelude::*, translate::*};
use std::fmt;

glib::wrapper! {
    ///
    ///
    /// ## Properties
    ///
    ///
    /// #### `buffer`
    ///  The [`Buffer`][crate::Buffer] to load the contents into. The
    /// [`FileLoader`][crate::FileLoader] object has a weak reference to the buffer.
    ///
    /// Readable | Writeable | Construct Only
    ///
    ///
    /// #### `file`
    ///  The [`File`][crate::File]. The [`FileLoader`][crate::FileLoader] object has a weak
    /// reference to the file.
    ///
    /// Readable | Writeable | Construct Only
    ///
    ///
    /// #### `input-stream`
    ///  The [`gio::InputStream`][crate::gio::InputStream] to load. Useful for reading stdin. If this property
    /// is set, the [`location`][struct@crate::FileLoader#location] property is ignored.
    ///
    /// Readable | Writeable | Construct Only
    ///
    ///
    /// #### `location`
    ///  The [`gio::File`][crate::gio::File] to load. If the [`input-stream`][struct@crate::FileLoader#input-stream] is
    /// [`None`], by default the location is taken from the [`File`][crate::File] at
    /// construction time.
    ///
    /// Readable | Writeable | Construct Only
    ///
    /// # Implements
    ///
    /// [`FileLoaderExt`][trait@crate::prelude::FileLoaderExt]
    #[doc(alias = "GtkSourceFileLoader")]
    pub struct FileLoader(Object<ffi::GtkSourceFileLoader, ffi::GtkSourceFileLoaderClass>);

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

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

    /// Creates a new [`FileLoader`][crate::FileLoader] object. The contents is read from the
    /// [`File`][crate::File]'s location. If not already done, call
    /// [`FileExt::set_location()`][crate::prelude::FileExt::set_location()] before calling this constructor. The previous
    /// location is anyway not needed, because as soon as the file loading begins,
    /// the `buffer` is emptied.
    /// ## `buffer`
    /// the [`Buffer`][crate::Buffer] to load the contents into.
    /// ## `file`
    /// the [`File`][crate::File].
    ///
    /// # Returns
    ///
    /// a new [`FileLoader`][crate::FileLoader] object.
    #[doc(alias = "gtk_source_file_loader_new")]
    pub fn new(buffer: &impl IsA<Buffer>, file: &impl IsA<File>) -> FileLoader {
        skip_assert_initialized!();
        unsafe {
            from_glib_full(ffi::gtk_source_file_loader_new(
                buffer.as_ref().to_glib_none().0,
                file.as_ref().to_glib_none().0,
            ))
        }
    }

    /// Creates a new [`FileLoader`][crate::FileLoader] object. The contents is read from `stream`.
    /// ## `buffer`
    /// the [`Buffer`][crate::Buffer] to load the contents into.
    /// ## `file`
    /// the [`File`][crate::File].
    /// ## `stream`
    /// the [`gio::InputStream`][crate::gio::InputStream] to load, e.g. stdin.
    ///
    /// # Returns
    ///
    /// a new [`FileLoader`][crate::FileLoader] object.
    #[doc(alias = "gtk_source_file_loader_new_from_stream")]
    #[doc(alias = "new_from_stream")]
    pub fn from_stream(
        buffer: &impl IsA<Buffer>,
        file: &impl IsA<File>,
        stream: &impl IsA<gio::InputStream>,
    ) -> FileLoader {
        skip_assert_initialized!();
        unsafe {
            from_glib_full(ffi::gtk_source_file_loader_new_from_stream(
                buffer.as_ref().to_glib_none().0,
                file.as_ref().to_glib_none().0,
                stream.as_ref().to_glib_none().0,
            ))
        }
    }

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

impl Default for FileLoader {
    fn default() -> Self {
        glib::object::Object::new::<Self>()
    }
}

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

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

    /// The [`Buffer`][crate::Buffer] to load the contents into. The
    /// [`FileLoader`][crate::FileLoader] object has a weak reference to the buffer.
    pub fn buffer(self, buffer: &impl IsA<Buffer>) -> Self {
        Self {
            builder: self.builder.property("buffer", buffer.clone().upcast()),
        }
    }

    /// The [`File`][crate::File]. The [`FileLoader`][crate::FileLoader] object has a weak
    /// reference to the file.
    pub fn file(self, file: &impl IsA<File>) -> Self {
        Self {
            builder: self.builder.property("file", file.clone().upcast()),
        }
    }

    /// The [`gio::InputStream`][crate::gio::InputStream] to load. Useful for reading stdin. If this property
    /// is set, the [`location`][struct@crate::FileLoader#location] property is ignored.
    pub fn input_stream(self, input_stream: &impl IsA<gio::InputStream>) -> Self {
        Self {
            builder: self
                .builder
                .property("input-stream", input_stream.clone().upcast()),
        }
    }

    /// The [`gio::File`][crate::gio::File] to load. If the [`input-stream`][struct@crate::FileLoader#input-stream] is
    /// [`None`], by default the location is taken from the [`File`][crate::File] at
    /// construction time.
    pub fn location(self, location: &impl IsA<gio::File>) -> Self {
        Self {
            builder: self.builder.property("location", location.clone().upcast()),
        }
    }

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

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

/// Trait containing all [`struct@FileLoader`] methods.
///
/// # Implementors
///
/// [`FileLoader`][struct@crate::FileLoader]
pub trait FileLoaderExt: IsA<FileLoader> + sealed::Sealed + 'static {
    ///
    /// # Returns
    ///
    /// the [`Buffer`][crate::Buffer] to load the contents into.
    #[doc(alias = "gtk_source_file_loader_get_buffer")]
    #[doc(alias = "get_buffer")]
    fn buffer(&self) -> Option<Buffer> {
        unsafe {
            from_glib_none(ffi::gtk_source_file_loader_get_buffer(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    ///
    /// # Returns
    ///
    /// the detected compression type.
    #[doc(alias = "gtk_source_file_loader_get_compression_type")]
    #[doc(alias = "get_compression_type")]
    fn compression_type(&self) -> CompressionType {
        unsafe {
            from_glib(ffi::gtk_source_file_loader_get_compression_type(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    ///
    /// # Returns
    ///
    /// the detected file encoding.
    #[doc(alias = "gtk_source_file_loader_get_encoding")]
    #[doc(alias = "get_encoding")]
    fn encoding(&self) -> Option<Encoding> {
        unsafe {
            from_glib_none(ffi::gtk_source_file_loader_get_encoding(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    ///
    /// # Returns
    ///
    /// the [`File`][crate::File].
    #[doc(alias = "gtk_source_file_loader_get_file")]
    #[doc(alias = "get_file")]
    fn file(&self) -> Option<File> {
        unsafe {
            from_glib_none(ffi::gtk_source_file_loader_get_file(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    ///
    /// # Returns
    ///
    /// the [`gio::InputStream`][crate::gio::InputStream] to load, or [`None`]
    /// if a [`gio::File`][crate::gio::File] is used.
    #[doc(alias = "gtk_source_file_loader_get_input_stream")]
    #[doc(alias = "get_input_stream")]
    fn input_stream(&self) -> Option<gio::InputStream> {
        unsafe {
            from_glib_none(ffi::gtk_source_file_loader_get_input_stream(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    ///
    /// # Returns
    ///
    /// the [`gio::File`][crate::gio::File] to load, or [`None`]
    /// if an input stream is used.
    #[doc(alias = "gtk_source_file_loader_get_location")]
    #[doc(alias = "get_location")]
    fn location(&self) -> Option<gio::File> {
        unsafe {
            from_glib_none(ffi::gtk_source_file_loader_get_location(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    ///
    /// # Returns
    ///
    /// the detected newline type.
    #[doc(alias = "gtk_source_file_loader_get_newline_type")]
    #[doc(alias = "get_newline_type")]
    fn newline_type(&self) -> NewlineType {
        unsafe {
            from_glib(ffi::gtk_source_file_loader_get_newline_type(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    //#[doc(alias = "gtk_source_file_loader_load_async")]
    //fn load_async<P: FnOnce(Result<(), glib::Error>) + 'static, Q: FnOnce(Result<(), glib::Error>) + 'static>(&self, io_priority: glib::Priority, cancellable: Option<&impl IsA<gio::Cancellable>>, progress_callback: P, callback: Q) {
    //    unsafe { TODO: call ffi:gtk_source_file_loader_load_async() }
    //}

    //
    //fn load_future<P: FnOnce(Result<(), glib::Error>) + 'static>(&self, io_priority: glib::Priority, progress_callback: P) -> Pin<Box_<dyn std::future::Future<Output = Result<(), glib::Error>> + 'static>> {

    //let progress_callback = progress_callback.map(ToOwned::to_owned);
    //Box_::pin(gio::GioFuture::new(self, move |obj, cancellable, send| {
    //    obj.load_async(
    //        io_priority,
    //        Some(cancellable),
    //        progress_callback.as_ref().map(::std::borrow::Borrow::borrow),
    //        move |res| {
    //            send.resolve(res);
    //        },
    //    );
    //}))
    //}
}

impl<O: IsA<FileLoader>> FileLoaderExt for O {}

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