cpython-lru_cache-weakref: Include/stringobject.h annotate

annotate Include/stringobject.h @ 42334:e70cdce0e8b2

Merged revisions 56467-56482 via svnmerge from svn+ssh://pythondev@svn.python.org/python/branches/p3yk ................ r56477 | martin.v.loewis | 2007-07-21 09:04:38 +0200 (Sa, 21 Jul 2007) | 11 lines Merged revisions 56466-56476 via svnmerge from svn+ssh://pythondev@svn.python.org/python/trunk ........ r56476 | martin.v.loewis | 2007-07-21 08:55:02 +0200 (Sa, 21 Jul 2007) | 4 lines PEP 3123: Provide forward compatibility with Python 3.0, while keeping backwards compatibility. Add Py_Refcnt, Py_Type, Py_Size, and PyVarObject_HEAD_INIT. ........ ................ r56478 | martin.v.loewis | 2007-07-21 09:47:23 +0200 (Sa, 21 Jul 2007) | 2 lines PEP 3123: Use proper C inheritance for PyObject. ................ r56479 | martin.v.loewis | 2007-07-21 10:06:55 +0200 (Sa, 21 Jul 2007) | 3 lines Add longintrepr.h to Python.h, so that the compiler can see that PyFalse is really some kind of PyObject*. ................ r56480 | martin.v.loewis | 2007-07-21 10:47:18 +0200 (Sa, 21 Jul 2007) | 2 lines Qualify SHIFT, MASK, BASE. ................ r56482 | martin.v.loewis | 2007-07-21 19:10:57 +0200 (Sa, 21 Jul 2007) | 2 lines Correctly refer to _ob_next. ................

author	Martin v. Löwis <martin@v.loewis.de>
date	Sat, 21 Jul 2007 17:22:18 +0000
parents	cd125fe83051
children	c8b850b5a066

rev	line source
145 853b736a6a9e Added copyright notice. Guido van Rossum <guido@python.org> parents: 6 diff changeset	1
6 fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	2 /* String object interface */
fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	3
13445 091ca6b9348f ANSI-fication and Py_PROTO extermination. Fred Drake <fdrake@acm.org> parents: 13376 diff changeset	4 #ifndef Py_STRINGOBJECT_H
091ca6b9348f ANSI-fication and Py_PROTO extermination. Fred Drake <fdrake@acm.org> parents: 13376 diff changeset	5 #define Py_STRINGOBJECT_H
091ca6b9348f ANSI-fication and Py_PROTO extermination. Fred Drake <fdrake@acm.org> parents: 13376 diff changeset	6 #ifdef __cplusplus
091ca6b9348f ANSI-fication and Py_PROTO extermination. Fred Drake <fdrake@acm.org> parents: 13376 diff changeset	7 extern "C" {
091ca6b9348f ANSI-fication and Py_PROTO extermination. Fred Drake <fdrake@acm.org> parents: 13376 diff changeset	8 #endif
091ca6b9348f ANSI-fication and Py_PROTO extermination. Fred Drake <fdrake@acm.org> parents: 13376 diff changeset	9
19475 bc63afc701ef PyString_FromFormat() and PyString_FromFormatV(): Largely ripped from Barry Warsaw <barry@python.org> parents: 18129 diff changeset	10 #include <stdarg.h>
bc63afc701ef PyString_FromFormat() and PyString_FromFormatV(): Largely ripped from Barry Warsaw <barry@python.org> parents: 18129 diff changeset	11
6 fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	12 /*
2129 05360cd616ae The great renaming, phase two: all header files have been updated to Guido van Rossum <guido@python.org> parents: 2058 diff changeset	13 Type PyStringObject represents a character string. An extra zero byte is
6 fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	14 reserved at the end to ensure it is zero-terminated, but a size is
fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	15 present so strings with null bytes in them can be represented. This
fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	16 is an immutable object type.
fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	17
fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	18 There are functions to create new string objects, to test
fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	19 an object for string-ness, and to get the
fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	20 string value. The latter function returns a null pointer
fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	21 if the object is not of the proper type.
fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	22 There is a variant that takes an explicit size as well as a
fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	23 variant that assumes a zero-terminated string. Note that none of the
fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	24 functions should be applied to nil objects.
fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	25 */
fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	26
22651 f3a416b178c4 Remove the CACHE_HASH and INTERN_STRINGS preprocessor symbols. Tim Peters <tim.peters@gmail.com> parents: 20626 diff changeset	27 /* Caching the hash (ob_shash) saves recalculation of a string's hash value.
24901 bc660f73795c SF patch 576101, by Oren Tirosh: alternative implementation of Guido van Rossum <guido@python.org> parents: 24808 diff changeset	28 Interning strings (ob_sstate) tries to ensure that only one string
22651 f3a416b178c4 Remove the CACHE_HASH and INTERN_STRINGS preprocessor symbols. Tim Peters <tim.peters@gmail.com> parents: 20626 diff changeset	29 object with a given value exists, so equality tests can be one pointer
f3a416b178c4 Remove the CACHE_HASH and INTERN_STRINGS preprocessor symbols. Tim Peters <tim.peters@gmail.com> parents: 20626 diff changeset	30 comparison. This is generally restricted to strings that "look like"
40484 8565e3fea9b6 Patch #1601678: move intern() to sys.intern(). Georg Brandl <georg@python.org> parents: 36501 diff changeset	31 Python identifiers, although the sys.intern() function can be used to force
22651 f3a416b178c4 Remove the CACHE_HASH and INTERN_STRINGS preprocessor symbols. Tim Peters <tim.peters@gmail.com> parents: 20626 diff changeset	32 interning of any string.
f3a416b178c4 Remove the CACHE_HASH and INTERN_STRINGS preprocessor symbols. Tim Peters <tim.peters@gmail.com> parents: 20626 diff changeset	33 Together, these sped the interpreter by up to 20%. */
3833 f0efff28a24d Turn on CACHE_HASH, for 2% speedier dict lookups Guido van Rossum <guido@python.org> parents: 2436 diff changeset	34
6 fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	35 typedef struct {
13445 091ca6b9348f ANSI-fication and Py_PROTO extermination. Fred Drake <fdrake@acm.org> parents: 13376 diff changeset	36 PyObject_VAR_HEAD
091ca6b9348f ANSI-fication and Py_PROTO extermination. Fred Drake <fdrake@acm.org> parents: 13376 diff changeset	37 long ob_shash;
24901 bc660f73795c SF patch 576101, by Oren Tirosh: alternative implementation of Guido van Rossum <guido@python.org> parents: 24808 diff changeset	38 int ob_sstate;
13445 091ca6b9348f ANSI-fication and Py_PROTO extermination. Fred Drake <fdrake@acm.org> parents: 13376 diff changeset	39 char ob_sval[1];
33856 60c60dc75c77 Wrote down the invariants of some common objects whose structure is Armin Rigo <arigo@tunes.org> parents: 29726 diff changeset	40
60c60dc75c77 Wrote down the invariants of some common objects whose structure is Armin Rigo <arigo@tunes.org> parents: 29726 diff changeset	41 /* Invariants:
60c60dc75c77 Wrote down the invariants of some common objects whose structure is Armin Rigo <arigo@tunes.org> parents: 29726 diff changeset	42 * ob_sval contains space for 'ob_size+1' elements.
60c60dc75c77 Wrote down the invariants of some common objects whose structure is Armin Rigo <arigo@tunes.org> parents: 29726 diff changeset	43 * ob_sval[ob_size] == 0.
60c60dc75c77 Wrote down the invariants of some common objects whose structure is Armin Rigo <arigo@tunes.org> parents: 29726 diff changeset	44 * ob_shash is the hash of the string or -1 if not computed yet.
60c60dc75c77 Wrote down the invariants of some common objects whose structure is Armin Rigo <arigo@tunes.org> parents: 29726 diff changeset	45 * ob_sstate != 0 iff the string object is in stringobject.c's
60c60dc75c77 Wrote down the invariants of some common objects whose structure is Armin Rigo <arigo@tunes.org> parents: 29726 diff changeset	46 * 'interned' dictionary; in this case the two references
60c60dc75c77 Wrote down the invariants of some common objects whose structure is Armin Rigo <arigo@tunes.org> parents: 29726 diff changeset	47 * from 'interned' to this object are not counted in ob_refcnt.
60c60dc75c77 Wrote down the invariants of some common objects whose structure is Armin Rigo <arigo@tunes.org> parents: 29726 diff changeset	48 */
2129 05360cd616ae The great renaming, phase two: all header files have been updated to Guido van Rossum <guido@python.org> parents: 2058 diff changeset	49 } PyStringObject;
6 fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	50
24752 c1eb668525e1 Excise DL_EXPORT from Include. Mark Hammond <mhammond@skippinet.com.au> parents: 23542 diff changeset	51 PyAPI_DATA(PyTypeObject) PyBaseString_Type;
c1eb668525e1 Excise DL_EXPORT from Include. Mark Hammond <mhammond@skippinet.com.au> parents: 23542 diff changeset	52 PyAPI_DATA(PyTypeObject) PyString_Type;
6 fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	53
40909 f2f0b41f270d Merged revisions 53875-53911 via svnmerge from Thomas Wouters <thomas@python.org> parents: 40484 diff changeset	54 #define PyString_Check(op) \
42334 e70cdce0e8b2 Merged revisions 56467-56482 via svnmerge from Martin v. Löwis <martin@v.loewis.de> parents: 42013 diff changeset	55 PyType_FastSubclass(Py_Type(op), Py_TPFLAGS_STRING_SUBCLASS)
e70cdce0e8b2 Merged revisions 56467-56482 via svnmerge from Martin v. Löwis <martin@v.loewis.de> parents: 42013 diff changeset	56 #define PyString_CheckExact(op) (Py_Type(op) == &PyString_Type)
6 fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	57
36501 7fdc639bc5b4 Merge ssize_t branch. Martin v. Löwis <martin@v.loewis.de> parents: 33856 diff changeset	58 PyAPI_FUNC(PyObject ) PyString_FromStringAndSize(const char , Py_ssize_t);
24752 c1eb668525e1 Excise DL_EXPORT from Include. Mark Hammond <mhammond@skippinet.com.au> parents: 23542 diff changeset	59 PyAPI_FUNC(PyObject ) PyString_FromString(const char );
c1eb668525e1 Excise DL_EXPORT from Include. Mark Hammond <mhammond@skippinet.com.au> parents: 23542 diff changeset	60 PyAPI_FUNC(PyObject ) PyString_FromFormatV(const char, va_list)
25276 6c21e95a4881 Use Py_GCC_ATTRIBUTE instead of __attribute__. Compilers other than GCC Neil Schemenauer <nascheme@enme.ucalgary.ca> parents: 24901 diff changeset	61 Py_GCC_ATTRIBUTE((format(printf, 1, 0)));
24752 c1eb668525e1 Excise DL_EXPORT from Include. Mark Hammond <mhammond@skippinet.com.au> parents: 23542 diff changeset	62 PyAPI_FUNC(PyObject ) PyString_FromFormat(const char, ...)
25276 6c21e95a4881 Use Py_GCC_ATTRIBUTE instead of __attribute__. Compilers other than GCC Neil Schemenauer <nascheme@enme.ucalgary.ca> parents: 24901 diff changeset	63 Py_GCC_ATTRIBUTE((format(printf, 1, 2)));
36501 7fdc639bc5b4 Merge ssize_t branch. Martin v. Löwis <martin@v.loewis.de> parents: 33856 diff changeset	64 PyAPI_FUNC(Py_ssize_t) PyString_Size(PyObject *);
24752 c1eb668525e1 Excise DL_EXPORT from Include. Mark Hammond <mhammond@skippinet.com.au> parents: 23542 diff changeset	65 PyAPI_FUNC(char ) PyString_AsString(PyObject );
24808 ab63af3ec349 Patch #505705: Remove eval in pickle and cPickle. Martin v. Löwis <martin@v.loewis.de> parents: 24752 diff changeset	66 PyAPI_FUNC(PyObject ) PyString_Repr(PyObject , int);
24752 c1eb668525e1 Excise DL_EXPORT from Include. Mark Hammond <mhammond@skippinet.com.au> parents: 23542 diff changeset	67 PyAPI_FUNC(void) PyString_Concat(PyObject *, PyObject );
c1eb668525e1 Excise DL_EXPORT from Include. Mark Hammond <mhammond@skippinet.com.au> parents: 23542 diff changeset	68 PyAPI_FUNC(void) PyString_ConcatAndDel(PyObject *, PyObject );
36501 7fdc639bc5b4 Merge ssize_t branch. Martin v. Löwis <martin@v.loewis.de> parents: 33856 diff changeset	69 PyAPI_FUNC(int) _PyString_Resize(PyObject **, Py_ssize_t);
24752 c1eb668525e1 Excise DL_EXPORT from Include. Mark Hammond <mhammond@skippinet.com.au> parents: 23542 diff changeset	70 PyAPI_FUNC(int) _PyString_Eq(PyObject , PyObject);
c1eb668525e1 Excise DL_EXPORT from Include. Mark Hammond <mhammond@skippinet.com.au> parents: 23542 diff changeset	71 PyAPI_FUNC(PyObject ) PyString_Format(PyObject , PyObject *);
c1eb668525e1 Excise DL_EXPORT from Include. Mark Hammond <mhammond@skippinet.com.au> parents: 23542 diff changeset	72 PyAPI_FUNC(PyObject ) _PyString_FormatLong(PyObject, int, int,
14713 58b832b8745e Derived from Martin's SF patch 110609: support unbounded ints in %d,i,u,x,X,o formats. Tim Peters <tim.peters@gmail.com> parents: 14696 diff changeset	73 int, char*, int);
36501 7fdc639bc5b4 Merge ssize_t branch. Martin v. Löwis <martin@v.loewis.de> parents: 33856 diff changeset	74 PyAPI_FUNC(PyObject ) PyString_DecodeEscape(const char , Py_ssize_t,
7fdc639bc5b4 Merge ssize_t branch. Martin v. Löwis <martin@v.loewis.de> parents: 33856 diff changeset	75 const char *, Py_ssize_t,
24808 ab63af3ec349 Patch #505705: Remove eval in pickle and cPickle. Martin v. Löwis <martin@v.loewis.de> parents: 24752 diff changeset	76 const char *);
6 fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	77
24752 c1eb668525e1 Excise DL_EXPORT from Include. Mark Hammond <mhammond@skippinet.com.au> parents: 23542 diff changeset	78 PyAPI_FUNC(void) PyString_InternInPlace(PyObject **);
24901 bc660f73795c SF patch 576101, by Oren Tirosh: alternative implementation of Guido van Rossum <guido@python.org> parents: 24808 diff changeset	79 PyAPI_FUNC(void) PyString_InternImmortal(PyObject **);
24752 c1eb668525e1 Excise DL_EXPORT from Include. Mark Hammond <mhammond@skippinet.com.au> parents: 23542 diff changeset	80 PyAPI_FUNC(PyObject ) PyString_InternFromString(const char );
c1eb668525e1 Excise DL_EXPORT from Include. Mark Hammond <mhammond@skippinet.com.au> parents: 23542 diff changeset	81 PyAPI_FUNC(void) _Py_ReleaseInternedStrings(void);
5003 65aace2012e5 Two speedup hacks. Caching the hash saves recalculation of a string's Guido van Rossum <guido@python.org> parents: 4897 diff changeset	82
24901 bc660f73795c SF patch 576101, by Oren Tirosh: alternative implementation of Guido van Rossum <guido@python.org> parents: 24808 diff changeset	83 /* Use only if you know it's a string */
bc660f73795c SF patch 576101, by Oren Tirosh: alternative implementation of Guido van Rossum <guido@python.org> parents: 24808 diff changeset	84 #define PyString_CHECK_INTERNED(op) (((PyStringObject *)(op))->ob_sstate)
bc660f73795c SF patch 576101, by Oren Tirosh: alternative implementation of Guido van Rossum <guido@python.org> parents: 24808 diff changeset	85
6 fc6fcd7df4f7 Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	86 /* Macro, trading safety for speed */
42013 cd125fe83051 Make identifiers str (not str8) objects throughout. Martin v. Löwis <martin@v.loewis.de> parents: 41876 diff changeset	87 #define PyString_AS_STRING(op) (assert(PyString_Check(op)),(((PyStringObject *)(op))->ob_sval))
cd125fe83051 Make identifiers str (not str8) objects throughout. Martin v. Löwis <martin@v.loewis.de> parents: 41876 diff changeset	88 #define PyString_GET_SIZE(op) (assert(PyString_Check(op)),(((PyStringObject *)(op))->ob_size))
1329 519c25039c6a * Added support for X11 modules. Guido van Rossum <guido@python.org> parents: 1252 diff changeset	89
18129 9d533ae574d2 SF bug 433228: repr(list) woes when len(list) big. Tim Peters <tim.peters@gmail.com> parents: 17964 diff changeset	90 /* _PyString_Join(sep, x) is like sep.join(x). sep must be PyStringObject*,
9d533ae574d2 SF bug 433228: repr(list) woes when len(list) big. Tim Peters <tim.peters@gmail.com> parents: 17964 diff changeset	91 x must be an iterable object. */
24752 c1eb668525e1 Excise DL_EXPORT from Include. Mark Hammond <mhammond@skippinet.com.au> parents: 23542 diff changeset	92 PyAPI_FUNC(PyObject ) _PyString_Join(PyObject sep, PyObject *x);
18129 9d533ae574d2 SF bug 433228: repr(list) woes when len(list) big. Tim Peters <tim.peters@gmail.com> parents: 17964 diff changeset	93
13376 bfe22cf6e770 Added prototypes for the new codec APIs for strings. These APIs Marc-André Lemburg <mal@egenix.com> parents: 13256 diff changeset	94 /* --- Generic Codecs ----------------------------------------------------- */
bfe22cf6e770 Added prototypes for the new codec APIs for strings. These APIs Marc-André Lemburg <mal@egenix.com> parents: 13256 diff changeset	95
17835 9ea87c0a7c04 This patch changes the way the string .encode() method works slightly Marc-André Lemburg <mal@egenix.com> parents: 16751 diff changeset	96 /* Create an object by decoding the encoded string s of the
13376 bfe22cf6e770 Added prototypes for the new codec APIs for strings. These APIs Marc-André Lemburg <mal@egenix.com> parents: 13256 diff changeset	97 given size. */
bfe22cf6e770 Added prototypes for the new codec APIs for strings. These APIs Marc-André Lemburg <mal@egenix.com> parents: 13256 diff changeset	98
24752 c1eb668525e1 Excise DL_EXPORT from Include. Mark Hammond <mhammond@skippinet.com.au> parents: 23542 diff changeset	99 PyAPI_FUNC(PyObject*) PyString_Decode(
13376 bfe22cf6e770 Added prototypes for the new codec APIs for strings. These APIs Marc-André Lemburg <mal@egenix.com> parents: 13256 diff changeset	100 const char s, / encoded string */
36501 7fdc639bc5b4 Merge ssize_t branch. Martin v. Löwis <martin@v.loewis.de> parents: 33856 diff changeset	101 Py_ssize_t size, /* size of buffer */
13376 bfe22cf6e770 Added prototypes for the new codec APIs for strings. These APIs Marc-André Lemburg <mal@egenix.com> parents: 13256 diff changeset	102 const char encoding, / encoding */
bfe22cf6e770 Added prototypes for the new codec APIs for strings. These APIs Marc-André Lemburg <mal@egenix.com> parents: 13256 diff changeset	103 const char errors / error handling */
bfe22cf6e770 Added prototypes for the new codec APIs for strings. These APIs Marc-André Lemburg <mal@egenix.com> parents: 13256 diff changeset	104 );
bfe22cf6e770 Added prototypes for the new codec APIs for strings. These APIs Marc-André Lemburg <mal@egenix.com> parents: 13256 diff changeset	105
bfe22cf6e770 Added prototypes for the new codec APIs for strings. These APIs Marc-André Lemburg <mal@egenix.com> parents: 13256 diff changeset	106 /* Encodes a char buffer of the given size and returns a
17835 9ea87c0a7c04 This patch changes the way the string .encode() method works slightly Marc-André Lemburg <mal@egenix.com> parents: 16751 diff changeset	107 Python object. */
13376 bfe22cf6e770 Added prototypes for the new codec APIs for strings. These APIs Marc-André Lemburg <mal@egenix.com> parents: 13256 diff changeset	108
24752 c1eb668525e1 Excise DL_EXPORT from Include. Mark Hammond <mhammond@skippinet.com.au> parents: 23542 diff changeset	109 PyAPI_FUNC(PyObject*) PyString_Encode(
13376 bfe22cf6e770 Added prototypes for the new codec APIs for strings. These APIs Marc-André Lemburg <mal@egenix.com> parents: 13256 diff changeset	110 const char s, / string char buffer */
36501 7fdc639bc5b4 Merge ssize_t branch. Martin v. Löwis <martin@v.loewis.de> parents: 33856 diff changeset	111 Py_ssize_t size, /* number of chars to encode */
13376 bfe22cf6e770 Added prototypes for the new codec APIs for strings. These APIs Marc-André Lemburg <mal@egenix.com> parents: 13256 diff changeset	112 const char encoding, / encoding */
bfe22cf6e770 Added prototypes for the new codec APIs for strings. These APIs Marc-André Lemburg <mal@egenix.com> parents: 13256 diff changeset	113 const char errors / error handling */
bfe22cf6e770 Added prototypes for the new codec APIs for strings. These APIs Marc-André Lemburg <mal@egenix.com> parents: 13256 diff changeset	114 );
bfe22cf6e770 Added prototypes for the new codec APIs for strings. These APIs Marc-André Lemburg <mal@egenix.com> parents: 13256 diff changeset	115
17835 9ea87c0a7c04 This patch changes the way the string .encode() method works slightly Marc-André Lemburg <mal@egenix.com> parents: 16751 diff changeset	116 /* Encodes a string object and returns the result as Python
13376 bfe22cf6e770 Added prototypes for the new codec APIs for strings. These APIs Marc-André Lemburg <mal@egenix.com> parents: 13256 diff changeset	117 object. */
bfe22cf6e770 Added prototypes for the new codec APIs for strings. These APIs Marc-André Lemburg <mal@egenix.com> parents: 13256 diff changeset	118
24752 c1eb668525e1 Excise DL_EXPORT from Include. Mark Hammond <mhammond@skippinet.com.au> parents: 23542 diff changeset	119 PyAPI_FUNC(PyObject*) PyString_AsEncodedObject(
17835 9ea87c0a7c04 This patch changes the way the string .encode() method works slightly Marc-André Lemburg <mal@egenix.com> parents: 16751 diff changeset	120 PyObject str, / string object */
9ea87c0a7c04 This patch changes the way the string .encode() method works slightly Marc-André Lemburg <mal@egenix.com> parents: 16751 diff changeset	121 const char encoding, / encoding */
9ea87c0a7c04 This patch changes the way the string .encode() method works slightly Marc-André Lemburg <mal@egenix.com> parents: 16751 diff changeset	122 const char errors / error handling */
9ea87c0a7c04 This patch changes the way the string .encode() method works slightly Marc-André Lemburg <mal@egenix.com> parents: 16751 diff changeset	123 );
9ea87c0a7c04 This patch changes the way the string .encode() method works slightly Marc-André Lemburg <mal@egenix.com> parents: 16751 diff changeset	124
9ea87c0a7c04 This patch changes the way the string .encode() method works slightly Marc-André Lemburg <mal@egenix.com> parents: 16751 diff changeset	125 /* Encodes a string object and returns the result as Python string
9ea87c0a7c04 This patch changes the way the string .encode() method works slightly Marc-André Lemburg <mal@egenix.com> parents: 16751 diff changeset	126 object.
9ea87c0a7c04 This patch changes the way the string .encode() method works slightly Marc-André Lemburg <mal@egenix.com> parents: 16751 diff changeset	127
9ea87c0a7c04 This patch changes the way the string .encode() method works slightly Marc-André Lemburg <mal@egenix.com> parents: 16751 diff changeset	128 If the codec returns an Unicode object, the object is converted
9ea87c0a7c04 This patch changes the way the string .encode() method works slightly Marc-André Lemburg <mal@egenix.com> parents: 16751 diff changeset	129 back to a string using the default encoding.
9ea87c0a7c04 This patch changes the way the string .encode() method works slightly Marc-André Lemburg <mal@egenix.com> parents: 16751 diff changeset	130
9ea87c0a7c04 This patch changes the way the string .encode() method works slightly Marc-André Lemburg <mal@egenix.com> parents: 16751 diff changeset	131 DEPRECATED - use PyString_AsEncodedObject() instead. */
9ea87c0a7c04 This patch changes the way the string .encode() method works slightly Marc-André Lemburg <mal@egenix.com> parents: 16751 diff changeset	132
24752 c1eb668525e1 Excise DL_EXPORT from Include. Mark Hammond <mhammond@skippinet.com.au> parents: 23542 diff changeset	133 PyAPI_FUNC(PyObject*) PyString_AsEncodedString(
13376 bfe22cf6e770 Added prototypes for the new codec APIs for strings. These APIs Marc-André Lemburg <mal@egenix.com> parents: 13256 diff changeset	134 PyObject str, / string object */
bfe22cf6e770 Added prototypes for the new codec APIs for strings. These APIs Marc-André Lemburg <mal@egenix.com> parents: 13256 diff changeset	135 const char encoding, / encoding */
bfe22cf6e770 Added prototypes for the new codec APIs for strings. These APIs Marc-André Lemburg <mal@egenix.com> parents: 13256 diff changeset	136 const char errors / error handling */
bfe22cf6e770 Added prototypes for the new codec APIs for strings. These APIs Marc-André Lemburg <mal@egenix.com> parents: 13256 diff changeset	137 );
bfe22cf6e770 Added prototypes for the new codec APIs for strings. These APIs Marc-André Lemburg <mal@egenix.com> parents: 13256 diff changeset	138
17835 9ea87c0a7c04 This patch changes the way the string .encode() method works slightly Marc-André Lemburg <mal@egenix.com> parents: 16751 diff changeset	139 /* Decodes a string object and returns the result as Python
9ea87c0a7c04 This patch changes the way the string .encode() method works slightly Marc-André Lemburg <mal@egenix.com> parents: 16751 diff changeset	140 object. */
9ea87c0a7c04 This patch changes the way the string .encode() method works slightly Marc-André Lemburg <mal@egenix.com> parents: 16751 diff changeset	141
24752 c1eb668525e1 Excise DL_EXPORT from Include. Mark Hammond <mhammond@skippinet.com.au> parents: 23542 diff changeset	142 PyAPI_FUNC(PyObject*) PyString_AsDecodedObject(
17835 9ea87c0a7c04 This patch changes the way the string .encode() method works slightly Marc-André Lemburg <mal@egenix.com> parents: 16751 diff changeset	143 PyObject str, / string object */
9ea87c0a7c04 This patch changes the way the string .encode() method works slightly Marc-André Lemburg <mal@egenix.com> parents: 16751 diff changeset	144 const char encoding, / encoding */
9ea87c0a7c04 This patch changes the way the string .encode() method works slightly Marc-André Lemburg <mal@egenix.com> parents: 16751 diff changeset	145 const char errors / error handling */
9ea87c0a7c04 This patch changes the way the string .encode() method works slightly Marc-André Lemburg <mal@egenix.com> parents: 16751 diff changeset	146 );
9ea87c0a7c04 This patch changes the way the string .encode() method works slightly Marc-André Lemburg <mal@egenix.com> parents: 16751 diff changeset	147
9ea87c0a7c04 This patch changes the way the string .encode() method works slightly Marc-André Lemburg <mal@egenix.com> parents: 16751 diff changeset	148 /* Decodes a string object and returns the result as Python string
9ea87c0a7c04 This patch changes the way the string .encode() method works slightly Marc-André Lemburg <mal@egenix.com> parents: 16751 diff changeset	149 object.
9ea87c0a7c04 This patch changes the way the string .encode() method works slightly Marc-André Lemburg <mal@egenix.com> parents: 16751 diff changeset	150
9ea87c0a7c04 This patch changes the way the string .encode() method works slightly Marc-André Lemburg <mal@egenix.com> parents: 16751 diff changeset	151 If the codec returns an Unicode object, the object is converted
9ea87c0a7c04 This patch changes the way the string .encode() method works slightly Marc-André Lemburg <mal@egenix.com> parents: 16751 diff changeset	152 back to a string using the default encoding.
9ea87c0a7c04 This patch changes the way the string .encode() method works slightly Marc-André Lemburg <mal@egenix.com> parents: 16751 diff changeset	153
9ea87c0a7c04 This patch changes the way the string .encode() method works slightly Marc-André Lemburg <mal@egenix.com> parents: 16751 diff changeset	154 DEPRECATED - use PyString_AsDecodedObject() instead. */
9ea87c0a7c04 This patch changes the way the string .encode() method works slightly Marc-André Lemburg <mal@egenix.com> parents: 16751 diff changeset	155
24752 c1eb668525e1 Excise DL_EXPORT from Include. Mark Hammond <mhammond@skippinet.com.au> parents: 23542 diff changeset	156 PyAPI_FUNC(PyObject*) PyString_AsDecodedString(
17835 9ea87c0a7c04 This patch changes the way the string .encode() method works slightly Marc-André Lemburg <mal@egenix.com> parents: 16751 diff changeset	157 PyObject str, / string object */
9ea87c0a7c04 This patch changes the way the string .encode() method works slightly Marc-André Lemburg <mal@egenix.com> parents: 16751 diff changeset	158 const char encoding, / encoding */
9ea87c0a7c04 This patch changes the way the string .encode() method works slightly Marc-André Lemburg <mal@egenix.com> parents: 16751 diff changeset	159 const char errors / error handling */
9ea87c0a7c04 This patch changes the way the string .encode() method works slightly Marc-André Lemburg <mal@egenix.com> parents: 16751 diff changeset	160 );
9ea87c0a7c04 This patch changes the way the string .encode() method works slightly Marc-André Lemburg <mal@egenix.com> parents: 16751 diff changeset	161
14696 85038a024b19 This patch adds a new Python C API called PyString_AsStringAndSize() Marc-André Lemburg <mal@egenix.com> parents: 14375 diff changeset	162 /* Provides access to the internal data buffer and size of a string
85038a024b19 This patch adds a new Python C API called PyString_AsStringAndSize() Marc-André Lemburg <mal@egenix.com> parents: 14375 diff changeset	163 object or the default encoded version of an Unicode object. Passing
85038a024b19 This patch adds a new Python C API called PyString_AsStringAndSize() Marc-André Lemburg <mal@egenix.com> parents: 14375 diff changeset	164 NULL as *len parameter will force the string buffer to be
85038a024b19 This patch adds a new Python C API called PyString_AsStringAndSize() Marc-André Lemburg <mal@egenix.com> parents: 14375 diff changeset	165 0-terminated (passing a string with embedded NULL characters will
85038a024b19 This patch adds a new Python C API called PyString_AsStringAndSize() Marc-André Lemburg <mal@egenix.com> parents: 14375 diff changeset	166 cause an exception). */
85038a024b19 This patch adds a new Python C API called PyString_AsStringAndSize() Marc-André Lemburg <mal@egenix.com> parents: 14375 diff changeset	167
24752 c1eb668525e1 Excise DL_EXPORT from Include. Mark Hammond <mhammond@skippinet.com.au> parents: 23542 diff changeset	168 PyAPI_FUNC(int) PyString_AsStringAndSize(
14696 85038a024b19 This patch adds a new Python C API called PyString_AsStringAndSize() Marc-André Lemburg <mal@egenix.com> parents: 14375 diff changeset	169 register PyObject obj, / string or Unicode object */
85038a024b19 This patch adds a new Python C API called PyString_AsStringAndSize() Marc-André Lemburg <mal@egenix.com> parents: 14375 diff changeset	170 register char *s, / pointer to buffer variable */
36501 7fdc639bc5b4 Merge ssize_t branch. Martin v. Löwis <martin@v.loewis.de> parents: 33856 diff changeset	171 register Py_ssize_t len / pointer to length variable or NULL
14696 85038a024b19 This patch adds a new Python C API called PyString_AsStringAndSize() Marc-André Lemburg <mal@egenix.com> parents: 14375 diff changeset	172 (only possible for 0-terminated
85038a024b19 This patch adds a new Python C API called PyString_AsStringAndSize() Marc-André Lemburg <mal@egenix.com> parents: 14375 diff changeset	173 strings) */
85038a024b19 This patch adds a new Python C API called PyString_AsStringAndSize() Marc-André Lemburg <mal@egenix.com> parents: 14375 diff changeset	174 );
85038a024b19 This patch adds a new Python C API called PyString_AsStringAndSize() Marc-André Lemburg <mal@egenix.com> parents: 14375 diff changeset	175
85038a024b19 This patch adds a new Python C API called PyString_AsStringAndSize() Marc-André Lemburg <mal@egenix.com> parents: 14375 diff changeset	176
1329 519c25039c6a * Added support for X11 modules. Guido van Rossum <guido@python.org> parents: 1252 diff changeset	177 #ifdef __cplusplus
519c25039c6a * Added support for X11 modules. Guido van Rossum <guido@python.org> parents: 1252 diff changeset	178 }
519c25039c6a * Added support for X11 modules. Guido van Rossum <guido@python.org> parents: 1252 diff changeset	179 #endif
519c25039c6a * Added support for X11 modules. Guido van Rossum <guido@python.org> parents: 1252 diff changeset	180 #endif /* !Py_STRINGOBJECT_H */

Mercurial > cpython-lru_cache-weakref

annotate Include/stringobject.h @ 42334:e70cdce0e8b2