1 2 /* Bytes (String) object interface */ 3 4 #ifndef Py_BYTESOBJECT_H 5 #define Py_BYTESOBJECT_H 6 #ifdef __cplusplus 7 extern "C" { 8 #endif 9 10 #include <stdarg.h> 11 12 /* 13 Type PyBytesObject represents a character string. An extra zero byte is 14 reserved at the end to ensure it is zero-terminated, but a size is 15 present so strings with null bytes in them can be represented. This 16 is an immutable object type. 17 18 There are functions to create new string objects, to test 19 an object for string-ness, and to get the 20 string value. The latter function returns a null pointer 21 if the object is not of the proper type. 22 There is a variant that takes an explicit size as well as a 23 variant that assumes a zero-terminated string. Note that none of the 24 functions should be applied to nil objects. 25 */ 26 27 /* Caching the hash (ob_shash) saves recalculation of a string's hash value. 28 This significantly speeds up dict lookups. */ 29 30 PyAPI_DATA(PyTypeObject) PyBytes_Type; 31 PyAPI_DATA(PyTypeObject) PyBytesIter_Type; 32 33 #define PyBytes_Check(op) \ 34 PyType_FastSubclass(Py_TYPE(op), Py_TPFLAGS_BYTES_SUBCLASS) 35 #define PyBytes_CheckExact(op) Py_IS_TYPE(op, &PyBytes_Type) 36 37 PyAPI_FUNC(PyObject *) PyBytes_FromStringAndSize(const char *, Py_ssize_t); 38 PyAPI_FUNC(PyObject *) PyBytes_FromString(const char *); 39 PyAPI_FUNC(PyObject *) PyBytes_FromObject(PyObject *); 40 PyAPI_FUNC(PyObject *) PyBytes_FromFormatV(const char*, va_list) 41 Py_GCC_ATTRIBUTE((format(printf, 1, 0))); 42 PyAPI_FUNC(PyObject *) PyBytes_FromFormat(const char*, ...) 43 Py_GCC_ATTRIBUTE((format(printf, 1, 2))); 44 PyAPI_FUNC(Py_ssize_t) PyBytes_Size(PyObject *); 45 PyAPI_FUNC(char *) PyBytes_AsString(PyObject *); 46 PyAPI_FUNC(PyObject *) PyBytes_Repr(PyObject *, int); 47 PyAPI_FUNC(void) PyBytes_Concat(PyObject **, PyObject *); 48 PyAPI_FUNC(void) PyBytes_ConcatAndDel(PyObject **, PyObject *); 49 PyAPI_FUNC(PyObject *) PyBytes_DecodeEscape(const char *, Py_ssize_t, 50 const char *, Py_ssize_t, 51 const char *); 52 53 /* Provides access to the internal data buffer and size of a string 54 object or the default encoded version of a Unicode object. Passing 55 NULL as *len parameter will force the string buffer to be 56 0-terminated (passing a string with embedded NULL characters will 57 cause an exception). */ 58 PyAPI_FUNC(int) PyBytes_AsStringAndSize( 59 PyObject *obj, /* string or Unicode object */ 60 char **s, /* pointer to buffer variable */ 61 Py_ssize_t *len /* pointer to length variable or NULL 62 (only possible for 0-terminated 63 strings) */ 64 ); 65 66 /* Flags used by string formatting */ 67 #define F_LJUST (1<<0) 68 #define F_SIGN (1<<1) 69 #define F_BLANK (1<<2) 70 #define F_ALT (1<<3) 71 #define F_ZERO (1<<4) 72 73 #ifndef Py_LIMITED_API 74 # define Py_CPYTHON_BYTESOBJECT_H 75 # include "cpython/bytesobject.h" 76 # undef Py_CPYTHON_BYTESOBJECT_H 77 #endif 78 79 #ifdef __cplusplus 80 } 81 #endif 82 #endif /* !Py_BYTESOBJECT_H */ 83