CR changes to encoder opts

Author: samantharitter

src/libbson/doc/bson_json_opts_destroy.rst

@@ -0,0 +1,22 @@
+:man_page: bson_json_opts_destroy
+
+bson_json_opts_destroy()
+========================
+
+Synopsis
+--------
+
+.. code-block:: c
+
+  void
+  bson_json_opts_destroy (bson_json_opts_t *opts);
+
+Parameters
+----------
+
+* ``opts``: A :symbol:`bson_json_opts_t`.
+
+Description
+-----------
+
+Destroys and releases all resources associated with ``opts``. Does nothing if ``opts`` is NULL.

src/libbson/doc/bson_json_opts_new.rst

@@ -0,0 +1,31 @@
+:man_page: bson_json_opts_new
+
+bson_json_opts_new()
+====================
+
+Synopsis
+--------
+
+.. code-block:: c
+
+  bson_json_opts_t *
+  bson_json_opts_new (bson_json_mode_t mode, int32_t max_len);
+
+Parameters
+----------
+
+* ``mode``: A bson_json_mode_t.
+* ``max_len``: An int32_t.
+
+Description
+-----------
+
+The :symbol:`bson_json_opts_new()` function shall create a new :symbol:`bson_json_opts_t` using the mode and length supplied.  The ``mode`` member is a :symbol:`bson_json_mode_t` defining the encoding mode.
+
+The ``max_len`` member holds a maximum length for the resulting JSON string. Encoding will stop once the serialised string has reached this length. To encode the full BSON document, ``BSON_MAX_LEN_UNLIMITED`` can be used.
+
+Returns
+-------
+
+A newly allocated :symbol:`bson_json_opts_t`.
+

src/libbson/doc/bson_json_opts_t.rst

@@ -12,10 +12,14 @@ Synopsis
 
   #include <bson/bson.h>
 
-  typedef struct {
-     bson_json_mode_t mode;
-     int32_t max_len;
-  } bson_json_opts_t;
+  typedef struct _bson_json_opts_t bson_json_opts_t;
+
+  bson_json_opts_t *
+  bson_json_opts_new (bson_json_mode_t mode, int32_t max_len);
+
+  void
+  bson_json_opts_destroy (bson_json_opts_t *opts);
+
 
 Description
 -----------
@@ -31,3 +35,16 @@ The ``max_len`` member holds a maximum length for the resulting JSON string. Enc
   | :symbol:`bson_as_json_with_opts()`
 
 .. _MongoDB Extended JSON: https://github.com/mongodb/specifications/blob/master/source/extended-json.rst
+
+
+.. only:: html
+
+	  Functions
+	  ---------
+
+	  .. toctree::
+	     :titlesonly:
+	     :maxdepth: 1
+
+	     bson_json_opts_new
+	     bson_json_opts_destroy

src/libbson/src/bson/CMakeLists.txt

@@ -27,6 +27,7 @@ set (src_libbson_src_bson_DIST_hs
    bson-iso8601-private.h
    bson-context-private.h
    bson-timegm-private.h
+   bson-json-private.h
    forwarding/bson.h
 )
 extra_dist_generated (

src/libbson/src/bson/bson-json-private.h

@@ -0,0 +1,29 @@
+/*
+ * Copyright 2020 MongoDB, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#include "bson-prelude.h"
+
+#ifndef BSON_JSON_PRIVATE_H
+#define BSON_JSON_PRIVATE_H
+
+
+struct _bson_json_opts_t {
+   bson_json_mode_t mode;
+   int32_t max_len;
+};
+
+
+#endif /* BSON_JSON_PRIVATE_H */

src/libbson/src/bson/bson-json.c

@@ -23,6 +23,7 @@
 #include "bson.h"
 #include "bson-config.h"
 #include "bson-json.h"
+#include "bson-json-private.h"
 #include "bson-iso8601-private.h"
 
 #include "common-b64-private.h"
@@ -392,6 +393,25 @@ _noop (void)
    }
 
 
+
+bson_json_opts_t *
+bson_json_opts_new (bson_json_mode_t mode, int32_t max_len)
+{
+   bson_json_opts_t *opts;
+
+   opts = (bson_json_opts_t *) bson_malloc (sizeof *opts);
+   opts->mode = mode;
+   opts->max_len = max_len;
+
+   return opts;
+}
+
+void
+bson_json_opts_destroy (bson_json_opts_t *opts)
+{
+   bson_free (opts);
+}
+
 static void
 _bson_json_read_set_error (bson_json_reader_t *reader, const char *fmt, ...)
    BSON_GNUC_PRINTF (2, 3);

src/libbson/src/bson/bson-json.h

@@ -37,6 +37,32 @@ typedef enum {
 } bson_json_error_code_t;
 
 
+/**
+ * BSON_MAX_LEN_UNLIMITED
+ *
+ * Denotes unlimited length limit when converting BSON to JSON.
+ */
+#define BSON_MAX_LEN_UNLIMITED -1
+
+/**
+ * bson_json_mode_t:
+ *
+ * This enumeration contains the different modes to serialize BSON into extended
+ * JSON.
+ */
+typedef enum {
+   BSON_JSON_MODE_LEGACY,
+   BSON_JSON_MODE_CANONICAL,
+   BSON_JSON_MODE_RELAXED,
+} bson_json_mode_t;
+
+
+BSON_EXPORT (bson_json_opts_t *)
+bson_json_opts_new (bson_json_mode_t mode, int32_t max_len);
+BSON_EXPORT (void)
+bson_json_opts_destroy (bson_json_opts_t *opts);
+
+
 typedef ssize_t (*bson_json_reader_cb) (void *handle,
                                         uint8_t *buf,
                                         size_t count);

src/libbson/src/bson/bson-types.h

@@ -97,6 +97,17 @@ typedef enum {
  */
 typedef struct _bson_context_t bson_context_t;
 
+/**
+ * bson_json_opts_t:
+ *
+ * This structure is used to pass options for serializing BSON into extended
+ * JSON to the respective serialization methods.
+ *
+ * max_len can be either a non-negative integer, or BSON_MAX_LEN_UNLIMITED to
+ * set no limit for serialization length.
+ */
+typedef struct _bson_json_opts_t bson_json_opts_t;
+
 
 /**
  * bson_t:
@@ -519,40 +530,6 @@ typedef struct _bson_error_t {
 } bson_error_t BSON_ALIGNED_END (8);
 
 
-/**
- * BSON_MAX_LEN_UNLIMITED
- *
- * Denotes unlimited length limit when converting BSON to JSON.
- */
-#define BSON_MAX_LEN_UNLIMITED -1
-
-/**
- * bson_json_mode_t:
- *
- * This enumeration contains the different modes to serialize BSON into extended
- * JSON.
- */
-typedef enum {
-   BSON_JSON_MODE_LEGACY,
-   BSON_JSON_MODE_CANONICAL,
-   BSON_JSON_MODE_RELAXED,
-} bson_json_mode_t;
-
-/**
- * bson_json_opts_t:
- *
- * This structure is used to pass options for serializing BSON into extended
- * JSON to the respective serialization methods.
- *
- * max_len can be either a non-negative integer, or BSON_MAX_LEN_UNLIMITED to
- * set no limit for serialization length.
- */
-typedef struct {
-   bson_json_mode_t mode;
-   int32_t max_len;
-} bson_json_opts_t;
-
-
 BSON_STATIC_ASSERT2 (error_t, sizeof (bson_error_t) == 512);
 
 

src/libbson/src/bson/bson.c

@@ -18,6 +18,7 @@
 #include "bson.h"
 #include "bson-config.h"
 #include "bson-private.h"
+#include "bson-json-private.h"
 #include "bson-string.h"
 #include "bson-iso8601-private.h"
 
@@ -3197,6 +3198,7 @@ _bson_as_json_visit_all (const bson_t *bson,
    bson_json_state_t state;
    bson_iter_t iter;
    ssize_t err_offset = -1;
+   int32_t remaining;
 
    BSON_ASSERT (bson);
 
@@ -3238,8 +3240,13 @@ _bson_as_json_visit_all (const bson_t *bson,
       return NULL;
    }
 
-   if (!state.max_len_reached) {
+   /* Append closing space and } separately, in case we hit the max in between. */
+   remaining = state.max_len - state.str->len;
+   if (state.max_len == BSON_MAX_LEN_UNLIMITED ||
+       remaining > 1) {
       bson_string_append (state.str, " }");
+   } else if (remaining == 1) {
+      bson_string_append (state.str, " ");
    }
 
    if (length) {
@@ -3292,12 +3299,13 @@ bson_array_as_json (const bson_t *bson, size_t *length)
    bson_json_state_t state;
    bson_iter_t iter;
    ssize_t err_offset = -1;
+   int32_t remaining;
 
    BSON_ASSERT (bson);
 
    if (length) {
       *length = 0;
-   }
+    }
 
    if (bson_empty0 (bson)) {
       if (length) {
@@ -3317,7 +3325,7 @@ bson_array_as_json (const bson_t *bson, size_t *length)
    state.depth = 0;
    state.err_offset = &err_offset;
    state.mode = BSON_JSON_MODE_LEGACY;
-   state.max_len = BSON_MAX_LEN_UNLIMITED;
+   state.max_len = BSON_MAX_LEN_UNLIMITED; // TODO: how does the limit get here?
    state.max_len_reached = false;
 
    if ((bson_iter_visit_all (&iter, &bson_as_json_visitors, &state) ||
@@ -3333,8 +3341,13 @@ bson_array_as_json (const bson_t *bson, size_t *length)
       return NULL;
    }
 
-   if (!state.max_len_reached) {
+   /* Append closing space and ] separately, in case we hit the max in between. */
+   remaining = state.max_len - state.str->len;
+   if (state.max_len == BSON_MAX_LEN_UNLIMITED ||
+       remaining > 1) {
       bson_string_append (state.str, " ]");
+   } else if (remaining == 1) {
+      bson_string_append (state.str, " ");
    }
 
    if (length) {