From b2b0feab152063f71c4bf58f985cd52fc9e0105a Mon Sep 17 00:00:00 2001
From: Hans Bolinder <hasse@erlang.org>
Date: Fri, 11 Jan 2013 14:42:54 +0100
Subject: Extend char() to Unicode characters

The code related to the introduction of unicode_string() and
unicode_char() has been removed. The types char() and string() have
been extended to include Unicode characters.

In fact char() was changed some time ago; this commit is about
cleaning up the documentation and introduce better names for some
functions.
---
 lib/stdlib/doc/src/io_lib.xml  | 67 ++++++++++++++++++++++++++++++++++++++++--
 lib/stdlib/doc/src/unicode.xml | 20 +++----------
 2 files changed, 68 insertions(+), 19 deletions(-)

(limited to 'lib/stdlib/doc')

diff --git a/lib/stdlib/doc/src/io_lib.xml b/lib/stdlib/doc/src/io_lib.xml
index 7487cb5740..001d34a7c2 100644
--- a/lib/stdlib/doc/src/io_lib.xml
+++ b/lib/stdlib/doc/src/io_lib.xml
@@ -4,7 +4,7 @@
 <erlref>
   <header>
     <copyright>
-      <year>1996</year><year>2012</year>
+      <year>1996</year><year>2013</year>
       <holder>Ericsson AB. All Rights Reserved.</holder>
     </copyright>
     <legalnotice>
@@ -53,6 +53,9 @@
     <datatype>
       <name name="fread_error"/>
     </datatype>
+    <datatype>
+      <name name="latin1_string"/>
+    </datatype>
   </datatypes>
   <funcs>
     <func>
@@ -207,13 +210,47 @@
       <name name="write_string" arity="1"/>
       <fsummary>Write a string</fsummary>
       <desc>
-        <p>Returns the list of characters needed to print <c><anno>String</anno></c>
-          as a string.</p>
+        <p>Returns the list of characters needed to print
+          <c><anno>String</anno></c> as a string.</p>
+      </desc>
+    </func>
+    <func>
+      <name name="write_string_as_latin1" arity="1"/>
+      <fsummary>Write a string</fsummary>
+      <desc>
+        <p>Returns the list of characters needed to print
+          <c><anno>String</anno></c> as a string. Non-Latin-1
+          characters are escaped.</p>
+      </desc>
+    </func>
+    <func>
+      <name name="write_latin1_string" arity="1"/>
+      <fsummary>Write an ISO-latin-1 string</fsummary>
+      <desc>
+        <p>Returns the list of characters needed to print
+          <c><anno>Latin1String</anno></c> as a string.</p>
       </desc>
     </func>
     <func>
       <name name="write_char" arity="1"/>
       <fsummary>Write a character</fsummary>
+      <desc>
+        <p>Returns the list of characters needed to print a character
+          constant in the Unicode character set.</p>
+      </desc>
+    </func>
+    <func>
+      <name name="write_char_as_latin1" arity="1"/>
+      <fsummary>Write a character</fsummary>
+      <desc>
+        <p>Returns the list of characters needed to print a character
+          constant in the Unicode character set. Non-Latin-1 characters
+          are escaped.</p>
+      </desc>
+    </func>
+    <func>
+      <name name="write_latin1_char" arity="1"/>
+      <fsummary>Write an ISO-latin-1 character</fsummary>
       <desc>
         <p>Returns the list of characters needed to print a character
           constant in the ISO-latin-1 character set.</p>
@@ -230,6 +267,14 @@
     <func>
       <name name="char_list" arity="1"/>
       <fsummary>Test for a list of characters</fsummary>
+      <desc>
+        <p>Returns <c>true</c> if <c><anno>Term</anno></c> is a flat list of
+          characters in the Unicode range, otherwise it returns <c>false</c>.</p>
+      </desc>
+    </func>
+    <func>
+      <name name="latin1_char_list" arity="1"/>
+      <fsummary>Test for a list of ISO-latin-1 characters</fsummary>
       <desc>
         <p>Returns <c>true</c> if <c><anno>Term</anno></c> is a flat list of
           characters in the ISO-latin-1 range, otherwise it returns <c>false</c>.</p>
@@ -238,6 +283,14 @@
     <func>
       <name name="deep_char_list" arity="1"/>
       <fsummary>Test for a deep list of characters</fsummary>
+      <desc>
+        <p>Returns <c>true</c> if <c><anno>Term</anno></c> is a, possibly deep, list
+          of characters in the Unicode range, otherwise it returns <c>false</c>.</p>
+      </desc>
+    </func>
+    <func>
+      <name name="deep_latin1_char_list" arity="1"/>
+      <fsummary>Test for a deep list of characters</fsummary>
       <desc>
         <p>Returns <c>true</c> if <c><anno>Term</anno></c> is a, possibly deep, list
           of characters in the ISO-latin-1 range, otherwise it returns <c>false</c>.</p>
@@ -245,6 +298,14 @@
     </func>
     <func>
       <name name="printable_list" arity="1"/>
+      <fsummary>Test for a list of printable characters</fsummary>
+      <desc>
+        <p>Returns <c>true</c> if <c><anno>Term</anno></c> is a flat list of
+          printable Unicode characters, otherwise it returns <c>false</c>.</p>
+      </desc>
+    </func>
+    <func>
+      <name name="printable_latin1_list" arity="1"/>
       <fsummary>Test for a list of printable ISO-latin-1 characters</fsummary>
       <desc>
         <p>Returns <c>true</c> if <c><anno>Term</anno></c> is a flat list of
diff --git a/lib/stdlib/doc/src/unicode.xml b/lib/stdlib/doc/src/unicode.xml
index d235f3e180..deba6adb11 100644
--- a/lib/stdlib/doc/src/unicode.xml
+++ b/lib/stdlib/doc/src/unicode.xml
@@ -5,7 +5,7 @@
   <header>
     <copyright>
       <year>1996</year>
-      <year>2012</year>
+      <year>2013</year>
       <holder>Ericsson AB, All Rights Reserved</holder>
     </copyright>
     <legalnotice>
@@ -51,20 +51,11 @@
         <p>A <c>binary()</c> with characters encoded in the UTF-8 coding standard.</p>
       </desc>
     </datatype>
-    <datatype>
-      <name name="unicode_char"/>
-      <desc>
-        <p>An <c>integer()</c> representing a valid Unicode codepoint.</p>
-      </desc>
-    </datatype>
     <datatype>
       <name name="chardata"/>
     </datatype>
     <datatype>
       <name name="charlist"/>
-      <desc>
-        <p>A <c>unicode_binary()</c> is allowed as the tail of the list.</p>
-      </desc>
     </datatype>
     <datatype>
       <name name="external_unicode_binary"/>
@@ -78,10 +69,6 @@
     </datatype>
     <datatype>
       <name name="external_charlist"/>
-      <desc>
-        <p>An <c>external_unicode_binary()</c> is allowed as the tail
-           of the list.</p>
-      </desc>
     </datatype>
     <datatype>
       <name name="latin1_binary"/>
@@ -96,11 +83,12 @@
     </datatype>
     <datatype>
       <name name="latin1_chardata"/>
+      <desc><p>The same as <c>iodata()</c>.</p>
+      </desc>
     </datatype>
     <datatype>
       <name name="latin1_charlist"/>
-      <desc><p>A <c>latin1_binary()</c> is allowed as the tail of
-        the list.</p>
+      <desc><p>The same as <c>iolist()</c>.</p>
       </desc>
     </datatype>
   </datatypes>
-- 
cgit v1.2.3