luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2024-12-24 22:46:15 +01:00
Code Issues Packages Projects Releases Wiki Activity

doc: clarify that _get_instance_private() is NULL-safe

Browse Source 
https://bugzilla.gnome.org/show_bug.cgi?id=755083
This commit is contained in:
Xavier Claessens 2015-09-15 16:42:10 -04:00
parent ab26dd5433
commit 32811598f3
1 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
gobject/gtype.h
View File

@ -1823,6 +1823,8 @@ guint g_type_get_type_registration_serial (void);
* { * {
* MyObjectPrivate *priv = my_object_get_instance_private (obj); * MyObjectPrivate *priv = my_object_get_instance_private (obj);
* *
* g_return_val_if_fail (MY_IS_OBJECT (obj), 0);
*
* return priv->foo; * return priv->foo;
* } * }
* *
@ -1832,6 +1834,8 @@ guint g_type_get_type_registration_serial (void);
* { * {
* MyObjectPrivate *priv = my_object_get_instance_private (obj); * MyObjectPrivate *priv = my_object_get_instance_private (obj);
* *
* g_return_if_fail (MY_IS_OBJECT (obj));
*
* if (priv->bar != bar) * if (priv->bar != bar)
* priv->bar = bar; * priv->bar = bar;
* } * }
@ -1843,6 +1847,10 @@ guint g_type_get_type_registration_serial (void);
* Also note that private structs added with these macros must have a struct * Also note that private structs added with these macros must have a struct
* name of the form `TypeNamePrivate`. * name of the form `TypeNamePrivate`.
* *
* It is safe to call _get_instance_private on %NULL or invalid object since
* it's only adding an offset to the instance pointer. In that case the returned
* pointer must not be dereferenced.
*
* Since: 2.38 * Since: 2.38
*/ */
#define G_ADD_PRIVATE(TypeName) { \ #define G_ADD_PRIVATE(TypeName) { \