134 lines
4.5 KiB
C
134 lines
4.5 KiB
C
#ifndef Py_CPYTHON_BYTESOBJECT_H
|
|
# error "this header file must not be included directly"
|
|
#endif
|
|
|
|
typedef struct {
|
|
PyObject_VAR_HEAD
|
|
Py_DEPRECATED(3.11) Py_hash_t ob_shash;
|
|
char ob_sval[1];
|
|
|
|
/* Invariants:
|
|
* ob_sval contains space for 'ob_size+1' elements.
|
|
* ob_sval[ob_size] == 0.
|
|
* ob_shash is the hash of the byte string or -1 if not computed yet.
|
|
*/
|
|
} PyBytesObject;
|
|
|
|
PyAPI_FUNC(int) _PyBytes_Resize(PyObject **, Py_ssize_t);
|
|
PyAPI_FUNC(PyObject*) _PyBytes_FormatEx(
|
|
const char *format,
|
|
Py_ssize_t format_len,
|
|
PyObject *args,
|
|
int use_bytearray);
|
|
PyAPI_FUNC(PyObject*) _PyBytes_FromHex(
|
|
PyObject *string,
|
|
int use_bytearray);
|
|
|
|
/* Helper for PyBytes_DecodeEscape that detects invalid escape chars. */
|
|
PyAPI_FUNC(PyObject *) _PyBytes_DecodeEscape(const char *, Py_ssize_t,
|
|
const char *, const char **);
|
|
|
|
/* Macros and static inline functions, trading safety for speed */
|
|
#define _PyBytes_CAST(op) \
|
|
(assert(PyBytes_Check(op)), _Py_CAST(PyBytesObject*, op))
|
|
|
|
static inline char* PyBytes_AS_STRING(PyObject *op)
|
|
{
|
|
return _PyBytes_CAST(op)->ob_sval;
|
|
}
|
|
#if !defined(Py_LIMITED_API) || Py_LIMITED_API+0 < 0x030b0000
|
|
# define PyBytes_AS_STRING(op) PyBytes_AS_STRING(_PyObject_CAST(op))
|
|
#endif
|
|
|
|
static inline Py_ssize_t PyBytes_GET_SIZE(PyObject *op) {
|
|
PyBytesObject *self = _PyBytes_CAST(op);
|
|
return Py_SIZE(self);
|
|
}
|
|
#if !defined(Py_LIMITED_API) || Py_LIMITED_API+0 < 0x030b0000
|
|
# define PyBytes_GET_SIZE(self) PyBytes_GET_SIZE(_PyObject_CAST(self))
|
|
#endif
|
|
|
|
/* _PyBytes_Join(sep, x) is like sep.join(x). sep must be PyBytesObject*,
|
|
x must be an iterable object. */
|
|
PyAPI_FUNC(PyObject *) _PyBytes_Join(PyObject *sep, PyObject *x);
|
|
|
|
|
|
/* The _PyBytesWriter structure is big: it contains an embedded "stack buffer".
|
|
A _PyBytesWriter variable must be declared at the end of variables in a
|
|
function to optimize the memory allocation on the stack. */
|
|
typedef struct {
|
|
/* bytes, bytearray or NULL (when the small buffer is used) */
|
|
PyObject *buffer;
|
|
|
|
/* Number of allocated size. */
|
|
Py_ssize_t allocated;
|
|
|
|
/* Minimum number of allocated bytes,
|
|
incremented by _PyBytesWriter_Prepare() */
|
|
Py_ssize_t min_size;
|
|
|
|
/* If non-zero, use a bytearray instead of a bytes object for buffer. */
|
|
int use_bytearray;
|
|
|
|
/* If non-zero, overallocate the buffer (default: 0).
|
|
This flag must be zero if use_bytearray is non-zero. */
|
|
int overallocate;
|
|
|
|
/* Stack buffer */
|
|
int use_small_buffer;
|
|
char small_buffer[512];
|
|
} _PyBytesWriter;
|
|
|
|
/* Initialize a bytes writer
|
|
|
|
By default, the overallocation is disabled. Set the overallocate attribute
|
|
to control the allocation of the buffer. */
|
|
PyAPI_FUNC(void) _PyBytesWriter_Init(_PyBytesWriter *writer);
|
|
|
|
/* Get the buffer content and reset the writer.
|
|
Return a bytes object, or a bytearray object if use_bytearray is non-zero.
|
|
Raise an exception and return NULL on error. */
|
|
PyAPI_FUNC(PyObject *) _PyBytesWriter_Finish(_PyBytesWriter *writer,
|
|
void *str);
|
|
|
|
/* Deallocate memory of a writer (clear its internal buffer). */
|
|
PyAPI_FUNC(void) _PyBytesWriter_Dealloc(_PyBytesWriter *writer);
|
|
|
|
/* Allocate the buffer to write size bytes.
|
|
Return the pointer to the beginning of buffer data.
|
|
Raise an exception and return NULL on error. */
|
|
PyAPI_FUNC(void*) _PyBytesWriter_Alloc(_PyBytesWriter *writer,
|
|
Py_ssize_t size);
|
|
|
|
/* Ensure that the buffer is large enough to write *size* bytes.
|
|
Add size to the writer minimum size (min_size attribute).
|
|
|
|
str is the current pointer inside the buffer.
|
|
Return the updated current pointer inside the buffer.
|
|
Raise an exception and return NULL on error. */
|
|
PyAPI_FUNC(void*) _PyBytesWriter_Prepare(_PyBytesWriter *writer,
|
|
void *str,
|
|
Py_ssize_t size);
|
|
|
|
/* Resize the buffer to make it larger.
|
|
The new buffer may be larger than size bytes because of overallocation.
|
|
Return the updated current pointer inside the buffer.
|
|
Raise an exception and return NULL on error.
|
|
|
|
Note: size must be greater than the number of allocated bytes in the writer.
|
|
|
|
This function doesn't use the writer minimum size (min_size attribute).
|
|
|
|
See also _PyBytesWriter_Prepare().
|
|
*/
|
|
PyAPI_FUNC(void*) _PyBytesWriter_Resize(_PyBytesWriter *writer,
|
|
void *str,
|
|
Py_ssize_t size);
|
|
|
|
/* Write bytes.
|
|
Raise an exception and return NULL on error. */
|
|
PyAPI_FUNC(void*) _PyBytesWriter_WriteBytes(_PyBytesWriter *writer,
|
|
void *str,
|
|
const void *bytes,
|
|
Py_ssize_t size);
|