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

glib::wrapper! {
    /// Load a file into a GtkSourceBuffer.
    ///
    /// A [`FileLoader`][crate::FileLoader] object permits to load the contents of a [`gio::File`][crate::gio::File] or a
    /// [`gio::InputStream`][crate::gio::InputStream] into a [`Buffer`][crate::Buffer].
    ///
    /// A file loader should be used only for one load operation, including errors
    /// handling. If an error occurs, you can reconfigure the loader and relaunch the
    /// operation with [`load_async()`][Self::load_async()].
    ///
    /// Running a [`FileLoader`][crate::FileLoader] is an undoable action for the
    /// [`Buffer`][crate::Buffer].
    ///
    /// After a file loading, the buffer is reset to the contents provided by the
    /// [`gio::File`][crate::gio::File] or [`gio::InputStream`][crate::gio::InputStream], so the buffer is set as “unmodified”, that is,
    /// [`TextBufferExtManual::set_modified()`][crate::gtk::prelude::TextBufferExtManual::set_modified()] is called with [`false`]. If the contents isn't
    /// saved somewhere (for example if you load from stdin), then you should
    /// probably call [`TextBufferExtManual::set_modified()`][crate::gtk::prelude::TextBufferExtManual::set_modified()] with [`true`] after calling
    /// `FileLoader::load_finish()`.
    ///
    /// ## Properties
    ///
    ///
    /// #### `buffer`
    ///  The #GtkSourceBuffer to load the contents into. The
    /// #GtkSourceFileLoader object has a weak reference to the buffer.
    ///
    /// Readable | Writeable | Construct Only
    ///
    ///
    /// #### `file`
    ///  The #GtkSourceFile. The #GtkSourceFileLoader object has a weak
    /// reference to the file.
    ///
    /// Readable | Writeable | Construct Only
    ///
    ///
    /// #### `input-stream`
    ///  The #GInputStream to load. Useful for reading stdin. If this property
    /// is set, the #GtkSourceFileLoader:location property is ignored.
    ///
    /// Readable | Writeable | Construct Only
    ///
    ///
    /// #### `location`
    ///  The #GFile to load. If the #GtkSourceFileLoader:input-stream is
    /// [`None`], by default the location is taken from the #GtkSourceFile at
    /// construction time.
    ///
    /// Readable | Writeable | Construct Only
    ///
    /// # Implements
    ///
    /// [`trait@glib::ObjectExt`]
    #[doc(alias = "GtkSourceFileLoader")]
    pub struct FileLoader(Object<ffi::GtkSourceFileLoader, ffi::GtkSourceFileLoaderClass>);

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

impl FileLoader {
    /// Creates a new [`FileLoader`][crate::FileLoader] object. The contents is read from the
    /// [`File`][crate::File]'s location.
    ///
    /// If not already done, call [`SourceFileExt::set_location()`][crate::prelude::SourceFileExt::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 #GtkSourceBuffer to load the contents into.
    /// ## `file`
    /// the #GtkSourceFile.
    ///
    /// # Returns
    ///
    /// a new #GtkSourceFileLoader 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 #GtkSourceFileLoader object. The contents is read from @stream.
    /// ## `buffer`
    /// the #GtkSourceBuffer to load the contents into.
    /// ## `file`
    /// the #GtkSourceFile.
    /// ## `stream`
    /// the #GInputStream to load, e.g. stdin.
    ///
    /// # Returns
    ///
    /// a new #GtkSourceFileLoader 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()
    }

    ///
    /// # Returns
    ///
    /// the #GtkSourceBuffer to load the contents into.
    #[doc(alias = "gtk_source_file_loader_get_buffer")]
    #[doc(alias = "get_buffer")]
    pub fn buffer(&self) -> Buffer {
        unsafe {
            from_glib_none(ffi::gtk_source_file_loader_get_buffer(
                self.to_glib_none().0,
            ))
        }
    }

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

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

    ///
    /// # Returns
    ///
    /// the #GtkSourceFile.
    #[doc(alias = "gtk_source_file_loader_get_file")]
    #[doc(alias = "get_file")]
    pub fn file(&self) -> File {
        unsafe { from_glib_none(ffi::gtk_source_file_loader_get_file(self.to_glib_none().0)) }
    }

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

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

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

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 #GtkSourceBuffer to load the contents into. The
    /// #GtkSourceFileLoader 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 #GtkSourceFile. The #GtkSourceFileLoader 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 #GInputStream to load. Useful for reading stdin. If this property
    /// is set, the #GtkSourceFileLoader: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 #GFile to load. If the #GtkSourceFileLoader:input-stream is
    /// [`None`], by default the location is taken from the #GtkSourceFile 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()
    }
}