1 Version 2.4 (in development)
2 ============================
8 - Add `json_boolean()` macro that returns the JSON true or false
9 value based on its argument (#86).
11 - Add `json_load_callback()` that calls a callback function
12 repeatedly to read the JSON input (#57).
14 - Add JSON_ESCAPE_SLASH encoding flag to escape all occurences of
19 - Jansson now builds on Windows with Visual Studio 2010, and
20 includes solution and project files in ``win32/vs2010/``
23 - Fix build warnings (#77, #78).
27 - Fix the symbol exports test on Linux/PPC64 (#88).
31 - Fix typos (#73, #84).
41 - Only use ``long long`` if ``strtoll()`` is also available.
45 - Fix the names of library version constants in documentation. (#52)
47 - Change the tutorial to use GitHub API v3. (#65)
51 - Make some tests locale independent. (#51)
53 - Distribute the library exports test in the tarball.
55 - Make test run on shells that don't support the ``export FOO=bar``
66 - `json_unpack()` and friends: Add support for optional object keys
67 with the ``{s?o}`` syntax.
69 - Add `json_object_update_existing()` and
70 `json_object_update_missing()`, for updating only existing keys or
71 only adding missing keys to an object. (#37)
73 - Add `json_object_foreach()` for more convenient iteration over
76 - When decoding JSON, write the number of bytes that were read from
77 input to ``error.position`` also on success. This is handy with
78 ``JSON_DISABLE_EOF_CHECK``.
80 - Add support for decoding any JSON value, not just arrays or
81 objects. The support is enabled with the new ``JSON_DECODE_ANY``
82 flag. Patch by Andrea Marchesini. (#4)
86 - Avoid problems with object's serial number growing too big. (#40,
89 - Decoding functions now return NULL if the first argument is NULL.
90 Patch by Andrea Marchesini.
92 - Include ``jansson_config.h.win32`` in the distribution tarball.
94 - Remove ``+`` and leading zeros from exponents in the encoder.
97 - Make Jansson build and work on MinGW. (#39, #38)
101 - Note that the same JSON values must not be encoded in parallel by
102 separate threads. (#42)
104 - Document MinGW support.
114 - Fix real number encoding and decoding under non-C locales. (#32)
116 - Fix identifier decoding under non-UTF-8 locales. (#35)
118 - `json_load_file()`: Open the input file in binary mode for maximum
123 - Clarify the lifecycle of the result of the ``s`` fromat of
124 `json_unpack()`. (#31)
126 - Add some portability info. (#36)
128 - Little clarifications here and there.
132 - Some style fixes, issues detected by static analyzers.
142 - `json_dump_callback()`: Pass the encoder output to a callback
147 - `json_string_set()`: Check that target is a string and value is
152 - Documentation typo fixes and clarifications.
162 - `json_loadb()`: Decode a string with a given size, useful if the
163 string is not null terminated.
165 - Add ``JSON_ENCODE_ANY`` encoding flag to allow encoding any JSON
166 value. By default, only arrays and objects can be encoded. (#19)
168 - Add ``JSON_REJECT_DUPLICATES`` decoding flag to issue a decoding
169 error if any JSON object in the input contins duplicate keys. (#3)
171 - Add ``JSON_DISABLE_EOF_CHECK`` decoding flag to stop decoding after a
172 valid JSON input. This allows other data after the JSON data.
176 - Fix an additional memory leak when memory allocation fails in
177 `json_object_set()` and friends.
179 - Clear errno before calling `strtod()` for better portability. (#27)
183 - Avoid set-but-not-used warning/error in a test. (#20)
187 - Minor clarifications to documentation.
197 - Replace a few `malloc()` and `free()` calls with their
198 counterparts that support custom memory management.
200 - Fix object key hashing in json_unpack() strict checking mode.
202 - Fix the parentheses in ``JANSSON_VERSION_HEX`` macro.
204 - Fix `json_object_size()` return value.
206 - Fix a few compilation issues.
210 - Enhance portability of `va_copy()`.
212 - Test framework portability enhancements.
216 - Distribute ``doc/upgrading.rst`` with the source tarball.
218 - Build documentation in strict mode in ``make distcheck``.
226 This release is backwards incompatible with the 1.x release series.
227 See the chapter "Upgrading from older versions" in documentation for
230 * Backwards incompatible changes:
232 - Unify unsigned integer usage in the API: All occurences of
233 unsigned int and unsigned long have been replaced with size_t.
235 - Change JSON integer's underlying type to the widest signed integer
236 type available, i.e. long long if it's supported, otherwise long.
237 Add a typedef json_int_t that defines the type.
239 - Change the maximum indentation depth to 31 spaces in encoder. This
240 frees up bits from the flags parameter of encoding functions
241 `json_dumpf()`, `json_dumps()` and `json_dump_file()`.
243 - For future needs, add a flags parameter to all decoding functions
244 `json_loadf()`, `json_loads()` and `json_load_file()`.
248 - `json_pack()`, `json_pack_ex()`, `json_vpack_ex()`: Create JSON
249 values based on a format string.
251 - `json_unpack()`, `json_unpack_ex()`, `json_vunpack_ex()`: Simple
252 value extraction and validation functionality based on a format
255 - Add column, position and source fields to the ``json_error_t``
258 - Enhance error reporting in the decoder.
260 - ``JANSSON_VERSION`` et al.: Preprocessor constants that define the
263 - `json_set_alloc_funcs()`: Set custom memory allocation functions.
265 * Fix many portability issues, especially on Windows.
269 - Add file ``jansson_config.h`` that contains site specific
270 configuration. It's created automatically by the configure script,
271 or can be created by hand if the configure script cannot be used.
272 The file ``jansson_config.h.win32`` can be used without
273 modifications on Windows systems.
275 - Add a section to documentation describing how to build Jansson on
278 - Documentation now requires Sphinx 1.0 or newer.
288 - `json_object_iter_set()`, `json_object_iter_set_new()`: Change
289 object contents while iterating over it.
291 - `json_object_iter_at()`: Return an iterator that points to a
292 specific object item.
294 * New encoding flags:
296 - ``JSON_PRESERVE_ORDER``: Preserve the insertion order of object
301 - Fix an error that occured when an array or object was first
302 encoded as empty, then populated with some data, and then
305 - Fix the situation like above, but when the first encoding resulted
310 - Clarify the documentation on reference stealing, providing an
311 example usage pattern
321 - Fix reference counting on ``true``, ``false`` and ``null``
322 - Estimate real number underflows in decoder with 0.0 instead of
327 - Make ``int32_t`` available on all systems
328 - Support compilers that don't have the ``inline`` keyword
329 - Require Autoconf 2.60 (for ``int32_t``)
333 - Print test names correctly when ``VERBOSE=1``
334 - ``test/suites/api``: Fail when a test fails
335 - Enhance tests for iterators
336 - Enhance tests for decoding texts that contain null bytes
340 - Don't remove ``changes.rst`` in ``make clean``
341 - Add a chapter on RFC conformance
351 - `json_equal()`: Test whether two JSON values are equal
352 - `json_copy()` and `json_deep_copy()`: Make shallow and deep copies
354 - Add a version of all functions taking a string argument that
355 doesn't check for valid UTF-8: `json_string_nocheck()`,
356 `json_string_set_nocheck()`, `json_object_set_nocheck()`,
357 `json_object_set_new_nocheck()`
359 * New encoding flags:
361 - ``JSON_SORT_KEYS``: Sort objects by key
362 - ``JSON_ENSURE_ASCII``: Escape all non-ASCII Unicode characters
363 - ``JSON_COMPACT``: Use a compact representation with all unneeded
368 - Revise and unify whitespace usage in encoder: Add spaces between
369 array and object items, never append newline to output.
370 - Remove const qualifier from the ``json_t`` parameter in
371 `json_string_set()`, `json_integer_set()` and `json_real_set`.
372 - Use ``int32_t`` internally for representing Unicode code points
373 (int is not enough on all platforms)
377 - Convert ``CHANGES`` (this file) to reStructured text and add it to
379 - The test system has been refactored. Python is no longer required
381 - Documentation can now be built by invoking ``make html``
382 - Support for pkg-config
390 * Encode reals correctly, so that first encoding and then decoding a
391 real always produces the same value
392 * Don't export private symbols in ``libjansson.so``
400 * Fix a bug where an error message was not produced if the input file
401 could not be opened in `json_load_file()`
402 * Fix an assertion failure in decoder caused by a minus sign without a
404 * Remove an unneeded include of ``stdint.h`` in ``jansson.h``
412 * All documentation files were not distributed with v1.1; build
413 documentation in make distcheck to prevent this in the future
414 * Fix v1.1 release date in ``CHANGES``
422 * API additions and improvements:
424 - Extend array and object APIs
425 - Add functions to modify integer, real and string values
426 - Improve argument validation
427 - Use unsigned int instead of ``uint32_t`` for encoding flags
429 * Enhance documentation
431 - Add getting started guide and tutorial
433 - General clarifications and cleanup
435 * Check for integer and real overflows and underflows in decoder
436 * Make singleton values thread-safe (``true``, ``false`` and ``null``)
437 * Enhance circular reference handling
438 * Don't define ``-std=c99`` in ``AM_CFLAGS``
439 * Add C++ guards to ``jansson.h``
440 * Minor performance and portability improvements
441 * Expand test coverage
449 * Relax Autoconf version requirement to 2.59
450 * Make Jansson compile on platforms where plain ``char`` is unsigned
451 * Fix API tests for object
459 * Check for integer and real overflows and underflows in decoder
460 * Use the Python json module for tests, or simplejson if the json
462 * Distribute changelog (this file)
470 * Handle EOF correctly in decoder
478 * Fixed broken `json_is_boolean()`