// This file was generated by gir (https://github.com/gtk-rs/gir)
// from gir-files (https://github.com/gtk-rs/gir-files)
// from gst-gir-files (https://gitlab.freedesktop.org/gstreamer/gir-files-rs.git)
// DO NOT EDIT

use crate::Edge;
use crate::EditMode;
use crate::Extractable;
use crate::Layer;
use crate::TimelineElement;
use glib::object::Cast;
use glib::object::IsA;
use glib::signal::connect_raw;
use glib::signal::SignalHandlerId;
use glib::translate::*;
use glib::StaticType;
use std::boxed::Box as Box_;
use std::mem::transmute;

glib::wrapper! {
    /// A [`crate::Container`] is a timeline element that controls other
    /// [`crate::TimelineElement`]-s, which are its children. In particular, it is
    /// responsible for maintaining the relative [`crate::TimelineElement:start`] and
    /// [`crate::TimelineElement:duration`] times of its children. Therefore, if a
    /// container is temporally adjusted or moved to a new layer, it may
    /// accordingly adjust and move its children. Similarly, a change in one of
    /// its children may prompt the parent to correspondingly change its
    /// siblings.
    ///
    /// This is an Abstract Base Class, you cannot instantiate it.
    ///
    /// # Implements
    ///
    /// [`trait@crate::prelude::GESContainerExt`], [`trait@crate::prelude::TimelineElementExt`], [`trait@glib::object::ObjectExt`], [`trait@crate::prelude::ExtractableExt`], [`trait@crate::prelude::TimelineElementExtManual`]
    pub struct Container(Object<ffi::GESContainer, ffi::GESContainerClass>) @extends TimelineElement, @implements Extractable;

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

impl Container {
    /// Groups the containers into a single container by merging them. The
    /// containers must all belong to the same [`crate::TimelineElement:timeline`].
    ///
    /// If the elements are all [`crate::Clip`]-s then this method will attempt to
    /// combine them all into a single [`crate::Clip`]. This should succeed if they:
    /// share the same [`crate::TimelineElement:start`], [`crate::TimelineElement:duration`]
    /// and [`crate::TimelineElement:in-point`]; exist in the same layer; and all of
    /// the sources share the same [`crate::Asset`]. If this fails, or one of the
    /// elements is not a [`crate::Clip`], this method will try to create a [`crate::Group`]
    /// instead.
    /// ## `containers`
    ///
    /// The [`crate::Container`]-s to group
    ///
    /// # Returns
    ///
    /// The container created by merging
    /// `containers`, or [`None`] if they could not be merged into a single
    /// container.
    #[doc(alias = "ges_container_group")]
    pub fn group(containers: &[Container]) -> Option<Container> {
        assert_initialized_main_thread!();
        unsafe { from_glib_none(ffi::ges_container_group(containers.to_glib_none().0)) }
    }
}

pub const NONE_CONTAINER: Option<&Container> = None;

/// Trait containing all `Container` methods.
///
/// # Implementors
///
/// [`struct@crate::Clip`], [`struct@crate::Container`], [`struct@crate::Group`]
pub trait GESContainerExt: 'static {
    /// Adds a timeline element to the container. The element will now be a
    /// child of the container (and the container will be the
    /// [`crate::TimelineElement:parent`] of the added element), which means that it
    /// is now controlled by the container. This may change the properties of
    /// the child or the container, depending on the subclass.
    ///
    /// Additionally, the children properties of the newly added element will
    /// be shared with the container, meaning they can also be read and set
    /// using [`crate::prelude::TimelineElementExt::get_child_property()`] and
    /// [`crate::prelude::TimelineElementExt::set_child_property()`] on the container.
    /// ## `child`
    /// The element to add as a child
    ///
    /// # Returns
    ///
    /// [`true`] if `child` was successfully added to `self`.
    #[doc(alias = "ges_container_add")]
    fn add<P: IsA<TimelineElement>>(&self, child: &P) -> Result<(), glib::error::BoolError>;

    /// Edits the container within its timeline.
    ///
    /// # Deprecated since 1.18
    ///
    /// use [`crate::prelude::TimelineElementExt::edit`] instead.
    /// ## `layers`
    /// A whitelist of layers
    /// where the edit can be performed, [`None`] allows all layers in the
    /// timeline
    /// ## `new_layer_priority`
    /// The priority/index of the layer `self` should
    /// be moved to. -1 means no move
    /// ## `mode`
    /// The edit mode
    /// ## `edge`
    /// The edge of `self` where the edit should occur
    /// ## `position`
    /// The edit position: a new location for the edge of `self`
    /// (in nanoseconds)
    ///
    /// # Returns
    ///
    /// [`true`] if the edit of `self` completed, [`false`] on failure.
    #[cfg_attr(feature = "v1_18", deprecated = "Since 1.18")]
    #[doc(alias = "ges_container_edit")]
    fn edit(
        &self,
        layers: &[Layer],
        new_layer_priority: i32,
        mode: EditMode,
        edge: Edge,
        position: u64,
    ) -> Result<(), glib::error::BoolError>;

    /// Get the list of timeline elements contained in the container. If
    /// `recursive` is [`true`], and the container contains other containers as
    /// children, then their children will be added to the list, in addition to
    /// themselves, and so on.
    /// ## `recursive`
    /// Whether to recursively get children in `self`
    ///
    /// # Returns
    ///
    /// The list of
    /// [`crate::TimelineElement`]-s contained in `self`.
    #[doc(alias = "ges_container_get_children")]
    #[doc(alias = "get_children")]
    fn children(&self, recursive: bool) -> Vec<TimelineElement>;

    /// Removes a timeline element from the container. The element will no
    /// longer be controlled by the container.
    /// ## `child`
    /// The child to remove
    ///
    /// # Returns
    ///
    /// [`true`] if `child` was successfully removed from `self`.
    #[doc(alias = "ges_container_remove")]
    fn remove<P: IsA<TimelineElement>>(&self, child: &P) -> Result<(), glib::error::BoolError>;

    /// Ungroups the container by splitting it into several containers
    /// containing various children of the original. The rules for how the
    /// container splits depends on the subclass. A [`crate::Group`] will simply split
    /// into its children. A [`crate::Clip`] will split into one [`crate::Clip`] per
    /// [`crate::TrackType`] it overlaps with (so an audio-video clip will split into
    /// an audio clip and a video clip), where each clip contains all the
    /// [`crate::TrackElement`]-s from the original clip with a matching
    /// [`crate::TrackElement:track-type`].
    ///
    /// If `recursive` is [`true`], and the container contains other containers as
    /// children, then they will also be ungrouped, and so on.
    /// ## `recursive`
    /// Whether to recursively ungroup `self`
    ///
    /// # Returns
    ///
    /// The list of
    /// new [`crate::Container`]-s created from the splitting of `self`.
    #[doc(alias = "ges_container_ungroup")]
    fn ungroup(&self, recursive: bool) -> Vec<Container>;

    fn height(&self) -> u32;

    /// Will be emitted after a child is added to the container. Usually,
    /// you should connect with `g_signal_connect_after()` since the signal
    /// may be stopped internally.
    /// ## `element`
    /// The child that was added
    #[doc(alias = "child-added")]
    fn connect_child_added<F: Fn(&Self, &TimelineElement) + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId;

    /// Will be emitted after a child is removed from the container.
    /// ## `element`
    /// The child that was removed
    #[doc(alias = "child-removed")]
    fn connect_child_removed<F: Fn(&Self, &TimelineElement) + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId;

    #[doc(alias = "height")]
    fn connect_height_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId;
}

impl<O: IsA<Container>> GESContainerExt for O {
    fn add<P: IsA<TimelineElement>>(&self, child: &P) -> Result<(), glib::error::BoolError> {
        unsafe {
            glib::result_from_gboolean!(
                ffi::ges_container_add(
                    self.as_ref().to_glib_none().0,
                    child.as_ref().to_glib_none().0
                ),
                "Failed to add element"
            )
        }
    }

    fn edit(
        &self,
        layers: &[Layer],
        new_layer_priority: i32,
        mode: EditMode,
        edge: Edge,
        position: u64,
    ) -> Result<(), glib::error::BoolError> {
        unsafe {
            glib::result_from_gboolean!(
                ffi::ges_container_edit(
                    self.as_ref().to_glib_none().0,
                    layers.to_glib_none().0,
                    new_layer_priority,
                    mode.into_glib(),
                    edge.into_glib(),
                    position
                ),
                "Failed to edit container"
            )
        }
    }

    fn children(&self, recursive: bool) -> Vec<TimelineElement> {
        unsafe {
            FromGlibPtrContainer::from_glib_full(ffi::ges_container_get_children(
                self.as_ref().to_glib_none().0,
                recursive.into_glib(),
            ))
        }
    }

    fn remove<P: IsA<TimelineElement>>(&self, child: &P) -> Result<(), glib::error::BoolError> {
        unsafe {
            glib::result_from_gboolean!(
                ffi::ges_container_remove(
                    self.as_ref().to_glib_none().0,
                    child.as_ref().to_glib_none().0
                ),
                "Failed to remove element"
            )
        }
    }

    fn ungroup(&self, recursive: bool) -> Vec<Container> {
        unsafe {
            FromGlibPtrContainer::from_glib_full(ffi::ges_container_ungroup(
                self.as_ref().to_glib_full(),
                recursive.into_glib(),
            ))
        }
    }

    fn height(&self) -> u32 {
        unsafe {
            let mut value = glib::Value::from_type(<u32 as StaticType>::static_type());
            glib::gobject_ffi::g_object_get_property(
                self.to_glib_none().0 as *mut glib::gobject_ffi::GObject,
                b"height\0".as_ptr() as *const _,
                value.to_glib_none_mut().0,
            );
            value
                .get()
                .expect("Return Value for property `height` getter")
        }
    }

    #[doc(alias = "child-added")]
    fn connect_child_added<F: Fn(&Self, &TimelineElement) + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId {
        unsafe extern "C" fn child_added_trampoline<P, F: Fn(&P, &TimelineElement) + 'static>(
            this: *mut ffi::GESContainer,
            element: *mut ffi::GESTimelineElement,
            f: glib::ffi::gpointer,
        ) where
            P: IsA<Container>,
        {
            let f: &F = &*(f as *const F);
            f(
                &Container::from_glib_borrow(this).unsafe_cast_ref(),
                &from_glib_borrow(element),
            )
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                b"child-added\0".as_ptr() as *const _,
                Some(transmute::<_, unsafe extern "C" fn()>(
                    child_added_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "child-removed")]
    fn connect_child_removed<F: Fn(&Self, &TimelineElement) + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId {
        unsafe extern "C" fn child_removed_trampoline<P, F: Fn(&P, &TimelineElement) + 'static>(
            this: *mut ffi::GESContainer,
            element: *mut ffi::GESTimelineElement,
            f: glib::ffi::gpointer,
        ) where
            P: IsA<Container>,
        {
            let f: &F = &*(f as *const F);
            f(
                &Container::from_glib_borrow(this).unsafe_cast_ref(),
                &from_glib_borrow(element),
            )
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                b"child-removed\0".as_ptr() as *const _,
                Some(transmute::<_, unsafe extern "C" fn()>(
                    child_removed_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

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