2 * Copyright © 2009, 2010 Codethink Limited
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the licence, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17 * Boston, MA 02111-1307, USA.
19 * Author: Ryan Lortie <desrt@desrt.ca>
26 #include <glib/gstrfuncs.h>
27 #include <glib/gatomic.h>
28 #include <glib/gmem.h>
35 GDestroyNotify user_destroy
;
40 g_buffer_free_gfree (GBuffer
*buffer
)
42 g_free ((gpointer
) buffer
->data
);
43 g_slice_free (GBuffer
, buffer
);
47 * g_buffer_new_from_data:
48 * @data: the data to be used for the buffer
49 * @size: the size of @data
50 * @returns: a reference to a new #GBuffer
52 * Creates a new #GBuffer from @data.
58 g_buffer_new_from_data (gconstpointer data
,
63 buffer
= g_slice_new (GBuffer
);
64 buffer
->data
= g_memdup (data
, size
);
66 buffer
->free_func
= g_buffer_free_gfree
;
67 buffer
->ref_count
= 1;
73 * g_buffer_new_take_data:
74 * @data: the data to be used for the buffer
75 * @size: the size of @data
76 * returns: a reference to a new #GBuffer
78 * Creates a new #GBuffer from @data.
80 * @data must have been created by a call to g_malloc(), g_malloc0() or
81 * g_realloc() or by one of the many functions that wrap these calls
82 * (such as g_new(), g_strdup(), etc).
84 * After this call, @data belongs to the buffer and may no longer be
85 * modified by the caller. g_free() will be called on @data when the
86 * buffer is no longer in use.
89 g_buffer_new_take_data (gpointer data
,
94 buffer
= g_slice_new (GBuffer
);
97 buffer
->free_func
= g_buffer_free_gfree
;
98 buffer
->ref_count
= 1;
104 g_buffer_free (GBuffer
*buffer
)
106 g_slice_free (GBuffer
, buffer
);
110 * g_buffer_new_from_static_data:
111 * @data: the data to be used for the buffer
112 * @size: the size of @data
113 * @returns: a reference to a new #GBuffer
115 * Creates a new #GBuffer from static data.
117 * @data must be static (ie: never modified or freed).
120 g_buffer_new_from_static_data (gconstpointer data
,
125 buffer
= g_slice_new (GBuffer
);
128 buffer
->free_func
= g_buffer_free
;
129 buffer
->ref_count
= 1;
135 g_buffer_free_usernotify (GBuffer
*buffer
)
137 GUserNotifyBuffer
*ubuffer
= (GUserNotifyBuffer
*) buffer
;
139 ubuffer
->user_destroy (ubuffer
->user_data
);
140 g_slice_free (GUserNotifyBuffer
, ubuffer
);
144 * g_buffer_new_from_pointer:
145 * @data: the data to be used for the buffer
146 * @size: the size of @data
147 * @notify: the function to call to release the data
148 * @user_data: the data to pass to @notify
149 * @returns: a reference to a new #GBuffer
151 * Creates a #GBuffer from @data.
153 * When the last reference is dropped, @notify will be called on
156 * @data must not be modified after this call is made, until @notify has
157 * been called to indicate that the buffer is no longer in use.
160 g_buffer_new_from_pointer (gconstpointer data
,
162 GDestroyNotify notify
,
165 GUserNotifyBuffer
*ubuffer
;
167 ubuffer
= g_slice_new (GUserNotifyBuffer
);
168 ubuffer
->buffer
.data
= data
;
169 ubuffer
->buffer
.size
= size
;
170 ubuffer
->buffer
.free_func
= g_buffer_free_usernotify
;
171 ubuffer
->buffer
.ref_count
= 1;
172 ubuffer
->user_destroy
= notify
;
173 ubuffer
->user_data
= user_data
;
175 return (GBuffer
*) ubuffer
;
180 * @buffer: a #GBuffer
183 * Increase the reference count on @buffer.
186 g_buffer_ref (GBuffer
*buffer
)
188 g_atomic_int_inc (&buffer
->ref_count
);
195 * @buffer: a #GBuffer
197 * Releases a reference on @buffer. This may result in the buffer being
201 g_buffer_unref (GBuffer
*buffer
)
203 if (g_atomic_int_dec_and_test (&buffer
->ref_count
))
204 if (buffer
->free_func
!= NULL
)
205 buffer
->free_func (buffer
);