Merge branch 'hb/kernel/zlib_contracts/OTP-9506' into dev

* hb/kernel/zlib_contracts/OTP-9506:
  Update documentation and specifications of some of the zlib functions

3 files changed, 90 insertions, 85 deletions

diff --git a/erts/doc/src/zlib.xml b/erts/doc/src/zlib.xml
index 47a649af02..8917ab5c3a 100644
--- a/erts/doc/src/zlib.xml
+++ b/erts/doc/src/zlib.xml
@@ -378,31 +378,31 @@ unpack(Z, Compressed, Dict) ->
       <name name="crc32" arity="2"/>
       <fsummary>Calculate CRC</fsummary>
       <desc>
-        <p>Calculate the CRC checksum for <c><anno>Binary</anno></c>.</p>
+        <p>Calculate the CRC checksum for <c><anno>Data</anno></c>.</p>
       </desc>
     </func>
     <func>
       <name name="crc32" arity="3"/>
       <fsummary>Calculate CRC</fsummary>
       <desc>
-        <p>Update a running CRC checksum for <c><anno>Binary</anno></c>.
-          If <c><anno>Binary</anno></c> is the empty binary, this function returns
+        <p>Update a running CRC checksum for <c><anno>Data</anno></c>.
+          If <c><anno>Data</anno></c> is the empty binary or the empty iolist, this function returns
           the required initial value for the crc.</p>
         <pre>
-Crc = lists:foldl(fun(Bin,Crc0) ->  
-                      zlib:crc32(Z, Crc0, Bin),
-                  end, zlib:crc32(Z,&lt;&lt; &gt;&gt;), Bins)</pre>
+Crc = lists:foldl(fun(Data,Crc0) ->
+                      zlib:crc32(Z, Crc0, Data),
+                  end, zlib:crc32(Z,&lt;&lt; &gt;&gt;), Datas)</pre>
       </desc>
     </func>
     <func>
       <name name="crc32_combine" arity="4"/>
       <fsummary>Combine two CRC's</fsummary>
       <desc>
-	<p>Combine two CRC checksums into one.  For two binaries,
-	  <c>Bin1</c> and <c>Bin2</c> with sizes of <c>Size1</c> and
+	<p>Combine two CRC checksums into one.  For two binaries or iolists,
+	  <c>Data1</c> and <c>Data2</c> with sizes of <c>Size1</c> and
 	  <c><anno>Size2</anno></c>, with CRC checksums <c><anno>CRC1</anno></c> and
 	  <c><anno>CRC2</anno></c>.  <c>crc32_combine/4</c> returns the <c><anno>CRC</anno></c>
-	  checksum of <c>&lt;&lt;Bin1/binary,Bin2/binary&gt;&gt;</c>, requiring
+	  checksum of <c>[Data1,Data2]</c>, requiring
 	  only <c><anno>CRC1</anno></c>, <c><anno>CRC2</anno></c>, and <c><anno>Size2</anno></c>.
 	</p>
       </desc>
@@ -411,75 +411,75 @@ Crc = lists:foldl(fun(Bin,Crc0) ->
       <name name="adler32" arity="2"/>
       <fsummary>Calculate the adler checksum</fsummary>
       <desc>
-        <p>Calculate the Adler-32 checksum for <c><anno>Binary</anno></c>.</p>
+        <p>Calculate the Adler-32 checksum for <c><anno>Data</anno></c>.</p>
       </desc>
     </func>
     <func>
       <name name="adler32" arity="3"/>
       <fsummary>Calculate the adler checksum</fsummary>
       <desc>
-        <p>Update a running Adler-32 checksum for <c><anno>Binary</anno></c>.
-          If <c><anno>Binary</anno></c> is the empty binary, this function returns
+        <p>Update a running Adler-32 checksum for <c><anno>Data</anno></c>.
+          If <c><anno>Data</anno></c> is the empty binary or the empty iolist, this function returns
           the required initial value for the checksum.</p>
         <pre>
-Crc = lists:foldl(fun(Bin,Crc0) ->  
-                      zlib:adler32(Z, Crc0, Bin),
-                  end, zlib:adler32(Z,&lt;&lt; &gt;&gt;), Bins)</pre>
+Crc = lists:foldl(fun(Data,Crc0) ->
+                      zlib:adler32(Z, Crc0, Data),
+                  end, zlib:adler32(Z,&lt;&lt; &gt;&gt;), Datas)</pre>
       </desc>
     </func>
     <func>
       <name name="adler32_combine" arity="4"/>
       <fsummary>Combine two Adler-32 checksums</fsummary>
       <desc>
-	<p>Combine two Adler-32 checksums into one.  For two binaries,
-	  <c>Bin1</c> and <c>Bin2</c> with sizes of <c>Size1</c> and
+	<p>Combine two Adler-32 checksums into one.  For two binaries or iolists,
+	  <c>Data1</c> and <c>Data2</c> with sizes of <c>Size1</c> and
 	  <c><anno>Size2</anno></c>, with Adler-32 checksums <c><anno>Adler1</anno></c> and
 	  <c><anno>Adler2</anno></c>.  <c>adler32_combine/4</c> returns the <c><anno>Adler</anno></c>
-	  checksum of <c>&lt;&lt;Bin1/binary,Bin2/binary&gt;&gt;</c>, requiring
+	  checksum of <c>[Data1,Data2]</c>, requiring
 	  only <c><anno>Adler1</anno></c>, <c><anno>Adler2</anno></c>, and <c><anno>Size2</anno></c>.
 	</p>
       </desc>
     </func>
     <func>
       <name name="compress" arity="1"/>
-      <fsummary>Compress a binary with standard zlib functionality</fsummary>
+      <fsummary>Compress data with standard zlib functionality</fsummary>
       <desc>
-        <p>Compress a binary (with zlib headers and checksum).</p>
+        <p>Compress data (with zlib headers and checksum).</p>
       </desc>
     </func>
     <func>
       <name name="uncompress" arity="1"/>
-      <fsummary>Uncompress a binary with standard zlib functionality</fsummary>
+      <fsummary>Uncompress data with standard zlib functionality</fsummary>
       <desc>
-        <p>Uncompress a binary (with zlib headers and checksum).</p>
+        <p>Uncompress data (with zlib headers and checksum).</p>
       </desc>
     </func>
     <func>
       <name name="zip" arity="1"/>
-      <fsummary>Compress a binary without the zlib headers</fsummary>
+      <fsummary>Compress data without the zlib headers</fsummary>
       <desc>
-        <p>Compress a binary (without zlib headers and checksum).</p>
+        <p>Compress data (without zlib headers and checksum).</p>
       </desc>
     </func>
     <func>
       <name name="unzip" arity="1"/>
-      <fsummary>Uncompress a binary without the zlib headers</fsummary>
+      <fsummary>Uncompress data without the zlib headers</fsummary>
       <desc>
-        <p>Uncompress a binary (without zlib headers and checksum).</p>
+        <p>Uncompress data (without zlib headers and checksum).</p>
       </desc>
     </func>
     <func>
       <name name="gzip" arity="1"/>
-      <fsummary>Compress a binary with gz header</fsummary>
+      <fsummary>Compress data with gz header</fsummary>
       <desc>
-        <p>Compress a binary (with gz headers and checksum).</p>
+        <p>Compress data (with gz headers and checksum).</p>
       </desc>
     </func>
     <func>
       <name name="gunzip" arity="1"/>
-      <fsummary>Uncompress a binary with gz header</fsummary>
+      <fsummary>Uncompress data with gz header</fsummary>
       <desc>
-        <p>Uncompress a binary (with gz headers and checksum).</p>
+        <p>Uncompress data (with gz headers and checksum).</p>
       </desc>
     </func>
   </funcs>
diff --git a/erts/preloaded/ebin/zlib.beam b/erts/preloaded/ebin/zlib.beam
index d400269ed0..cda53f7692 100644
--- a/erts/preloaded/ebin/zlib.beam
+++ b/erts/preloaded/ebin/zlib.beam
diff --git a/erts/preloaded/src/zlib.erl b/erts/preloaded/src/zlib.erl
index 6cc7b27114..210532edac 100644
--- a/erts/preloaded/src/zlib.erl
+++ b/erts/preloaded/src/zlib.erl
@@ -173,7 +173,7 @@ deflateInit(Z, Level, Method, WindowBits, MemLevel, Strategy) ->
 
 -spec deflateSetDictionary(Z, Dictionary) -> Adler32 when
       Z :: zstream(),
-      Dictionary :: binary(),
+      Dictionary :: iodata(),
       Adler32 :: integer().
 deflateSetDictionary(Z, Dictionary) ->
     call(Z, ?DEFLATE_SETDICT, Dictionary).
@@ -232,7 +232,7 @@ inflateInit(Z, WindowBits) ->
 
 -spec inflateSetDictionary(Z, Dictionary) -> 'ok' when
       Z :: zstream(),
-      Dictionary :: binary().
+      Dictionary :: iodata().
 inflateSetDictionary(Z, Dictionary) -> 
     call(Z, ?INFLATE_SETDICT, Dictionary).
 
@@ -283,38 +283,36 @@ getBufSize(Z) ->
 crc32(Z) ->
     call(Z, ?CRC32_0, []).
 
--spec crc32(Z, Binary) -> CRC when
+-spec crc32(Z, Data) -> CRC when
       Z :: zstream(),
-      Binary :: binary(),
+      Data :: iodata(),
       CRC :: integer().
-crc32(Z, Binary) ->
-    call(Z, ?CRC32_1, Binary).
+crc32(Z, Data) ->
+    call(Z, ?CRC32_1, Data).
 
--spec crc32(Z, PrevCRC, Binary) -> CRC when
+-spec crc32(Z, PrevCRC, Data) -> CRC when
       Z :: zstream(),
       PrevCRC :: integer(),
-      Binary :: binary(),
+      Data :: iodata(),
       CRC :: integer().
-crc32(Z, CRC, Binary) when is_binary(Binary), is_integer(CRC) ->
-    call(Z, ?CRC32_2, <<CRC:32, Binary/binary>>);
-crc32(_Z, _CRC, _Binary)  ->
-    erlang:error(badarg).
+crc32(Z, CRC, Data) ->
+    call(Z, ?CRC32_2, [<<CRC:32>>, Data]).
 
--spec adler32(Z, Binary) -> CheckSum when
+-spec adler32(Z, Data) -> CheckSum when
       Z :: zstream(),
-      Binary :: binary(),
+      Data :: iodata(),
       CheckSum :: integer().
-adler32(Z, Binary) ->
-    call(Z, ?ADLER32_1, Binary).
+adler32(Z, Data) ->
+    call(Z, ?ADLER32_1, Data).
 
--spec adler32(Z, PrevAdler, Binary) -> CheckSum when
+-spec adler32(Z, PrevAdler, Data) -> CheckSum when
       Z :: zstream(),
       PrevAdler :: integer(),
-      Binary :: binary(),
+      Data :: iodata(),
       CheckSum :: integer().
-adler32(Z, Adler, Binary) when is_binary(Binary), is_integer(Adler) ->
-    call(Z, ?ADLER32_2, <<Adler:32, Binary/binary>>);
-adler32(_Z, _Adler, _Binary)  ->
+adler32(Z, Adler, Data) when is_integer(Adler) ->
+    call(Z, ?ADLER32_2, [<<Adler:32>>, Data]);
+adler32(_Z, _Adler, _Data)  ->
     erlang:error(badarg).
 
 -spec crc32_combine(Z, CRC1, CRC2, Size2) -> CRC when
@@ -346,76 +344,83 @@ getQSize(Z) ->
     call(Z, ?GET_QSIZE, []).
 
 %% compress/uncompress zlib with header
--spec compress(Binary) -> Compressed when
-      Binary :: binary(),
+-spec compress(Data) -> Compressed when
+      Data :: iodata(),
       Compressed :: binary().
-compress(Binary) ->
+compress(Data) ->
     Z = open(),
     deflateInit(Z, default),
-    Bs = deflate(Z, Binary,finish),
+    Bs = deflate(Z, Data, finish),
     deflateEnd(Z),
     close(Z),
-    list_to_binary(Bs).
+    iolist_to_binary(Bs).
 
--spec uncompress(Binary) -> Decompressed when
-      Binary  :: binary(),
+-spec uncompress(Data) -> Decompressed when
+      Data  :: iodata(),
       Decompressed :: binary().
-uncompress(Binary) when byte_size(Binary) >= 8 ->
-    Z = open(),
-    inflateInit(Z),
-    Bs = inflate(Z, Binary),
-    inflateEnd(Z),
-    close(Z),
-    list_to_binary(Bs);
-uncompress(Binary) when is_binary(Binary) -> erlang:error(data_error);
-uncompress(_) -> erlang:error(badarg).
+uncompress(Data) ->
+    try iolist_size(Data) of
+        Size ->
+            if
+                Size >= 8 ->
+                    Z = open(),
+                    inflateInit(Z),
+                    Bs = inflate(Z, Data),
+                    inflateEnd(Z),
+                    close(Z),
+                    iolist_to_binary(Bs);
+                true ->
+                    erlang:error(data_error)
+            end
+    catch
+        _:_ ->
+            erlang:error(badarg)
+    end.
 
 %% unzip/zip zlib without header (zip members)
--spec zip(Binary) -> Compressed when
-      Binary :: binary(),
+-spec zip(Data) -> Compressed when
+      Data :: iodata(),
       Compressed :: binary().
-zip(Binary) ->
+zip(Data) ->
     Z = open(),
     deflateInit(Z, default, deflated, -?MAX_WBITS, 8, default),
-    Bs = deflate(Z, Binary, finish),
+    Bs = deflate(Z, Data, finish),
     deflateEnd(Z),
     close(Z),
-    list_to_binary(Bs).
+    iolist_to_binary(Bs).
 
--spec unzip(Binary) -> Decompressed when
-      Binary :: binary(),
+-spec unzip(Data) -> Decompressed when
+      Data :: iodata(),
       Decompressed :: binary().
-unzip(Binary) ->
+unzip(Data) ->
     Z = open(),
     inflateInit(Z, -?MAX_WBITS),
-    Bs = inflate(Z, Binary),
+    Bs = inflate(Z, Data),
     inflateEnd(Z),
     close(Z),
-    list_to_binary(Bs).
+    iolist_to_binary(Bs).
     
 -spec gzip(Data) -> Compressed when
       Data :: iodata(),
       Compressed :: binary().
-gzip(Data) when is_binary(Data); is_list(Data) ->
+gzip(Data) ->
     Z = open(),
     deflateInit(Z, default, deflated, 16+?MAX_WBITS, 8, default),
     Bs = deflate(Z, Data, finish),
     deflateEnd(Z),
     close(Z),
-    iolist_to_binary(Bs);
-gzip(_) -> erlang:error(badarg).
+    iolist_to_binary(Bs).
 
--spec gunzip(Binary) -> Decompressed when
-      Binary :: binary(),
+-spec gunzip(Data) -> Decompressed when
+      Data :: iodata(),
       Decompressed :: binary().
-gunzip(Data) when is_binary(Data); is_list(Data) ->
+gunzip(Data) ->
     Z = open(),
     inflateInit(Z, 16+?MAX_WBITS),
     Bs = inflate(Z, Data),
     inflateEnd(Z),
     close(Z),
-    iolist_to_binary(Bs);
-gunzip(_) -> erlang:error(badarg).
+    iolist_to_binary(Bs).
 
 -spec collect(zstream()) -> iolist().
 collect(Z) ->