1 /* grcbox.h: Reference counted data
2  *
3  * Copyright 2018  Emmanuele Bassi
4  *
5  * This library is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Lesser General Public
7  * License as published by the Free Software Foundation; either
8  * version 2.1 of the License, or (at your option) any later version.
9  *
10  * This library is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  * Lesser General Public License for more details.
14  *
15  * You should have received a copy of the GNU Lesser General Public
16  * License along with this library; if not, see <http://www.gnu.org/licenses/>.
17  */
18 
19 #pragma once
20 
21 #if !defined (__GLIB_H_INSIDE__) && !defined (GLIB_COMPILATION)
22 #error "Only <glib.h> can be included directly."
23 #endif
24 
25 #include <glib/gmem.h>
26 #include <glib/glib-typeof.h>
27 
28 G_BEGIN_DECLS
29 
30 GLIB_AVAILABLE_IN_2_58
31 gpointer        g_rc_box_alloc                  (gsize           block_size) G_GNUC_MALLOC G_GNUC_ALLOC_SIZE(1);
32 GLIB_AVAILABLE_IN_2_58
33 gpointer        g_rc_box_alloc0                 (gsize           block_size) G_GNUC_MALLOC G_GNUC_ALLOC_SIZE(1);
34 GLIB_AVAILABLE_IN_2_58
35 gpointer        g_rc_box_dup                    (gsize           block_size,
36                                                  gconstpointer   mem_block) G_GNUC_ALLOC_SIZE(1);
37 GLIB_AVAILABLE_IN_2_58
38 gpointer        g_rc_box_acquire                (gpointer        mem_block);
39 GLIB_AVAILABLE_IN_2_58
40 void            g_rc_box_release                (gpointer        mem_block);
41 GLIB_AVAILABLE_IN_2_58
42 void            g_rc_box_release_full           (gpointer        mem_block,
43                                                  GDestroyNotify  clear_func);
44 
45 GLIB_AVAILABLE_IN_2_58
46 gsize           g_rc_box_get_size               (gpointer        mem_block);
47 
48 GLIB_AVAILABLE_IN_2_58
49 gpointer        g_atomic_rc_box_alloc           (gsize           block_size) G_GNUC_MALLOC G_GNUC_ALLOC_SIZE(1);
50 GLIB_AVAILABLE_IN_2_58
51 gpointer        g_atomic_rc_box_alloc0          (gsize           block_size) G_GNUC_MALLOC G_GNUC_ALLOC_SIZE(1);
52 GLIB_AVAILABLE_IN_2_58
53 gpointer        g_atomic_rc_box_dup             (gsize           block_size,
54                                                  gconstpointer   mem_block) G_GNUC_ALLOC_SIZE(1);
55 GLIB_AVAILABLE_IN_2_58
56 gpointer        g_atomic_rc_box_acquire         (gpointer        mem_block);
57 GLIB_AVAILABLE_IN_2_58
58 void            g_atomic_rc_box_release         (gpointer        mem_block);
59 GLIB_AVAILABLE_IN_2_58
60 void            g_atomic_rc_box_release_full    (gpointer        mem_block,
61                                                  GDestroyNotify  clear_func);
62 
63 GLIB_AVAILABLE_IN_2_58
64 gsize           g_atomic_rc_box_get_size        (gpointer        mem_block);
65 
66 #define g_rc_box_new(type) \
67   ((type *) g_rc_box_alloc (sizeof (type)))
68 #define g_rc_box_new0(type) \
69   ((type *) g_rc_box_alloc0 (sizeof (type)))
70 #define g_atomic_rc_box_new(type) \
71   ((type *) g_atomic_rc_box_alloc (sizeof (type)))
72 #define g_atomic_rc_box_new0(type) \
73   ((type *) g_atomic_rc_box_alloc0 (sizeof (type)))
74 
75 #if defined(glib_typeof)
76 /* Type check to avoid assigning references to different types */
77 #define g_rc_box_acquire(mem_block) \
78   ((glib_typeof (mem_block)) (g_rc_box_acquire) (mem_block))
79 #define g_atomic_rc_box_acquire(mem_block) \
80   ((glib_typeof (mem_block)) (g_atomic_rc_box_acquire) (mem_block))
81 
82 /* Type check to avoid duplicating data to different types */
83 #define g_rc_box_dup(block_size, mem_block) \
84   ((glib_typeof (mem_block)) (g_rc_box_dup) (block_size, mem_block))
85 #define g_atomic_rc_box_dup(block_size, mem_block) \
86   ((glib_typeof (mem_block)) (g_atomic_rc_box_dup) (block_size, mem_block))
87 #endif
88 
89 G_END_DECLS
90