Split binding generation into zstd and zdict (#141)

src/stream/tests.rs

@@ -235,7 +235,7 @@ fn test_empty() {
 #[test]
 fn test_ll_source() {
     // Where could I find some long text?...
-    let data = include_bytes!("../../zstd-safe/zstd-sys/src/bindings.rs");
+    let data = include_bytes!("../../zstd-safe/zstd-sys/src/bindings_zstd.rs");
     // Test a few compression levels.
     // TODO: check them all?
     for level in 1..5 {

zstd-safe/zstd-sys/build.rs

@@ -6,6 +6,7 @@ use std::{env, fs};
 fn generate_bindings(defs: Vec<&str>, headerpaths: Vec<PathBuf>) {
     let bindings = bindgen::Builder::default()
         .header("zstd.h")
+        .header("zdict.h")
         .blocklist_type("max_align_t")
         .size_t_is_usize(true)
         .use_core()

zstd-safe/zstd-sys/src/bindings_zdict.rs

@@ -0,0 +1,136 @@
+/*
+This file is auto-generated from the public API of the zstd library.
+It is released under the same BSD license.
+
+BSD License
+
+For Zstandard software
+
+Copyright (c) 2016-present, Facebook, Inc. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+ * Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+ * Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+ * Neither the name Facebook nor the names of its contributors may be used to
+   endorse or promote products derived from this software without specific
+   prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+*/
+/* automatically generated by rust-bindgen 0.59.2 */
+
+extern "C" {
+    #[doc = " ZDICT_trainFromBuffer():"]
+    #[doc = "  Train a dictionary from an array of samples."]
+    #[doc = "  Redirect towards ZDICT_optimizeTrainFromBuffer_fastCover() single-threaded, with d=8, steps=4,"]
+    #[doc = "  f=20, and accel=1."]
+    #[doc = "  Samples must be stored concatenated in a single flat buffer `samplesBuffer`,"]
+    #[doc = "  supplied with an array of sizes `samplesSizes`, providing the size of each sample, in order."]
+    #[doc = "  The resulting dictionary will be saved into `dictBuffer`."]
+    #[doc = " @return: size of dictionary stored into `dictBuffer` (<= `dictBufferCapacity`)"]
+    #[doc = "          or an error code, which can be tested with ZDICT_isError()."]
+    #[doc = "  Note:  Dictionary training will fail if there are not enough samples to construct a"]
+    #[doc = "         dictionary, or if most of the samples are too small (< 8 bytes being the lower limit)."]
+    #[doc = "         If dictionary training fails, you should use zstd without a dictionary, as the dictionary"]
+    #[doc = "         would've been ineffective anyways. If you believe your samples would benefit from a dictionary"]
+    #[doc = "         please open an issue with details, and we can look into it."]
+    #[doc = "  Note: ZDICT_trainFromBuffer()'s memory usage is about 6 MB."]
+    #[doc = "  Tips: In general, a reasonable dictionary has a size of ~ 100 KB."]
+    #[doc = "        It's possible to select smaller or larger size, just by specifying `dictBufferCapacity`."]
+    #[doc = "        In general, it's recommended to provide a few thousands samples, though this can vary a lot."]
+    #[doc = "        It's recommended that total size of all samples be about ~x100 times the target size of dictionary."]
+    pub fn ZDICT_trainFromBuffer(
+        dictBuffer: *mut libc::c_void,
+        dictBufferCapacity: usize,
+        samplesBuffer: *const libc::c_void,
+        samplesSizes: *const usize,
+        nbSamples: libc::c_uint,
+    ) -> usize;
+}
+#[repr(C)]
+#[derive(Debug, Copy, Clone)]
+pub struct ZDICT_params_t {
+    pub compressionLevel: libc::c_int,
+    pub notificationLevel: libc::c_uint,
+    pub dictID: libc::c_uint,
+}
+extern "C" {
+    #[doc = " ZDICT_finalizeDictionary():"]
+    #[doc = " Given a custom content as a basis for dictionary, and a set of samples,"]
+    #[doc = " finalize dictionary by adding headers and statistics according to the zstd"]
+    #[doc = " dictionary format."]
+    #[doc = ""]
+    #[doc = " Samples must be stored concatenated in a flat buffer `samplesBuffer`,"]
+    #[doc = " supplied with an array of sizes `samplesSizes`, providing the size of each"]
+    #[doc = " sample in order. The samples are used to construct the statistics, so they"]
+    #[doc = " should be representative of what you will compress with this dictionary."]
+    #[doc = ""]
+    #[doc = " The compression level can be set in `parameters`. You should pass the"]
+    #[doc = " compression level you expect to use in production. The statistics for each"]
+    #[doc = " compression level differ, so tuning the dictionary for the compression level"]
+    #[doc = " can help quite a bit."]
+    #[doc = ""]
+    #[doc = " You can set an explicit dictionary ID in `parameters`, or allow us to pick"]
+    #[doc = " a random dictionary ID for you, but we can't guarantee no collisions."]
+    #[doc = ""]
+    #[doc = " The dstDictBuffer and the dictContent may overlap, and the content will be"]
+    #[doc = " appended to the end of the header. If the header + the content doesn't fit in"]
+    #[doc = " maxDictSize the beginning of the content is truncated to make room, since it"]
+    #[doc = " is presumed that the most profitable content is at the end of the dictionary,"]
+    #[doc = " since that is the cheapest to reference."]
+    #[doc = ""]
+    #[doc = " `maxDictSize` must be >= max(dictContentSize, ZSTD_DICTSIZE_MIN)."]
+    #[doc = ""]
+    #[doc = " @return: size of dictionary stored into `dstDictBuffer` (<= `maxDictSize`),"]
+    #[doc = "          or an error code, which can be tested by ZDICT_isError()."]
+    #[doc = " Note: ZDICT_finalizeDictionary() will push notifications into stderr if"]
+    #[doc = "       instructed to, using notificationLevel>0."]
+    #[doc = " NOTE: This function currently may fail in several edge cases including:"]
+    #[doc = "         * Not enough samples"]
+    #[doc = "         * Samples are uncompressible"]
+    #[doc = "         * Samples are all exactly the same"]
+    pub fn ZDICT_finalizeDictionary(
+        dstDictBuffer: *mut libc::c_void,
+        maxDictSize: usize,
+        dictContent: *const libc::c_void,
+        dictContentSize: usize,
+        samplesBuffer: *const libc::c_void,
+        samplesSizes: *const usize,
+        nbSamples: libc::c_uint,
+        parameters: ZDICT_params_t,
+    ) -> usize;
+}
+extern "C" {
+    pub fn ZDICT_getDictID(
+        dictBuffer: *const libc::c_void,
+        dictSize: usize,
+    ) -> libc::c_uint;
+}
+extern "C" {
+    pub fn ZDICT_getDictHeaderSize(
+        dictBuffer: *const libc::c_void,
+        dictSize: usize,
+    ) -> usize;
+}
+extern "C" {
+    pub fn ZDICT_isError(errorCode: usize) -> libc::c_uint;
+}
+extern "C" {
+    pub fn ZDICT_getErrorName(errorCode: usize) -> *const libc::c_char;
+}