Revert, don't use strdup.
[libidn.git] / NEWS
blob852d64917a18e63e0e7183914a7f9cf0423c4430
1 Libidn NEWS -- History of user-visible changes.                 -*- outline -*-
2 Copyright (C) 2002, 2003, 2004 Simon Josefsson
3 See the end for copying conditions.
5 * Version 0.5.6 (unreleased)
7 ** Now using GNULib for portability code.
8 This means the code now use strdup, which improve readability.  See
9 <http://www.gnu.org/software/gnulib/> for more information on GNULib.
11 ** Added functions to convert return codes to human readable text.
13 ** API and ABI is backwards compatible with the previous version.
14 idna_strerror: ADD.
15 pr29_strerror: ADD.
16 punycode_strerror: ADD.
17 stringprep_strerror: ADD.
18 tld_strerror: ADD.
19 TLD_NO_TLD: ADD.  Replaces TLD_NOTLD.
20 TLD_NOTLD: DEPRECATED.  Use TLD_NO_TLD instead.
22 * Version 0.5.5 (released 2004-09-13)
24 ** Hide accidentally exported variable g_utf8_skip, by marking it as static.
26 ** Various fixes.
28 ** API and ABI is backwards compatible with the previous version.
29 g_utf8_skip: REMOVED.  (But never meant to be used.)
31 * Version 0.5.4 (released 2004-08-08)
33 ** Translation updates.
35 ** API and ABI is backwards compatible with the previous version.
37 * Version 0.5.3 (released 2004-08-05)
39 ** Fix crash in `idn --tld' command line tool.
41 ** API and ABI is backwards compatible with the previous version.
43 * Version 0.5.2 (released 2004-07-14)
45 ** Java "make install" rules are now DESTDIR compatible.
47 ** API and ABI is backwards compatible with the previous version.
49 * Version 0.5.1 (released 2004-07-09)
51 ** Cross compile builds should work.
52 It should work for any sane cross compile target, but the only tested
53 platform is uClibc/uClinux on Motorola Coldfire.
55 ** The example programs now correctly invoke `setlocale (LC_ALL, "")'.
57 ** API and ABI is backwards compatible with the previous version.
59 * Version 0.5.0 (released 2004-06-26)
61 ** Functions to detect "normalization problem sequences" as per PR-29 added.
62 See the new chapter "PR29 Functions" in the manual
63 (doc/libidn.{ps,pdf,html}) for more information and the background
64 story.  An external link that discuss the problem is
65 <http://www.unicode.org/review/pr-29.html>.
67 ** More translations.
68 Added Esperanto (by Edmund GRIMLEY EVANS).
70 ** API and ABI is backwards compatible with the previous version.
71 pr29.h: ADD.  Prototypes for PR29 types and functions.
72 pr29_4, pr29_4z, pr29_8z: ADD.  New API entry points for PR29 functions.
73 Pr29_rc: ADD.  New error code enum type for PR29 functions.
75 * Version 0.4.9 (released 2004-06-11)
77 ** The Java library (java/libidn-*.jar) is included in the distribution.
79 ** JavaDoc manuals (doc/javadoc/) are included.
81 ** API and ABI is backwards compatible with the previous version.
83 * Version 0.4.8 (released 2004-06-01)
85 ** The Java source code is actually included in the distribution.
87 ** API and ABI is backwards compatible with the previous version.
89 * Version 0.4.7 (released 2004-05-31)
91 ** The Java port should now be functional, contributed by Oliver Hitz.
92 See the new section "Java API" in the manual for more information.
94 ** API and ABI is backwards compatible with the previous version.
96 * Version 0.4.6 (released 2004-05-24)
98 ** The header file idn-free.h is actually installed by 'make install'.
100 ** API and ABI is backwards compatible with the previous version.
102 * Version 0.4.5 (released 2004-05-21)
104 ** In IDNA ToUnicode, a `free' on a stale pointer fixed by Ulrich Drepper.
106 ** Several memory leaks fixed by Ulrich Drepper.
108 ** Added more SASLPrep and NFKC test vectors.
110 ** Automake 1.8.4 is used.
112 ** API and ABI is backwards compatible with the previous version.
113 idn_free: ADD.  Wrapper around system `free'.
114 idn-free.h: ADD.  Prototype for `idn_free'.
115                 See idn-free.h for discussion.  The interface is
116                 currently not documented.  Comments and feedback is
117                 appreciated.
119 * Version 0.4.4 (released 2004-04-29)
121 ** Fixed two bugs in iSCSI definition, syncing with newly published RFC 3722.
122 The first bug was an omission of prohibiting the characters in C.1.1,
123 C.1.2 and C.7 (space characters and characters that are inappropriate
124 for canonical representation).  The second was a bug in the definition
125 of the table, causing the entire table to be skipped, of the special
126 prohibited output character table defined in RFC 3722 (see section 6,
127 the characters in the table are various ASCII characters and U+3002).
129 ** A few test vectors for iSCSI were added.
131 ** The self tests are linked with libtool -no-install to avoid wrapper script.
133 ** Separated self test utilities into a separate library, shared by all tests.
135 ** More translations.
136 Added Romanian (by Laurentiu Buzdugan).
138 ** API and ABI is backwards compatible with the previous version.
140 * Version 0.4.3 (released 2004-04-22)
142 ** Fixed a bug in table processing code to prohibit control characters.
143 The problem was that the code used a code point of 0 to indicate end
144 of table, but if (as for table C.2.1) a range starts with 0, this
145 logic would fail.  The end-of-table test is now that both the start
146 and end code points of the range is 0.  Table C.2.1 is responsible for
147 prohibiting non-ASCII control characters, i.e. ASCII 0-31 and 127.
148 Before, libidn silently accepted such strings without complaining.
150 ** A few test vectors for SASLprep were added.
152 ** The pkg-config script no longer include a -R parameter.
154 ** More translations.
155 Added Dutch (by Elros Cyriatan), and German (by Roland Illig).
157 ** API and ABI is backwards compatible with the previous version.
159 * Version 0.4.2 (released 2004-03-20)
161 ** A Punycode implementation in Java was added, by Oliver Hitz.
162 Eventually hopefully a StringPrep, Nameprep and IDNA implementation
163 will be added as well.  Currently you need to specify --enable-java to
164 enable the Java interface.  The Java sources (below java/) are
165 compiled into byte-code (not native code) into a JAR library.
167 ** More translations.
168 Added Danish (by Morten Bo Johansen), French (by Michel Robitaille),
169 Polish (by Jakub Bogusz), and Serbian (by Aleksandar Jelenak).
171 ** Norwegian TLD table added, by Thomas Jacob.
173 ** API and ABI is backwards compatible with the previous version.
175 * Version 0.4.1 (released 2004-03-08)
177 ** The user messages from the command line utility are now translated.
178 Currently English and Swedish is supported.
180 ** Logic of stringprep_locale_charset modified.
181 Future versions will use, in order, $CHARSET iff defined, nl_langinfo
182 (CODESET) iff working, or fall back to returning "ASCII".  Earlier it
183 attempted to guess the system locale, in contrast with the current
184 application's locale, via some setlocale save/set/reset magic.  This
185 change may require you to invoke setlocale() in your application,
186 which is (should be) required for non-ASCII to work anyway.  Based on
187 discussion with Ulrich Drepper.
189 ** The command-line utility now invoke setlocale (LC_ALL, "") at startup.
191 ** Fixed SASLprep tables to prohibit non-ASCII space in output.
192 Non-ASCII space has always been mapped to ASCII space, so it is not
193 clear this really have any effect, but the specification require it.
195 ** Building Libidn as part of GLIBC has been updated.
196 Refer to libc/README for more information.  Incidentally, GLIBC in CVS
197 now include a copy of Libidn.
199 ** API and ABI is backwards compatible with the previous version.
200 IDNA_DLOPEN_ERROR: ADD.  Only used internally by Libidn in libc.
202 * Version 0.4.0 (released 2004-02-28)
204 ** Support for TLD restrictions on IDN strings, contributed by Thomas Jacob.
205 Many TLDs restrict the set of characters that can be used, from the
206 full Unicode 3.2 range that is normally available.  This contribution
207 make it possible for you to test strings for TLD conformance locally.
208 The code can be disabled by --disable-tld.  If enabled (the default),
209 the new API "tld.h" is installed which can be used to check a string
210 for conformance to TLD specific rules.  This add a new self test, and
211 a new chapter in the manual.  People responsible for maintaining TLD
212 tables are hereby encouraged to contribute them (under reasonable
213 licensing terms) for inclusion in future versions of Libidn.  Be
214 warned that the API for TLD checking may change throughout the 0.4.x
215 series as we get feedback on it.
217 ** Kerberos 5 stringprep profile macro is no longer documented.
218 The macro itself will probably be removed in the future, if the
219 specification is dropped from the Kerberos WG agenda.
221 ** API and ABI is backwards compatible with the previous version.
222 stringprep_kerberos5: DEPRECATED.
223 Tld_table_element:
224 Tld_table:
225 Tld_rc: ADD.  New data types.
226 tld_get_4:
227 tld_get_4z:
228 tld_get_z: ADD.  New functions to extract TLD from string.
229 tld_get_table:
230 tld_default_table: ADD.  New functions to get TLD table from TLD name.
231 tld_check_4t:
232 tld_check_4tz: ADD.  New function to provide core TLD operations.
233 tld_check_4:
234 tld_check_4z:
235 tld_check_8z:
236 tld_check_lz: ADD.  New functions that combine all TLD operations in one call.
238 * Version 0.3.7 (released 2004-01-22)
240 ** The command line parameter '--' idiom is documented.
242 ** The iSCSI stringprep profile now recognized as "iSCSI".
243 The earlier name "ISCSIprep" is still recognized, for backwards
244 compatibility.
246 ** DocBook manuals no longer included (the tools are too unstable).
248 ** API and ABI is backwards compatible with the previous version.
250 * Version 0.3.6 (released 2004-01-06)
252 ** The manual now contain a troubleshooting section for the command line tool.
254 ** The PHP interface pass the string directly on the command line.
256 ** The macro that create 'idn-int.h' has been updated to latest version.
258 ** API and ABI is backwards compatible with the previous version.
260 * Version 0.3.5 (released 2003-12-15)
262 ** The program 'idn' accepts input strings directly on the command line.
264 ** The program 'idn' defaults to --idna-to-ascii if no parameter is given.
266 ** The program 'idn' now print user instructions before waiting for input.
268 ** DocBook HTML output not included any longer.
269 The reason is that the filenames generated by docbook2html appear to
270 be rather random, so it is difficult to maintain the Makefile.am rules
271 for them.
273 ** Autoconf 2.59, automake 1.8 and libtool from CVS is used.
275 ** API and ABI is backwards compatible with the previous version.
276 IDNA_CONTAINS_NON_LDH: ADD.  Same integer value as IDNA_CONTAINS_LDH.
277 IDNA_CONTAINS_LDH: DEPRECATED.  LDH (letter-digits-hyphens) characters
278                 are not an error, but non-LDH characters are, when
279                 IDNA_USE_STD3_ASCII_RULES is used.  The logic of the
280                 mnemonic name of this error constant was reversed.
282 * Version 0.3.4 (released 2003-11-09)
284 ** DocBook manuals in XML, PDF, PostScript, ASCII and HTML formats included.
286 * Version 0.3.3 (released 2003-10-18)
288 ** Fixed list of Stringprep profiles in 'idn --help' and 'idn.php'.
290 ** Fixed debug information in 'idn'.
292 ** Internal improvements.
293 Leads to reduced heap memory usage.  Simplified inter-dependency among
294 files in lib/* to make it easier to copy them into your project.
296 ** Debugging stringprep profile 'generic' removed.
298 ** Punycode implementation updated to rfc3492bis-00.
300 ** API and ABI is backwards compatible with the previous version.
301 stringprep_4i: NEW.
302 stringprep_4zi: NEW.
303 stringprep: CHANGED. 'profile' is marked as 'const'.
304 stringprep_profile: CHANGED. 'profile' is marked as 'const'.
305 stringprep_generic: REMOVED. Never meant for public use.
307 * Version 0.3.2 (released 2003-10-07)
309 ** SASL ANONYMOUS stringprep profile "trace" added.
310 It is equivalent to the already supported "plain" SASL ANONYMOUS
311 stringprep profile, except for the name.
313 ** API and ABI is backwards compatible with the previous version.
314 The 'in' parameter to stringprep_profile was changed from 'char*' to
315 'const char*'.
317 * Version 0.3.1 (released 2003-10-02)
319 ** Fixed handling of implicit and explicit zero-length root labels in ToASCII.
321 ** Fixed support for Hangul Syllables during Unicode NFKC normalization.
323 ** Fixed Unicode NFKC normalization of (some) BMP code points.
324 This was done by syncing the NFKC code with latest GLIB, and may have
325 fixed other bugs in the earlier versions of the updated functions.
327 ** Added more IDNA test vectors.
329 ** Emacs Lisp IDNA implementation now set the UseSTD3ASCIIRules flag.
330 This is the appropriate setting for mail-related uses of IDNA.
332 ** API and ABI is backwards compatible with the previous version.
334 * Version 0.3.0 (released 2003-09-23)
336 ** Ported to Mac OS X.
338 ** Gnulib code removed, we now assume a C89 compatible environment.
340 ** Building libidn as a libc add-on now works again.
342 ** Man pages for all public API functions are included.
344 ** Fixed bug in SASLprep profile.
346 ** API and ABI is NOT backwards compatible with the previous version.
347 All previously labeled (since 0.1.x) obsolete functions have been dropped.
348 The use of 'enum' types instead of 'int' added in 0.2.3 reverted, it
349 confused documentation generators and wasn't all that common practice.
351 * Version 0.2.3 (released 2003-08-26)
353 ** Example 4 was the same as example 3, now changed to demo ToUnicode.
355 ** Documentation improvements.
357 ** Prototype cleanups.
358 The proper enum types (Stringprep_rc, Idna_rc, etc) are now used in
359 several places where plain int where used before.  String lengths are
360 handled by (s)size_t instead of int.
362 ** API and ABI is backwards compatible with the previous version.
364 * Version 0.2.2 (released 2003-08-13)
366 ** Fixed problem with strings longer than 4GB in punycode functions.
367 The punycode code cannot handle strings longer than 4GB.  The code now
368 return PUNYCODE_BAD_INPUT on too long input, instead of failing in an
369 unknown way.
371 ** The "idn --idna-to-unicode" command now output locale encoded strings.
373 ** Build fixes, bug fixes.
375 ** API and ABI is backwards compatible with the previous version.
377 * Version 0.2.1 (released 2003-07-04)
379 ** Don't reject zero-length trailing labels as in, e.g., "www.example.org.".
380 The IDNA RFC is not clear on this topic, zero-length labels in general
381 are forbidden by the ToASCII algorithm in section 4.1 step 8, but the
382 terminology section define, inside a parenthesis, that the zero-length
383 root label is in fact not considered a label at all in IDNA.
385 ** Bug fixes.
387 ** API and ABI is backwards compatible with the previous version.
389 * Version 0.2.0 (released 2003-06-19)
391 ** Unicode code point data is now uint32_t, defined in "idn-int.h".
392 A header file "idn-int.h" is generated and installed to make sure the
393 "uint32_t" data type is available on all platforms.  The reason for
394 this change is that on 64-bit platforms, the application was required
395 to convert 32 bit integers (which is how Unicode code points are
396 typically represented) into 64 bit integers before calling libidn
397 functions.
399 ** New idna_*() functions have improved flags handling.
400 The allowunassigned and usestd3asciirules parameters were collapsed
401 into a flags parameter, that can take on the IDNA_ALLOW_UNASSIGNED and
402 IDNA_USE_STD3_ASCII_RULES values.  This allows for easier extensions
403 to support, e.g., Unicode 4.0 or RFC 952 ASCII rules checking.  Note
404 that the old entry points are unmodified (in this regard), and new
405 entry points with this modification were added.
407 ** The manual was moved into a separate directory doc/.
409 ** Bugfixes.
411 ** API and ABI is not backwards compatible.
412 In punycode.h and stringprep.h the "unsigned long" data type was
413 changed into "uint32_t", which cause a API and ABI missmatch.  For
414 idna.h, the old entry points that used "unsigned long" still exist,
415 and new entry points that uses "uint32_t" was added.  To update your
416 application, you probably only need to change "unsigned long" to
417 "uint32_t".  As a result of these changes, the shared object version
418 has been increased.
420 * Version 0.1.15 (released 2003-06-07)
422 ** Bugfixes.
424 ** API and ABI is backwards compatible with the previous version.
426 * Version 0.1.14 (released 2003-05-10)
428 ** Experimental documentation generation in contrib/doxygen/.
429 Simply invoke "doxygen" in that directory and it should build the
430 documentation.
432 ** Lisp API bug fixes.
434 ** API and ABI is backwards compatible with the previous version.
436 * Version 0.1.13 (released 2003-03-13)
438 ** Unfinished Java *.class files implementing the libidn API.
439 See the contrib/java/ directory.  It is implemented using the Java
440 Native Interface, and light initial testing indicate interoperability
441 between GCJ, IBM's JDK and Sun's JDK.
443 ** Building is now silent when gengetopt is not present.
445 ** Bug fixes.
447 ** API and ABI is backwards compatible with the previous version.
449 * Version 0.1.12 (released 2003-03-06)
451 ** Building libidn doesn't require gengetopt.
452 Warnings are still printed though.  Gengetopt will be replaced by argp
453 eventually.
455 ** Command line tool "idn" supports stringprep too.
457 ** New stringprep API entry point: stringprep_profile().
458 It takes a name of the stringprep profile as an argument instead of
459 the stringprep table structure.
461 ** stringprep_*.h are deprecated and will be removed in the future.
462 All symbols have been moved to stringprep.h.  The reasons are that (1)
463 the files typically only defined one CPP macro and exported one symbol
464 definition, which is wasteful as it generates too much work in the
465 manual, and (2) using one header file for all profiles allows easier
466 access to all stringprep profiles during runtime.  Note that the files
467 are still installed, but they only #include stringprep.h now, for
468 backwards compatibility.
470 ** GNU Libc add-on build instructions updated to GNU Libc 2.3.2.
472 ** SASLprep stringprep profile added.
474 ** An online interface to libidn written in PHP added to contrib/web/.
476 ** API and ABI is backwards compatible with the previous version.
478 * Version 0.1.11 (released 2003-02-26)
480 ** Command line application "idn" is included.
481 A simple wrapper around the library that allows you to invoke punycode
482 encoding/decoding and IDNA ToASCII/ToUnicode on the command line.
484 ** Emacs Lisp interface for punycode and IDNA included.
485 See punycode.el and idna.el.
487 ** API and ABI is backwards compatible with the previous version.
489 * Version 0.1.10 (released 2003-02-21)
491 ** idna_*_to_ace() and idna_*ace_to_*() are deprecated in favor of
492 ** idna_to_ascii_from_*() and idna_to_unicode_*_from_*() respectively.
493 The reason was that the old interfaces did not accept the
494 AllowUnassigned and UseSTD3ASCIIRules flags.  Note that the old
495 functions are not removed, but will be in the future.
497 ** IPS iSCSI stringprep profile added.
499 ** A new contrib/ directory added.
500 Currently it contains a Python interface to Libidn, contributed by
501 Stephane Bortzmeyer.
503 ** idna.h and punycode.h are now installed by "make install".
505 ** API and ABI is backwards compatible with the previous version.
507 * Version 0.1.9 (released 2003-02-20)
509 ** SASL ANONYMOUS "plain" stringprep profile added.
511 ** XMPP nodeprep profile fixed.
513 ** API and ABI is backwards compatible with the previous version.
514 For future releases, the NEWS entry will specifically mention whether
515 the C header API or library ABI backwards compatibility is affected.
517 * Version 0.1.8 (released 2003-02-14)
519 ** Portability fixes.
520 This includes not building the API Reference Manual with GTK-DOC by
521 default, if you want it use configure parameter --enable-gtk-doc after
522 making sure your gtkdoc-mkdb accept the --tmpl-dir parameter.
524 ** The type for string length variables is now (s)size_t.
525 Unfortunately this means binary shared library binary backwards
526 compatible is lost.
528 ** New nameprep test vectors.
530 * Version 0.1.7 (released 2003-02-12)
532 ** Uses official IDNA ACE prefix.
534 * Version 0.1.6 (released 2003-02-11)
536 ** Uses tentative IDNA ACE prefix.
538 ** Added XMPP Node/Resource Identifiers stringprep profiles.
540 ** Fixed prohibited character checks for bidi.
542 * Version 0.1.5 (released 2003-01-28)
544 ** The library can now be built as part of GNU Libc.
545 This is experimental and only tested against GNU Libc version 2.3.1.
546 See the libc/ directory, and libc/README in particular.
548 ** Bug fixes.
550 * Version 0.1.4 (released 2003-01-15)
552 ** Documentation fixes.
554 ** Portability fixes.
556 ** Bug fixes.
558 * Version 0.1.3 (released 2003-01-15)
560 ** Added texinfo manual.
562 * Version 0.1.2 (released 2003-01-08)
564 ** Added high-level IDNA API.
566 ** Added example3.c and example4.c demonstrating the high-level IDNA API.
568 * Version 0.1.1 (released 2003-01-08)
570 ** Added documentation using GTK-DOC.
572 ** The obsolete stringprep_utf8_to_ucs4_fast API entry point was removed.
573 By accident it was never removed in 0.1.0.
575 * Version 0.1.0 (released 2003-01-05)
577 ** Official GNU project.
579 ** Renamed from libstringprep to libidn.
581 ** Supports punycode and IDNA.  Caveat emptor: I don't use it myself.
583 ** Uses "unsigned long" for Unicode code points instead of "long".
584 Long is guaranteed to be at least 32 bits by C standards so it is
585 always sufficiently large, no need to use uint32_t and the like.
587 ** The obsolete stringprep_utf8_to_ucs4_fast API entry point was removed.
589 * Version 0.0.8 (released 2002-12-13)
591 ** Portability fixes (now works under Cygwin on Windows 2000).
593 ** Bug fixes.
595 * Version 0.0.7 (released 2002-12-09)
597 ** Apply all tables to entire strings, not just first hit.
599 ** Fix bidi infloop.
601 * Version 0.0.5 (released 2002-12-07)
603 ** Fix prohibited characters handling.
605 ** Fix bidi.
607 ** Renamed type (struct) stringprep_table_element to Stringprep_table_element.
609 ** Renamed type stringprep_profile to Stringprep_profile.
611 ** Renamed type (struct) stringprep_table to Stringprep_table.
613 ** Added more self-tests.
615 * Version 0.0.4 (released 2002-12-06)
617 ** Add unassigned code point handling, including self test cases.
619 ** Portability fixes.
621 * Version 0.0.3 (released 2002-11-30)
623 ** Exported utility function `stringprep_utf8_to_unichar', complementary
624 to existing `stringprep_unichar_to_utf8'.
626 ** Renamed `stringprep_utf8_to_ucs4_fast' to `stringprep_utf8_to_ucs4' to
627 clean up API. The old entry point is maintained for binary backwards
628 compatibility though.
630 ** The distribution is from now on signed using GnuPG.
632 ** Bug fixes.
634 * Version 0.0.2 (released 2002-11-07)
636 ** NFKC self test.
638 ** Bug fixes.
640 * Version 0.0.1 (released 2002-11-06)
642 ** Add utility functions stringprep_locale_charset(), stringprep_convert() 
643 and stringprep_locale_to_utf8 () that can be used to convert text from
644 system's locale into UTF-8, which should be done before invoking
645 stringprep().  The functions requires iconv() in the operating system.
647 ** An example program (example.c) that illustrates how libstringprep can be
648 used is included.
650 ** The pkg-config --libs output should now include necessary -R options.
652 * Version 0.0.0 (released 2002-11-05)
654 ** Initial release
656 ----------------------------------------------------------------------
657 Copying and distribution of this file, with or without modification,
658 are permitted in any medium without royalty provided the copyright
659 notice and this notice are preserved.