Fix nlohmann#3513, explain is_ndarray flag

fangq · fangq · commit 36054c4a4e0c · 2022-06-01T16:45:38.000-04:00
diff --git a/include/nlohmann/detail/input/binary_reader.hpp b/include/nlohmann/detail/input/binary_reader.hpp
@@ -1938,7 +1938,7 @@ class binary_reader
     {
         std::pair<std::size_t, char_int_type> size_and_type;
         size_t dimlen = 0;
-        bool is_ndarray = true;
+        bool no_ndarray = true;
 
         if (JSON_HEDLEY_UNLIKELY(!get_ubjson_size_type(size_and_type)))
         {
@@ -1953,7 +1953,7 @@ class binary_reader
                 {
                     for (std::size_t i = 0; i < size_and_type.first; ++i)
                     {
-                        if (JSON_HEDLEY_UNLIKELY(!get_ubjson_size_value(dimlen, is_ndarray, size_and_type.second)))
+                        if (JSON_HEDLEY_UNLIKELY(!get_ubjson_size_value(dimlen, no_ndarray, size_and_type.second)))
                         {
                             return false;
                         }
@@ -1965,7 +1965,7 @@ class binary_reader
             {
                 for (std::size_t i = 0; i < size_and_type.first; ++i)
                 {
-                    if (JSON_HEDLEY_UNLIKELY(!get_ubjson_size_value(dimlen, is_ndarray)))
+                    if (JSON_HEDLEY_UNLIKELY(!get_ubjson_size_value(dimlen, no_ndarray)))
                     {
                         return false;
                     }
@@ -1977,7 +1977,7 @@ class binary_reader
         {
             while (current != ']')
             {
-                if (JSON_HEDLEY_UNLIKELY(!get_ubjson_size_value(dimlen, is_ndarray, current)))
+                if (JSON_HEDLEY_UNLIKELY(!get_ubjson_size_value(dimlen, no_ndarray, current)))
                 {
                     return false;
                 }
@@ -1990,6 +1990,12 @@ class binary_reader
 
     /*!
     @param[out] result  determined size
+    @param[in,out] is_ndarray  for input, `true` means already inside an ndarray vector
+                               or ndarray dimension is not allowed; `false` means ndarray
+                               is allowed; for output, `true` means an ndarray is found;
+                               is_ndarray only returns true when its initial value is `false`
+    @param[in] prefix  the previously read or set type prefix, read next if not given
+
     @return whether size determination completed
     */
     bool get_ubjson_size_value(std::size_t& result, bool& is_ndarray, char_int_type prefix = 0)
@@ -2640,8 +2646,8 @@ class binary_reader
     {
         // get size of following number string
         std::size_t size{};
-        bool is_ndarray = false;
-        auto res = get_ubjson_size_value(size, is_ndarray);
+        bool no_ndarray = true;
+        auto res = get_ubjson_size_value(size, no_ndarray);
         if (JSON_HEDLEY_UNLIKELY(!res))
         {
             return res;
diff --git a/single_include/nlohmann/json.hpp b/single_include/nlohmann/json.hpp
@@ -10421,7 +10421,7 @@ class binary_reader
     {
         std::pair<std::size_t, char_int_type> size_and_type;
         size_t dimlen = 0;
-        bool is_ndarray = true;
+        bool no_ndarray = true;
 
         if (JSON_HEDLEY_UNLIKELY(!get_ubjson_size_type(size_and_type)))
         {
@@ -10436,7 +10436,7 @@ class binary_reader
                 {
                     for (std::size_t i = 0; i < size_and_type.first; ++i)
                     {
-                        if (JSON_HEDLEY_UNLIKELY(!get_ubjson_size_value(dimlen, is_ndarray, size_and_type.second)))
+                        if (JSON_HEDLEY_UNLIKELY(!get_ubjson_size_value(dimlen, no_ndarray, size_and_type.second)))
                         {
                             return false;
                         }
@@ -10448,7 +10448,7 @@ class binary_reader
             {
                 for (std::size_t i = 0; i < size_and_type.first; ++i)
                 {
-                    if (JSON_HEDLEY_UNLIKELY(!get_ubjson_size_value(dimlen, is_ndarray)))
+                    if (JSON_HEDLEY_UNLIKELY(!get_ubjson_size_value(dimlen, no_ndarray)))
                     {
                         return false;
                     }
@@ -10460,7 +10460,7 @@ class binary_reader
         {
             while (current != ']')
             {
-                if (JSON_HEDLEY_UNLIKELY(!get_ubjson_size_value(dimlen, is_ndarray, current)))
+                if (JSON_HEDLEY_UNLIKELY(!get_ubjson_size_value(dimlen, no_ndarray, current)))
                 {
                     return false;
                 }
@@ -10473,6 +10473,12 @@ class binary_reader
 
     /*!
     @param[out] result  determined size
+    @param[in,out] is_ndarray  for input, `true` means already inside an ndarray vector
+                               or ndarray dimension is not allowed; `false` means ndarray
+                               is allowed; for output, `true` means an ndarray is found;
+                               is_ndarray only returns true when its initial value is `false`
+    @param[in] prefix  the previously read or set type prefix, read next if not given
+
     @return whether size determination completed
     */
     bool get_ubjson_size_value(std::size_t& result, bool& is_ndarray, char_int_type prefix = 0)
@@ -11123,8 +11129,8 @@ class binary_reader
     {
         // get size of following number string
         std::size_t size{};
-        bool is_ndarray = false;
-        auto res = get_ubjson_size_value(size, is_ndarray);
+        bool no_ndarray = true;
+        auto res = get_ubjson_size_value(size, no_ndarray);
         if (JSON_HEDLEY_UNLIKELY(!res))
         {
             return res;

Original file line number	Diff line number	Diff line change
`@@ -1938,7 +1938,7 @@ class binary_reader`
`1938`	`1938`	`{`
`1939`	`1939`	`std::pair<std::size_t, char_int_type> size_and_type;`
`1940`	`1940`	`size_t dimlen = 0;`
`1941`		`- bool is_ndarray = true;`
	`1941`	`+ bool no_ndarray = true;`
`1942`	`1942`
`1943`	`1943`	`if (JSON_HEDLEY_UNLIKELY(!get_ubjson_size_type(size_and_type)))`
`1944`	`1944`	`{`
`@@ -1953,7 +1953,7 @@ class binary_reader`
`1953`	`1953`	`{`
`1954`	`1954`	`for (std::size_t i = 0; i < size_and_type.first; ++i)`
`1955`	`1955`	`{`
`1956`		`- if (JSON_HEDLEY_UNLIKELY(!get_ubjson_size_value(dimlen, is_ndarray, size_and_type.second)))`
	`1956`	`+ if (JSON_HEDLEY_UNLIKELY(!get_ubjson_size_value(dimlen, no_ndarray, size_and_type.second)))`
`1957`	`1957`	`{`
`1958`	`1958`	`return false;`
`1959`	`1959`	`}`
`@@ -1965,7 +1965,7 @@ class binary_reader`
`1965`	`1965`	`{`
`1966`	`1966`	`for (std::size_t i = 0; i < size_and_type.first; ++i)`
`1967`	`1967`	`{`
`1968`		`- if (JSON_HEDLEY_UNLIKELY(!get_ubjson_size_value(dimlen, is_ndarray)))`
	`1968`	`+ if (JSON_HEDLEY_UNLIKELY(!get_ubjson_size_value(dimlen, no_ndarray)))`
`1969`	`1969`	`{`
`1970`	`1970`	`return false;`
`1971`	`1971`	`}`
`@@ -1977,7 +1977,7 @@ class binary_reader`
`1977`	`1977`	`{`
`1978`	`1978`	`while (current != ']')`
`1979`	`1979`	`{`
`1980`		`- if (JSON_HEDLEY_UNLIKELY(!get_ubjson_size_value(dimlen, is_ndarray, current)))`
	`1980`	`+ if (JSON_HEDLEY_UNLIKELY(!get_ubjson_size_value(dimlen, no_ndarray, current)))`
`1981`	`1981`	`{`
`1982`	`1982`	`return false;`
`1983`	`1983`	`}`
`@@ -1990,6 +1990,12 @@ class binary_reader`
`1990`	`1990`
`1991`	`1991`	`/*!`
`1992`	`1992`	`@param[out] result determined size`
	`1993`	+ @param[in,out] is_ndarray for input, `true` means already inside an ndarray vector
	`1994`	+ or ndarray dimension is not allowed; `false` means ndarray
	`1995`	+ is allowed; for output, `true` means an ndarray is found;
	`1996`	+ is_ndarray only returns true when its initial value is `false`
	`1997`	`+ @param[in] prefix the previously read or set type prefix, read next if not given`
	`1998`	`+`
`1993`	`1999`	`@return whether size determination completed`
`1994`	`2000`	`*/`
`1995`	`2001`	`bool get_ubjson_size_value(std::size_t& result, bool& is_ndarray, char_int_type prefix = 0)`
`@@ -2640,8 +2646,8 @@ class binary_reader`
`2640`	`2646`	`{`
`2641`	`2647`	`// get size of following number string`
`2642`	`2648`	`std::size_t size{};`
`2643`		`- bool is_ndarray = false;`
`2644`		`- auto res = get_ubjson_size_value(size, is_ndarray);`
	`2649`	`+ bool no_ndarray = true;`
	`2650`	`+ auto res = get_ubjson_size_value(size, no_ndarray);`
`2645`	`2651`	`if (JSON_HEDLEY_UNLIKELY(!res))`
`2646`	`2652`	`{`
`2647`	`2653`	`return res;`
Original file line number	Diff line number	Diff line change
`@@ -10421,7 +10421,7 @@ class binary_reader`
`10421`	`10421`	`{`
`10422`	`10422`	`std::pair<std::size_t, char_int_type> size_and_type;`
`10423`	`10423`	`size_t dimlen = 0;`
`10424`		`- bool is_ndarray = true;`
	`10424`	`+ bool no_ndarray = true;`
`10425`	`10425`
`10426`	`10426`	`if (JSON_HEDLEY_UNLIKELY(!get_ubjson_size_type(size_and_type)))`
`10427`	`10427`	`{`
`@@ -10436,7 +10436,7 @@ class binary_reader`
`10436`	`10436`	`{`
`10437`	`10437`	`for (std::size_t i = 0; i < size_and_type.first; ++i)`
`10438`	`10438`	`{`
`10439`		`- if (JSON_HEDLEY_UNLIKELY(!get_ubjson_size_value(dimlen, is_ndarray, size_and_type.second)))`
	`10439`	`+ if (JSON_HEDLEY_UNLIKELY(!get_ubjson_size_value(dimlen, no_ndarray, size_and_type.second)))`
`10440`	`10440`	`{`
`10441`	`10441`	`return false;`
`10442`	`10442`	`}`
`@@ -10448,7 +10448,7 @@ class binary_reader`
`10448`	`10448`	`{`
`10449`	`10449`	`for (std::size_t i = 0; i < size_and_type.first; ++i)`
`10450`	`10450`	`{`
`10451`		`- if (JSON_HEDLEY_UNLIKELY(!get_ubjson_size_value(dimlen, is_ndarray)))`
	`10451`	`+ if (JSON_HEDLEY_UNLIKELY(!get_ubjson_size_value(dimlen, no_ndarray)))`
`10452`	`10452`	`{`
`10453`	`10453`	`return false;`
`10454`	`10454`	`}`
`@@ -10460,7 +10460,7 @@ class binary_reader`
`10460`	`10460`	`{`
`10461`	`10461`	`while (current != ']')`
`10462`	`10462`	`{`
`10463`		`- if (JSON_HEDLEY_UNLIKELY(!get_ubjson_size_value(dimlen, is_ndarray, current)))`
	`10463`	`+ if (JSON_HEDLEY_UNLIKELY(!get_ubjson_size_value(dimlen, no_ndarray, current)))`
`10464`	`10464`	`{`
`10465`	`10465`	`return false;`
`10466`	`10466`	`}`
`@@ -10473,6 +10473,12 @@ class binary_reader`
`10473`	`10473`
`10474`	`10474`	`/*!`
`10475`	`10475`	`@param[out] result determined size`
	`10476`	+ @param[in,out] is_ndarray for input, `true` means already inside an ndarray vector
	`10477`	+ or ndarray dimension is not allowed; `false` means ndarray
	`10478`	+ is allowed; for output, `true` means an ndarray is found;
	`10479`	+ is_ndarray only returns true when its initial value is `false`
	`10480`	`+ @param[in] prefix the previously read or set type prefix, read next if not given`
	`10481`	`+`
`10476`	`10482`	`@return whether size determination completed`
`10477`	`10483`	`*/`
`10478`	`10484`	`bool get_ubjson_size_value(std::size_t& result, bool& is_ndarray, char_int_type prefix = 0)`
`@@ -11123,8 +11129,8 @@ class binary_reader`
`11123`	`11129`	`{`
`11124`	`11130`	`// get size of following number string`
`11125`	`11131`	`std::size_t size{};`
`11126`		`- bool is_ndarray = false;`
`11127`		`- auto res = get_ubjson_size_value(size, is_ndarray);`
	`11132`	`+ bool no_ndarray = true;`
	`11133`	`+ auto res = get_ubjson_size_value(size, no_ndarray);`
`11128`	`11134`	`if (JSON_HEDLEY_UNLIKELY(!res))`
`11129`	`11135`	`{`
`11130`	`11136`	`return res;`