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
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
// Take a look at the license at the top of the repository in the LICENSE file.

use crate::{ParseLocation, RenderNodeType};
use glib::translate::*;
use glib::{StaticType, Type};
use std::fmt;
use std::path::Path;
use std::ptr;

// Can't use get_type here as this is not a boxed type but another fundamental type
glib::wrapper! {
    /// [`RenderNode`][crate::RenderNode] is the basic block in a scene graph to be
    /// rendered using [`Renderer`][crate::Renderer].
    ///
    /// Each node has a parent, except the top-level node; each node may have
    /// children nodes.
    ///
    /// Each node has an associated drawing surface, which has the size of
    /// the rectangle set when creating it.
    ///
    /// Render nodes are meant to be transient; once they have been associated
    /// to a [`Renderer`][crate::Renderer] it's safe to release any reference you have on
    /// them. All [`RenderNode`][crate::RenderNode]s are immutable, you can only specify their
    /// properties during construction.
    ///
    /// This is an Abstract Base Class, you cannot instantiate it.
    #[derive(Debug, PartialEq, Eq, PartialOrd, Ord, Hash)]
    #[doc(alias = "GskRenderNode")]
    pub struct RenderNode(Shared<ffi::GskRenderNode>);

    match fn {
        ref => |ptr| ffi::gsk_render_node_ref(ptr),
        unref => |ptr| ffi::gsk_render_node_unref(ptr),
    }
}

impl StaticType for RenderNode {
    #[doc(alias = "gsk_render_node_type_get_type")]
    fn static_type() -> Type {
        unsafe { from_glib(ffi::gsk_render_node_type_get_type()) }
    }
}

impl RenderNode {
    /// Loads data previously created via [`serialize()`][Self::serialize()].
    ///
    /// For a discussion of the supported format, see that function.
    /// ## `bytes`
    /// the bytes containing the data
    /// ## `error_func`
    /// Callback on parsing errors
    ///
    /// # Returns
    ///
    /// a new [`RenderNode`][crate::RenderNode]
    #[doc(alias = "gsk_render_node_deserialize")]
    pub fn deserialize(bytes: &glib::Bytes) -> Option<Self> {
        assert_initialized_main_thread!();
        unsafe {
            from_glib_full(ffi::gsk_render_node_deserialize(
                bytes.to_glib_none().0,
                None,
                std::ptr::null_mut(),
            ))
        }
    }

    #[doc(alias = "gsk_render_node_deserialize")]
    pub fn deserialize_with_error_func<P: FnMut(&ParseLocation, &ParseLocation, &glib::Error)>(
        bytes: &glib::Bytes,
        error_func: P,
    ) -> Option<Self> {
        assert_initialized_main_thread!();
        let error_func_data: P = error_func;
        unsafe extern "C" fn error_func_func<
            P: FnMut(&ParseLocation, &ParseLocation, &glib::Error),
        >(
            start: *const ffi::GskParseLocation,
            end: *const ffi::GskParseLocation,
            error: *const glib::ffi::GError,
            user_data: glib::ffi::gpointer,
        ) {
            let start = from_glib_borrow(start);
            let end = from_glib_borrow(end);
            let error = from_glib_borrow(error);
            let callback: *mut P = user_data as *const _ as usize as *mut P;
            (*callback)(&start, &end, &error);
        }
        let error_func = Some(error_func_func::<P> as _);
        let super_callback0: &P = &error_func_data;
        unsafe {
            from_glib_full(ffi::gsk_render_node_deserialize(
                bytes.to_glib_none().0,
                error_func,
                super_callback0 as *const _ as usize as *mut _,
            ))
        }
    }

    pub fn downcast<T: IsRenderNode>(self) -> Result<T, Self> {
        unsafe {
            if self.node_type() == T::NODE_TYPE {
                Ok(from_glib_full(self.to_glib_full()))
            } else {
                Err(self)
            }
        }
    }

    pub fn downcast_ref<T: IsRenderNode>(&self) -> Option<&T> {
        unsafe {
            if self.node_type() == T::NODE_TYPE {
                Some(&*(self as *const RenderNode as *const T))
            } else {
                None
            }
        }
    }

    /// Draw the contents of `self` to the given cairo context.
    ///
    /// Typically, you'll use this function to implement fallback rendering
    /// of [`RenderNode`][crate::RenderNode]s on an intermediate Cairo context, instead of using
    /// the drawing context associated to a [`gdk::Surface`][crate::gdk::Surface]'s rendering buffer.
    ///
    /// For advanced nodes that cannot be supported using Cairo, in particular
    /// for nodes doing 3D operations, this function may fail.
    /// ## `cr`
    /// cairo context to draw to
    #[doc(alias = "gsk_render_node_draw")]
    pub fn draw(&self, cr: &cairo::Context) {
        unsafe {
            ffi::gsk_render_node_draw(self.to_glib_none().0, mut_override(cr.to_glib_none().0));
        }
    }

    /// Retrieves the boundaries of the `self`.
    ///
    /// The node will not draw outside of its boundaries.
    ///
    /// # Returns
    ///
    ///
    /// ## `bounds`
    /// return location for the boundaries
    #[doc(alias = "get_bounds")]
    #[doc(alias = "gsk_render_node_get_bounds")]
    pub fn bounds(&self) -> graphene::Rect {
        unsafe {
            let mut bounds = graphene::Rect::uninitialized();
            ffi::gsk_render_node_get_bounds(self.to_glib_none().0, bounds.to_glib_none_mut().0);
            bounds
        }
    }

    /// Returns the type of the `self`.
    ///
    /// # Returns
    ///
    /// the type of the [`RenderNode`][crate::RenderNode]
    #[doc(alias = "get_node_type")]
    #[doc(alias = "gsk_render_node_get_node_type")]
    pub fn node_type(&self) -> RenderNodeType {
        unsafe { from_glib(ffi::gsk_render_node_get_node_type(self.to_glib_none().0)) }
    }

    /// Serializes the `self` for later deserialization via
    /// [`deserialize()`][Self::deserialize()]. No guarantees are made about the format
    /// used other than that the same version of GTK will be able to deserialize
    /// the result of a call to [`serialize()`][Self::serialize()] and
    /// [`deserialize()`][Self::deserialize()] will correctly reject files it cannot open
    /// that were created with previous versions of GTK.
    ///
    /// The intended use of this functions is testing, benchmarking and debugging.
    /// The format is not meant as a permanent storage format.
    ///
    /// # Returns
    ///
    /// a `GBytes` representing the node.
    #[doc(alias = "gsk_render_node_serialize")]
    pub fn serialize(&self) -> glib::Bytes {
        unsafe { from_glib_full(ffi::gsk_render_node_serialize(self.to_glib_none().0)) }
    }

    /// This function is equivalent to calling [`serialize()`][Self::serialize()]
    /// followed by `g_file_set_contents()`.
    ///
    /// See those two functions for details on the arguments.
    ///
    /// It is mostly intended for use inside a debugger to quickly dump a render
    /// node to a file for later inspection.
    /// ## `filename`
    /// the file to save it to.
    ///
    /// # Returns
    ///
    /// [`true`] if saving was successful
    #[doc(alias = "gsk_render_node_write_to_file")]
    pub fn write_to_file<P: AsRef<Path>>(&self, filename: P) -> Result<(), glib::Error> {
        unsafe {
            let mut error = ptr::null_mut();
            let _ = ffi::gsk_render_node_write_to_file(
                self.to_glib_none().0,
                filename.as_ref().to_glib_none().0,
                &mut error,
            );
            if error.is_null() {
                Ok(())
            } else {
                Err(from_glib_full(error))
            }
        }
    }
}

pub unsafe trait IsRenderNode:
    StaticType
    + FromGlibPtrFull<*mut ffi::GskRenderNode>
    + std::convert::AsRef<crate::RenderNode>
    + 'static
{
    const NODE_TYPE: RenderNodeType;
    fn upcast(self) -> RenderNode;
    fn upcast_ref(&self) -> &RenderNode;
}

pub const NONE_RENDER_NODE: Option<&RenderNode> = None;

impl fmt::Display for RenderNode {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        f.write_str("RenderNode")
    }
}

#[doc(hidden)]
impl AsRef<RenderNode> for RenderNode {
    fn as_ref(&self) -> &Self {
        self
    }
}

macro_rules! define_render_node {
    ($rust_type:ident, $ffi_type:path, $get_type:path, $node_type:path) => {
        impl ::glib::StaticType for $rust_type {
            fn static_type() -> ::glib::Type {
                unsafe { from_glib($get_type()) }
            }
        }

        impl std::convert::AsRef<crate::RenderNode> for $rust_type {
            fn as_ref(&self) -> &crate::RenderNode {
                &*self
            }
        }

        impl std::ops::Deref for $rust_type {
            type Target = crate::RenderNode;

            fn deref(&self) -> &Self::Target {
                unsafe { &*(self as *const $rust_type as *const crate::RenderNode) }
            }
        }

        unsafe impl crate::render_node::IsRenderNode for $rust_type {
            const NODE_TYPE: RenderNodeType = $node_type;

            fn upcast(self) -> crate::RenderNode {
                unsafe { from_glib_full(self.to_glib_full() as *mut ffi::GskRenderNode) }
            }

            fn upcast_ref(&self) -> &crate::RenderNode {
                &*self
            }
        }

        #[doc(hidden)]
        impl FromGlibPtrFull<*mut ffi::GskRenderNode> for $rust_type {
            unsafe fn from_glib_full(ptr: *mut ffi::GskRenderNode) -> Self {
                from_glib_full(ptr as *mut $ffi_type)
            }
        }

        impl ::std::fmt::Display for $rust_type {
            fn fmt(&self, f: &mut ::std::fmt::Formatter) -> ::std::fmt::Result {
                f.write_str(::std::stringify!($rust_type))
            }
        }
    };
}