luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2024-12-27 07:56:14 +01:00
Code Issues Packages Projects Releases Wiki Activity

garray: Document that return value of g_ptr_array_remove() may be junk

Browse Source 
If using g_ptr_array_remove*() with a non-NULL GDestroyNotify function,
the value returned will probably be freed memory (depending on what the
GDestroyNotify) function actually does. Warn about that in the
documentation. We can’t just unconditionally return NULL in these cases,
though, since the user might have set the GDestroyNotify to a nifty
function which doesn’t actually free the element; so returning it might
still be valid and useful.

Also add missing (nullable) annotations to that documentation.

Signed-off-by: Philip Withnall <withnall@endlessm.com>

https://bugzilla.gnome.org/show_bug.cgi?id=795376
This commit is contained in:
Philip Withnall 2018-04-19 14:50:35 +01:00
parent 2c9a84e5a3
commit e6200eaea2
1 changed files with 7 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
glib/garray.c
View File

@ -1231,9 +1231,10 @@ ptr_array_remove_index (GPtrArray *array,
* Removes the pointer at the given index from the pointer array.
* The following elements are moved down one place. If @array has
* a non-%NULL #GDestroyNotify function it is called for the removed
* element.
* element. If so, the return value from this function will potentially point
* to freed memory (depending on the #GDestroyNotify implementation).
*
* Returns: the pointer which was removed
* Returns: (nullable): the pointer which was removed
*/
gpointer
g_ptr_array_remove_index (GPtrArray *array,
@ -1251,9 +1252,11 @@ g_ptr_array_remove_index (GPtrArray *array,
* The last element in the array is used to fill in the space, so
* this function does not preserve the order of the array. But it
* is faster than g_ptr_array_remove_index(). If @array has a non-%NULL
* #GDestroyNotify function it is called for the removed element.
* #GDestroyNotify function it is called for the removed element. If so, the
* return value from this function will potentially point to freed memory
* (depending on the #GDestroyNotify implementation).
*
* Returns: the pointer which was removed
* Returns: (nullable): the pointer which was removed
*/
gpointer
g_ptr_array_remove_index_fast (GPtrArray *array,