[ViewVC] Annotation of: cvs/JSON-XS/Changes

Revision history for Perl extension JSON::XS

        - implemented and added a json_xs command line utility that can convert
          from/to a number of serialisation formats - tell me if you need more.
        - moved down =encoding directive a bit, too much breaks if its the first
          pod directive :/.

2.1  Wed Mar 19 23:23:18 CET 2008
        - update documentation here and there: add a large section
          about utf8/latin1/ascii flags, add a security consideration
          and extend and clarify the JSON and YAML section.
        - medium speed enhancements when encoding/decoding non-ascii chars.
        - minor speedup in number encoding case.
        - extend and clarify the section on incompatibilities
          between YAML and JSON.
        - switch to static inline from just inline when using gcc.
        - add =encoding utf-8 to the manpage, now that perl 5.10 supports it.
        - fix some issues with UV to JSON conversion of unknown impact.
        - published the yahoo locals search result used in benchmarks as the
          original url changes so comparison is impossible.

2.01 Wed Dec  5 11:40:28 CET 2007
        - INCOMPATIBLE API CHANGE: to_json and from_json have been
          renamed to encode_json/decode_json for JSON.pm compatibility.
          The old functions croak and might be replaced by JSON.pm
          comaptible versions in some later release.

2.0  Tue Dec  4 11:30:46 CET 2007
        - this is supposed to be the first version of JSON::XS
          compatible with version 2.0+ of the JSON module.
          Using the JSON module as frontend to JSON::XS should be
          as fast as using JSON::XS directly, so consider using it
          instead.
        - added get_* methods for all "simple" options.
        - make JSON::XS subclassable.

1.53 Tue Nov 13 23:58:33 CET 2007
        - minor doc clarifications.
        - fixed many doc typos (patch by Thomas L. Shinnick).

1.52 Mon Oct 15 03:22:06 CEST 2007
        - remove =encoding pod directive again, it confuses too many pod
          parsers :/.

1.51 Sat Oct 13 03:55:56 CEST 2007
        - encode empty arrays/hashes in a compact way when pretty is enabled.
        - apparently JSON::XS was used to find some bugs in the
          JSON_checker testsuite, so add (the corrected) JSON_checker tests to
          the testsuite.
        - quite a bit of doc updates/extension.
        - require 5.8.2, as this seems to be the first unicode-stable version.

1.5  Tue Aug 28 04:05:38 CEST 2007
        - add support for tied hashes, based on ideas and testcase by
          Marcus Holland-Moritz.
        - implemented relaxed parsing mode where some extensions are being
          accepted. generation is still JSON-only.

1.44 Wed Aug 22 01:02:44 CEST 2007
        - very experimental process-emulation support, slowing everything down.
          the horribly broken perl threads are still not supported - YMMV.

1.43 Thu Jul 26 13:26:37 CEST 2007
        - convert big json numbers exclusively consisting of digits to NV
          only when there is no loss of precision, otherwise to string.

1.42 Tue Jul 24 00:51:18 CEST 2007
        - fix a crash caused by not handling missing array elements
          (report and testcase by Jay Kuri).

1.41 Tue Jul 10 18:21:44 CEST 2007
        - fix compilation with NDEBUG (assert side-effect),
          affects convert_blessed only.
        - fix a bug in decode filters calling ENTER; SAVETMPS;
          one time too often.
        - catch a typical error in TO_JSON methods.
        - antique-ised XS.xs again to work with outdated
          C compilers (windows...).

1.4  Mon Jul  2 10:06:30 CEST 2007
        - add convert_blessed setting.
        - encode did not catch all blessed objects, encoding their
          contents in most cases. This has been fixed by introducing
          the allow_blessed setting.
        - added filter_json_object and filter_json_single_key_object
          settings that specify a callback to be called when
          all/specific json objects are encountered.
        - assume that most object keys are simple ascii words and
          optimise this case, penalising the general case. This can
          speed up decoding by 30% in typical cases and gives
          a smaller and faster perl hash.
        - implemented simpleminded, optional resource size checking
          in decode_json.
        - remove objToJson/jsonToObj aliases, as the next version
          of JSON will not have them either.
        - bit the bullet and converted the very simple json object
          into a more complex one.
        - work around a bug where perl wrongly claims an integer
          is not an integer.
        - unbundle JSON::XS::Boolean into own pm file so Storable
          and similar modules can resolve the overloading when thawing.

1.3  Sun Jun 24 01:55:02 CEST 2007
        - make JSON::XS::true and false special overloaded objects
          and return those instead of 1 and 0 for those json atoms
          (JSON::PP compatibility is NOT achieved yet).
        - add JSON::XS::is_bool predicate to test for those special
          values.
        - add a reference to
          http://jpsykes.com/47/practical-csrf-and-json-security.
        - removed require 5.8.8 again, it is just not very expert-friendly.
          Also try to be more compatible with slightly older versions,
          which are not recommended (because they are buggy).

1.24 Mon Jun 11 05:40:49 CEST 2007
        - added informative section on JSON-as-YAML.
        - get rid of some c99-isms again.
        - localise dec->cur in decode_str, speeding up
          string decoding considerably (>15% on my amd64 + gcc).
        - increased SHORT_STRING_LEN to 16kb: stack space is
          usually plenty, and this actually saves memory
          when !shrinking as short strings will fit perfectly.

1.23 Wed Jun  6 20:13:06 CEST 2007
        - greatly improved small integer encoding and decoding speed.
        - implement a number of µ-optimisations.
        - updated benchmarks.

1.22 Thu May 24 00:07:25 CEST 2007
        - require 5.8.8 explicitly as older perls do not seem to offer
          the required macros.
        - possibly made it compile on so-called C compilers by microsoft.

1.21 Wed May  9 18:40:32 CEST 2007
        - character offset reported for trailing garbage was random.

1.2  Wed May  9 18:35:01 CEST 2007
        - decode did not work with magical scalars (doh!).
        - added latin1 flag to produce JSON texts in the latin1 subset
          of unicode.
        - flag trailing garbage as error.
        - new decode_prefix method that returns the number
          of characters consumed by a decode.
        - max octets/char in perls UTF-X is actually 13, not 11,
          as pointed out by Glenn Linderman.
        - fixed typoe reported by YAMASHINA Hio.

1.11 Mon Apr  9 07:05:49 CEST 2007
        - properly 0-terminate sv's returned by encode to help
          C libraries that expect that 0 to be there.
        - partially "port" JSON from C to microsofts fucking broken
          pseudo-C. They should be burned to the ground for pissing
          on standards. And I should be stoned for even trying to
          support this filthy excuse for a c compiler.

1.1  Wed Apr  4 01:45:00 CEST 2007
        - clarify documentation (pointed out by Quinn Weaver).
        - decode_utf8 sometimes did not correctly flag errors,
          leading to segfaults.
        - further reduced default nesting depth to 512 due to the test
          failure by that anonymous "chris" whose e-mail address seems
          to be impossible to get. Tests on other freebsd systems indicate
          that this is likely a problem in his/her configuration and not this
          module.
        - renamed json => JSON in error messages.
        - corrected the character offset in some error messages.

1.01 Sat Mar 31 16:15:40 CEST 2007
        - do not segfault when from_json/decode gets passed
          a non-string object (reported by Florian Ragwitz).
          This has no effect on normal operation.

1.0  Thu Mar 29 04:43:34 CEST 2007
        - the long awaited (by me) 1.0 version.
        - add \0 (JSON::XS::false) and \1 (JSON::XS::true) mappings to JSON
          true and false.
        - add some more notes to shrink, as suggested by Alex Efros.
        - improve testsuite.
        - halve the default nesting depth limit, to hopefully make it
          work on Freebsd (unfortunately, the cpan tester did not
          send me his report, so I cannot ask about the stack limit on fbsd).

0.8  Mon Mar 26 00:10:48 CEST 2007
        - fix a memleak when decoding hashes.
        - export jsonToBj and objToJson as aliases
          to to_json and from_json, to reduce incompatibilities
          between JSON/JSON::PC and JSON::XS. (experimental).
        - implement a maximum nesting depth for both en- and de-coding.
        - added a security considerations sections.

0.7  Sun Mar 25 01:46:30 CET 2007
        - code cleanup.
        - fix a memory overflow bug when indenting.
        - pretty-printing now up to 15% faster.
        - improve decoding speed of strings by
          up to 50% by specialcasing short strings.
        - further decoding speedups for strings using
          lots of \u escapes.
        - improve utf8 decoding speed for U+80 .. U+7FF.

0.5  Sat Mar 24 20:41:51 CET 2007
        - added the UTF-16 encoding example hinted at in previous
          versions.
        - minor documentation fixes.
        - fix a bug in and optimise canonicalising fastpath
          (reported by Craig Manley).
        - remove a subtest that breaks with bleadperl (reported
          by Andreas König).

0.31 Sat Mar 24 02:14:34 CET 2007
        - documentation updates.
        - do some casting to hopefully fix Andreas' problem.
        - nuke bogus json rpc stuff.

0.3  Fri Mar 23 19:33:21 CET 2007
        - remove spurious PApp::Util reference (John McNamara).
        - adapted lots of tests from other json modules
          (idea by Chris Carline).
        - documented mapping from json to perl and vice versa.
        - improved the documentation by adding more examples.
        - added short escaping forms, reducing the created
          json texts a bit.
        - added shrink flag.
        - when flag methods are called without enable argument
          they will by default enable their flag.
        - considerably improved string encoding speed (at least
          with gcc 4).
        - added a test that covers lots of different characters.
        - clarified some error messages.
        - error messages now use correct character offset
          with F_UTF8.
        - improve the "no bytes" and "no warnings" hacks in
          case the called functions do... stuff.
        - croak when encoding to ascii and an out-of-range
          (non-unicode) codepoint is encountered.

0.2  Fri Mar 23 00:23:34 CET 2007
        - the "could not sleep without debuggign release".
          it should basically work now, with many bugs as
          no production tests have been run yet.
        - added more testcases.
        - the expected shitload of bugfixes.
        - handle utf8 flag correctly in decode.
        - fix segfault in decoder.
        - utf8n_to_uvuni sets retlen to -1, but retlen is an
          unsigned types (argh).
        - fix decoding of utf-8 strings.
        - improved error diagnostics.
        - fix decoding of 'null'.
        - fix parsing of empty array/hashes
        - silence warnings when we prepare the croak message.

0.1   Thu Mar 22 22:13:43 CET 2007
        - first release, very untested, basically just to claim
          the namespace.
 
0.01  Thu Mar 22 06:08:12 CET 2007
        - original version; cloned from Convert-Scalar

Revision:	1.103
Committed:	Sat Mar 22 22:21:32 2008 UTC (16 years, 2 months ago) by root
Branch:	MAIN
Changes since 1.102:	+2 -0 lines
Log Message:	* empty log message *
#	User	Rev	Content
1	root	1.1	Revision history for Perl extension JSON::XS
2	root	1.2
3	root	1.103	- implemented and added a json_xs command line utility that can convert
4			from/to a number of serialisation formats - tell me if you need more.
5	root	1.102	- moved down =encoding directive a bit, too much breaks if its the first
6			pod directive :/.
7
8	root	1.101	2.1 Wed Mar 19 23:23:18 CET 2008
9			- update documentation here and there: add a large section
10			about utf8/latin1/ascii flags, add a security consideration
11			and extend and clarify the JSON and YAML section.
12	root	1.98	- medium speed enhancements when encoding/decoding non-ascii chars.
13	root	1.100	- minor speedup in number encoding case.
14	root	1.92	- extend and clarify the section on incompatibilities
15			between YAML and JSON.
16	root	1.95	- switch to static inline from just inline when using gcc.
17	root	1.94	- add =encoding utf-8 to the manpage, now that perl 5.10 supports it.
18	root	1.100	- fix some issues with UV to JSON conversion of unknown impact.
19	root	1.99	- published the yahoo locals search result used in benchmarks as the
20			original url changes so comparison is impossible.
21	root	1.92
22	root	1.91	2.01 Wed Dec 5 11:40:28 CET 2007
23			- INCOMPATIBLE API CHANGE: to_json and from_json have been
24			renamed to encode_json/decode_json for JSON.pm compatibility.
25			The old functions croak and might be replaced by JSON.pm
26			comaptible versions in some later release.
27
28	root	1.90	2.0 Tue Dec 4 11:30:46 CET 2007
29			- this is supposed to be the first version of JSON::XS
30			compatible with version 2.0+ of the JSON module.
31			Using the JSON module as frontend to JSON::XS should be
32			as fast as using JSON::XS directly, so consider using it
33			instead.
34	root	1.88	- added get_* methods for all "simple" options.
35	root	1.89	- make JSON::XS subclassable.
36	root	1.88
37	root	1.86	1.53 Tue Nov 13 23:58:33 CET 2007
38	root	1.85	- minor doc clarifications.
39			- fixed many doc typos (patch by Thomas L. Shinnick).
40
41	root	1.84	1.52 Mon Oct 15 03:22:06 CEST 2007
42	root	1.83	- remove =encoding pod directive again, it confuses too many pod
43			parsers :/.
44
45	root	1.82	1.51 Sat Oct 13 03:55:56 CEST 2007
46	root	1.81	- encode empty arrays/hashes in a compact way when pretty is enabled.
47	root	1.87	- apparently JSON::XS was used to find some bugs in the
48	root	1.80	JSON_checker testsuite, so add (the corrected) JSON_checker tests to
49			the testsuite.
50			- quite a bit of doc updates/extension.
51	root	1.79	- require 5.8.2, as this seems to be the first unicode-stable version.
52	root	1.78
53	root	1.77	1.5 Tue Aug 28 04:05:38 CEST 2007
54	root	1.74	- add support for tied hashes, based on ideas and testcase by
55			Marcus Holland-Moritz.
56	root	1.75	- implemented relaxed parsing mode where some extensions are being
57			accepted. generation is still JSON-only.
58	root	1.74
59			1.44 Wed Aug 22 01:02:44 CEST 2007
60	root	1.73	- very experimental process-emulation support, slowing everything down.
61			the horribly broken perl threads are still not supported - YMMV.
62
63	root	1.72	1.43 Thu Jul 26 13:26:37 CEST 2007
64			- convert big json numbers exclusively consisting of digits to NV
65			only when there is no loss of precision, otherwise to string.
66
67	root	1.71	1.42 Tue Jul 24 00:51:18 CEST 2007
68			- fix a crash caused by not handling missing array elements
69			(report and testcase by Jay Kuri).
70
71	root	1.70	1.41 Tue Jul 10 18:21:44 CEST 2007
72			- fix compilation with NDEBUG (assert side-effect),
73			affects convert_blessed only.
74	root	1.69	- fix a bug in decode filters calling ENTER; SAVETMPS;
75			one time too often.
76	root	1.70	- catch a typical error in TO_JSON methods.
77	root	1.69	- antique-ised XS.xs again to work with outdated
78			C compilers (windows...).
79
80	root	1.68	1.4 Mon Jul 2 10:06:30 CEST 2007
81	root	1.63	- add convert_blessed setting.
82	root	1.56	- encode did not catch all blessed objects, encoding their
83			contents in most cases. This has been fixed by introducing
84			the allow_blessed setting.
85	root	1.65	- added filter_json_object and filter_json_single_key_object
86			settings that specify a callback to be called when
87	root	1.67	all/specific json objects are encountered.
88	root	1.59	- assume that most object keys are simple ascii words and
89			optimise this case, penalising the general case. This can
90			speed up decoding by 30% in typical cases and gives
91			a smaller and faster perl hash.
92	root	1.58	- implemented simpleminded, optional resource size checking
93			in decode_json.
94	root	1.61	- remove objToJson/jsonToObj aliases, as the next version
95			of JSON will not have them either.
96	root	1.62	- bit the bullet and converted the very simple json object
97			into a more complex one.
98	root	1.64	- work around a bug where perl wrongly claims an integer
99			is not an integer.
100	root	1.65	- unbundle JSON::XS::Boolean into own pm file so Storable
101			and similar modules can resolve the overloading when thawing.
102	root	1.56
103	root	1.55	1.3 Sun Jun 24 01:55:02 CEST 2007
104	root	1.54	- make JSON::XS::true and false special overloaded objects
105			and return those instead of 1 and 0 for those json atoms
106			(JSON::PP compatibility is NOT achieved yet).
107			- add JSON::XS::is_bool predicate to test for those special
108			values.
109	root	1.52	- add a reference to
110			http://jpsykes.com/47/practical-csrf-and-json-security.
111	root	1.60	- removed require 5.8.8 again, it is just not very expert-friendly.
112			Also try to be more compatible with slightly older versions,
113	root	1.54	which are not recommended (because they are buggy).
114	root	1.52
115	root	1.51	1.24 Mon Jun 11 05:40:49 CEST 2007
116	root	1.49	- added informative section on JSON-as-YAML.
117	root	1.51	- get rid of some c99-isms again.
118	root	1.50	- localise dec->cur in decode_str, speeding up
119			string decoding considerably (>15% on my amd64 + gcc).
120			- increased SHORT_STRING_LEN to 16kb: stack space is
121			usually plenty, and this actually saves memory
122	root	1.51	when !shrinking as short strings will fit perfectly.
123	root	1.49
124	root	1.47	1.23 Wed Jun 6 20:13:06 CEST 2007
125	root	1.46	- greatly improved small integer encoding and decoding speed.
126			- implement a number of µ-optimisations.
127	root	1.47	- updated benchmarks.
128	root	1.46
129	root	1.45	1.22 Thu May 24 00:07:25 CEST 2007
130	root	1.42	- require 5.8.8 explicitly as older perls do not seem to offer
131			the required macros.
132	root	1.43	- possibly made it compile on so-called C compilers by microsoft.
133	root	1.42
134	root	1.41	1.21 Wed May 9 18:40:32 CEST 2007
135	root	1.47	- character offset reported for trailing garbage was random.
136	root	1.41
137	root	1.40	1.2 Wed May 9 18:35:01 CEST 2007
138			- decode did not work with magical scalars (doh!).
139	root	1.38	- added latin1 flag to produce JSON texts in the latin1 subset
140			of unicode.
141	root	1.39	- flag trailing garbage as error.
142			- new decode_prefix method that returns the number
143			of characters consumed by a decode.
144	root	1.40	- max octets/char in perls UTF-X is actually 13, not 11,
145			as pointed out by Glenn Linderman.
146			- fixed typoe reported by YAMASHINA Hio.
147	root	1.34
148	root	1.32	1.11 Mon Apr 9 07:05:49 CEST 2007
149			- properly 0-terminate sv's returned by encode to help
150			C libraries that expect that 0 to be there.
151	root	1.31	- partially "port" JSON from C to microsofts fucking broken
152			pseudo-C. They should be burned to the ground for pissing
153			on standards. And I should be stoned for even trying to
154	root	1.32	support this filthy excuse for a c compiler.
155	root	1.6
156	root	1.30	1.1 Wed Apr 4 01:45:00 CEST 2007
157	root	1.28	- clarify documentation (pointed out by Quinn Weaver).
158	root	1.29	- decode_utf8 sometimes did not correctly flag errors,
159			leading to segfaults.
160	root	1.30	- further reduced default nesting depth to 512 due to the test
161			failure by that anonymous "chris" whose e-mail address seems
162			to be impossible to get. Tests on other freebsd systems indicate
163			that this is likely a problem in his/her configuration and not this
164			module.
165			- renamed json => JSON in error messages.
166			- corrected the character offset in some error messages.
167	root	1.28
168	root	1.27	1.01 Sat Mar 31 16:15:40 CEST 2007
169			- do not segfault when from_json/decode gets passed
170			a non-string object (reported by Florian Ragwitz).
171			This has no effect on normal operation.
172
173	root	1.25	1.0 Thu Mar 29 04:43:34 CEST 2007
174			- the long awaited (by me) 1.0 version.
175			- add \0 (JSON::XS::false) and \1 (JSON::XS::true) mappings to JSON
176			true and false.
177	root	1.24	- add some more notes to shrink, as suggested by Alex Efros.
178	root	1.25	- improve testsuite.
179	root	1.26	- halve the default nesting depth limit, to hopefully make it
180	root	1.25	work on Freebsd (unfortunately, the cpan tester did not
181			send me his report, so I cannot ask about the stack limit on fbsd).
182	root	1.24
183	root	1.23	0.8 Mon Mar 26 00:10:48 CEST 2007
184	root	1.21	- fix a memleak when decoding hashes.
185	root	1.20	- export jsonToBj and objToJson as aliases
186			to to_json and from_json, to reduce incompatibilities
187			between JSON/JSON::PC and JSON::XS. (experimental).
188	root	1.21	- implement a maximum nesting depth for both en- and de-coding.
189			- added a security considerations sections.
190	root	1.20
191	root	1.19	0.7 Sun Mar 25 01:46:30 CET 2007
192	root	1.16	- code cleanup.
193			- fix a memory overflow bug when indenting.
194			- pretty-printing now up to 15% faster.
195			- improve decoding speed of strings by
196			up to 50% by specialcasing short strings.
197			- further decoding speedups for strings using
198			lots of \u escapes.
199	root	1.17	- improve utf8 decoding speed for U+80 .. U+7FF.
200	root	1.16
201	root	1.15	0.5 Sat Mar 24 20:41:51 CET 2007
202	root	1.14	- added the UTF-16 encoding example hinted at in previous
203			versions.
204			- minor documentation fixes.
205	root	1.15	- fix a bug in and optimise canonicalising fastpath
206			(reported by Craig Manley).
207			- remove a subtest that breaks with bleadperl (reported
208			by Andreas König).
209	root	1.14
210	root	1.13	0.31 Sat Mar 24 02:14:34 CET 2007
211	root	1.12	- documentation updates.
212	root	1.13	- do some casting to hopefully fix Andreas' problem.
213			- nuke bogus json rpc stuff.
214	root	1.12
215	root	1.11	0.3 Fri Mar 23 19:33:21 CET 2007
216	root	1.5	- remove spurious PApp::Util reference (John McNamara).
217			- adapted lots of tests from other json modules
218			(idea by Chris Carline).
219	root	1.9	- documented mapping from json to perl and vice versa.
220	root	1.11	- improved the documentation by adding more examples.
221	root	1.5	- added short escaping forms, reducing the created
222			json texts a bit.
223			- added shrink flag.
224			- when flag methods are called without enable argument
225			they will by default enable their flag.
226			- considerably improved string encoding speed (at least
227			with gcc 4).
228	root	1.7	- added a test that covers lots of different characters.
229			- clarified some error messages.
230			- error messages now use correct character offset
231			with F_UTF8.
232	root	1.8	- improve the "no bytes" and "no warnings" hacks in
233			case the called functions do... stuff.
234	root	1.9	- croak when encoding to ascii and an out-of-range
235			(non-unicode) codepoint is encountered.
236	root	1.4
237	root	1.3	0.2 Fri Mar 23 00:23:34 CET 2007
238			- the "could not sleep without debuggign release".
239			it should basically work now, with many bugs as
240			no production tests have been run yet.
241			- added more testcases.
242			- the expected shitload of bugfixes.
243			- handle utf8 flag correctly in decode.
244			- fix segfault in decoder.
245			- utf8n_to_uvuni sets retlen to -1, but retlen is an
246			unsigned types (argh).
247			- fix decoding of utf-8 strings.
248			- improved error diagnostics.
249			- fix decoding of 'null'.
250			- fix parsing of empty array/hashes
251			- silence warnings when we prepare the croak message.
252
253	root	1.2	0.1 Thu Mar 22 22:13:43 CET 2007
254			- first release, very untested, basically just to claim
255			the namespace.
256	root	1.1
257			0.01 Thu Mar 22 06:08:12 CET 2007
258			- original version; cloned from Convert-Scalar
259