1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
// 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::AttrIterator;
use crate::Attribute;
use glib::translate::*;
#[cfg(any(feature = "v1_50", feature = "dox"))]
#[cfg_attr(feature = "dox", doc(cfg(feature = "v1_50")))]
use std::fmt;

glib::wrapper! {
    /// A [`AttrList`][crate::AttrList] represents a list of attributes that apply to a section
    /// of text.
    ///
    /// The attributes in a [`AttrList`][crate::AttrList] are, in general, allowed to overlap in
    /// an arbitrary fashion. However, if the attributes are manipulated only through
    /// [`change()`][Self::change()], the overlap between properties will meet
    /// stricter criteria.
    ///
    /// Since the [`AttrList`][crate::AttrList] structure is stored as a linear list, it is not
    /// suitable for storing attributes for large amounts of text. In general, you
    /// should not use a single [`AttrList`][crate::AttrList] for more than one paragraph of text.
    #[derive(Debug)]
    pub struct AttrList(Shared<ffi::PangoAttrList>);

    match fn {
        ref => |ptr| ffi::pango_attr_list_ref(ptr),
        unref => |ptr| ffi::pango_attr_list_unref(ptr),
        type_ => || ffi::pango_attr_list_get_type(),
    }
}

impl AttrList {
    /// Create a new empty attribute list with a reference
    /// count of one.
    ///
    /// # Returns
    ///
    /// the newly allocated
    ///   [`AttrList`][crate::AttrList], which should be freed with
    ///   `Pango::AttrList::unref()`
    #[doc(alias = "pango_attr_list_new")]
    pub fn new() -> AttrList {
        unsafe { from_glib_full(ffi::pango_attr_list_new()) }
    }

    #[doc(alias = "pango_attr_list_copy")]
    #[must_use]
    pub fn copy(&self) -> Option<AttrList> {
        unsafe { from_glib_full(ffi::pango_attr_list_copy(self.to_glib_none().0)) }
    }

    /// Given a [`AttrList`][crate::AttrList] and callback function, removes
    /// any elements of @self for which @func returns [`true`] and
    /// inserts them into a new list.
    /// ## `func`
    /// callback function;
    ///   returns [`true`] if an attribute should be filtered out
    ///
    /// # Returns
    ///
    /// the new
    ///   [`AttrList`][crate::AttrList] or [`None`] if no attributes of the
    ///   given types were found
    #[doc(alias = "pango_attr_list_filter")]
    #[must_use]
    pub fn filter<P: FnMut(&Attribute) -> bool>(&self, func: P) -> Option<AttrList> {
        let func_data: P = func;
        unsafe extern "C" fn func_func<P: FnMut(&Attribute) -> bool>(
            attribute: *mut ffi::PangoAttribute,
            user_data: glib::ffi::gpointer,
        ) -> glib::ffi::gboolean {
            let attribute = from_glib_borrow(attribute);
            let callback: *mut P = user_data as *const _ as usize as *mut P;
            let res = (*callback)(&attribute);
            res.into_glib()
        }
        let func = Some(func_func::<P> as _);
        let super_callback0: &P = &func_data;
        unsafe {
            from_glib_full(ffi::pango_attr_list_filter(
                self.to_glib_none().0,
                func,
                super_callback0 as *const _ as usize as *mut _,
            ))
        }
    }

    /// Gets a list of all attributes in @self.
    ///
    /// # Returns
    ///
    ///
    ///   a list of all attributes in @self. To free this value,
    ///   call `Pango::Attribute::destroy()` on each value and
    ///   g_slist_free() on the list.
    #[cfg(any(feature = "v1_44", feature = "dox"))]
    #[cfg_attr(feature = "dox", doc(cfg(feature = "v1_44")))]
    #[doc(alias = "pango_attr_list_get_attributes")]
    #[doc(alias = "get_attributes")]
    pub fn attributes(&self) -> Vec<Attribute> {
        unsafe {
            FromGlibPtrContainer::from_glib_full(ffi::pango_attr_list_get_attributes(
                self.to_glib_none().0,
            ))
        }
    }

    /// Create a iterator initialized to the beginning of the list.
    ///
    /// @self must not be modified until this iterator is freed.
    ///
    /// # Returns
    ///
    /// the newly allocated
    ///   [`AttrIterator`][crate::AttrIterator], which should be freed with
    ///   `Pango::AttrIterator::destroy()`
    #[doc(alias = "pango_attr_list_get_iterator")]
    #[doc(alias = "get_iterator")]
    pub fn iterator(&self) -> AttrIterator {
        unsafe { from_glib_full(ffi::pango_attr_list_get_iterator(self.to_glib_none().0)) }
    }

    /// This function opens up a hole in @self, fills it
    /// in with attributes from the left, and then merges
    /// @other on top of the hole.
    ///
    /// This operation is equivalent to stretching every attribute
    /// that applies at position @pos in @self by an amount @len,
    /// and then calling [`change()`][Self::change()] with a copy
    /// of each attribute in @other in sequence (offset in position
    /// by @pos, and limited in length to @len).
    ///
    /// This operation proves useful for, for instance, inserting
    /// a pre-edit string in the middle of an edit buffer.
    ///
    /// For backwards compatibility, the function behaves differently
    /// when @len is 0. In this case, the attributes from @other are
    /// not imited to @len, and are just overlayed on top of @self.
    ///
    /// This mode is useful for merging two lists of attributes together.
    /// ## `other`
    /// another [`AttrList`][crate::AttrList]
    /// ## `pos`
    /// the position in @self at which to insert @other
    /// ## `len`
    /// the length of the spliced segment. (Note that this
    ///   must be specified since the attributes in @other may only
    ///   be present at some subsection of this range)
    #[doc(alias = "pango_attr_list_splice")]
    pub fn splice(&self, other: &AttrList, pos: i32, len: i32) {
        unsafe {
            ffi::pango_attr_list_splice(self.to_glib_none().0, other.to_glib_none().0, pos, len);
        }
    }

    /// Serializes a [`AttrList`][crate::AttrList] to a string.
    ///
    /// No guarantees are made about the format of the string,
    /// it may change between Pango versions.
    ///
    /// The intended use of this function is testing and
    /// debugging. The format is not meant as a permanent
    /// storage format.
    ///
    /// # Returns
    ///
    /// a newly allocated string
    #[cfg(any(feature = "v1_50", feature = "dox"))]
    #[cfg_attr(feature = "dox", doc(cfg(feature = "v1_50")))]
    #[doc(alias = "pango_attr_list_to_string")]
    #[doc(alias = "to_string")]
    pub fn to_str(&self) -> glib::GString {
        unsafe { from_glib_full(ffi::pango_attr_list_to_string(self.to_glib_none().0)) }
    }

    /// Update indices of attributes in @self for a change in the
    /// text they refer to.
    ///
    /// The change that this function applies is removing @remove
    /// bytes at position @pos and inserting @add bytes instead.
    ///
    /// Attributes that fall entirely in the (@pos, @pos + @remove)
    /// range are removed.
    ///
    /// Attributes that start or end inside the (@pos, @pos + @remove)
    /// range are shortened to reflect the removal.
    ///
    /// Attributes start and end positions are updated if they are
    /// behind @pos + @remove.
    /// ## `pos`
    /// the position of the change
    /// ## `remove`
    /// the number of removed bytes
    /// ## `add`
    /// the number of added bytes
    #[cfg(any(feature = "v1_44", feature = "dox"))]
    #[cfg_attr(feature = "dox", doc(cfg(feature = "v1_44")))]
    #[doc(alias = "pango_attr_list_update")]
    pub fn update(&self, pos: i32, remove: i32, add: i32) {
        unsafe {
            ffi::pango_attr_list_update(self.to_glib_none().0, pos, remove, add);
        }
    }

    /// Deserializes a [`AttrList`][crate::AttrList] from a string.
    ///
    /// This is the counterpart to [`to_str()`][Self::to_str()].
    /// See that functions for details about the format.
    /// ## `text`
    /// a string
    ///
    /// # Returns
    ///
    /// a new [`AttrList`][crate::AttrList]
    #[cfg(any(feature = "v1_50", feature = "dox"))]
    #[cfg_attr(feature = "dox", doc(cfg(feature = "v1_50")))]
    #[doc(alias = "pango_attr_list_from_string")]
    pub fn from_string(text: &str) -> Result<AttrList, glib::BoolError> {
        unsafe {
            Option::<_>::from_glib_full(ffi::pango_attr_list_from_string(text.to_glib_none().0))
                .ok_or_else(|| glib::bool_error!("Can't parse AttrList"))
        }
    }
}

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

#[cfg(any(feature = "v1_50", feature = "dox"))]
#[cfg_attr(feature = "dox", doc(cfg(feature = "v1_50")))]
impl fmt::Display for AttrList {
    #[inline]
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        f.write_str(&self.to_str())
    }
}