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

use crate::Pixbuf;
use crate::PixbufAnimation;
use crate::PixbufFormat;
use glib::object::Cast;
use glib::object::IsA;
use glib::signal::connect_raw;
use glib::signal::SignalHandlerId;
use glib::translate::*;
use std::boxed::Box as Box_;
use std::fmt;
use std::mem::transmute;
use std::ptr;

glib::wrapper! {
    /// The GdkPixbufLoader struct contains only private
    /// fields.
    ///
    /// # Implements
    ///
    /// [`PixbufLoaderExt`][trait@crate::prelude::PixbufLoaderExt]
    #[doc(alias = "GdkPixbufLoader")]
    pub struct PixbufLoader(Object<ffi::GdkPixbufLoader, ffi::GdkPixbufLoaderClass>);

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

impl PixbufLoader {
    /// Creates a new pixbuf loader object.
    ///
    /// # Returns
    ///
    /// A newly-created pixbuf loader.
    #[doc(alias = "gdk_pixbuf_loader_new")]
    pub fn new() -> PixbufLoader {
        unsafe { from_glib_full(ffi::gdk_pixbuf_loader_new()) }
    }

    /// Creates a new pixbuf loader object that always attempts to parse
    /// image data as if it were an image of mime type `mime_type`, instead of
    /// identifying the type automatically. Useful if you want an error if
    /// the image isn't the expected mime type, for loading image formats
    /// that can't be reliably identified by looking at the data, or if
    /// the user manually forces a specific mime type.
    ///
    /// The list of supported mime types depends on what image loaders
    /// are installed, but typically "image/png", "image/jpeg", "image/gif",
    /// "image/tiff" and "image/x-xpixmap" are among the supported mime types.
    /// To obtain the full list of supported mime types, call
    /// [`PixbufFormat::mime_types()`][crate::PixbufFormat::mime_types()] on each of the [`PixbufFormat`][crate::PixbufFormat]
    /// structs returned by [`Pixbuf::formats()`][crate::Pixbuf::formats()].
    /// ## `mime_type`
    /// the mime type to be loaded
    ///
    /// # Returns
    ///
    /// A newly-created pixbuf loader.
    #[doc(alias = "gdk_pixbuf_loader_new_with_mime_type")]
    #[doc(alias = "new_with_mime_type")]
    pub fn with_mime_type(mime_type: &str) -> Result<PixbufLoader, glib::Error> {
        unsafe {
            let mut error = ptr::null_mut();
            let ret =
                ffi::gdk_pixbuf_loader_new_with_mime_type(mime_type.to_glib_none().0, &mut error);
            if error.is_null() {
                Ok(from_glib_full(ret))
            } else {
                Err(from_glib_full(error))
            }
        }
    }

    /// Creates a new pixbuf loader object that always attempts to parse
    /// image data as if it were an image of type `image_type`, instead of
    /// identifying the type automatically. Useful if you want an error if
    /// the image isn't the expected type, for loading image formats
    /// that can't be reliably identified by looking at the data, or if
    /// the user manually forces a specific type.
    ///
    /// The list of supported image formats depends on what image loaders
    /// are installed, but typically "png", "jpeg", "gif", "tiff" and
    /// "xpm" are among the supported formats. To obtain the full list of
    /// supported image formats, call [`PixbufFormat::name()`][crate::PixbufFormat::name()] on each
    /// of the [`PixbufFormat`][crate::PixbufFormat] structs returned by [`Pixbuf::formats()`][crate::Pixbuf::formats()].
    /// ## `image_type`
    /// name of the image format to be loaded with the image
    ///
    /// # Returns
    ///
    /// A newly-created pixbuf loader.
    #[doc(alias = "gdk_pixbuf_loader_new_with_type")]
    #[doc(alias = "new_with_type")]
    pub fn with_type(image_type: &str) -> Result<PixbufLoader, glib::Error> {
        unsafe {
            let mut error = ptr::null_mut();
            let ret = ffi::gdk_pixbuf_loader_new_with_type(image_type.to_glib_none().0, &mut error);
            if error.is_null() {
                Ok(from_glib_full(ret))
            } else {
                Err(from_glib_full(error))
            }
        }
    }
}

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

pub const NONE_PIXBUF_LOADER: Option<&PixbufLoader> = None;

/// Trait containing all [`struct@PixbufLoader`] methods.
///
/// # Implementors
///
/// [`PixbufLoader`][struct@crate::PixbufLoader]
pub trait PixbufLoaderExt: 'static {
    /// Informs a pixbuf loader that no further writes with
    /// [`write()`][Self::write()] will occur, so that it can free its
    /// internal loading structures. Also, tries to parse any data that
    /// hasn't yet been parsed; if the remaining data is partial or
    /// corrupt, an error will be returned. If [`false`] is returned, `error`
    /// will be set to an error from the `GDK_PIXBUF_ERROR` or `G_FILE_ERROR`
    /// domains. If you're just cancelling a load rather than expecting it
    /// to be finished, passing [`None`] for `error` to ignore it is
    /// reasonable.
    ///
    /// Remember that this does not unref the loader, so if you plan not to
    /// use it anymore, please `g_object_unref()` it.
    ///
    /// # Returns
    ///
    /// [`true`] if all image data written so far was successfully
    ///  passed out via the update_area signal
    #[doc(alias = "gdk_pixbuf_loader_close")]
    fn close(&self) -> Result<(), glib::Error>;

    /// Queries the [`PixbufAnimation`][crate::PixbufAnimation] that a pixbuf loader is currently creating.
    /// In general it only makes sense to call this function after the "area-prepared"
    /// signal has been emitted by the loader. If the loader doesn't have enough
    /// bytes yet (hasn't emitted the "area-prepared" signal) this function will
    /// return [`None`].
    ///
    /// # Returns
    ///
    /// The [`PixbufAnimation`][crate::PixbufAnimation] that the loader is loading, or [`None`] if
    /// not enough data has been read to determine the information.
    #[doc(alias = "gdk_pixbuf_loader_get_animation")]
    #[doc(alias = "get_animation")]
    fn animation(&self) -> Option<PixbufAnimation>;

    /// Obtains the available information about the format of the
    /// currently loading image file.
    ///
    /// # Returns
    ///
    /// A [`PixbufFormat`][crate::PixbufFormat] or
    /// [`None`]. The return value is owned by GdkPixbuf and should not be
    /// freed.
    #[doc(alias = "gdk_pixbuf_loader_get_format")]
    #[doc(alias = "get_format")]
    fn format(&self) -> Option<PixbufFormat>;

    /// Queries the [`Pixbuf`][crate::Pixbuf] that a pixbuf loader is currently creating.
    /// In general it only makes sense to call this function after the
    /// "area-prepared" signal has been emitted by the loader; this means
    /// that enough data has been read to know the size of the image that
    /// will be allocated. If the loader has not received enough data via
    /// [`write()`][Self::write()], then this function returns [`None`]. The
    /// returned pixbuf will be the same in all future calls to the loader,
    /// so simply calling `g_object_ref()` should be sufficient to continue
    /// using it. Additionally, if the loader is an animation, it will
    /// return the "static image" of the animation
    /// (see [`PixbufAnimationExt::static_image()`][crate::prelude::PixbufAnimationExt::static_image()]).
    ///
    /// # Returns
    ///
    /// The [`Pixbuf`][crate::Pixbuf] that the loader is creating, or [`None`] if not
    /// enough data has been read to determine how to create the image buffer.
    #[doc(alias = "gdk_pixbuf_loader_get_pixbuf")]
    #[doc(alias = "get_pixbuf")]
    fn pixbuf(&self) -> Option<Pixbuf>;

    /// Causes the image to be scaled while it is loaded. The desired
    /// image size can be determined relative to the original size of
    /// the image by calling [`set_size()`][Self::set_size()] from a
    /// signal handler for the ::size-prepared signal.
    ///
    /// Attempts to set the desired image size are ignored after the
    /// emission of the ::size-prepared signal.
    /// ## `width`
    /// The desired width of the image being loaded.
    /// ## `height`
    /// The desired height of the image being loaded.
    #[doc(alias = "gdk_pixbuf_loader_set_size")]
    fn set_size(&self, width: i32, height: i32);

    /// This will cause a pixbuf loader to parse the next `count` bytes of
    /// an image. It will return [`true`] if the data was loaded successfully,
    /// and [`false`] if an error occurred. In the latter case, the loader
    /// will be closed, and will not accept further writes. If [`false`] is
    /// returned, `error` will be set to an error from the `GDK_PIXBUF_ERROR`
    /// or `G_FILE_ERROR` domains.
    /// ## `buf`
    /// Pointer to image data.
    ///
    /// # Returns
    ///
    /// [`true`] if the write was successful, or [`false`] if the loader
    /// cannot parse the buffer.
    #[doc(alias = "gdk_pixbuf_loader_write")]
    fn write(&self, buf: &[u8]) -> Result<(), glib::Error>;

    /// This will cause a pixbuf loader to parse a buffer inside a [`glib::Bytes`][crate::glib::Bytes]
    /// for an image. It will return [`true`] if the data was loaded successfully,
    /// and [`false`] if an error occurred. In the latter case, the loader
    /// will be closed, and will not accept further writes. If [`false`] is
    /// returned, `error` will be set to an error from the `GDK_PIXBUF_ERROR`
    /// or `G_FILE_ERROR` domains.
    ///
    /// See also: [`write()`][Self::write()]
    /// ## `buffer`
    /// The image data as a [`glib::Bytes`][crate::glib::Bytes]
    ///
    /// # Returns
    ///
    /// [`true`] if the write was successful, or [`false`] if the loader
    /// cannot parse the buffer.
    #[doc(alias = "gdk_pixbuf_loader_write_bytes")]
    fn write_bytes(&self, buffer: &glib::Bytes) -> Result<(), glib::Error>;

    /// This signal is emitted when the pixbuf loader has allocated the
    /// pixbuf in the desired size. After this signal is emitted,
    /// applications can call [`pixbuf()`][Self::pixbuf()] to fetch
    /// the partially-loaded pixbuf.
    #[doc(alias = "area-prepared")]
    fn connect_area_prepared<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId;

    /// This signal is emitted when a significant area of the image being
    /// loaded has been updated. Normally it means that a complete
    /// scanline has been read in, but it could be a different area as
    /// well. Applications can use this signal to know when to repaint
    /// areas of an image that is being loaded.
    /// ## `x`
    /// X offset of upper-left corner of the updated area.
    /// ## `y`
    /// Y offset of upper-left corner of the updated area.
    /// ## `width`
    /// Width of updated area.
    /// ## `height`
    /// Height of updated area.
    #[doc(alias = "area-updated")]
    fn connect_area_updated<F: Fn(&Self, i32, i32, i32, i32) + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId;

    /// This signal is emitted when [`close()`][Self::close()] is called.
    /// It can be used by different parts of an application to receive
    /// notification when an image loader is closed by the code that
    /// drives it.
    #[doc(alias = "closed")]
    fn connect_closed<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId;

    /// This signal is emitted when the pixbuf loader has been fed the
    /// initial amount of data that is required to figure out the size
    /// of the image that it will create. Applications can call
    /// [`set_size()`][Self::set_size()] in response to this signal to set
    /// the desired size to which the image should be scaled.
    /// ## `width`
    /// the original width of the image
    /// ## `height`
    /// the original height of the image
    #[doc(alias = "size-prepared")]
    fn connect_size_prepared<F: Fn(&Self, i32, i32) + 'static>(&self, f: F) -> SignalHandlerId;
}

impl<O: IsA<PixbufLoader>> PixbufLoaderExt for O {
    fn close(&self) -> Result<(), glib::Error> {
        unsafe {
            let mut error = ptr::null_mut();
            let _ = ffi::gdk_pixbuf_loader_close(self.as_ref().to_glib_none().0, &mut error);
            if error.is_null() {
                Ok(())
            } else {
                Err(from_glib_full(error))
            }
        }
    }

    fn animation(&self) -> Option<PixbufAnimation> {
        unsafe {
            from_glib_none(ffi::gdk_pixbuf_loader_get_animation(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    fn format(&self) -> Option<PixbufFormat> {
        unsafe {
            from_glib_none(ffi::gdk_pixbuf_loader_get_format(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    fn pixbuf(&self) -> Option<Pixbuf> {
        unsafe {
            from_glib_none(ffi::gdk_pixbuf_loader_get_pixbuf(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    fn set_size(&self, width: i32, height: i32) {
        unsafe {
            ffi::gdk_pixbuf_loader_set_size(self.as_ref().to_glib_none().0, width, height);
        }
    }

    fn write(&self, buf: &[u8]) -> Result<(), glib::Error> {
        let count = buf.len() as usize;
        unsafe {
            let mut error = ptr::null_mut();
            let _ = ffi::gdk_pixbuf_loader_write(
                self.as_ref().to_glib_none().0,
                buf.to_glib_none().0,
                count,
                &mut error,
            );
            if error.is_null() {
                Ok(())
            } else {
                Err(from_glib_full(error))
            }
        }
    }

    fn write_bytes(&self, buffer: &glib::Bytes) -> Result<(), glib::Error> {
        unsafe {
            let mut error = ptr::null_mut();
            let _ = ffi::gdk_pixbuf_loader_write_bytes(
                self.as_ref().to_glib_none().0,
                buffer.to_glib_none().0,
                &mut error,
            );
            if error.is_null() {
                Ok(())
            } else {
                Err(from_glib_full(error))
            }
        }
    }

    fn connect_area_prepared<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn area_prepared_trampoline<P: IsA<PixbufLoader>, F: Fn(&P) + 'static>(
            this: *mut ffi::GdkPixbufLoader,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(PixbufLoader::from_glib_borrow(this).unsafe_cast_ref())
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                b"area-prepared\0".as_ptr() as *const _,
                Some(transmute::<_, unsafe extern "C" fn()>(
                    area_prepared_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    fn connect_area_updated<F: Fn(&Self, i32, i32, i32, i32) + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId {
        unsafe extern "C" fn area_updated_trampoline<
            P: IsA<PixbufLoader>,
            F: Fn(&P, i32, i32, i32, i32) + 'static,
        >(
            this: *mut ffi::GdkPixbufLoader,
            x: libc::c_int,
            y: libc::c_int,
            width: libc::c_int,
            height: libc::c_int,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(
                PixbufLoader::from_glib_borrow(this).unsafe_cast_ref(),
                x,
                y,
                width,
                height,
            )
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                b"area-updated\0".as_ptr() as *const _,
                Some(transmute::<_, unsafe extern "C" fn()>(
                    area_updated_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    fn connect_closed<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn closed_trampoline<P: IsA<PixbufLoader>, F: Fn(&P) + 'static>(
            this: *mut ffi::GdkPixbufLoader,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(PixbufLoader::from_glib_borrow(this).unsafe_cast_ref())
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                b"closed\0".as_ptr() as *const _,
                Some(transmute::<_, unsafe extern "C" fn()>(
                    closed_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    fn connect_size_prepared<F: Fn(&Self, i32, i32) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn size_prepared_trampoline<
            P: IsA<PixbufLoader>,
            F: Fn(&P, i32, i32) + 'static,
        >(
            this: *mut ffi::GdkPixbufLoader,
            width: libc::c_int,
            height: libc::c_int,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(
                PixbufLoader::from_glib_borrow(this).unsafe_cast_ref(),
                width,
                height,
            )
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                b"size-prepared\0".as_ptr() as *const _,
                Some(transmute::<_, unsafe extern "C" fn()>(
                    size_prepared_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }
}

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