gtk4/
tree_sortable.rs

1// Take a look at the license at the top of the repository in the LICENSE file.
2
3use std::{fmt, mem};
4
5use glib::translate::*;
6
7use crate::{ffi, prelude::*, Ordering, SortType, TreeIter, TreeModel, TreeSortable};
8
9#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash)]
10#[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
11#[allow(deprecated)]
12pub enum SortColumn {
13    #[doc(alias = "GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID")]
14    Default,
15    Index(u32),
16}
17
18#[doc(hidden)]
19impl IntoGlib for SortColumn {
20    type GlibType = i32;
21
22    #[inline]
23    fn into_glib(self) -> i32 {
24        match self {
25            SortColumn::Default => ffi::GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID,
26            SortColumn::Index(x) => {
27                assert!(x <= i32::MAX as u32, "column index is too big");
28                x as i32
29            }
30        }
31    }
32}
33
34#[doc(hidden)]
35impl FromGlib<i32> for SortColumn {
36    #[inline]
37    unsafe fn from_glib(val: i32) -> Self {
38        skip_assert_initialized!();
39        match val {
40            ffi::GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID => Self::Default,
41            x => {
42                assert!(x >= 0, "invalid column index");
43                Self::Index(x as u32)
44            }
45        }
46    }
47}
48
49impl fmt::Display for SortColumn {
50    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
51        write!(
52            f,
53            "SortColumn::{}",
54            match *self {
55                SortColumn::Default => "Default",
56                SortColumn::Index(_) => "Index",
57            }
58        )
59    }
60}
61
62// rustdoc-stripper-ignore-next
63/// Trait containing manually implemented methods of
64/// [`TreeSortable`](crate::TreeSortable).
65#[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
66#[allow(deprecated)]
67pub trait TreeSortableExtManual: IsA<TreeSortable> + 'static {
68    #[doc(alias = "gtk_tree_sortable_set_default_sort_func")]
69    fn set_default_sort_func<F>(&self, sort_func: F)
70    where
71        F: Fn(&Self, &TreeIter, &TreeIter) -> Ordering + 'static,
72    {
73        unsafe {
74            ffi::gtk_tree_sortable_set_default_sort_func(
75                self.as_ref().to_glib_none().0,
76                Some(trampoline::<Self, F>),
77                into_raw(sort_func),
78                Some(destroy_closure::<Self, F>),
79            )
80        }
81    }
82    #[doc(alias = "gtk_tree_sortable_set_sort_func")]
83    fn set_sort_func<F>(&self, sort_column_id: SortColumn, sort_func: F)
84    where
85        F: Fn(&Self, &TreeIter, &TreeIter) -> Ordering + 'static,
86    {
87        unsafe {
88            ffi::gtk_tree_sortable_set_sort_func(
89                self.as_ref().to_glib_none().0,
90                sort_column_id.into_glib(),
91                Some(trampoline::<Self, F>),
92                into_raw(sort_func),
93                Some(destroy_closure::<Self, F>),
94            )
95        }
96    }
97    #[doc(alias = "gtk_tree_sortable_get_sort_column_id")]
98    #[doc(alias = "get_sort_column_id")]
99    fn sort_column_id(&self) -> Option<(SortColumn, SortType)> {
100        unsafe {
101            let mut sort_column_id = mem::MaybeUninit::uninit();
102            let mut order = mem::MaybeUninit::uninit();
103            ffi::gtk_tree_sortable_get_sort_column_id(
104                self.as_ref().to_glib_none().0,
105                sort_column_id.as_mut_ptr(),
106                order.as_mut_ptr(),
107            );
108            let sort_column_id = sort_column_id.assume_init();
109            if sort_column_id != ffi::GTK_TREE_SORTABLE_UNSORTED_SORT_COLUMN_ID {
110                Some((from_glib(sort_column_id), from_glib(order.assume_init())))
111            } else {
112                None
113            }
114        }
115    }
116    #[doc(alias = "gtk_tree_sortable_set_sort_column_id")]
117    fn set_sort_column_id(&self, sort_column_id: SortColumn, order: SortType) {
118        unsafe {
119            ffi::gtk_tree_sortable_set_sort_column_id(
120                self.as_ref().to_glib_none().0,
121                sort_column_id.into_glib(),
122                order.into_glib(),
123            );
124        }
125    }
126    #[doc(alias = "gtk_tree_sortable_set_sort_column_id")]
127    fn set_unsorted(&self) {
128        unsafe {
129            ffi::gtk_tree_sortable_set_sort_column_id(
130                self.as_ref().to_glib_none().0,
131                ffi::GTK_TREE_SORTABLE_UNSORTED_SORT_COLUMN_ID,
132                SortType::Ascending.into_glib(),
133            );
134        }
135    }
136}
137
138unsafe extern "C" fn trampoline<T, F: Fn(&T, &TreeIter, &TreeIter) -> Ordering>(
139    this: *mut ffi::GtkTreeModel,
140    iter: *mut ffi::GtkTreeIter,
141    iter2: *mut ffi::GtkTreeIter,
142    f: glib::ffi::gpointer,
143) -> i32
144where
145    T: IsA<TreeSortable>,
146{
147    let f: &F = &*(f as *const F);
148    f(
149        &TreeModel::from_glib_none(this).unsafe_cast(),
150        &from_glib_borrow(iter),
151        &from_glib_borrow(iter2),
152    )
153    .into_glib()
154}
155
156unsafe extern "C" fn destroy_closure<T, F: Fn(&T, &TreeIter, &TreeIter) -> Ordering>(
157    ptr: glib::ffi::gpointer,
158) {
159    let _ = Box::<F>::from_raw(ptr as *mut _);
160}
161
162fn into_raw<F, T>(func: F) -> glib::ffi::gpointer
163where
164    F: Fn(&T, &TreeIter, &TreeIter) -> Ordering + 'static,
165{
166    skip_assert_initialized!();
167    let func: Box<F> = Box::new(func);
168    Box::into_raw(func) as glib::ffi::gpointer
169}
170
171impl<O: IsA<TreeSortable>> TreeSortableExtManual for O {}
gtk4/tree_sortable.rs

gtk4/
tree_sortable.rs
