annotate Include/unicodeobject.h @ 73633:1dd575504607

Ensure that Py_UCS4 is 32 bits and Py_UCS2 is 16 bits
author Victor Stinner <victor.stinner@haypocalc.com>
date Sun, 20 Nov 2011 18:28:29 +0100
parents abe62c9d659d
children 28f2c1c1b7c1
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1 #ifndef Py_UNICODEOBJECT_H
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
2 #define Py_UNICODEOBJECT_H
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
3
44999
7c02182e2979 Merged revisions 60284-60349 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 44586
diff changeset
4 #include <stdarg.h>
7c02182e2979 Merged revisions 60284-60349 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 44586
diff changeset
5
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
6 /*
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
7
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
8 Unicode implementation based on original code by Fredrik Lundh,
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
9 modified by Marc-Andre Lemburg (mal@lemburg.com) according to the
66206
52fe60216e89 Merged revisions 86478 via svnmerge from
Alexander Belopolsky <alexander.belopolsky@gmail.com>
parents: 65113
diff changeset
10 Unicode Integration Proposal. (See
52fe60216e89 Merged revisions 86478 via svnmerge from
Alexander Belopolsky <alexander.belopolsky@gmail.com>
parents: 65113
diff changeset
11 http://www.egenix.com/files/python/unicode-proposal.txt).
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
12
13828
254f8b7c4a83 Changing the CNRI copyright notice according to CNRI's instructions.
Guido van Rossum <guido@python.org>
parents: 13661
diff changeset
13 Copyright (c) Corporation for National Research Initiatives.
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
14
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
15
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
16 Original header:
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
17 --------------------------------------------------------------------
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
18
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
19 * Yet another Unicode string type for Python. This type supports the
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
20 * 16-bit Basic Multilingual Plane (BMP) only.
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
21 *
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
22 * Written by Fredrik Lundh, January 1999.
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
23 *
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
24 * Copyright (c) 1999 by Secret Labs AB.
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
25 * Copyright (c) 1999 by Fredrik Lundh.
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
26 *
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
27 * fredrik@pythonware.com
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
28 * http://www.pythonware.com
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
29 *
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
30 * --------------------------------------------------------------------
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
31 * This Unicode String Type is
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
32 *
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
33 * Copyright (c) 1999 by Secret Labs AB
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
34 * Copyright (c) 1999 by Fredrik Lundh
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
35 *
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
36 * By obtaining, using, and/or copying this software and/or its
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
37 * associated documentation, you agree that you have read, understood,
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
38 * and will comply with the following terms and conditions:
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
39 *
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
40 * Permission to use, copy, modify, and distribute this software and its
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
41 * associated documentation for any purpose and without fee is hereby
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
42 * granted, provided that the above copyright notice appears in all
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
43 * copies, and that both that copyright notice and this permission notice
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
44 * appear in supporting documentation, and that the name of Secret Labs
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
45 * AB or the author not be used in advertising or publicity pertaining to
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
46 * distribution of the software without specific, written prior
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
47 * permission.
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
48 *
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
49 * SECRET LABS AB AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
50 * THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
51 * FITNESS. IN NO EVENT SHALL SECRET LABS AB OR THE AUTHOR BE LIABLE FOR
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
52 * ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
53 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
54 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
55 * OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
56 * -------------------------------------------------------------------- */
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
57
19980
9ab6af6815af Fix for bug #462737.
Marc-André Lemburg <mal@egenix.com>
parents: 19849
diff changeset
58 #include <ctype.h>
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
59
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
60 /* === Internal API ======================================================= */
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
61
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
62 /* --- Internal Unicode Format -------------------------------------------- */
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
63
44586
a2938c55200c Always define Py_USING_UNICODE, 3rd party software may depend on it. A missing declaration can lead to strange bugs as I had to learn the hard way in the upcoming merge
Christian Heimes <christian@cheimes.de>
parents: 44351
diff changeset
64 /* Python 3.x requires unicode */
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
65 #define Py_USING_UNICODE
44586
a2938c55200c Always define Py_USING_UNICODE, 3rd party software may depend on it. A missing declaration can lead to strange bugs as I had to learn the hard way in the upcoming merge
Christian Heimes <christian@cheimes.de>
parents: 44351
diff changeset
66
72475
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
67 #ifndef SIZEOF_WCHAR_T
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
68 #error Must define SIZEOF_WCHAR_T
18296
22f85c6a6520 Make Unicode work a bit better on Windows...
Fredrik Lundh <fredrik@pythonware.com>
parents: 18292
diff changeset
69 #endif
22f85c6a6520 Make Unicode work a bit better on Windows...
Fredrik Lundh <fredrik@pythonware.com>
parents: 18292
diff changeset
70
72475
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
71 #define Py_UNICODE_SIZE SIZEOF_WCHAR_T
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
72
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
73 /* If wchar_t can be used for UCS-4 storage, set Py_UNICODE_WIDE.
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
74 Otherwise, Unicode strings are stored as UCS-2 (with limited support
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
75 for UTF-16) */
18324
3ba7a358ce02 use Py_UNICODE_WIDE instead of USE_UCS4_STORAGE and Py_UNICODE_SIZE
Fredrik Lundh <fredrik@pythonware.com>
parents: 18298
diff changeset
76
3ba7a358ce02 use Py_UNICODE_WIDE instead of USE_UCS4_STORAGE and Py_UNICODE_SIZE
Fredrik Lundh <fredrik@pythonware.com>
parents: 18298
diff changeset
77 #if Py_UNICODE_SIZE >= 4
3ba7a358ce02 use Py_UNICODE_WIDE instead of USE_UCS4_STORAGE and Py_UNICODE_SIZE
Fredrik Lundh <fredrik@pythonware.com>
parents: 18298
diff changeset
78 #define Py_UNICODE_WIDE
18292
ffbb9c918ac0 Support using UCS-4 as the Py_UNICODE type:
Martin v. Löwis <martin@v.loewis.de>
parents: 18280
diff changeset
79 #endif
18280
0632dcd69ea3 experimental UCS-4 support: added USE_UCS4_STORAGE define to
Fredrik Lundh <fredrik@pythonware.com>
parents: 17887
diff changeset
80
64687
9cdba6864eb6 #9210: remove --with-wctype-functions configure option.
Amaury Forgeot d'Arc <amauryfa@gmail.com>
parents: 64639
diff changeset
81 /* Set these flags if the platform has "wchar.h" and the
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
82 wchar_t type is a 16-bit unsigned type */
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
83 /* #define HAVE_WCHAR_H */
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
84 /* #define HAVE_USABLE_WCHAR_T */
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
85
72475
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
86 /* Py_UNICODE was the native Unicode storage format (code unit) used by
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
87 Python and represents a single Unicode element in the Unicode type.
72689
aa79b4e62c38 Fix a few typos in the unicode header.
Georg Brandl <georg@python.org>
parents: 72688
diff changeset
88 With PEP 393, Py_UNICODE is deprecated and replaced with a
72475
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
89 typedef to wchar_t. */
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
90
72475
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
91 #ifndef Py_LIMITED_API
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
92 #define PY_UNICODE_TYPE wchar_t
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
93 typedef wchar_t Py_UNICODE;
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
94 #endif
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
95
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
96 /* If the compiler provides a wchar_t type we try to support it
65007
7c7d1d96e2c3 Issue #9979: Create function PyUnicode_AsWideCharString().
Victor Stinner <victor.stinner@haypocalc.com>
parents: 64687
diff changeset
97 through the interface functions PyUnicode_FromWideChar(),
7c7d1d96e2c3 Issue #9979: Create function PyUnicode_AsWideCharString().
Victor Stinner <victor.stinner@haypocalc.com>
parents: 64687
diff changeset
98 PyUnicode_AsWideChar() and PyUnicode_AsWideCharString(). */
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
99
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
100 #ifdef HAVE_USABLE_WCHAR_T
13917
03fa40528d17 Added #fndef's to avoid compiler errors.
Marc-André Lemburg <mal@egenix.com>
parents: 13837
diff changeset
101 # ifndef HAVE_WCHAR_H
03fa40528d17 Added #fndef's to avoid compiler errors.
Marc-André Lemburg <mal@egenix.com>
parents: 13837
diff changeset
102 # define HAVE_WCHAR_H
03fa40528d17 Added #fndef's to avoid compiler errors.
Marc-André Lemburg <mal@egenix.com>
parents: 13837
diff changeset
103 # endif
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
104 #endif
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
105
72475
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
106 #if defined(MS_WINDOWS)
71193
13e6d3cb2ecd Issue #9642: Uniformize the tests on the availability of the mbcs codec
Victor Stinner <victor.stinner@haypocalc.com>
parents: 68258
diff changeset
107 # define HAVE_MBCS
13e6d3cb2ecd Issue #9642: Uniformize the tests on the availability of the mbcs codec
Victor Stinner <victor.stinner@haypocalc.com>
parents: 68258
diff changeset
108 #endif
13e6d3cb2ecd Issue #9642: Uniformize the tests on the availability of the mbcs codec
Victor Stinner <victor.stinner@haypocalc.com>
parents: 68258
diff changeset
109
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
110 #ifdef HAVE_WCHAR_H
12074
65f35b73e350 Marc-Andre Lemburg:
Guido van Rossum <guido@python.org>
parents: 12066
diff changeset
111 /* Work around a cosmetic bug in BSDI 4.x wchar.h; thanks to Thomas Wouters */
65f35b73e350 Marc-Andre Lemburg:
Guido van Rossum <guido@python.org>
parents: 12066
diff changeset
112 # ifdef _HAVE_BSDI
65f35b73e350 Marc-Andre Lemburg:
Guido van Rossum <guido@python.org>
parents: 12066
diff changeset
113 # include <time.h>
65f35b73e350 Marc-Andre Lemburg:
Guido van Rossum <guido@python.org>
parents: 12066
diff changeset
114 # endif
19980
9ab6af6815af Fix for bug #462737.
Marc-André Lemburg <mal@egenix.com>
parents: 19849
diff changeset
115 # include <wchar.h>
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
116 #endif
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
117
72689
aa79b4e62c38 Fix a few typos in the unicode header.
Georg Brandl <georg@python.org>
parents: 72688
diff changeset
118 /* Py_UCS4 and Py_UCS2 are typedefs for the respective
72475
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
119 unicode representations. */
73633
1dd575504607 Ensure that Py_UCS4 is 32 bits and Py_UCS2 is 16 bits
Victor Stinner <victor.stinner@haypocalc.com>
parents: 73591
diff changeset
120 #if SIZEOF_INT == 4
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
121 typedef unsigned int Py_UCS4;
73633
1dd575504607 Ensure that Py_UCS4 is 32 bits and Py_UCS2 is 16 bits
Victor Stinner <victor.stinner@haypocalc.com>
parents: 73591
diff changeset
122 #elif SIZEOF_LONG == 4
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
123 typedef unsigned long Py_UCS4;
72475
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
124 #else
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
125 #error "Could not find a proper typedef for Py_UCS4"
66664
62b61abd02b8 Merge branches/pep-0384.
Martin v. Löwis <martin@v.loewis.de>
parents: 66203
diff changeset
126 #endif
13393
bcb14627b8f4 Bill Tutt: Added Py_UCS4 typedef to hold UCS4 values (these need
Marc-André Lemburg <mal@egenix.com>
parents: 13352
diff changeset
127
73633
1dd575504607 Ensure that Py_UCS4 is 32 bits and Py_UCS2 is 16 bits
Victor Stinner <victor.stinner@haypocalc.com>
parents: 73591
diff changeset
128 #if SIZEOF_SHORT == 2
72475
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
129 typedef unsigned short Py_UCS2;
73633
1dd575504607 Ensure that Py_UCS4 is 32 bits and Py_UCS2 is 16 bits
Victor Stinner <victor.stinner@haypocalc.com>
parents: 73591
diff changeset
130 #else
1dd575504607 Ensure that Py_UCS4 is 32 bits and Py_UCS2 is 16 bits
Victor Stinner <victor.stinner@haypocalc.com>
parents: 73591
diff changeset
131 #error "Could not find a proper typedef for Py_UCS2"
1dd575504607 Ensure that Py_UCS4 is 32 bits and Py_UCS2 is 16 bits
Victor Stinner <victor.stinner@haypocalc.com>
parents: 73591
diff changeset
132 #endif
1dd575504607 Ensure that Py_UCS4 is 32 bits and Py_UCS2 is 16 bits
Victor Stinner <victor.stinner@haypocalc.com>
parents: 73591
diff changeset
133
72475
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
134 typedef unsigned char Py_UCS1;
18911
55b45b47fc48 As discussed on python-dev: this patch adds name mangling to
Marc-André Lemburg <mal@egenix.com>
parents: 18887
diff changeset
135
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
136 /* --- Internal Unicode Operations ---------------------------------------- */
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
137
50660
9d093ef89c56 Merged revisions 68440 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents: 50550
diff changeset
138 /* Since splitting on whitespace is an important use case, and
9d093ef89c56 Merged revisions 68440 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents: 50550
diff changeset
139 whitespace in most situations is solely ASCII whitespace, we
9d093ef89c56 Merged revisions 68440 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents: 50550
diff changeset
140 optimize for the common case by using a quick look-up table
9d093ef89c56 Merged revisions 68440 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents: 50550
diff changeset
141 _Py_ascii_whitespace (see below) with an inlined check.
9d093ef89c56 Merged revisions 68440 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents: 50550
diff changeset
142
45056
c8fca9b5cd3c Merged revisions 60408-60440 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 44999
diff changeset
143 */
66664
62b61abd02b8 Merge branches/pep-0384.
Martin v. Löwis <martin@v.loewis.de>
parents: 66203
diff changeset
144 #ifndef Py_LIMITED_API
45056
c8fca9b5cd3c Merged revisions 60408-60440 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 44999
diff changeset
145 #define Py_UNICODE_ISSPACE(ch) \
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
146 ((ch) < 128U ? _Py_ascii_whitespace[(ch)] : _PyUnicode_IsWhitespace(ch))
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
147
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
148 #define Py_UNICODE_ISLOWER(ch) _PyUnicode_IsLowercase(ch)
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
149 #define Py_UNICODE_ISUPPER(ch) _PyUnicode_IsUppercase(ch)
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
150 #define Py_UNICODE_ISTITLE(ch) _PyUnicode_IsTitlecase(ch)
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
151 #define Py_UNICODE_ISLINEBREAK(ch) _PyUnicode_IsLinebreak(ch)
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
152
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
153 #define Py_UNICODE_TOLOWER(ch) _PyUnicode_ToLowercase(ch)
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
154 #define Py_UNICODE_TOUPPER(ch) _PyUnicode_ToUppercase(ch)
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
155 #define Py_UNICODE_TOTITLE(ch) _PyUnicode_ToTitlecase(ch)
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
156
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
157 #define Py_UNICODE_ISDECIMAL(ch) _PyUnicode_IsDecimalDigit(ch)
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
158 #define Py_UNICODE_ISDIGIT(ch) _PyUnicode_IsDigit(ch)
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
159 #define Py_UNICODE_ISNUMERIC(ch) _PyUnicode_IsNumeric(ch)
47611
da47e7e135ae #2630: Implement PEP 3138.
Georg Brandl <georg@python.org>
parents: 47496
diff changeset
160 #define Py_UNICODE_ISPRINTABLE(ch) _PyUnicode_IsPrintable(ch)
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
161
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
162 #define Py_UNICODE_TODECIMAL(ch) _PyUnicode_ToDecimalDigit(ch)
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
163 #define Py_UNICODE_TODIGIT(ch) _PyUnicode_ToDigit(ch)
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
164 #define Py_UNICODE_TONUMERIC(ch) _PyUnicode_ToNumeric(ch)
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
165
13352
d88535ccaee5 Modified the ISALPHA and ISALNUM macros to use the new lookup APIs
Marc-André Lemburg <mal@egenix.com>
parents: 13320
diff changeset
166 #define Py_UNICODE_ISALPHA(ch) _PyUnicode_IsAlpha(ch)
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
167
13320
67a04816ea50 Added new Py_UNICODE_ISALPHA() and Py_UNICODE_ISALNUM() macros
Marc-André Lemburg <mal@egenix.com>
parents: 12956
diff changeset
168 #define Py_UNICODE_ISALNUM(ch) \
67a04816ea50 Added new Py_UNICODE_ISALPHA() and Py_UNICODE_ISALNUM() macros
Marc-André Lemburg <mal@egenix.com>
parents: 12956
diff changeset
169 (Py_UNICODE_ISALPHA(ch) || \
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
170 Py_UNICODE_ISDECIMAL(ch) || \
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
171 Py_UNICODE_ISDIGIT(ch) || \
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
172 Py_UNICODE_ISNUMERIC(ch))
13320
67a04816ea50 Added new Py_UNICODE_ISALPHA() and Py_UNICODE_ISALNUM() macros
Marc-André Lemburg <mal@egenix.com>
parents: 12956
diff changeset
173
72475
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
174 #define Py_UNICODE_COPY(target, source, length) \
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
175 Py_MEMCPY((target), (source), (length)*sizeof(Py_UNICODE))
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
176
50660
9d093ef89c56 Merged revisions 68440 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents: 50550
diff changeset
177 #define Py_UNICODE_FILL(target, value, length) \
9d093ef89c56 Merged revisions 68440 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents: 50550
diff changeset
178 do {Py_ssize_t i_; Py_UNICODE *t_ = (target); Py_UNICODE v_ = (value);\
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
179 for (i_ = 0; i_ < (length); i_++) t_[i_] = v_;\
38453
29ae5e0fc348 Much-needed merge (using svnmerge.py this time) of trunk changes into p3yk.
Thomas Wouters <thomas@python.org>
parents: 36501
diff changeset
180 } while (0)
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
181
72036
77171f993bf2 #10542: Add 4 macros to work with surrogates: Py_UNICODE_IS_SURROGATE, Py_UNICODE_IS_HIGH_SURROGATE, Py_UNICODE_IS_LOW_SURROGATE, Py_UNICODE_JOIN_SURROGATES.
Ezio Melotti <ezio.melotti@gmail.com>
parents: 71193
diff changeset
182 /* macros to work with surrogates */
77171f993bf2 #10542: Add 4 macros to work with surrogates: Py_UNICODE_IS_SURROGATE, Py_UNICODE_IS_HIGH_SURROGATE, Py_UNICODE_IS_LOW_SURROGATE, Py_UNICODE_JOIN_SURROGATES.
Ezio Melotti <ezio.melotti@gmail.com>
parents: 71193
diff changeset
183 #define Py_UNICODE_IS_SURROGATE(ch) (0xD800 <= ch && ch <= 0xDFFF)
77171f993bf2 #10542: Add 4 macros to work with surrogates: Py_UNICODE_IS_SURROGATE, Py_UNICODE_IS_HIGH_SURROGATE, Py_UNICODE_IS_LOW_SURROGATE, Py_UNICODE_JOIN_SURROGATES.
Ezio Melotti <ezio.melotti@gmail.com>
parents: 71193
diff changeset
184 #define Py_UNICODE_IS_HIGH_SURROGATE(ch) (0xD800 <= ch && ch <= 0xDBFF)
77171f993bf2 #10542: Add 4 macros to work with surrogates: Py_UNICODE_IS_SURROGATE, Py_UNICODE_IS_HIGH_SURROGATE, Py_UNICODE_IS_LOW_SURROGATE, Py_UNICODE_JOIN_SURROGATES.
Ezio Melotti <ezio.melotti@gmail.com>
parents: 71193
diff changeset
185 #define Py_UNICODE_IS_LOW_SURROGATE(ch) (0xDC00 <= ch && ch <= 0xDFFF)
77171f993bf2 #10542: Add 4 macros to work with surrogates: Py_UNICODE_IS_SURROGATE, Py_UNICODE_IS_HIGH_SURROGATE, Py_UNICODE_IS_LOW_SURROGATE, Py_UNICODE_JOIN_SURROGATES.
Ezio Melotti <ezio.melotti@gmail.com>
parents: 71193
diff changeset
186 /* Join two surrogate characters and return a single Py_UCS4 value. */
77171f993bf2 #10542: Add 4 macros to work with surrogates: Py_UNICODE_IS_SURROGATE, Py_UNICODE_IS_HIGH_SURROGATE, Py_UNICODE_IS_LOW_SURROGATE, Py_UNICODE_JOIN_SURROGATES.
Ezio Melotti <ezio.melotti@gmail.com>
parents: 71193
diff changeset
187 #define Py_UNICODE_JOIN_SURROGATES(high, low) \
77171f993bf2 #10542: Add 4 macros to work with surrogates: Py_UNICODE_IS_SURROGATE, Py_UNICODE_IS_HIGH_SURROGATE, Py_UNICODE_IS_LOW_SURROGATE, Py_UNICODE_JOIN_SURROGATES.
Ezio Melotti <ezio.melotti@gmail.com>
parents: 71193
diff changeset
188 (((((Py_UCS4)(high) & 0x03FF) << 10) | \
77171f993bf2 #10542: Add 4 macros to work with surrogates: Py_UNICODE_IS_SURROGATE, Py_UNICODE_IS_HIGH_SURROGATE, Py_UNICODE_IS_LOW_SURROGATE, Py_UNICODE_JOIN_SURROGATES.
Ezio Melotti <ezio.melotti@gmail.com>
parents: 71193
diff changeset
189 ((Py_UCS4)(low) & 0x03FF)) + 0x10000)
77171f993bf2 #10542: Add 4 macros to work with surrogates: Py_UNICODE_IS_SURROGATE, Py_UNICODE_IS_HIGH_SURROGATE, Py_UNICODE_IS_LOW_SURROGATE, Py_UNICODE_JOIN_SURROGATES.
Ezio Melotti <ezio.melotti@gmail.com>
parents: 71193
diff changeset
190
66206
52fe60216e89 Merged revisions 86478 via svnmerge from
Alexander Belopolsky <alexander.belopolsky@gmail.com>
parents: 65113
diff changeset
191 /* Check if substring matches at given offset. The offset must be
52fe60216e89 Merged revisions 86478 via svnmerge from
Alexander Belopolsky <alexander.belopolsky@gmail.com>
parents: 65113
diff changeset
192 valid, and the substring must not be empty. */
50660
9d093ef89c56 Merged revisions 68440 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents: 50550
diff changeset
193
38453
29ae5e0fc348 Much-needed merge (using svnmerge.py this time) of trunk changes into p3yk.
Thomas Wouters <thomas@python.org>
parents: 36501
diff changeset
194 #define Py_UNICODE_MATCH(string, offset, substring) \
72475
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
195 ((*((string)->wstr + (offset)) == *((substring)->wstr)) && \
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
196 ((*((string)->wstr + (offset) + (substring)->wstr_length-1) == *((substring)->wstr + (substring)->wstr_length-1))) && \
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
197 !memcmp((string)->wstr + (offset), (substring)->wstr, (substring)->wstr_length*sizeof(Py_UNICODE)))
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
198
66664
62b61abd02b8 Merge branches/pep-0384.
Martin v. Löwis <martin@v.loewis.de>
parents: 66203
diff changeset
199 #endif /* Py_LIMITED_API */
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
200
12025
7994d9db7f4d On 17-Mar-2000, Marc-Andre Lemburg said:
Barry Warsaw <barry@python.org>
parents: 12002
diff changeset
201 #ifdef __cplusplus
7994d9db7f4d On 17-Mar-2000, Marc-Andre Lemburg said:
Barry Warsaw <barry@python.org>
parents: 12002
diff changeset
202 extern "C" {
7994d9db7f4d On 17-Mar-2000, Marc-Andre Lemburg said:
Barry Warsaw <barry@python.org>
parents: 12002
diff changeset
203 #endif
7994d9db7f4d On 17-Mar-2000, Marc-Andre Lemburg said:
Barry Warsaw <barry@python.org>
parents: 12002
diff changeset
204
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
205 /* --- Unicode Type ------------------------------------------------------- */
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
206
66664
62b61abd02b8 Merge branches/pep-0384.
Martin v. Löwis <martin@v.loewis.de>
parents: 66203
diff changeset
207 #ifndef Py_LIMITED_API
72475
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
208
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
209 /* ASCII-only strings created through PyUnicode_New use the PyASCIIObject
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
210 structure. state.ascii and state.compact are set, and the data
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
211 immediately follow the structure. utf8_length and wstr_length can be found
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
212 in the length field; the utf8 pointer is equal to the data pointer. */
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
213 typedef struct {
72729
109c8b9f2828 Fix typo
Éric Araujo <merwok@netwok.org>
parents: 72632
diff changeset
214 /* There are 4 forms of Unicode strings:
72603
dbb9313c3ed8 Add _PyUnicode_CheckConsistency() macro to help debugging
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72598
diff changeset
215
dbb9313c3ed8 Add _PyUnicode_CheckConsistency() macro to help debugging
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72598
diff changeset
216 - compact ascii:
dbb9313c3ed8 Add _PyUnicode_CheckConsistency() macro to help debugging
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72598
diff changeset
217
dbb9313c3ed8 Add _PyUnicode_CheckConsistency() macro to help debugging
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72598
diff changeset
218 * structure = PyASCIIObject
dbb9313c3ed8 Add _PyUnicode_CheckConsistency() macro to help debugging
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72598
diff changeset
219 * kind = PyUnicode_1BYTE_KIND
dbb9313c3ed8 Add _PyUnicode_CheckConsistency() macro to help debugging
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72598
diff changeset
220 * compact = 1
dbb9313c3ed8 Add _PyUnicode_CheckConsistency() macro to help debugging
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72598
diff changeset
221 * ascii = 1
dbb9313c3ed8 Add _PyUnicode_CheckConsistency() macro to help debugging
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72598
diff changeset
222 * ready = 1
72632
9c9ebb07d053 Complete documentation of compact ASCII strings
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72629
diff changeset
223 * (length is the length of the utf8 and wstr strings)
9c9ebb07d053 Complete documentation of compact ASCII strings
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72629
diff changeset
224 * (data starts just after the structure)
9c9ebb07d053 Complete documentation of compact ASCII strings
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72629
diff changeset
225 * (since ASCII is decoded from UTF-8, the utf8 string are the data)
72603
dbb9313c3ed8 Add _PyUnicode_CheckConsistency() macro to help debugging
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72598
diff changeset
226
dbb9313c3ed8 Add _PyUnicode_CheckConsistency() macro to help debugging
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72598
diff changeset
227 - compact:
dbb9313c3ed8 Add _PyUnicode_CheckConsistency() macro to help debugging
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72598
diff changeset
228
dbb9313c3ed8 Add _PyUnicode_CheckConsistency() macro to help debugging
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72598
diff changeset
229 * structure = PyCompactUnicodeObject
dbb9313c3ed8 Add _PyUnicode_CheckConsistency() macro to help debugging
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72598
diff changeset
230 * kind = PyUnicode_1BYTE_KIND, PyUnicode_2BYTE_KIND or
dbb9313c3ed8 Add _PyUnicode_CheckConsistency() macro to help debugging
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72598
diff changeset
231 PyUnicode_4BYTE_KIND
dbb9313c3ed8 Add _PyUnicode_CheckConsistency() macro to help debugging
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72598
diff changeset
232 * compact = 1
dbb9313c3ed8 Add _PyUnicode_CheckConsistency() macro to help debugging
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72598
diff changeset
233 * ready = 1
72614
93f033c7cfea PyUnicode_Ready() now sets ascii=1 if maxchar < 128
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72603
diff changeset
234 * ascii = 0
72632
9c9ebb07d053 Complete documentation of compact ASCII strings
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72629
diff changeset
235 * utf8 is not shared with data
72629
5346409167a7 Document utf8_length and wstr_length states
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72625
diff changeset
236 * utf8_length = 0 if utf8 is NULL
5346409167a7 Document utf8_length and wstr_length states
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72625
diff changeset
237 * wstr is shared with data and wstr_length=length
5346409167a7 Document utf8_length and wstr_length states
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72625
diff changeset
238 if kind=PyUnicode_2BYTE_KIND and sizeof(wchar_t)=2
73356
b3543ef9b445 Fix gdb/libpython.py for not ready Unicode strings
Victor Stinner <victor.stinner@haypocalc.com>
parents: 73337
diff changeset
239 or if kind=PyUnicode_4BYTE_KIND and sizeof(wchar_t)=4
72629
5346409167a7 Document utf8_length and wstr_length states
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72625
diff changeset
240 * wstr_length = 0 if wstr is NULL
72632
9c9ebb07d053 Complete documentation of compact ASCII strings
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72629
diff changeset
241 * (data starts just after the structure)
72603
dbb9313c3ed8 Add _PyUnicode_CheckConsistency() macro to help debugging
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72598
diff changeset
242
72621
fe10f0bcc860 Improve string forms and PyUnicode_Resize() documentation
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72617
diff changeset
243 - legacy string, not ready:
72603
dbb9313c3ed8 Add _PyUnicode_CheckConsistency() macro to help debugging
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72598
diff changeset
244
dbb9313c3ed8 Add _PyUnicode_CheckConsistency() macro to help debugging
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72598
diff changeset
245 * structure = PyUnicodeObject
73356
b3543ef9b445 Fix gdb/libpython.py for not ready Unicode strings
Victor Stinner <victor.stinner@haypocalc.com>
parents: 73337
diff changeset
246 * length = 0 (use wstr_length)
b3543ef9b445 Fix gdb/libpython.py for not ready Unicode strings
Victor Stinner <victor.stinner@haypocalc.com>
parents: 73337
diff changeset
247 * hash = -1
72603
dbb9313c3ed8 Add _PyUnicode_CheckConsistency() macro to help debugging
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72598
diff changeset
248 * kind = PyUnicode_WCHAR_KIND
dbb9313c3ed8 Add _PyUnicode_CheckConsistency() macro to help debugging
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72598
diff changeset
249 * compact = 0
72632
9c9ebb07d053 Complete documentation of compact ASCII strings
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72629
diff changeset
250 * ascii = 0
72603
dbb9313c3ed8 Add _PyUnicode_CheckConsistency() macro to help debugging
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72598
diff changeset
251 * ready = 0
73356
b3543ef9b445 Fix gdb/libpython.py for not ready Unicode strings
Victor Stinner <victor.stinner@haypocalc.com>
parents: 73337
diff changeset
252 * interned = SSTATE_NOT_INTERNED
72603
dbb9313c3ed8 Add _PyUnicode_CheckConsistency() macro to help debugging
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72598
diff changeset
253 * wstr is not NULL
dbb9313c3ed8 Add _PyUnicode_CheckConsistency() macro to help debugging
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72598
diff changeset
254 * data.any is NULL
dbb9313c3ed8 Add _PyUnicode_CheckConsistency() macro to help debugging
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72598
diff changeset
255 * utf8 is NULL
72629
5346409167a7 Document utf8_length and wstr_length states
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72625
diff changeset
256 * utf8_length = 0
72603
dbb9313c3ed8 Add _PyUnicode_CheckConsistency() macro to help debugging
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72598
diff changeset
257
72621
fe10f0bcc860 Improve string forms and PyUnicode_Resize() documentation
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72617
diff changeset
258 - legacy string, ready:
72603
dbb9313c3ed8 Add _PyUnicode_CheckConsistency() macro to help debugging
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72598
diff changeset
259
dbb9313c3ed8 Add _PyUnicode_CheckConsistency() macro to help debugging
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72598
diff changeset
260 * structure = PyUnicodeObject structure
dbb9313c3ed8 Add _PyUnicode_CheckConsistency() macro to help debugging
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72598
diff changeset
261 * kind = PyUnicode_1BYTE_KIND, PyUnicode_2BYTE_KIND or
dbb9313c3ed8 Add _PyUnicode_CheckConsistency() macro to help debugging
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72598
diff changeset
262 PyUnicode_4BYTE_KIND
dbb9313c3ed8 Add _PyUnicode_CheckConsistency() macro to help debugging
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72598
diff changeset
263 * compact = 0
dbb9313c3ed8 Add _PyUnicode_CheckConsistency() macro to help debugging
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72598
diff changeset
264 * ready = 1
dbb9313c3ed8 Add _PyUnicode_CheckConsistency() macro to help debugging
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72598
diff changeset
265 * data.any is not NULL
72629
5346409167a7 Document utf8_length and wstr_length states
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72625
diff changeset
266 * utf8 is shared and utf8_length = length with data.any if ascii = 1
5346409167a7 Document utf8_length and wstr_length states
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72625
diff changeset
267 * utf8_length = 0 if utf8 is NULL
73356
b3543ef9b445 Fix gdb/libpython.py for not ready Unicode strings
Victor Stinner <victor.stinner@haypocalc.com>
parents: 73337
diff changeset
268 * wstr is shared with data.any and wstr_length = length
72629
5346409167a7 Document utf8_length and wstr_length states
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72625
diff changeset
269 if kind=PyUnicode_2BYTE_KIND and sizeof(wchar_t)=2
5346409167a7 Document utf8_length and wstr_length states
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72625
diff changeset
270 or if kind=PyUnicode_4BYTE_KIND and sizeof(wchar_4)=4
5346409167a7 Document utf8_length and wstr_length states
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72625
diff changeset
271 * wstr_length = 0 if wstr is NULL
72603
dbb9313c3ed8 Add _PyUnicode_CheckConsistency() macro to help debugging
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72598
diff changeset
272
72621
fe10f0bcc860 Improve string forms and PyUnicode_Resize() documentation
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72617
diff changeset
273 Compact strings use only one memory block (structure + characters),
fe10f0bcc860 Improve string forms and PyUnicode_Resize() documentation
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72617
diff changeset
274 whereas legacy strings use one block for the structure and one block
fe10f0bcc860 Improve string forms and PyUnicode_Resize() documentation
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72617
diff changeset
275 for characters.
72603
dbb9313c3ed8 Add _PyUnicode_CheckConsistency() macro to help debugging
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72598
diff changeset
276
72621
fe10f0bcc860 Improve string forms and PyUnicode_Resize() documentation
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72617
diff changeset
277 Legacy strings are created by PyUnicode_FromUnicode() and
fe10f0bcc860 Improve string forms and PyUnicode_Resize() documentation
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72617
diff changeset
278 PyUnicode_FromStringAndSize(NULL, size) functions. They become ready
fe10f0bcc860 Improve string forms and PyUnicode_Resize() documentation
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72617
diff changeset
279 when PyUnicode_READY() is called.
fe10f0bcc860 Improve string forms and PyUnicode_Resize() documentation
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72617
diff changeset
280
fe10f0bcc860 Improve string forms and PyUnicode_Resize() documentation
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72617
diff changeset
281 See also _PyUnicode_CheckConsistency().
fe10f0bcc860 Improve string forms and PyUnicode_Resize() documentation
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72617
diff changeset
282 */
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
283 PyObject_HEAD
72475
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
284 Py_ssize_t length; /* Number of code points in the string */
65494
e8969fb822fc make hashes always the size of pointers; introduce Py_hash_t #9778
Benjamin Peterson <benjamin@python.org>
parents: 65348
diff changeset
285 Py_hash_t hash; /* Hash value; -1 if not set */
72475
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
286 struct {
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
287 /*
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
288 SSTATE_NOT_INTERNED (0)
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
289 SSTATE_INTERNED_MORTAL (1)
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
290 SSTATE_INTERNED_IMMORTAL (2)
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
291
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
292 If interned != SSTATE_NOT_INTERNED, the two references from the
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
293 dictionary to this object are *not* counted in ob_refcnt.
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
294 */
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
295 unsigned int interned:2;
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
296 /* Character size:
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
297
72699
055174308822 Document requierements of Unicode kinds
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72691
diff changeset
298 - PyUnicode_WCHAR_KIND (0):
055174308822 Document requierements of Unicode kinds
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72691
diff changeset
299
055174308822 Document requierements of Unicode kinds
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72691
diff changeset
300 * character type = wchar_t (16 or 32 bits, depending on the
055174308822 Document requierements of Unicode kinds
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72691
diff changeset
301 platform)
055174308822 Document requierements of Unicode kinds
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72691
diff changeset
302
055174308822 Document requierements of Unicode kinds
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72691
diff changeset
303 - PyUnicode_1BYTE_KIND (1):
055174308822 Document requierements of Unicode kinds
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72691
diff changeset
304
055174308822 Document requierements of Unicode kinds
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72691
diff changeset
305 * character type = Py_UCS1 (8 bits, unsigned)
72715
341c3002ffb2 rephrase PyUnicode_1BYTE_KIND documentation
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72714
diff changeset
306 * if ascii is set, all characters must be in range
341c3002ffb2 rephrase PyUnicode_1BYTE_KIND documentation
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72714
diff changeset
307 U+0000-U+007F, otherwise at least one character must be in range
341c3002ffb2 rephrase PyUnicode_1BYTE_KIND documentation
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72714
diff changeset
308 U+0080-U+00FF
72699
055174308822 Document requierements of Unicode kinds
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72691
diff changeset
309
055174308822 Document requierements of Unicode kinds
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72691
diff changeset
310 - PyUnicode_2BYTE_KIND (2):
055174308822 Document requierements of Unicode kinds
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72691
diff changeset
311
055174308822 Document requierements of Unicode kinds
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72691
diff changeset
312 * character type = Py_UCS2 (16 bits, unsigned)
72715
341c3002ffb2 rephrase PyUnicode_1BYTE_KIND documentation
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72714
diff changeset
313 * at least one character must be in range U+0100-U+FFFF
72699
055174308822 Document requierements of Unicode kinds
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72691
diff changeset
314
72796
c25262e97304 Change PyUnicode_KIND to 1,2,4. Drop _KIND_SIZE and _CHARACTER_SIZE.
Martin v. Löwis <martin@v.loewis.de>
parents: 72785
diff changeset
315 - PyUnicode_4BYTE_KIND (4):
72699
055174308822 Document requierements of Unicode kinds
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72691
diff changeset
316
055174308822 Document requierements of Unicode kinds
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72691
diff changeset
317 * character type = Py_UCS4 (32 bits, unsigned)
055174308822 Document requierements of Unicode kinds
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72691
diff changeset
318 * at least one character must be in range U+10000-U+10FFFF
72475
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
319 */
72796
c25262e97304 Change PyUnicode_KIND to 1,2,4. Drop _KIND_SIZE and _CHARACTER_SIZE.
Martin v. Löwis <martin@v.loewis.de>
parents: 72785
diff changeset
320 unsigned int kind:3;
72475
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
321 /* Compact is with respect to the allocation scheme. Compact unicode
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
322 objects only require one memory block while non-compact objects use
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
323 one block for the PyUnicodeObject struct and another for its data
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
324 buffer. */
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
325 unsigned int compact:1;
72715
341c3002ffb2 rephrase PyUnicode_1BYTE_KIND documentation
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72714
diff changeset
326 /* The string only contains characters in range U+0000-U+007F (ASCII)
341c3002ffb2 rephrase PyUnicode_1BYTE_KIND documentation
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72714
diff changeset
327 and the kind is PyUnicode_1BYTE_KIND. If ascii is set and compact is
341c3002ffb2 rephrase PyUnicode_1BYTE_KIND documentation
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72714
diff changeset
328 set, use the PyASCIIObject structure. */
72475
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
329 unsigned int ascii:1;
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
330 /* The ready flag indicates whether the object layout is initialized
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
331 completely. This means that this is either a compact object, or
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
332 the data pointer is filled out. The bit is redundant, and helps
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
333 to minimize the test in PyUnicode_IS_READY(). */
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
334 unsigned int ready:1;
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
335 } state;
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
336 wchar_t *wstr; /* wchar_t representation (null-terminated) */
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
337 } PyASCIIObject;
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
338
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
339 /* Non-ASCII strings allocated through PyUnicode_New use the
72689
aa79b4e62c38 Fix a few typos in the unicode header.
Georg Brandl <georg@python.org>
parents: 72688
diff changeset
340 PyCompactUnicodeObject structure. state.compact is set, and the data
72475
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
341 immediately follow the structure. */
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
342 typedef struct {
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
343 PyASCIIObject _base;
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
344 Py_ssize_t utf8_length; /* Number of bytes in utf8, excluding the
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
345 * terminating \0. */
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
346 char *utf8; /* UTF-8 representation (null-terminated) */
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
347 Py_ssize_t wstr_length; /* Number of code points in wstr, possible
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
348 * surrogates count as two code points. */
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
349 } PyCompactUnicodeObject;
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
350
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
351 /* Strings allocated through PyUnicode_FromUnicode(NULL, len) use the
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
352 PyUnicodeObject structure. The actual string data is initially in the wstr
72614
93f033c7cfea PyUnicode_Ready() now sets ascii=1 if maxchar < 128
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72603
diff changeset
353 block, and copied into the data block using _PyUnicode_Ready. */
72475
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
354 typedef struct {
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
355 PyCompactUnicodeObject _base;
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
356 union {
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
357 void *any;
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
358 Py_UCS1 *latin1;
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
359 Py_UCS2 *ucs2;
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
360 Py_UCS4 *ucs4;
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
361 } data; /* Canonical, smallest-form Unicode buffer */
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
362 } PyUnicodeObject;
66664
62b61abd02b8 Merge branches/pep-0384.
Martin v. Löwis <martin@v.loewis.de>
parents: 66203
diff changeset
363 #endif
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
364
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 24737
diff changeset
365 PyAPI_DATA(PyTypeObject) PyUnicode_Type;
44061
0cc552ab76bd Added all PyTypeObjects to the appropriate header files.
Christian Heimes <christian@cheimes.de>
parents: 43933
diff changeset
366 PyAPI_DATA(PyTypeObject) PyUnicodeIter_Type;
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
367
40909
f2f0b41f270d Merged revisions 53875-53911 via svnmerge from
Thomas Wouters <thomas@python.org>
parents: 39610
diff changeset
368 #define PyUnicode_Check(op) \
44351
86a2679dca46 #1629: Renamed Py_Size, Py_Type and Py_Refcnt to Py_SIZE, Py_TYPE and Py_REFCNT.
Christian Heimes <christian@cheimes.de>
parents: 44061
diff changeset
369 PyType_FastSubclass(Py_TYPE(op), Py_TPFLAGS_UNICODE_SUBCLASS)
86a2679dca46 #1629: Renamed Py_Size, Py_Type and Py_Refcnt to Py_SIZE, Py_TYPE and Py_REFCNT.
Christian Heimes <christian@cheimes.de>
parents: 44061
diff changeset
370 #define PyUnicode_CheckExact(op) (Py_TYPE(op) == &PyUnicode_Type)
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
371
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
372 /* Fast access macros */
66664
62b61abd02b8 Merge branches/pep-0384.
Martin v. Löwis <martin@v.loewis.de>
parents: 66203
diff changeset
373 #ifndef Py_LIMITED_API
72475
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
374
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
375 #define PyUnicode_WSTR_LENGTH(op) \
72614
93f033c7cfea PyUnicode_Ready() now sets ascii=1 if maxchar < 128
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72603
diff changeset
376 (PyUnicode_IS_COMPACT_ASCII(op) ? \
72475
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
377 ((PyASCIIObject*)op)->length : \
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
378 ((PyCompactUnicodeObject*)op)->wstr_length)
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
379
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
380 /* Returns the deprecated Py_UNICODE representation's size in code units
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
381 (this includes surrogate pairs as 2 units).
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
382 If the Py_UNICODE representation is not available, it will be computed
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
383 on request. Use PyUnicode_GET_LENGTH() for the length in code points. */
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
384
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
385 #define PyUnicode_GET_SIZE(op) \
72475
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
386 (assert(PyUnicode_Check(op)), \
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
387 (((PyASCIIObject *)(op))->wstr) ? \
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
388 PyUnicode_WSTR_LENGTH(op) : \
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
389 ((void)PyUnicode_AsUnicode((PyObject *)(op)), \
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
390 PyUnicode_WSTR_LENGTH(op)))
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
391
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
392 #define PyUnicode_GET_DATA_SIZE(op) \
72475
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
393 (PyUnicode_GET_SIZE(op) * Py_UNICODE_SIZE)
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
394
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
395 /* Alias for PyUnicode_AsUnicode(). This will create a wchar_t/Py_UNICODE
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
396 representation on demand. Using this macro is very inefficient now,
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
397 try to port your code to use the new PyUnicode_*BYTE_DATA() macros or
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
398 use PyUnicode_WRITE() and PyUnicode_READ(). */
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
399
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
400 #define PyUnicode_AS_UNICODE(op) \
72475
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
401 (assert(PyUnicode_Check(op)), \
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
402 (((PyASCIIObject *)(op))->wstr) ? (((PyASCIIObject *)(op))->wstr) : \
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
403 PyUnicode_AsUnicode((PyObject *)(op)))
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
404
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
405 #define PyUnicode_AS_DATA(op) \
72475
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
406 ((const char *)(PyUnicode_AS_UNICODE(op)))
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
407
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
408
72689
aa79b4e62c38 Fix a few typos in the unicode header.
Georg Brandl <georg@python.org>
parents: 72688
diff changeset
409 /* --- Flexible String Representation Helper Macros (PEP 393) -------------- */
72475
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
410
73591
abe62c9d659d Fix misused of "PyUnicodeObject" structure name in unicodeobject.h
Victor Stinner <victor.stinner@haypocalc.com>
parents: 73476
diff changeset
411 /* Values for PyASCIIObject.state: */
72475
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
412
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
413 /* Interning state. */
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
414 #define SSTATE_NOT_INTERNED 0
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
415 #define SSTATE_INTERNED_MORTAL 1
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
416 #define SSTATE_INTERNED_IMMORTAL 2
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
417
72614
93f033c7cfea PyUnicode_Ready() now sets ascii=1 if maxchar < 128
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72603
diff changeset
418 /* Return true if the string contains only ASCII characters, or 0 if not. The
93f033c7cfea PyUnicode_Ready() now sets ascii=1 if maxchar < 128
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72603
diff changeset
419 string may be compact (PyUnicode_IS_COMPACT_ASCII) or not. No type checks
93f033c7cfea PyUnicode_Ready() now sets ascii=1 if maxchar < 128
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72603
diff changeset
420 or Ready calls are performed. */
93f033c7cfea PyUnicode_Ready() now sets ascii=1 if maxchar < 128
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72603
diff changeset
421 #define PyUnicode_IS_ASCII(op) \
93f033c7cfea PyUnicode_Ready() now sets ascii=1 if maxchar < 128
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72603
diff changeset
422 (((PyASCIIObject*)op)->state.ascii)
93f033c7cfea PyUnicode_Ready() now sets ascii=1 if maxchar < 128
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72603
diff changeset
423
93f033c7cfea PyUnicode_Ready() now sets ascii=1 if maxchar < 128
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72603
diff changeset
424 /* Return true if the string is compact or 0 if not.
93f033c7cfea PyUnicode_Ready() now sets ascii=1 if maxchar < 128
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72603
diff changeset
425 No type checks or Ready calls are performed. */
93f033c7cfea PyUnicode_Ready() now sets ascii=1 if maxchar < 128
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72603
diff changeset
426 #define PyUnicode_IS_COMPACT(op) \
93f033c7cfea PyUnicode_Ready() now sets ascii=1 if maxchar < 128
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72603
diff changeset
427 (((PyASCIIObject*)(op))->state.compact)
93f033c7cfea PyUnicode_Ready() now sets ascii=1 if maxchar < 128
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72603
diff changeset
428
93f033c7cfea PyUnicode_Ready() now sets ascii=1 if maxchar < 128
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72603
diff changeset
429 /* Return true if the string is a compact ASCII string (use PyASCIIObject
93f033c7cfea PyUnicode_Ready() now sets ascii=1 if maxchar < 128
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72603
diff changeset
430 structure), or 0 if not. No type checks or Ready calls are performed. */
93f033c7cfea PyUnicode_Ready() now sets ascii=1 if maxchar < 128
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72603
diff changeset
431 #define PyUnicode_IS_COMPACT_ASCII(op) \
93f033c7cfea PyUnicode_Ready() now sets ascii=1 if maxchar < 128
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72603
diff changeset
432 (PyUnicode_IS_ASCII(op) && PyUnicode_IS_COMPACT(op))
72475
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
433
72796
c25262e97304 Change PyUnicode_KIND to 1,2,4. Drop _KIND_SIZE and _CHARACTER_SIZE.
Martin v. Löwis <martin@v.loewis.de>
parents: 72785
diff changeset
434 enum PyUnicode_Kind {
72475
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
435 /* String contains only wstr byte characters. This is only possible
72614
93f033c7cfea PyUnicode_Ready() now sets ascii=1 if maxchar < 128
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72603
diff changeset
436 when the string was created with a legacy API and _PyUnicode_Ready()
72475
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
437 has not been called yet. */
72796
c25262e97304 Change PyUnicode_KIND to 1,2,4. Drop _KIND_SIZE and _CHARACTER_SIZE.
Martin v. Löwis <martin@v.loewis.de>
parents: 72785
diff changeset
438 PyUnicode_WCHAR_KIND = 0,
72475
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
439 /* Return values of the PyUnicode_KIND() macro: */
72796
c25262e97304 Change PyUnicode_KIND to 1,2,4. Drop _KIND_SIZE and _CHARACTER_SIZE.
Martin v. Löwis <martin@v.loewis.de>
parents: 72785
diff changeset
440 PyUnicode_1BYTE_KIND = 1,
c25262e97304 Change PyUnicode_KIND to 1,2,4. Drop _KIND_SIZE and _CHARACTER_SIZE.
Martin v. Löwis <martin@v.loewis.de>
parents: 72785
diff changeset
441 PyUnicode_2BYTE_KIND = 2,
c25262e97304 Change PyUnicode_KIND to 1,2,4. Drop _KIND_SIZE and _CHARACTER_SIZE.
Martin v. Löwis <martin@v.loewis.de>
parents: 72785
diff changeset
442 PyUnicode_4BYTE_KIND = 4
c25262e97304 Change PyUnicode_KIND to 1,2,4. Drop _KIND_SIZE and _CHARACTER_SIZE.
Martin v. Löwis <martin@v.loewis.de>
parents: 72785
diff changeset
443 };
72475
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
444
72688
6d4701a0e76b Fix grammar.
Georg Brandl <georg@python.org>
parents: 72685
diff changeset
445 /* Return pointers to the canonical representation cast to unsigned char,
72475
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
446 Py_UCS2, or Py_UCS4 for direct character access.
72796
c25262e97304 Change PyUnicode_KIND to 1,2,4. Drop _KIND_SIZE and _CHARACTER_SIZE.
Martin v. Löwis <martin@v.loewis.de>
parents: 72785
diff changeset
447 No checks are performed, use PyUnicode_KIND() before to ensure
c25262e97304 Change PyUnicode_KIND to 1,2,4. Drop _KIND_SIZE and _CHARACTER_SIZE.
Martin v. Löwis <martin@v.loewis.de>
parents: 72785
diff changeset
448 these will work correctly. */
72475
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
449
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
450 #define PyUnicode_1BYTE_DATA(op) ((Py_UCS1*)PyUnicode_DATA(op))
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
451 #define PyUnicode_2BYTE_DATA(op) ((Py_UCS2*)PyUnicode_DATA(op))
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
452 #define PyUnicode_4BYTE_DATA(op) ((Py_UCS4*)PyUnicode_DATA(op))
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
453
72494
93cc591cffe4 Strip trailing spaces in unicodeobject.[ch]
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72492
diff changeset
454 /* Return one of the PyUnicode_*_KIND values defined above. */
72475
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
455 #define PyUnicode_KIND(op) \
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
456 (assert(PyUnicode_Check(op)), \
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
457 assert(PyUnicode_IS_READY(op)), \
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
458 ((PyASCIIObject *)(op))->state.kind)
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
459
72494
93cc591cffe4 Strip trailing spaces in unicodeobject.[ch]
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72492
diff changeset
460 /* Return a void pointer to the raw unicode buffer. */
72475
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
461 #define _PyUnicode_COMPACT_DATA(op) \
72980
cade7c20c728 Simplify _PyUnicode_COMPACT_DATA() macro
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72976
diff changeset
462 (PyUnicode_IS_ASCII(op) ? \
72475
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
463 ((void*)((PyASCIIObject*)(op) + 1)) : \
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
464 ((void*)((PyCompactUnicodeObject*)(op) + 1)))
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
465
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
466 #define _PyUnicode_NONCOMPACT_DATA(op) \
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
467 (assert(((PyUnicodeObject*)(op))->data.any), \
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
468 ((((PyUnicodeObject *)(op))->data.any)))
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
469
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
470 #define PyUnicode_DATA(op) \
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
471 (assert(PyUnicode_Check(op)), \
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
472 PyUnicode_IS_COMPACT(op) ? _PyUnicode_COMPACT_DATA(op) : \
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
473 _PyUnicode_NONCOMPACT_DATA(op))
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
474
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
475 /* In the access macros below, "kind" may be evaluated more than once.
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
476 All other macro parameters are evaluated exactly once, so it is safe
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
477 to put side effects into them (such as increasing the index). */
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
478
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
479 /* Write into the canonical representation, this macro does not do any sanity
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
480 checks and is intended for usage in loops. The caller should cache the
72691
c2127d79f7c1 More fixes.
Georg Brandl <georg@python.org>
parents: 72689
diff changeset
481 kind and data pointers obtained from other macro calls.
72475
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
482 index is the index in the string (starts at 0) and value is the new
72689
aa79b4e62c38 Fix a few typos in the unicode header.
Georg Brandl <georg@python.org>
parents: 72688
diff changeset
483 code point value which should be written to that location. */
72475
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
484 #define PyUnicode_WRITE(kind, data, index, value) \
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
485 do { \
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
486 switch ((kind)) { \
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
487 case PyUnicode_1BYTE_KIND: { \
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
488 ((Py_UCS1 *)(data))[(index)] = (Py_UCS1)(value); \
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
489 break; \
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
490 } \
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
491 case PyUnicode_2BYTE_KIND: { \
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
492 ((Py_UCS2 *)(data))[(index)] = (Py_UCS2)(value); \
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
493 break; \
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
494 } \
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
495 default: { \
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
496 assert((kind) == PyUnicode_4BYTE_KIND); \
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
497 ((Py_UCS4 *)(data))[(index)] = (Py_UCS4)(value); \
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
498 } \
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
499 } \
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
500 } while (0)
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
501
72691
c2127d79f7c1 More fixes.
Georg Brandl <georg@python.org>
parents: 72689
diff changeset
502 /* Read a code point from the string's canonical representation. No checks
72475
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
503 or ready calls are performed. */
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
504 #define PyUnicode_READ(kind, data, index) \
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
505 ((Py_UCS4) \
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
506 ((kind) == PyUnicode_1BYTE_KIND ? \
72577
5231de1080b0 Use Py_UCS1 instead of unsigned char in unicodeobject.h
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72575
diff changeset
507 ((const Py_UCS1 *)(data))[(index)] : \
72475
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
508 ((kind) == PyUnicode_2BYTE_KIND ? \
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
509 ((const Py_UCS2 *)(data))[(index)] : \
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
510 ((const Py_UCS4 *)(data))[(index)] \
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
511 ) \
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
512 ))
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
513
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
514 /* PyUnicode_READ_CHAR() is less efficient than PyUnicode_READ() because it
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
515 calls PyUnicode_KIND() and might call it twice. For single reads, use
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
516 PyUnicode_READ_CHAR, for multiple consecutive reads callers should
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
517 cache kind and use PyUnicode_READ instead. */
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
518 #define PyUnicode_READ_CHAR(unicode, index) \
72598
3a0af974f1b5 PyUnicode_READ_CHAR() ensures that the string is ready
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72577
diff changeset
519 (assert(PyUnicode_Check(unicode)), \
3a0af974f1b5 PyUnicode_READ_CHAR() ensures that the string is ready
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72577
diff changeset
520 assert(PyUnicode_IS_READY(unicode)), \
3a0af974f1b5 PyUnicode_READ_CHAR() ensures that the string is ready
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72577
diff changeset
521 (Py_UCS4) \
3a0af974f1b5 PyUnicode_READ_CHAR() ensures that the string is ready
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72577
diff changeset
522 (PyUnicode_KIND((unicode)) == PyUnicode_1BYTE_KIND ? \
3a0af974f1b5 PyUnicode_READ_CHAR() ensures that the string is ready
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72577
diff changeset
523 ((const Py_UCS1 *)(PyUnicode_DATA((unicode))))[(index)] : \
3a0af974f1b5 PyUnicode_READ_CHAR() ensures that the string is ready
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72577
diff changeset
524 (PyUnicode_KIND((unicode)) == PyUnicode_2BYTE_KIND ? \
3a0af974f1b5 PyUnicode_READ_CHAR() ensures that the string is ready
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72577
diff changeset
525 ((const Py_UCS2 *)(PyUnicode_DATA((unicode))))[(index)] : \
3a0af974f1b5 PyUnicode_READ_CHAR() ensures that the string is ready
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72577
diff changeset
526 ((const Py_UCS4 *)(PyUnicode_DATA((unicode))))[(index)] \
3a0af974f1b5 PyUnicode_READ_CHAR() ensures that the string is ready
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72577
diff changeset
527 ) \
3a0af974f1b5 PyUnicode_READ_CHAR() ensures that the string is ready
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72577
diff changeset
528 ))
72475
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
529
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
530 /* Returns the length of the unicode string. The caller has to make sure that
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
531 the string has it's canonical representation set before calling
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
532 this macro. Call PyUnicode_(FAST_)Ready to ensure that. */
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
533 #define PyUnicode_GET_LENGTH(op) \
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
534 (assert(PyUnicode_Check(op)), \
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
535 assert(PyUnicode_IS_READY(op)), \
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
536 ((PyASCIIObject *)(op))->length)
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
537
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
538
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
539 /* Fast check to determine whether an object is ready. Equivalent to
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
540 PyUnicode_IS_COMPACT(op) || ((PyUnicodeObject*)(op))->data.any) */
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
541
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
542 #define PyUnicode_IS_READY(op) (((PyASCIIObject*)op)->state.ready)
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
543
72614
93f033c7cfea PyUnicode_Ready() now sets ascii=1 if maxchar < 128
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72603
diff changeset
544 /* PyUnicode_READY() does less work than _PyUnicode_Ready() in the best
72475
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
545 case. If the canonical representation is not yet set, it will still call
72614
93f033c7cfea PyUnicode_Ready() now sets ascii=1 if maxchar < 128
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72603
diff changeset
546 _PyUnicode_Ready().
72475
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
547 Returns 0 on success and -1 on errors. */
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
548 #define PyUnicode_READY(op) \
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
549 (assert(PyUnicode_Check(op)), \
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
550 (PyUnicode_IS_READY(op) ? \
72529
2fc483009f6d _PyUnicode_Ready() cannot be used on ready strings anymore
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72528
diff changeset
551 0 : _PyUnicode_Ready((PyObject *)(op))))
72475
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
552
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
553 /* Return a maximum character value which is suitable for creating another
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
554 string based on op. This is always an approximation but more efficient
72689
aa79b4e62c38 Fix a few typos in the unicode header.
Georg Brandl <georg@python.org>
parents: 72688
diff changeset
555 than iterating over the string. */
72475
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
556 #define PyUnicode_MAX_CHAR_VALUE(op) \
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
557 (assert(PyUnicode_IS_READY(op)), \
72904
f60e8228aeb2 Simplify PyUnicode_MAX_CHAR_VALUE
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72836
diff changeset
558 (PyUnicode_IS_ASCII(op) ? \
f60e8228aeb2 Simplify PyUnicode_MAX_CHAR_VALUE
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72836
diff changeset
559 (0x7f) : \
72475
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
560 (PyUnicode_KIND(op) == PyUnicode_1BYTE_KIND ? \
72904
f60e8228aeb2 Simplify PyUnicode_MAX_CHAR_VALUE
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72836
diff changeset
561 (0xffU) : \
72475
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
562 (PyUnicode_KIND(op) == PyUnicode_2BYTE_KIND ? \
72904
f60e8228aeb2 Simplify PyUnicode_MAX_CHAR_VALUE
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72836
diff changeset
563 (0xffffU) : \
f60e8228aeb2 Simplify PyUnicode_MAX_CHAR_VALUE
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72836
diff changeset
564 (0x10ffffU)))))
72475
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
565
66664
62b61abd02b8 Merge branches/pep-0384.
Martin v. Löwis <martin@v.loewis.de>
parents: 66203
diff changeset
566 #endif
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
567
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
568 /* --- Constants ---------------------------------------------------------- */
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
569
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
570 /* This Unicode character will be used as replacement character during
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
571 decoding if the errors argument is set to "replace". Note: the
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
572 Unicode character U+FFFD is the official REPLACEMENT CHARACTER in
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
573 Unicode 3.0. */
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
574
72488
17626ba912fb Set Py_UNICODE_REPLACEMENT_CHARACTER type to Py_UCS4, instead of Py_UNICODE
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72475
diff changeset
575 #define Py_UNICODE_REPLACEMENT_CHARACTER ((Py_UCS4) 0xFFFD)
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
576
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
577 /* === Public API ========================================================= */
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
578
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
579 /* --- Plain Py_UNICODE --------------------------------------------------- */
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
580
72475
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
581 /* With PEP 393, this is the recommended way to allocate a new unicode object.
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
582 This function will allocate the object and its buffer in a single memory
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
583 block. Objects created using this function are not resizable. */
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
584 #ifndef Py_LIMITED_API
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
585 PyAPI_FUNC(PyObject*) PyUnicode_New(
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
586 Py_ssize_t size, /* Number of code points in the new string */
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
587 Py_UCS4 maxchar /* maximum code point value in the string */
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
588 );
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
589 #endif
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
590
72529
2fc483009f6d _PyUnicode_Ready() cannot be used on ready strings anymore
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72528
diff changeset
591 /* Initializes the canonical string representation from a the deprecated
2fc483009f6d _PyUnicode_Ready() cannot be used on ready strings anymore
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72528
diff changeset
592 wstr/Py_UNICODE representation. This function is used to convert Unicode
2fc483009f6d _PyUnicode_Ready() cannot be used on ready strings anymore
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72528
diff changeset
593 objects which were created using the old API to the new flexible format
2fc483009f6d _PyUnicode_Ready() cannot be used on ready strings anymore
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72528
diff changeset
594 introduced with PEP 393.
2fc483009f6d _PyUnicode_Ready() cannot be used on ready strings anymore
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72528
diff changeset
595
2fc483009f6d _PyUnicode_Ready() cannot be used on ready strings anymore
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72528
diff changeset
596 Don't call this function directly, use the public PyUnicode_READY() macro
2fc483009f6d _PyUnicode_Ready() cannot be used on ready strings anymore
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72528
diff changeset
597 instead. */
72475
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
598 #ifndef Py_LIMITED_API
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
599 PyAPI_FUNC(int) _PyUnicode_Ready(
72529
2fc483009f6d _PyUnicode_Ready() cannot be used on ready strings anymore
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72528
diff changeset
600 PyObject *unicode /* Unicode object */
72475
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
601 );
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
602 #endif
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
603
72546
c75b04996f54 Add PyUnicode_Copy() function, include it to the public API
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72529
diff changeset
604 /* Get a copy of a Unicode string. */
c75b04996f54 Add PyUnicode_Copy() function, include it to the public API
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72529
diff changeset
605 PyAPI_FUNC(PyObject*) PyUnicode_Copy(
c75b04996f54 Add PyUnicode_Copy() function, include it to the public API
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72529
diff changeset
606 PyObject *unicode
c75b04996f54 Add PyUnicode_Copy() function, include it to the public API
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72529
diff changeset
607 );
c75b04996f54 Add PyUnicode_Copy() function, include it to the public API
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72529
diff changeset
608
72475
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
609 /* Copy character from one unicode object into another, this function performs
72492
e69b7f21823f PyUnicode_CopyCharacters() checks for buffer and character overflow
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72491
diff changeset
610 character conversion when necessary and falls back to memcpy if possible.
e69b7f21823f PyUnicode_CopyCharacters() checks for buffer and character overflow
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72491
diff changeset
611
72527
a11970b158f2 Add a note in PyUnicode_CopyCharacters() doc: it doesn't write null character
Victor Stinner <vstinner@wyplay.com>
parents: 72506
diff changeset
612 Fail if to is too small (smaller than how_many or smaller than
a11970b158f2 Add a note in PyUnicode_CopyCharacters() doc: it doesn't write null character
Victor Stinner <vstinner@wyplay.com>
parents: 72506
diff changeset
613 len(from)-from_start), or if kind(from[from_start:from_start+how_many]) >
a11970b158f2 Add a note in PyUnicode_CopyCharacters() doc: it doesn't write null character
Victor Stinner <vstinner@wyplay.com>
parents: 72506
diff changeset
614 kind(to), or if to has more than 1 reference.
72492
e69b7f21823f PyUnicode_CopyCharacters() checks for buffer and character overflow
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72491
diff changeset
615
e69b7f21823f PyUnicode_CopyCharacters() checks for buffer and character overflow
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72491
diff changeset
616 Return the number of written character, or return -1 and raise an exception
e69b7f21823f PyUnicode_CopyCharacters() checks for buffer and character overflow
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72491
diff changeset
617 on error.
e69b7f21823f PyUnicode_CopyCharacters() checks for buffer and character overflow
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72491
diff changeset
618
e69b7f21823f PyUnicode_CopyCharacters() checks for buffer and character overflow
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72491
diff changeset
619 Pseudo-code:
e69b7f21823f PyUnicode_CopyCharacters() checks for buffer and character overflow
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72491
diff changeset
620
e69b7f21823f PyUnicode_CopyCharacters() checks for buffer and character overflow
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72491
diff changeset
621 how_many = min(how_many, len(from) - from_start)
e69b7f21823f PyUnicode_CopyCharacters() checks for buffer and character overflow
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72491
diff changeset
622 to[to_start:to_start+how_many] = from[from_start:from_start+how_many]
e69b7f21823f PyUnicode_CopyCharacters() checks for buffer and character overflow
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72491
diff changeset
623 return how_many
72527
a11970b158f2 Add a note in PyUnicode_CopyCharacters() doc: it doesn't write null character
Victor Stinner <vstinner@wyplay.com>
parents: 72506
diff changeset
624
a11970b158f2 Add a note in PyUnicode_CopyCharacters() doc: it doesn't write null character
Victor Stinner <vstinner@wyplay.com>
parents: 72506
diff changeset
625 Note: The function doesn't write a terminating null character.
72492
e69b7f21823f PyUnicode_CopyCharacters() checks for buffer and character overflow
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72491
diff changeset
626 */
72475
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
627 #ifndef Py_LIMITED_API
72492
e69b7f21823f PyUnicode_CopyCharacters() checks for buffer and character overflow
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72491
diff changeset
628 PyAPI_FUNC(Py_ssize_t) PyUnicode_CopyCharacters(
72475
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
629 PyObject *to,
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
630 Py_ssize_t to_start,
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
631 PyObject *from,
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
632 Py_ssize_t from_start,
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
633 Py_ssize_t how_many
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
634 );
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
635 #endif
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
636
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
637 /* Create a Unicode Object from the Py_UNICODE buffer u of the given
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
638 size.
17618
b44ba7c01217 This patch originated from an idea by Martin v. Loewis who submitted a
Marc-André Lemburg <mal@egenix.com>
parents: 13917
diff changeset
639
b44ba7c01217 This patch originated from an idea by Martin v. Loewis who submitted a
Marc-André Lemburg <mal@egenix.com>
parents: 13917
diff changeset
640 u may be NULL which causes the contents to be undefined. It is the
b44ba7c01217 This patch originated from an idea by Martin v. Loewis who submitted a
Marc-André Lemburg <mal@egenix.com>
parents: 13917
diff changeset
641 user's responsibility to fill in the needed data afterwards. Note
b44ba7c01217 This patch originated from an idea by Martin v. Loewis who submitted a
Marc-André Lemburg <mal@egenix.com>
parents: 13917
diff changeset
642 that modifying the Unicode object contents after construction is
b44ba7c01217 This patch originated from an idea by Martin v. Loewis who submitted a
Marc-André Lemburg <mal@egenix.com>
parents: 13917
diff changeset
643 only allowed if u was set to NULL.
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
644
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
645 The buffer is copied into the new object. */
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
646
66664
62b61abd02b8 Merge branches/pep-0384.
Martin v. Löwis <martin@v.loewis.de>
parents: 66203
diff changeset
647 #ifndef Py_LIMITED_API
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 24737
diff changeset
648 PyAPI_FUNC(PyObject*) PyUnicode_FromUnicode(
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
649 const Py_UNICODE *u, /* Unicode buffer */
36501
7fdc639bc5b4 Merge ssize_t branch.
Martin v. Löwis <martin@v.loewis.de>
parents: 35808
diff changeset
650 Py_ssize_t size /* size of buffer */
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
651 );
66664
62b61abd02b8 Merge branches/pep-0384.
Martin v. Löwis <martin@v.loewis.de>
parents: 66203
diff changeset
652 #endif
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
653
65113
c9879b3402e4 Merged revisions 82262,82269,82434,82480-82481,82484-82485,82487-82488,82594,82599,82615 via svnmerge from
Georg Brandl <georg@python.org>
parents: 61577
diff changeset
654 /* Similar to PyUnicode_FromUnicode(), but u points to UTF-8 encoded bytes */
41766
d6aa7edf217a Add 'U'/'U#' format characters to Py_BuildValue (and thus
Walter Dörwald <walter@livinglogic.de>
parents: 41619
diff changeset
655 PyAPI_FUNC(PyObject*) PyUnicode_FromStringAndSize(
67152
f61196453c78 Issue #9738: Ooops, fix typos in my previous commit (r87506)
Victor Stinner <victor.stinner@haypocalc.com>
parents: 67150
diff changeset
656 const char *u, /* UTF-8 encoded string */
67150
4bb7f7b151fe Issue #9738: document encodings of unicode functions
Victor Stinner <victor.stinner@haypocalc.com>
parents: 66751
diff changeset
657 Py_ssize_t size /* size of buffer */
41766
d6aa7edf217a Add 'U'/'U#' format characters to Py_BuildValue (and thus
Walter Dörwald <walter@livinglogic.de>
parents: 41619
diff changeset
658 );
d6aa7edf217a Add 'U'/'U#' format characters to Py_BuildValue (and thus
Walter Dörwald <walter@livinglogic.de>
parents: 41619
diff changeset
659
41619
61acfb831633 Add PyUnicode_FromString(), which create a unicode object from a
Walter Dörwald <walter@livinglogic.de>
parents: 41587
diff changeset
660 /* Similar to PyUnicode_FromUnicode(), but u points to null-terminated
72475
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
661 UTF-8 encoded bytes. The size is determined with strlen(). */
41619
61acfb831633 Add PyUnicode_FromString(), which create a unicode object from a
Walter Dörwald <walter@livinglogic.de>
parents: 41587
diff changeset
662 PyAPI_FUNC(PyObject*) PyUnicode_FromString(
67150
4bb7f7b151fe Issue #9738: document encodings of unicode functions
Victor Stinner <victor.stinner@haypocalc.com>
parents: 66751
diff changeset
663 const char *u /* UTF-8 encoded string */
41619
61acfb831633 Add PyUnicode_FromString(), which create a unicode object from a
Walter Dörwald <walter@livinglogic.de>
parents: 41587
diff changeset
664 );
61acfb831633 Add PyUnicode_FromString(), which create a unicode object from a
Walter Dörwald <walter@livinglogic.de>
parents: 41587
diff changeset
665
72685
61ca5262b6c4 Speedup str[a:b] and PyUnicode_FromKindAndData
Victor Stinner <vstinner@wyplay.com>
parents: 72632
diff changeset
666 /* Create a new string from a buffer of Py_UCS1, Py_UCS2 or Py_UCS4 characters.
61ca5262b6c4 Speedup str[a:b] and PyUnicode_FromKindAndData
Victor Stinner <vstinner@wyplay.com>
parents: 72632
diff changeset
667 Scan the string to find the maximum character. */
72475
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
668 #ifndef Py_LIMITED_API
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
669 PyAPI_FUNC(PyObject*) PyUnicode_FromKindAndData(
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
670 int kind,
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
671 const void *buffer,
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
672 Py_ssize_t size);
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
673 #endif
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
674
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
675 PyAPI_FUNC(PyObject*) PyUnicode_Substring(
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
676 PyObject *str,
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
677 Py_ssize_t start,
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
678 Py_ssize_t end);
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
679
72785
fe65c75c9f9d Update C API docs for PEP 393.
Georg Brandl <georg@python.org>
parents: 72752
diff changeset
680 /* Copy the string into a UCS4 buffer including the null character if copy_null
72475
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
681 is set. Return NULL and raise an exception on error. Raise a ValueError if
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
682 the buffer is smaller than the string. Return buffer on success.
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
683
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
684 buflen is the length of the buffer in (Py_UCS4) characters. */
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
685 PyAPI_FUNC(Py_UCS4*) PyUnicode_AsUCS4(
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
686 PyObject *unicode,
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
687 Py_UCS4* buffer,
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
688 Py_ssize_t buflen,
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
689 int copy_null);
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
690
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
691 /* Copy the string into a UCS4 buffer. A new buffer is allocated using
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
692 * PyMem_Malloc; if this fails, NULL is returned with a memory error
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
693 exception set. */
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
694 PyAPI_FUNC(Py_UCS4*) PyUnicode_AsUCS4Copy(PyObject *unicode);
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
695
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
696 /* Return a read-only pointer to the Unicode object's internal
72475
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
697 Py_UNICODE buffer.
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
698 If the wchar_t/Py_UNICODE representation is not yet available, this
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
699 function will calculate it. */
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
700
66664
62b61abd02b8 Merge branches/pep-0384.
Martin v. Löwis <martin@v.loewis.de>
parents: 66203
diff changeset
701 #ifndef Py_LIMITED_API
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 24737
diff changeset
702 PyAPI_FUNC(Py_UNICODE *) PyUnicode_AsUnicode(
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
703 PyObject *unicode /* Unicode object */
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
704 );
66664
62b61abd02b8 Merge branches/pep-0384.
Martin v. Löwis <martin@v.loewis.de>
parents: 66203
diff changeset
705 #endif
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
706
72475
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
707 /* Return a read-only pointer to the Unicode object's internal
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
708 Py_UNICODE buffer and save the length at size.
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
709 If the wchar_t/Py_UNICODE representation is not yet available, this
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
710 function will calculate it. */
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
711
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
712 #ifndef Py_LIMITED_API
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
713 PyAPI_FUNC(Py_UNICODE *) PyUnicode_AsUnicodeAndSize(
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
714 PyObject *unicode, /* Unicode object */
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
715 Py_ssize_t *size /* location where to save the length */
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
716 );
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
717 #endif
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
718
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
719 /* Get the length of the Unicode object. */
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
720
72475
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
721 PyAPI_FUNC(Py_ssize_t) PyUnicode_GetLength(
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
722 PyObject *unicode
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
723 );
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
724
72494
93cc591cffe4 Strip trailing spaces in unicodeobject.[ch]
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72492
diff changeset
725 /* Get the number of Py_UNICODE units in the
72475
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
726 string representation. */
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
727
36501
7fdc639bc5b4 Merge ssize_t branch.
Martin v. Löwis <martin@v.loewis.de>
parents: 35808
diff changeset
728 PyAPI_FUNC(Py_ssize_t) PyUnicode_GetSize(
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
729 PyObject *unicode /* Unicode object */
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
730 );
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
731
72475
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
732 /* Read a character from the string. */
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
733
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
734 PyAPI_FUNC(Py_UCS4) PyUnicode_ReadChar(
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
735 PyObject *unicode,
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
736 Py_ssize_t index
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
737 );
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
738
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
739 /* Write a character to the string. The string must have been created through
72575
99aa46107a22 PyUnicode_WriteChar() raises IndexError on invalid index
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72559
diff changeset
740 PyUnicode_New, must not be shared, and must not have been hashed yet.
99aa46107a22 PyUnicode_WriteChar() raises IndexError on invalid index
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72559
diff changeset
741
99aa46107a22 PyUnicode_WriteChar() raises IndexError on invalid index
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72559
diff changeset
742 Return 0 on success, -1 on error. */
72475
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
743
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
744 PyAPI_FUNC(int) PyUnicode_WriteChar(
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
745 PyObject *unicode,
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
746 Py_ssize_t index,
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
747 Py_UCS4 character
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
748 );
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
749
66664
62b61abd02b8 Merge branches/pep-0384.
Martin v. Löwis <martin@v.loewis.de>
parents: 66203
diff changeset
750 #ifndef Py_LIMITED_API
18298
982163c4e9d2 Encode surrogates in UTF-8 even for a wide Py_UNICODE.
Martin v. Löwis <martin@v.loewis.de>
parents: 18296
diff changeset
751 /* Get the maximum ordinal for a Unicode character. */
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 24737
diff changeset
752 PyAPI_FUNC(Py_UNICODE) PyUnicode_GetMax(void);
66664
62b61abd02b8 Merge branches/pep-0384.
Martin v. Löwis <martin@v.loewis.de>
parents: 66203
diff changeset
753 #endif
18298
982163c4e9d2 Encode surrogates in UTF-8 even for a wide Py_UNICODE.
Martin v. Löwis <martin@v.loewis.de>
parents: 18296
diff changeset
754
72621
fe10f0bcc860 Improve string forms and PyUnicode_Resize() documentation
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72617
diff changeset
755 /* Resize an Unicode object allocated by the legacy API (e.g.
fe10f0bcc860 Improve string forms and PyUnicode_Resize() documentation
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72617
diff changeset
756 PyUnicode_FromUnicode). Unicode objects allocated by the new API (e.g.
fe10f0bcc860 Improve string forms and PyUnicode_Resize() documentation
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72617
diff changeset
757 PyUnicode_New) cannot be resized by this function.
fe10f0bcc860 Improve string forms and PyUnicode_Resize() documentation
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72617
diff changeset
758
fe10f0bcc860 Improve string forms and PyUnicode_Resize() documentation
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72617
diff changeset
759 The length is a number of Py_UNICODE characters (and not the number of code
fe10f0bcc860 Improve string forms and PyUnicode_Resize() documentation
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72617
diff changeset
760 points).
12326
9488e4fdafe4 Marc-Andre Lemburg: New exported API PyUnicode_Resize().
Guido van Rossum <guido@python.org>
parents: 12248
diff changeset
761
9488e4fdafe4 Marc-Andre Lemburg: New exported API PyUnicode_Resize().
Guido van Rossum <guido@python.org>
parents: 12248
diff changeset
762 *unicode is modified to point to the new (resized) object and 0
9488e4fdafe4 Marc-Andre Lemburg: New exported API PyUnicode_Resize().
Guido van Rossum <guido@python.org>
parents: 12248
diff changeset
763 returned on success.
9488e4fdafe4 Marc-Andre Lemburg: New exported API PyUnicode_Resize().
Guido van Rossum <guido@python.org>
parents: 12248
diff changeset
764
72621
fe10f0bcc860 Improve string forms and PyUnicode_Resize() documentation
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72617
diff changeset
765 If the refcount on the object is 1, the function resizes the string in
fe10f0bcc860 Improve string forms and PyUnicode_Resize() documentation
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72617
diff changeset
766 place, which is usually faster than allocating a new string (and copy
fe10f0bcc860 Improve string forms and PyUnicode_Resize() documentation
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72617
diff changeset
767 characters).
12326
9488e4fdafe4 Marc-Andre Lemburg: New exported API PyUnicode_Resize().
Guido van Rossum <guido@python.org>
parents: 12248
diff changeset
768
9488e4fdafe4 Marc-Andre Lemburg: New exported API PyUnicode_Resize().
Guido van Rossum <guido@python.org>
parents: 12248
diff changeset
769 Error handling is implemented as follows: an exception is set, -1
72621
fe10f0bcc860 Improve string forms and PyUnicode_Resize() documentation
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72617
diff changeset
770 is returned and *unicode left untouched. */
12326
9488e4fdafe4 Marc-Andre Lemburg: New exported API PyUnicode_Resize().
Guido van Rossum <guido@python.org>
parents: 12248
diff changeset
771
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 24737
diff changeset
772 PyAPI_FUNC(int) PyUnicode_Resize(
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
773 PyObject **unicode, /* Pointer to the Unicode object */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
774 Py_ssize_t length /* New length */
12326
9488e4fdafe4 Marc-Andre Lemburg: New exported API PyUnicode_Resize().
Guido van Rossum <guido@python.org>
parents: 12248
diff changeset
775 );
9488e4fdafe4 Marc-Andre Lemburg: New exported API PyUnicode_Resize().
Guido van Rossum <guido@python.org>
parents: 12248
diff changeset
776
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
777 /* Coerce obj to an Unicode object and return a reference with
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
778 *incremented* refcount.
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
779
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
780 Coercion is done in the following way:
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
781
65113
c9879b3402e4 Merged revisions 82262,82269,82434,82480-82481,82484-82485,82487-82488,82594,82599,82615 via svnmerge from
Georg Brandl <georg@python.org>
parents: 61577
diff changeset
782 1. bytes, bytearray and other char buffer compatible objects are decoded
66206
52fe60216e89 Merged revisions 86478 via svnmerge from
Alexander Belopolsky <alexander.belopolsky@gmail.com>
parents: 65113
diff changeset
783 under the assumptions that they contain data using the UTF-8
52fe60216e89 Merged revisions 86478 via svnmerge from
Alexander Belopolsky <alexander.belopolsky@gmail.com>
parents: 65113
diff changeset
784 encoding. Decoding is done in "strict" mode.
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
785
20554
0336ee5b46d4 SF patch #470578: Fixes to synchronize unicode() and str()
Guido van Rossum <guido@python.org>
parents: 19998
diff changeset
786 2. All other objects (including Unicode objects) raise an
0336ee5b46d4 SF patch #470578: Fixes to synchronize unicode() and str()
Guido van Rossum <guido@python.org>
parents: 19998
diff changeset
787 exception.
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
788
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
789 The API returns NULL in case of an error. The caller is responsible
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
790 for decref'ing the returned objects.
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
791
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
792 */
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
793
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 24737
diff changeset
794 PyAPI_FUNC(PyObject*) PyUnicode_FromEncodedObject(
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
795 register PyObject *obj, /* Object */
13401
8f1a2deeb9b0 Added new API PyUnicode_FromEncodedObject() which supports decoding
Marc-André Lemburg <mal@egenix.com>
parents: 13393
diff changeset
796 const char *encoding, /* encoding */
8f1a2deeb9b0 Added new API PyUnicode_FromEncodedObject() which supports decoding
Marc-André Lemburg <mal@egenix.com>
parents: 13393
diff changeset
797 const char *errors /* error handling */
8f1a2deeb9b0 Added new API PyUnicode_FromEncodedObject() which supports decoding
Marc-André Lemburg <mal@egenix.com>
parents: 13393
diff changeset
798 );
8f1a2deeb9b0 Added new API PyUnicode_FromEncodedObject() which supports decoding
Marc-André Lemburg <mal@egenix.com>
parents: 13393
diff changeset
799
20554
0336ee5b46d4 SF patch #470578: Fixes to synchronize unicode() and str()
Guido van Rossum <guido@python.org>
parents: 19998
diff changeset
800 /* Coerce obj to an Unicode object and return a reference with
13401
8f1a2deeb9b0 Added new API PyUnicode_FromEncodedObject() which supports decoding
Marc-André Lemburg <mal@egenix.com>
parents: 13393
diff changeset
801 *incremented* refcount.
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
802
20554
0336ee5b46d4 SF patch #470578: Fixes to synchronize unicode() and str()
Guido van Rossum <guido@python.org>
parents: 19998
diff changeset
803 Unicode objects are passed back as-is (subclasses are converted to
0336ee5b46d4 SF patch #470578: Fixes to synchronize unicode() and str()
Guido van Rossum <guido@python.org>
parents: 19998
diff changeset
804 true Unicode objects), all other objects are delegated to
0336ee5b46d4 SF patch #470578: Fixes to synchronize unicode() and str()
Guido van Rossum <guido@python.org>
parents: 19998
diff changeset
805 PyUnicode_FromEncodedObject(obj, NULL, "strict") which results in
65113
c9879b3402e4 Merged revisions 82262,82269,82434,82480-82481,82484-82485,82487-82488,82594,82599,82615 via svnmerge from
Georg Brandl <georg@python.org>
parents: 61577
diff changeset
806 using UTF-8 encoding as basis for decoding the object.
13401
8f1a2deeb9b0 Added new API PyUnicode_FromEncodedObject() which supports decoding
Marc-André Lemburg <mal@egenix.com>
parents: 13393
diff changeset
807
8f1a2deeb9b0 Added new API PyUnicode_FromEncodedObject() which supports decoding
Marc-André Lemburg <mal@egenix.com>
parents: 13393
diff changeset
808 The API returns NULL in case of an error. The caller is responsible
8f1a2deeb9b0 Added new API PyUnicode_FromEncodedObject() which supports decoding
Marc-André Lemburg <mal@egenix.com>
parents: 13393
diff changeset
809 for decref'ing the returned objects.
8f1a2deeb9b0 Added new API PyUnicode_FromEncodedObject() which supports decoding
Marc-André Lemburg <mal@egenix.com>
parents: 13393
diff changeset
810
8f1a2deeb9b0 Added new API PyUnicode_FromEncodedObject() which supports decoding
Marc-André Lemburg <mal@egenix.com>
parents: 13393
diff changeset
811 */
8f1a2deeb9b0 Added new API PyUnicode_FromEncodedObject() which supports decoding
Marc-André Lemburg <mal@egenix.com>
parents: 13393
diff changeset
812
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 24737
diff changeset
813 PyAPI_FUNC(PyObject*) PyUnicode_FromObject(
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
814 register PyObject *obj /* Object */
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
815 );
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
816
64639
1cfad55de5bd Issue #9738: PyUnicode_FromFormat() and PyErr_Format() raise an error on
Victor Stinner <victor.stinner@haypocalc.com>
parents: 64397
diff changeset
817 PyAPI_FUNC(PyObject *) PyUnicode_FromFormatV(
1cfad55de5bd Issue #9738: PyUnicode_FromFormat() and PyErr_Format() raise an error on
Victor Stinner <victor.stinner@haypocalc.com>
parents: 64397
diff changeset
818 const char *format, /* ASCII-encoded string */
1cfad55de5bd Issue #9738: PyUnicode_FromFormat() and PyErr_Format() raise an error on
Victor Stinner <victor.stinner@haypocalc.com>
parents: 64397
diff changeset
819 va_list vargs
1cfad55de5bd Issue #9738: PyUnicode_FromFormat() and PyErr_Format() raise an error on
Victor Stinner <victor.stinner@haypocalc.com>
parents: 64397
diff changeset
820 );
1cfad55de5bd Issue #9738: PyUnicode_FromFormat() and PyErr_Format() raise an error on
Victor Stinner <victor.stinner@haypocalc.com>
parents: 64397
diff changeset
821 PyAPI_FUNC(PyObject *) PyUnicode_FromFormat(
1cfad55de5bd Issue #9738: PyUnicode_FromFormat() and PyErr_Format() raise an error on
Victor Stinner <victor.stinner@haypocalc.com>
parents: 64397
diff changeset
822 const char *format, /* ASCII-encoded string */
1cfad55de5bd Issue #9738: PyUnicode_FromFormat() and PyErr_Format() raise an error on
Victor Stinner <victor.stinner@haypocalc.com>
parents: 64397
diff changeset
823 ...
1cfad55de5bd Issue #9738: PyUnicode_FromFormat() and PyErr_Format() raise an error on
Victor Stinner <victor.stinner@haypocalc.com>
parents: 64397
diff changeset
824 );
41766
d6aa7edf217a Add 'U'/'U#' format characters to Py_BuildValue (and thus
Walter Dörwald <walter@livinglogic.de>
parents: 41619
diff changeset
825
66664
62b61abd02b8 Merge branches/pep-0384.
Martin v. Löwis <martin@v.loewis.de>
parents: 66203
diff changeset
826 #ifndef Py_LIMITED_API
47393
0da27fdf0192 Refactor and clean up str.format() code (and helpers) in advance of optimizations.
Eric Smith <eric@trueblade.com>
parents: 46909
diff changeset
827 /* Format the object based on the format_spec, as defined in PEP 3101
0da27fdf0192 Refactor and clean up str.format() code (and helpers) in advance of optimizations.
Eric Smith <eric@trueblade.com>
parents: 46909
diff changeset
828 (Advanced String Formatting). */
0da27fdf0192 Refactor and clean up str.format() code (and helpers) in advance of optimizations.
Eric Smith <eric@trueblade.com>
parents: 46909
diff changeset
829 PyAPI_FUNC(PyObject *) _PyUnicode_FormatAdvanced(PyObject *obj,
72475
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
830 PyObject *format_spec,
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
831 Py_ssize_t start,
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
832 Py_ssize_t end);
66664
62b61abd02b8 Merge branches/pep-0384.
Martin v. Löwis <martin@v.loewis.de>
parents: 66203
diff changeset
833 #endif
47393
0da27fdf0192 Refactor and clean up str.format() code (and helpers) in advance of optimizations.
Eric Smith <eric@trueblade.com>
parents: 46909
diff changeset
834
41876
dcb43f40390b Add interning of unicode strings by copying the functionality from
Walter Dörwald <walter@livinglogic.de>
parents: 41769
diff changeset
835 PyAPI_FUNC(void) PyUnicode_InternInPlace(PyObject **);
dcb43f40390b Add interning of unicode strings by copying the functionality from
Walter Dörwald <walter@livinglogic.de>
parents: 41769
diff changeset
836 PyAPI_FUNC(void) PyUnicode_InternImmortal(PyObject **);
67150
4bb7f7b151fe Issue #9738: document encodings of unicode functions
Victor Stinner <victor.stinner@haypocalc.com>
parents: 66751
diff changeset
837 PyAPI_FUNC(PyObject *) PyUnicode_InternFromString(
4bb7f7b151fe Issue #9738: document encodings of unicode functions
Victor Stinner <victor.stinner@haypocalc.com>
parents: 66751
diff changeset
838 const char *u /* UTF-8 encoded string */
4bb7f7b151fe Issue #9738: document encodings of unicode functions
Victor Stinner <victor.stinner@haypocalc.com>
parents: 66751
diff changeset
839 );
66664
62b61abd02b8 Merge branches/pep-0384.
Martin v. Löwis <martin@v.loewis.de>
parents: 66203
diff changeset
840 #ifndef Py_LIMITED_API
41876
dcb43f40390b Add interning of unicode strings by copying the functionality from
Walter Dörwald <walter@livinglogic.de>
parents: 41769
diff changeset
841 PyAPI_FUNC(void) _Py_ReleaseInternedUnicodeStrings(void);
66664
62b61abd02b8 Merge branches/pep-0384.
Martin v. Löwis <martin@v.loewis.de>
parents: 66203
diff changeset
842 #endif
41876
dcb43f40390b Add interning of unicode strings by copying the functionality from
Walter Dörwald <walter@livinglogic.de>
parents: 41769
diff changeset
843
dcb43f40390b Add interning of unicode strings by copying the functionality from
Walter Dörwald <walter@livinglogic.de>
parents: 41769
diff changeset
844 /* Use only if you know it's a string */
72475
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
845 #define PyUnicode_CHECK_INTERNED(op) \
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
846 (((PyASCIIObject *)(op))->state.interned)
41876
dcb43f40390b Add interning of unicode strings by copying the functionality from
Walter Dörwald <walter@livinglogic.de>
parents: 41769
diff changeset
847
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
848 /* --- wchar_t support for platforms which support it --------------------- */
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
849
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
850 #ifdef HAVE_WCHAR_H
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
851
65113
c9879b3402e4 Merged revisions 82262,82269,82434,82480-82481,82484-82485,82487-82488,82594,82599,82615 via svnmerge from
Georg Brandl <georg@python.org>
parents: 61577
diff changeset
852 /* Create a Unicode Object from the wchar_t buffer w of the given
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
853 size.
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
854
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
855 The buffer is copied into the new object. */
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
856
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 24737
diff changeset
857 PyAPI_FUNC(PyObject*) PyUnicode_FromWideChar(
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
858 register const wchar_t *w, /* wchar_t buffer */
36501
7fdc639bc5b4 Merge ssize_t branch.
Martin v. Löwis <martin@v.loewis.de>
parents: 35808
diff changeset
859 Py_ssize_t size /* size of buffer */
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
860 );
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
861
34016
264e45baacd5 Correct the handling of 0-termination of PyUnicode_AsWideChar()
Marc-André Lemburg <mal@egenix.com>
parents: 33864
diff changeset
862 /* Copies the Unicode Object contents into the wchar_t buffer w. At
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
863 most size wchar_t characters are copied.
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
864
34016
264e45baacd5 Correct the handling of 0-termination of PyUnicode_AsWideChar()
Marc-André Lemburg <mal@egenix.com>
parents: 33864
diff changeset
865 Note that the resulting wchar_t string may or may not be
264e45baacd5 Correct the handling of 0-termination of PyUnicode_AsWideChar()
Marc-André Lemburg <mal@egenix.com>
parents: 33864
diff changeset
866 0-terminated. It is the responsibility of the caller to make sure
264e45baacd5 Correct the handling of 0-termination of PyUnicode_AsWideChar()
Marc-André Lemburg <mal@egenix.com>
parents: 33864
diff changeset
867 that the wchar_t string is 0-terminated in case this is required by
264e45baacd5 Correct the handling of 0-termination of PyUnicode_AsWideChar()
Marc-André Lemburg <mal@egenix.com>
parents: 33864
diff changeset
868 the application.
264e45baacd5 Correct the handling of 0-termination of PyUnicode_AsWideChar()
Marc-André Lemburg <mal@egenix.com>
parents: 33864
diff changeset
869
264e45baacd5 Correct the handling of 0-termination of PyUnicode_AsWideChar()
Marc-André Lemburg <mal@egenix.com>
parents: 33864
diff changeset
870 Returns the number of wchar_t characters copied (excluding a
264e45baacd5 Correct the handling of 0-termination of PyUnicode_AsWideChar()
Marc-André Lemburg <mal@egenix.com>
parents: 33864
diff changeset
871 possibly trailing 0-termination character) or -1 in case of an
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
872 error. */
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
873
36501
7fdc639bc5b4 Merge ssize_t branch.
Martin v. Löwis <martin@v.loewis.de>
parents: 35808
diff changeset
874 PyAPI_FUNC(Py_ssize_t) PyUnicode_AsWideChar(
66664
62b61abd02b8 Merge branches/pep-0384.
Martin v. Löwis <martin@v.loewis.de>
parents: 66203
diff changeset
875 PyObject *unicode, /* Unicode object */
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
876 register wchar_t *w, /* wchar_t buffer */
36501
7fdc639bc5b4 Merge ssize_t branch.
Martin v. Löwis <martin@v.loewis.de>
parents: 35808
diff changeset
877 Py_ssize_t size /* size of buffer */
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
878 );
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
879
65007
7c7d1d96e2c3 Issue #9979: Create function PyUnicode_AsWideCharString().
Victor Stinner <victor.stinner@haypocalc.com>
parents: 64687
diff changeset
880 /* Convert the Unicode object to a wide character string. The output string
7c7d1d96e2c3 Issue #9979: Create function PyUnicode_AsWideCharString().
Victor Stinner <victor.stinner@haypocalc.com>
parents: 64687
diff changeset
881 always ends with a nul character. If size is not NULL, write the number of
72298
028423c89f8d Fix PyUnicode_AsWideCharString() doc: size doesn't contain the null character
Victor Stinner <victor.stinner@haypocalc.com>
parents: 68257
diff changeset
882 wide characters (excluding the null character) into *size.
65007
7c7d1d96e2c3 Issue #9979: Create function PyUnicode_AsWideCharString().
Victor Stinner <victor.stinner@haypocalc.com>
parents: 64687
diff changeset
883
7c7d1d96e2c3 Issue #9979: Create function PyUnicode_AsWideCharString().
Victor Stinner <victor.stinner@haypocalc.com>
parents: 64687
diff changeset
884 Returns a buffer allocated by PyMem_Alloc() (use PyMem_Free() to free it)
7c7d1d96e2c3 Issue #9979: Create function PyUnicode_AsWideCharString().
Victor Stinner <victor.stinner@haypocalc.com>
parents: 64687
diff changeset
885 on success. On error, returns NULL, *size is undefined and raises a
7c7d1d96e2c3 Issue #9979: Create function PyUnicode_AsWideCharString().
Victor Stinner <victor.stinner@haypocalc.com>
parents: 64687
diff changeset
886 MemoryError. */
7c7d1d96e2c3 Issue #9979: Create function PyUnicode_AsWideCharString().
Victor Stinner <victor.stinner@haypocalc.com>
parents: 64687
diff changeset
887
7c7d1d96e2c3 Issue #9979: Create function PyUnicode_AsWideCharString().
Victor Stinner <victor.stinner@haypocalc.com>
parents: 64687
diff changeset
888 PyAPI_FUNC(wchar_t*) PyUnicode_AsWideCharString(
65157
e3ae5b00ba15 PyUnicode_AsWideCharString() takes a PyObject*, not a PyUnicodeObject*
Victor Stinner <victor.stinner@haypocalc.com>
parents: 65007
diff changeset
889 PyObject *unicode, /* Unicode object */
65007
7c7d1d96e2c3 Issue #9979: Create function PyUnicode_AsWideCharString().
Victor Stinner <victor.stinner@haypocalc.com>
parents: 64687
diff changeset
890 Py_ssize_t *size /* number of characters of the result */
7c7d1d96e2c3 Issue #9979: Create function PyUnicode_AsWideCharString().
Victor Stinner <victor.stinner@haypocalc.com>
parents: 64687
diff changeset
891 );
7c7d1d96e2c3 Issue #9979: Create function PyUnicode_AsWideCharString().
Victor Stinner <victor.stinner@haypocalc.com>
parents: 64687
diff changeset
892
72559
fc7d2c6db61b _PyUnicode_AsKind() is *not* part of the stable ABI
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72554
diff changeset
893 #ifndef Py_LIMITED_API
72475
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
894 PyAPI_FUNC(void*) _PyUnicode_AsKind(PyObject *s, unsigned int kind);
72559
fc7d2c6db61b _PyUnicode_AsKind() is *not* part of the stable ABI
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72554
diff changeset
895 #endif
72475
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
896
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
897 #endif
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
898
24737
eaa87632b1e8 Add C API PyUnicode_FromOrdinal() which exposes unichr() at C level.
Marc-André Lemburg <mal@egenix.com>
parents: 23561
diff changeset
899 /* --- Unicode ordinals --------------------------------------------------- */
eaa87632b1e8 Add C API PyUnicode_FromOrdinal() which exposes unichr() at C level.
Marc-André Lemburg <mal@egenix.com>
parents: 23561
diff changeset
900
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
901 /* Create a Unicode Object from the given Unicode code point ordinal.
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
902
24737
eaa87632b1e8 Add C API PyUnicode_FromOrdinal() which exposes unichr() at C level.
Marc-André Lemburg <mal@egenix.com>
parents: 23561
diff changeset
903 The ordinal must be in range(0x10000) on narrow Python builds
eaa87632b1e8 Add C API PyUnicode_FromOrdinal() which exposes unichr() at C level.
Marc-André Lemburg <mal@egenix.com>
parents: 23561
diff changeset
904 (UCS2), and range(0x110000) on wide builds (UCS4). A ValueError is
eaa87632b1e8 Add C API PyUnicode_FromOrdinal() which exposes unichr() at C level.
Marc-André Lemburg <mal@egenix.com>
parents: 23561
diff changeset
905 raised in case it is not.
eaa87632b1e8 Add C API PyUnicode_FromOrdinal() which exposes unichr() at C level.
Marc-André Lemburg <mal@egenix.com>
parents: 23561
diff changeset
906
eaa87632b1e8 Add C API PyUnicode_FromOrdinal() which exposes unichr() at C level.
Marc-André Lemburg <mal@egenix.com>
parents: 23561
diff changeset
907 */
eaa87632b1e8 Add C API PyUnicode_FromOrdinal() which exposes unichr() at C level.
Marc-André Lemburg <mal@egenix.com>
parents: 23561
diff changeset
908
24753
27ae978bee58 Add name mangling for new PyUnicode_FromOrdinal() and fix declaration
Marc-André Lemburg <mal@egenix.com>
parents: 24752
diff changeset
909 PyAPI_FUNC(PyObject*) PyUnicode_FromOrdinal(int ordinal);
24737
eaa87632b1e8 Add C API PyUnicode_FromOrdinal() which exposes unichr() at C level.
Marc-André Lemburg <mal@egenix.com>
parents: 23561
diff changeset
910
50660
9d093ef89c56 Merged revisions 68440 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents: 50550
diff changeset
911 /* --- Free-list management ----------------------------------------------- */
9d093ef89c56 Merged revisions 68440 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents: 50550
diff changeset
912
9d093ef89c56 Merged revisions 68440 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents: 50550
diff changeset
913 /* Clear the free list used by the Unicode implementation.
9d093ef89c56 Merged revisions 68440 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents: 50550
diff changeset
914
9d093ef89c56 Merged revisions 68440 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents: 50550
diff changeset
915 This can be used to release memory used for objects on the free
9d093ef89c56 Merged revisions 68440 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents: 50550
diff changeset
916 list back to the Python memory allocator.
9d093ef89c56 Merged revisions 68440 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents: 50550
diff changeset
917
9d093ef89c56 Merged revisions 68440 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents: 50550
diff changeset
918 */
9d093ef89c56 Merged revisions 68440 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents: 50550
diff changeset
919
9d093ef89c56 Merged revisions 68440 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents: 50550
diff changeset
920 PyAPI_FUNC(int) PyUnicode_ClearFreeList(void);
9d093ef89c56 Merged revisions 68440 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents: 50550
diff changeset
921
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
922 /* === Builtin Codecs =====================================================
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
923
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
924 Many of these APIs take two arguments encoding and errors. These
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
925 parameters encoding and errors have the same semantics as the ones
66206
52fe60216e89 Merged revisions 86478 via svnmerge from
Alexander Belopolsky <alexander.belopolsky@gmail.com>
parents: 65113
diff changeset
926 of the builtin str() API.
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
927
65113
c9879b3402e4 Merged revisions 82262,82269,82434,82480-82481,82484-82485,82487-82488,82594,82599,82615 via svnmerge from
Georg Brandl <georg@python.org>
parents: 61577
diff changeset
928 Setting encoding to NULL causes the default encoding (UTF-8) to be used.
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
929
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
930 Error handling is set by errors which may also be set to NULL
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
931 meaning to use the default handling defined for the codec. Default
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
932 error handling for all builtin codecs is "strict" (ValueErrors are
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
933 raised).
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
934
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
935 The codecs all use a similar interface. Only deviation from the
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
936 generic ones are documented.
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
937
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
938 */
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
939
12643
06ff966f69d5 M.-A. Lemburg <mal@lemburg.com>:
Fred Drake <fdrake@acm.org>
parents: 12372
diff changeset
940 /* --- Manage the default encoding ---------------------------------------- */
06ff966f69d5 M.-A. Lemburg <mal@lemburg.com>:
Fred Drake <fdrake@acm.org>
parents: 12372
diff changeset
941
66206
52fe60216e89 Merged revisions 86478 via svnmerge from
Alexander Belopolsky <alexander.belopolsky@gmail.com>
parents: 65113
diff changeset
942 /* Returns a pointer to the default encoding (UTF-8) of the
46598
0154df250ef6 Cleanup the Unicode header documentation and formatting a bit.
Marc-André Lemburg <mal@egenix.com>
parents: 45371
diff changeset
943 Unicode object unicode and the size of the encoded representation
0154df250ef6 Cleanup the Unicode header documentation and formatting a bit.
Marc-André Lemburg <mal@egenix.com>
parents: 45371
diff changeset
944 in bytes stored in *size.
43761
658cd34a8c5d Fixed a bug in PyUnicode_DecodeFSDefault. strcmp() returns 0 on success.
Christian Heimes <christian@cheimes.de>
parents: 43569
diff changeset
945
46598
0154df250ef6 Cleanup the Unicode header documentation and formatting a bit.
Marc-André Lemburg <mal@egenix.com>
parents: 45371
diff changeset
946 In case of an error, no *size is set.
42984
3a56e73ae919 Add PyUnicode_AsStringAndSize(), which is like PyUnicode_AsString() but
Guido van Rossum <guido@python.org>
parents: 42896
diff changeset
947
72689
aa79b4e62c38 Fix a few typos in the unicode header.
Georg Brandl <georg@python.org>
parents: 72688
diff changeset
948 This function caches the UTF-8 encoded string in the unicodeobject
aa79b4e62c38 Fix a few typos in the unicode header.
Georg Brandl <georg@python.org>
parents: 72688
diff changeset
949 and subsequent calls will return the same string. The memory is released
72475
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
950 when the unicodeobject is deallocated.
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
951
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
952 _PyUnicode_AsStringAndSize is a #define for PyUnicode_AsUTF8AndSize to
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
953 support the previous internal function with the same behaviour.
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
954
48660
85b67fb5672b Rename PyUnicode_AsString -> _PyUnicode_AsString and
Marc-André Lemburg <mal@egenix.com>
parents: 48358
diff changeset
955 *** This API is for interpreter INTERNAL USE ONLY and will likely
66206
52fe60216e89 Merged revisions 86478 via svnmerge from
Alexander Belopolsky <alexander.belopolsky@gmail.com>
parents: 65113
diff changeset
956 *** be removed or changed in the future.
48660
85b67fb5672b Rename PyUnicode_AsString -> _PyUnicode_AsString and
Marc-André Lemburg <mal@egenix.com>
parents: 48358
diff changeset
957
85b67fb5672b Rename PyUnicode_AsString -> _PyUnicode_AsString and
Marc-André Lemburg <mal@egenix.com>
parents: 48358
diff changeset
958 *** If you need to access the Unicode object as UTF-8 bytes string,
85b67fb5672b Rename PyUnicode_AsString -> _PyUnicode_AsString and
Marc-André Lemburg <mal@egenix.com>
parents: 48358
diff changeset
959 *** please use PyUnicode_AsUTF8String() instead.
42013
cd125fe83051 Make identifiers str (not str8) objects throughout.
Martin v. Löwis <martin@v.loewis.de>
parents: 41876
diff changeset
960 */
cd125fe83051 Make identifiers str (not str8) objects throughout.
Martin v. Löwis <martin@v.loewis.de>
parents: 41876
diff changeset
961
66664
62b61abd02b8 Merge branches/pep-0384.
Martin v. Löwis <martin@v.loewis.de>
parents: 66203
diff changeset
962 #ifndef Py_LIMITED_API
72475
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
963 PyAPI_FUNC(char *) PyUnicode_AsUTF8AndSize(
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
964 PyObject *unicode,
46598
0154df250ef6 Cleanup the Unicode header documentation and formatting a bit.
Marc-André Lemburg <mal@egenix.com>
parents: 45371
diff changeset
965 Py_ssize_t *size);
72475
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
966 #define _PyUnicode_AsStringAndSize PyUnicode_AsUTF8AndSize
66664
62b61abd02b8 Merge branches/pep-0384.
Martin v. Löwis <martin@v.loewis.de>
parents: 66203
diff changeset
967 #endif
42984
3a56e73ae919 Add PyUnicode_AsStringAndSize(), which is like PyUnicode_AsString() but
Guido van Rossum <guido@python.org>
parents: 42896
diff changeset
968
66206
52fe60216e89 Merged revisions 86478 via svnmerge from
Alexander Belopolsky <alexander.belopolsky@gmail.com>
parents: 65113
diff changeset
969 /* Returns a pointer to the default encoding (UTF-8) of the
46598
0154df250ef6 Cleanup the Unicode header documentation and formatting a bit.
Marc-André Lemburg <mal@egenix.com>
parents: 45371
diff changeset
970 Unicode object unicode.
42984
3a56e73ae919 Add PyUnicode_AsStringAndSize(), which is like PyUnicode_AsString() but
Guido van Rossum <guido@python.org>
parents: 42896
diff changeset
971
72475
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
972 Like PyUnicode_AsUTF8AndSize(), this also caches the UTF-8 representation
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
973 in the unicodeobject.
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
974
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
975 _PyUnicode_AsString is a #define for PyUnicode_AsUTF8 to
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
976 support the previous internal function with the same behaviour.
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
977
46598
0154df250ef6 Cleanup the Unicode header documentation and formatting a bit.
Marc-André Lemburg <mal@egenix.com>
parents: 45371
diff changeset
978 Use of this API is DEPRECATED since no size information can be
48660
85b67fb5672b Rename PyUnicode_AsString -> _PyUnicode_AsString and
Marc-André Lemburg <mal@egenix.com>
parents: 48358
diff changeset
979 extracted from the returned data.
85b67fb5672b Rename PyUnicode_AsString -> _PyUnicode_AsString and
Marc-André Lemburg <mal@egenix.com>
parents: 48358
diff changeset
980
85b67fb5672b Rename PyUnicode_AsString -> _PyUnicode_AsString and
Marc-André Lemburg <mal@egenix.com>
parents: 48358
diff changeset
981 *** This API is for interpreter INTERNAL USE ONLY and will likely
85b67fb5672b Rename PyUnicode_AsString -> _PyUnicode_AsString and
Marc-André Lemburg <mal@egenix.com>
parents: 48358
diff changeset
982 *** be removed or changed for Python 3.1.
85b67fb5672b Rename PyUnicode_AsString -> _PyUnicode_AsString and
Marc-André Lemburg <mal@egenix.com>
parents: 48358
diff changeset
983
85b67fb5672b Rename PyUnicode_AsString -> _PyUnicode_AsString and
Marc-André Lemburg <mal@egenix.com>
parents: 48358
diff changeset
984 *** If you need to access the Unicode object as UTF-8 bytes string,
85b67fb5672b Rename PyUnicode_AsString -> _PyUnicode_AsString and
Marc-André Lemburg <mal@egenix.com>
parents: 48358
diff changeset
985 *** please use PyUnicode_AsUTF8String() instead.
42984
3a56e73ae919 Add PyUnicode_AsStringAndSize(), which is like PyUnicode_AsString() but
Guido van Rossum <guido@python.org>
parents: 42896
diff changeset
986
46598
0154df250ef6 Cleanup the Unicode header documentation and formatting a bit.
Marc-André Lemburg <mal@egenix.com>
parents: 45371
diff changeset
987 */
0154df250ef6 Cleanup the Unicode header documentation and formatting a bit.
Marc-André Lemburg <mal@egenix.com>
parents: 45371
diff changeset
988
66664
62b61abd02b8 Merge branches/pep-0384.
Martin v. Löwis <martin@v.loewis.de>
parents: 66203
diff changeset
989 #ifndef Py_LIMITED_API
72475
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
990 PyAPI_FUNC(char *) PyUnicode_AsUTF8(PyObject *unicode);
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
991 #define _PyUnicode_AsString PyUnicode_AsUTF8
66664
62b61abd02b8 Merge branches/pep-0384.
Martin v. Löwis <martin@v.loewis.de>
parents: 66203
diff changeset
992 #endif
46598
0154df250ef6 Cleanup the Unicode header documentation and formatting a bit.
Marc-André Lemburg <mal@egenix.com>
parents: 45371
diff changeset
993
66206
52fe60216e89 Merged revisions 86478 via svnmerge from
Alexander Belopolsky <alexander.belopolsky@gmail.com>
parents: 65113
diff changeset
994 /* Returns "utf-8". */
12643
06ff966f69d5 M.-A. Lemburg <mal@lemburg.com>:
Fred Drake <fdrake@acm.org>
parents: 12372
diff changeset
995
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 24737
diff changeset
996 PyAPI_FUNC(const char*) PyUnicode_GetDefaultEncoding(void);
12643
06ff966f69d5 M.-A. Lemburg <mal@lemburg.com>:
Fred Drake <fdrake@acm.org>
parents: 12372
diff changeset
997
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
998 /* --- Generic Codecs ----------------------------------------------------- */
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
999
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1000 /* Create a Unicode object by decoding the encoded string s of the
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1001 given size. */
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1002
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 24737
diff changeset
1003 PyAPI_FUNC(PyObject*) PyUnicode_Decode(
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1004 const char *s, /* encoded string */
36501
7fdc639bc5b4 Merge ssize_t branch.
Martin v. Löwis <martin@v.loewis.de>
parents: 35808
diff changeset
1005 Py_ssize_t size, /* size of buffer */
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1006 const char *encoding, /* encoding */
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1007 const char *errors /* error handling */
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1008 );
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1009
47496
2284fa89ab08 Move the codec decode type checks to bytes/bytearray.decode().
Marc-André Lemburg <mal@egenix.com>
parents: 47463
diff changeset
1010 /* Decode a Unicode object unicode and return the result as Python
2284fa89ab08 Move the codec decode type checks to bytes/bytearray.decode().
Marc-André Lemburg <mal@egenix.com>
parents: 47463
diff changeset
1011 object. */
2284fa89ab08 Move the codec decode type checks to bytes/bytearray.decode().
Marc-André Lemburg <mal@egenix.com>
parents: 47463
diff changeset
1012
2284fa89ab08 Move the codec decode type checks to bytes/bytearray.decode().
Marc-André Lemburg <mal@egenix.com>
parents: 47463
diff changeset
1013 PyAPI_FUNC(PyObject*) PyUnicode_AsDecodedObject(
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1014 PyObject *unicode, /* Unicode object */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1015 const char *encoding, /* encoding */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1016 const char *errors /* error handling */
47496
2284fa89ab08 Move the codec decode type checks to bytes/bytearray.decode().
Marc-André Lemburg <mal@egenix.com>
parents: 47463
diff changeset
1017 );
2284fa89ab08 Move the codec decode type checks to bytes/bytearray.decode().
Marc-André Lemburg <mal@egenix.com>
parents: 47463
diff changeset
1018
2284fa89ab08 Move the codec decode type checks to bytes/bytearray.decode().
Marc-André Lemburg <mal@egenix.com>
parents: 47463
diff changeset
1019 /* Decode a Unicode object unicode and return the result as Unicode
2284fa89ab08 Move the codec decode type checks to bytes/bytearray.decode().
Marc-André Lemburg <mal@egenix.com>
parents: 47463
diff changeset
1020 object. */
2284fa89ab08 Move the codec decode type checks to bytes/bytearray.decode().
Marc-André Lemburg <mal@egenix.com>
parents: 47463
diff changeset
1021
2284fa89ab08 Move the codec decode type checks to bytes/bytearray.decode().
Marc-André Lemburg <mal@egenix.com>
parents: 47463
diff changeset
1022 PyAPI_FUNC(PyObject*) PyUnicode_AsDecodedUnicode(
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1023 PyObject *unicode, /* Unicode object */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1024 const char *encoding, /* encoding */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1025 const char *errors /* error handling */
47496
2284fa89ab08 Move the codec decode type checks to bytes/bytearray.decode().
Marc-André Lemburg <mal@egenix.com>
parents: 47463
diff changeset
1026 );
2284fa89ab08 Move the codec decode type checks to bytes/bytearray.decode().
Marc-André Lemburg <mal@egenix.com>
parents: 47463
diff changeset
1027
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1028 /* Encodes a Py_UNICODE buffer of the given size and returns a
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1029 Python string object. */
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1030
66664
62b61abd02b8 Merge branches/pep-0384.
Martin v. Löwis <martin@v.loewis.de>
parents: 66203
diff changeset
1031 #ifndef Py_LIMITED_API
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 24737
diff changeset
1032 PyAPI_FUNC(PyObject*) PyUnicode_Encode(
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1033 const Py_UNICODE *s, /* Unicode char buffer */
36501
7fdc639bc5b4 Merge ssize_t branch.
Martin v. Löwis <martin@v.loewis.de>
parents: 35808
diff changeset
1034 Py_ssize_t size, /* number of Py_UNICODE chars to encode */
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1035 const char *encoding, /* encoding */
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1036 const char *errors /* error handling */
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1037 );
66664
62b61abd02b8 Merge branches/pep-0384.
Martin v. Löwis <martin@v.loewis.de>
parents: 66203
diff changeset
1038 #endif
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1039
32551
f46d49e2e0f0 Allow string and unicode return types from .encode()/.decode()
Marc-André Lemburg <mal@egenix.com>
parents: 32197
diff changeset
1040 /* Encodes a Unicode object and returns the result as Python
f46d49e2e0f0 Allow string and unicode return types from .encode()/.decode()
Marc-André Lemburg <mal@egenix.com>
parents: 32197
diff changeset
1041 object. */
f46d49e2e0f0 Allow string and unicode return types from .encode()/.decode()
Marc-André Lemburg <mal@egenix.com>
parents: 32197
diff changeset
1042
f46d49e2e0f0 Allow string and unicode return types from .encode()/.decode()
Marc-André Lemburg <mal@egenix.com>
parents: 32197
diff changeset
1043 PyAPI_FUNC(PyObject*) PyUnicode_AsEncodedObject(
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1044 PyObject *unicode, /* Unicode object */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1045 const char *encoding, /* encoding */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1046 const char *errors /* error handling */
32551
f46d49e2e0f0 Allow string and unicode return types from .encode()/.decode()
Marc-André Lemburg <mal@egenix.com>
parents: 32197
diff changeset
1047 );
f46d49e2e0f0 Allow string and unicode return types from .encode()/.decode()
Marc-André Lemburg <mal@egenix.com>
parents: 32197
diff changeset
1048
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1049 /* Encodes a Unicode object and returns the result as Python string
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1050 object. */
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1051
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 24737
diff changeset
1052 PyAPI_FUNC(PyObject*) PyUnicode_AsEncodedString(
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1053 PyObject *unicode, /* Unicode object */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1054 const char *encoding, /* encoding */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1055 const char *errors /* error handling */
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1056 );
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1057
47496
2284fa89ab08 Move the codec decode type checks to bytes/bytearray.decode().
Marc-André Lemburg <mal@egenix.com>
parents: 47463
diff changeset
1058 /* Encodes a Unicode object and returns the result as Unicode
2284fa89ab08 Move the codec decode type checks to bytes/bytearray.decode().
Marc-André Lemburg <mal@egenix.com>
parents: 47463
diff changeset
1059 object. */
2284fa89ab08 Move the codec decode type checks to bytes/bytearray.decode().
Marc-André Lemburg <mal@egenix.com>
parents: 47463
diff changeset
1060
2284fa89ab08 Move the codec decode type checks to bytes/bytearray.decode().
Marc-André Lemburg <mal@egenix.com>
parents: 47463
diff changeset
1061 PyAPI_FUNC(PyObject*) PyUnicode_AsEncodedUnicode(
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1062 PyObject *unicode, /* Unicode object */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1063 const char *encoding, /* encoding */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1064 const char *errors /* error handling */
47496
2284fa89ab08 Move the codec decode type checks to bytes/bytearray.decode().
Marc-André Lemburg <mal@egenix.com>
parents: 47463
diff changeset
1065 );
2284fa89ab08 Move the codec decode type checks to bytes/bytearray.decode().
Marc-André Lemburg <mal@egenix.com>
parents: 47463
diff changeset
1066
2284fa89ab08 Move the codec decode type checks to bytes/bytearray.decode().
Marc-André Lemburg <mal@egenix.com>
parents: 47463
diff changeset
1067 /* Build an encoding map. */
2284fa89ab08 Move the codec decode type checks to bytes/bytearray.decode().
Marc-André Lemburg <mal@egenix.com>
parents: 47463
diff changeset
1068
38673
a19c20c5e5c7 Merge the rest of the trunk.
Thomas Wouters <thomas@python.org>
parents: 38669
diff changeset
1069 PyAPI_FUNC(PyObject*) PyUnicode_BuildEncodingMap(
a19c20c5e5c7 Merge the rest of the trunk.
Thomas Wouters <thomas@python.org>
parents: 38669
diff changeset
1070 PyObject* string /* 256 character map */
a19c20c5e5c7 Merge the rest of the trunk.
Thomas Wouters <thomas@python.org>
parents: 38669
diff changeset
1071 );
a19c20c5e5c7 Merge the rest of the trunk.
Thomas Wouters <thomas@python.org>
parents: 38669
diff changeset
1072
19998
8a0c97453df4 Patch #435971: UTF-7 codec by Brian Quinlan.
Marc-André Lemburg <mal@egenix.com>
parents: 19980
diff changeset
1073 /* --- UTF-7 Codecs ------------------------------------------------------- */
8a0c97453df4 Patch #435971: UTF-7 codec by Brian Quinlan.
Marc-André Lemburg <mal@egenix.com>
parents: 19980
diff changeset
1074
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 24737
diff changeset
1075 PyAPI_FUNC(PyObject*) PyUnicode_DecodeUTF7(
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1076 const char *string, /* UTF-7 encoded string */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1077 Py_ssize_t length, /* size of string */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1078 const char *errors /* error handling */
19998
8a0c97453df4 Patch #435971: UTF-7 codec by Brian Quinlan.
Marc-André Lemburg <mal@egenix.com>
parents: 19980
diff changeset
1079 );
8a0c97453df4 Patch #435971: UTF-7 codec by Brian Quinlan.
Marc-André Lemburg <mal@egenix.com>
parents: 19980
diff changeset
1080
43933
9c4bf18e5d30 Merged revisions 59056-59076 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 43761
diff changeset
1081 PyAPI_FUNC(PyObject*) PyUnicode_DecodeUTF7Stateful(
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1082 const char *string, /* UTF-7 encoded string */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1083 Py_ssize_t length, /* size of string */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1084 const char *errors, /* error handling */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1085 Py_ssize_t *consumed /* bytes consumed */
43933
9c4bf18e5d30 Merged revisions 59056-59076 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 43761
diff changeset
1086 );
9c4bf18e5d30 Merged revisions 59056-59076 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 43761
diff changeset
1087
66664
62b61abd02b8 Merge branches/pep-0384.
Martin v. Löwis <martin@v.loewis.de>
parents: 66203
diff changeset
1088 #ifndef Py_LIMITED_API
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 24737
diff changeset
1089 PyAPI_FUNC(PyObject*) PyUnicode_EncodeUTF7(
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1090 const Py_UNICODE *data, /* Unicode char buffer */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1091 Py_ssize_t length, /* number of Py_UNICODE chars to encode */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1092 int base64SetO, /* Encode RFC2152 Set O characters in base64 */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1093 int base64WhiteSpace, /* Encode whitespace (sp, ht, nl, cr) in base64 */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1094 const char *errors /* error handling */
19998
8a0c97453df4 Patch #435971: UTF-7 codec by Brian Quinlan.
Marc-André Lemburg <mal@egenix.com>
parents: 19980
diff changeset
1095 );
73476
b3e532c1485e Port encoders from Py_UNICODE API to unicode object API.
Martin v. Löwis <martin@v.loewis.de>
parents: 73457
diff changeset
1096 PyAPI_FUNC(PyObject*) _PyUnicode_EncodeUTF7(
b3e532c1485e Port encoders from Py_UNICODE API to unicode object API.
Martin v. Löwis <martin@v.loewis.de>
parents: 73457
diff changeset
1097 PyObject *unicode, /* Unicode object */
b3e532c1485e Port encoders from Py_UNICODE API to unicode object API.
Martin v. Löwis <martin@v.loewis.de>
parents: 73457
diff changeset
1098 int base64SetO, /* Encode RFC2152 Set O characters in base64 */
b3e532c1485e Port encoders from Py_UNICODE API to unicode object API.
Martin v. Löwis <martin@v.loewis.de>
parents: 73457
diff changeset
1099 int base64WhiteSpace, /* Encode whitespace (sp, ht, nl, cr) in base64 */
b3e532c1485e Port encoders from Py_UNICODE API to unicode object API.
Martin v. Löwis <martin@v.loewis.de>
parents: 73457
diff changeset
1100 const char *errors /* error handling */
b3e532c1485e Port encoders from Py_UNICODE API to unicode object API.
Martin v. Löwis <martin@v.loewis.de>
parents: 73457
diff changeset
1101 );
66664
62b61abd02b8 Merge branches/pep-0384.
Martin v. Löwis <martin@v.loewis.de>
parents: 66203
diff changeset
1102 #endif
19998
8a0c97453df4 Patch #435971: UTF-7 codec by Brian Quinlan.
Marc-André Lemburg <mal@egenix.com>
parents: 19980
diff changeset
1103
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1104 /* --- UTF-8 Codecs ------------------------------------------------------- */
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1105
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 24737
diff changeset
1106 PyAPI_FUNC(PyObject*) PyUnicode_DecodeUTF8(
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1107 const char *string, /* UTF-8 encoded string */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1108 Py_ssize_t length, /* size of string */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1109 const char *errors /* error handling */
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1110 );
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1111
33428
57478a13fbf6 SF patch #998993: The UTF-8 and the UTF-16 stateful decoders now support
Walter Dörwald <walter@livinglogic.de>
parents: 32951
diff changeset
1112 PyAPI_FUNC(PyObject*) PyUnicode_DecodeUTF8Stateful(
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1113 const char *string, /* UTF-8 encoded string */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1114 Py_ssize_t length, /* size of string */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1115 const char *errors, /* error handling */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1116 Py_ssize_t *consumed /* bytes consumed */
33428
57478a13fbf6 SF patch #998993: The UTF-8 and the UTF-16 stateful decoders now support
Walter Dörwald <walter@livinglogic.de>
parents: 32951
diff changeset
1117 );
57478a13fbf6 SF patch #998993: The UTF-8 and the UTF-16 stateful decoders now support
Walter Dörwald <walter@livinglogic.de>
parents: 32951
diff changeset
1118
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 24737
diff changeset
1119 PyAPI_FUNC(PyObject*) PyUnicode_AsUTF8String(
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1120 PyObject *unicode /* Unicode object */
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1121 );
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1122
66664
62b61abd02b8 Merge branches/pep-0384.
Martin v. Löwis <martin@v.loewis.de>
parents: 66203
diff changeset
1123 #ifndef Py_LIMITED_API
72475
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
1124 PyAPI_FUNC(PyObject*) _PyUnicode_AsUTF8String(
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
1125 PyObject *unicode,
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
1126 const char *errors);
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
1127
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 24737
diff changeset
1128 PyAPI_FUNC(PyObject*) PyUnicode_EncodeUTF8(
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1129 const Py_UNICODE *data, /* Unicode char buffer */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1130 Py_ssize_t length, /* number of Py_UNICODE chars to encode */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1131 const char *errors /* error handling */
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1132 );
66664
62b61abd02b8 Merge branches/pep-0384.
Martin v. Löwis <martin@v.loewis.de>
parents: 66203
diff changeset
1133 #endif
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1134
42626
f1a2d51f1cab Apply SF patch #1775604: This adds three new codecs (utf-32, utf-32-le and
Walter Dörwald <walter@livinglogic.de>
parents: 42597
diff changeset
1135 /* --- UTF-32 Codecs ------------------------------------------------------ */
f1a2d51f1cab Apply SF patch #1775604: This adds three new codecs (utf-32, utf-32-le and
Walter Dörwald <walter@livinglogic.de>
parents: 42597
diff changeset
1136
f1a2d51f1cab Apply SF patch #1775604: This adds three new codecs (utf-32, utf-32-le and
Walter Dörwald <walter@livinglogic.de>
parents: 42597
diff changeset
1137 /* Decodes length bytes from a UTF-32 encoded buffer string and returns
f1a2d51f1cab Apply SF patch #1775604: This adds three new codecs (utf-32, utf-32-le and
Walter Dörwald <walter@livinglogic.de>
parents: 42597
diff changeset
1138 the corresponding Unicode object.
f1a2d51f1cab Apply SF patch #1775604: This adds three new codecs (utf-32, utf-32-le and
Walter Dörwald <walter@livinglogic.de>
parents: 42597
diff changeset
1139
f1a2d51f1cab Apply SF patch #1775604: This adds three new codecs (utf-32, utf-32-le and
Walter Dörwald <walter@livinglogic.de>
parents: 42597
diff changeset
1140 errors (if non-NULL) defines the error handling. It defaults
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1141 to "strict".
42626
f1a2d51f1cab Apply SF patch #1775604: This adds three new codecs (utf-32, utf-32-le and
Walter Dörwald <walter@livinglogic.de>
parents: 42597
diff changeset
1142
f1a2d51f1cab Apply SF patch #1775604: This adds three new codecs (utf-32, utf-32-le and
Walter Dörwald <walter@livinglogic.de>
parents: 42597
diff changeset
1143 If byteorder is non-NULL, the decoder starts decoding using the
f1a2d51f1cab Apply SF patch #1775604: This adds three new codecs (utf-32, utf-32-le and
Walter Dörwald <walter@livinglogic.de>
parents: 42597
diff changeset
1144 given byte order:
f1a2d51f1cab Apply SF patch #1775604: This adds three new codecs (utf-32, utf-32-le and
Walter Dörwald <walter@livinglogic.de>
parents: 42597
diff changeset
1145
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1146 *byteorder == -1: little endian
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1147 *byteorder == 0: native order
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1148 *byteorder == 1: big endian
42626
f1a2d51f1cab Apply SF patch #1775604: This adds three new codecs (utf-32, utf-32-le and
Walter Dörwald <walter@livinglogic.de>
parents: 42597
diff changeset
1149
f1a2d51f1cab Apply SF patch #1775604: This adds three new codecs (utf-32, utf-32-le and
Walter Dörwald <walter@livinglogic.de>
parents: 42597
diff changeset
1150 In native mode, the first four bytes of the stream are checked for a
f1a2d51f1cab Apply SF patch #1775604: This adds three new codecs (utf-32, utf-32-le and
Walter Dörwald <walter@livinglogic.de>
parents: 42597
diff changeset
1151 BOM mark. If found, the BOM mark is analysed, the byte order
f1a2d51f1cab Apply SF patch #1775604: This adds three new codecs (utf-32, utf-32-le and
Walter Dörwald <walter@livinglogic.de>
parents: 42597
diff changeset
1152 adjusted and the BOM skipped. In the other modes, no BOM mark
f1a2d51f1cab Apply SF patch #1775604: This adds three new codecs (utf-32, utf-32-le and
Walter Dörwald <walter@livinglogic.de>
parents: 42597
diff changeset
1153 interpretation is done. After completion, *byteorder is set to the
f1a2d51f1cab Apply SF patch #1775604: This adds three new codecs (utf-32, utf-32-le and
Walter Dörwald <walter@livinglogic.de>
parents: 42597
diff changeset
1154 current byte order at the end of input data.
f1a2d51f1cab Apply SF patch #1775604: This adds three new codecs (utf-32, utf-32-le and
Walter Dörwald <walter@livinglogic.de>
parents: 42597
diff changeset
1155
f1a2d51f1cab Apply SF patch #1775604: This adds three new codecs (utf-32, utf-32-le and
Walter Dörwald <walter@livinglogic.de>
parents: 42597
diff changeset
1156 If byteorder is NULL, the codec starts in native order mode.
f1a2d51f1cab Apply SF patch #1775604: This adds three new codecs (utf-32, utf-32-le and
Walter Dörwald <walter@livinglogic.de>
parents: 42597
diff changeset
1157
f1a2d51f1cab Apply SF patch #1775604: This adds three new codecs (utf-32, utf-32-le and
Walter Dörwald <walter@livinglogic.de>
parents: 42597
diff changeset
1158 */
f1a2d51f1cab Apply SF patch #1775604: This adds three new codecs (utf-32, utf-32-le and
Walter Dörwald <walter@livinglogic.de>
parents: 42597
diff changeset
1159
f1a2d51f1cab Apply SF patch #1775604: This adds three new codecs (utf-32, utf-32-le and
Walter Dörwald <walter@livinglogic.de>
parents: 42597
diff changeset
1160 PyAPI_FUNC(PyObject*) PyUnicode_DecodeUTF32(
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1161 const char *string, /* UTF-32 encoded string */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1162 Py_ssize_t length, /* size of string */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1163 const char *errors, /* error handling */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1164 int *byteorder /* pointer to byteorder to use
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1165 0=native;-1=LE,1=BE; updated on
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1166 exit */
42626
f1a2d51f1cab Apply SF patch #1775604: This adds three new codecs (utf-32, utf-32-le and
Walter Dörwald <walter@livinglogic.de>
parents: 42597
diff changeset
1167 );
f1a2d51f1cab Apply SF patch #1775604: This adds three new codecs (utf-32, utf-32-le and
Walter Dörwald <walter@livinglogic.de>
parents: 42597
diff changeset
1168
f1a2d51f1cab Apply SF patch #1775604: This adds three new codecs (utf-32, utf-32-le and
Walter Dörwald <walter@livinglogic.de>
parents: 42597
diff changeset
1169 PyAPI_FUNC(PyObject*) PyUnicode_DecodeUTF32Stateful(
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1170 const char *string, /* UTF-32 encoded string */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1171 Py_ssize_t length, /* size of string */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1172 const char *errors, /* error handling */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1173 int *byteorder, /* pointer to byteorder to use
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1174 0=native;-1=LE,1=BE; updated on
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1175 exit */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1176 Py_ssize_t *consumed /* bytes consumed */
42626
f1a2d51f1cab Apply SF patch #1775604: This adds three new codecs (utf-32, utf-32-le and
Walter Dörwald <walter@livinglogic.de>
parents: 42597
diff changeset
1177 );
f1a2d51f1cab Apply SF patch #1775604: This adds three new codecs (utf-32, utf-32-le and
Walter Dörwald <walter@livinglogic.de>
parents: 42597
diff changeset
1178
f1a2d51f1cab Apply SF patch #1775604: This adds three new codecs (utf-32, utf-32-le and
Walter Dörwald <walter@livinglogic.de>
parents: 42597
diff changeset
1179 /* Returns a Python string using the UTF-32 encoding in native byte
f1a2d51f1cab Apply SF patch #1775604: This adds three new codecs (utf-32, utf-32-le and
Walter Dörwald <walter@livinglogic.de>
parents: 42597
diff changeset
1180 order. The string always starts with a BOM mark. */
f1a2d51f1cab Apply SF patch #1775604: This adds three new codecs (utf-32, utf-32-le and
Walter Dörwald <walter@livinglogic.de>
parents: 42597
diff changeset
1181
f1a2d51f1cab Apply SF patch #1775604: This adds three new codecs (utf-32, utf-32-le and
Walter Dörwald <walter@livinglogic.de>
parents: 42597
diff changeset
1182 PyAPI_FUNC(PyObject*) PyUnicode_AsUTF32String(
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1183 PyObject *unicode /* Unicode object */
42626
f1a2d51f1cab Apply SF patch #1775604: This adds three new codecs (utf-32, utf-32-le and
Walter Dörwald <walter@livinglogic.de>
parents: 42597
diff changeset
1184 );
f1a2d51f1cab Apply SF patch #1775604: This adds three new codecs (utf-32, utf-32-le and
Walter Dörwald <walter@livinglogic.de>
parents: 42597
diff changeset
1185
f1a2d51f1cab Apply SF patch #1775604: This adds three new codecs (utf-32, utf-32-le and
Walter Dörwald <walter@livinglogic.de>
parents: 42597
diff changeset
1186 /* Returns a Python string object holding the UTF-32 encoded value of
f1a2d51f1cab Apply SF patch #1775604: This adds three new codecs (utf-32, utf-32-le and
Walter Dörwald <walter@livinglogic.de>
parents: 42597
diff changeset
1187 the Unicode data.
f1a2d51f1cab Apply SF patch #1775604: This adds three new codecs (utf-32, utf-32-le and
Walter Dörwald <walter@livinglogic.de>
parents: 42597
diff changeset
1188
f1a2d51f1cab Apply SF patch #1775604: This adds three new codecs (utf-32, utf-32-le and
Walter Dörwald <walter@livinglogic.de>
parents: 42597
diff changeset
1189 If byteorder is not 0, output is written according to the following
f1a2d51f1cab Apply SF patch #1775604: This adds three new codecs (utf-32, utf-32-le and
Walter Dörwald <walter@livinglogic.de>
parents: 42597
diff changeset
1190 byte order:
f1a2d51f1cab Apply SF patch #1775604: This adds three new codecs (utf-32, utf-32-le and
Walter Dörwald <walter@livinglogic.de>
parents: 42597
diff changeset
1191
f1a2d51f1cab Apply SF patch #1775604: This adds three new codecs (utf-32, utf-32-le and
Walter Dörwald <walter@livinglogic.de>
parents: 42597
diff changeset
1192 byteorder == -1: little endian
f1a2d51f1cab Apply SF patch #1775604: This adds three new codecs (utf-32, utf-32-le and
Walter Dörwald <walter@livinglogic.de>
parents: 42597
diff changeset
1193 byteorder == 0: native byte order (writes a BOM mark)
f1a2d51f1cab Apply SF patch #1775604: This adds three new codecs (utf-32, utf-32-le and
Walter Dörwald <walter@livinglogic.de>
parents: 42597
diff changeset
1194 byteorder == 1: big endian
f1a2d51f1cab Apply SF patch #1775604: This adds three new codecs (utf-32, utf-32-le and
Walter Dörwald <walter@livinglogic.de>
parents: 42597
diff changeset
1195
f1a2d51f1cab Apply SF patch #1775604: This adds three new codecs (utf-32, utf-32-le and
Walter Dörwald <walter@livinglogic.de>
parents: 42597
diff changeset
1196 If byteorder is 0, the output string will always start with the
f1a2d51f1cab Apply SF patch #1775604: This adds three new codecs (utf-32, utf-32-le and
Walter Dörwald <walter@livinglogic.de>
parents: 42597
diff changeset
1197 Unicode BOM mark (U+FEFF). In the other two modes, no BOM mark is
f1a2d51f1cab Apply SF patch #1775604: This adds three new codecs (utf-32, utf-32-le and
Walter Dörwald <walter@livinglogic.de>
parents: 42597
diff changeset
1198 prepended.
f1a2d51f1cab Apply SF patch #1775604: This adds three new codecs (utf-32, utf-32-le and
Walter Dörwald <walter@livinglogic.de>
parents: 42597
diff changeset
1199
f1a2d51f1cab Apply SF patch #1775604: This adds three new codecs (utf-32, utf-32-le and
Walter Dörwald <walter@livinglogic.de>
parents: 42597
diff changeset
1200 */
f1a2d51f1cab Apply SF patch #1775604: This adds three new codecs (utf-32, utf-32-le and
Walter Dörwald <walter@livinglogic.de>
parents: 42597
diff changeset
1201
66664
62b61abd02b8 Merge branches/pep-0384.
Martin v. Löwis <martin@v.loewis.de>
parents: 66203
diff changeset
1202 #ifndef Py_LIMITED_API
42626
f1a2d51f1cab Apply SF patch #1775604: This adds three new codecs (utf-32, utf-32-le and
Walter Dörwald <walter@livinglogic.de>
parents: 42597
diff changeset
1203 PyAPI_FUNC(PyObject*) PyUnicode_EncodeUTF32(
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1204 const Py_UNICODE *data, /* Unicode char buffer */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1205 Py_ssize_t length, /* number of Py_UNICODE chars to encode */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1206 const char *errors, /* error handling */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1207 int byteorder /* byteorder to use 0=BOM+native;-1=LE,1=BE */
42626
f1a2d51f1cab Apply SF patch #1775604: This adds three new codecs (utf-32, utf-32-le and
Walter Dörwald <walter@livinglogic.de>
parents: 42597
diff changeset
1208 );
73476
b3e532c1485e Port encoders from Py_UNICODE API to unicode object API.
Martin v. Löwis <martin@v.loewis.de>
parents: 73457
diff changeset
1209 PyAPI_FUNC(PyObject*) _PyUnicode_EncodeUTF32(
b3e532c1485e Port encoders from Py_UNICODE API to unicode object API.
Martin v. Löwis <martin@v.loewis.de>
parents: 73457
diff changeset
1210 PyObject *object, /* Unicode object */
b3e532c1485e Port encoders from Py_UNICODE API to unicode object API.
Martin v. Löwis <martin@v.loewis.de>
parents: 73457
diff changeset
1211 const char *errors, /* error handling */
b3e532c1485e Port encoders from Py_UNICODE API to unicode object API.
Martin v. Löwis <martin@v.loewis.de>
parents: 73457
diff changeset
1212 int byteorder /* byteorder to use 0=BOM+native;-1=LE,1=BE */
b3e532c1485e Port encoders from Py_UNICODE API to unicode object API.
Martin v. Löwis <martin@v.loewis.de>
parents: 73457
diff changeset
1213 );
66664
62b61abd02b8 Merge branches/pep-0384.
Martin v. Löwis <martin@v.loewis.de>
parents: 66203
diff changeset
1214 #endif
42626
f1a2d51f1cab Apply SF patch #1775604: This adds three new codecs (utf-32, utf-32-le and
Walter Dörwald <walter@livinglogic.de>
parents: 42597
diff changeset
1215
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1216 /* --- UTF-16 Codecs ------------------------------------------------------ */
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1217
12248
70154e2e9c89 Marc-Andre's third try at this bulk patch seems to work (except that
Guido van Rossum <guido@python.org>
parents: 12074
diff changeset
1218 /* Decodes length bytes from a UTF-16 encoded buffer string and returns
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1219 the corresponding Unicode object.
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1220
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1221 errors (if non-NULL) defines the error handling. It defaults
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1222 to "strict".
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1223
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1224 If byteorder is non-NULL, the decoder starts decoding using the
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1225 given byte order:
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1226
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1227 *byteorder == -1: little endian
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1228 *byteorder == 0: native order
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1229 *byteorder == 1: big endian
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1230
17887
fd5f83188778 This patch changes the behaviour of the UTF-16 codec family. Only the
Marc-André Lemburg <mal@egenix.com>
parents: 17618
diff changeset
1231 In native mode, the first two bytes of the stream are checked for a
fd5f83188778 This patch changes the behaviour of the UTF-16 codec family. Only the
Marc-André Lemburg <mal@egenix.com>
parents: 17618
diff changeset
1232 BOM mark. If found, the BOM mark is analysed, the byte order
fd5f83188778 This patch changes the behaviour of the UTF-16 codec family. Only the
Marc-André Lemburg <mal@egenix.com>
parents: 17618
diff changeset
1233 adjusted and the BOM skipped. In the other modes, no BOM mark
fd5f83188778 This patch changes the behaviour of the UTF-16 codec family. Only the
Marc-André Lemburg <mal@egenix.com>
parents: 17618
diff changeset
1234 interpretation is done. After completion, *byteorder is set to the
fd5f83188778 This patch changes the behaviour of the UTF-16 codec family. Only the
Marc-André Lemburg <mal@egenix.com>
parents: 17618
diff changeset
1235 current byte order at the end of input data.
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1236
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1237 If byteorder is NULL, the codec starts in native order mode.
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1238
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1239 */
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1240
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 24737
diff changeset
1241 PyAPI_FUNC(PyObject*) PyUnicode_DecodeUTF16(
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1242 const char *string, /* UTF-16 encoded string */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1243 Py_ssize_t length, /* size of string */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1244 const char *errors, /* error handling */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1245 int *byteorder /* pointer to byteorder to use
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1246 0=native;-1=LE,1=BE; updated on
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1247 exit */
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1248 );
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1249
33428
57478a13fbf6 SF patch #998993: The UTF-8 and the UTF-16 stateful decoders now support
Walter Dörwald <walter@livinglogic.de>
parents: 32951
diff changeset
1250 PyAPI_FUNC(PyObject*) PyUnicode_DecodeUTF16Stateful(
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1251 const char *string, /* UTF-16 encoded string */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1252 Py_ssize_t length, /* size of string */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1253 const char *errors, /* error handling */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1254 int *byteorder, /* pointer to byteorder to use
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1255 0=native;-1=LE,1=BE; updated on
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1256 exit */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1257 Py_ssize_t *consumed /* bytes consumed */
33428
57478a13fbf6 SF patch #998993: The UTF-8 and the UTF-16 stateful decoders now support
Walter Dörwald <walter@livinglogic.de>
parents: 32951
diff changeset
1258 );
57478a13fbf6 SF patch #998993: The UTF-8 and the UTF-16 stateful decoders now support
Walter Dörwald <walter@livinglogic.de>
parents: 32951
diff changeset
1259
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1260 /* Returns a Python string using the UTF-16 encoding in native byte
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1261 order. The string always starts with a BOM mark. */
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1262
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 24737
diff changeset
1263 PyAPI_FUNC(PyObject*) PyUnicode_AsUTF16String(
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1264 PyObject *unicode /* Unicode object */
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1265 );
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1266
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1267 /* Returns a Python string object holding the UTF-16 encoded value of
12248
70154e2e9c89 Marc-Andre's third try at this bulk patch seems to work (except that
Guido van Rossum <guido@python.org>
parents: 12074
diff changeset
1268 the Unicode data.
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1269
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1270 If byteorder is not 0, output is written according to the following
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1271 byte order:
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1272
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1273 byteorder == -1: little endian
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1274 byteorder == 0: native byte order (writes a BOM mark)
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1275 byteorder == 1: big endian
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1276
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1277 If byteorder is 0, the output string will always start with the
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1278 Unicode BOM mark (U+FEFF). In the other two modes, no BOM mark is
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1279 prepended.
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1280
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1281 Note that Py_UNICODE data is being interpreted as UTF-16 reduced to
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1282 UCS-2. This trick makes it possible to add full UTF-16 capabilities
13620
5b727ab37092 Spelling fixes supplied by Rob W. W. Hooft. All these are fixes in either
Thomas Wouters <thomas@python.org>
parents: 13401
diff changeset
1283 at a later point without compromising the APIs.
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1284
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1285 */
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1286
66664
62b61abd02b8 Merge branches/pep-0384.
Martin v. Löwis <martin@v.loewis.de>
parents: 66203
diff changeset
1287 #ifndef Py_LIMITED_API
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 24737
diff changeset
1288 PyAPI_FUNC(PyObject*) PyUnicode_EncodeUTF16(
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1289 const Py_UNICODE *data, /* Unicode char buffer */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1290 Py_ssize_t length, /* number of Py_UNICODE chars to encode */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1291 const char *errors, /* error handling */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1292 int byteorder /* byteorder to use 0=BOM+native;-1=LE,1=BE */
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1293 );
73476
b3e532c1485e Port encoders from Py_UNICODE API to unicode object API.
Martin v. Löwis <martin@v.loewis.de>
parents: 73457
diff changeset
1294 PyAPI_FUNC(PyObject*) _PyUnicode_EncodeUTF16(
b3e532c1485e Port encoders from Py_UNICODE API to unicode object API.
Martin v. Löwis <martin@v.loewis.de>
parents: 73457
diff changeset
1295 PyObject* unicode, /* Unicode object */
b3e532c1485e Port encoders from Py_UNICODE API to unicode object API.
Martin v. Löwis <martin@v.loewis.de>
parents: 73457
diff changeset
1296 const char *errors, /* error handling */
b3e532c1485e Port encoders from Py_UNICODE API to unicode object API.
Martin v. Löwis <martin@v.loewis.de>
parents: 73457
diff changeset
1297 int byteorder /* byteorder to use 0=BOM+native;-1=LE,1=BE */
b3e532c1485e Port encoders from Py_UNICODE API to unicode object API.
Martin v. Löwis <martin@v.loewis.de>
parents: 73457
diff changeset
1298 );
66664
62b61abd02b8 Merge branches/pep-0384.
Martin v. Löwis <martin@v.loewis.de>
parents: 66203
diff changeset
1299 #endif
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1300
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1301 /* --- Unicode-Escape Codecs ---------------------------------------------- */
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1302
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 24737
diff changeset
1303 PyAPI_FUNC(PyObject*) PyUnicode_DecodeUnicodeEscape(
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1304 const char *string, /* Unicode-Escape encoded string */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1305 Py_ssize_t length, /* size of string */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1306 const char *errors /* error handling */
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1307 );
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1308
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 24737
diff changeset
1309 PyAPI_FUNC(PyObject*) PyUnicode_AsUnicodeEscapeString(
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1310 PyObject *unicode /* Unicode object */
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1311 );
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1312
66664
62b61abd02b8 Merge branches/pep-0384.
Martin v. Löwis <martin@v.loewis.de>
parents: 66203
diff changeset
1313 #ifndef Py_LIMITED_API
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 24737
diff changeset
1314 PyAPI_FUNC(PyObject*) PyUnicode_EncodeUnicodeEscape(
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1315 const Py_UNICODE *data, /* Unicode char buffer */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1316 Py_ssize_t length /* Number of Py_UNICODE chars to encode */
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1317 );
66664
62b61abd02b8 Merge branches/pep-0384.
Martin v. Löwis <martin@v.loewis.de>
parents: 66203
diff changeset
1318 #endif
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1319
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1320 /* --- Raw-Unicode-Escape Codecs ------------------------------------------ */
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1321
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 24737
diff changeset
1322 PyAPI_FUNC(PyObject*) PyUnicode_DecodeRawUnicodeEscape(
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1323 const char *string, /* Raw-Unicode-Escape encoded string */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1324 Py_ssize_t length, /* size of string */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1325 const char *errors /* error handling */
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1326 );
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1327
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 24737
diff changeset
1328 PyAPI_FUNC(PyObject*) PyUnicode_AsRawUnicodeEscapeString(
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1329 PyObject *unicode /* Unicode object */
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1330 );
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1331
66664
62b61abd02b8 Merge branches/pep-0384.
Martin v. Löwis <martin@v.loewis.de>
parents: 66203
diff changeset
1332 #ifndef Py_LIMITED_API
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 24737
diff changeset
1333 PyAPI_FUNC(PyObject*) PyUnicode_EncodeRawUnicodeEscape(
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1334 const Py_UNICODE *data, /* Unicode char buffer */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1335 Py_ssize_t length /* Number of Py_UNICODE chars to encode */
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1336 );
66664
62b61abd02b8 Merge branches/pep-0384.
Martin v. Löwis <martin@v.loewis.de>
parents: 66203
diff changeset
1337 #endif
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1338
35485
6b8c55877755 Backport checkin:
Walter Dörwald <walter@livinglogic.de>
parents: 34016
diff changeset
1339 /* --- Unicode Internal Codec ---------------------------------------------
6b8c55877755 Backport checkin:
Walter Dörwald <walter@livinglogic.de>
parents: 34016
diff changeset
1340
6b8c55877755 Backport checkin:
Walter Dörwald <walter@livinglogic.de>
parents: 34016
diff changeset
1341 Only for internal use in _codecsmodule.c */
6b8c55877755 Backport checkin:
Walter Dörwald <walter@livinglogic.de>
parents: 34016
diff changeset
1342
66664
62b61abd02b8 Merge branches/pep-0384.
Martin v. Löwis <martin@v.loewis.de>
parents: 66203
diff changeset
1343 #ifndef Py_LIMITED_API
35485
6b8c55877755 Backport checkin:
Walter Dörwald <walter@livinglogic.de>
parents: 34016
diff changeset
1344 PyObject *_PyUnicode_DecodeUnicodeInternal(
6b8c55877755 Backport checkin:
Walter Dörwald <walter@livinglogic.de>
parents: 34016
diff changeset
1345 const char *string,
36501
7fdc639bc5b4 Merge ssize_t branch.
Martin v. Löwis <martin@v.loewis.de>
parents: 35808
diff changeset
1346 Py_ssize_t length,
35485
6b8c55877755 Backport checkin:
Walter Dörwald <walter@livinglogic.de>
parents: 34016
diff changeset
1347 const char *errors
6b8c55877755 Backport checkin:
Walter Dörwald <walter@livinglogic.de>
parents: 34016
diff changeset
1348 );
66664
62b61abd02b8 Merge branches/pep-0384.
Martin v. Löwis <martin@v.loewis.de>
parents: 66203
diff changeset
1349 #endif
35485
6b8c55877755 Backport checkin:
Walter Dörwald <walter@livinglogic.de>
parents: 34016
diff changeset
1350
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1351 /* --- Latin-1 Codecs -----------------------------------------------------
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1352
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1353 Note: Latin-1 corresponds to the first 256 Unicode ordinals.
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1354
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1355 */
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1356
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 24737
diff changeset
1357 PyAPI_FUNC(PyObject*) PyUnicode_DecodeLatin1(
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1358 const char *string, /* Latin-1 encoded string */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1359 Py_ssize_t length, /* size of string */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1360 const char *errors /* error handling */
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1361 );
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1362
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 24737
diff changeset
1363 PyAPI_FUNC(PyObject*) PyUnicode_AsLatin1String(
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1364 PyObject *unicode /* Unicode object */
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1365 );
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1366
66664
62b61abd02b8 Merge branches/pep-0384.
Martin v. Löwis <martin@v.loewis.de>
parents: 66203
diff changeset
1367 #ifndef Py_LIMITED_API
72475
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
1368 PyAPI_FUNC(PyObject*) _PyUnicode_AsLatin1String(
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
1369 PyObject* unicode,
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
1370 const char* errors);
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
1371
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 24737
diff changeset
1372 PyAPI_FUNC(PyObject*) PyUnicode_EncodeLatin1(
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1373 const Py_UNICODE *data, /* Unicode char buffer */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1374 Py_ssize_t length, /* Number of Py_UNICODE chars to encode */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1375 const char *errors /* error handling */
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1376 );
66664
62b61abd02b8 Merge branches/pep-0384.
Martin v. Löwis <martin@v.loewis.de>
parents: 66203
diff changeset
1377 #endif
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1378
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1379 /* --- ASCII Codecs -------------------------------------------------------
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1380
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1381 Only 7-bit ASCII data is excepted. All other codes generate errors.
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1382
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1383 */
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1384
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 24737
diff changeset
1385 PyAPI_FUNC(PyObject*) PyUnicode_DecodeASCII(
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1386 const char *string, /* ASCII encoded string */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1387 Py_ssize_t length, /* size of string */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1388 const char *errors /* error handling */
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1389 );
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1390
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 24737
diff changeset
1391 PyAPI_FUNC(PyObject*) PyUnicode_AsASCIIString(
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1392 PyObject *unicode /* Unicode object */
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1393 );
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1394
66664
62b61abd02b8 Merge branches/pep-0384.
Martin v. Löwis <martin@v.loewis.de>
parents: 66203
diff changeset
1395 #ifndef Py_LIMITED_API
72475
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
1396 PyAPI_FUNC(PyObject*) _PyUnicode_AsASCIIString(
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
1397 PyObject* unicode,
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
1398 const char* errors);
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
1399
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 24737
diff changeset
1400 PyAPI_FUNC(PyObject*) PyUnicode_EncodeASCII(
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1401 const Py_UNICODE *data, /* Unicode char buffer */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1402 Py_ssize_t length, /* Number of Py_UNICODE chars to encode */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1403 const char *errors /* error handling */
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1404 );
66664
62b61abd02b8 Merge branches/pep-0384.
Martin v. Löwis <martin@v.loewis.de>
parents: 66203
diff changeset
1405 #endif
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1406
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1407 /* --- Character Map Codecs -----------------------------------------------
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1408
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1409 This codec uses mappings to encode and decode characters.
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1410
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1411 Decoding mappings must map single string characters to single
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1412 Unicode characters, integers (which are then interpreted as Unicode
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1413 ordinals) or None (meaning "undefined mapping" and causing an
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1414 error).
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1415
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1416 Encoding mappings must map single Unicode characters to single
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1417 string characters, integers (which are then interpreted as Latin-1
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1418 ordinals) or None (meaning "undefined mapping" and causing an
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1419 error).
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1420
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1421 If a character lookup fails with a LookupError, the character is
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1422 copied as-is meaning that its ordinal value will be interpreted as
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1423 Unicode or Latin-1 ordinal resp. Because of this mappings only need
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1424 to contain those mappings which map characters to different code
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1425 points.
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1426
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1427 */
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1428
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 24737
diff changeset
1429 PyAPI_FUNC(PyObject*) PyUnicode_DecodeCharmap(
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1430 const char *string, /* Encoded string */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1431 Py_ssize_t length, /* size of string */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1432 PyObject *mapping, /* character mapping
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1433 (char ordinal -> unicode ordinal) */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1434 const char *errors /* error handling */
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1435 );
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1436
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 24737
diff changeset
1437 PyAPI_FUNC(PyObject*) PyUnicode_AsCharmapString(
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1438 PyObject *unicode, /* Unicode object */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1439 PyObject *mapping /* character mapping
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1440 (unicode ordinal -> char ordinal) */
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1441 );
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1442
66664
62b61abd02b8 Merge branches/pep-0384.
Martin v. Löwis <martin@v.loewis.de>
parents: 66203
diff changeset
1443 #ifndef Py_LIMITED_API
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 24737
diff changeset
1444 PyAPI_FUNC(PyObject*) PyUnicode_EncodeCharmap(
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1445 const Py_UNICODE *data, /* Unicode char buffer */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1446 Py_ssize_t length, /* Number of Py_UNICODE chars to encode */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1447 PyObject *mapping, /* character mapping
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1448 (unicode ordinal -> char ordinal) */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1449 const char *errors /* error handling */
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1450 );
73302
295fdfd4f422 Port UCS1 and charmap codecs to new API.
Martin v. Löwis <martin@v.loewis.de>
parents: 73236
diff changeset
1451 PyAPI_FUNC(PyObject*) _PyUnicode_EncodeCharmap(
295fdfd4f422 Port UCS1 and charmap codecs to new API.
Martin v. Löwis <martin@v.loewis.de>
parents: 73236
diff changeset
1452 PyObject *unicode, /* Unicode object */
295fdfd4f422 Port UCS1 and charmap codecs to new API.
Martin v. Löwis <martin@v.loewis.de>
parents: 73236
diff changeset
1453 PyObject *mapping, /* character mapping
295fdfd4f422 Port UCS1 and charmap codecs to new API.
Martin v. Löwis <martin@v.loewis.de>
parents: 73236
diff changeset
1454 (unicode ordinal -> char ordinal) */
295fdfd4f422 Port UCS1 and charmap codecs to new API.
Martin v. Löwis <martin@v.loewis.de>
parents: 73236
diff changeset
1455 const char *errors /* error handling */
295fdfd4f422 Port UCS1 and charmap codecs to new API.
Martin v. Löwis <martin@v.loewis.de>
parents: 73236
diff changeset
1456 );
66664
62b61abd02b8 Merge branches/pep-0384.
Martin v. Löwis <martin@v.loewis.de>
parents: 66203
diff changeset
1457 #endif
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1458
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1459 /* Translate a Py_UNICODE buffer of the given length by applying a
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1460 character mapping table to it and return the resulting Unicode
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1461 object.
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1462
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1463 The mapping table must map Unicode ordinal integers to Unicode
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1464 ordinal integers or None (causing deletion of the character).
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1465
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1466 Mapping tables may be dictionaries or sequences. Unmapped character
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1467 ordinals (ones which cause a LookupError) are left untouched and
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1468 are copied as-is.
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1469
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1470 */
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1471
66664
62b61abd02b8 Merge branches/pep-0384.
Martin v. Löwis <martin@v.loewis.de>
parents: 66203
diff changeset
1472 #ifndef Py_LIMITED_API
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 24737
diff changeset
1473 PyAPI_FUNC(PyObject *) PyUnicode_TranslateCharmap(
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1474 const Py_UNICODE *data, /* Unicode char buffer */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1475 Py_ssize_t length, /* Number of Py_UNICODE chars to encode */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1476 PyObject *table, /* Translate table */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1477 const char *errors /* error handling */
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1478 );
66664
62b61abd02b8 Merge branches/pep-0384.
Martin v. Löwis <martin@v.loewis.de>
parents: 66203
diff changeset
1479 #endif
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1480
71193
13e6d3cb2ecd Issue #9642: Uniformize the tests on the availability of the mbcs codec
Victor Stinner <victor.stinner@haypocalc.com>
parents: 68258
diff changeset
1481 #ifdef HAVE_MBCS
12074
65f35b73e350 Marc-Andre Lemburg:
Guido van Rossum <guido@python.org>
parents: 12066
diff changeset
1482
12066
86cffe50fb17 Prototypes added for MBCS codecs. (Win32 only.)
Guido van Rossum <guido@python.org>
parents: 12025
diff changeset
1483 /* --- MBCS codecs for Windows -------------------------------------------- */
12074
65f35b73e350 Marc-Andre Lemburg:
Guido van Rossum <guido@python.org>
parents: 12066
diff changeset
1484
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 24737
diff changeset
1485 PyAPI_FUNC(PyObject*) PyUnicode_DecodeMBCS(
12066
86cffe50fb17 Prototypes added for MBCS codecs. (Win32 only.)
Guido van Rossum <guido@python.org>
parents: 12025
diff changeset
1486 const char *string, /* MBCS encoded string */
36501
7fdc639bc5b4 Merge ssize_t branch.
Martin v. Löwis <martin@v.loewis.de>
parents: 35808
diff changeset
1487 Py_ssize_t length, /* size of string */
12066
86cffe50fb17 Prototypes added for MBCS codecs. (Win32 only.)
Guido van Rossum <guido@python.org>
parents: 12025
diff changeset
1488 const char *errors /* error handling */
86cffe50fb17 Prototypes added for MBCS codecs. (Win32 only.)
Guido van Rossum <guido@python.org>
parents: 12025
diff changeset
1489 );
86cffe50fb17 Prototypes added for MBCS codecs. (Win32 only.)
Guido van Rossum <guido@python.org>
parents: 12025
diff changeset
1490
39442
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from
Thomas Wouters <thomas@python.org>
parents: 38673
diff changeset
1491 PyAPI_FUNC(PyObject*) PyUnicode_DecodeMBCSStateful(
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from
Thomas Wouters <thomas@python.org>
parents: 38673
diff changeset
1492 const char *string, /* MBCS encoded string */
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from
Thomas Wouters <thomas@python.org>
parents: 38673
diff changeset
1493 Py_ssize_t length, /* size of string */
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from
Thomas Wouters <thomas@python.org>
parents: 38673
diff changeset
1494 const char *errors, /* error handling */
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from
Thomas Wouters <thomas@python.org>
parents: 38673
diff changeset
1495 Py_ssize_t *consumed /* bytes consumed */
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from
Thomas Wouters <thomas@python.org>
parents: 38673
diff changeset
1496 );
654c380cf8b9 Merged revisions 46753-51188 via svnmerge from
Thomas Wouters <thomas@python.org>
parents: 38673
diff changeset
1497
72976
af0800b986b7 Issue #12281: Rewrite the MBCS codec to handle correctly replace and ignore
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72925
diff changeset
1498 PyAPI_FUNC(PyObject*) PyUnicode_DecodeCodePageStateful(
af0800b986b7 Issue #12281: Rewrite the MBCS codec to handle correctly replace and ignore
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72925
diff changeset
1499 int code_page, /* code page number */
af0800b986b7 Issue #12281: Rewrite the MBCS codec to handle correctly replace and ignore
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72925
diff changeset
1500 const char *string, /* encoded string */
af0800b986b7 Issue #12281: Rewrite the MBCS codec to handle correctly replace and ignore
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72925
diff changeset
1501 Py_ssize_t length, /* size of string */
af0800b986b7 Issue #12281: Rewrite the MBCS codec to handle correctly replace and ignore
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72925
diff changeset
1502 const char *errors, /* error handling */
af0800b986b7 Issue #12281: Rewrite the MBCS codec to handle correctly replace and ignore
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72925
diff changeset
1503 Py_ssize_t *consumed /* bytes consumed */
af0800b986b7 Issue #12281: Rewrite the MBCS codec to handle correctly replace and ignore
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72925
diff changeset
1504 );
af0800b986b7 Issue #12281: Rewrite the MBCS codec to handle correctly replace and ignore
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72925
diff changeset
1505
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 24737
diff changeset
1506 PyAPI_FUNC(PyObject*) PyUnicode_AsMBCSString(
12066
86cffe50fb17 Prototypes added for MBCS codecs. (Win32 only.)
Guido van Rossum <guido@python.org>
parents: 12025
diff changeset
1507 PyObject *unicode /* Unicode object */
86cffe50fb17 Prototypes added for MBCS codecs. (Win32 only.)
Guido van Rossum <guido@python.org>
parents: 12025
diff changeset
1508 );
86cffe50fb17 Prototypes added for MBCS codecs. (Win32 only.)
Guido van Rossum <guido@python.org>
parents: 12025
diff changeset
1509
66664
62b61abd02b8 Merge branches/pep-0384.
Martin v. Löwis <martin@v.loewis.de>
parents: 66203
diff changeset
1510 #ifndef Py_LIMITED_API
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 24737
diff changeset
1511 PyAPI_FUNC(PyObject*) PyUnicode_EncodeMBCS(
12066
86cffe50fb17 Prototypes added for MBCS codecs. (Win32 only.)
Guido van Rossum <guido@python.org>
parents: 12025
diff changeset
1512 const Py_UNICODE *data, /* Unicode char buffer */
72976
af0800b986b7 Issue #12281: Rewrite the MBCS codec to handle correctly replace and ignore
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72925
diff changeset
1513 Py_ssize_t length, /* number of Py_UNICODE chars to encode */
12066
86cffe50fb17 Prototypes added for MBCS codecs. (Win32 only.)
Guido van Rossum <guido@python.org>
parents: 12025
diff changeset
1514 const char *errors /* error handling */
86cffe50fb17 Prototypes added for MBCS codecs. (Win32 only.)
Guido van Rossum <guido@python.org>
parents: 12025
diff changeset
1515 );
66664
62b61abd02b8 Merge branches/pep-0384.
Martin v. Löwis <martin@v.loewis.de>
parents: 66203
diff changeset
1516 #endif
12066
86cffe50fb17 Prototypes added for MBCS codecs. (Win32 only.)
Guido van Rossum <guido@python.org>
parents: 12025
diff changeset
1517
72976
af0800b986b7 Issue #12281: Rewrite the MBCS codec to handle correctly replace and ignore
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72925
diff changeset
1518 PyAPI_FUNC(PyObject*) PyUnicode_EncodeCodePage(
af0800b986b7 Issue #12281: Rewrite the MBCS codec to handle correctly replace and ignore
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72925
diff changeset
1519 int code_page, /* code page number */
af0800b986b7 Issue #12281: Rewrite the MBCS codec to handle correctly replace and ignore
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72925
diff changeset
1520 PyObject *unicode, /* Unicode object */
af0800b986b7 Issue #12281: Rewrite the MBCS codec to handle correctly replace and ignore
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72925
diff changeset
1521 const char *errors /* error handling */
af0800b986b7 Issue #12281: Rewrite the MBCS codec to handle correctly replace and ignore
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72925
diff changeset
1522 );
af0800b986b7 Issue #12281: Rewrite the MBCS codec to handle correctly replace and ignore
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72925
diff changeset
1523
71193
13e6d3cb2ecd Issue #9642: Uniformize the tests on the availability of the mbcs codec
Victor Stinner <victor.stinner@haypocalc.com>
parents: 68258
diff changeset
1524 #endif /* HAVE_MBCS */
12066
86cffe50fb17 Prototypes added for MBCS codecs. (Win32 only.)
Guido van Rossum <guido@python.org>
parents: 12025
diff changeset
1525
12248
70154e2e9c89 Marc-Andre's third try at this bulk patch seems to work (except that
Guido van Rossum <guido@python.org>
parents: 12074
diff changeset
1526 /* --- Decimal Encoder ---------------------------------------------------- */
70154e2e9c89 Marc-Andre's third try at this bulk patch seems to work (except that
Guido van Rossum <guido@python.org>
parents: 12074
diff changeset
1527
70154e2e9c89 Marc-Andre's third try at this bulk patch seems to work (except that
Guido van Rossum <guido@python.org>
parents: 12074
diff changeset
1528 /* Takes a Unicode string holding a decimal value and writes it into
70154e2e9c89 Marc-Andre's third try at this bulk patch seems to work (except that
Guido van Rossum <guido@python.org>
parents: 12074
diff changeset
1529 an output buffer using standard ASCII digit codes.
70154e2e9c89 Marc-Andre's third try at this bulk patch seems to work (except that
Guido van Rossum <guido@python.org>
parents: 12074
diff changeset
1530
70154e2e9c89 Marc-Andre's third try at this bulk patch seems to work (except that
Guido van Rossum <guido@python.org>
parents: 12074
diff changeset
1531 The output buffer has to provide at least length+1 bytes of storage
70154e2e9c89 Marc-Andre's third try at this bulk patch seems to work (except that
Guido van Rossum <guido@python.org>
parents: 12074
diff changeset
1532 area. The output string is 0-terminated.
70154e2e9c89 Marc-Andre's third try at this bulk patch seems to work (except that
Guido van Rossum <guido@python.org>
parents: 12074
diff changeset
1533
70154e2e9c89 Marc-Andre's third try at this bulk patch seems to work (except that
Guido van Rossum <guido@python.org>
parents: 12074
diff changeset
1534 The encoder converts whitespace to ' ', decimal characters to their
70154e2e9c89 Marc-Andre's third try at this bulk patch seems to work (except that
Guido van Rossum <guido@python.org>
parents: 12074
diff changeset
1535 corresponding ASCII digit and all other Latin-1 characters except
70154e2e9c89 Marc-Andre's third try at this bulk patch seems to work (except that
Guido van Rossum <guido@python.org>
parents: 12074
diff changeset
1536 \0 as-is. Characters outside this range (Unicode ordinals 1-256)
70154e2e9c89 Marc-Andre's third try at this bulk patch seems to work (except that
Guido van Rossum <guido@python.org>
parents: 12074
diff changeset
1537 are treated as errors. This includes embedded NULL bytes.
70154e2e9c89 Marc-Andre's third try at this bulk patch seems to work (except that
Guido van Rossum <guido@python.org>
parents: 12074
diff changeset
1538
70154e2e9c89 Marc-Andre's third try at this bulk patch seems to work (except that
Guido van Rossum <guido@python.org>
parents: 12074
diff changeset
1539 Error handling is defined by the errors argument:
70154e2e9c89 Marc-Andre's third try at this bulk patch seems to work (except that
Guido van Rossum <guido@python.org>
parents: 12074
diff changeset
1540
70154e2e9c89 Marc-Andre's third try at this bulk patch seems to work (except that
Guido van Rossum <guido@python.org>
parents: 12074
diff changeset
1541 NULL or "strict": raise a ValueError
70154e2e9c89 Marc-Andre's third try at this bulk patch seems to work (except that
Guido van Rossum <guido@python.org>
parents: 12074
diff changeset
1542 "ignore": ignore the wrong characters (these are not copied to the
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1543 output buffer)
12248
70154e2e9c89 Marc-Andre's third try at this bulk patch seems to work (except that
Guido van Rossum <guido@python.org>
parents: 12074
diff changeset
1544 "replace": replaces illegal characters with '?'
70154e2e9c89 Marc-Andre's third try at this bulk patch seems to work (except that
Guido van Rossum <guido@python.org>
parents: 12074
diff changeset
1545
70154e2e9c89 Marc-Andre's third try at this bulk patch seems to work (except that
Guido van Rossum <guido@python.org>
parents: 12074
diff changeset
1546 Returns 0 on success, -1 on failure.
70154e2e9c89 Marc-Andre's third try at this bulk patch seems to work (except that
Guido van Rossum <guido@python.org>
parents: 12074
diff changeset
1547
70154e2e9c89 Marc-Andre's third try at this bulk patch seems to work (except that
Guido van Rossum <guido@python.org>
parents: 12074
diff changeset
1548 */
70154e2e9c89 Marc-Andre's third try at this bulk patch seems to work (except that
Guido van Rossum <guido@python.org>
parents: 12074
diff changeset
1549
66664
62b61abd02b8 Merge branches/pep-0384.
Martin v. Löwis <martin@v.loewis.de>
parents: 66203
diff changeset
1550 #ifndef Py_LIMITED_API
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 24737
diff changeset
1551 PyAPI_FUNC(int) PyUnicode_EncodeDecimal(
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1552 Py_UNICODE *s, /* Unicode buffer */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1553 Py_ssize_t length, /* Number of Py_UNICODE chars to encode */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1554 char *output, /* Output buffer; must have size >= length */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1555 const char *errors /* error handling */
12248
70154e2e9c89 Marc-Andre's third try at this bulk patch seems to work (except that
Guido van Rossum <guido@python.org>
parents: 12074
diff changeset
1556 );
66664
62b61abd02b8 Merge branches/pep-0384.
Martin v. Löwis <martin@v.loewis.de>
parents: 66203
diff changeset
1557 #endif
12248
70154e2e9c89 Marc-Andre's third try at this bulk patch seems to work (except that
Guido van Rossum <guido@python.org>
parents: 12074
diff changeset
1558
66673
7b6af56ee74d Issue #10557: Fixed error messages from float() and other numeric
Alexander Belopolsky <alexander.belopolsky@gmail.com>
parents: 66664
diff changeset
1559 /* Transforms code points that have decimal digit property to the
7b6af56ee74d Issue #10557: Fixed error messages from float() and other numeric
Alexander Belopolsky <alexander.belopolsky@gmail.com>
parents: 66664
diff changeset
1560 corresponding ASCII digit code points.
7b6af56ee74d Issue #10557: Fixed error messages from float() and other numeric
Alexander Belopolsky <alexander.belopolsky@gmail.com>
parents: 66664
diff changeset
1561
7b6af56ee74d Issue #10557: Fixed error messages from float() and other numeric
Alexander Belopolsky <alexander.belopolsky@gmail.com>
parents: 66664
diff changeset
1562 Returns a new Unicode string on success, NULL on failure.
7b6af56ee74d Issue #10557: Fixed error messages from float() and other numeric
Alexander Belopolsky <alexander.belopolsky@gmail.com>
parents: 66664
diff changeset
1563 */
7b6af56ee74d Issue #10557: Fixed error messages from float() and other numeric
Alexander Belopolsky <alexander.belopolsky@gmail.com>
parents: 66664
diff changeset
1564
66751
902db4722594 Take PyUnicode_TransformDecimalToASCII out of the limited API.
Georg Brandl <georg@python.org>
parents: 66673
diff changeset
1565 #ifndef Py_LIMITED_API
66673
7b6af56ee74d Issue #10557: Fixed error messages from float() and other numeric
Alexander Belopolsky <alexander.belopolsky@gmail.com>
parents: 66664
diff changeset
1566 PyAPI_FUNC(PyObject*) PyUnicode_TransformDecimalToASCII(
7b6af56ee74d Issue #10557: Fixed error messages from float() and other numeric
Alexander Belopolsky <alexander.belopolsky@gmail.com>
parents: 66664
diff changeset
1567 Py_UNICODE *s, /* Unicode buffer */
7b6af56ee74d Issue #10557: Fixed error messages from float() and other numeric
Alexander Belopolsky <alexander.belopolsky@gmail.com>
parents: 66664
diff changeset
1568 Py_ssize_t length /* Number of Py_UNICODE chars to transform */
7b6af56ee74d Issue #10557: Fixed error messages from float() and other numeric
Alexander Belopolsky <alexander.belopolsky@gmail.com>
parents: 66664
diff changeset
1569 );
66751
902db4722594 Take PyUnicode_TransformDecimalToASCII out of the limited API.
Georg Brandl <georg@python.org>
parents: 66673
diff changeset
1570 #endif
12248
70154e2e9c89 Marc-Andre's third try at this bulk patch seems to work (except that
Guido van Rossum <guido@python.org>
parents: 12074
diff changeset
1571
73591
abe62c9d659d Fix misused of "PyUnicodeObject" structure name in unicodeobject.h
Victor Stinner <victor.stinner@haypocalc.com>
parents: 73476
diff changeset
1572 /* Similar to PyUnicode_TransformDecimalToASCII(), but takes a PyObject
72475
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
1573 as argument instead of a raw buffer and length. This function additionally
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
1574 transforms spaces to ASCII because this is what the callers in longobject,
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
1575 floatobject, and complexobject did anyways. */
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
1576
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
1577 #ifndef Py_LIMITED_API
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
1578 PyAPI_FUNC(PyObject*) _PyUnicode_TransformDecimalAndSpaceToASCII(
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
1579 PyObject *unicode /* Unicode object */
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
1580 );
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
1581 #endif
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
1582
53767
ac209f132b17 Issue #5915: Implement PEP 383, Non-decodable Bytes in
Martin v. Löwis <martin@v.loewis.de>
parents: 53742
diff changeset
1583 /* --- File system encoding ---------------------------------------------- */
ac209f132b17 Issue #5915: Implement PEP 383, Non-decodable Bytes in
Martin v. Löwis <martin@v.loewis.de>
parents: 53742
diff changeset
1584
63963
50c0dbaeaa04 Issue #9542: Create PyUnicode_FSDecoder() function
Victor Stinner <victor.stinner@haypocalc.com>
parents: 63912
diff changeset
1585 /* ParseTuple converter: encode str objects to bytes using
50c0dbaeaa04 Issue #9542: Create PyUnicode_FSDecoder() function
Victor Stinner <victor.stinner@haypocalc.com>
parents: 63912
diff changeset
1586 PyUnicode_EncodeFSDefault(); bytes objects are output as-is. */
53767
ac209f132b17 Issue #5915: Implement PEP 383, Non-decodable Bytes in
Martin v. Löwis <martin@v.loewis.de>
parents: 53742
diff changeset
1587
ac209f132b17 Issue #5915: Implement PEP 383, Non-decodable Bytes in
Martin v. Löwis <martin@v.loewis.de>
parents: 53742
diff changeset
1588 PyAPI_FUNC(int) PyUnicode_FSConverter(PyObject*, void*);
ac209f132b17 Issue #5915: Implement PEP 383, Non-decodable Bytes in
Martin v. Löwis <martin@v.loewis.de>
parents: 53742
diff changeset
1589
63963
50c0dbaeaa04 Issue #9542: Create PyUnicode_FSDecoder() function
Victor Stinner <victor.stinner@haypocalc.com>
parents: 63912
diff changeset
1590 /* ParseTuple converter: decode bytes objects to unicode using
50c0dbaeaa04 Issue #9542: Create PyUnicode_FSDecoder() function
Victor Stinner <victor.stinner@haypocalc.com>
parents: 63912
diff changeset
1591 PyUnicode_DecodeFSDefaultAndSize(); str objects are output as-is. */
50c0dbaeaa04 Issue #9542: Create PyUnicode_FSDecoder() function
Victor Stinner <victor.stinner@haypocalc.com>
parents: 63912
diff changeset
1592
50c0dbaeaa04 Issue #9542: Create PyUnicode_FSDecoder() function
Victor Stinner <victor.stinner@haypocalc.com>
parents: 63912
diff changeset
1593 PyAPI_FUNC(int) PyUnicode_FSDecoder(PyObject*, void*);
50c0dbaeaa04 Issue #9542: Create PyUnicode_FSDecoder() function
Victor Stinner <victor.stinner@haypocalc.com>
parents: 63912
diff changeset
1594
61577
2b0af69aef97 Merged revisions 81168 via svnmerge from
Victor Stinner <victor.stinner@haypocalc.com>
parents: 61467
diff changeset
1595 /* Decode a null-terminated string using Py_FileSystemDefaultEncoding
2b0af69aef97 Merged revisions 81168 via svnmerge from
Victor Stinner <victor.stinner@haypocalc.com>
parents: 61467
diff changeset
1596 and the "surrogateescape" error handler.
53767
ac209f132b17 Issue #5915: Implement PEP 383, Non-decodable Bytes in
Martin v. Löwis <martin@v.loewis.de>
parents: 53742
diff changeset
1597
65348
453fd8182c2f Use locale encoding if Py_FileSystemDefaultEncoding is not set
Victor Stinner <victor.stinner@haypocalc.com>
parents: 65157
diff changeset
1598 If Py_FileSystemDefaultEncoding is not set, fall back to the locale
453fd8182c2f Use locale encoding if Py_FileSystemDefaultEncoding is not set
Victor Stinner <victor.stinner@haypocalc.com>
parents: 65157
diff changeset
1599 encoding.
53767
ac209f132b17 Issue #5915: Implement PEP 383, Non-decodable Bytes in
Martin v. Löwis <martin@v.loewis.de>
parents: 53742
diff changeset
1600
61601
042e6a396a86 rephrase
Benjamin Peterson <benjamin@python.org>
parents: 61597
diff changeset
1601 Use PyUnicode_DecodeFSDefaultAndSize() if the string length is known.
53767
ac209f132b17 Issue #5915: Implement PEP 383, Non-decodable Bytes in
Martin v. Löwis <martin@v.loewis.de>
parents: 53742
diff changeset
1602 */
ac209f132b17 Issue #5915: Implement PEP 383, Non-decodable Bytes in
Martin v. Löwis <martin@v.loewis.de>
parents: 53742
diff changeset
1603
ac209f132b17 Issue #5915: Implement PEP 383, Non-decodable Bytes in
Martin v. Löwis <martin@v.loewis.de>
parents: 53742
diff changeset
1604 PyAPI_FUNC(PyObject*) PyUnicode_DecodeFSDefault(
ac209f132b17 Issue #5915: Implement PEP 383, Non-decodable Bytes in
Martin v. Löwis <martin@v.loewis.de>
parents: 53742
diff changeset
1605 const char *s /* encoded string */
ac209f132b17 Issue #5915: Implement PEP 383, Non-decodable Bytes in
Martin v. Löwis <martin@v.loewis.de>
parents: 53742
diff changeset
1606 );
ac209f132b17 Issue #5915: Implement PEP 383, Non-decodable Bytes in
Martin v. Löwis <martin@v.loewis.de>
parents: 53742
diff changeset
1607
61577
2b0af69aef97 Merged revisions 81168 via svnmerge from
Victor Stinner <victor.stinner@haypocalc.com>
parents: 61467
diff changeset
1608 /* Decode a string using Py_FileSystemDefaultEncoding
2b0af69aef97 Merged revisions 81168 via svnmerge from
Victor Stinner <victor.stinner@haypocalc.com>
parents: 61467
diff changeset
1609 and the "surrogateescape" error handler.
2b0af69aef97 Merged revisions 81168 via svnmerge from
Victor Stinner <victor.stinner@haypocalc.com>
parents: 61467
diff changeset
1610
65348
453fd8182c2f Use locale encoding if Py_FileSystemDefaultEncoding is not set
Victor Stinner <victor.stinner@haypocalc.com>
parents: 65157
diff changeset
1611 If Py_FileSystemDefaultEncoding is not set, fall back to the locale
453fd8182c2f Use locale encoding if Py_FileSystemDefaultEncoding is not set
Victor Stinner <victor.stinner@haypocalc.com>
parents: 65157
diff changeset
1612 encoding.
61577
2b0af69aef97 Merged revisions 81168 via svnmerge from
Victor Stinner <victor.stinner@haypocalc.com>
parents: 61467
diff changeset
1613 */
2b0af69aef97 Merged revisions 81168 via svnmerge from
Victor Stinner <victor.stinner@haypocalc.com>
parents: 61467
diff changeset
1614
53767
ac209f132b17 Issue #5915: Implement PEP 383, Non-decodable Bytes in
Martin v. Löwis <martin@v.loewis.de>
parents: 53742
diff changeset
1615 PyAPI_FUNC(PyObject*) PyUnicode_DecodeFSDefaultAndSize(
ac209f132b17 Issue #5915: Implement PEP 383, Non-decodable Bytes in
Martin v. Löwis <martin@v.loewis.de>
parents: 53742
diff changeset
1616 const char *s, /* encoded string */
ac209f132b17 Issue #5915: Implement PEP 383, Non-decodable Bytes in
Martin v. Löwis <martin@v.loewis.de>
parents: 53742
diff changeset
1617 Py_ssize_t size /* size */
ac209f132b17 Issue #5915: Implement PEP 383, Non-decodable Bytes in
Martin v. Löwis <martin@v.loewis.de>
parents: 53742
diff changeset
1618 );
ac209f132b17 Issue #5915: Implement PEP 383, Non-decodable Bytes in
Martin v. Löwis <martin@v.loewis.de>
parents: 53742
diff changeset
1619
61597
b5ba7ea4246b Issue #8715: Create PyUnicode_EncodeFSDefault() function: Encode a Unicode
Victor Stinner <victor.stinner@haypocalc.com>
parents: 61576
diff changeset
1620 /* Encode a Unicode object to Py_FileSystemDefaultEncoding with the
61601
042e6a396a86 rephrase
Benjamin Peterson <benjamin@python.org>
parents: 61597
diff changeset
1621 "surrogateescape" error handler, and return bytes.
61597
b5ba7ea4246b Issue #8715: Create PyUnicode_EncodeFSDefault() function: Encode a Unicode
Victor Stinner <victor.stinner@haypocalc.com>
parents: 61576
diff changeset
1622
65348
453fd8182c2f Use locale encoding if Py_FileSystemDefaultEncoding is not set
Victor Stinner <victor.stinner@haypocalc.com>
parents: 65157
diff changeset
1623 If Py_FileSystemDefaultEncoding is not set, fall back to the locale
453fd8182c2f Use locale encoding if Py_FileSystemDefaultEncoding is not set
Victor Stinner <victor.stinner@haypocalc.com>
parents: 65157
diff changeset
1624 encoding.
61597
b5ba7ea4246b Issue #8715: Create PyUnicode_EncodeFSDefault() function: Encode a Unicode
Victor Stinner <victor.stinner@haypocalc.com>
parents: 61576
diff changeset
1625 */
b5ba7ea4246b Issue #8715: Create PyUnicode_EncodeFSDefault() function: Encode a Unicode
Victor Stinner <victor.stinner@haypocalc.com>
parents: 61576
diff changeset
1626
b5ba7ea4246b Issue #8715: Create PyUnicode_EncodeFSDefault() function: Encode a Unicode
Victor Stinner <victor.stinner@haypocalc.com>
parents: 61576
diff changeset
1627 PyAPI_FUNC(PyObject*) PyUnicode_EncodeFSDefault(
b5ba7ea4246b Issue #8715: Create PyUnicode_EncodeFSDefault() function: Encode a Unicode
Victor Stinner <victor.stinner@haypocalc.com>
parents: 61576
diff changeset
1628 PyObject *unicode
b5ba7ea4246b Issue #8715: Create PyUnicode_EncodeFSDefault() function: Encode a Unicode
Victor Stinner <victor.stinner@haypocalc.com>
parents: 61576
diff changeset
1629 );
b5ba7ea4246b Issue #8715: Create PyUnicode_EncodeFSDefault() function: Encode a Unicode
Victor Stinner <victor.stinner@haypocalc.com>
parents: 61576
diff changeset
1630
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1631 /* --- Methods & Slots ----------------------------------------------------
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1632
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1633 These are capable of handling Unicode objects and strings on input
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1634 (we refer to them as strings in the descriptions) and return
72689
aa79b4e62c38 Fix a few typos in the unicode header.
Georg Brandl <georg@python.org>
parents: 72688
diff changeset
1635 Unicode objects or integers as appropriate. */
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1636
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1637 /* Concat two strings giving a new Unicode string. */
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1638
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 24737
diff changeset
1639 PyAPI_FUNC(PyObject*) PyUnicode_Concat(
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1640 PyObject *left, /* Left string */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1641 PyObject *right /* Right string */
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1642 );
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1643
41769
b29d71d43c80 Add functions PyUnicode_Append() and PyUnicode_AppendAndDel() that mirror
Walter Dörwald <walter@livinglogic.de>
parents: 41768
diff changeset
1644 /* Concat two strings and put the result in *pleft
b29d71d43c80 Add functions PyUnicode_Append() and PyUnicode_AppendAndDel() that mirror
Walter Dörwald <walter@livinglogic.de>
parents: 41768
diff changeset
1645 (sets *pleft to NULL on error) */
b29d71d43c80 Add functions PyUnicode_Append() and PyUnicode_AppendAndDel() that mirror
Walter Dörwald <walter@livinglogic.de>
parents: 41768
diff changeset
1646
b29d71d43c80 Add functions PyUnicode_Append() and PyUnicode_AppendAndDel() that mirror
Walter Dörwald <walter@livinglogic.de>
parents: 41768
diff changeset
1647 PyAPI_FUNC(void) PyUnicode_Append(
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1648 PyObject **pleft, /* Pointer to left string */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1649 PyObject *right /* Right string */
41769
b29d71d43c80 Add functions PyUnicode_Append() and PyUnicode_AppendAndDel() that mirror
Walter Dörwald <walter@livinglogic.de>
parents: 41768
diff changeset
1650 );
b29d71d43c80 Add functions PyUnicode_Append() and PyUnicode_AppendAndDel() that mirror
Walter Dörwald <walter@livinglogic.de>
parents: 41768
diff changeset
1651
b29d71d43c80 Add functions PyUnicode_Append() and PyUnicode_AppendAndDel() that mirror
Walter Dörwald <walter@livinglogic.de>
parents: 41768
diff changeset
1652 /* Concat two strings, put the result in *pleft and drop the right object
b29d71d43c80 Add functions PyUnicode_Append() and PyUnicode_AppendAndDel() that mirror
Walter Dörwald <walter@livinglogic.de>
parents: 41768
diff changeset
1653 (sets *pleft to NULL on error) */
b29d71d43c80 Add functions PyUnicode_Append() and PyUnicode_AppendAndDel() that mirror
Walter Dörwald <walter@livinglogic.de>
parents: 41768
diff changeset
1654
b29d71d43c80 Add functions PyUnicode_Append() and PyUnicode_AppendAndDel() that mirror
Walter Dörwald <walter@livinglogic.de>
parents: 41768
diff changeset
1655 PyAPI_FUNC(void) PyUnicode_AppendAndDel(
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1656 PyObject **pleft, /* Pointer to left string */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1657 PyObject *right /* Right string */
41769
b29d71d43c80 Add functions PyUnicode_Append() and PyUnicode_AppendAndDel() that mirror
Walter Dörwald <walter@livinglogic.de>
parents: 41768
diff changeset
1658 );
b29d71d43c80 Add functions PyUnicode_Append() and PyUnicode_AppendAndDel() that mirror
Walter Dörwald <walter@livinglogic.de>
parents: 41768
diff changeset
1659
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1660 /* Split a string giving a list of Unicode strings.
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1661
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1662 If sep is NULL, splitting will be done at all whitespace
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1663 substrings. Otherwise, splits occur at the given separator.
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1664
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1665 At most maxsplit splits will be done. If negative, no limit is set.
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1666
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1667 Separators are not included in the resulting list.
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1668
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1669 */
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1670
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 24737
diff changeset
1671 PyAPI_FUNC(PyObject*) PyUnicode_Split(
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1672 PyObject *s, /* String to split */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1673 PyObject *sep, /* String separator */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1674 Py_ssize_t maxsplit /* Maxsplit count */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1675 );
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1676
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1677 /* Dito, but split at line breaks.
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1678
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1679 CRLF is considered to be one line break. Line breaks are not
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1680 included in the resulting list. */
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1681
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 24737
diff changeset
1682 PyAPI_FUNC(PyObject*) PyUnicode_Splitlines(
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1683 PyObject *s, /* String to split */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1684 int keepends /* If true, line end markers are included */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1685 );
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1686
38453
29ae5e0fc348 Much-needed merge (using svnmerge.py this time) of trunk changes into p3yk.
Thomas Wouters <thomas@python.org>
parents: 36501
diff changeset
1687 /* Partition a string using a given separator. */
29ae5e0fc348 Much-needed merge (using svnmerge.py this time) of trunk changes into p3yk.
Thomas Wouters <thomas@python.org>
parents: 36501
diff changeset
1688
29ae5e0fc348 Much-needed merge (using svnmerge.py this time) of trunk changes into p3yk.
Thomas Wouters <thomas@python.org>
parents: 36501
diff changeset
1689 PyAPI_FUNC(PyObject*) PyUnicode_Partition(
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1690 PyObject *s, /* String to partition */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1691 PyObject *sep /* String separator */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1692 );
38453
29ae5e0fc348 Much-needed merge (using svnmerge.py this time) of trunk changes into p3yk.
Thomas Wouters <thomas@python.org>
parents: 36501
diff changeset
1693
29ae5e0fc348 Much-needed merge (using svnmerge.py this time) of trunk changes into p3yk.
Thomas Wouters <thomas@python.org>
parents: 36501
diff changeset
1694 /* Partition a string using a given separator, searching from the end of the
29ae5e0fc348 Much-needed merge (using svnmerge.py this time) of trunk changes into p3yk.
Thomas Wouters <thomas@python.org>
parents: 36501
diff changeset
1695 string. */
29ae5e0fc348 Much-needed merge (using svnmerge.py this time) of trunk changes into p3yk.
Thomas Wouters <thomas@python.org>
parents: 36501
diff changeset
1696
29ae5e0fc348 Much-needed merge (using svnmerge.py this time) of trunk changes into p3yk.
Thomas Wouters <thomas@python.org>
parents: 36501
diff changeset
1697 PyAPI_FUNC(PyObject*) PyUnicode_RPartition(
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1698 PyObject *s, /* String to partition */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1699 PyObject *sep /* String separator */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1700 );
38453
29ae5e0fc348 Much-needed merge (using svnmerge.py this time) of trunk changes into p3yk.
Thomas Wouters <thomas@python.org>
parents: 36501
diff changeset
1701
31199
504943c89193 Add rsplit method for str and unicode builtin types.
Hye-Shik Chang <hyeshik@gmail.com>
parents: 24753
diff changeset
1702 /* Split a string giving a list of Unicode strings.
504943c89193 Add rsplit method for str and unicode builtin types.
Hye-Shik Chang <hyeshik@gmail.com>
parents: 24753
diff changeset
1703
504943c89193 Add rsplit method for str and unicode builtin types.
Hye-Shik Chang <hyeshik@gmail.com>
parents: 24753
diff changeset
1704 If sep is NULL, splitting will be done at all whitespace
504943c89193 Add rsplit method for str and unicode builtin types.
Hye-Shik Chang <hyeshik@gmail.com>
parents: 24753
diff changeset
1705 substrings. Otherwise, splits occur at the given separator.
504943c89193 Add rsplit method for str and unicode builtin types.
Hye-Shik Chang <hyeshik@gmail.com>
parents: 24753
diff changeset
1706
504943c89193 Add rsplit method for str and unicode builtin types.
Hye-Shik Chang <hyeshik@gmail.com>
parents: 24753
diff changeset
1707 At most maxsplit splits will be done. But unlike PyUnicode_Split
504943c89193 Add rsplit method for str and unicode builtin types.
Hye-Shik Chang <hyeshik@gmail.com>
parents: 24753
diff changeset
1708 PyUnicode_RSplit splits from the end of the string. If negative,
504943c89193 Add rsplit method for str and unicode builtin types.
Hye-Shik Chang <hyeshik@gmail.com>
parents: 24753
diff changeset
1709 no limit is set.
504943c89193 Add rsplit method for str and unicode builtin types.
Hye-Shik Chang <hyeshik@gmail.com>
parents: 24753
diff changeset
1710
504943c89193 Add rsplit method for str and unicode builtin types.
Hye-Shik Chang <hyeshik@gmail.com>
parents: 24753
diff changeset
1711 Separators are not included in the resulting list.
504943c89193 Add rsplit method for str and unicode builtin types.
Hye-Shik Chang <hyeshik@gmail.com>
parents: 24753
diff changeset
1712
504943c89193 Add rsplit method for str and unicode builtin types.
Hye-Shik Chang <hyeshik@gmail.com>
parents: 24753
diff changeset
1713 */
504943c89193 Add rsplit method for str and unicode builtin types.
Hye-Shik Chang <hyeshik@gmail.com>
parents: 24753
diff changeset
1714
504943c89193 Add rsplit method for str and unicode builtin types.
Hye-Shik Chang <hyeshik@gmail.com>
parents: 24753
diff changeset
1715 PyAPI_FUNC(PyObject*) PyUnicode_RSplit(
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1716 PyObject *s, /* String to split */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1717 PyObject *sep, /* String separator */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1718 Py_ssize_t maxsplit /* Maxsplit count */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1719 );
31199
504943c89193 Add rsplit method for str and unicode builtin types.
Hye-Shik Chang <hyeshik@gmail.com>
parents: 24753
diff changeset
1720
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1721 /* Translate a string by applying a character mapping table to it and
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1722 return the resulting Unicode object.
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1723
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1724 The mapping table must map Unicode ordinal integers to Unicode
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1725 ordinal integers or None (causing deletion of the character).
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1726
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1727 Mapping tables may be dictionaries or sequences. Unmapped character
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1728 ordinals (ones which cause a LookupError) are left untouched and
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1729 are copied as-is.
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1730
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1731 */
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1732
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 24737
diff changeset
1733 PyAPI_FUNC(PyObject *) PyUnicode_Translate(
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1734 PyObject *str, /* String */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1735 PyObject *table, /* Translate table */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1736 const char *errors /* error handling */
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1737 );
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1738
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1739 /* Join a sequence of strings using the given separator and return
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1740 the resulting Unicode string. */
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1741
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 24737
diff changeset
1742 PyAPI_FUNC(PyObject*) PyUnicode_Join(
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1743 PyObject *separator, /* Separator string */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1744 PyObject *seq /* Sequence object */
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1745 );
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1746
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1747 /* Return 1 if substr matches str[start:end] at the given tail end, 0
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1748 otherwise. */
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1749
36501
7fdc639bc5b4 Merge ssize_t branch.
Martin v. Löwis <martin@v.loewis.de>
parents: 35808
diff changeset
1750 PyAPI_FUNC(Py_ssize_t) PyUnicode_Tailmatch(
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1751 PyObject *str, /* String */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1752 PyObject *substr, /* Prefix or Suffix string */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1753 Py_ssize_t start, /* Start index */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1754 Py_ssize_t end, /* Stop index */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1755 int direction /* Tail end: -1 prefix, +1 suffix */
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1756 );
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1757
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1758 /* Return the first position of substr in str[start:end] using the
23561
c5e8f89fd358 Fix for bug [ 561796 ] string.find causes lazy error
Marc-André Lemburg <mal@egenix.com>
parents: 23225
diff changeset
1759 given search direction or -1 if not found. -2 is returned in case
c5e8f89fd358 Fix for bug [ 561796 ] string.find causes lazy error
Marc-André Lemburg <mal@egenix.com>
parents: 23225
diff changeset
1760 an error occurred and an exception is set. */
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1761
36501
7fdc639bc5b4 Merge ssize_t branch.
Martin v. Löwis <martin@v.loewis.de>
parents: 35808
diff changeset
1762 PyAPI_FUNC(Py_ssize_t) PyUnicode_Find(
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1763 PyObject *str, /* String */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1764 PyObject *substr, /* Substring to find */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1765 Py_ssize_t start, /* Start index */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1766 Py_ssize_t end, /* Stop index */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1767 int direction /* Find direction: +1 forward, -1 backward */
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1768 );
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1769
72475
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
1770 /* Like PyUnicode_Find, but search for single character only. */
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
1771 PyAPI_FUNC(Py_ssize_t) PyUnicode_FindChar(
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
1772 PyObject *str,
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
1773 Py_UCS4 ch,
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
1774 Py_ssize_t start,
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
1775 Py_ssize_t end,
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
1776 int direction
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
1777 );
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
1778
12025
7994d9db7f4d On 17-Mar-2000, Marc-Andre Lemburg said:
Barry Warsaw <barry@python.org>
parents: 12002
diff changeset
1779 /* Count the number of occurrences of substr in str[start:end]. */
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1780
36501
7fdc639bc5b4 Merge ssize_t branch.
Martin v. Löwis <martin@v.loewis.de>
parents: 35808
diff changeset
1781 PyAPI_FUNC(Py_ssize_t) PyUnicode_Count(
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1782 PyObject *str, /* String */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1783 PyObject *substr, /* Substring to count */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1784 Py_ssize_t start, /* Start index */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1785 Py_ssize_t end /* Stop index */
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1786 );
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1787
12025
7994d9db7f4d On 17-Mar-2000, Marc-Andre Lemburg said:
Barry Warsaw <barry@python.org>
parents: 12002
diff changeset
1788 /* Replace at most maxcount occurrences of substr in str with replstr
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1789 and return the resulting Unicode object. */
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1790
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 24737
diff changeset
1791 PyAPI_FUNC(PyObject *) PyUnicode_Replace(
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1792 PyObject *str, /* String */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1793 PyObject *substr, /* Substring to find */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1794 PyObject *replstr, /* Substring to replace */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1795 Py_ssize_t maxcount /* Max. number of replacements to apply;
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1796 -1 = all */
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1797 );
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1798
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1799 /* Compare two strings and return -1, 0, 1 for less than, equal,
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1800 greater than resp. */
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1801
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 24737
diff changeset
1802 PyAPI_FUNC(int) PyUnicode_Compare(
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1803 PyObject *left, /* Left string */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1804 PyObject *right /* Right string */
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1805 );
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1806
42013
cd125fe83051 Make identifiers str (not str8) objects throughout.
Martin v. Löwis <martin@v.loewis.de>
parents: 41876
diff changeset
1807 PyAPI_FUNC(int) PyUnicode_CompareWithASCIIString(
cd125fe83051 Make identifiers str (not str8) objects throughout.
Martin v. Löwis <martin@v.loewis.de>
parents: 41876
diff changeset
1808 PyObject *left,
67150
4bb7f7b151fe Issue #9738: document encodings of unicode functions
Victor Stinner <victor.stinner@haypocalc.com>
parents: 66751
diff changeset
1809 const char *right /* ASCII-encoded string */
42013
cd125fe83051 Make identifiers str (not str8) objects throughout.
Martin v. Löwis <martin@v.loewis.de>
parents: 41876
diff changeset
1810 );
cd125fe83051 Make identifiers str (not str8) objects throughout.
Martin v. Löwis <martin@v.loewis.de>
parents: 41876
diff changeset
1811
39610
3674f20ac781 Merge current trunk into p3yk. This includes the PyNumber_Index API change,
Thomas Wouters <thomas@python.org>
parents: 39442
diff changeset
1812 /* Rich compare two strings and return one of the following:
3674f20ac781 Merge current trunk into p3yk. This includes the PyNumber_Index API change,
Thomas Wouters <thomas@python.org>
parents: 39442
diff changeset
1813
3674f20ac781 Merge current trunk into p3yk. This includes the PyNumber_Index API change,
Thomas Wouters <thomas@python.org>
parents: 39442
diff changeset
1814 - NULL in case an exception was raised
72689
aa79b4e62c38 Fix a few typos in the unicode header.
Georg Brandl <georg@python.org>
parents: 72688
diff changeset
1815 - Py_True or Py_False for successfully comparisons
39610
3674f20ac781 Merge current trunk into p3yk. This includes the PyNumber_Index API change,
Thomas Wouters <thomas@python.org>
parents: 39442
diff changeset
1816 - Py_NotImplemented in case the type combination is unknown
3674f20ac781 Merge current trunk into p3yk. This includes the PyNumber_Index API change,
Thomas Wouters <thomas@python.org>
parents: 39442
diff changeset
1817
3674f20ac781 Merge current trunk into p3yk. This includes the PyNumber_Index API change,
Thomas Wouters <thomas@python.org>
parents: 39442
diff changeset
1818 Note that Py_EQ and Py_NE comparisons can cause a UnicodeWarning in
3674f20ac781 Merge current trunk into p3yk. This includes the PyNumber_Index API change,
Thomas Wouters <thomas@python.org>
parents: 39442
diff changeset
1819 case the conversion of the arguments to Unicode fails with a
3674f20ac781 Merge current trunk into p3yk. This includes the PyNumber_Index API change,
Thomas Wouters <thomas@python.org>
parents: 39442
diff changeset
1820 UnicodeDecodeError.
3674f20ac781 Merge current trunk into p3yk. This includes the PyNumber_Index API change,
Thomas Wouters <thomas@python.org>
parents: 39442
diff changeset
1821
3674f20ac781 Merge current trunk into p3yk. This includes the PyNumber_Index API change,
Thomas Wouters <thomas@python.org>
parents: 39442
diff changeset
1822 Possible values for op:
3674f20ac781 Merge current trunk into p3yk. This includes the PyNumber_Index API change,
Thomas Wouters <thomas@python.org>
parents: 39442
diff changeset
1823
3674f20ac781 Merge current trunk into p3yk. This includes the PyNumber_Index API change,
Thomas Wouters <thomas@python.org>
parents: 39442
diff changeset
1824 Py_GT, Py_GE, Py_EQ, Py_NE, Py_LT, Py_LE
3674f20ac781 Merge current trunk into p3yk. This includes the PyNumber_Index API change,
Thomas Wouters <thomas@python.org>
parents: 39442
diff changeset
1825
3674f20ac781 Merge current trunk into p3yk. This includes the PyNumber_Index API change,
Thomas Wouters <thomas@python.org>
parents: 39442
diff changeset
1826 */
3674f20ac781 Merge current trunk into p3yk. This includes the PyNumber_Index API change,
Thomas Wouters <thomas@python.org>
parents: 39442
diff changeset
1827
3674f20ac781 Merge current trunk into p3yk. This includes the PyNumber_Index API change,
Thomas Wouters <thomas@python.org>
parents: 39442
diff changeset
1828 PyAPI_FUNC(PyObject *) PyUnicode_RichCompare(
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1829 PyObject *left, /* Left string */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1830 PyObject *right, /* Right string */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1831 int op /* Operation: Py_EQ, Py_NE, Py_GT, etc. */
39610
3674f20ac781 Merge current trunk into p3yk. This includes the PyNumber_Index API change,
Thomas Wouters <thomas@python.org>
parents: 39442
diff changeset
1832 );
3674f20ac781 Merge current trunk into p3yk. This includes the PyNumber_Index API change,
Thomas Wouters <thomas@python.org>
parents: 39442
diff changeset
1833
13620
5b727ab37092 Spelling fixes supplied by Rob W. W. Hooft. All these are fixes in either
Thomas Wouters <thomas@python.org>
parents: 13401
diff changeset
1834 /* Apply a argument tuple or dictionary to a format string and return
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1835 the resulting Unicode string. */
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1836
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 24737
diff changeset
1837 PyAPI_FUNC(PyObject *) PyUnicode_Format(
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1838 PyObject *format, /* Format string */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1839 PyObject *args /* Argument tuple or dictionary */
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1840 );
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1841
12002
d50fa3670b66 Marc-Andre Lemburg: add declaration for PyUnicode_Contains().
Guido van Rossum <guido@python.org>
parents: 11962
diff changeset
1842 /* Checks whether element is contained in container and return 1/0
d50fa3670b66 Marc-Andre Lemburg: add declaration for PyUnicode_Contains().
Guido van Rossum <guido@python.org>
parents: 11962
diff changeset
1843 accordingly.
d50fa3670b66 Marc-Andre Lemburg: add declaration for PyUnicode_Contains().
Guido van Rossum <guido@python.org>
parents: 11962
diff changeset
1844
d50fa3670b66 Marc-Andre Lemburg: add declaration for PyUnicode_Contains().
Guido van Rossum <guido@python.org>
parents: 11962
diff changeset
1845 element has to coerce to an one element Unicode string. -1 is
d50fa3670b66 Marc-Andre Lemburg: add declaration for PyUnicode_Contains().
Guido van Rossum <guido@python.org>
parents: 11962
diff changeset
1846 returned in case of an error. */
d50fa3670b66 Marc-Andre Lemburg: add declaration for PyUnicode_Contains().
Guido van Rossum <guido@python.org>
parents: 11962
diff changeset
1847
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 24737
diff changeset
1848 PyAPI_FUNC(int) PyUnicode_Contains(
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1849 PyObject *container, /* Container string */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1850 PyObject *element /* Element string */
12002
d50fa3670b66 Marc-Andre Lemburg: add declaration for PyUnicode_Contains().
Guido van Rossum <guido@python.org>
parents: 11962
diff changeset
1851 );
d50fa3670b66 Marc-Andre Lemburg: add declaration for PyUnicode_Contains().
Guido van Rossum <guido@python.org>
parents: 11962
diff changeset
1852
42597
20477cbfd996 Implement PEP 3131. Add isidentifier to str.
Martin v. Löwis <martin@v.loewis.de>
parents: 42595
diff changeset
1853 /* Checks whether argument is a valid identifier. */
20477cbfd996 Implement PEP 3131. Add isidentifier to str.
Martin v. Löwis <martin@v.loewis.de>
parents: 42595
diff changeset
1854
20477cbfd996 Implement PEP 3131. Add isidentifier to str.
Martin v. Löwis <martin@v.loewis.de>
parents: 42595
diff changeset
1855 PyAPI_FUNC(int) PyUnicode_IsIdentifier(PyObject *s);
20477cbfd996 Implement PEP 3131. Add isidentifier to str.
Martin v. Löwis <martin@v.loewis.de>
parents: 42595
diff changeset
1856
66664
62b61abd02b8 Merge branches/pep-0384.
Martin v. Löwis <martin@v.loewis.de>
parents: 66203
diff changeset
1857 #ifndef Py_LIMITED_API
23225
e639e34ef901 Apply patch diff.txt from SF feature request
Walter Dörwald <walter@livinglogic.de>
parents: 20554
diff changeset
1858 /* Externally visible for str.strip(unicode) */
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 24737
diff changeset
1859 PyAPI_FUNC(PyObject *) _PyUnicode_XStrip(
73185
f61db5671cc8 Replace PyUnicodeObject* by PyObject* where it was irrevelant
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72980
diff changeset
1860 PyObject *self,
23225
e639e34ef901 Apply patch diff.txt from SF feature request
Walter Dörwald <walter@livinglogic.de>
parents: 20554
diff changeset
1861 int striptype,
e639e34ef901 Apply patch diff.txt from SF feature request
Walter Dörwald <walter@livinglogic.de>
parents: 20554
diff changeset
1862 PyObject *sepobj
e639e34ef901 Apply patch diff.txt from SF feature request
Walter Dörwald <walter@livinglogic.de>
parents: 20554
diff changeset
1863 );
66664
62b61abd02b8 Merge branches/pep-0384.
Martin v. Löwis <martin@v.loewis.de>
parents: 66203
diff changeset
1864 #endif
23225
e639e34ef901 Apply patch diff.txt from SF feature request
Walter Dörwald <walter@livinglogic.de>
parents: 20554
diff changeset
1865
46909
ef4ec968fdb6 Merged revisions 63078 via svnmerge from
Eric Smith <eric@trueblade.com>
parents: 46598
diff changeset
1866 /* Using the current locale, insert the thousands grouping
ef4ec968fdb6 Merged revisions 63078 via svnmerge from
Eric Smith <eric@trueblade.com>
parents: 46598
diff changeset
1867 into the string pointed to by buffer. For the argument descriptions,
ef4ec968fdb6 Merged revisions 63078 via svnmerge from
Eric Smith <eric@trueblade.com>
parents: 46598
diff changeset
1868 see Objects/stringlib/localeutil.h */
ef4ec968fdb6 Merged revisions 63078 via svnmerge from
Eric Smith <eric@trueblade.com>
parents: 46598
diff changeset
1869
66664
62b61abd02b8 Merge branches/pep-0384.
Martin v. Löwis <martin@v.loewis.de>
parents: 66203
diff changeset
1870 #ifndef Py_LIMITED_API
53187
b653eab13b73 The other half of Issue #1580: use short float repr where possible.
Eric Smith <eric@trueblade.com>
parents: 52773
diff changeset
1871 PyAPI_FUNC(Py_ssize_t) _PyUnicode_InsertThousandsGroupingLocale(Py_UNICODE *buffer,
b653eab13b73 The other half of Issue #1580: use short float repr where possible.
Eric Smith <eric@trueblade.com>
parents: 52773
diff changeset
1872 Py_ssize_t n_buffer,
b653eab13b73 The other half of Issue #1580: use short float repr where possible.
Eric Smith <eric@trueblade.com>
parents: 52773
diff changeset
1873 Py_UNICODE *digits,
b653eab13b73 The other half of Issue #1580: use short float repr where possible.
Eric Smith <eric@trueblade.com>
parents: 52773
diff changeset
1874 Py_ssize_t n_digits,
b653eab13b73 The other half of Issue #1580: use short float repr where possible.
Eric Smith <eric@trueblade.com>
parents: 52773
diff changeset
1875 Py_ssize_t min_width);
66664
62b61abd02b8 Merge branches/pep-0384.
Martin v. Löwis <martin@v.loewis.de>
parents: 66203
diff changeset
1876 #endif
46909
ef4ec968fdb6 Merged revisions 63078 via svnmerge from
Eric Smith <eric@trueblade.com>
parents: 46598
diff changeset
1877
52773
28096ed73153 Added ',' thousands grouping to int.__format__. See PEP 378.
Eric Smith <eric@trueblade.com>
parents: 50660
diff changeset
1878 /* Using explicit passed-in values, insert the thousands grouping
28096ed73153 Added ',' thousands grouping to int.__format__. See PEP 378.
Eric Smith <eric@trueblade.com>
parents: 50660
diff changeset
1879 into the string pointed to by buffer. For the argument descriptions,
28096ed73153 Added ',' thousands grouping to int.__format__. See PEP 378.
Eric Smith <eric@trueblade.com>
parents: 50660
diff changeset
1880 see Objects/stringlib/localeutil.h */
66664
62b61abd02b8 Merge branches/pep-0384.
Martin v. Löwis <martin@v.loewis.de>
parents: 66203
diff changeset
1881 #ifndef Py_LIMITED_API
72475
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
1882 PyAPI_FUNC(Py_ssize_t) _PyUnicode_InsertThousandsGrouping(
72705
05ed6e5f2cf4 Add asciilib: similar to ucs1, ucs2 and ucs4 library, but specialized to ASCII
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72699
diff changeset
1883 PyObject *unicode,
72475
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
1884 int kind,
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
1885 void *buffer,
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
1886 Py_ssize_t n_buffer,
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
1887 void *digits,
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
1888 Py_ssize_t n_digits,
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
1889 Py_ssize_t min_width,
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
1890 const char *grouping,
8beaa9a37387 Implement PEP 393.
Martin v. Löwis <martin@v.loewis.de>
parents: 72299
diff changeset
1891 const char *thousands_sep);
66664
62b61abd02b8 Merge branches/pep-0384.
Martin v. Löwis <martin@v.loewis.de>
parents: 66203
diff changeset
1892 #endif
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1893 /* === Characters Type APIs =============================================== */
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1894
50660
9d093ef89c56 Merged revisions 68440 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents: 50550
diff changeset
1895 /* Helper array used by Py_UNICODE_ISSPACE(). */
9d093ef89c56 Merged revisions 68440 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents: 50550
diff changeset
1896
66664
62b61abd02b8 Merge branches/pep-0384.
Martin v. Löwis <martin@v.loewis.de>
parents: 66203
diff changeset
1897 #ifndef Py_LIMITED_API
50660
9d093ef89c56 Merged revisions 68440 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents: 50550
diff changeset
1898 PyAPI_DATA(const unsigned char) _Py_ascii_whitespace[];
9d093ef89c56 Merged revisions 68440 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents: 50550
diff changeset
1899
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1900 /* These should not be used directly. Use the Py_UNICODE_IS* and
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 53767
diff changeset
1901 Py_UNICODE_TO* macros instead.
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1902
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1903 These APIs are implemented in Objects/unicodectype.c.
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1904
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1905 */
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1906
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 24737
diff changeset
1907 PyAPI_FUNC(int) _PyUnicode_IsLowercase(
64146
8f97c64b2333 #5127: Even on narrow unicode builds, the C functions that access the Unicode
Amaury Forgeot d'Arc <amauryfa@gmail.com>
parents: 64081
diff changeset
1908 Py_UCS4 ch /* Unicode character */
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1909 );
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1910
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 24737
diff changeset
1911 PyAPI_FUNC(int) _PyUnicode_IsUppercase(
64146
8f97c64b2333 #5127: Even on narrow unicode builds, the C functions that access the Unicode
Amaury Forgeot d'Arc <amauryfa@gmail.com>
parents: 64081
diff changeset
1912 Py_UCS4 ch /* Unicode character */
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1913 );
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1914
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 24737
diff changeset
1915 PyAPI_FUNC(int) _PyUnicode_IsTitlecase(
64146
8f97c64b2333 #5127: Even on narrow unicode builds, the C functions that access the Unicode
Amaury Forgeot d'Arc <amauryfa@gmail.com>
parents: 64081
diff changeset
1916 Py_UCS4 ch /* Unicode character */
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1917 );
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1918
42595
f6af0b2598ca Add XID_Start and XID_Continue properties to unicodectype.
Martin v. Löwis <martin@v.loewis.de>
parents: 42490
diff changeset
1919 PyAPI_FUNC(int) _PyUnicode_IsXidStart(
64146
8f97c64b2333 #5127: Even on narrow unicode builds, the C functions that access the Unicode
Amaury Forgeot d'Arc <amauryfa@gmail.com>
parents: 64081
diff changeset
1920 Py_UCS4 ch /* Unicode character */
42595
f6af0b2598ca Add XID_Start and XID_Continue properties to unicodectype.
Martin v. Löwis <martin@v.loewis.de>
parents: 42490
diff changeset
1921 );
f6af0b2598ca Add XID_Start and XID_Continue properties to unicodectype.
Martin v. Löwis <martin@v.loewis.de>
parents: 42490
diff changeset
1922
f6af0b2598ca Add XID_Start and XID_Continue properties to unicodectype.
Martin v. Löwis <martin@v.loewis.de>
parents: 42490
diff changeset
1923 PyAPI_FUNC(int) _PyUnicode_IsXidContinue(
64146
8f97c64b2333 #5127: Even on narrow unicode builds, the C functions that access the Unicode
Amaury Forgeot d'Arc <amauryfa@gmail.com>
parents: 64081
diff changeset
1924 Py_UCS4 ch /* Unicode character */
42595
f6af0b2598ca Add XID_Start and XID_Continue properties to unicodectype.
Martin v. Löwis <martin@v.loewis.de>
parents: 42490
diff changeset
1925 );
f6af0b2598ca Add XID_Start and XID_Continue properties to unicodectype.
Martin v. Löwis <martin@v.loewis.de>
parents: 42490
diff changeset
1926
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 24737
diff changeset
1927 PyAPI_FUNC(int) _PyUnicode_IsWhitespace(
64146
8f97c64b2333 #5127: Even on narrow unicode builds, the C functions that access the Unicode
Amaury Forgeot d'Arc <amauryfa@gmail.com>
parents: 64081
diff changeset
1928 const Py_UCS4 ch /* Unicode character */
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1929 );
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1930
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 24737
diff changeset
1931 PyAPI_FUNC(int) _PyUnicode_IsLinebreak(
64146
8f97c64b2333 #5127: Even on narrow unicode builds, the C functions that access the Unicode
Amaury Forgeot d'Arc <amauryfa@gmail.com>
parents: 64081
diff changeset
1932 const Py_UCS4 ch /* Unicode character */
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1933 );
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1934
64146
8f97c64b2333 #5127: Even on narrow unicode builds, the C functions that access the Unicode
Amaury Forgeot d'Arc <amauryfa@gmail.com>
parents: 64081
diff changeset
1935 PyAPI_FUNC(Py_UCS4) _PyUnicode_ToLowercase(
8f97c64b2333 #5127: Even on narrow unicode builds, the C functions that access the Unicode
Amaury Forgeot d'Arc <amauryfa@gmail.com>
parents: 64081
diff changeset
1936 Py_UCS4 ch /* Unicode character */
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1937 );
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1938
64146
8f97c64b2333 #5127: Even on narrow unicode builds, the C functions that access the Unicode
Amaury Forgeot d'Arc <amauryfa@gmail.com>
parents: 64081
diff changeset
1939 PyAPI_FUNC(Py_UCS4) _PyUnicode_ToUppercase(
8f97c64b2333 #5127: Even on narrow unicode builds, the C functions that access the Unicode
Amaury Forgeot d'Arc <amauryfa@gmail.com>
parents: 64081
diff changeset
1940 Py_UCS4 ch /* Unicode character */
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1941 );
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1942
64146
8f97c64b2333 #5127: Even on narrow unicode builds, the C functions that access the Unicode
Amaury Forgeot d'Arc <amauryfa@gmail.com>
parents: 64081
diff changeset
1943 PyAPI_FUNC(Py_UCS4) _PyUnicode_ToTitlecase(
8f97c64b2333 #5127: Even on narrow unicode builds, the C functions that access the Unicode
Amaury Forgeot d'Arc <amauryfa@gmail.com>
parents: 64081
diff changeset
1944 Py_UCS4 ch /* Unicode character */
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1945 );
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1946
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 24737
diff changeset
1947 PyAPI_FUNC(int) _PyUnicode_ToDecimalDigit(
64146
8f97c64b2333 #5127: Even on narrow unicode builds, the C functions that access the Unicode
Amaury Forgeot d'Arc <amauryfa@gmail.com>
parents: 64081
diff changeset
1948 Py_UCS4 ch /* Unicode character */
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1949 );
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1950
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 24737
diff changeset
1951 PyAPI_FUNC(int) _PyUnicode_ToDigit(
64146
8f97c64b2333 #5127: Even on narrow unicode builds, the C functions that access the Unicode
Amaury Forgeot d'Arc <amauryfa@gmail.com>
parents: 64081
diff changeset
1952 Py_UCS4 ch /* Unicode character */
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1953 );
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1954
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 24737
diff changeset
1955 PyAPI_FUNC(double) _PyUnicode_ToNumeric(
64146
8f97c64b2333 #5127: Even on narrow unicode builds, the C functions that access the Unicode
Amaury Forgeot d'Arc <amauryfa@gmail.com>
parents: 64081
diff changeset
1956 Py_UCS4 ch /* Unicode character */
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1957 );
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1958
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 24737
diff changeset
1959 PyAPI_FUNC(int) _PyUnicode_IsDecimalDigit(
64146
8f97c64b2333 #5127: Even on narrow unicode builds, the C functions that access the Unicode
Amaury Forgeot d'Arc <amauryfa@gmail.com>
parents: 64081
diff changeset
1960 Py_UCS4 ch /* Unicode character */
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1961 );
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1962
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 24737
diff changeset
1963 PyAPI_FUNC(int) _PyUnicode_IsDigit(
64146
8f97c64b2333 #5127: Even on narrow unicode builds, the C functions that access the Unicode
Amaury Forgeot d'Arc <amauryfa@gmail.com>
parents: 64081
diff changeset
1964 Py_UCS4 ch /* Unicode character */
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1965 );
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1966
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 24737
diff changeset
1967 PyAPI_FUNC(int) _PyUnicode_IsNumeric(
64146
8f97c64b2333 #5127: Even on narrow unicode builds, the C functions that access the Unicode
Amaury Forgeot d'Arc <amauryfa@gmail.com>
parents: 64081
diff changeset
1968 Py_UCS4 ch /* Unicode character */
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1969 );
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1970
47611
da47e7e135ae #2630: Implement PEP 3138.
Georg Brandl <georg@python.org>
parents: 47496
diff changeset
1971 PyAPI_FUNC(int) _PyUnicode_IsPrintable(
64146
8f97c64b2333 #5127: Even on narrow unicode builds, the C functions that access the Unicode
Amaury Forgeot d'Arc <amauryfa@gmail.com>
parents: 64081
diff changeset
1972 Py_UCS4 ch /* Unicode character */
47611
da47e7e135ae #2630: Implement PEP 3138.
Georg Brandl <georg@python.org>
parents: 47496
diff changeset
1973 );
da47e7e135ae #2630: Implement PEP 3138.
Georg Brandl <georg@python.org>
parents: 47496
diff changeset
1974
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 24737
diff changeset
1975 PyAPI_FUNC(int) _PyUnicode_IsAlpha(
64146
8f97c64b2333 #5127: Even on narrow unicode builds, the C functions that access the Unicode
Amaury Forgeot d'Arc <amauryfa@gmail.com>
parents: 64081
diff changeset
1976 Py_UCS4 ch /* Unicode character */
13352
d88535ccaee5 Modified the ISALPHA and ISALNUM macros to use the new lookup APIs
Marc-André Lemburg <mal@egenix.com>
parents: 13320
diff changeset
1977 );
d88535ccaee5 Modified the ISALPHA and ISALNUM macros to use the new lookup APIs
Marc-André Lemburg <mal@egenix.com>
parents: 13320
diff changeset
1978
64081
b089ed576b13 Issue #9425: Create Py_UNICODE_strncmp() function
Victor Stinner <victor.stinner@haypocalc.com>
parents: 63963
diff changeset
1979 PyAPI_FUNC(size_t) Py_UNICODE_strlen(
b089ed576b13 Issue #9425: Create Py_UNICODE_strncmp() function
Victor Stinner <victor.stinner@haypocalc.com>
parents: 63963
diff changeset
1980 const Py_UNICODE *u
b089ed576b13 Issue #9425: Create Py_UNICODE_strncmp() function
Victor Stinner <victor.stinner@haypocalc.com>
parents: 63963
diff changeset
1981 );
42013
cd125fe83051 Make identifiers str (not str8) objects throughout.
Martin v. Löwis <martin@v.loewis.de>
parents: 41876
diff changeset
1982
cd125fe83051 Make identifiers str (not str8) objects throughout.
Martin v. Löwis <martin@v.loewis.de>
parents: 41876
diff changeset
1983 PyAPI_FUNC(Py_UNICODE*) Py_UNICODE_strcpy(
64081
b089ed576b13 Issue #9425: Create Py_UNICODE_strncmp() function
Victor Stinner <victor.stinner@haypocalc.com>
parents: 63963
diff changeset
1984 Py_UNICODE *s1,
b089ed576b13 Issue #9425: Create Py_UNICODE_strncmp() function
Victor Stinner <victor.stinner@haypocalc.com>
parents: 63963
diff changeset
1985 const Py_UNICODE *s2);
42013
cd125fe83051 Make identifiers str (not str8) objects throughout.
Martin v. Löwis <martin@v.loewis.de>
parents: 41876
diff changeset
1986
64372
a0d8de04c3a8 Create Py_UNICODE_strcat() function
Victor Stinner <victor.stinner@haypocalc.com>
parents: 64349
diff changeset
1987 PyAPI_FUNC(Py_UNICODE*) Py_UNICODE_strcat(
42013
cd125fe83051 Make identifiers str (not str8) objects throughout.
Martin v. Löwis <martin@v.loewis.de>
parents: 41876
diff changeset
1988 Py_UNICODE *s1, const Py_UNICODE *s2);
cd125fe83051 Make identifiers str (not str8) objects throughout.
Martin v. Löwis <martin@v.loewis.de>
parents: 41876
diff changeset
1989
cd125fe83051 Make identifiers str (not str8) objects throughout.
Martin v. Löwis <martin@v.loewis.de>
parents: 41876
diff changeset
1990 PyAPI_FUNC(Py_UNICODE*) Py_UNICODE_strncpy(
64081
b089ed576b13 Issue #9425: Create Py_UNICODE_strncmp() function
Victor Stinner <victor.stinner@haypocalc.com>
parents: 63963
diff changeset
1991 Py_UNICODE *s1,
b089ed576b13 Issue #9425: Create Py_UNICODE_strncmp() function
Victor Stinner <victor.stinner@haypocalc.com>
parents: 63963
diff changeset
1992 const Py_UNICODE *s2,
b089ed576b13 Issue #9425: Create Py_UNICODE_strncmp() function
Victor Stinner <victor.stinner@haypocalc.com>
parents: 63963
diff changeset
1993 size_t n);
42013
cd125fe83051 Make identifiers str (not str8) objects throughout.
Martin v. Löwis <martin@v.loewis.de>
parents: 41876
diff changeset
1994
cd125fe83051 Make identifiers str (not str8) objects throughout.
Martin v. Löwis <martin@v.loewis.de>
parents: 41876
diff changeset
1995 PyAPI_FUNC(int) Py_UNICODE_strcmp(
64081
b089ed576b13 Issue #9425: Create Py_UNICODE_strncmp() function
Victor Stinner <victor.stinner@haypocalc.com>
parents: 63963
diff changeset
1996 const Py_UNICODE *s1,
b089ed576b13 Issue #9425: Create Py_UNICODE_strncmp() function
Victor Stinner <victor.stinner@haypocalc.com>
parents: 63963
diff changeset
1997 const Py_UNICODE *s2
b089ed576b13 Issue #9425: Create Py_UNICODE_strncmp() function
Victor Stinner <victor.stinner@haypocalc.com>
parents: 63963
diff changeset
1998 );
b089ed576b13 Issue #9425: Create Py_UNICODE_strncmp() function
Victor Stinner <victor.stinner@haypocalc.com>
parents: 63963
diff changeset
1999
b089ed576b13 Issue #9425: Create Py_UNICODE_strncmp() function
Victor Stinner <victor.stinner@haypocalc.com>
parents: 63963
diff changeset
2000 PyAPI_FUNC(int) Py_UNICODE_strncmp(
b089ed576b13 Issue #9425: Create Py_UNICODE_strncmp() function
Victor Stinner <victor.stinner@haypocalc.com>
parents: 63963
diff changeset
2001 const Py_UNICODE *s1,
b089ed576b13 Issue #9425: Create Py_UNICODE_strncmp() function
Victor Stinner <victor.stinner@haypocalc.com>
parents: 63963
diff changeset
2002 const Py_UNICODE *s2,
b089ed576b13 Issue #9425: Create Py_UNICODE_strncmp() function
Victor Stinner <victor.stinner@haypocalc.com>
parents: 63963
diff changeset
2003 size_t n
b089ed576b13 Issue #9425: Create Py_UNICODE_strncmp() function
Victor Stinner <victor.stinner@haypocalc.com>
parents: 63963
diff changeset
2004 );
42013
cd125fe83051 Make identifiers str (not str8) objects throughout.
Martin v. Löwis <martin@v.loewis.de>
parents: 41876
diff changeset
2005
cd125fe83051 Make identifiers str (not str8) objects throughout.
Martin v. Löwis <martin@v.loewis.de>
parents: 41876
diff changeset
2006 PyAPI_FUNC(Py_UNICODE*) Py_UNICODE_strchr(
64081
b089ed576b13 Issue #9425: Create Py_UNICODE_strncmp() function
Victor Stinner <victor.stinner@haypocalc.com>
parents: 63963
diff changeset
2007 const Py_UNICODE *s,
b089ed576b13 Issue #9425: Create Py_UNICODE_strncmp() function
Victor Stinner <victor.stinner@haypocalc.com>
parents: 63963
diff changeset
2008 Py_UNICODE c
42013
cd125fe83051 Make identifiers str (not str8) objects throughout.
Martin v. Löwis <martin@v.loewis.de>
parents: 41876
diff changeset
2009 );
cd125fe83051 Make identifiers str (not str8) objects throughout.
Martin v. Löwis <martin@v.loewis.de>
parents: 41876
diff changeset
2010
63912
a3853bfa2518 Issue #9425: create Py_UNICODE_strrchr() function
Victor Stinner <victor.stinner@haypocalc.com>
parents: 62530
diff changeset
2011 PyAPI_FUNC(Py_UNICODE*) Py_UNICODE_strrchr(
64081
b089ed576b13 Issue #9425: Create Py_UNICODE_strncmp() function
Victor Stinner <victor.stinner@haypocalc.com>
parents: 63963
diff changeset
2012 const Py_UNICODE *s,
b089ed576b13 Issue #9425: Create Py_UNICODE_strncmp() function
Victor Stinner <victor.stinner@haypocalc.com>
parents: 63963
diff changeset
2013 Py_UNICODE c
42013
cd125fe83051 Make identifiers str (not str8) objects throughout.
Martin v. Löwis <martin@v.loewis.de>
parents: 41876
diff changeset
2014 );
cd125fe83051 Make identifiers str (not str8) objects throughout.
Martin v. Löwis <martin@v.loewis.de>
parents: 41876
diff changeset
2015
64373
1f04b0076fd8 Create PyUnicode_strdup() function
Victor Stinner <victor.stinner@haypocalc.com>
parents: 64372
diff changeset
2016 /* Create a copy of a unicode string ending with a nul character. Return NULL
1f04b0076fd8 Create PyUnicode_strdup() function
Victor Stinner <victor.stinner@haypocalc.com>
parents: 64372
diff changeset
2017 and raise a MemoryError exception on memory allocation failure, otherwise
1f04b0076fd8 Create PyUnicode_strdup() function
Victor Stinner <victor.stinner@haypocalc.com>
parents: 64372
diff changeset
2018 return a new allocated buffer (use PyMem_Free() to free the buffer). */
1f04b0076fd8 Create PyUnicode_strdup() function
Victor Stinner <victor.stinner@haypocalc.com>
parents: 64372
diff changeset
2019
64397
98f337a6957c Rename PyUnicode_strdup() to PyUnicode_AsUnicodeCopy()
Victor Stinner <victor.stinner@haypocalc.com>
parents: 64373
diff changeset
2020 PyAPI_FUNC(Py_UNICODE*) PyUnicode_AsUnicodeCopy(
64373
1f04b0076fd8 Create PyUnicode_strdup() function
Victor Stinner <victor.stinner@haypocalc.com>
parents: 64372
diff changeset
2021 PyObject *unicode
1f04b0076fd8 Create PyUnicode_strdup() function
Victor Stinner <victor.stinner@haypocalc.com>
parents: 64372
diff changeset
2022 );
66664
62b61abd02b8 Merge branches/pep-0384.
Martin v. Löwis <martin@v.loewis.de>
parents: 66203
diff changeset
2023 #endif /* Py_LIMITED_API */
64373
1f04b0076fd8 Create PyUnicode_strdup() function
Victor Stinner <victor.stinner@haypocalc.com>
parents: 64372
diff changeset
2024
72714
6f03716079a9 Don't check for the maximum character when copying from unicodeobject.c
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72705
diff changeset
2025 #if defined(Py_DEBUG) && !defined(Py_LIMITED_API)
6f03716079a9 Don't check for the maximum character when copying from unicodeobject.c
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72705
diff changeset
2026 PyAPI_FUNC(int) _PyUnicode_CheckConsistency(
73337
783b4b9dfa5e Replace PyUnicodeObject type by PyObject
Victor Stinner <victor.stinner@haypocalc.com>
parents: 73302
diff changeset
2027 PyObject *op,
72714
6f03716079a9 Don't check for the maximum character when copying from unicodeobject.c
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72705
diff changeset
2028 int check_content);
6f03716079a9 Don't check for the maximum character when copying from unicodeobject.c
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72705
diff changeset
2029 #endif
6f03716079a9 Don't check for the maximum character when copying from unicodeobject.c
Victor Stinner <victor.stinner@haypocalc.com>
parents: 72705
diff changeset
2030
72835
5e33219492bc Add API for static strings, primarily good for identifiers.
Martin v. Löwis <martin@v.loewis.de>
parents: 72796
diff changeset
2031 /********************* String Literals ****************************************/
5e33219492bc Add API for static strings, primarily good for identifiers.
Martin v. Löwis <martin@v.loewis.de>
parents: 72796
diff changeset
2032 /* This structure helps managing static strings. The basic usage goes like this:
5e33219492bc Add API for static strings, primarily good for identifiers.
Martin v. Löwis <martin@v.loewis.de>
parents: 72796
diff changeset
2033 Instead of doing
5e33219492bc Add API for static strings, primarily good for identifiers.
Martin v. Löwis <martin@v.loewis.de>
parents: 72796
diff changeset
2034
5e33219492bc Add API for static strings, primarily good for identifiers.
Martin v. Löwis <martin@v.loewis.de>
parents: 72796
diff changeset
2035 r = PyObject_CallMethod(o, "foo", "args", ...);
5e33219492bc Add API for static strings, primarily good for identifiers.
Martin v. Löwis <martin@v.loewis.de>
parents: 72796
diff changeset
2036
5e33219492bc Add API for static strings, primarily good for identifiers.
Martin v. Löwis <martin@v.loewis.de>
parents: 72796
diff changeset
2037 do
5e33219492bc Add API for static strings, primarily good for identifiers.
Martin v. Löwis <martin@v.loewis.de>
parents: 72796
diff changeset
2038
72925
7109f31300fb Rename _Py_identifier to _Py_IDENTIFIER.
Martin v. Löwis <martin@v.loewis.de>
parents: 72904
diff changeset
2039 _Py_IDENTIFIER(foo);
72835
5e33219492bc Add API for static strings, primarily good for identifiers.
Martin v. Löwis <martin@v.loewis.de>
parents: 72796
diff changeset
2040 ...
5e33219492bc Add API for static strings, primarily good for identifiers.
Martin v. Löwis <martin@v.loewis.de>
parents: 72796
diff changeset
2041 r = _PyObject_CallMethodId(o, &PyId_foo, "args", ...);
5e33219492bc Add API for static strings, primarily good for identifiers.
Martin v. Löwis <martin@v.loewis.de>
parents: 72796
diff changeset
2042
5e33219492bc Add API for static strings, primarily good for identifiers.
Martin v. Löwis <martin@v.loewis.de>
parents: 72796
diff changeset
2043 PyId_foo is a static variable, either on block level or file level. On first
5e33219492bc Add API for static strings, primarily good for identifiers.
Martin v. Löwis <martin@v.loewis.de>
parents: 72796
diff changeset
2044 usage, the string "foo" is interned, and the structures are linked. On interpreter
5e33219492bc Add API for static strings, primarily good for identifiers.
Martin v. Löwis <martin@v.loewis.de>
parents: 72796
diff changeset
2045 shutdown, all strings are released (through _PyUnicode_ClearStaticStrings).
5e33219492bc Add API for static strings, primarily good for identifiers.
Martin v. Löwis <martin@v.loewis.de>
parents: 72796
diff changeset
2046
5e33219492bc Add API for static strings, primarily good for identifiers.
Martin v. Löwis <martin@v.loewis.de>
parents: 72796
diff changeset
2047 Alternatively, _Py_static_string allows to choose the variable name.
73457
6ae8c68eb0c1 Make _PyUnicode_FromId return borrowed references.
Martin v. Löwis <martin@v.loewis.de>
parents: 73356
diff changeset
2048 _PyUnicode_FromId returns a borrowed reference to the interned string.
72835
5e33219492bc Add API for static strings, primarily good for identifiers.
Martin v. Löwis <martin@v.loewis.de>
parents: 72796
diff changeset
2049 _PyObject_{Get,Set,Has}AttrId are __getattr__ versions using _Py_Identifier*.
5e33219492bc Add API for static strings, primarily good for identifiers.
Martin v. Löwis <martin@v.loewis.de>
parents: 72796
diff changeset
2050 */
5e33219492bc Add API for static strings, primarily good for identifiers.
Martin v. Löwis <martin@v.loewis.de>
parents: 72796
diff changeset
2051 typedef struct _Py_Identifier {
5e33219492bc Add API for static strings, primarily good for identifiers.
Martin v. Löwis <martin@v.loewis.de>
parents: 72796
diff changeset
2052 struct _Py_Identifier *next;
5e33219492bc Add API for static strings, primarily good for identifiers.
Martin v. Löwis <martin@v.loewis.de>
parents: 72796
diff changeset
2053 const char* string;
5e33219492bc Add API for static strings, primarily good for identifiers.
Martin v. Löwis <martin@v.loewis.de>
parents: 72796
diff changeset
2054 PyObject *object;
5e33219492bc Add API for static strings, primarily good for identifiers.
Martin v. Löwis <martin@v.loewis.de>
parents: 72796
diff changeset
2055 } _Py_Identifier;
5e33219492bc Add API for static strings, primarily good for identifiers.
Martin v. Löwis <martin@v.loewis.de>
parents: 72796
diff changeset
2056
72836
57ed1e24f8f3 Drop extra semicolon.
Martin v. Löwis <martin@v.loewis.de>
parents: 72835
diff changeset
2057 #define _Py_static_string(varname, value) static _Py_Identifier varname = { 0, value, 0 }
72925
7109f31300fb Rename _Py_identifier to _Py_IDENTIFIER.
Martin v. Löwis <martin@v.loewis.de>
parents: 72904
diff changeset
2058 #define _Py_IDENTIFIER(varname) _Py_static_string(PyId_##varname, #varname)
72835
5e33219492bc Add API for static strings, primarily good for identifiers.
Martin v. Löwis <martin@v.loewis.de>
parents: 72796
diff changeset
2059
5e33219492bc Add API for static strings, primarily good for identifiers.
Martin v. Löwis <martin@v.loewis.de>
parents: 72796
diff changeset
2060 /* Return an interned Unicode object for an Identifier; may fail if there is no memory.*/
5e33219492bc Add API for static strings, primarily good for identifiers.
Martin v. Löwis <martin@v.loewis.de>
parents: 72796
diff changeset
2061 PyAPI_FUNC(PyObject*) _PyUnicode_FromId(_Py_Identifier*);
5e33219492bc Add API for static strings, primarily good for identifiers.
Martin v. Löwis <martin@v.loewis.de>
parents: 72796
diff changeset
2062 /* Clear all static strings. */
5e33219492bc Add API for static strings, primarily good for identifiers.
Martin v. Löwis <martin@v.loewis.de>
parents: 72796
diff changeset
2063 PyAPI_FUNC(void) _PyUnicode_ClearStaticStrings(void);
5e33219492bc Add API for static strings, primarily good for identifiers.
Martin v. Löwis <martin@v.loewis.de>
parents: 72796
diff changeset
2064
11962
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
2065 #ifdef __cplusplus
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
2066 }
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
2067 #endif
be98e055e39d Unicode implementation by Marc-Andre Lemburg based on original code by Fredrik Lundh.
Guido van Rossum <guido@python.org>
parents:
diff changeset
2068 #endif /* !Py_UNICODEOBJECT_H */