blob: 0531aedb30dcca309c7b06357c413f2bf8533a5f [file] [log] [blame]
Guido van Rossumd8225182000-03-10 22:33:05 +00001#ifndef Py_UNICODEOBJECT_H
2#define Py_UNICODEOBJECT_H
Guido van Rossumd8225182000-03-10 22:33:05 +00003
4/*
5
6Unicode implementation based on original code by Fredrik Lundh,
7modified by Marc-Andre Lemburg (mal@lemburg.com) according to the
8Unicode Integration Proposal (see file Misc/unicode.txt).
9
Guido van Rossum16b1ad92000-08-03 16:24:25 +000010Copyright (c) Corporation for National Research Initiatives.
Guido van Rossumd8225182000-03-10 22:33:05 +000011
12
13 Original header:
14 --------------------------------------------------------------------
15
16 * Yet another Unicode string type for Python. This type supports the
17 * 16-bit Basic Multilingual Plane (BMP) only.
18 *
19 * Written by Fredrik Lundh, January 1999.
20 *
21 * Copyright (c) 1999 by Secret Labs AB.
22 * Copyright (c) 1999 by Fredrik Lundh.
23 *
24 * fredrik@pythonware.com
25 * http://www.pythonware.com
26 *
27 * --------------------------------------------------------------------
28 * This Unicode String Type is
29 *
30 * Copyright (c) 1999 by Secret Labs AB
31 * Copyright (c) 1999 by Fredrik Lundh
32 *
33 * By obtaining, using, and/or copying this software and/or its
34 * associated documentation, you agree that you have read, understood,
35 * and will comply with the following terms and conditions:
36 *
37 * Permission to use, copy, modify, and distribute this software and its
38 * associated documentation for any purpose and without fee is hereby
39 * granted, provided that the above copyright notice appears in all
40 * copies, and that both that copyright notice and this permission notice
41 * appear in supporting documentation, and that the name of Secret Labs
42 * AB or the author not be used in advertising or publicity pertaining to
43 * distribution of the software without specific, written prior
44 * permission.
45 *
46 * SECRET LABS AB AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO
47 * THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
48 * FITNESS. IN NO EVENT SHALL SECRET LABS AB OR THE AUTHOR BE LIABLE FOR
49 * ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
50 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
51 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT
52 * OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
53 * -------------------------------------------------------------------- */
54
Marc-André Lemburg5e6007c2001-09-19 11:21:03 +000055#include <ctype.h>
Guido van Rossumd8225182000-03-10 22:33:05 +000056
57/* === Internal API ======================================================= */
58
59/* --- Internal Unicode Format -------------------------------------------- */
60
Martin v. Löwis339d0f72001-08-17 18:39:25 +000061#ifndef Py_USING_UNICODE
62
63#define PyUnicode_Check(op) 0
Tim Peters78e0fc72001-09-11 03:07:38 +000064#define PyUnicode_CheckExact(op) 0
Martin v. Löwis339d0f72001-08-17 18:39:25 +000065
66#else
67
Fredrik Lundh9b14ab32001-06-26 22:59:49 +000068/* FIXME: MvL's new implementation assumes that Py_UNICODE_SIZE is
69 properly set, but the default rules below doesn't set it. I'll
70 sort this out some other day -- fredrik@pythonware.com */
71
72#ifndef Py_UNICODE_SIZE
73#error Must define Py_UNICODE_SIZE
74#endif
75
Fredrik Lundh8f455852001-06-27 18:59:43 +000076/* Setting Py_UNICODE_WIDE enables UCS-4 storage. Otherwise, Unicode
77 strings are stored as UCS-2 (with limited support for UTF-16) */
78
79#if Py_UNICODE_SIZE >= 4
80#define Py_UNICODE_WIDE
Martin v. Löwis0ba70cc2001-06-26 22:22:37 +000081#endif
Fredrik Lundh1294ad02001-06-26 17:17:07 +000082
Guido van Rossumd8225182000-03-10 22:33:05 +000083/* Set these flags if the platform has "wchar.h", "wctype.h" and the
84 wchar_t type is a 16-bit unsigned type */
85/* #define HAVE_WCHAR_H */
86/* #define HAVE_USABLE_WCHAR_T */
87
88/* Defaults for various platforms */
Martin v. Löwis0ba70cc2001-06-26 22:22:37 +000089#ifndef PY_UNICODE_TYPE
Guido van Rossumd8225182000-03-10 22:33:05 +000090
Fredrik Lundh1294ad02001-06-26 17:17:07 +000091/* Windows has a usable wchar_t type (unless we're using UCS-4) */
Fredrik Lundh8f455852001-06-27 18:59:43 +000092# if defined(MS_WIN32) && Py_UNICODE_SIZE == 2
Guido van Rossumd8225182000-03-10 22:33:05 +000093# define HAVE_USABLE_WCHAR_T
Martin v. Löwis0ba70cc2001-06-26 22:22:37 +000094# define PY_UNICODE_TYPE wchar_t
95# endif
96
Fredrik Lundh8f455852001-06-27 18:59:43 +000097# if defined(Py_UNICODE_WIDE)
Martin v. Löwis0ba70cc2001-06-26 22:22:37 +000098# define PY_UNICODE_TYPE Py_UCS4
Guido van Rossumd8225182000-03-10 22:33:05 +000099# endif
100
101#endif
102
103/* If the compiler provides a wchar_t type we try to support it
104 through the interface functions PyUnicode_FromWideChar() and
105 PyUnicode_AsWideChar(). */
106
107#ifdef HAVE_USABLE_WCHAR_T
Marc-André Lemburg1a731c62000-08-11 11:43:10 +0000108# ifndef HAVE_WCHAR_H
109# define HAVE_WCHAR_H
110# endif
Guido van Rossumd8225182000-03-10 22:33:05 +0000111#endif
112
113#ifdef HAVE_WCHAR_H
Guido van Rossum24bdb042000-03-28 20:29:59 +0000114/* Work around a cosmetic bug in BSDI 4.x wchar.h; thanks to Thomas Wouters */
115# ifdef _HAVE_BSDI
116# include <time.h>
117# endif
Marc-André Lemburg5e6007c2001-09-19 11:21:03 +0000118# include <wchar.h>
Guido van Rossumd8225182000-03-10 22:33:05 +0000119#endif
120
Martin v. Löwis0ba70cc2001-06-26 22:22:37 +0000121/*
122 * Use this typedef when you need to represent a UTF-16 surrogate pair
123 * as single unsigned integer.
124 */
125#if SIZEOF_INT >= 4
126typedef unsigned int Py_UCS4;
127#elif SIZEOF_LONG >= 4
128typedef unsigned long Py_UCS4;
Guido van Rossumd8225182000-03-10 22:33:05 +0000129#endif
130
Martin v. Löwis0ba70cc2001-06-26 22:22:37 +0000131typedef PY_UNICODE_TYPE Py_UNICODE;
Marc-André Lemburg43279102000-07-07 09:01:41 +0000132
Marc-André Lemburgb5ac6f62001-07-31 14:30:16 +0000133/* --- UCS-2/UCS-4 Name Mangling ------------------------------------------ */
134
135/* Unicode API names are mangled to assure that UCS-2 and UCS-4 builds
136 produce different external names and thus cause import errors in
137 case Python interpreters and extensions with mixed compiled in
138 Unicode width assumptions are combined. */
139
140#ifndef Py_UNICODE_WIDE
141
142# define PyUnicode_AsASCIIString PyUnicodeUCS2_AsASCIIString
143# define PyUnicode_AsCharmapString PyUnicodeUCS2_AsCharmapString
Marc-André Lemburgd2d45982004-07-08 17:57:32 +0000144# define PyUnicode_AsEncodedObject PyUnicodeUCS2_AsEncodedObject
Marc-André Lemburgb5ac6f62001-07-31 14:30:16 +0000145# define PyUnicode_AsEncodedString PyUnicodeUCS2_AsEncodedString
146# define PyUnicode_AsLatin1String PyUnicodeUCS2_AsLatin1String
147# define PyUnicode_AsRawUnicodeEscapeString PyUnicodeUCS2_AsRawUnicodeEscapeString
148# define PyUnicode_AsUTF16String PyUnicodeUCS2_AsUTF16String
149# define PyUnicode_AsUTF8String PyUnicodeUCS2_AsUTF8String
150# define PyUnicode_AsUnicode PyUnicodeUCS2_AsUnicode
151# define PyUnicode_AsUnicodeEscapeString PyUnicodeUCS2_AsUnicodeEscapeString
152# define PyUnicode_AsWideChar PyUnicodeUCS2_AsWideChar
153# define PyUnicode_Compare PyUnicodeUCS2_Compare
154# define PyUnicode_Concat PyUnicodeUCS2_Concat
155# define PyUnicode_Contains PyUnicodeUCS2_Contains
156# define PyUnicode_Count PyUnicodeUCS2_Count
157# define PyUnicode_Decode PyUnicodeUCS2_Decode
158# define PyUnicode_DecodeASCII PyUnicodeUCS2_DecodeASCII
159# define PyUnicode_DecodeCharmap PyUnicodeUCS2_DecodeCharmap
160# define PyUnicode_DecodeLatin1 PyUnicodeUCS2_DecodeLatin1
161# define PyUnicode_DecodeRawUnicodeEscape PyUnicodeUCS2_DecodeRawUnicodeEscape
162# define PyUnicode_DecodeUTF16 PyUnicodeUCS2_DecodeUTF16
Walter Dörwald69652032004-09-07 20:24:22 +0000163# define PyUnicode_DecodeUTF16Stateful PyUnicodeUCS2_DecodeUTF16Stateful
Marc-André Lemburgb5ac6f62001-07-31 14:30:16 +0000164# define PyUnicode_DecodeUTF8 PyUnicodeUCS2_DecodeUTF8
Walter Dörwald69652032004-09-07 20:24:22 +0000165# define PyUnicode_DecodeUTF8Stateful PyUnicodeUCS2_DecodeUTF8Stateful
Marc-André Lemburgb5ac6f62001-07-31 14:30:16 +0000166# define PyUnicode_DecodeUnicodeEscape PyUnicodeUCS2_DecodeUnicodeEscape
167# define PyUnicode_Encode PyUnicodeUCS2_Encode
168# define PyUnicode_EncodeASCII PyUnicodeUCS2_EncodeASCII
169# define PyUnicode_EncodeCharmap PyUnicodeUCS2_EncodeCharmap
170# define PyUnicode_EncodeDecimal PyUnicodeUCS2_EncodeDecimal
171# define PyUnicode_EncodeLatin1 PyUnicodeUCS2_EncodeLatin1
172# define PyUnicode_EncodeRawUnicodeEscape PyUnicodeUCS2_EncodeRawUnicodeEscape
173# define PyUnicode_EncodeUTF16 PyUnicodeUCS2_EncodeUTF16
174# define PyUnicode_EncodeUTF8 PyUnicodeUCS2_EncodeUTF8
175# define PyUnicode_EncodeUnicodeEscape PyUnicodeUCS2_EncodeUnicodeEscape
176# define PyUnicode_Find PyUnicodeUCS2_Find
177# define PyUnicode_Format PyUnicodeUCS2_Format
178# define PyUnicode_FromEncodedObject PyUnicodeUCS2_FromEncodedObject
179# define PyUnicode_FromObject PyUnicodeUCS2_FromObject
Marc-André Lemburg9c329de2002-08-12 08:19:10 +0000180# define PyUnicode_FromOrdinal PyUnicodeUCS2_FromOrdinal
Marc-André Lemburgb5ac6f62001-07-31 14:30:16 +0000181# define PyUnicode_FromUnicode PyUnicodeUCS2_FromUnicode
182# define PyUnicode_FromWideChar PyUnicodeUCS2_FromWideChar
183# define PyUnicode_GetDefaultEncoding PyUnicodeUCS2_GetDefaultEncoding
184# define PyUnicode_GetMax PyUnicodeUCS2_GetMax
185# define PyUnicode_GetSize PyUnicodeUCS2_GetSize
186# define PyUnicode_Join PyUnicodeUCS2_Join
Thomas Wouters477c8d52006-05-27 19:21:47 +0000187# define PyUnicode_Partition PyUnicodeUCS2_Partition
188# define PyUnicode_RPartition PyUnicodeUCS2_RPartition
189# define PyUnicode_RSplit PyUnicodeUCS2_RSplit
Marc-André Lemburgb5ac6f62001-07-31 14:30:16 +0000190# define PyUnicode_Replace PyUnicodeUCS2_Replace
191# define PyUnicode_Resize PyUnicodeUCS2_Resize
192# define PyUnicode_SetDefaultEncoding PyUnicodeUCS2_SetDefaultEncoding
193# define PyUnicode_Split PyUnicodeUCS2_Split
194# define PyUnicode_Splitlines PyUnicodeUCS2_Splitlines
195# define PyUnicode_Tailmatch PyUnicodeUCS2_Tailmatch
196# define PyUnicode_Translate PyUnicodeUCS2_Translate
197# define PyUnicode_TranslateCharmap PyUnicodeUCS2_TranslateCharmap
198# define _PyUnicode_AsDefaultEncodedString _PyUnicodeUCS2_AsDefaultEncodedString
199# define _PyUnicode_Fini _PyUnicodeUCS2_Fini
200# define _PyUnicode_Init _PyUnicodeUCS2_Init
201# define _PyUnicode_IsAlpha _PyUnicodeUCS2_IsAlpha
202# define _PyUnicode_IsDecimalDigit _PyUnicodeUCS2_IsDecimalDigit
203# define _PyUnicode_IsDigit _PyUnicodeUCS2_IsDigit
204# define _PyUnicode_IsLinebreak _PyUnicodeUCS2_IsLinebreak
205# define _PyUnicode_IsLowercase _PyUnicodeUCS2_IsLowercase
206# define _PyUnicode_IsNumeric _PyUnicodeUCS2_IsNumeric
207# define _PyUnicode_IsTitlecase _PyUnicodeUCS2_IsTitlecase
208# define _PyUnicode_IsUppercase _PyUnicodeUCS2_IsUppercase
209# define _PyUnicode_IsWhitespace _PyUnicodeUCS2_IsWhitespace
210# define _PyUnicode_ToDecimalDigit _PyUnicodeUCS2_ToDecimalDigit
211# define _PyUnicode_ToDigit _PyUnicodeUCS2_ToDigit
212# define _PyUnicode_ToLowercase _PyUnicodeUCS2_ToLowercase
213# define _PyUnicode_ToNumeric _PyUnicodeUCS2_ToNumeric
214# define _PyUnicode_ToTitlecase _PyUnicodeUCS2_ToTitlecase
215# define _PyUnicode_ToUppercase _PyUnicodeUCS2_ToUppercase
216
217#else
218
219# define PyUnicode_AsASCIIString PyUnicodeUCS4_AsASCIIString
220# define PyUnicode_AsCharmapString PyUnicodeUCS4_AsCharmapString
Marc-André Lemburgd2d45982004-07-08 17:57:32 +0000221# define PyUnicode_AsEncodedObject PyUnicodeUCS4_AsEncodedObject
Marc-André Lemburgb5ac6f62001-07-31 14:30:16 +0000222# define PyUnicode_AsEncodedString PyUnicodeUCS4_AsEncodedString
223# define PyUnicode_AsLatin1String PyUnicodeUCS4_AsLatin1String
224# define PyUnicode_AsRawUnicodeEscapeString PyUnicodeUCS4_AsRawUnicodeEscapeString
225# define PyUnicode_AsUTF16String PyUnicodeUCS4_AsUTF16String
226# define PyUnicode_AsUTF8String PyUnicodeUCS4_AsUTF8String
227# define PyUnicode_AsUnicode PyUnicodeUCS4_AsUnicode
228# define PyUnicode_AsUnicodeEscapeString PyUnicodeUCS4_AsUnicodeEscapeString
229# define PyUnicode_AsWideChar PyUnicodeUCS4_AsWideChar
230# define PyUnicode_Compare PyUnicodeUCS4_Compare
231# define PyUnicode_Concat PyUnicodeUCS4_Concat
232# define PyUnicode_Contains PyUnicodeUCS4_Contains
233# define PyUnicode_Count PyUnicodeUCS4_Count
234# define PyUnicode_Decode PyUnicodeUCS4_Decode
235# define PyUnicode_DecodeASCII PyUnicodeUCS4_DecodeASCII
236# define PyUnicode_DecodeCharmap PyUnicodeUCS4_DecodeCharmap
237# define PyUnicode_DecodeLatin1 PyUnicodeUCS4_DecodeLatin1
238# define PyUnicode_DecodeRawUnicodeEscape PyUnicodeUCS4_DecodeRawUnicodeEscape
239# define PyUnicode_DecodeUTF16 PyUnicodeUCS4_DecodeUTF16
Walter Dörwald69652032004-09-07 20:24:22 +0000240# define PyUnicode_DecodeUTF16Stateful PyUnicodeUCS4_DecodeUTF16Stateful
Marc-André Lemburgb5ac6f62001-07-31 14:30:16 +0000241# define PyUnicode_DecodeUTF8 PyUnicodeUCS4_DecodeUTF8
Walter Dörwald69652032004-09-07 20:24:22 +0000242# define PyUnicode_DecodeUTF8Stateful PyUnicodeUCS4_DecodeUTF8Stateful
Marc-André Lemburgb5ac6f62001-07-31 14:30:16 +0000243# define PyUnicode_DecodeUnicodeEscape PyUnicodeUCS4_DecodeUnicodeEscape
244# define PyUnicode_Encode PyUnicodeUCS4_Encode
245# define PyUnicode_EncodeASCII PyUnicodeUCS4_EncodeASCII
246# define PyUnicode_EncodeCharmap PyUnicodeUCS4_EncodeCharmap
247# define PyUnicode_EncodeDecimal PyUnicodeUCS4_EncodeDecimal
248# define PyUnicode_EncodeLatin1 PyUnicodeUCS4_EncodeLatin1
249# define PyUnicode_EncodeRawUnicodeEscape PyUnicodeUCS4_EncodeRawUnicodeEscape
250# define PyUnicode_EncodeUTF16 PyUnicodeUCS4_EncodeUTF16
251# define PyUnicode_EncodeUTF8 PyUnicodeUCS4_EncodeUTF8
252# define PyUnicode_EncodeUnicodeEscape PyUnicodeUCS4_EncodeUnicodeEscape
253# define PyUnicode_Find PyUnicodeUCS4_Find
254# define PyUnicode_Format PyUnicodeUCS4_Format
255# define PyUnicode_FromEncodedObject PyUnicodeUCS4_FromEncodedObject
256# define PyUnicode_FromObject PyUnicodeUCS4_FromObject
Marc-André Lemburg9c329de2002-08-12 08:19:10 +0000257# define PyUnicode_FromOrdinal PyUnicodeUCS4_FromOrdinal
Marc-André Lemburgb5ac6f62001-07-31 14:30:16 +0000258# define PyUnicode_FromUnicode PyUnicodeUCS4_FromUnicode
259# define PyUnicode_FromWideChar PyUnicodeUCS4_FromWideChar
260# define PyUnicode_GetDefaultEncoding PyUnicodeUCS4_GetDefaultEncoding
261# define PyUnicode_GetMax PyUnicodeUCS4_GetMax
262# define PyUnicode_GetSize PyUnicodeUCS4_GetSize
263# define PyUnicode_Join PyUnicodeUCS4_Join
Thomas Wouters477c8d52006-05-27 19:21:47 +0000264# define PyUnicode_Partition PyUnicodeUCS4_Partition
265# define PyUnicode_RPartition PyUnicodeUCS4_RPartition
266# define PyUnicode_RSplit PyUnicodeUCS4_RSplit
Marc-André Lemburgb5ac6f62001-07-31 14:30:16 +0000267# define PyUnicode_Replace PyUnicodeUCS4_Replace
268# define PyUnicode_Resize PyUnicodeUCS4_Resize
269# define PyUnicode_SetDefaultEncoding PyUnicodeUCS4_SetDefaultEncoding
270# define PyUnicode_Split PyUnicodeUCS4_Split
271# define PyUnicode_Splitlines PyUnicodeUCS4_Splitlines
272# define PyUnicode_Tailmatch PyUnicodeUCS4_Tailmatch
273# define PyUnicode_Translate PyUnicodeUCS4_Translate
274# define PyUnicode_TranslateCharmap PyUnicodeUCS4_TranslateCharmap
275# define _PyUnicode_AsDefaultEncodedString _PyUnicodeUCS4_AsDefaultEncodedString
276# define _PyUnicode_Fini _PyUnicodeUCS4_Fini
277# define _PyUnicode_Init _PyUnicodeUCS4_Init
278# define _PyUnicode_IsAlpha _PyUnicodeUCS4_IsAlpha
279# define _PyUnicode_IsDecimalDigit _PyUnicodeUCS4_IsDecimalDigit
280# define _PyUnicode_IsDigit _PyUnicodeUCS4_IsDigit
281# define _PyUnicode_IsLinebreak _PyUnicodeUCS4_IsLinebreak
282# define _PyUnicode_IsLowercase _PyUnicodeUCS4_IsLowercase
283# define _PyUnicode_IsNumeric _PyUnicodeUCS4_IsNumeric
284# define _PyUnicode_IsTitlecase _PyUnicodeUCS4_IsTitlecase
285# define _PyUnicode_IsUppercase _PyUnicodeUCS4_IsUppercase
286# define _PyUnicode_IsWhitespace _PyUnicodeUCS4_IsWhitespace
287# define _PyUnicode_ToDecimalDigit _PyUnicodeUCS4_ToDecimalDigit
288# define _PyUnicode_ToDigit _PyUnicodeUCS4_ToDigit
289# define _PyUnicode_ToLowercase _PyUnicodeUCS4_ToLowercase
290# define _PyUnicode_ToNumeric _PyUnicodeUCS4_ToNumeric
291# define _PyUnicode_ToTitlecase _PyUnicodeUCS4_ToTitlecase
292# define _PyUnicode_ToUppercase _PyUnicodeUCS4_ToUppercase
293
294
295#endif
296
Guido van Rossumd8225182000-03-10 22:33:05 +0000297/* --- Internal Unicode Operations ---------------------------------------- */
298
299/* If you want Python to use the compiler's wctype.h functions instead
Barry Warsaw51ac5802000-03-20 16:36:48 +0000300 of the ones supplied with Python, define WANT_WCTYPE_FUNCTIONS or
Raymond Hettinger57341c32004-10-31 05:46:59 +0000301 configure Python using --with-wctype-functions. This reduces the
Barry Warsaw51ac5802000-03-20 16:36:48 +0000302 interpreter's code size. */
Guido van Rossumd8225182000-03-10 22:33:05 +0000303
304#if defined(HAVE_USABLE_WCHAR_T) && defined(WANT_WCTYPE_FUNCTIONS)
305
Marc-André Lemburg5e6007c2001-09-19 11:21:03 +0000306#include <wctype.h>
Guido van Rossumd8225182000-03-10 22:33:05 +0000307
308#define Py_UNICODE_ISSPACE(ch) iswspace(ch)
309
310#define Py_UNICODE_ISLOWER(ch) iswlower(ch)
311#define Py_UNICODE_ISUPPER(ch) iswupper(ch)
312#define Py_UNICODE_ISTITLE(ch) _PyUnicode_IsTitlecase(ch)
313#define Py_UNICODE_ISLINEBREAK(ch) _PyUnicode_IsLinebreak(ch)
314
315#define Py_UNICODE_TOLOWER(ch) towlower(ch)
316#define Py_UNICODE_TOUPPER(ch) towupper(ch)
317#define Py_UNICODE_TOTITLE(ch) _PyUnicode_ToTitlecase(ch)
318
319#define Py_UNICODE_ISDECIMAL(ch) _PyUnicode_IsDecimalDigit(ch)
320#define Py_UNICODE_ISDIGIT(ch) _PyUnicode_IsDigit(ch)
321#define Py_UNICODE_ISNUMERIC(ch) _PyUnicode_IsNumeric(ch)
322
323#define Py_UNICODE_TODECIMAL(ch) _PyUnicode_ToDecimalDigit(ch)
324#define Py_UNICODE_TODIGIT(ch) _PyUnicode_ToDigit(ch)
325#define Py_UNICODE_TONUMERIC(ch) _PyUnicode_ToNumeric(ch)
326
Marc-André Lemburgf03e7412000-07-05 09:45:59 +0000327#define Py_UNICODE_ISALPHA(ch) iswalpha(ch)
328
Guido van Rossumd8225182000-03-10 22:33:05 +0000329#else
330
331#define Py_UNICODE_ISSPACE(ch) _PyUnicode_IsWhitespace(ch)
332
333#define Py_UNICODE_ISLOWER(ch) _PyUnicode_IsLowercase(ch)
334#define Py_UNICODE_ISUPPER(ch) _PyUnicode_IsUppercase(ch)
335#define Py_UNICODE_ISTITLE(ch) _PyUnicode_IsTitlecase(ch)
336#define Py_UNICODE_ISLINEBREAK(ch) _PyUnicode_IsLinebreak(ch)
337
338#define Py_UNICODE_TOLOWER(ch) _PyUnicode_ToLowercase(ch)
339#define Py_UNICODE_TOUPPER(ch) _PyUnicode_ToUppercase(ch)
340#define Py_UNICODE_TOTITLE(ch) _PyUnicode_ToTitlecase(ch)
341
342#define Py_UNICODE_ISDECIMAL(ch) _PyUnicode_IsDecimalDigit(ch)
343#define Py_UNICODE_ISDIGIT(ch) _PyUnicode_IsDigit(ch)
344#define Py_UNICODE_ISNUMERIC(ch) _PyUnicode_IsNumeric(ch)
345
346#define Py_UNICODE_TODECIMAL(ch) _PyUnicode_ToDecimalDigit(ch)
347#define Py_UNICODE_TODIGIT(ch) _PyUnicode_ToDigit(ch)
348#define Py_UNICODE_TONUMERIC(ch) _PyUnicode_ToNumeric(ch)
349
Marc-André Lemburgf03e7412000-07-05 09:45:59 +0000350#define Py_UNICODE_ISALPHA(ch) _PyUnicode_IsAlpha(ch)
Guido van Rossumd8225182000-03-10 22:33:05 +0000351
Marc-André Lemburgf03e7412000-07-05 09:45:59 +0000352#endif
Marc-André Lemburga9c103b2000-07-03 10:52:13 +0000353
354#define Py_UNICODE_ISALNUM(ch) \
355 (Py_UNICODE_ISALPHA(ch) || \
356 Py_UNICODE_ISDECIMAL(ch) || \
357 Py_UNICODE_ISDIGIT(ch) || \
358 Py_UNICODE_ISNUMERIC(ch))
359
Thomas Wouters477c8d52006-05-27 19:21:47 +0000360/* memcpy has a considerable setup overhead on many platforms; use a
361 loop for short strings (the "16" below is pretty arbitary) */
362#define Py_UNICODE_COPY(target, source, length) do\
363 {Py_ssize_t i_; Py_UNICODE *t_ = (target); const Py_UNICODE *s_ = (source);\
364 if (length > 16)\
365 memcpy(t_, s_, (length)*sizeof(Py_UNICODE));\
366 else\
367 for (i_ = 0; i_ < (length); i_++) t_[i_] = s_[i_];\
368 } while (0)
Guido van Rossumd8225182000-03-10 22:33:05 +0000369
370#define Py_UNICODE_FILL(target, value, length) do\
Thomas Wouters477c8d52006-05-27 19:21:47 +0000371 {Py_ssize_t i_; Py_UNICODE *t_ = (target); Py_UNICODE v_ = (value);\
372 for (i_ = 0; i_ < (length); i_++) t_[i_] = v_;\
373 } while (0)
Guido van Rossumd8225182000-03-10 22:33:05 +0000374
Thomas Wouters477c8d52006-05-27 19:21:47 +0000375/* check if substring matches at given offset. the offset must be
376 valid, and the substring must not be empty */
377#define Py_UNICODE_MATCH(string, offset, substring) \
378 ((*((string)->str + (offset)) == *((substring)->str)) && \
379 ((*((string)->str + (offset) + (substring)->length-1) == *((substring)->str + (substring)->length-1))) && \
380 !memcmp((string)->str + (offset), (substring)->str, (substring)->length*sizeof(Py_UNICODE)))
Guido van Rossumd8225182000-03-10 22:33:05 +0000381
Barry Warsaw51ac5802000-03-20 16:36:48 +0000382#ifdef __cplusplus
383extern "C" {
384#endif
385
Guido van Rossumd8225182000-03-10 22:33:05 +0000386/* --- Unicode Type ------------------------------------------------------- */
387
388typedef struct {
389 PyObject_HEAD
Martin v. Löwis18e16552006-02-15 17:27:45 +0000390 Py_ssize_t length; /* Length of raw Unicode data in buffer */
Guido van Rossumd8225182000-03-10 22:33:05 +0000391 Py_UNICODE *str; /* Raw Unicode buffer */
392 long hash; /* Hash value; -1 if not set */
Marc-André Lemburgbff879c2000-08-03 18:46:08 +0000393 PyObject *defenc; /* (Default) Encoded version as Python
394 string, or NULL; this is used for
395 implementing the buffer protocol */
Guido van Rossumd8225182000-03-10 22:33:05 +0000396} PyUnicodeObject;
397
Mark Hammond91a681d2002-08-12 07:21:58 +0000398PyAPI_DATA(PyTypeObject) PyUnicode_Type;
Guido van Rossumd8225182000-03-10 22:33:05 +0000399
Guido van Rossum5eef77a2001-08-30 03:08:07 +0000400#define PyUnicode_Check(op) PyObject_TypeCheck(op, &PyUnicode_Type)
Tim Peters78e0fc72001-09-11 03:07:38 +0000401#define PyUnicode_CheckExact(op) ((op)->ob_type == &PyUnicode_Type)
Guido van Rossumd8225182000-03-10 22:33:05 +0000402
403/* Fast access macros */
404#define PyUnicode_GET_SIZE(op) \
405 (((PyUnicodeObject *)(op))->length)
406#define PyUnicode_GET_DATA_SIZE(op) \
407 (((PyUnicodeObject *)(op))->length * sizeof(Py_UNICODE))
408#define PyUnicode_AS_UNICODE(op) \
409 (((PyUnicodeObject *)(op))->str)
410#define PyUnicode_AS_DATA(op) \
411 ((const char *)((PyUnicodeObject *)(op))->str)
412
413/* --- Constants ---------------------------------------------------------- */
414
415/* This Unicode character will be used as replacement character during
416 decoding if the errors argument is set to "replace". Note: the
417 Unicode character U+FFFD is the official REPLACEMENT CHARACTER in
418 Unicode 3.0. */
419
420#define Py_UNICODE_REPLACEMENT_CHARACTER ((Py_UNICODE) 0xFFFD)
421
422/* === Public API ========================================================= */
423
424/* --- Plain Py_UNICODE --------------------------------------------------- */
425
426/* Create a Unicode Object from the Py_UNICODE buffer u of the given
Marc-André Lemburg8155e0e2001-04-23 14:44:21 +0000427 size.
428
429 u may be NULL which causes the contents to be undefined. It is the
430 user's responsibility to fill in the needed data afterwards. Note
431 that modifying the Unicode object contents after construction is
432 only allowed if u was set to NULL.
Guido van Rossumd8225182000-03-10 22:33:05 +0000433
434 The buffer is copied into the new object. */
435
Mark Hammond91a681d2002-08-12 07:21:58 +0000436PyAPI_FUNC(PyObject*) PyUnicode_FromUnicode(
Guido van Rossumd8225182000-03-10 22:33:05 +0000437 const Py_UNICODE *u, /* Unicode buffer */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000438 Py_ssize_t size /* size of buffer */
Guido van Rossumd8225182000-03-10 22:33:05 +0000439 );
440
441/* Return a read-only pointer to the Unicode object's internal
442 Py_UNICODE buffer. */
443
Mark Hammond91a681d2002-08-12 07:21:58 +0000444PyAPI_FUNC(Py_UNICODE *) PyUnicode_AsUnicode(
Guido van Rossumd8225182000-03-10 22:33:05 +0000445 PyObject *unicode /* Unicode object */
446 );
447
448/* Get the length of the Unicode object. */
449
Martin v. Löwis18e16552006-02-15 17:27:45 +0000450PyAPI_FUNC(Py_ssize_t) PyUnicode_GetSize(
Guido van Rossumd8225182000-03-10 22:33:05 +0000451 PyObject *unicode /* Unicode object */
452 );
453
Martin v. Löwisce9b5a52001-06-27 06:28:56 +0000454/* Get the maximum ordinal for a Unicode character. */
Mark Hammond91a681d2002-08-12 07:21:58 +0000455PyAPI_FUNC(Py_UNICODE) PyUnicode_GetMax(void);
Martin v. Löwisce9b5a52001-06-27 06:28:56 +0000456
Guido van Rossum52c23592000-04-10 13:41:41 +0000457/* Resize an already allocated Unicode object to the new size length.
458
459 *unicode is modified to point to the new (resized) object and 0
460 returned on success.
461
462 This API may only be called by the function which also called the
463 Unicode constructor. The refcount on the object must be 1. Otherwise,
464 an error is returned.
465
466 Error handling is implemented as follows: an exception is set, -1
467 is returned and *unicode left untouched.
468
469*/
470
Mark Hammond91a681d2002-08-12 07:21:58 +0000471PyAPI_FUNC(int) PyUnicode_Resize(
Guido van Rossum52c23592000-04-10 13:41:41 +0000472 PyObject **unicode, /* Pointer to the Unicode object */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000473 Py_ssize_t length /* New length */
Guido van Rossum52c23592000-04-10 13:41:41 +0000474 );
475
Guido van Rossumd8225182000-03-10 22:33:05 +0000476/* Coerce obj to an Unicode object and return a reference with
477 *incremented* refcount.
478
479 Coercion is done in the following way:
480
Guido van Rossumb8c65bc2001-10-19 02:01:31 +0000481 1. String and other char buffer compatible objects are decoded
Fred Drakecb093fe2000-05-09 19:51:53 +0000482 under the assumptions that they contain data using the current
483 default encoding. Decoding is done in "strict" mode.
Guido van Rossumd8225182000-03-10 22:33:05 +0000484
Guido van Rossumb8c65bc2001-10-19 02:01:31 +0000485 2. All other objects (including Unicode objects) raise an
486 exception.
Guido van Rossumd8225182000-03-10 22:33:05 +0000487
488 The API returns NULL in case of an error. The caller is responsible
489 for decref'ing the returned objects.
490
491*/
492
Mark Hammond91a681d2002-08-12 07:21:58 +0000493PyAPI_FUNC(PyObject*) PyUnicode_FromEncodedObject(
Marc-André Lemburg5a5c81a2000-07-07 13:46:42 +0000494 register PyObject *obj, /* Object */
495 const char *encoding, /* encoding */
496 const char *errors /* error handling */
497 );
498
Guido van Rossumb8c65bc2001-10-19 02:01:31 +0000499/* Coerce obj to an Unicode object and return a reference with
Marc-André Lemburg5a5c81a2000-07-07 13:46:42 +0000500 *incremented* refcount.
Guido van Rossumb8c65bc2001-10-19 02:01:31 +0000501
502 Unicode objects are passed back as-is (subclasses are converted to
503 true Unicode objects), all other objects are delegated to
504 PyUnicode_FromEncodedObject(obj, NULL, "strict") which results in
505 using the default encoding as basis for decoding the object.
Marc-André Lemburg5a5c81a2000-07-07 13:46:42 +0000506
507 The API returns NULL in case of an error. The caller is responsible
508 for decref'ing the returned objects.
509
510*/
511
Mark Hammond91a681d2002-08-12 07:21:58 +0000512PyAPI_FUNC(PyObject*) PyUnicode_FromObject(
Guido van Rossumd8225182000-03-10 22:33:05 +0000513 register PyObject *obj /* Object */
514 );
515
516/* --- wchar_t support for platforms which support it --------------------- */
517
518#ifdef HAVE_WCHAR_H
519
520/* Create a Unicode Object from the whcar_t buffer w of the given
521 size.
522
523 The buffer is copied into the new object. */
524
Mark Hammond91a681d2002-08-12 07:21:58 +0000525PyAPI_FUNC(PyObject*) PyUnicode_FromWideChar(
Guido van Rossumd8225182000-03-10 22:33:05 +0000526 register const wchar_t *w, /* wchar_t buffer */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000527 Py_ssize_t size /* size of buffer */
Guido van Rossumd8225182000-03-10 22:33:05 +0000528 );
529
Marc-André Lemburga9cadcd2004-11-22 13:02:31 +0000530/* Copies the Unicode Object contents into the wchar_t buffer w. At
Guido van Rossumd8225182000-03-10 22:33:05 +0000531 most size wchar_t characters are copied.
532
Marc-André Lemburga9cadcd2004-11-22 13:02:31 +0000533 Note that the resulting wchar_t string may or may not be
534 0-terminated. It is the responsibility of the caller to make sure
535 that the wchar_t string is 0-terminated in case this is required by
536 the application.
537
538 Returns the number of wchar_t characters copied (excluding a
539 possibly trailing 0-termination character) or -1 in case of an
Guido van Rossumd8225182000-03-10 22:33:05 +0000540 error. */
541
Martin v. Löwis18e16552006-02-15 17:27:45 +0000542PyAPI_FUNC(Py_ssize_t) PyUnicode_AsWideChar(
Guido van Rossumd8225182000-03-10 22:33:05 +0000543 PyUnicodeObject *unicode, /* Unicode object */
544 register wchar_t *w, /* wchar_t buffer */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000545 Py_ssize_t size /* size of buffer */
Guido van Rossumd8225182000-03-10 22:33:05 +0000546 );
547
548#endif
549
Marc-André Lemburgcc8764c2002-08-11 12:23:04 +0000550/* --- Unicode ordinals --------------------------------------------------- */
551
552/* Create a Unicode Object from the given Unicode code point ordinal.
553
554 The ordinal must be in range(0x10000) on narrow Python builds
555 (UCS2), and range(0x110000) on wide builds (UCS4). A ValueError is
556 raised in case it is not.
557
558*/
559
Marc-André Lemburg9c329de2002-08-12 08:19:10 +0000560PyAPI_FUNC(PyObject*) PyUnicode_FromOrdinal(int ordinal);
Marc-André Lemburgcc8764c2002-08-11 12:23:04 +0000561
Guido van Rossumd8225182000-03-10 22:33:05 +0000562/* === Builtin Codecs =====================================================
563
564 Many of these APIs take two arguments encoding and errors. These
565 parameters encoding and errors have the same semantics as the ones
566 of the builtin unicode() API.
567
Fred Drakecb093fe2000-05-09 19:51:53 +0000568 Setting encoding to NULL causes the default encoding to be used.
Guido van Rossumd8225182000-03-10 22:33:05 +0000569
570 Error handling is set by errors which may also be set to NULL
571 meaning to use the default handling defined for the codec. Default
572 error handling for all builtin codecs is "strict" (ValueErrors are
573 raised).
574
575 The codecs all use a similar interface. Only deviation from the
576 generic ones are documented.
577
578*/
579
Fred Drakecb093fe2000-05-09 19:51:53 +0000580/* --- Manage the default encoding ---------------------------------------- */
581
Jeremy Hylton3ce45382001-07-30 22:34:24 +0000582/* Return a Python string holding the default encoded value of the
583 Unicode object.
584
585 The resulting string is cached in the Unicode object for subsequent
586 usage by this function. The cached version is needed to implement
587 the character buffer interface and will live (at least) as long as
588 the Unicode object itself.
589
590 The refcount of the string is *not* incremented.
591
592 *** Exported for internal use by the interpreter only !!! ***
593
594*/
595
Mark Hammond91a681d2002-08-12 07:21:58 +0000596PyAPI_FUNC(PyObject *) _PyUnicode_AsDefaultEncodedString(
Jeremy Hylton3ce45382001-07-30 22:34:24 +0000597 PyObject *, const char *);
598
Fred Drakecb093fe2000-05-09 19:51:53 +0000599/* Returns the currently active default encoding.
600
601 The default encoding is currently implemented as run-time settable
602 process global. This may change in future versions of the
603 interpreter to become a parameter which is managed on a per-thread
604 basis.
605
606 */
607
Mark Hammond91a681d2002-08-12 07:21:58 +0000608PyAPI_FUNC(const char*) PyUnicode_GetDefaultEncoding(void);
Fred Drakecb093fe2000-05-09 19:51:53 +0000609
610/* Sets the currently active default encoding.
611
612 Returns 0 on success, -1 in case of an error.
613
614 */
615
Mark Hammond91a681d2002-08-12 07:21:58 +0000616PyAPI_FUNC(int) PyUnicode_SetDefaultEncoding(
Fred Drakecb093fe2000-05-09 19:51:53 +0000617 const char *encoding /* Encoding name in standard form */
618 );
619
Guido van Rossumd8225182000-03-10 22:33:05 +0000620/* --- Generic Codecs ----------------------------------------------------- */
621
622/* Create a Unicode object by decoding the encoded string s of the
623 given size. */
624
Mark Hammond91a681d2002-08-12 07:21:58 +0000625PyAPI_FUNC(PyObject*) PyUnicode_Decode(
Guido van Rossumd8225182000-03-10 22:33:05 +0000626 const char *s, /* encoded string */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000627 Py_ssize_t size, /* size of buffer */
Guido van Rossumd8225182000-03-10 22:33:05 +0000628 const char *encoding, /* encoding */
629 const char *errors /* error handling */
630 );
631
632/* Encodes a Py_UNICODE buffer of the given size and returns a
633 Python string object. */
634
Mark Hammond91a681d2002-08-12 07:21:58 +0000635PyAPI_FUNC(PyObject*) PyUnicode_Encode(
Guido van Rossumd8225182000-03-10 22:33:05 +0000636 const Py_UNICODE *s, /* Unicode char buffer */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000637 Py_ssize_t size, /* number of Py_UNICODE chars to encode */
Guido van Rossumd8225182000-03-10 22:33:05 +0000638 const char *encoding, /* encoding */
639 const char *errors /* error handling */
640 );
641
Marc-André Lemburgd2d45982004-07-08 17:57:32 +0000642/* Encodes a Unicode object and returns the result as Python
643 object. */
644
645PyAPI_FUNC(PyObject*) PyUnicode_AsEncodedObject(
646 PyObject *unicode, /* Unicode object */
647 const char *encoding, /* encoding */
648 const char *errors /* error handling */
649 );
650
Guido van Rossumd8225182000-03-10 22:33:05 +0000651/* Encodes a Unicode object and returns the result as Python string
652 object. */
653
Mark Hammond91a681d2002-08-12 07:21:58 +0000654PyAPI_FUNC(PyObject*) PyUnicode_AsEncodedString(
Guido van Rossumd8225182000-03-10 22:33:05 +0000655 PyObject *unicode, /* Unicode object */
656 const char *encoding, /* encoding */
657 const char *errors /* error handling */
658 );
659
Marc-André Lemburgc60e6f72001-09-20 10:35:46 +0000660/* --- UTF-7 Codecs ------------------------------------------------------- */
661
Mark Hammond91a681d2002-08-12 07:21:58 +0000662PyAPI_FUNC(PyObject*) PyUnicode_DecodeUTF7(
Marc-André Lemburgc60e6f72001-09-20 10:35:46 +0000663 const char *string, /* UTF-7 encoded string */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000664 Py_ssize_t length, /* size of string */
Marc-André Lemburgc60e6f72001-09-20 10:35:46 +0000665 const char *errors /* error handling */
666 );
667
Mark Hammond91a681d2002-08-12 07:21:58 +0000668PyAPI_FUNC(PyObject*) PyUnicode_EncodeUTF7(
Marc-André Lemburgc60e6f72001-09-20 10:35:46 +0000669 const Py_UNICODE *data, /* Unicode char buffer */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000670 Py_ssize_t length, /* number of Py_UNICODE chars to encode */
Marc-André Lemburgc60e6f72001-09-20 10:35:46 +0000671 int encodeSetO, /* force the encoder to encode characters in
672 Set O, as described in RFC2152 */
673 int encodeWhiteSpace, /* force the encoder to encode space, tab,
674 carriage return and linefeed characters */
675 const char *errors /* error handling */
676 );
677
Guido van Rossumd8225182000-03-10 22:33:05 +0000678/* --- UTF-8 Codecs ------------------------------------------------------- */
679
Mark Hammond91a681d2002-08-12 07:21:58 +0000680PyAPI_FUNC(PyObject*) PyUnicode_DecodeUTF8(
Guido van Rossumd8225182000-03-10 22:33:05 +0000681 const char *string, /* UTF-8 encoded string */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000682 Py_ssize_t length, /* size of string */
Guido van Rossumd8225182000-03-10 22:33:05 +0000683 const char *errors /* error handling */
684 );
685
Walter Dörwald69652032004-09-07 20:24:22 +0000686PyAPI_FUNC(PyObject*) PyUnicode_DecodeUTF8Stateful(
687 const char *string, /* UTF-8 encoded string */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000688 Py_ssize_t length, /* size of string */
Walter Dörwald69652032004-09-07 20:24:22 +0000689 const char *errors, /* error handling */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000690 Py_ssize_t *consumed /* bytes consumed */
Walter Dörwald69652032004-09-07 20:24:22 +0000691 );
692
Mark Hammond91a681d2002-08-12 07:21:58 +0000693PyAPI_FUNC(PyObject*) PyUnicode_AsUTF8String(
Guido van Rossumd8225182000-03-10 22:33:05 +0000694 PyObject *unicode /* Unicode object */
695 );
696
Mark Hammond91a681d2002-08-12 07:21:58 +0000697PyAPI_FUNC(PyObject*) PyUnicode_EncodeUTF8(
Guido van Rossumd8225182000-03-10 22:33:05 +0000698 const Py_UNICODE *data, /* Unicode char buffer */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000699 Py_ssize_t length, /* number of Py_UNICODE chars to encode */
Guido van Rossumd8225182000-03-10 22:33:05 +0000700 const char *errors /* error handling */
701 );
702
703/* --- UTF-16 Codecs ------------------------------------------------------ */
704
Guido van Rossum9e896b32000-04-05 20:11:21 +0000705/* Decodes length bytes from a UTF-16 encoded buffer string and returns
Guido van Rossumd8225182000-03-10 22:33:05 +0000706 the corresponding Unicode object.
707
708 errors (if non-NULL) defines the error handling. It defaults
709 to "strict".
710
711 If byteorder is non-NULL, the decoder starts decoding using the
712 given byte order:
713
714 *byteorder == -1: little endian
715 *byteorder == 0: native order
716 *byteorder == 1: big endian
717
Marc-André Lemburg489b56e2001-05-21 20:30:15 +0000718 In native mode, the first two bytes of the stream are checked for a
719 BOM mark. If found, the BOM mark is analysed, the byte order
720 adjusted and the BOM skipped. In the other modes, no BOM mark
721 interpretation is done. After completion, *byteorder is set to the
722 current byte order at the end of input data.
Guido van Rossumd8225182000-03-10 22:33:05 +0000723
724 If byteorder is NULL, the codec starts in native order mode.
725
726*/
727
Mark Hammond91a681d2002-08-12 07:21:58 +0000728PyAPI_FUNC(PyObject*) PyUnicode_DecodeUTF16(
Guido van Rossumd8225182000-03-10 22:33:05 +0000729 const char *string, /* UTF-16 encoded string */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000730 Py_ssize_t length, /* size of string */
Guido van Rossumd8225182000-03-10 22:33:05 +0000731 const char *errors, /* error handling */
732 int *byteorder /* pointer to byteorder to use
733 0=native;-1=LE,1=BE; updated on
734 exit */
735 );
736
Walter Dörwald69652032004-09-07 20:24:22 +0000737PyAPI_FUNC(PyObject*) PyUnicode_DecodeUTF16Stateful(
738 const char *string, /* UTF-16 encoded string */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000739 Py_ssize_t length, /* size of string */
Walter Dörwald69652032004-09-07 20:24:22 +0000740 const char *errors, /* error handling */
741 int *byteorder, /* pointer to byteorder to use
742 0=native;-1=LE,1=BE; updated on
743 exit */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000744 Py_ssize_t *consumed /* bytes consumed */
Walter Dörwald69652032004-09-07 20:24:22 +0000745 );
746
Guido van Rossumd8225182000-03-10 22:33:05 +0000747/* Returns a Python string using the UTF-16 encoding in native byte
748 order. The string always starts with a BOM mark. */
749
Mark Hammond91a681d2002-08-12 07:21:58 +0000750PyAPI_FUNC(PyObject*) PyUnicode_AsUTF16String(
Guido van Rossumd8225182000-03-10 22:33:05 +0000751 PyObject *unicode /* Unicode object */
752 );
753
754/* Returns a Python string object holding the UTF-16 encoded value of
Guido van Rossum9e896b32000-04-05 20:11:21 +0000755 the Unicode data.
Guido van Rossumd8225182000-03-10 22:33:05 +0000756
757 If byteorder is not 0, output is written according to the following
758 byte order:
759
760 byteorder == -1: little endian
761 byteorder == 0: native byte order (writes a BOM mark)
762 byteorder == 1: big endian
763
764 If byteorder is 0, the output string will always start with the
765 Unicode BOM mark (U+FEFF). In the other two modes, no BOM mark is
766 prepended.
767
768 Note that Py_UNICODE data is being interpreted as UTF-16 reduced to
769 UCS-2. This trick makes it possible to add full UTF-16 capabilities
Thomas Wouters7e474022000-07-16 12:04:32 +0000770 at a later point without compromising the APIs.
Guido van Rossumd8225182000-03-10 22:33:05 +0000771
772*/
773
Mark Hammond91a681d2002-08-12 07:21:58 +0000774PyAPI_FUNC(PyObject*) PyUnicode_EncodeUTF16(
Guido van Rossumd8225182000-03-10 22:33:05 +0000775 const Py_UNICODE *data, /* Unicode char buffer */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000776 Py_ssize_t length, /* number of Py_UNICODE chars to encode */
Guido van Rossumd8225182000-03-10 22:33:05 +0000777 const char *errors, /* error handling */
778 int byteorder /* byteorder to use 0=BOM+native;-1=LE,1=BE */
779 );
780
781/* --- Unicode-Escape Codecs ---------------------------------------------- */
782
Mark Hammond91a681d2002-08-12 07:21:58 +0000783PyAPI_FUNC(PyObject*) PyUnicode_DecodeUnicodeEscape(
Guido van Rossumd8225182000-03-10 22:33:05 +0000784 const char *string, /* Unicode-Escape encoded string */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000785 Py_ssize_t length, /* size of string */
Guido van Rossumd8225182000-03-10 22:33:05 +0000786 const char *errors /* error handling */
787 );
788
Mark Hammond91a681d2002-08-12 07:21:58 +0000789PyAPI_FUNC(PyObject*) PyUnicode_AsUnicodeEscapeString(
Guido van Rossumd8225182000-03-10 22:33:05 +0000790 PyObject *unicode /* Unicode object */
791 );
792
Mark Hammond91a681d2002-08-12 07:21:58 +0000793PyAPI_FUNC(PyObject*) PyUnicode_EncodeUnicodeEscape(
Guido van Rossumd8225182000-03-10 22:33:05 +0000794 const Py_UNICODE *data, /* Unicode char buffer */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000795 Py_ssize_t length /* Number of Py_UNICODE chars to encode */
Guido van Rossumd8225182000-03-10 22:33:05 +0000796 );
797
798/* --- Raw-Unicode-Escape Codecs ------------------------------------------ */
799
Mark Hammond91a681d2002-08-12 07:21:58 +0000800PyAPI_FUNC(PyObject*) PyUnicode_DecodeRawUnicodeEscape(
Guido van Rossumd8225182000-03-10 22:33:05 +0000801 const char *string, /* Raw-Unicode-Escape encoded string */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000802 Py_ssize_t length, /* size of string */
Guido van Rossumd8225182000-03-10 22:33:05 +0000803 const char *errors /* error handling */
804 );
805
Mark Hammond91a681d2002-08-12 07:21:58 +0000806PyAPI_FUNC(PyObject*) PyUnicode_AsRawUnicodeEscapeString(
Guido van Rossumd8225182000-03-10 22:33:05 +0000807 PyObject *unicode /* Unicode object */
808 );
809
Mark Hammond91a681d2002-08-12 07:21:58 +0000810PyAPI_FUNC(PyObject*) PyUnicode_EncodeRawUnicodeEscape(
Guido van Rossumd8225182000-03-10 22:33:05 +0000811 const Py_UNICODE *data, /* Unicode char buffer */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000812 Py_ssize_t length /* Number of Py_UNICODE chars to encode */
Guido van Rossumd8225182000-03-10 22:33:05 +0000813 );
814
Walter Dörwalda47d1c02005-08-30 10:23:14 +0000815/* --- Unicode Internal Codec ---------------------------------------------
816
817 Only for internal use in _codecsmodule.c */
818
819PyObject *_PyUnicode_DecodeUnicodeInternal(
820 const char *string,
Martin v. Löwis18e16552006-02-15 17:27:45 +0000821 Py_ssize_t length,
Walter Dörwalda47d1c02005-08-30 10:23:14 +0000822 const char *errors
823 );
824
Guido van Rossumd8225182000-03-10 22:33:05 +0000825/* --- Latin-1 Codecs -----------------------------------------------------
826
827 Note: Latin-1 corresponds to the first 256 Unicode ordinals.
828
829*/
830
Mark Hammond91a681d2002-08-12 07:21:58 +0000831PyAPI_FUNC(PyObject*) PyUnicode_DecodeLatin1(
Guido van Rossumd8225182000-03-10 22:33:05 +0000832 const char *string, /* Latin-1 encoded string */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000833 Py_ssize_t length, /* size of string */
Guido van Rossumd8225182000-03-10 22:33:05 +0000834 const char *errors /* error handling */
835 );
836
Mark Hammond91a681d2002-08-12 07:21:58 +0000837PyAPI_FUNC(PyObject*) PyUnicode_AsLatin1String(
Guido van Rossumd8225182000-03-10 22:33:05 +0000838 PyObject *unicode /* Unicode object */
839 );
840
Mark Hammond91a681d2002-08-12 07:21:58 +0000841PyAPI_FUNC(PyObject*) PyUnicode_EncodeLatin1(
Guido van Rossumd8225182000-03-10 22:33:05 +0000842 const Py_UNICODE *data, /* Unicode char buffer */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000843 Py_ssize_t length, /* Number of Py_UNICODE chars to encode */
Guido van Rossumd8225182000-03-10 22:33:05 +0000844 const char *errors /* error handling */
845 );
846
847/* --- ASCII Codecs -------------------------------------------------------
848
849 Only 7-bit ASCII data is excepted. All other codes generate errors.
850
851*/
852
Mark Hammond91a681d2002-08-12 07:21:58 +0000853PyAPI_FUNC(PyObject*) PyUnicode_DecodeASCII(
Guido van Rossumd8225182000-03-10 22:33:05 +0000854 const char *string, /* ASCII encoded string */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000855 Py_ssize_t length, /* size of string */
Guido van Rossumd8225182000-03-10 22:33:05 +0000856 const char *errors /* error handling */
857 );
858
Mark Hammond91a681d2002-08-12 07:21:58 +0000859PyAPI_FUNC(PyObject*) PyUnicode_AsASCIIString(
Guido van Rossumd8225182000-03-10 22:33:05 +0000860 PyObject *unicode /* Unicode object */
861 );
862
Mark Hammond91a681d2002-08-12 07:21:58 +0000863PyAPI_FUNC(PyObject*) PyUnicode_EncodeASCII(
Guido van Rossumd8225182000-03-10 22:33:05 +0000864 const Py_UNICODE *data, /* Unicode char buffer */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000865 Py_ssize_t length, /* Number of Py_UNICODE chars to encode */
Guido van Rossumd8225182000-03-10 22:33:05 +0000866 const char *errors /* error handling */
867 );
868
869/* --- Character Map Codecs -----------------------------------------------
870
871 This codec uses mappings to encode and decode characters.
872
873 Decoding mappings must map single string characters to single
874 Unicode characters, integers (which are then interpreted as Unicode
875 ordinals) or None (meaning "undefined mapping" and causing an
876 error).
877
878 Encoding mappings must map single Unicode characters to single
879 string characters, integers (which are then interpreted as Latin-1
880 ordinals) or None (meaning "undefined mapping" and causing an
881 error).
882
883 If a character lookup fails with a LookupError, the character is
884 copied as-is meaning that its ordinal value will be interpreted as
885 Unicode or Latin-1 ordinal resp. Because of this mappings only need
886 to contain those mappings which map characters to different code
887 points.
888
889*/
890
Mark Hammond91a681d2002-08-12 07:21:58 +0000891PyAPI_FUNC(PyObject*) PyUnicode_DecodeCharmap(
Guido van Rossumd8225182000-03-10 22:33:05 +0000892 const char *string, /* Encoded string */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000893 Py_ssize_t length, /* size of string */
Guido van Rossumd8225182000-03-10 22:33:05 +0000894 PyObject *mapping, /* character mapping
895 (char ordinal -> unicode ordinal) */
896 const char *errors /* error handling */
897 );
898
Mark Hammond91a681d2002-08-12 07:21:58 +0000899PyAPI_FUNC(PyObject*) PyUnicode_AsCharmapString(
Guido van Rossumd8225182000-03-10 22:33:05 +0000900 PyObject *unicode, /* Unicode object */
901 PyObject *mapping /* character mapping
902 (unicode ordinal -> char ordinal) */
903 );
904
Mark Hammond91a681d2002-08-12 07:21:58 +0000905PyAPI_FUNC(PyObject*) PyUnicode_EncodeCharmap(
Guido van Rossumd8225182000-03-10 22:33:05 +0000906 const Py_UNICODE *data, /* Unicode char buffer */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000907 Py_ssize_t length, /* Number of Py_UNICODE chars to encode */
Guido van Rossumd8225182000-03-10 22:33:05 +0000908 PyObject *mapping, /* character mapping
909 (unicode ordinal -> char ordinal) */
910 const char *errors /* error handling */
911 );
912
913/* Translate a Py_UNICODE buffer of the given length by applying a
914 character mapping table to it and return the resulting Unicode
915 object.
916
917 The mapping table must map Unicode ordinal integers to Unicode
918 ordinal integers or None (causing deletion of the character).
919
920 Mapping tables may be dictionaries or sequences. Unmapped character
921 ordinals (ones which cause a LookupError) are left untouched and
922 are copied as-is.
923
924*/
925
Mark Hammond91a681d2002-08-12 07:21:58 +0000926PyAPI_FUNC(PyObject *) PyUnicode_TranslateCharmap(
Guido van Rossumd8225182000-03-10 22:33:05 +0000927 const Py_UNICODE *data, /* Unicode char buffer */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000928 Py_ssize_t length, /* Number of Py_UNICODE chars to encode */
Guido van Rossumd8225182000-03-10 22:33:05 +0000929 PyObject *table, /* Translate table */
930 const char *errors /* error handling */
931 );
932
Guido van Rossumefec1152000-03-28 02:01:15 +0000933#ifdef MS_WIN32
Guido van Rossum24bdb042000-03-28 20:29:59 +0000934
Guido van Rossumefec1152000-03-28 02:01:15 +0000935/* --- MBCS codecs for Windows -------------------------------------------- */
Guido van Rossum24bdb042000-03-28 20:29:59 +0000936
Mark Hammond91a681d2002-08-12 07:21:58 +0000937PyAPI_FUNC(PyObject*) PyUnicode_DecodeMBCS(
Guido van Rossumefec1152000-03-28 02:01:15 +0000938 const char *string, /* MBCS encoded string */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000939 Py_ssize_t length, /* size of string */
Guido van Rossumefec1152000-03-28 02:01:15 +0000940 const char *errors /* error handling */
941 );
942
Mark Hammond91a681d2002-08-12 07:21:58 +0000943PyAPI_FUNC(PyObject*) PyUnicode_AsMBCSString(
Guido van Rossumefec1152000-03-28 02:01:15 +0000944 PyObject *unicode /* Unicode object */
945 );
946
Mark Hammond91a681d2002-08-12 07:21:58 +0000947PyAPI_FUNC(PyObject*) PyUnicode_EncodeMBCS(
Guido van Rossumefec1152000-03-28 02:01:15 +0000948 const Py_UNICODE *data, /* Unicode char buffer */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000949 Py_ssize_t length, /* Number of Py_UNICODE chars to encode */
Guido van Rossumefec1152000-03-28 02:01:15 +0000950 const char *errors /* error handling */
951 );
952
Guido van Rossumefec1152000-03-28 02:01:15 +0000953#endif /* MS_WIN32 */
Guido van Rossum24bdb042000-03-28 20:29:59 +0000954
Guido van Rossum9e896b32000-04-05 20:11:21 +0000955/* --- Decimal Encoder ---------------------------------------------------- */
956
957/* Takes a Unicode string holding a decimal value and writes it into
958 an output buffer using standard ASCII digit codes.
959
960 The output buffer has to provide at least length+1 bytes of storage
961 area. The output string is 0-terminated.
962
963 The encoder converts whitespace to ' ', decimal characters to their
964 corresponding ASCII digit and all other Latin-1 characters except
965 \0 as-is. Characters outside this range (Unicode ordinals 1-256)
966 are treated as errors. This includes embedded NULL bytes.
967
968 Error handling is defined by the errors argument:
969
970 NULL or "strict": raise a ValueError
971 "ignore": ignore the wrong characters (these are not copied to the
972 output buffer)
973 "replace": replaces illegal characters with '?'
974
975 Returns 0 on success, -1 on failure.
976
977*/
978
Mark Hammond91a681d2002-08-12 07:21:58 +0000979PyAPI_FUNC(int) PyUnicode_EncodeDecimal(
Guido van Rossum9e896b32000-04-05 20:11:21 +0000980 Py_UNICODE *s, /* Unicode buffer */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000981 Py_ssize_t length, /* Number of Py_UNICODE chars to encode */
Guido van Rossum9e896b32000-04-05 20:11:21 +0000982 char *output, /* Output buffer; must have size >= length */
983 const char *errors /* error handling */
984 );
985
Guido van Rossumd8225182000-03-10 22:33:05 +0000986/* --- Methods & Slots ----------------------------------------------------
987
988 These are capable of handling Unicode objects and strings on input
989 (we refer to them as strings in the descriptions) and return
990 Unicode objects or integers as apporpriate. */
991
992/* Concat two strings giving a new Unicode string. */
993
Mark Hammond91a681d2002-08-12 07:21:58 +0000994PyAPI_FUNC(PyObject*) PyUnicode_Concat(
Guido van Rossumd8225182000-03-10 22:33:05 +0000995 PyObject *left, /* Left string */
996 PyObject *right /* Right string */
997 );
998
999/* Split a string giving a list of Unicode strings.
1000
1001 If sep is NULL, splitting will be done at all whitespace
1002 substrings. Otherwise, splits occur at the given separator.
1003
1004 At most maxsplit splits will be done. If negative, no limit is set.
1005
1006 Separators are not included in the resulting list.
1007
1008*/
1009
Mark Hammond91a681d2002-08-12 07:21:58 +00001010PyAPI_FUNC(PyObject*) PyUnicode_Split(
Guido van Rossumd8225182000-03-10 22:33:05 +00001011 PyObject *s, /* String to split */
1012 PyObject *sep, /* String separator */
Martin v. Löwis18e16552006-02-15 17:27:45 +00001013 Py_ssize_t maxsplit /* Maxsplit count */
Guido van Rossumd8225182000-03-10 22:33:05 +00001014 );
1015
1016/* Dito, but split at line breaks.
1017
1018 CRLF is considered to be one line break. Line breaks are not
1019 included in the resulting list. */
1020
Mark Hammond91a681d2002-08-12 07:21:58 +00001021PyAPI_FUNC(PyObject*) PyUnicode_Splitlines(
Guido van Rossumd8225182000-03-10 22:33:05 +00001022 PyObject *s, /* String to split */
Guido van Rossum004d64f2000-04-11 15:39:46 +00001023 int keepends /* If true, line end markers are included */
Guido van Rossumd8225182000-03-10 22:33:05 +00001024 );
1025
Thomas Wouters477c8d52006-05-27 19:21:47 +00001026/* Partition a string using a given separator. */
1027
1028PyAPI_FUNC(PyObject*) PyUnicode_Partition(
1029 PyObject *s, /* String to partition */
1030 PyObject *sep /* String separator */
1031 );
1032
1033/* Partition a string using a given separator, searching from the end of the
1034 string. */
1035
1036PyAPI_FUNC(PyObject*) PyUnicode_RPartition(
1037 PyObject *s, /* String to partition */
1038 PyObject *sep /* String separator */
1039 );
1040
Hye-Shik Chang3ae811b2003-12-15 18:49:53 +00001041/* Split a string giving a list of Unicode strings.
1042
1043 If sep is NULL, splitting will be done at all whitespace
1044 substrings. Otherwise, splits occur at the given separator.
1045
1046 At most maxsplit splits will be done. But unlike PyUnicode_Split
1047 PyUnicode_RSplit splits from the end of the string. If negative,
1048 no limit is set.
1049
1050 Separators are not included in the resulting list.
1051
1052*/
1053
1054PyAPI_FUNC(PyObject*) PyUnicode_RSplit(
1055 PyObject *s, /* String to split */
1056 PyObject *sep, /* String separator */
Martin v. Löwis18e16552006-02-15 17:27:45 +00001057 Py_ssize_t maxsplit /* Maxsplit count */
Hye-Shik Chang3ae811b2003-12-15 18:49:53 +00001058 );
1059
Guido van Rossumd8225182000-03-10 22:33:05 +00001060/* Translate a string by applying a character mapping table to it and
1061 return the resulting Unicode object.
1062
1063 The mapping table must map Unicode ordinal integers to Unicode
1064 ordinal integers or None (causing deletion of the character).
1065
1066 Mapping tables may be dictionaries or sequences. Unmapped character
1067 ordinals (ones which cause a LookupError) are left untouched and
1068 are copied as-is.
1069
1070*/
1071
Mark Hammond91a681d2002-08-12 07:21:58 +00001072PyAPI_FUNC(PyObject *) PyUnicode_Translate(
Guido van Rossumd8225182000-03-10 22:33:05 +00001073 PyObject *str, /* String */
1074 PyObject *table, /* Translate table */
1075 const char *errors /* error handling */
1076 );
1077
1078/* Join a sequence of strings using the given separator and return
1079 the resulting Unicode string. */
1080
Mark Hammond91a681d2002-08-12 07:21:58 +00001081PyAPI_FUNC(PyObject*) PyUnicode_Join(
Guido van Rossumd8225182000-03-10 22:33:05 +00001082 PyObject *separator, /* Separator string */
1083 PyObject *seq /* Sequence object */
1084 );
1085
1086/* Return 1 if substr matches str[start:end] at the given tail end, 0
1087 otherwise. */
1088
Martin v. Löwis18e16552006-02-15 17:27:45 +00001089PyAPI_FUNC(Py_ssize_t) PyUnicode_Tailmatch(
Guido van Rossumd8225182000-03-10 22:33:05 +00001090 PyObject *str, /* String */
1091 PyObject *substr, /* Prefix or Suffix string */
Martin v. Löwis18e16552006-02-15 17:27:45 +00001092 Py_ssize_t start, /* Start index */
1093 Py_ssize_t end, /* Stop index */
Guido van Rossumd8225182000-03-10 22:33:05 +00001094 int direction /* Tail end: -1 prefix, +1 suffix */
1095 );
1096
1097/* Return the first position of substr in str[start:end] using the
Marc-André Lemburg4da6fd62002-05-29 11:33:13 +00001098 given search direction or -1 if not found. -2 is returned in case
1099 an error occurred and an exception is set. */
Guido van Rossumd8225182000-03-10 22:33:05 +00001100
Martin v. Löwis18e16552006-02-15 17:27:45 +00001101PyAPI_FUNC(Py_ssize_t) PyUnicode_Find(
Guido van Rossumd8225182000-03-10 22:33:05 +00001102 PyObject *str, /* String */
1103 PyObject *substr, /* Substring to find */
Martin v. Löwis18e16552006-02-15 17:27:45 +00001104 Py_ssize_t start, /* Start index */
1105 Py_ssize_t end, /* Stop index */
Guido van Rossumd8225182000-03-10 22:33:05 +00001106 int direction /* Find direction: +1 forward, -1 backward */
1107 );
1108
Barry Warsaw51ac5802000-03-20 16:36:48 +00001109/* Count the number of occurrences of substr in str[start:end]. */
Guido van Rossumd8225182000-03-10 22:33:05 +00001110
Martin v. Löwis18e16552006-02-15 17:27:45 +00001111PyAPI_FUNC(Py_ssize_t) PyUnicode_Count(
Guido van Rossumd8225182000-03-10 22:33:05 +00001112 PyObject *str, /* String */
1113 PyObject *substr, /* Substring to count */
Martin v. Löwis18e16552006-02-15 17:27:45 +00001114 Py_ssize_t start, /* Start index */
1115 Py_ssize_t end /* Stop index */
Guido van Rossumd8225182000-03-10 22:33:05 +00001116 );
1117
Barry Warsaw51ac5802000-03-20 16:36:48 +00001118/* Replace at most maxcount occurrences of substr in str with replstr
Guido van Rossumd8225182000-03-10 22:33:05 +00001119 and return the resulting Unicode object. */
1120
Mark Hammond91a681d2002-08-12 07:21:58 +00001121PyAPI_FUNC(PyObject *) PyUnicode_Replace(
Guido van Rossumd8225182000-03-10 22:33:05 +00001122 PyObject *str, /* String */
1123 PyObject *substr, /* Substring to find */
1124 PyObject *replstr, /* Substring to replace */
Martin v. Löwis18e16552006-02-15 17:27:45 +00001125 Py_ssize_t maxcount /* Max. number of replacements to apply;
Guido van Rossumd8225182000-03-10 22:33:05 +00001126 -1 = all */
1127 );
1128
1129/* Compare two strings and return -1, 0, 1 for less than, equal,
1130 greater than resp. */
1131
Mark Hammond91a681d2002-08-12 07:21:58 +00001132PyAPI_FUNC(int) PyUnicode_Compare(
Guido van Rossumd8225182000-03-10 22:33:05 +00001133 PyObject *left, /* Left string */
1134 PyObject *right /* Right string */
1135 );
1136
Thomas Wouters7e474022000-07-16 12:04:32 +00001137/* Apply a argument tuple or dictionary to a format string and return
Guido van Rossumd8225182000-03-10 22:33:05 +00001138 the resulting Unicode string. */
1139
Mark Hammond91a681d2002-08-12 07:21:58 +00001140PyAPI_FUNC(PyObject *) PyUnicode_Format(
Guido van Rossumd8225182000-03-10 22:33:05 +00001141 PyObject *format, /* Format string */
1142 PyObject *args /* Argument tuple or dictionary */
1143 );
1144
Guido van Rossumd0d366b2000-03-13 23:22:24 +00001145/* Checks whether element is contained in container and return 1/0
1146 accordingly.
1147
1148 element has to coerce to an one element Unicode string. -1 is
1149 returned in case of an error. */
1150
Mark Hammond91a681d2002-08-12 07:21:58 +00001151PyAPI_FUNC(int) PyUnicode_Contains(
Guido van Rossumd0d366b2000-03-13 23:22:24 +00001152 PyObject *container, /* Container string */
1153 PyObject *element /* Element string */
1154 );
1155
Walter Dörwaldde02bcb2002-04-22 17:42:37 +00001156/* Externally visible for str.strip(unicode) */
Mark Hammond91a681d2002-08-12 07:21:58 +00001157PyAPI_FUNC(PyObject *) _PyUnicode_XStrip(
Walter Dörwaldde02bcb2002-04-22 17:42:37 +00001158 PyUnicodeObject *self,
1159 int striptype,
1160 PyObject *sepobj
1161 );
1162
Guido van Rossumd8225182000-03-10 22:33:05 +00001163/* === Characters Type APIs =============================================== */
1164
1165/* These should not be used directly. Use the Py_UNICODE_IS* and
1166 Py_UNICODE_TO* macros instead.
1167
1168 These APIs are implemented in Objects/unicodectype.c.
1169
1170*/
1171
Mark Hammond91a681d2002-08-12 07:21:58 +00001172PyAPI_FUNC(int) _PyUnicode_IsLowercase(
Fredrik Lundh72b06852001-06-27 22:08:26 +00001173 Py_UNICODE ch /* Unicode character */
Guido van Rossumd8225182000-03-10 22:33:05 +00001174 );
1175
Mark Hammond91a681d2002-08-12 07:21:58 +00001176PyAPI_FUNC(int) _PyUnicode_IsUppercase(
Fredrik Lundh72b06852001-06-27 22:08:26 +00001177 Py_UNICODE ch /* Unicode character */
Guido van Rossumd8225182000-03-10 22:33:05 +00001178 );
1179
Mark Hammond91a681d2002-08-12 07:21:58 +00001180PyAPI_FUNC(int) _PyUnicode_IsTitlecase(
Fredrik Lundh72b06852001-06-27 22:08:26 +00001181 Py_UNICODE ch /* Unicode character */
Guido van Rossumd8225182000-03-10 22:33:05 +00001182 );
1183
Mark Hammond91a681d2002-08-12 07:21:58 +00001184PyAPI_FUNC(int) _PyUnicode_IsWhitespace(
Tim Peters2576c972005-10-29 02:33:18 +00001185 const Py_UNICODE ch /* Unicode character */
Guido van Rossumd8225182000-03-10 22:33:05 +00001186 );
1187
Mark Hammond91a681d2002-08-12 07:21:58 +00001188PyAPI_FUNC(int) _PyUnicode_IsLinebreak(
Tim Peters2576c972005-10-29 02:33:18 +00001189 const Py_UNICODE ch /* Unicode character */
Guido van Rossumd8225182000-03-10 22:33:05 +00001190 );
1191
Mark Hammond91a681d2002-08-12 07:21:58 +00001192PyAPI_FUNC(Py_UNICODE) _PyUnicode_ToLowercase(
Fredrik Lundh72b06852001-06-27 22:08:26 +00001193 Py_UNICODE ch /* Unicode character */
Guido van Rossumd8225182000-03-10 22:33:05 +00001194 );
1195
Mark Hammond91a681d2002-08-12 07:21:58 +00001196PyAPI_FUNC(Py_UNICODE) _PyUnicode_ToUppercase(
Fredrik Lundh72b06852001-06-27 22:08:26 +00001197 Py_UNICODE ch /* Unicode character */
Guido van Rossumd8225182000-03-10 22:33:05 +00001198 );
1199
Mark Hammond91a681d2002-08-12 07:21:58 +00001200PyAPI_FUNC(Py_UNICODE) _PyUnicode_ToTitlecase(
Fredrik Lundh72b06852001-06-27 22:08:26 +00001201 Py_UNICODE ch /* Unicode character */
Guido van Rossumd8225182000-03-10 22:33:05 +00001202 );
1203
Mark Hammond91a681d2002-08-12 07:21:58 +00001204PyAPI_FUNC(int) _PyUnicode_ToDecimalDigit(
Fredrik Lundh72b06852001-06-27 22:08:26 +00001205 Py_UNICODE ch /* Unicode character */
Guido van Rossumd8225182000-03-10 22:33:05 +00001206 );
1207
Mark Hammond91a681d2002-08-12 07:21:58 +00001208PyAPI_FUNC(int) _PyUnicode_ToDigit(
Fredrik Lundh72b06852001-06-27 22:08:26 +00001209 Py_UNICODE ch /* Unicode character */
Guido van Rossumd8225182000-03-10 22:33:05 +00001210 );
1211
Mark Hammond91a681d2002-08-12 07:21:58 +00001212PyAPI_FUNC(double) _PyUnicode_ToNumeric(
Fredrik Lundh72b06852001-06-27 22:08:26 +00001213 Py_UNICODE ch /* Unicode character */
Guido van Rossumd8225182000-03-10 22:33:05 +00001214 );
1215
Mark Hammond91a681d2002-08-12 07:21:58 +00001216PyAPI_FUNC(int) _PyUnicode_IsDecimalDigit(
Fredrik Lundh72b06852001-06-27 22:08:26 +00001217 Py_UNICODE ch /* Unicode character */
Guido van Rossumd8225182000-03-10 22:33:05 +00001218 );
1219
Mark Hammond91a681d2002-08-12 07:21:58 +00001220PyAPI_FUNC(int) _PyUnicode_IsDigit(
Fredrik Lundh72b06852001-06-27 22:08:26 +00001221 Py_UNICODE ch /* Unicode character */
Guido van Rossumd8225182000-03-10 22:33:05 +00001222 );
1223
Mark Hammond91a681d2002-08-12 07:21:58 +00001224PyAPI_FUNC(int) _PyUnicode_IsNumeric(
Fredrik Lundh72b06852001-06-27 22:08:26 +00001225 Py_UNICODE ch /* Unicode character */
Guido van Rossumd8225182000-03-10 22:33:05 +00001226 );
1227
Mark Hammond91a681d2002-08-12 07:21:58 +00001228PyAPI_FUNC(int) _PyUnicode_IsAlpha(
Fredrik Lundh72b06852001-06-27 22:08:26 +00001229 Py_UNICODE ch /* Unicode character */
Marc-André Lemburgf03e7412000-07-05 09:45:59 +00001230 );
1231
Guido van Rossumd8225182000-03-10 22:33:05 +00001232#ifdef __cplusplus
1233}
1234#endif
Martin v. Löwis339d0f72001-08-17 18:39:25 +00001235#endif /* Py_USING_UNICODE */
Guido van Rossumd8225182000-03-10 22:33:05 +00001236#endif /* !Py_UNICODEOBJECT_H */