1 files changed, 432 insertions, 0 deletions
diff --git a/Modules/_zstd/clinic/_zstdmodule.c.h b/Modules/_zstd/clinic/_zstdmodule.c.h
new file mode 100644
index 00000000000..2f8225389b7
--- /dev/null
+++ b/Modules/_zstd/clinic/_zstdmodule.c.h
@@ -0,0 +1,432 @@
+/*[clinic input]
+preserve
+[clinic start generated code]*/
+
+#if defined(Py_BUILD_CORE) && !defined(Py_BUILD_CORE_MODULE)
+#  include "pycore_gc.h"          // PyGC_Head
+#  include "pycore_runtime.h"     // _Py_ID()
+#endif
+#include "pycore_abstract.h"      // _PyNumber_Index()
+#include "pycore_modsupport.h"    // _PyArg_CheckPositional()
+
+PyDoc_STRVAR(_zstd__train_dict__doc__,
+"_train_dict($module, samples_bytes, samples_sizes, dict_size, /)\n"
+"--\n"
+"\n"
+"Internal function, train a zstd dictionary on sample data.\n"
+"\n"
+"  samples_bytes\n"
+"    Concatenation of samples.\n"
+"  samples_sizes\n"
+"    Tuple of samples\' sizes.\n"
+"  dict_size\n"
+"    The size of the dictionary.");
+
+#define _ZSTD__TRAIN_DICT_METHODDEF    \
+    {"_train_dict", _PyCFunction_CAST(_zstd__train_dict), METH_FASTCALL, _zstd__train_dict__doc__},
+
+static PyObject *
+_zstd__train_dict_impl(PyObject *module, PyBytesObject *samples_bytes,
+                       PyObject *samples_sizes, Py_ssize_t dict_size);
+
+static PyObject *
+_zstd__train_dict(PyObject *module, PyObject *const *args, Py_ssize_t nargs)
+{
+    PyObject *return_value = NULL;
+    PyBytesObject *samples_bytes;
+    PyObject *samples_sizes;
+    Py_ssize_t dict_size;
+
+    if (!_PyArg_CheckPositional("_train_dict", nargs, 3, 3)) {
+        goto exit;
+    }
+    if (!PyBytes_Check(args[0])) {
+        _PyArg_BadArgument("_train_dict", "argument 1", "bytes", args[0]);
+        goto exit;
+    }
+    samples_bytes = (PyBytesObject *)args[0];
+    if (!PyTuple_Check(args[1])) {
+        _PyArg_BadArgument("_train_dict", "argument 2", "tuple", args[1]);
+        goto exit;
+    }
+    samples_sizes = args[1];
+    {
+        Py_ssize_t ival = -1;
+        PyObject *iobj = _PyNumber_Index(args[2]);
+        if (iobj != NULL) {
+            ival = PyLong_AsSsize_t(iobj);
+            Py_DECREF(iobj);
+        }
+        if (ival == -1 && PyErr_Occurred()) {
+            goto exit;
+        }
+        dict_size = ival;
+    }
+    return_value = _zstd__train_dict_impl(module, samples_bytes, samples_sizes, dict_size);
+
+exit:
+    return return_value;
+}
+
+PyDoc_STRVAR(_zstd__finalize_dict__doc__,
+"_finalize_dict($module, custom_dict_bytes, samples_bytes,\n"
+"               samples_sizes, dict_size, compression_level, /)\n"
+"--\n"
+"\n"
+"Internal function, finalize a zstd dictionary.\n"
+"\n"
+"  custom_dict_bytes\n"
+"    Custom dictionary content.\n"
+"  samples_bytes\n"
+"    Concatenation of samples.\n"
+"  samples_sizes\n"
+"    Tuple of samples\' sizes.\n"
+"  dict_size\n"
+"    The size of the dictionary.\n"
+"  compression_level\n"
+"    Optimize for a specific zstd compression level, 0 means default.");
+
+#define _ZSTD__FINALIZE_DICT_METHODDEF    \
+    {"_finalize_dict", _PyCFunction_CAST(_zstd__finalize_dict), METH_FASTCALL, _zstd__finalize_dict__doc__},
+
+static PyObject *
+_zstd__finalize_dict_impl(PyObject *module, PyBytesObject *custom_dict_bytes,
+                          PyBytesObject *samples_bytes,
+                          PyObject *samples_sizes, Py_ssize_t dict_size,
+                          int compression_level);
+
+static PyObject *
+_zstd__finalize_dict(PyObject *module, PyObject *const *args, Py_ssize_t nargs)
+{
+    PyObject *return_value = NULL;
+    PyBytesObject *custom_dict_bytes;
+    PyBytesObject *samples_bytes;
+    PyObject *samples_sizes;
+    Py_ssize_t dict_size;
+    int compression_level;
+
+    if (!_PyArg_CheckPositional("_finalize_dict", nargs, 5, 5)) {
+        goto exit;
+    }
+    if (!PyBytes_Check(args[0])) {
+        _PyArg_BadArgument("_finalize_dict", "argument 1", "bytes", args[0]);
+        goto exit;
+    }
+    custom_dict_bytes = (PyBytesObject *)args[0];
+    if (!PyBytes_Check(args[1])) {
+        _PyArg_BadArgument("_finalize_dict", "argument 2", "bytes", args[1]);
+        goto exit;
+    }
+    samples_bytes = (PyBytesObject *)args[1];
+    if (!PyTuple_Check(args[2])) {
+        _PyArg_BadArgument("_finalize_dict", "argument 3", "tuple", args[2]);
+        goto exit;
+    }
+    samples_sizes = args[2];
+    {
+        Py_ssize_t ival = -1;
+        PyObject *iobj = _PyNumber_Index(args[3]);
+        if (iobj != NULL) {
+            ival = PyLong_AsSsize_t(iobj);
+            Py_DECREF(iobj);
+        }
+        if (ival == -1 && PyErr_Occurred()) {
+            goto exit;
+        }
+        dict_size = ival;
+    }
+    compression_level = PyLong_AsInt(args[4]);
+    if (compression_level == -1 && PyErr_Occurred()) {
+        goto exit;
+    }
+    return_value = _zstd__finalize_dict_impl(module, custom_dict_bytes, samples_bytes, samples_sizes, dict_size, compression_level);
+
+exit:
+    return return_value;
+}
+
+PyDoc_STRVAR(_zstd__get_param_bounds__doc__,
+"_get_param_bounds($module, /, parameter, is_compress)\n"
+"--\n"
+"\n"
+"Internal function, get CompressionParameter/DecompressionParameter bounds.\n"
+"\n"
+"  parameter\n"
+"    The parameter to get bounds.\n"
+"  is_compress\n"
+"    True for CompressionParameter, False for DecompressionParameter.");
+
+#define _ZSTD__GET_PARAM_BOUNDS_METHODDEF    \
+    {"_get_param_bounds", _PyCFunction_CAST(_zstd__get_param_bounds), METH_FASTCALL|METH_KEYWORDS, _zstd__get_param_bounds__doc__},
+
+static PyObject *
+_zstd__get_param_bounds_impl(PyObject *module, int parameter,
+                             int is_compress);
+
+static PyObject *
+_zstd__get_param_bounds(PyObject *module, PyObject *const *args, Py_ssize_t nargs, PyObject *kwnames)
+{
+    PyObject *return_value = NULL;
+    #if defined(Py_BUILD_CORE) && !defined(Py_BUILD_CORE_MODULE)
+
+    #define NUM_KEYWORDS 2
+    static struct {
+        PyGC_Head _this_is_not_used;
+        PyObject_VAR_HEAD
+        Py_hash_t ob_hash;
+        PyObject *ob_item[NUM_KEYWORDS];
+    } _kwtuple = {
+        .ob_base = PyVarObject_HEAD_INIT(&PyTuple_Type, NUM_KEYWORDS)
+        .ob_hash = -1,
+        .ob_item = { &_Py_ID(parameter), &_Py_ID(is_compress), },
+    };
+    #undef NUM_KEYWORDS
+    #define KWTUPLE (&_kwtuple.ob_base.ob_base)
+
+    #else  // !Py_BUILD_CORE
+    #  define KWTUPLE NULL
+    #endif  // !Py_BUILD_CORE
+
+    static const char * const _keywords[] = {"parameter", "is_compress", NULL};
+    static _PyArg_Parser _parser = {
+        .keywords = _keywords,
+        .fname = "_get_param_bounds",
+        .kwtuple = KWTUPLE,
+    };
+    #undef KWTUPLE
+    PyObject *argsbuf[2];
+    int parameter;
+    int is_compress;
+
+    args = _PyArg_UnpackKeywords(args, nargs, NULL, kwnames, &_parser,
+            /*minpos*/ 2, /*maxpos*/ 2, /*minkw*/ 0, /*varpos*/ 0, argsbuf);
+    if (!args) {
+        goto exit;
+    }
+    parameter = PyLong_AsInt(args[0]);
+    if (parameter == -1 && PyErr_Occurred()) {
+        goto exit;
+    }
+    is_compress = PyObject_IsTrue(args[1]);
+    if (is_compress < 0) {
+        goto exit;
+    }
+    return_value = _zstd__get_param_bounds_impl(module, parameter, is_compress);
+
+exit:
+    return return_value;
+}
+
+PyDoc_STRVAR(_zstd_get_frame_size__doc__,
+"get_frame_size($module, /, frame_buffer)\n"
+"--\n"
+"\n"
+"Get the size of a zstd frame, including frame header and 4-byte checksum if it has one.\n"
+"\n"
+"  frame_buffer\n"
+"    A bytes-like object, it should start from the beginning of a frame,\n"
+"    and contains at least one complete frame.\n"
+"\n"
+"It will iterate all blocks\' headers within a frame, to accumulate the frame size.");
+
+#define _ZSTD_GET_FRAME_SIZE_METHODDEF    \
+    {"get_frame_size", _PyCFunction_CAST(_zstd_get_frame_size), METH_FASTCALL|METH_KEYWORDS, _zstd_get_frame_size__doc__},
+
+static PyObject *
+_zstd_get_frame_size_impl(PyObject *module, Py_buffer *frame_buffer);
+
+static PyObject *
+_zstd_get_frame_size(PyObject *module, PyObject *const *args, Py_ssize_t nargs, PyObject *kwnames)
+{
+    PyObject *return_value = NULL;
+    #if defined(Py_BUILD_CORE) && !defined(Py_BUILD_CORE_MODULE)
+
+    #define NUM_KEYWORDS 1
+    static struct {
+        PyGC_Head _this_is_not_used;
+        PyObject_VAR_HEAD
+        Py_hash_t ob_hash;
+        PyObject *ob_item[NUM_KEYWORDS];
+    } _kwtuple = {
+        .ob_base = PyVarObject_HEAD_INIT(&PyTuple_Type, NUM_KEYWORDS)
+        .ob_hash = -1,
+        .ob_item = { &_Py_ID(frame_buffer), },
+    };
+    #undef NUM_KEYWORDS
+    #define KWTUPLE (&_kwtuple.ob_base.ob_base)
+
+    #else  // !Py_BUILD_CORE
+    #  define KWTUPLE NULL
+    #endif  // !Py_BUILD_CORE
+
+    static const char * const _keywords[] = {"frame_buffer", NULL};
+    static _PyArg_Parser _parser = {
+        .keywords = _keywords,
+        .fname = "get_frame_size",
+        .kwtuple = KWTUPLE,
+    };
+    #undef KWTUPLE
+    PyObject *argsbuf[1];
+    Py_buffer frame_buffer = {NULL, NULL};
+
+    args = _PyArg_UnpackKeywords(args, nargs, NULL, kwnames, &_parser,
+            /*minpos*/ 1, /*maxpos*/ 1, /*minkw*/ 0, /*varpos*/ 0, argsbuf);
+    if (!args) {
+        goto exit;
+    }
+    if (PyObject_GetBuffer(args[0], &frame_buffer, PyBUF_SIMPLE) != 0) {
+        goto exit;
+    }
+    return_value = _zstd_get_frame_size_impl(module, &frame_buffer);
+
+exit:
+    /* Cleanup for frame_buffer */
+    if (frame_buffer.obj) {
+       PyBuffer_Release(&frame_buffer);
+    }
+
+    return return_value;
+}
+
+PyDoc_STRVAR(_zstd__get_frame_info__doc__,
+"_get_frame_info($module, /, frame_buffer)\n"
+"--\n"
+"\n"
+"Internal function, get zstd frame infomation from a frame header.\n"
+"\n"
+"  frame_buffer\n"
+"    A bytes-like object, containing the header of a zstd frame.");
+
+#define _ZSTD__GET_FRAME_INFO_METHODDEF    \
+    {"_get_frame_info", _PyCFunction_CAST(_zstd__get_frame_info), METH_FASTCALL|METH_KEYWORDS, _zstd__get_frame_info__doc__},
+
+static PyObject *
+_zstd__get_frame_info_impl(PyObject *module, Py_buffer *frame_buffer);
+
+static PyObject *
+_zstd__get_frame_info(PyObject *module, PyObject *const *args, Py_ssize_t nargs, PyObject *kwnames)
+{
+    PyObject *return_value = NULL;
+    #if defined(Py_BUILD_CORE) && !defined(Py_BUILD_CORE_MODULE)
+
+    #define NUM_KEYWORDS 1
+    static struct {
+        PyGC_Head _this_is_not_used;
+        PyObject_VAR_HEAD
+        Py_hash_t ob_hash;
+        PyObject *ob_item[NUM_KEYWORDS];
+    } _kwtuple = {
+        .ob_base = PyVarObject_HEAD_INIT(&PyTuple_Type, NUM_KEYWORDS)
+        .ob_hash = -1,
+        .ob_item = { &_Py_ID(frame_buffer), },
+    };
+    #undef NUM_KEYWORDS
+    #define KWTUPLE (&_kwtuple.ob_base.ob_base)
+
+    #else  // !Py_BUILD_CORE
+    #  define KWTUPLE NULL
+    #endif  // !Py_BUILD_CORE
+
+    static const char * const _keywords[] = {"frame_buffer", NULL};
+    static _PyArg_Parser _parser = {
+        .keywords = _keywords,
+        .fname = "_get_frame_info",
+        .kwtuple = KWTUPLE,
+    };
+    #undef KWTUPLE
+    PyObject *argsbuf[1];
+    Py_buffer frame_buffer = {NULL, NULL};
+
+    args = _PyArg_UnpackKeywords(args, nargs, NULL, kwnames, &_parser,
+            /*minpos*/ 1, /*maxpos*/ 1, /*minkw*/ 0, /*varpos*/ 0, argsbuf);
+    if (!args) {
+        goto exit;
+    }
+    if (PyObject_GetBuffer(args[0], &frame_buffer, PyBUF_SIMPLE) != 0) {
+        goto exit;
+    }
+    return_value = _zstd__get_frame_info_impl(module, &frame_buffer);
+
+exit:
+    /* Cleanup for frame_buffer */
+    if (frame_buffer.obj) {
+       PyBuffer_Release(&frame_buffer);
+    }
+
+    return return_value;
+}
+
+PyDoc_STRVAR(_zstd__set_parameter_types__doc__,
+"_set_parameter_types($module, /, c_parameter_type, d_parameter_type)\n"
+"--\n"
+"\n"
+"Internal function, set CompressionParameter/DecompressionParameter types for validity check.\n"
+"\n"
+"  c_parameter_type\n"
+"    CompressionParameter IntEnum type object\n"
+"  d_parameter_type\n"
+"    DecompressionParameter IntEnum type object");
+
+#define _ZSTD__SET_PARAMETER_TYPES_METHODDEF    \
+    {"_set_parameter_types", _PyCFunction_CAST(_zstd__set_parameter_types), METH_FASTCALL|METH_KEYWORDS, _zstd__set_parameter_types__doc__},
+
+static PyObject *
+_zstd__set_parameter_types_impl(PyObject *module, PyObject *c_parameter_type,
+                                PyObject *d_parameter_type);
+
+static PyObject *
+_zstd__set_parameter_types(PyObject *module, PyObject *const *args, Py_ssize_t nargs, PyObject *kwnames)
+{
+    PyObject *return_value = NULL;
+    #if defined(Py_BUILD_CORE) && !defined(Py_BUILD_CORE_MODULE)
+
+    #define NUM_KEYWORDS 2
+    static struct {
+        PyGC_Head _this_is_not_used;
+        PyObject_VAR_HEAD
+        Py_hash_t ob_hash;
+        PyObject *ob_item[NUM_KEYWORDS];
+    } _kwtuple = {
+        .ob_base = PyVarObject_HEAD_INIT(&PyTuple_Type, NUM_KEYWORDS)
+        .ob_hash = -1,
+        .ob_item = { &_Py_ID(c_parameter_type), &_Py_ID(d_parameter_type), },
+    };
+    #undef NUM_KEYWORDS
+    #define KWTUPLE (&_kwtuple.ob_base.ob_base)
+
+    #else  // !Py_BUILD_CORE
+    #  define KWTUPLE NULL
+    #endif  // !Py_BUILD_CORE
+
+    static const char * const _keywords[] = {"c_parameter_type", "d_parameter_type", NULL};
+    static _PyArg_Parser _parser = {
+        .keywords = _keywords,
+        .fname = "_set_parameter_types",
+        .kwtuple = KWTUPLE,
+    };
+    #undef KWTUPLE
+    PyObject *argsbuf[2];
+    PyObject *c_parameter_type;
+    PyObject *d_parameter_type;
+
+    args = _PyArg_UnpackKeywords(args, nargs, NULL, kwnames, &_parser,
+            /*minpos*/ 2, /*maxpos*/ 2, /*minkw*/ 0, /*varpos*/ 0, argsbuf);
+    if (!args) {
+        goto exit;
+    }
+    if (!PyObject_TypeCheck(args[0], &PyType_Type)) {
+        _PyArg_BadArgument("_set_parameter_types", "argument 'c_parameter_type'", (&PyType_Type)->tp_name, args[0]);
+        goto exit;
+    }
+    c_parameter_type = args[0];
+    if (!PyObject_TypeCheck(args[1], &PyType_Type)) {
+        _PyArg_BadArgument("_set_parameter_types", "argument 'd_parameter_type'", (&PyType_Type)->tp_name, args[1]);
+        goto exit;
+    }
+    d_parameter_type = args[1];
+    return_value = _zstd__set_parameter_types_impl(module, c_parameter_type, d_parameter_type);
+
+exit:
+    return return_value;
+}
+/*[clinic end generated code: output=189c462236a7096c input=a9049054013a1b77]*/