File: python-lz4f.h

package info (click to toggle)
lz4tools 1.3.1.1-1.1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, bullseye, sid
  • size: 380 kB
  • sloc: ansic: 3,988; python: 377; makefile: 8
file content (88 lines) | stat: -rw-r--r-- 4,955 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
/*
 * Copyright (c) 2014, Christoper Jackson
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 *
 * 2. 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.
 *
 * 3. Neither the name of Christoper Jackson 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.
 */

#include "Python.h"

static PyObject *py_lz4f_createCompCtx(PyObject *self, PyObject *args);
static PyObject *py_lz4f_compressFrame(PyObject *self, PyObject *args);
static PyObject *py_lz4f_compressBegin(PyObject *self, PyObject *args);
static PyObject *py_lz4f_compressUpdate(PyObject *self, PyObject *args);
static PyObject *py_lz4f_compressEnd(PyObject *self, PyObject *args);
static PyObject *py_lz4f_freeCompCtx(PyObject *self, PyObject *args);
static PyObject *py_lz4f_createDecompCtx(PyObject *self, PyObject *args);
static PyObject *py_lz4f_freeDecompCtx(PyObject *self, PyObject *args);
static PyObject *py_lz4f_getFrameInfo(PyObject *self, PyObject *args);
static PyObject *py_lz4f_decompress(PyObject *self, PyObject *args, PyObject *keywds);
static PyObject *py_lz4f_disableChecksum(PyObject *self, PyObject *args);

PyMODINIT_FUNC initlz4f(void);

#define CTX_DOCSTRING    "context, to be used with all respective functions."
#define CCCTX_DOCSTRING  "Generates a compression " CTX_DOCSTRING
#define COMPF_DOCSTRING  "Accepts a string, and compresses the string in one go, returning the compressed string. \n" \
                         "This generates a header, compressed data and endmark, making the result ready to be written to file."
#define COMPB_DOCSTRING  "Accepts a compression context as a PyCObject. Returns a frame header, based on context variables."
#define COMPU_DOCSTRING  "Accepts a string, and a compression context. Returns the string as a compressed block, if the\n" \
                         "block is filled. If not, it will return a blank string and hold the compressed data until the\n" \
                         "block is filled, flush is called or compressEnd is called."
#define COMPE_DOCSTRING  "Accepts a compression context as a PyCObject. Flushed the holding buffer, applies endmark and if\n" \
                         "applicable will generate a checksum. Returns a string."
#define FCCTX_DOCSTRING  "Frees a compression context, passed as a PyCObject."
#define CDCTX_DOCSTRING  "Generates a decompression " CTX_DOCSTRING
#define FDCTX_DOCSTRING  "Frees a decompression context, passed as a PyCObject."
#define GETFI_DOCSTRING  "Accepts a string, which should be the first 7 bytes of a lz4 file, the 'header,'  and a dCtx PyCObject.\n" \
                         "Returns a dictionary object containing the frame info for the given header."
#define DCHKS_DOCSTRING  "Accepts a dCtx as a PyCObject. Disables the checksum portion of a the frameInfo struct in the dCtx. \n" \
                         "This is required for arbitrary seeking of a lz4 file. Without this, decompress will error out if blocks\n" \
                         "are read out of order."
#define DCOMP_DOCSTRING  "Decompress string, returning the uncompressed data.\nRaises an exception if any error occurs."

#if defined(_WIN32) && defined(_MSC_VER)
# define inline __inline
# if _MSC_VER >= 1600
#  include <stdint.h>
# else /* _MSC_VER >= 1600 */
   typedef signed char       int8_t;
   typedef signed short      int16_t;
   typedef signed int        int32_t;
   typedef unsigned char     uint8_t;
   typedef unsigned short    uint16_t;
   typedef unsigned int      uint32_t;
# endif /* _MSC_VER >= 1600 */
#endif

#if defined(__SUNPRO_C) || defined(__hpux) || defined(_AIX)
#define inline
#endif

#ifdef __linux
#define inline __inline
#endif