blob: bc385c1dd707da5b7fcffbd0f204c4b2a1305fb6 [file] [log] [blame]
Guido van Rossum4dfe8a12006-04-22 23:28:04 +00001/* Bytes object interface */
2
3#ifndef Py_BYTESOBJECT_H
4#define Py_BYTESOBJECT_H
5#ifdef __cplusplus
6extern "C" {
7#endif
8
9#include <stdarg.h>
10
11/* Type PyBytesObject represents a mutable array of bytes.
12 * The Python API is that of a sequence;
13 * the bytes are mapped to ints in [0, 256).
14 * Bytes are not characters; they may be used to encode characters.
15 * The only way to go between bytes and str/unicode is via encoding
16 * and decoding.
17 * For the concenience of C programmers, the bytes type is considered
18 * to contain a char pointer, not an unsigned char pointer.
19 */
20
21/* Object layout */
22typedef struct {
23 PyObject_VAR_HEAD
Guido van Rossuma0867f72006-05-05 04:34:18 +000024 Py_ssize_t ob_alloc; /* How many bytes allocated */
Guido van Rossumd624f182006-04-24 13:47:05 +000025 char *ob_bytes;
Guido van Rossum4dfe8a12006-04-22 23:28:04 +000026} PyBytesObject;
27
28/* Type object */
29PyAPI_DATA(PyTypeObject) PyBytes_Type;
30
31/* Type check macros */
32#define PyBytes_Check(self) PyObject_TypeCheck(self, &PyBytes_Type)
33#define PyBytes_CheckExact(self) ((self)->ob_type == &PyBytes_Type)
34
35/* Direct API functions */
Guido van Rossumd624f182006-04-24 13:47:05 +000036PyAPI_FUNC(PyObject *) PyBytes_FromObject(PyObject *);
Guido van Rossumad7d8d12007-04-13 01:39:34 +000037PyAPI_FUNC(PyObject *) PyBytes_Concat(PyObject *, PyObject *);
Guido van Rossum4dfe8a12006-04-22 23:28:04 +000038PyAPI_FUNC(PyObject *) PyBytes_FromStringAndSize(const char *, Py_ssize_t);
39PyAPI_FUNC(Py_ssize_t) PyBytes_Size(PyObject *);
40PyAPI_FUNC(char *) PyBytes_AsString(PyObject *);
41PyAPI_FUNC(int) PyBytes_Resize(PyObject *, Py_ssize_t);
42
43/* Macros, trading safety for speed */
Guido van Rossumd624f182006-04-24 13:47:05 +000044#define PyBytes_AS_STRING(self) (((PyBytesObject *)(self))->ob_bytes)
Guido van Rossum4dfe8a12006-04-22 23:28:04 +000045#define PyBytes_GET_SIZE(self) (((PyBytesObject *)(self))->ob_size)
46
47#ifdef __cplusplus
48}
49#endif
50#endif /* !Py_BYTESOBJECT_H */