API CHANGE to jsonwriter_object_key, enum jsonwriter_error -> jsonwriter_status. add jsonwriter_end_array(), jsonwriter_end_object()

Author: liquidaty

jsonwriter.c

@@ -28,7 +28,6 @@ struct jsonwriter_data {
   unsigned char compact:1;
   unsigned char started:1;
   unsigned char dummy:5;
-
 };
 
 void jsonwriter_set_option(jsonwriter_handle h, enum jsonwriter_option opt) {
@@ -103,19 +102,35 @@ static int jsonwriter_indent(struct jsonwriter_data *data, char closing) {
   return 0;
 }
 
-int jsonwriter_end(jsonwriter_handle h) { // return 0 on success
+static enum jsonwriter_status jsonwriter_end_aux(jsonwriter_handle h, char close_bracket) { // return 0 on success
   struct jsonwriter_data *data = h;
   if(data->depth > 0) {
+    if(close_bracket && data->close_brackets[data->depth-1] != close_bracket)
+      return jsonwriter_status_invalid_end;
+
     data->depth--;
+
     if(data->depth < JSONWRITER_MAX_NESTING - 1) {
       jsonwriter_indent(data, 1);
       data->write(data->close_brackets + data->depth, 1, 1, data->write_arg);
     }
     if(data->depth == 0)
       jsonwriter_writeln(data);
-    return 0;
+    return jsonwriter_status_ok;
   }
-  return 1; // error: nothing to close
+  return jsonwriter_status_invalid_end; // error: nothing to close
+}
+
+enum jsonwriter_status jsonwriter_end(jsonwriter_handle h) {
+  return jsonwriter_end_aux(h, 0);
+}
+
+enum jsonwriter_status jsonwriter_end_array(jsonwriter_handle h) {
+  return jsonwriter_end_aux(h, ']');
+}
+
+enum jsonwriter_status jsonwriter_end_object(jsonwriter_handle h) {
+  return jsonwriter_end_aux(h, '}');
 }
 
 int jsonwriter_end_all(jsonwriter_handle h) {
@@ -207,7 +222,7 @@ int jsonwriter_strn(jsonwriter_handle h, const char *s, size_t len) {
   return 1;
 }
 
-int jsonwriter_object_key(jsonwriter_handle h, const char *key, size_t len_or_zero) {
+static int jsonwriter_object_keyn(jsonwriter_handle h, const char *key, size_t len_or_zero) {
   struct jsonwriter_data *data = h;
   if(data->depth < JSONWRITER_MAX_NESTING) {
     jsonwriter_indent(data, 0);
@@ -218,6 +233,10 @@ int jsonwriter_object_key(jsonwriter_handle h, const char *key, size_t len_or_ze
   return 1;
 }
 
+int jsonwriter_object_key(jsonwriter_handle h, const char *key) {
+  return jsonwriter_object_keyn(h, key, strlen(key));
+}
+
 int jsonwriter_dblf(jsonwriter_handle h, long double d, const char *format_string, char compact) {
   struct jsonwriter_data *data = h;
   if(data->depth < JSONWRITER_MAX_NESTING) {
@@ -276,26 +295,26 @@ int jsonwriter_start_array(jsonwriter_handle h) {
   return jsonwriter_go_deeper((struct jsonwriter_data *)h, '[', ']');
 }
 
-enum jsonwriter_error jsonwriter_set_variant_handler(
+enum jsonwriter_status jsonwriter_set_variant_handler(
     jsonwriter_handle h,
     struct jsonwriter_variant (*to_jsw_variant)(void *),
     void (*cleanup)(void *, struct jsonwriter_variant *)
 ) {
   struct jsonwriter_data *d = h;
   d->after_to_jsw_variant = cleanup;
   if(!(d->to_jsw_variant = to_jsw_variant))
-    return jsonwriter_error_invalid_value;
+    return jsonwriter_status_invalid_value;
 
-  return jsonwriter_error_ok;
+  return jsonwriter_status_ok;
 }
 
-enum jsonwriter_error jsonwriter_variant(jsonwriter_handle h, void *data) {
+enum jsonwriter_status jsonwriter_variant(jsonwriter_handle h, void *data) {
   struct jsonwriter_data *d = h;
   if(!d->to_jsw_variant)
-    return jsonwriter_error_misconfiguration;
+    return jsonwriter_status_misconfiguration;
   struct jsonwriter_variant jv = d->to_jsw_variant(data);
 
-  int rc = jsonwriter_error_unrecognized_variant_type;
+  int rc = jsonwriter_status_unrecognized_variant_type;
   switch(jv.type) {
   case jsonwriter_datatype_null:
     rc = jsonwriter_null(h);

jsonwriter.h

@@ -12,12 +12,13 @@ extern "C" {
     jsonwriter_option_compact = 1
   };
 
-  enum jsonwriter_error {
-    jsonwriter_error_ok = 0, // no error
-    jsonwriter_error_out_of_memory = 1,
-    jsonwriter_error_invalid_value,
-    jsonwriter_error_misconfiguration,
-    jsonwriter_error_unrecognized_variant_type
+  enum jsonwriter_status {
+    jsonwriter_status_ok = 0, // no error
+    jsonwriter_status_out_of_memory = 1,
+    jsonwriter_status_invalid_value,
+    jsonwriter_status_misconfiguration,
+    jsonwriter_status_unrecognized_variant_type,
+    jsonwriter_status_invalid_end
   };
 
   typedef void * jsonwriter_handle;
@@ -31,11 +32,15 @@ extern "C" {
   int jsonwriter_start_object(jsonwriter_handle h);
   int jsonwriter_start_array(jsonwriter_handle h);
 
-  int jsonwriter_end(jsonwriter_handle h);
+  enum jsonwriter_status jsonwriter_end_array(jsonwriter_handle h);  // end an error, or return err
+  enum jsonwriter_status jsonwriter_end_object(jsonwriter_handle h); // end an object, or return err
+  enum jsonwriter_status jsonwriter_end(jsonwriter_handle h); // end either an array or an object, or return err
+
+  // to do: jsonwriter_end_array() and jsonwriter_end_object(): same as jsonwriter_end, but
+  // return an error if no matching open array/obj
   int jsonwriter_end_all(jsonwriter_handle h);
 
-  // jsonwriter_object_key: if len is zero, will use strlen to calculate
-  int jsonwriter_object_key(jsonwriter_handle h, const char *key, size_t len_or_zero);
+  int jsonwriter_object_key(jsonwriter_handle h, const char *key);
 
   int jsonwriter_str(jsonwriter_handle h, const char *s);
   int jsonwriter_strn(jsonwriter_handle h, const char *s, size_t len);
@@ -45,7 +50,6 @@ extern "C" {
   int jsonwriter_int(jsonwriter_handle h, long int i);
   int jsonwriter_null(jsonwriter_handle h);
 
-
   // optionally, you can configure jsonwriter to handle custom variant types
   enum jsonwriter_datatype {
     jsonwriter_datatype_null = 0,
@@ -74,13 +78,13 @@ extern "C" {
   // jsonwriter_set_variant_handler(): provide jsonwriter with a custom function that converts your data to a jsonwriter_variant
   // with an optional cleanup callback
   // returns 0 on success, nonzero on error
-  enum jsonwriter_error
+  enum jsonwriter_status
   jsonwriter_set_variant_handler(jsonwriter_handle h,
                                  struct jsonwriter_variant (*to_jsw_variant)(void *),
                                  void (*cleanup)(void *, struct jsonwriter_variant *));
 
   // write a variant. will use custom to_jsw_variant() to convert data to jsonwriter_variant
-  enum jsonwriter_error jsonwriter_variant(jsonwriter_handle h, void *data);
+  enum jsonwriter_status jsonwriter_variant(jsonwriter_handle h, void *data);
 
 #ifdef __cplusplus
 }