// 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::AttrType;
use crate::Attribute;
use glib::translate::*;
use std::mem;

#[cfg(any(feature = "v1_44", feature = "dox"))]
#[cfg_attr(feature = "dox", doc(cfg(feature = "v1_44")))]
glib::wrapper! {
    /// The [`AttrIterator`][crate::AttrIterator] structure is used to represent an
    /// iterator through a [`AttrList`][crate::AttrList]. A new iterator is created
    /// with [`AttrList::iterator()`][crate::AttrList::iterator()]. Once the iterator
    /// is created, it can be advanced through the style changes
    /// in the text using [`next()`][Self::next()]. At each
    /// style change, the range of the current style segment and the
    /// attributes currently in effect can be queried.
    #[derive(Debug, PartialEq, Eq, PartialOrd, Ord, Hash)]
    pub struct AttrIterator(Boxed<ffi::PangoAttrIterator>);

    match fn {
        copy => |ptr| ffi::pango_attr_iterator_copy(mut_override(ptr)),
        free => |ptr| ffi::pango_attr_iterator_destroy(ptr),
        type_ => || ffi::pango_attr_iterator_get_type(),
    }
}

#[cfg(not(any(feature = "v1_44", feature = "dox")))]
glib::wrapper! {
    #[derive(Debug, PartialEq, Eq, PartialOrd, Ord, Hash)]
    pub struct AttrIterator(Boxed<ffi::PangoAttrIterator>);

    match fn {
        copy => |ptr| ffi::pango_attr_iterator_copy(mut_override(ptr)),
        free => |ptr| ffi::pango_attr_iterator_destroy(ptr),
    }
}

impl AttrIterator {
    /// Find the current attribute of a particular type at the iterator
    /// location. When multiple attributes of the same type overlap,
    /// the attribute whose range starts closest to the current location
    /// is used.
    /// ## `type_`
    /// the type of attribute to find.
    ///
    /// # Returns
    ///
    /// the current attribute of the given type,
    ///  or [`None`] if no attribute of that type applies to the
    ///  current location.
    #[doc(alias = "pango_attr_iterator_get")]
    pub fn get(&mut self, type_: AttrType) -> Option<Attribute> {
        unsafe {
            from_glib_none(ffi::pango_attr_iterator_get(
                self.to_glib_none_mut().0,
                type_.into_glib(),
            ))
        }
    }

    /// Gets a list of all attributes at the current position of the
    /// iterator.
    ///
    /// # Returns
    ///
    /// a list of
    ///  all attributes for the current range.
    ///  To free this value, call `pango_attribute_destroy()` on
    ///  each value and `g_slist_free()` on the list.
    #[doc(alias = "pango_attr_iterator_get_attrs")]
    #[doc(alias = "get_attrs")]
    pub fn attrs(&mut self) -> Vec<Attribute> {
        unsafe {
            FromGlibPtrContainer::from_glib_full(ffi::pango_attr_iterator_get_attrs(
                self.to_glib_none_mut().0,
            ))
        }
    }

    /// Advance the iterator until the next change of style.
    ///
    /// # Returns
    ///
    /// [`false`] if the iterator is at the end of the list, otherwise [`true`]
    #[doc(alias = "pango_attr_iterator_next")]
    pub fn next(&mut self) -> bool {
        unsafe { from_glib(ffi::pango_attr_iterator_next(self.to_glib_none_mut().0)) }
    }

    /// Get the range of the current segment. Note that the
    /// stored return values are signed, not unsigned like
    /// the values in [`Attribute`][crate::Attribute]. To deal with this API
    /// oversight, stored return values that wouldn't fit into
    /// a signed integer are clamped to `G_MAXINT`.
    ///
    /// # Returns
    ///
    ///
    /// ## `start`
    /// location to store the start of the range
    ///
    /// ## `end`
    /// location to store the end of the range
    #[doc(alias = "pango_attr_iterator_range")]
    pub fn range(&mut self) -> (i32, i32) {
        unsafe {
            let mut start = mem::MaybeUninit::uninit();
            let mut end = mem::MaybeUninit::uninit();
            ffi::pango_attr_iterator_range(
                self.to_glib_none_mut().0,
                start.as_mut_ptr(),
                end.as_mut_ptr(),
            );
            let start = start.assume_init();
            let end = end.assume_init();
            (start, end)
        }
    }
}