blob: 72ca0767b74c17bfb4a06a4ab144c51a43592717 [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 Rossumd624f182006-04-24 13:47:05 +000024 char *ob_bytes;
Guido van Rossum4dfe8a12006-04-22 23:28:04 +000025} PyBytesObject;
26
27/* Type object */
28PyAPI_DATA(PyTypeObject) PyBytes_Type;
29
30/* Type check macros */
31#define PyBytes_Check(self) PyObject_TypeCheck(self, &PyBytes_Type)
32#define PyBytes_CheckExact(self) ((self)->ob_type == &PyBytes_Type)
33
34/* Direct API functions */
Guido van Rossumd624f182006-04-24 13:47:05 +000035PyAPI_FUNC(PyObject *) PyBytes_FromObject(PyObject *);
Guido van Rossum4dfe8a12006-04-22 23:28:04 +000036PyAPI_FUNC(PyObject *) PyBytes_FromStringAndSize(const char *, Py_ssize_t);
37PyAPI_FUNC(Py_ssize_t) PyBytes_Size(PyObject *);
38PyAPI_FUNC(char *) PyBytes_AsString(PyObject *);
39PyAPI_FUNC(int) PyBytes_Resize(PyObject *, Py_ssize_t);
40
41/* Macros, trading safety for speed */
Guido van Rossumd624f182006-04-24 13:47:05 +000042#define PyBytes_AS_STRING(self) (((PyBytesObject *)(self))->ob_bytes)
Guido van Rossum4dfe8a12006-04-22 23:28:04 +000043#define PyBytes_GET_SIZE(self) (((PyBytesObject *)(self))->ob_size)
44
45#ifdef __cplusplus
46}
47#endif
48#endif /* !Py_BYTESOBJECT_H */