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

Revision history for Perl extension JSON::XS

        - update documentation here and there, add a large section
          about utf/latin1/ascii flags.
        - extend and clarify the section on incompatibilities
          between YAML and JSON.
        - add =encoding utf-8 to the manpage, now that perl 5.10 supports it.

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