Add public API to get and set userdata

Also, json_object_set_serializer is changed to respect the userdata
and user_delete parameters when to_string_func is NULL.

diff --git a/json_object.c b/json_object.c
index f9085403cb662e311ffdcccd1bb812a71d09a2e2..93aefd5d35d6fae3aa5a685abd5b0e668cc694a4 100644 (file)
--- a/json_object.c
+++ b/json_object.c
@@ -235,6 +235,21 @@ enum json_type json_object_get_type(const struct json_object *jso)
        return jso->o_type;
 }
 
+void* json_object_get_userdata(json_object *jso) {
+       return jso->_userdata;
+}
+
+void json_object_set_userdata(json_object *jso, void *userdata,
+                             json_object_delete_fn *user_delete)
+{
+       // First, clean up any previously existing user info
+       if (jso->_user_delete)
+               jso->_user_delete(jso, jso->_userdata);
+
+       jso->_userdata = userdata;
+       jso->_user_delete = user_delete;
+}
+
 /* set a custom conversion to string */
 
 void json_object_set_serializer(json_object *jso,
@@ -242,13 +257,7 @@ void json_object_set_serializer(json_object *jso,
        void *userdata,
        json_object_delete_fn *user_delete)
 {
-       // First, clean up any previously existing user info
-       if (jso->_user_delete)
-       {
-               jso->_user_delete(jso, jso->_userdata);
-       }
-       jso->_userdata = NULL;
-       jso->_user_delete = NULL;
+       json_object_set_userdata(jso, userdata, user_delete);
 
        if (to_string_func == NULL)
        {
@@ -281,8 +290,6 @@ void json_object_set_serializer(json_object *jso,
        }
 
        jso->_to_json_string = to_string_func;
-       jso->_userdata = userdata;
-       jso->_user_delete = user_delete;
 }
 
 

diff --git a/json_object.h b/json_object.h
index d8090f860b95f0b126650ed14e74c49b997dcc81..29af8e9a44a51016e2f160be3defbfa8f7970df8 100644 (file)
--- a/json_object.h
+++ b/json_object.h
@@ -222,19 +222,55 @@ extern const char* json_object_to_json_string(struct json_object *obj);
 extern const char* json_object_to_json_string_ext(struct json_object *obj, int
 flags);
 
+/**
+ * Returns the userdata set by json_object_set_userdata() or
+ * json_object_set_serializer()
+ *
+ * @param jso the object to return the userdata for
+ */
+extern void* json_object_get_userdata(json_object *jso);
+
+/**
+ * Set an opaque userdata value for an object
+ *
+ * The userdata can be retrieved using json_object_get_userdata().
+ *
+ * If custom userdata is already set on this object, any existing user_delete
+ * function is called before the new one is set.
+ *
+ * The user_delete parameter is optional and may be passed as NULL, even if
+ * the userdata parameter is non-NULL.  It will be called just before the
+ * json_object is deleted, after it's reference count goes to zero
+ * (see json_object_put()).
+ * If this is not provided, it is up to the caller to free the userdata at
+ * an appropriate time. (i.e. after the json_object is deleted)
+ *
+ * Note: Objects created by parsing strings may have custom serializers set
+ * which expect the userdata to contain specific data (due to use of
+ * json_object_new_double_s()). In this case, json_object_set_serialiser() with
+ * NULL as to_string_func should be used instead to set the userdata and reset
+ * the serializer to its default value.
+ *
+ * @param jso the object to set the userdata for
+ * @param userdata an optional opaque cookie
+ * @param user_delete an optional function from freeing userdata
+ */
+extern void json_object_set_userdata(json_object *jso, void *userdata,
+                                    json_object_delete_fn *user_delete);
+
 /**
  * Set a custom serialization function to be used when this particular object
  * is converted to a string by json_object_to_json_string.
  *
- * If a custom serializer is already set on this object, any existing
- * user_delete function is called before the new one is set.
+ * If custom userdata is already set on this object, any existing user_delete
+ * function is called before the new one is set.
  *
- * If to_string_func is NULL, the other parameters are ignored
- * and the default behaviour is reset.
+ * If to_string_func is NULL the default behaviour is reset (but the userdata
+ * and user_delete fields are still set).
  *
- * The userdata parameter is optional and may be passed as NULL.  If provided,
- * it is passed to to_string_func as-is.  This parameter may be NULL even
- * if user_delete is non-NULL.
+ * The userdata parameter is optional and may be passed as NULL. It can be used
+ * to provide additional data for to_string_func to use. This parameter may
+ * be NULL even if user_delete is non-NULL.
  *
  * The user_delete parameter is optional and may be passed as NULL, even if
  * the userdata parameter is non-NULL.  It will be called just before the
@@ -243,6 +279,10 @@ flags);
  * If this is not provided, it is up to the caller to free the userdata at
  * an appropriate time. (i.e. after the json_object is deleted)
  *
+ * Note that the userdata is the same as set by json_object_set_userdata(), so
+ * care must be taken not to overwrite the value when both a custom serializer
+ * and json_object_set_userdata() are used.
+ *
  * @param jso the object to customize
  * @param to_string_func the custom serialization function
  * @param userdata an optional opaque cookie
@@ -634,8 +674,13 @@ extern struct json_object* json_object_new_double(double d);
  * inefficiently (e.g. 12.3 => "12.300000000000001") to be
  * serialized with the more convenient form.
  *
- * Note: this is used by json_tokener_parse_ex() to allow for
- *   an exact re-serialization of a parsed object.
+ * Notes:
+ *
+ * This is used by json_tokener_parse_ex() to allow for
+ * an exact re-serialization of a parsed object.
+ *
+ * The userdata field is used to store the string representation, so it
+ * can't be used for other data if this function is used.
  *
  * An equivalent sequence of calls is:
  * @code