// 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 glib::translate::*;
use glib::GString;
use gtk_sys;
use std::cmp;
use std::fmt;
use std::mem;

glib_wrapper! {
    #[derive(Debug, Hash)]
    pub struct TreePath(Boxed<gtk_sys::GtkTreePath>);

    match fn {
        copy => |ptr| gtk_sys::gtk_tree_path_copy(mut_override(ptr)),
        free => |ptr| gtk_sys::gtk_tree_path_free(ptr),
        get_type => || gtk_sys::gtk_tree_path_get_type(),
    }
}

impl TreePath {
    /// Creates a new `TreePath`-struct.
    /// This refers to a row.
    ///
    /// # Returns
    ///
    /// A newly created `TreePath`-struct.
    pub fn new() -> TreePath {
        assert_initialized_main_thread!();
        unsafe { from_glib_full(gtk_sys::gtk_tree_path_new()) }
    }

    /// Creates a new `TreePath`-struct.
    ///
    /// The string representation of this path is “0”.
    ///
    /// # Returns
    ///
    /// A new `TreePath`-struct
    pub fn new_first() -> TreePath {
        assert_initialized_main_thread!();
        unsafe { from_glib_full(gtk_sys::gtk_tree_path_new_first()) }
    }

    //pub fn from_indices(first_index: i32, : /*Unknown conversion*//*Unimplemented*/Fundamental: VarArgs) -> TreePath {
    //    unsafe { TODO: call gtk_sys:gtk_tree_path_new_from_indices() }
    //}

    pub fn from_indicesv(indices: &[i32]) -> TreePath {
        assert_initialized_main_thread!();
        let length = indices.len() as usize;
        unsafe {
            from_glib_full(gtk_sys::gtk_tree_path_new_from_indicesv(
                indices.to_glib_none().0,
                length,
            ))
        }
    }

    pub fn from_string(path: &str) -> TreePath {
        assert_initialized_main_thread!();
        unsafe {
            from_glib_full(gtk_sys::gtk_tree_path_new_from_string(
                path.to_glib_none().0,
            ))
        }
    }

    /// Appends a new index to a path.
    ///
    /// As a result, the depth of the path is increased.
    /// ## `index_`
    /// the index
    pub fn append_index(&mut self, index_: i32) {
        unsafe {
            gtk_sys::gtk_tree_path_append_index(self.to_glib_none_mut().0, index_);
        }
    }

    /// Compares two paths.
    ///
    /// If `self` appears before `b` in a tree, then -1 is returned.
    /// If `b` appears before `self`, then 1 is returned.
    /// If the two nodes are equal, then 0 is returned.
    /// ## `b`
    /// a `TreePath`-struct to compare with
    ///
    /// # Returns
    ///
    /// the relative positions of `self` and `b`
    fn compare(&self, b: &TreePath) -> i32 {
        unsafe { gtk_sys::gtk_tree_path_compare(self.to_glib_none().0, b.to_glib_none().0) }
    }

    /// Moves `self` to point to the first child of the current path.
    pub fn down(&mut self) {
        unsafe {
            gtk_sys::gtk_tree_path_down(self.to_glib_none_mut().0);
        }
    }

    /// Returns the current depth of `self`.
    ///
    /// # Returns
    ///
    /// The depth of `self`
    pub fn get_depth(&self) -> i32 {
        unsafe { gtk_sys::gtk_tree_path_get_depth(mut_override(self.to_glib_none().0)) }
    }

    /// Returns the current indices of `self`.
    ///
    /// This is an array of integers, each representing a node in a tree.
    /// It also returns the number of elements in the array.
    /// The array should not be freed.
    /// ## `depth`
    /// return location for number of elements
    ///  returned in the integer array, or `None`
    ///
    /// # Returns
    ///
    /// The current
    ///  indices, or `None`
    pub fn get_indices_with_depth(&mut self) -> Vec<i32> {
        unsafe {
            let mut depth = mem::MaybeUninit::uninit();
            let ret = FromGlibContainer::from_glib_none_num(
                gtk_sys::gtk_tree_path_get_indices_with_depth(
                    self.to_glib_none_mut().0,
                    depth.as_mut_ptr(),
                ),
                depth.assume_init() as usize,
            );
            ret
        }
    }

    /// Returns `true` if `descendant` is a descendant of `self`.
    /// ## `descendant`
    /// another `TreePath`-struct
    ///
    /// # Returns
    ///
    /// `true` if `descendant` is contained inside `self`
    pub fn is_ancestor(&self, descendant: &TreePath) -> bool {
        unsafe {
            from_glib(gtk_sys::gtk_tree_path_is_ancestor(
                mut_override(self.to_glib_none().0),
                mut_override(descendant.to_glib_none().0),
            ))
        }
    }

    /// Returns `true` if `self` is a descendant of `ancestor`.
    /// ## `ancestor`
    /// another `TreePath`-struct
    ///
    /// # Returns
    ///
    /// `true` if `ancestor` contains `self` somewhere below it
    pub fn is_descendant(&self, ancestor: &TreePath) -> bool {
        unsafe {
            from_glib(gtk_sys::gtk_tree_path_is_descendant(
                mut_override(self.to_glib_none().0),
                mut_override(ancestor.to_glib_none().0),
            ))
        }
    }

    /// Moves the `self` to point to the next node at the current depth.
    pub fn next(&mut self) {
        unsafe {
            gtk_sys::gtk_tree_path_next(self.to_glib_none_mut().0);
        }
    }

    /// Prepends a new index to a path.
    ///
    /// As a result, the depth of the path is increased.
    /// ## `index_`
    /// the index
    pub fn prepend_index(&mut self, index_: i32) {
        unsafe {
            gtk_sys::gtk_tree_path_prepend_index(self.to_glib_none_mut().0, index_);
        }
    }

    /// Moves the `self` to point to the previous node at the
    /// current depth, if it exists.
    ///
    /// # Returns
    ///
    /// `true` if `self` has a previous node, and
    ///  the move was made
    pub fn prev(&mut self) -> bool {
        unsafe { from_glib(gtk_sys::gtk_tree_path_prev(self.to_glib_none_mut().0)) }
    }

    /// Generates a string representation of the path.
    ///
    /// This string is a “:” separated list of numbers.
    /// For example, “4:10:0:3” would be an acceptable
    /// return value for this string.
    ///
    /// # Returns
    ///
    /// A newly-allocated string.
    ///  Must be freed with `g_free`.
    fn to_string(&self) -> GString {
        unsafe {
            from_glib_full(gtk_sys::gtk_tree_path_to_string(mut_override(
                self.to_glib_none().0,
            )))
        }
    }

    /// Moves the `self` to point to its parent node, if it has a parent.
    ///
    /// # Returns
    ///
    /// `true` if `self` has a parent, and the move was made
    pub fn up(&mut self) -> bool {
        unsafe { from_glib(gtk_sys::gtk_tree_path_up(self.to_glib_none_mut().0)) }
    }
}

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

impl PartialEq for TreePath {
    #[inline]
    fn eq(&self, other: &Self) -> bool {
        self.compare(other) == 0
    }
}

impl Eq for TreePath {}

impl PartialOrd for TreePath {
    #[inline]
    fn partial_cmp(&self, other: &Self) -> Option<cmp::Ordering> {
        self.compare(other).partial_cmp(&0)
    }
}

impl Ord for TreePath {
    #[inline]
    fn cmp(&self, other: &Self) -> cmp::Ordering {
        self.compare(other).cmp(&0)
    }
}

impl fmt::Display for TreePath {
    #[inline]
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(f, "{}", self.to_string())
    }
}