octave: libinterp/corefcn/jsondecode.cc annotate

annotate libinterp/corefcn/jsondecode.cc @ 28761:b5461b1dc0ca

Review jsonecode/jsondecode BIST tests. * test/json/jsondecode_BIST.tst: Renamed file from "jsondecodetest.tst". * test/json/jsonencode_BIST.tst: Renamed file from "jsonencodetest.tst". * test/json/module.mk: Update build system with new file names. * jsondecode_BIST.tst, jsonencode_BIST.tst: Use "obs" as variable name for observed result. Use Octave convention of two leading comment characters for full-line comments. Test explicitly for class of decoded logical values as isequal() does not do that. Add FIXME about jsondecode failure to decode logical array. Shorten lines to mostly be less than 80 characters. Add tests for Octave-specific value 'NA' for jsonencode. Add FIXME about Matlab compatibility with double quoted strings and jsonencode. Remove duplicated %!testif block. Add FIXME to jsonencode_BIST.tst about need for tests with "PrettyWriter" set to true. * jsondecode.cc: Add note that functional BIST tests are not located with the code in this file, but in the file jsondecode_BIST.tst. * jsonencode.cc: Add note that functional BIST tests are not located with the code in this file, but in the file jsonencode_BIST.tst. Change wording of documentation about preserving array dimensions. Wrap long lines in input validation BIST tests.

author	Rik <rik@octave.org>
date	Fri, 18 Sep 2020 13:02:43 -0700
parents	80857685105b
children	ffa6c50c2eaa

rev	line source
28615 5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	1 ////////////////////////////////////////////////////////////////////////
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	2 //
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	3 // Copyright (C) 2020 The Octave Project Developers
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	4 //
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	5 // See the file COPYRIGHT.md in the top-level directory of this
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	6 // distribution or <https://octave.org/copyright/>.
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	7 //
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	8 // This file is part of Octave.
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	9 //
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	10 // Octave is free software: you can redistribute it and/or modify it
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	11 // under the terms of the GNU General Public License as published by
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	12 // the Free Software Foundation, either version 3 of the License, or
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	13 // (at your option) any later version.
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	14 //
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	15 // Octave is distributed in the hope that it will be useful, but
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	16 // WITHOUT ANY WARRANTY; without even the implied warranty of
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	17 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	18 // GNU General Public License for more details.
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	19 //
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	20 // You should have received a copy of the GNU General Public License
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	21 // along with Octave; see the file COPYING. If not, see
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	22 // <https://www.gnu.org/licenses/>.
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	23 //
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	24 ////////////////////////////////////////////////////////////////////////
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	25
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	26 #if defined (HAVE_CONFIG_H)
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	27 # include "config.h"
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	28 #endif
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	29
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	30 #include "defun.h"
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	31 #include "error.h"
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	32 #include "errwarn.h"
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	33 #include "ovl.h"
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	34 #include "parse.h"
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	35
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	36 #if defined (HAVE_RAPIDJSON)
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	37 # include <rapidjson/document.h>
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	38 # include <rapidjson/error/en.h>
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	39 #endif
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	40
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	41 #if defined (HAVE_RAPIDJSON)
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	42
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	43 octave_value
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	44 decode (const rapidjson::Value& val, const octave_value_list& options);
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	45
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	46 //! Decodes a numerical JSON value into a scalar number.
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	47 //!
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	48 //! @param val JSON value that is guaranteed to be a numerical value.
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	49 //!
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	50 //! @return @ref octave_value that contains the numerical value of @p val.
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	51 //!
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	52 //! @b Example:
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	53 //!
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	54 //! @code{.cc}
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	55 //! rapidjson::Document d;
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	56 //! d.Parse ("123");
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	57 //! octave_value num = decode_number (d);
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	58 //! @endcode
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	59
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	60 octave_value
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	61 decode_number (const rapidjson::Value& val)
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	62 {
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	63 if (val.IsUint ())
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	64 return octave_value (val.GetUint ());
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	65 else if (val.IsInt ())
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	66 return octave_value (val.GetInt ());
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	67 else if (val.IsUint64 ())
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	68 return octave_value (val.GetUint64 ());
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	69 else if (val.IsInt64 ())
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	70 return octave_value (val.GetInt64 ());
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	71 else if (val.IsDouble ())
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	72 return octave_value (val.GetDouble ());
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	73 else
28750 80857685105b Code review for jsonencode/jsondecode functions. Rik <rik@octave.org> parents: 28626 diff changeset	74 error ("jsondecode: unidentified type");
28615 5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	75 }
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	76
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	77 //! Decodes a JSON object into a scalar struct.
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	78 //!
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	79 //! @param val JSON value that is guaranteed to be a JSON object.
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	80 //! @param options @c ReplacementStyle and @c Prefix options with their values.
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	81 //!
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	82 //! @return @ref octave_value that contains the equivalent scalar struct of @p val.
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	83 //!
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	84 //! @b Example:
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	85 //!
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	86 //! @code{.cc}
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	87 //! rapidjson::Document d;
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	88 //! d.Parse ("{\"a\": 1, \"b\": 2}");
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	89 //! octave_value struct = decode_object (d, octave_value_list ());
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	90 //! @endcode
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	91
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	92 octave_value
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	93 decode_object (const rapidjson::Value& val, const octave_value_list& options)
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	94 {
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	95 octave_scalar_map retval;
28750 80857685105b Code review for jsonencode/jsondecode functions. Rik <rik@octave.org> parents: 28626 diff changeset	96
80857685105b Code review for jsonencode/jsondecode functions. Rik <rik@octave.org> parents: 28626 diff changeset	97 // Validator function to guarantee legitimate variable name.
80857685105b Code review for jsonencode/jsondecode functions. Rik <rik@octave.org> parents: 28626 diff changeset	98 std::string fcn_name = "matlab.lang.makeValidName";
80857685105b Code review for jsonencode/jsondecode functions. Rik <rik@octave.org> parents: 28626 diff changeset	99
28615 5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	100 for (const auto& pair : val.GetObject ())
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	101 {
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	102 octave_value_list args = octave_value_list (pair.name.GetString ());
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	103 args.append (options);
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	104 std::string validName = octave::feval (fcn_name,args)(0).string_value ();
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	105 retval.assign (validName, decode (pair.value, options));
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	106 }
28750 80857685105b Code review for jsonencode/jsondecode functions. Rik <rik@octave.org> parents: 28626 diff changeset	107
80857685105b Code review for jsonencode/jsondecode functions. Rik <rik@octave.org> parents: 28626 diff changeset	108 return retval;
28615 5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	109 }
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	110
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	111 //! Decodes a JSON array that contains only numerical or null values
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	112 //! into an NDArray.
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	113 //!
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	114 //! @param val JSON value that is guaranteed to be a numeric array.
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	115 //!
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	116 //! @return @ref octave_value that contains the equivalent NDArray of @p val.
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	117 //!
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	118 //! @b Example:
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	119 //!
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	120 //! @code{.cc}
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	121 //! rapidjson::Document d;
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	122 //! d.Parse ("[1, 2, 3, 4]");
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	123 //! octave_value numeric_array = decode_numeric_array (d);
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	124 //! @endcode
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	125
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	126 octave_value
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	127 decode_numeric_array (const rapidjson::Value& val)
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	128 {
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	129 NDArray retval (dim_vector (val.Size (), 1));
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	130 octave_idx_type index = 0;
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	131 for (const auto& elem : val.GetArray ())
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	132 retval(index++) = elem.IsNull () ? octave_NaN
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	133 : decode_number (elem).double_value ();
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	134 return retval;
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	135 }
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	136
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	137 //! Decodes a JSON array that contains only boolean values into a boolNDArray.
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	138 //!
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	139 //! @param val JSON value that is guaranteed to be a boolean array.
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	140 //!
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	141 //! @return @ref octave_value that contains the equivalent boolNDArray of @p val.
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	142 //!
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	143 //! @b Example:
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	144 //!
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	145 //! @code{.cc}
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	146 //! rapidjson::Document d;
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	147 //! d.Parse ("[true, false, true]");
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	148 //! octave_value boolean_array = decode_boolean_array (d);
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	149 //! @endcode
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	150
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	151 octave_value
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	152 decode_boolean_array (const rapidjson::Value& val)
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	153 {
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	154 boolNDArray retval (dim_vector (val.Size (), 1));
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	155 octave_idx_type index = 0;
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	156 for (const auto& elem : val.GetArray ())
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	157 retval(index++) = elem.GetBool ();
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	158 return retval;
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	159 }
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	160
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	161 //! Decodes a JSON array that contains different types
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	162 //! or string values only into a Cell.
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	163 //!
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	164 //! @param val JSON value that is guaranteed to be a mixed or string array.
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	165 //! @param options @c ReplacementStyle and @c Prefix options with their values.
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	166 //!
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	167 //! @return @ref octave_value that contains the equivalent Cell of @p val.
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	168 //!
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	169 //! @b Example (decoding a string array):
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	170 //!
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	171 //! @code{.cc}
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	172 //! rapidjson::Document d;
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	173 //! d.Parse ("[\"foo\", \"bar\", \"baz\"]");
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	174 //! octave_value cell = decode_string_and_mixed_array (d, octave_value_list ());
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	175 //! @endcode
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	176 //!
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	177 //! @b Example (decoding a mixed array):
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	178 //!
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	179 //! @code{.cc}
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	180 //! rapidjson::Document d;
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	181 //! d.Parse ("[\"foo\", 123, true]");
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	182 //! octave_value cell = decode_string_and_mixed_array (d, octave_value_list ());
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	183 //! @endcode
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	184
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	185 octave_value
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	186 decode_string_and_mixed_array (const rapidjson::Value& val,
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	187 const octave_value_list& options)
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	188 {
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	189 Cell retval (dim_vector (val.Size (), 1));
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	190 octave_idx_type index = 0;
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	191 for (const auto& elem : val.GetArray ())
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	192 retval(index++) = decode (elem, options);
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	193 return retval;
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	194 }
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	195
28750 80857685105b Code review for jsonencode/jsondecode functions. Rik <rik@octave.org> parents: 28626 diff changeset	196 //! Decodes a JSON array that contains only objects into a Cell or struct array
28615 5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	197 //! depending on the similarity of the objects' keys.
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	198 //!
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	199 //! @param val JSON value that is guaranteed to be an object array.
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	200 //! @param options @c ReplacementStyle and @c Prefix options with their values.
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	201 //!
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	202 //! @return @ref octave_value that contains the equivalent Cell
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	203 //! or struct array of @p val.
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	204 //!
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	205 //! @b Example (returns a struct array):
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	206 //!
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	207 //! @code{.cc}
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	208 //! rapidjson::Document d;
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	209 //! d.Parse ("[{\"a\":1,\"b\":2},{\"a\":3,\"b\":4}]");
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	210 //! octave_value object_array = decode_object_array (d, octave_value_list ());
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	211 //! @endcode
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	212 //!
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	213 //! @b Example (returns a Cell):
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	214 //!
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	215 //! @code{.cc}
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	216 //! rapidjson::Document d;
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	217 //! d.Parse ("[{\"a\":1,\"b\":2},{\"b\":3,\"a\":4}]");
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	218 //! octave_value object_array = decode_object_array (d, octave_value_list ());
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	219 //! @endcode
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	220
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	221 octave_value
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	222 decode_object_array (const rapidjson::Value& val,
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	223 const octave_value_list& options)
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	224 {
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	225 Cell struct_cell = decode_string_and_mixed_array (val, options).cell_value ();
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	226 string_vector field_names = struct_cell(0).scalar_map_value ().fieldnames ();
28750 80857685105b Code review for jsonencode/jsondecode functions. Rik <rik@octave.org> parents: 28626 diff changeset	227
28625 173807014259 jsondecode.cc: Prefer STL to custom comparison function Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28624 diff changeset	228 bool same_field_names = true;
28615 5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	229 for (octave_idx_type i = 1; i < struct_cell.numel (); ++i)
28625 173807014259 jsondecode.cc: Prefer STL to custom comparison function Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28624 diff changeset	230 if (field_names.std_list ()
173807014259 jsondecode.cc: Prefer STL to custom comparison function Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28624 diff changeset	231 != struct_cell(i).scalar_map_value ().fieldnames ().std_list ())
28615 5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	232 {
28750 80857685105b Code review for jsonencode/jsondecode functions. Rik <rik@octave.org> parents: 28626 diff changeset	233 same_field_names = false;
28615 5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	234 break;
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	235 }
28750 80857685105b Code review for jsonencode/jsondecode functions. Rik <rik@octave.org> parents: 28626 diff changeset	236
28615 5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	237 if (same_field_names)
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	238 {
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	239 octave_map struct_array;
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	240 Cell value (dim_vector (struct_cell.numel (), 1));
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	241 for (octave_idx_type i = 0; i < field_names.numel (); ++i)
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	242 {
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	243 for (octave_idx_type k = 0; k < struct_cell.numel (); ++k)
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	244 value(k) = struct_cell(k).scalar_map_value ().getfield (field_names(i));
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	245 struct_array.assign (field_names(i), value);
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	246 }
28750 80857685105b Code review for jsonencode/jsondecode functions. Rik <rik@octave.org> parents: 28626 diff changeset	247 return struct_array;
28615 5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	248 }
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	249 else
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	250 return struct_cell;
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	251 }
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	252
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	253 //! Decodes a JSON array that contains only arrays into a Cell or an NDArray
28750 80857685105b Code review for jsonencode/jsondecode functions. Rik <rik@octave.org> parents: 28626 diff changeset	254 //! depending on the dimensions and element types of the sub-arrays.
28615 5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	255 //!
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	256 //! @param val JSON value that is guaranteed to be an array of arrays.
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	257 //! @param options @c ReplacementStyle and @c Prefix options with their values.
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	258 //!
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	259 //! @return @ref octave_value that contains the equivalent Cell
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	260 //! or NDArray of @p val.
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	261 //!
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	262 //! @b Example (returns an NDArray):
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	263 //!
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	264 //! @code{.cc}
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	265 //! rapidjson::Document d;
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	266 //! d.Parse ("[[1, 2], [3, 4]]");
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	267 //! octave_value array = decode_array_of_arrays (d, octave_value_list ());
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	268 //! @endcode
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	269 //!
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	270 //! @b Example (returns a Cell):
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	271 //!
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	272 //! @code{.cc}
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	273 //! rapidjson::Document d;
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	274 //! d.Parse ("[[1, 2], [3, 4, 5]]");
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	275 //! octave_value cell = decode_array_of_arrays (d, octave_value_list ());
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	276 //! @endcode
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	277
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	278 octave_value
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	279 decode_array_of_arrays (const rapidjson::Value& val,
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	280 const octave_value_list& options)
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	281 {
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	282 // Some arrays should be decoded as NDArrays and others as cell arrays
28750 80857685105b Code review for jsonencode/jsondecode functions. Rik <rik@octave.org> parents: 28626 diff changeset	283 Cell cell = decode_string_and_mixed_array (val, options).cell_value ();
80857685105b Code review for jsonencode/jsondecode functions. Rik <rik@octave.org> parents: 28626 diff changeset	284
80857685105b Code review for jsonencode/jsondecode functions. Rik <rik@octave.org> parents: 28626 diff changeset	285 // Only arrays with sub-arrays of booleans and numericals will return NDArray
28615 5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	286 bool is_bool = cell(0).is_bool_matrix ();
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	287 dim_vector sub_array_dims = cell(0).dims ();
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	288 octave_idx_type sub_array_ndims = cell(0).ndims ();
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	289 octave_idx_type cell_numel = cell.numel ();
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	290 for (octave_idx_type i = 0; i < cell_numel; ++i)
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	291 {
28750 80857685105b Code review for jsonencode/jsondecode functions. Rik <rik@octave.org> parents: 28626 diff changeset	292 // If one element is cell return the cell array as at least one of the
80857685105b Code review for jsonencode/jsondecode functions. Rik <rik@octave.org> parents: 28626 diff changeset	293 // sub-arrays area either an array of: strings, objects or mixed array
28615 5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	294 if (cell(i).iscell ())
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	295 return cell;
28750 80857685105b Code review for jsonencode/jsondecode functions. Rik <rik@octave.org> parents: 28626 diff changeset	296 // If not the same dim of elements or dim = 0, return cell array
28615 5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	297 if (cell(i).dims () != sub_array_dims \|\| sub_array_dims == dim_vector ())
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	298 return cell;
28750 80857685105b Code review for jsonencode/jsondecode functions. Rik <rik@octave.org> parents: 28626 diff changeset	299 // If not numeric sub-arrays only or bool sub-arrays only,
80857685105b Code review for jsonencode/jsondecode functions. Rik <rik@octave.org> parents: 28626 diff changeset	300 // return cell array
80857685105b Code review for jsonencode/jsondecode functions. Rik <rik@octave.org> parents: 28626 diff changeset	301 if (cell(i).is_bool_matrix () != is_bool)
28615 5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	302 return cell;
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	303 }
28750 80857685105b Code review for jsonencode/jsondecode functions. Rik <rik@octave.org> parents: 28626 diff changeset	304
28615 5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	305 // Calculate the dims of the output array
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	306 dim_vector array_dims;
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	307 array_dims.resize (sub_array_ndims + 1);
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	308 array_dims(0) = cell_numel;
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	309 for (auto i = 1; i < sub_array_ndims + 1; i++)
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	310 array_dims(i) = sub_array_dims(i-1);
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	311 NDArray array (array_dims);
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	312
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	313 // Populate the array with specific order to generate MATLAB-identical output
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	314 octave_idx_type array_index = 0;
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	315 for (octave_idx_type i = 0; i < array.numel () / cell_numel; ++i)
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	316 for (octave_idx_type k = 0; k < cell_numel; ++k)
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	317 array(array_index++) = cell(k).array_value ()(i);
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	318 return array;
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	319 }
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	320
28750 80857685105b Code review for jsonencode/jsondecode functions. Rik <rik@octave.org> parents: 28626 diff changeset	321 //! Decodes any type of JSON arrays. This function only serves as an interface
28615 5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	322 //! by choosing which function to call from the previous functions.
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	323 //!
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	324 //! @param val JSON value that is guaranteed to be an array.
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	325 //! @param options @c ReplacementStyle and @c Prefix options with their values.
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	326 //!
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	327 //! @return @ref octave_value that contains the output of decoding @p val.
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	328 //!
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	329 //! @b Example:
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	330 //!
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	331 //! @code{.cc}
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	332 //! rapidjson::Document d;
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	333 //! d.Parse ("[[1, 2], [3, 4, 5]]");
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	334 //! octave_value array = decode_array (d, octave_value_list ());
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	335 //! @endcode
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	336
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	337 octave_value
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	338 decode_array (const rapidjson::Value& val, const octave_value_list& options)
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	339 {
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	340 // Handle empty arrays
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	341 if (val.Empty ())
28750 80857685105b Code review for jsonencode/jsondecode functions. Rik <rik@octave.org> parents: 28626 diff changeset	342 return NDArray ();
28615 5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	343
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	344 // Compare with other elements to know if the array has multiple types
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	345 rapidjson::Type array_type = val[0].GetType ();
28750 80857685105b Code review for jsonencode/jsondecode functions. Rik <rik@octave.org> parents: 28626 diff changeset	346 // Check if the array is numeric and if it has multiple types
80857685105b Code review for jsonencode/jsondecode functions. Rik <rik@octave.org> parents: 28626 diff changeset	347 bool same_type = true;
80857685105b Code review for jsonencode/jsondecode functions. Rik <rik@octave.org> parents: 28626 diff changeset	348 bool is_numeric = true;
28615 5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	349 for (const auto& elem : val.GetArray ())
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	350 {
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	351 rapidjson::Type current_elem_type = elem.GetType ();
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	352 if (is_numeric && ! (current_elem_type == rapidjson::kNullType
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	353 \|\| current_elem_type == rapidjson::kNumberType))
28750 80857685105b Code review for jsonencode/jsondecode functions. Rik <rik@octave.org> parents: 28626 diff changeset	354 is_numeric = false;
28615 5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	355 if (same_type && (current_elem_type != array_type))
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	356 // RapidJSON doesn't have kBoolean Type it has kTrueType and kFalseType
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	357 if (! ((current_elem_type == rapidjson::kTrueType
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	358 && array_type == rapidjson::kFalseType)
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	359 \|\| (current_elem_type == rapidjson::kFalseType
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	360 && array_type == rapidjson::kTrueType)))
28750 80857685105b Code review for jsonencode/jsondecode functions. Rik <rik@octave.org> parents: 28626 diff changeset	361 same_type = false;
28615 5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	362 }
28750 80857685105b Code review for jsonencode/jsondecode functions. Rik <rik@octave.org> parents: 28626 diff changeset	363
28615 5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	364 if (is_numeric)
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	365 return decode_numeric_array (val);
28750 80857685105b Code review for jsonencode/jsondecode functions. Rik <rik@octave.org> parents: 28626 diff changeset	366
28615 5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	367 if (same_type && (array_type != rapidjson::kStringType))
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	368 {
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	369 if (array_type == rapidjson::kTrueType
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	370 \|\| array_type == rapidjson::kFalseType)
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	371 return decode_boolean_array (val);
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	372 else if (array_type == rapidjson::kObjectType)
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	373 return decode_object_array (val, options);
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	374 else if (array_type == rapidjson::kArrayType)
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	375 return decode_array_of_arrays (val, options);
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	376 else
28750 80857685105b Code review for jsonencode/jsondecode functions. Rik <rik@octave.org> parents: 28626 diff changeset	377 error ("jsondecode: unidentified type");
28615 5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	378 }
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	379 else
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	380 return decode_string_and_mixed_array (val, options);
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	381 }
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	382
28750 80857685105b Code review for jsonencode/jsondecode functions. Rik <rik@octave.org> parents: 28626 diff changeset	383 //! Decodes any JSON value. This function only serves as an interface
28615 5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	384 //! by choosing which function to call from the previous functions.
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	385 //!
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	386 //! @param val JSON value.
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	387 //! @param options @c ReplacementStyle and @c Prefix options with their values.
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	388 //!
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	389 //! @return @ref octave_value that contains the output of decoding @p val.
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	390 //!
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	391 //! @b Example:
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	392 //!
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	393 //! @code{.cc}
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	394 //! rapidjson::Document d;
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	395 //! d.Parse ("[{\"a\":1,\"b\":2},{\"b\":3,\"a\":4}]");
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	396 //! octave_value value = decode (d, octave_value_list ());
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	397 //! @endcode
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	398
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	399 octave_value
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	400 decode (const rapidjson::Value& val, const octave_value_list& options)
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	401 {
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	402 if (val.IsBool ())
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	403 return val.GetBool ();
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	404 else if (val.IsNumber ())
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	405 return decode_number (val);
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	406 else if (val.IsString ())
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	407 return val.GetString ();
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	408 else if (val.IsObject ())
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	409 return decode_object (val, options);
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	410 else if (val.IsNull ())
28750 80857685105b Code review for jsonencode/jsondecode functions. Rik <rik@octave.org> parents: 28626 diff changeset	411 return NDArray ();
28615 5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	412 else if (val.IsArray ())
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	413 return decode_array (val, options);
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	414 else
28750 80857685105b Code review for jsonencode/jsondecode functions. Rik <rik@octave.org> parents: 28626 diff changeset	415 error ("jsondecode: unidentified type");
28615 5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	416 }
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	417
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	418 #endif
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	419
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	420 DEFUN (jsondecode, args, ,
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	421 doc: /* -- texinfo --
28750 80857685105b Code review for jsonencode/jsondecode functions. Rik <rik@octave.org> parents: 28626 diff changeset	422 @deftypefn {} {@var{object} =} jsondecode (@var{JSON_txt})
80857685105b Code review for jsonencode/jsondecode functions. Rik <rik@octave.org> parents: 28626 diff changeset	423 @deftypefnx {} {@var{object} =} jsondecode (@dots{}, "ReplacementStyle", @var{rs})
80857685105b Code review for jsonencode/jsondecode functions. Rik <rik@octave.org> parents: 28626 diff changeset	424 @deftypefnx {} {@var{object} =} jsondecode (@dots{}, "Prefix", @var{pfx})
28615 5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	425
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	426 Decode text that is formatted in JSON.
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	427
28750 80857685105b Code review for jsonencode/jsondecode functions. Rik <rik@octave.org> parents: 28626 diff changeset	428 The input @var{JSON_txt} is a string that contains JSON text.
80857685105b Code review for jsonencode/jsondecode functions. Rik <rik@octave.org> parents: 28626 diff changeset	429
80857685105b Code review for jsonencode/jsondecode functions. Rik <rik@octave.org> parents: 28626 diff changeset	430 The output @var{object} is an Octave object that contains the result of
80857685105b Code review for jsonencode/jsondecode functions. Rik <rik@octave.org> parents: 28626 diff changeset	431 decoding @var{JSON_txt}.
28615 5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	432
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	433 For more information about the options @qcode{"ReplacementStyle"} and
28626 34696240591e doc: Improve JSON documentation. Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: 28625 diff changeset	434 @qcode{"Prefix"}, see
34696240591e doc: Improve JSON documentation. Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: 28625 diff changeset	435 @ref{XREFmatlab_lang_makeValidName,,matlab.lang.makeValidName}.
28615 5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	436
28750 80857685105b Code review for jsonencode/jsondecode functions. Rik <rik@octave.org> parents: 28626 diff changeset	437 NOTE: Decoding and encoding JSON text is not guaranteed to reproduce the
80857685105b Code review for jsonencode/jsondecode functions. Rik <rik@octave.org> parents: 28626 diff changeset	438 original text as some names may be changed by @code{matlab.lang.makeValidName}.
28615 5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	439
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	440 This table shows the conversions from JSON data types to Octave data types:
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	441
28750 80857685105b Code review for jsonencode/jsondecode functions. Rik <rik@octave.org> parents: 28626 diff changeset	442 @multitable @columnfractions 0.50 0.50
80857685105b Code review for jsonencode/jsondecode functions. Rik <rik@octave.org> parents: 28626 diff changeset	443 @headitem JSON data type @tab Octave data type
80857685105b Code review for jsonencode/jsondecode functions. Rik <rik@octave.org> parents: 28626 diff changeset	444 @item Boolean @tab scalar logical
80857685105b Code review for jsonencode/jsondecode functions. Rik <rik@octave.org> parents: 28626 diff changeset	445 @item Number @tab scalar double
80857685105b Code review for jsonencode/jsondecode functions. Rik <rik@octave.org> parents: 28626 diff changeset	446 @item String @tab vector of characters
80857685105b Code review for jsonencode/jsondecode functions. Rik <rik@octave.org> parents: 28626 diff changeset	447 @item Object @tab scalar struct (field names of the struct may be different from the keys of the JSON object due to @code{matlab_lang_makeValidName}
80857685105b Code review for jsonencode/jsondecode functions. Rik <rik@octave.org> parents: 28626 diff changeset	448 @item null, inside a numeric array @tab @code{NaN}
80857685105b Code review for jsonencode/jsondecode functions. Rik <rik@octave.org> parents: 28626 diff changeset	449 @item null, inside a non-numeric array @tab empty double array @code{[]}
80857685105b Code review for jsonencode/jsondecode functions. Rik <rik@octave.org> parents: 28626 diff changeset	450 @item Array, of different data types @tab cell array
80857685105b Code review for jsonencode/jsondecode functions. Rik <rik@octave.org> parents: 28626 diff changeset	451 @item Array, of Booleans @tab logical array
80857685105b Code review for jsonencode/jsondecode functions. Rik <rik@octave.org> parents: 28626 diff changeset	452 @item Array, of Numbers @tab double array
80857685105b Code review for jsonencode/jsondecode functions. Rik <rik@octave.org> parents: 28626 diff changeset	453 @item Array, of Strings @tab cell array of character vectors (@code{cellstr})
80857685105b Code review for jsonencode/jsondecode functions. Rik <rik@octave.org> parents: 28626 diff changeset	454 @item Array of Objects, same field names @tab struct array
80857685105b Code review for jsonencode/jsondecode functions. Rik <rik@octave.org> parents: 28626 diff changeset	455 @item Array of Objects, different field names @tab cell array of scalar structs
80857685105b Code review for jsonencode/jsondecode functions. Rik <rik@octave.org> parents: 28626 diff changeset	456 @end multitable
28615 5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	457
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	458 Examples:
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	459
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	460 @example
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	461 @group
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	462 jsondecode ('[1, 2, null, 3]')
28624 aae9d7f098bd Support for RapidJSON 1.1.0 with jsonencode and jsondecode Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: 28615 diff changeset	463 @result{} ans =
aae9d7f098bd Support for RapidJSON 1.1.0 with jsonencode and jsondecode Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: 28615 diff changeset	464
aae9d7f098bd Support for RapidJSON 1.1.0 with jsonencode and jsondecode Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: 28615 diff changeset	465 1
aae9d7f098bd Support for RapidJSON 1.1.0 with jsonencode and jsondecode Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: 28615 diff changeset	466 2
aae9d7f098bd Support for RapidJSON 1.1.0 with jsonencode and jsondecode Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: 28615 diff changeset	467 NaN
aae9d7f098bd Support for RapidJSON 1.1.0 with jsonencode and jsondecode Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: 28615 diff changeset	468 3
28615 5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	469 @end group
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	470
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	471 @group
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	472 jsondecode ('["foo", "bar", ["foo", "bar"]]')
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	473 @result{} ans =
28624 aae9d7f098bd Support for RapidJSON 1.1.0 with jsonencode and jsondecode Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: 28615 diff changeset	474 @{
aae9d7f098bd Support for RapidJSON 1.1.0 with jsonencode and jsondecode Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: 28615 diff changeset	475 [1,1] = foo
aae9d7f098bd Support for RapidJSON 1.1.0 with jsonencode and jsondecode Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: 28615 diff changeset	476 [2,1] = bar
aae9d7f098bd Support for RapidJSON 1.1.0 with jsonencode and jsondecode Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: 28615 diff changeset	477 [3,1] =
aae9d7f098bd Support for RapidJSON 1.1.0 with jsonencode and jsondecode Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: 28615 diff changeset	478 @{
aae9d7f098bd Support for RapidJSON 1.1.0 with jsonencode and jsondecode Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: 28615 diff changeset	479 [1,1] = foo
aae9d7f098bd Support for RapidJSON 1.1.0 with jsonencode and jsondecode Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: 28615 diff changeset	480 [2,1] = bar
aae9d7f098bd Support for RapidJSON 1.1.0 with jsonencode and jsondecode Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: 28615 diff changeset	481 @}
28615 5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	482
28624 aae9d7f098bd Support for RapidJSON 1.1.0 with jsonencode and jsondecode Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: 28615 diff changeset	483 @}
28615 5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	484 @end group
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	485
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	486 @group
28750 80857685105b Code review for jsonencode/jsondecode functions. Rik <rik@octave.org> parents: 28626 diff changeset	487 jsondecode ('@{"nu#m#ber": 7, "s#tr#ing": "hi"@}', ...
80857685105b Code review for jsonencode/jsondecode functions. Rik <rik@octave.org> parents: 28626 diff changeset	488 'ReplacementStyle', 'delete')
28615 5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	489 @result{} scalar structure containing the fields:
28624 aae9d7f098bd Support for RapidJSON 1.1.0 with jsonencode and jsondecode Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: 28615 diff changeset	490
aae9d7f098bd Support for RapidJSON 1.1.0 with jsonencode and jsondecode Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: 28615 diff changeset	491 number = 7
aae9d7f098bd Support for RapidJSON 1.1.0 with jsonencode and jsondecode Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: 28615 diff changeset	492 string = hi
28615 5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	493 @end group
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	494
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	495 @group
28624 aae9d7f098bd Support for RapidJSON 1.1.0 with jsonencode and jsondecode Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: 28615 diff changeset	496 jsondecode ('@{"1": "one", "2": "two"@}', 'Prefix', 'm_')
28615 5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	497 @result{} scalar structure containing the fields:
28624 aae9d7f098bd Support for RapidJSON 1.1.0 with jsonencode and jsondecode Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: 28615 diff changeset	498
aae9d7f098bd Support for RapidJSON 1.1.0 with jsonencode and jsondecode Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: 28615 diff changeset	499 m_1 = one
aae9d7f098bd Support for RapidJSON 1.1.0 with jsonencode and jsondecode Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: 28615 diff changeset	500 m_2 = two
28615 5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	501 @end group
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	502 @end example
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	503
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	504 @seealso{jsonencode, matlab.lang.makeValidName}
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	505 @end deftypefn */)
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	506 {
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	507 #if defined (HAVE_RAPIDJSON)
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	508
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	509 int nargin = args.length ();
28750 80857685105b Code review for jsonencode/jsondecode functions. Rik <rik@octave.org> parents: 28626 diff changeset	510
28624 aae9d7f098bd Support for RapidJSON 1.1.0 with jsonencode and jsondecode Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: 28615 diff changeset	511 // makeValidName options are pairs, the number of arguments must be odd.
28615 5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	512 if (! (nargin % 2))
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	513 print_usage ();
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	514
28750 80857685105b Code review for jsonencode/jsondecode functions. Rik <rik@octave.org> parents: 28626 diff changeset	515 if (! args(0).is_string ())
80857685105b Code review for jsonencode/jsondecode functions. Rik <rik@octave.org> parents: 28626 diff changeset	516 error ("jsondecode: JSON_TXT must be a character string");
28615 5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	517
28750 80857685105b Code review for jsonencode/jsondecode functions. Rik <rik@octave.org> parents: 28626 diff changeset	518 std::string json = args(0).string_value ();
28615 5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	519 rapidjson::Document d;
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	520 // DOM is chosen instead of SAX as SAX publishes events to a handler that
28624 aae9d7f098bd Support for RapidJSON 1.1.0 with jsonencode and jsondecode Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: 28615 diff changeset	521 // decides what to do depending on the event only. This will cause a
aae9d7f098bd Support for RapidJSON 1.1.0 with jsonencode and jsondecode Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: 28615 diff changeset	522 // problem in decoding JSON arrays as the output may be an array or a cell
aae9d7f098bd Support for RapidJSON 1.1.0 with jsonencode and jsondecode Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: 28615 diff changeset	523 // and that doesn't only depend on the event (startArray) but also on the
aae9d7f098bd Support for RapidJSON 1.1.0 with jsonencode and jsondecode Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: 28615 diff changeset	524 // types of the elements inside the array.
28750 80857685105b Code review for jsonencode/jsondecode functions. Rik <rik@octave.org> parents: 28626 diff changeset	525 d.Parse <rapidjson::kParseNanAndInfFlag> (json.c_str ());
28615 5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	526
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	527 if (d.HasParseError ())
28750 80857685105b Code review for jsonencode/jsondecode functions. Rik <rik@octave.org> parents: 28626 diff changeset	528 error ("jsondecode: parse error at offset %u: %s\n",
80857685105b Code review for jsonencode/jsondecode functions. Rik <rik@octave.org> parents: 28626 diff changeset	529 static_cast<unsigned int> (d.GetErrorOffset ()) + 1,
80857685105b Code review for jsonencode/jsondecode functions. Rik <rik@octave.org> parents: 28626 diff changeset	530 rapidjson::GetParseError_En (d.GetParseError ()));
28624 aae9d7f098bd Support for RapidJSON 1.1.0 with jsonencode and jsondecode Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: 28615 diff changeset	531
aae9d7f098bd Support for RapidJSON 1.1.0 with jsonencode and jsondecode Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: 28615 diff changeset	532 return decode (d, args.slice (1, nargin - 1));
28615 5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	533
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	534 #else
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	535
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	536 octave_unused_parameter (args);
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	537
28624 aae9d7f098bd Support for RapidJSON 1.1.0 with jsonencode and jsondecode Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: 28615 diff changeset	538 err_disabled_feature ("jsondecode", "JSON decoding through RapidJSON");
28615 5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	539
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	540 #endif
5da49e37a6c9 New functions jsondecode and jsonencode (bug #53100). Abdallah Elshamy <abdallah.k.elshamy@gmail.com> parents: diff changeset	541 }
28750 80857685105b Code review for jsonencode/jsondecode functions. Rik <rik@octave.org> parents: 28626 diff changeset	542
80857685105b Code review for jsonencode/jsondecode functions. Rik <rik@octave.org> parents: 28626 diff changeset	543 /*
28761 b5461b1dc0ca Review jsonecode/jsondecode BIST tests. Rik <rik@octave.org> parents: 28750 diff changeset	544 Functional BIST tests are located in test/json/jsondecode_BIST.tst
28750 80857685105b Code review for jsonencode/jsondecode functions. Rik <rik@octave.org> parents: 28626 diff changeset	545
80857685105b Code review for jsonencode/jsondecode functions. Rik <rik@octave.org> parents: 28626 diff changeset	546 ## Input validation tests
80857685105b Code review for jsonencode/jsondecode functions. Rik <rik@octave.org> parents: 28626 diff changeset	547 %!testif HAVE_RAPIDJSON
80857685105b Code review for jsonencode/jsondecode functions. Rik <rik@octave.org> parents: 28626 diff changeset	548 %! fail ("jsondecode ()");
80857685105b Code review for jsonencode/jsondecode functions. Rik <rik@octave.org> parents: 28626 diff changeset	549 %! fail ("jsondecode ('1', 2)");
80857685105b Code review for jsonencode/jsondecode functions. Rik <rik@octave.org> parents: 28626 diff changeset	550 %! fail ("jsondecode (1)", "JSON_TXT must be a character string");
80857685105b Code review for jsonencode/jsondecode functions. Rik <rik@octave.org> parents: 28626 diff changeset	551 %! fail ("jsondecode ('12-')", "parse error at offset 3");
80857685105b Code review for jsonencode/jsondecode functions. Rik <rik@octave.org> parents: 28626 diff changeset	552
80857685105b Code review for jsonencode/jsondecode functions. Rik <rik@octave.org> parents: 28626 diff changeset	553 */

Mercurial > octave

annotate libinterp/corefcn/jsondecode.cc @ 28761:b5461b1dc0ca