• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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 
27 #if defined(glib_typeof_2_68) && GLIB_VERSION_MIN_REQUIRED >= GLIB_VERSION_2_68
28 /* for glib_typeof */
29 #include <type_traits>
30 #endif
31 
32 G_BEGIN_DECLS
33 
34 GLIB_AVAILABLE_IN_2_58
35 gpointer        g_rc_box_alloc                  (gsize           block_size) G_GNUC_MALLOC G_GNUC_ALLOC_SIZE(1);
36 GLIB_AVAILABLE_IN_2_58
37 gpointer        g_rc_box_alloc0                 (gsize           block_size) G_GNUC_MALLOC G_GNUC_ALLOC_SIZE(1);
38 GLIB_AVAILABLE_IN_2_58
39 gpointer        g_rc_box_dup                    (gsize           block_size,
40                                                  gconstpointer   mem_block) G_GNUC_ALLOC_SIZE(1);
41 GLIB_AVAILABLE_IN_2_58
42 gpointer        g_rc_box_acquire                (gpointer        mem_block);
43 GLIB_AVAILABLE_IN_2_58
44 void            g_rc_box_release                (gpointer        mem_block);
45 GLIB_AVAILABLE_IN_2_58
46 void            g_rc_box_release_full           (gpointer        mem_block,
47                                                  GDestroyNotify  clear_func);
48 
49 GLIB_AVAILABLE_IN_2_58
50 gsize           g_rc_box_get_size               (gpointer        mem_block);
51 
52 GLIB_AVAILABLE_IN_2_58
53 gpointer        g_atomic_rc_box_alloc           (gsize           block_size) G_GNUC_MALLOC G_GNUC_ALLOC_SIZE(1);
54 GLIB_AVAILABLE_IN_2_58
55 gpointer        g_atomic_rc_box_alloc0          (gsize           block_size) G_GNUC_MALLOC G_GNUC_ALLOC_SIZE(1);
56 GLIB_AVAILABLE_IN_2_58
57 gpointer        g_atomic_rc_box_dup             (gsize           block_size,
58                                                  gconstpointer   mem_block) G_GNUC_ALLOC_SIZE(1);
59 GLIB_AVAILABLE_IN_2_58
60 gpointer        g_atomic_rc_box_acquire         (gpointer        mem_block);
61 GLIB_AVAILABLE_IN_2_58
62 void            g_atomic_rc_box_release         (gpointer        mem_block);
63 GLIB_AVAILABLE_IN_2_58
64 void            g_atomic_rc_box_release_full    (gpointer        mem_block,
65                                                  GDestroyNotify  clear_func);
66 
67 GLIB_AVAILABLE_IN_2_58
68 gsize           g_atomic_rc_box_get_size        (gpointer        mem_block);
69 
70 #define g_rc_box_new(type) \
71   ((type *) g_rc_box_alloc (sizeof (type)))
72 #define g_rc_box_new0(type) \
73   ((type *) g_rc_box_alloc0 (sizeof (type)))
74 #define g_atomic_rc_box_new(type) \
75   ((type *) g_atomic_rc_box_alloc (sizeof (type)))
76 #define g_atomic_rc_box_new0(type) \
77   ((type *) g_atomic_rc_box_alloc0 (sizeof (type)))
78 
79 #if defined(glib_typeof) && (!defined(glib_typeof_2_68) || GLIB_VERSION_MIN_REQUIRED >= GLIB_VERSION_2_68)
80 /* Type check to avoid assigning references to different types */
81 #define g_rc_box_acquire(mem_block) \
82   ((glib_typeof (mem_block)) (g_rc_box_acquire) (mem_block))
83 #define g_atomic_rc_box_acquire(mem_block) \
84   ((glib_typeof (mem_block)) (g_atomic_rc_box_acquire) (mem_block))
85 
86 /* Type check to avoid duplicating data to different types */
87 #define g_rc_box_dup(block_size, mem_block) \
88   ((glib_typeof (mem_block)) (g_rc_box_dup) (block_size, mem_block))
89 #define g_atomic_rc_box_dup(block_size, mem_block) \
90   ((glib_typeof (mem_block)) (g_atomic_rc_box_dup) (block_size, mem_block))
91 #endif
92 
93 G_END_DECLS
94