glib/wrapper.rs
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 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443
// Take a look at the license at the top of the repository in the LICENSE file.
// rustdoc-stripper-ignore-next
//! `IMPL` The `wrapper!` macro and miscellaneous wrapper traits.
// rustdoc-stripper-ignore-next
/// Defines a wrapper type and implements the appropriate traits.
///
/// The basic syntax is
///
/// ```ignore
/// wrapper! {
/// /// Your documentation goes here
/// pub struct $name($kind<$foreign>);
///
/// match fn {
/// $fn_name => /* a closure-like expression */,
/// ...
/// }
/// }
/// ```
///
/// This creates a wrapper named `$name` around the foreign type
/// `$foreign` of `$kind` — one of [`Boxed`][#boxed],
/// [`Shared`][#shared], or [`Object`][#object].
///
/// Inside the `match fn` block there are closure-like expressions to
/// provide ways of copying/freeing, or referencing/unreferencing the
/// value that you are wrapping. These expressions will be evaluated
/// in an `unsafe` context, since they frequently invoke `extern`
/// functions from an FFI crate.
///
/// What follows is a description of each of the possible `$kind`:
/// [`Boxed`][#boxed], [`Shared`][#shared], and [`Object`][#object];
/// note that each supports different sets of `$fn_name` inside the
/// `match fn` block. Also, `Object` may require you to specify
/// things like the class struct to wrap, plus any interfaces that the
/// class implements.
///
/// ### Boxed (heap allocated)
///
/// Boxed records with single ownership allocated on the heap.
///
/// With no registered `glib_ffi::GType`:
///
/// ```ignore
/// wrapper! {
/// /// Text buffer iterator
/// pub struct TextIter(Boxed<ffi::GtkTextIter>);
///
/// match fn {
/// copy => |ptr| ffi::gtk_text_iter_copy(ptr),
/// free => |ptr| ffi::gtk_text_iter_free(ptr),
/// }
/// }
/// ```
///
/// `copy`: `|*const $foreign| -> *mut $foreign` creates a copy of the value.
///
/// `free`: `|*mut $foreign|` frees the value.
///
/// With a registered `glib_ffi::GType`:
///
/// ```ignore
/// wrapper! {
/// /// Text buffer iterator
/// pub struct TextIter(Boxed<ffi::GtkTextIter>);
///
/// match fn {
/// copy => |ptr| ffi::gtk_text_iter_copy(ptr),
/// free => |ptr| ffi::gtk_text_iter_free(ptr),
/// type_ => || ffi::gtk_text_iter_get_type(),
/// }
/// }
/// ```
///
/// `type_`: `|| -> glib_ffi::GType` (optional) returns the
/// `glib_ffi::GType` that corresponds to the foreign struct.
///
/// ### BoxedInline (inline, stack allocated)
///
/// Boxed records with single ownership allocated on the stack or otherwise inline.
/// With no registered `glib_ffi::GType`:
///
/// ```ignore
/// wrapper! {
/// /// Text buffer iterator
/// pub struct TextIter(BoxedInline<ffi::GtkTextIter>);
///
/// match fn {
/// copy => |ptr| ffi::gtk_text_iter_copy(ptr),
/// free => |ptr| ffi::gtk_text_iter_free(ptr),
/// }
/// }
/// ```
///
/// `copy`: `|*const $foreign| -> *mut $foreign` (optional) creates a heap allocated copy of the value.
///
/// `free`: `|*mut $foreign|` (optional) frees the value.
///
/// With a registered `glib_ffi::GType`:
///
/// ```ignore
/// wrapper! {
/// /// Text buffer iterator
/// pub struct TextIter(BoxedInline<ffi::GtkTextIter>);
///
/// match fn {
/// copy => |ptr| ffi::gtk_text_iter_copy(ptr),
/// free => |ptr| ffi::gtk_text_iter_free(ptr),
/// type_ => || ffi::gtk_text_iter_get_type(),
/// }
/// }
/// ```
///
/// `type_`: `|| -> glib_ffi::GType` (optional) returns the
/// `glib_ffi::GType` that corresponds to the foreign struct.
///
/// ### Shared
///
/// Records with reference-counted, shared ownership.
///
/// With no registered `glib_ffi::GType`:
///
/// ```ignore
/// wrapper! {
/// /// Object holding timing information for a single frame.
/// pub struct FrameTimings(Shared<ffi::GdkFrameTimings>);
///
/// match fn {
/// ref => |ptr| ffi::gdk_frame_timings_ref(ptr),
/// unref => |ptr| ffi::gdk_frame_timings_unref(ptr),
/// }
/// }
/// ```
///
/// `ref`: `|*mut $foreign|` increases the refcount.
///
/// `unref`: `|*mut $foreign|` decreases the refcount.
///
/// With a registered `glib_ffi::GType`:
///
/// ```ignore
/// wrapper! {
/// /// Object holding timing information for a single frame.
/// pub struct FrameTimings(Shared<ffi::GdkFrameTimings>);
///
/// match fn {
/// ref => |ptr| ffi::gdk_frame_timings_ref(ptr),
/// unref => |ptr| ffi::gdk_frame_timings_unref(ptr),
/// type_ => || ffi::gdk_frame_timings_get_type(),
/// }
/// }
/// ```
///
/// `type_`: `|| -> glib_ffi::GType` (optional) returns the
/// `glib_ffi::GType` that corresponds to the foreign struct.
///
/// ### Object
///
/// Objects -- classes. Note that the class name, if available, must be specified after the
/// $foreign type; see below for [non-derivable classes][#non-derivable-classes].
///
/// The basic syntax is this:
///
/// ```ignore
/// wrapper! {
/// /// Your documentation goes here
/// pub struct InstanceName(Object<ffi::InstanceStruct, ffi::ClassStruct>)
/// @extends ParentClass, GrandparentClass, ...,
/// @implements Interface1, Interface2, ...;
///
/// match fn {
/// type_ => || ffi::instance_get_type(),
/// }
/// }
/// ```
///
/// `type_`: `|| -> glib_ffi::GType` returns the `glib_ffi::GType`
/// that corresponds to the foreign class.
///
/// #### All parent classes must be specified
///
/// In the example above, "`@extends ParentClass, GrandparentClass, ...,`" is where you must
/// specify all the parent classes of the one you are wrapping. The uppermost parent class,
/// `glib::Object`, must not be specified.
///
/// For example, `ffi::GtkWindowGroup` derives directly from
/// `GObject`, so it can be simply wrapped as follows:
///
/// ```ignore
/// wrapper! {
/// pub struct WindowGroup(Object<ffi::GtkWindowGroup, ffi::GtkWindowGroupClass>);
///
/// match fn {
/// type_ => || ffi::gtk_window_group_get_type(),
/// }
/// }
/// ```
///
/// In contrast, `ffi::GtkButton` has a parent, grandparent, etc. classes, which must be specified:
///
/// ```ignore
/// wrapper! {
/// pub struct Button(Object<ffi::GtkButton>) @extends Bin, Container, Widget;
/// // see note on interfaces in the example below
///
/// match fn {
/// type_ => || ffi::gtk_button_get_type(),
/// }
/// }
/// ```
///
/// #### Objects which implement interfaces
///
/// The example above is incomplete, since `ffi::GtkButton` actually implements two interfaces,
/// `Buildable` and `Actionable`. In this case, they must be specified after all the parent classes
/// behind the `@implements` keyword:
///
/// ```ignore
/// wrapper! {
/// pub struct Button(Object<ffi::GtkButton>)
/// @extends Bin, Container, Widget, // parent classes
/// @implements Buildable, Actionable; // interfaces
///
/// match fn {
/// type_ => || ffi::gtk_button_get_type(),
/// }
/// }
/// ```
///
/// #### Non-derivable classes
///
/// By convention, GObject implements "final" classes, i.e. those who
/// cannot be subclassed, by *not* exposing a public Class struct.
/// This way it is not possible to override any methods, as there are
/// no `klass.method_name` fields to overwrite. In this case, don't
/// specify a FFI class name at all in the `Object<>` part:
///
/// ```ignore
/// wrapper! {
/// pub struct Clipboard(Object<ffi::GtkClipboard>);
/// ...
/// }
/// ```
///
/// #### Interfaces
///
/// Interfaces are passed in the same way to the macro but instead of specifying
/// `Object`, `Interface` has to be specified:
///
/// ```ignore
/// wrapper! {
/// pub struct TreeModel(Interface<ffi::GtkTreeModel, ffi::GtkTreeModelIface>);
/// ...
/// }
/// ```
///
/// #### Interfaces with prerequisites
///
/// Interfaces can declare prerequisites, i.e. the classes from which types that implement the
/// interface have to inherit or interfaces that have to be implemented:
///
/// ```ignore
/// wrapper! {
/// pub struct TreeSortable(Interface<ffi::GtkTreeSortable, ffi::GtkTreeSortable>) @requires TreeModel;
/// ...
/// }
/// ```
///
/// [#boxed]: #boxed
/// [#shared]: #shared
/// [#object]: #object
/// [#non-derivable-classes]: #non-derivable-classes
#[macro_export]
macro_rules! wrapper {
// Boxed
(
$(#[$attr:meta])*
$visibility:vis struct $name:ident $(<$($generic:ident $(: $bound:tt $(+ $bound2:tt)*)?),+>)? (Boxed<$ffi_name:ty>);
match fn {
copy => |$copy_arg:ident| $copy_expr:expr,
free => |$free_arg:ident| $free_expr:expr,
$(
type_ => || $get_type_expr:expr,
)?
}
) => {
$crate::glib_boxed_wrapper!(
[$($attr)*] $visibility $name $(<$($generic $(: $bound $(+ $bound2)*)?),+>)?, $ffi_name,
@copy $copy_arg $copy_expr, @free $free_arg $free_expr
$(, @type_ $get_type_expr)?
);
};
// BoxedInline
(
$(#[$attr:meta])*
$visibility:vis struct $name:ident $(<$($generic:ident $(: $bound:tt $(+ $bound2:tt)*)?),+>)? (BoxedInline<$ffi_name:ty>);
match fn {
$(
copy => |$copy_arg:ident| $copy_expr:expr,
free => |$free_arg:ident| $free_expr:expr,
)?
$(
init => |$init_arg:ident| $init_expr:expr,
copy_into => |$copy_into_arg_dest:ident, $copy_into_arg_src:ident| $copy_into_expr:expr,
clear => |$clear_arg:ident| $clear_expr:expr,
)?
$(
type_ => || $get_type_expr:expr,
)?
}
) => {
$crate::glib_boxed_inline_wrapper!(
[$($attr)*] $visibility $name $(<$($generic $(: $bound $(+ $bound2)*)?),+>)?, $ffi_name
$(, @copy $copy_arg $copy_expr, @free $free_arg $free_expr)?
$(, @init $init_arg $init_expr, @copy_into $copy_into_arg_dest $copy_into_arg_src $copy_into_expr, @clear $clear_arg $clear_expr)?
$(, @type_ $get_type_expr)?
);
};
// BoxedInline
(
$(#[$attr:meta])*
$visibility:vis struct $name:ident $(<$($generic:ident $(: $bound:tt $(+ $bound2:tt)*)?),+>)? (BoxedInline<$ffi_name:ty>);
) => {
$crate::glib_boxed_inline_wrapper!(
[$($attr)*] $visibility $name $(<$($generic $(: $bound $(+ $bound2)*)?),+>)?, $ffi_name
);
};
// Shared
(
$(#[$attr:meta])*
$visibility:vis struct $name:ident $(<$($generic:ident $(: $bound:tt $(+ $bound2:tt)*)?),+>)? (Shared<$ffi_name:ty>);
match fn {
ref => |$ref_arg:ident| $ref_expr:expr,
unref => |$unref_arg:ident| $unref_expr:expr,
$(
type_ => || $get_type_expr:expr,
)?
}
) => {
$crate::glib_shared_wrapper!(
[$($attr)*] $visibility $name $(<$($generic $(: $bound $(+ $bound2)*)?),+>)?, $ffi_name,
@ref $ref_arg $ref_expr, @unref $unref_arg $unref_expr
$(, @type_ $get_type_expr)?
);
};
// Object, no parents
(
$(#[$attr:meta])*
$visibility:vis struct $name:ident $(<$($generic:ident $(: $bound:tt $(+ $bound2:tt)*)?),+>)? (Object<$ffi_name:ty $(, $ffi_class_name:ty)?>) $(@implements $($implements:path),+)?;
match fn {
type_ => || $get_type_expr:expr,
}
) => {
$crate::glib_object_wrapper!(
@object [$($attr)*] $visibility $name $(<$($generic $(: $bound $(+ $bound2)*)?),+>)?, *mut std::os::raw::c_void, (), $ffi_name,
$( @ffi_class $ffi_class_name ,)?
@type_ $get_type_expr,
@extends [],
@implements [$($($implements),+)?]
);
};
// Object, parents
(
$(#[$attr:meta])*
$visibility:vis struct $name:ident $(<$($generic:ident $(: $bound:tt $(+ $bound2:tt)*)?),+>)? (Object<$ffi_name:ty $(, $ffi_class_name:ty)?>) @extends $($extends:path),+ $(, @implements $($implements:path),+)?;
match fn {
type_ => || $get_type_expr:expr,
}
) => {
$crate::glib_object_wrapper!(
@object [$($attr)*] $visibility $name $(<$($generic $(: $bound $(+ $bound2)*)?),+>)?, *mut std::os::raw::c_void, (), $ffi_name,
$( @ffi_class $ffi_class_name ,)?
@type_ $get_type_expr,
@extends [$($extends),+],
@implements [$($($implements),+)?]
);
};
// ObjectSubclass, no parents
(
$(#[$attr:meta])*
$visibility:vis struct $name:ident $(<$($generic:ident $(: $bound:tt $(+ $bound2:tt)*)?),+>)? (ObjectSubclass<$subclass:ty>) $(@implements $($implements:path),+)?;
) => {
$crate::glib_object_wrapper!(
@object_subclass [$($attr)*] $visibility $name $(<$($generic $(: $bound $(+ $bound2)*)?),+>)?, $subclass,
@extends [],
@implements [$($($implements),+)?]
);
};
// ObjectSubclass, parents
(
$(#[$attr:meta])*
$visibility:vis struct $name:ident $(<$($generic:ident $(: $bound:tt $(+ $bound2:tt)*)?),+>)? (ObjectSubclass<$subclass:ty>) @extends $($extends:path),+ $(, @implements $($implements:path),+)?;
) => {
$crate::glib_object_wrapper!(
@object_subclass [$($attr)*] $visibility $name $(<$($generic $(: $bound $(+ $bound2)*)?),+>)?, $subclass,
@extends [$($extends),+],
@implements [$($($implements),+)?]
);
};
// Interface
(
$(#[$attr:meta])*
$visibility:vis struct $name:ident $(<$($generic:ident $(: $bound:tt $(+ $bound2:tt)*)?),+>)? (Interface<$ffi_name:ty $(, $ffi_class_name:ty)?>) $(@requires $($requires:path),+)?;
match fn {
type_ => || $get_type_expr:expr,
}
) => {
$crate::glib_object_wrapper!(
@interface [$($attr)*] $visibility $name $(<$($generic $(: $bound $(+ $bound2)*)?),+>)?, *mut std::os::raw::c_void, $ffi_name,
$( @ffi_class $ffi_class_name ,)?
@type_ $get_type_expr,
@requires [$( $($requires),+ )?]
);
};
// ObjectInterface
(
$(#[$attr:meta])*
$visibility:vis struct $name:ident $(<$($generic:ident $(: $bound:tt $(+ $bound2:tt)*)?),+>)? (ObjectInterface<$iface_name:ty>) $(@requires $($requires:path),+)?;
) => {
$crate::glib_object_wrapper!(
@object_interface [$($attr)*] $visibility $name $(<$($generic $(: $bound $(+ $bound2)*)?),+>)?, $iface_name,
@type_ $crate::translate::IntoGlib::into_glib(<$iface_name as $crate::subclass::interface::ObjectInterfaceType>::type_()),
@requires [$( $($requires),+ )?]
);
};
}