blob: 664578223c9853fd582d565e3b05f061c2732c43 [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
Fredrik Lundh06a69dd2006-05-26 08:54:28 +0000187# define PyUnicode_Partition PyUnicodeUCS2_Partition
Marc-André Lemburgb5ac6f62001-07-31 14:30:16 +0000188# define PyUnicode_Replace PyUnicodeUCS2_Replace
189# define PyUnicode_Resize PyUnicodeUCS2_Resize
190# define PyUnicode_SetDefaultEncoding PyUnicodeUCS2_SetDefaultEncoding
191# define PyUnicode_Split PyUnicodeUCS2_Split
Hye-Shik Chang3ae811b2003-12-15 18:49:53 +0000192# define PyUnicode_RSplit PyUnicodeUCS2_RSplit
Marc-André Lemburgb5ac6f62001-07-31 14:30:16 +0000193# define PyUnicode_Splitlines PyUnicodeUCS2_Splitlines
194# define PyUnicode_Tailmatch PyUnicodeUCS2_Tailmatch
195# define PyUnicode_Translate PyUnicodeUCS2_Translate
196# define PyUnicode_TranslateCharmap PyUnicodeUCS2_TranslateCharmap
197# define _PyUnicode_AsDefaultEncodedString _PyUnicodeUCS2_AsDefaultEncodedString
198# define _PyUnicode_Fini _PyUnicodeUCS2_Fini
199# define _PyUnicode_Init _PyUnicodeUCS2_Init
200# define _PyUnicode_IsAlpha _PyUnicodeUCS2_IsAlpha
201# define _PyUnicode_IsDecimalDigit _PyUnicodeUCS2_IsDecimalDigit
202# define _PyUnicode_IsDigit _PyUnicodeUCS2_IsDigit
203# define _PyUnicode_IsLinebreak _PyUnicodeUCS2_IsLinebreak
204# define _PyUnicode_IsLowercase _PyUnicodeUCS2_IsLowercase
205# define _PyUnicode_IsNumeric _PyUnicodeUCS2_IsNumeric
206# define _PyUnicode_IsTitlecase _PyUnicodeUCS2_IsTitlecase
207# define _PyUnicode_IsUppercase _PyUnicodeUCS2_IsUppercase
208# define _PyUnicode_IsWhitespace _PyUnicodeUCS2_IsWhitespace
209# define _PyUnicode_ToDecimalDigit _PyUnicodeUCS2_ToDecimalDigit
210# define _PyUnicode_ToDigit _PyUnicodeUCS2_ToDigit
211# define _PyUnicode_ToLowercase _PyUnicodeUCS2_ToLowercase
212# define _PyUnicode_ToNumeric _PyUnicodeUCS2_ToNumeric
213# define _PyUnicode_ToTitlecase _PyUnicodeUCS2_ToTitlecase
214# define _PyUnicode_ToUppercase _PyUnicodeUCS2_ToUppercase
215
216#else
217
218# define PyUnicode_AsASCIIString PyUnicodeUCS4_AsASCIIString
219# define PyUnicode_AsCharmapString PyUnicodeUCS4_AsCharmapString
Marc-André Lemburgd2d45982004-07-08 17:57:32 +0000220# define PyUnicode_AsEncodedObject PyUnicodeUCS4_AsEncodedObject
Marc-André Lemburgb5ac6f62001-07-31 14:30:16 +0000221# define PyUnicode_AsEncodedString PyUnicodeUCS4_AsEncodedString
222# define PyUnicode_AsLatin1String PyUnicodeUCS4_AsLatin1String
223# define PyUnicode_AsRawUnicodeEscapeString PyUnicodeUCS4_AsRawUnicodeEscapeString
224# define PyUnicode_AsUTF16String PyUnicodeUCS4_AsUTF16String
225# define PyUnicode_AsUTF8String PyUnicodeUCS4_AsUTF8String
226# define PyUnicode_AsUnicode PyUnicodeUCS4_AsUnicode
227# define PyUnicode_AsUnicodeEscapeString PyUnicodeUCS4_AsUnicodeEscapeString
228# define PyUnicode_AsWideChar PyUnicodeUCS4_AsWideChar
229# define PyUnicode_Compare PyUnicodeUCS4_Compare
230# define PyUnicode_Concat PyUnicodeUCS4_Concat
231# define PyUnicode_Contains PyUnicodeUCS4_Contains
232# define PyUnicode_Count PyUnicodeUCS4_Count
233# define PyUnicode_Decode PyUnicodeUCS4_Decode
234# define PyUnicode_DecodeASCII PyUnicodeUCS4_DecodeASCII
235# define PyUnicode_DecodeCharmap PyUnicodeUCS4_DecodeCharmap
236# define PyUnicode_DecodeLatin1 PyUnicodeUCS4_DecodeLatin1
237# define PyUnicode_DecodeRawUnicodeEscape PyUnicodeUCS4_DecodeRawUnicodeEscape
238# define PyUnicode_DecodeUTF16 PyUnicodeUCS4_DecodeUTF16
Walter Dörwald69652032004-09-07 20:24:22 +0000239# define PyUnicode_DecodeUTF16Stateful PyUnicodeUCS4_DecodeUTF16Stateful
Marc-André Lemburgb5ac6f62001-07-31 14:30:16 +0000240# define PyUnicode_DecodeUTF8 PyUnicodeUCS4_DecodeUTF8
Walter Dörwald69652032004-09-07 20:24:22 +0000241# define PyUnicode_DecodeUTF8Stateful PyUnicodeUCS4_DecodeUTF8Stateful
Marc-André Lemburgb5ac6f62001-07-31 14:30:16 +0000242# define PyUnicode_DecodeUnicodeEscape PyUnicodeUCS4_DecodeUnicodeEscape
243# define PyUnicode_Encode PyUnicodeUCS4_Encode
244# define PyUnicode_EncodeASCII PyUnicodeUCS4_EncodeASCII
245# define PyUnicode_EncodeCharmap PyUnicodeUCS4_EncodeCharmap
246# define PyUnicode_EncodeDecimal PyUnicodeUCS4_EncodeDecimal
247# define PyUnicode_EncodeLatin1 PyUnicodeUCS4_EncodeLatin1
248# define PyUnicode_EncodeRawUnicodeEscape PyUnicodeUCS4_EncodeRawUnicodeEscape
249# define PyUnicode_EncodeUTF16 PyUnicodeUCS4_EncodeUTF16
250# define PyUnicode_EncodeUTF8 PyUnicodeUCS4_EncodeUTF8
251# define PyUnicode_EncodeUnicodeEscape PyUnicodeUCS4_EncodeUnicodeEscape
252# define PyUnicode_Find PyUnicodeUCS4_Find
253# define PyUnicode_Format PyUnicodeUCS4_Format
254# define PyUnicode_FromEncodedObject PyUnicodeUCS4_FromEncodedObject
255# define PyUnicode_FromObject PyUnicodeUCS4_FromObject
Marc-André Lemburg9c329de2002-08-12 08:19:10 +0000256# define PyUnicode_FromOrdinal PyUnicodeUCS4_FromOrdinal
Marc-André Lemburgb5ac6f62001-07-31 14:30:16 +0000257# define PyUnicode_FromUnicode PyUnicodeUCS4_FromUnicode
258# define PyUnicode_FromWideChar PyUnicodeUCS4_FromWideChar
259# define PyUnicode_GetDefaultEncoding PyUnicodeUCS4_GetDefaultEncoding
260# define PyUnicode_GetMax PyUnicodeUCS4_GetMax
261# define PyUnicode_GetSize PyUnicodeUCS4_GetSize
262# define PyUnicode_Join PyUnicodeUCS4_Join
Fredrik Lundh06a69dd2006-05-26 08:54:28 +0000263# define PyUnicode_Partition PyUnicodeUCS4_Partition
Marc-André Lemburgb5ac6f62001-07-31 14:30:16 +0000264# define PyUnicode_Replace PyUnicodeUCS4_Replace
265# define PyUnicode_Resize PyUnicodeUCS4_Resize
266# define PyUnicode_SetDefaultEncoding PyUnicodeUCS4_SetDefaultEncoding
267# define PyUnicode_Split PyUnicodeUCS4_Split
268# define PyUnicode_Splitlines PyUnicodeUCS4_Splitlines
269# define PyUnicode_Tailmatch PyUnicodeUCS4_Tailmatch
270# define PyUnicode_Translate PyUnicodeUCS4_Translate
271# define PyUnicode_TranslateCharmap PyUnicodeUCS4_TranslateCharmap
272# define _PyUnicode_AsDefaultEncodedString _PyUnicodeUCS4_AsDefaultEncodedString
273# define _PyUnicode_Fini _PyUnicodeUCS4_Fini
274# define _PyUnicode_Init _PyUnicodeUCS4_Init
275# define _PyUnicode_IsAlpha _PyUnicodeUCS4_IsAlpha
276# define _PyUnicode_IsDecimalDigit _PyUnicodeUCS4_IsDecimalDigit
277# define _PyUnicode_IsDigit _PyUnicodeUCS4_IsDigit
278# define _PyUnicode_IsLinebreak _PyUnicodeUCS4_IsLinebreak
279# define _PyUnicode_IsLowercase _PyUnicodeUCS4_IsLowercase
280# define _PyUnicode_IsNumeric _PyUnicodeUCS4_IsNumeric
281# define _PyUnicode_IsTitlecase _PyUnicodeUCS4_IsTitlecase
282# define _PyUnicode_IsUppercase _PyUnicodeUCS4_IsUppercase
283# define _PyUnicode_IsWhitespace _PyUnicodeUCS4_IsWhitespace
284# define _PyUnicode_ToDecimalDigit _PyUnicodeUCS4_ToDecimalDigit
285# define _PyUnicode_ToDigit _PyUnicodeUCS4_ToDigit
286# define _PyUnicode_ToLowercase _PyUnicodeUCS4_ToLowercase
287# define _PyUnicode_ToNumeric _PyUnicodeUCS4_ToNumeric
288# define _PyUnicode_ToTitlecase _PyUnicodeUCS4_ToTitlecase
289# define _PyUnicode_ToUppercase _PyUnicodeUCS4_ToUppercase
290
291
292#endif
293
Guido van Rossumd8225182000-03-10 22:33:05 +0000294/* --- Internal Unicode Operations ---------------------------------------- */
295
296/* If you want Python to use the compiler's wctype.h functions instead
Barry Warsaw51ac5802000-03-20 16:36:48 +0000297 of the ones supplied with Python, define WANT_WCTYPE_FUNCTIONS or
Raymond Hettinger57341c32004-10-31 05:46:59 +0000298 configure Python using --with-wctype-functions. This reduces the
Barry Warsaw51ac5802000-03-20 16:36:48 +0000299 interpreter's code size. */
Guido van Rossumd8225182000-03-10 22:33:05 +0000300
301#if defined(HAVE_USABLE_WCHAR_T) && defined(WANT_WCTYPE_FUNCTIONS)
302
Marc-André Lemburg5e6007c2001-09-19 11:21:03 +0000303#include <wctype.h>
Guido van Rossumd8225182000-03-10 22:33:05 +0000304
305#define Py_UNICODE_ISSPACE(ch) iswspace(ch)
306
307#define Py_UNICODE_ISLOWER(ch) iswlower(ch)
308#define Py_UNICODE_ISUPPER(ch) iswupper(ch)
309#define Py_UNICODE_ISTITLE(ch) _PyUnicode_IsTitlecase(ch)
310#define Py_UNICODE_ISLINEBREAK(ch) _PyUnicode_IsLinebreak(ch)
311
312#define Py_UNICODE_TOLOWER(ch) towlower(ch)
313#define Py_UNICODE_TOUPPER(ch) towupper(ch)
314#define Py_UNICODE_TOTITLE(ch) _PyUnicode_ToTitlecase(ch)
315
316#define Py_UNICODE_ISDECIMAL(ch) _PyUnicode_IsDecimalDigit(ch)
317#define Py_UNICODE_ISDIGIT(ch) _PyUnicode_IsDigit(ch)
318#define Py_UNICODE_ISNUMERIC(ch) _PyUnicode_IsNumeric(ch)
319
320#define Py_UNICODE_TODECIMAL(ch) _PyUnicode_ToDecimalDigit(ch)
321#define Py_UNICODE_TODIGIT(ch) _PyUnicode_ToDigit(ch)
322#define Py_UNICODE_TONUMERIC(ch) _PyUnicode_ToNumeric(ch)
323
Marc-André Lemburgf03e7412000-07-05 09:45:59 +0000324#define Py_UNICODE_ISALPHA(ch) iswalpha(ch)
325
Guido van Rossumd8225182000-03-10 22:33:05 +0000326#else
327
328#define Py_UNICODE_ISSPACE(ch) _PyUnicode_IsWhitespace(ch)
329
330#define Py_UNICODE_ISLOWER(ch) _PyUnicode_IsLowercase(ch)
331#define Py_UNICODE_ISUPPER(ch) _PyUnicode_IsUppercase(ch)
332#define Py_UNICODE_ISTITLE(ch) _PyUnicode_IsTitlecase(ch)
333#define Py_UNICODE_ISLINEBREAK(ch) _PyUnicode_IsLinebreak(ch)
334
335#define Py_UNICODE_TOLOWER(ch) _PyUnicode_ToLowercase(ch)
336#define Py_UNICODE_TOUPPER(ch) _PyUnicode_ToUppercase(ch)
337#define Py_UNICODE_TOTITLE(ch) _PyUnicode_ToTitlecase(ch)
338
339#define Py_UNICODE_ISDECIMAL(ch) _PyUnicode_IsDecimalDigit(ch)
340#define Py_UNICODE_ISDIGIT(ch) _PyUnicode_IsDigit(ch)
341#define Py_UNICODE_ISNUMERIC(ch) _PyUnicode_IsNumeric(ch)
342
343#define Py_UNICODE_TODECIMAL(ch) _PyUnicode_ToDecimalDigit(ch)
344#define Py_UNICODE_TODIGIT(ch) _PyUnicode_ToDigit(ch)
345#define Py_UNICODE_TONUMERIC(ch) _PyUnicode_ToNumeric(ch)
346
Marc-André Lemburgf03e7412000-07-05 09:45:59 +0000347#define Py_UNICODE_ISALPHA(ch) _PyUnicode_IsAlpha(ch)
Guido van Rossumd8225182000-03-10 22:33:05 +0000348
Marc-André Lemburgf03e7412000-07-05 09:45:59 +0000349#endif
Marc-André Lemburga9c103b2000-07-03 10:52:13 +0000350
351#define Py_UNICODE_ISALNUM(ch) \
352 (Py_UNICODE_ISALPHA(ch) || \
353 Py_UNICODE_ISDECIMAL(ch) || \
354 Py_UNICODE_ISDIGIT(ch) || \
355 Py_UNICODE_ISNUMERIC(ch))
356
Fredrik Lundh8a8e05a2006-05-22 17:12:58 +0000357/* memcpy has a considerable setup overhead on many platforms; use a
358 loop for short strings (the "16" below is pretty arbitary) */
Fredrik Lundhf1d60a52006-05-22 16:29:30 +0000359#define Py_UNICODE_COPY(target, source, length) do\
Fredrik Lundh8a8e05a2006-05-22 17:12:58 +0000360 {Py_ssize_t i_; Py_UNICODE *t_ = (target); const Py_UNICODE *s_ = (source);\
361 if (length > 16)\
362 memcpy(t_, s_, (length)*sizeof(Py_UNICODE));\
363 else\
364 for (i_ = 0; i_ < (length); i_++) t_[i_] = s_[i_];\
Fredrik Lundhf1d60a52006-05-22 16:29:30 +0000365 } while (0)
Guido van Rossumd8225182000-03-10 22:33:05 +0000366
367#define Py_UNICODE_FILL(target, value, length) do\
Fredrik Lundh8a8e05a2006-05-22 17:12:58 +0000368 {Py_ssize_t i_; Py_UNICODE *t_ = (target); Py_UNICODE v_ = (value);\
369 for (i_ = 0; i_ < (length); i_++) t_[i_] = v_;\
Fredrik Lundhf1d60a52006-05-22 16:29:30 +0000370 } while (0)
Guido van Rossumd8225182000-03-10 22:33:05 +0000371
Fredrik Lundh3d885e02006-05-23 10:10:57 +0000372/* check if substring matches at given offset. the offset must be
373 valid, and the substring must not be empty */
374#define Py_UNICODE_MATCH(string, offset, substring) \
375 ((*((string)->str + (offset)) == *((substring)->str)) && \
376 ((*((string)->str + (offset) + (substring)->length-1) == *((substring)->str + (substring)->length-1))) && \
377 !memcmp((string)->str + (offset), (substring)->str, (substring)->length*sizeof(Py_UNICODE)))
Guido van Rossumd8225182000-03-10 22:33:05 +0000378
Barry Warsaw51ac5802000-03-20 16:36:48 +0000379#ifdef __cplusplus
380extern "C" {
381#endif
382
Guido van Rossumd8225182000-03-10 22:33:05 +0000383/* --- Unicode Type ------------------------------------------------------- */
384
385typedef struct {
386 PyObject_HEAD
Martin v. Löwis18e16552006-02-15 17:27:45 +0000387 Py_ssize_t length; /* Length of raw Unicode data in buffer */
Guido van Rossumd8225182000-03-10 22:33:05 +0000388 Py_UNICODE *str; /* Raw Unicode buffer */
389 long hash; /* Hash value; -1 if not set */
Marc-André Lemburgbff879c2000-08-03 18:46:08 +0000390 PyObject *defenc; /* (Default) Encoded version as Python
391 string, or NULL; this is used for
392 implementing the buffer protocol */
Guido van Rossumd8225182000-03-10 22:33:05 +0000393} PyUnicodeObject;
394
Mark Hammond91a681d2002-08-12 07:21:58 +0000395PyAPI_DATA(PyTypeObject) PyUnicode_Type;
Guido van Rossumd8225182000-03-10 22:33:05 +0000396
Guido van Rossum5eef77a2001-08-30 03:08:07 +0000397#define PyUnicode_Check(op) PyObject_TypeCheck(op, &PyUnicode_Type)
Tim Peters78e0fc72001-09-11 03:07:38 +0000398#define PyUnicode_CheckExact(op) ((op)->ob_type == &PyUnicode_Type)
Guido van Rossumd8225182000-03-10 22:33:05 +0000399
400/* Fast access macros */
401#define PyUnicode_GET_SIZE(op) \
402 (((PyUnicodeObject *)(op))->length)
403#define PyUnicode_GET_DATA_SIZE(op) \
404 (((PyUnicodeObject *)(op))->length * sizeof(Py_UNICODE))
405#define PyUnicode_AS_UNICODE(op) \
406 (((PyUnicodeObject *)(op))->str)
407#define PyUnicode_AS_DATA(op) \
408 ((const char *)((PyUnicodeObject *)(op))->str)
409
410/* --- Constants ---------------------------------------------------------- */
411
412/* This Unicode character will be used as replacement character during
413 decoding if the errors argument is set to "replace". Note: the
414 Unicode character U+FFFD is the official REPLACEMENT CHARACTER in
415 Unicode 3.0. */
416
417#define Py_UNICODE_REPLACEMENT_CHARACTER ((Py_UNICODE) 0xFFFD)
418
419/* === Public API ========================================================= */
420
421/* --- Plain Py_UNICODE --------------------------------------------------- */
422
423/* Create a Unicode Object from the Py_UNICODE buffer u of the given
Marc-André Lemburg8155e0e2001-04-23 14:44:21 +0000424 size.
425
426 u may be NULL which causes the contents to be undefined. It is the
427 user's responsibility to fill in the needed data afterwards. Note
428 that modifying the Unicode object contents after construction is
429 only allowed if u was set to NULL.
Guido van Rossumd8225182000-03-10 22:33:05 +0000430
431 The buffer is copied into the new object. */
432
Mark Hammond91a681d2002-08-12 07:21:58 +0000433PyAPI_FUNC(PyObject*) PyUnicode_FromUnicode(
Guido van Rossumd8225182000-03-10 22:33:05 +0000434 const Py_UNICODE *u, /* Unicode buffer */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000435 Py_ssize_t size /* size of buffer */
Guido van Rossumd8225182000-03-10 22:33:05 +0000436 );
437
438/* Return a read-only pointer to the Unicode object's internal
439 Py_UNICODE buffer. */
440
Mark Hammond91a681d2002-08-12 07:21:58 +0000441PyAPI_FUNC(Py_UNICODE *) PyUnicode_AsUnicode(
Guido van Rossumd8225182000-03-10 22:33:05 +0000442 PyObject *unicode /* Unicode object */
443 );
444
445/* Get the length of the Unicode object. */
446
Martin v. Löwis18e16552006-02-15 17:27:45 +0000447PyAPI_FUNC(Py_ssize_t) PyUnicode_GetSize(
Guido van Rossumd8225182000-03-10 22:33:05 +0000448 PyObject *unicode /* Unicode object */
449 );
450
Martin v. Löwisce9b5a52001-06-27 06:28:56 +0000451/* Get the maximum ordinal for a Unicode character. */
Mark Hammond91a681d2002-08-12 07:21:58 +0000452PyAPI_FUNC(Py_UNICODE) PyUnicode_GetMax(void);
Martin v. Löwisce9b5a52001-06-27 06:28:56 +0000453
Guido van Rossum52c23592000-04-10 13:41:41 +0000454/* Resize an already allocated Unicode object to the new size length.
455
456 *unicode is modified to point to the new (resized) object and 0
457 returned on success.
458
459 This API may only be called by the function which also called the
460 Unicode constructor. The refcount on the object must be 1. Otherwise,
461 an error is returned.
462
463 Error handling is implemented as follows: an exception is set, -1
464 is returned and *unicode left untouched.
465
466*/
467
Mark Hammond91a681d2002-08-12 07:21:58 +0000468PyAPI_FUNC(int) PyUnicode_Resize(
Guido van Rossum52c23592000-04-10 13:41:41 +0000469 PyObject **unicode, /* Pointer to the Unicode object */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000470 Py_ssize_t length /* New length */
Guido van Rossum52c23592000-04-10 13:41:41 +0000471 );
472
Guido van Rossumd8225182000-03-10 22:33:05 +0000473/* Coerce obj to an Unicode object and return a reference with
474 *incremented* refcount.
475
476 Coercion is done in the following way:
477
Guido van Rossumb8c65bc2001-10-19 02:01:31 +0000478 1. String and other char buffer compatible objects are decoded
Fred Drakecb093fe2000-05-09 19:51:53 +0000479 under the assumptions that they contain data using the current
480 default encoding. Decoding is done in "strict" mode.
Guido van Rossumd8225182000-03-10 22:33:05 +0000481
Guido van Rossumb8c65bc2001-10-19 02:01:31 +0000482 2. All other objects (including Unicode objects) raise an
483 exception.
Guido van Rossumd8225182000-03-10 22:33:05 +0000484
485 The API returns NULL in case of an error. The caller is responsible
486 for decref'ing the returned objects.
487
488*/
489
Mark Hammond91a681d2002-08-12 07:21:58 +0000490PyAPI_FUNC(PyObject*) PyUnicode_FromEncodedObject(
Marc-André Lemburg5a5c81a2000-07-07 13:46:42 +0000491 register PyObject *obj, /* Object */
492 const char *encoding, /* encoding */
493 const char *errors /* error handling */
494 );
495
Guido van Rossumb8c65bc2001-10-19 02:01:31 +0000496/* Coerce obj to an Unicode object and return a reference with
Marc-André Lemburg5a5c81a2000-07-07 13:46:42 +0000497 *incremented* refcount.
Guido van Rossumb8c65bc2001-10-19 02:01:31 +0000498
499 Unicode objects are passed back as-is (subclasses are converted to
500 true Unicode objects), all other objects are delegated to
501 PyUnicode_FromEncodedObject(obj, NULL, "strict") which results in
502 using the default encoding as basis for decoding the object.
Marc-André Lemburg5a5c81a2000-07-07 13:46:42 +0000503
504 The API returns NULL in case of an error. The caller is responsible
505 for decref'ing the returned objects.
506
507*/
508
Mark Hammond91a681d2002-08-12 07:21:58 +0000509PyAPI_FUNC(PyObject*) PyUnicode_FromObject(
Guido van Rossumd8225182000-03-10 22:33:05 +0000510 register PyObject *obj /* Object */
511 );
512
513/* --- wchar_t support for platforms which support it --------------------- */
514
515#ifdef HAVE_WCHAR_H
516
517/* Create a Unicode Object from the whcar_t buffer w of the given
518 size.
519
520 The buffer is copied into the new object. */
521
Mark Hammond91a681d2002-08-12 07:21:58 +0000522PyAPI_FUNC(PyObject*) PyUnicode_FromWideChar(
Guido van Rossumd8225182000-03-10 22:33:05 +0000523 register const wchar_t *w, /* wchar_t buffer */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000524 Py_ssize_t size /* size of buffer */
Guido van Rossumd8225182000-03-10 22:33:05 +0000525 );
526
Marc-André Lemburga9cadcd2004-11-22 13:02:31 +0000527/* Copies the Unicode Object contents into the wchar_t buffer w. At
Guido van Rossumd8225182000-03-10 22:33:05 +0000528 most size wchar_t characters are copied.
529
Marc-André Lemburga9cadcd2004-11-22 13:02:31 +0000530 Note that the resulting wchar_t string may or may not be
531 0-terminated. It is the responsibility of the caller to make sure
532 that the wchar_t string is 0-terminated in case this is required by
533 the application.
534
535 Returns the number of wchar_t characters copied (excluding a
536 possibly trailing 0-termination character) or -1 in case of an
Guido van Rossumd8225182000-03-10 22:33:05 +0000537 error. */
538
Martin v. Löwis18e16552006-02-15 17:27:45 +0000539PyAPI_FUNC(Py_ssize_t) PyUnicode_AsWideChar(
Guido van Rossumd8225182000-03-10 22:33:05 +0000540 PyUnicodeObject *unicode, /* Unicode object */
541 register wchar_t *w, /* wchar_t buffer */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000542 Py_ssize_t size /* size of buffer */
Guido van Rossumd8225182000-03-10 22:33:05 +0000543 );
544
545#endif
546
Marc-André Lemburgcc8764c2002-08-11 12:23:04 +0000547/* --- Unicode ordinals --------------------------------------------------- */
548
549/* Create a Unicode Object from the given Unicode code point ordinal.
550
551 The ordinal must be in range(0x10000) on narrow Python builds
552 (UCS2), and range(0x110000) on wide builds (UCS4). A ValueError is
553 raised in case it is not.
554
555*/
556
Marc-André Lemburg9c329de2002-08-12 08:19:10 +0000557PyAPI_FUNC(PyObject*) PyUnicode_FromOrdinal(int ordinal);
Marc-André Lemburgcc8764c2002-08-11 12:23:04 +0000558
Guido van Rossumd8225182000-03-10 22:33:05 +0000559/* === Builtin Codecs =====================================================
560
561 Many of these APIs take two arguments encoding and errors. These
562 parameters encoding and errors have the same semantics as the ones
563 of the builtin unicode() API.
564
Fred Drakecb093fe2000-05-09 19:51:53 +0000565 Setting encoding to NULL causes the default encoding to be used.
Guido van Rossumd8225182000-03-10 22:33:05 +0000566
567 Error handling is set by errors which may also be set to NULL
568 meaning to use the default handling defined for the codec. Default
569 error handling for all builtin codecs is "strict" (ValueErrors are
570 raised).
571
572 The codecs all use a similar interface. Only deviation from the
573 generic ones are documented.
574
575*/
576
Fred Drakecb093fe2000-05-09 19:51:53 +0000577/* --- Manage the default encoding ---------------------------------------- */
578
Jeremy Hylton3ce45382001-07-30 22:34:24 +0000579/* Return a Python string holding the default encoded value of the
580 Unicode object.
581
582 The resulting string is cached in the Unicode object for subsequent
583 usage by this function. The cached version is needed to implement
584 the character buffer interface and will live (at least) as long as
585 the Unicode object itself.
586
587 The refcount of the string is *not* incremented.
588
589 *** Exported for internal use by the interpreter only !!! ***
590
591*/
592
Mark Hammond91a681d2002-08-12 07:21:58 +0000593PyAPI_FUNC(PyObject *) _PyUnicode_AsDefaultEncodedString(
Jeremy Hylton3ce45382001-07-30 22:34:24 +0000594 PyObject *, const char *);
595
Fred Drakecb093fe2000-05-09 19:51:53 +0000596/* Returns the currently active default encoding.
597
598 The default encoding is currently implemented as run-time settable
599 process global. This may change in future versions of the
600 interpreter to become a parameter which is managed on a per-thread
601 basis.
602
603 */
604
Mark Hammond91a681d2002-08-12 07:21:58 +0000605PyAPI_FUNC(const char*) PyUnicode_GetDefaultEncoding(void);
Fred Drakecb093fe2000-05-09 19:51:53 +0000606
607/* Sets the currently active default encoding.
608
609 Returns 0 on success, -1 in case of an error.
610
611 */
612
Mark Hammond91a681d2002-08-12 07:21:58 +0000613PyAPI_FUNC(int) PyUnicode_SetDefaultEncoding(
Fred Drakecb093fe2000-05-09 19:51:53 +0000614 const char *encoding /* Encoding name in standard form */
615 );
616
Guido van Rossumd8225182000-03-10 22:33:05 +0000617/* --- Generic Codecs ----------------------------------------------------- */
618
619/* Create a Unicode object by decoding the encoded string s of the
620 given size. */
621
Mark Hammond91a681d2002-08-12 07:21:58 +0000622PyAPI_FUNC(PyObject*) PyUnicode_Decode(
Guido van Rossumd8225182000-03-10 22:33:05 +0000623 const char *s, /* encoded string */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000624 Py_ssize_t size, /* size of buffer */
Guido van Rossumd8225182000-03-10 22:33:05 +0000625 const char *encoding, /* encoding */
626 const char *errors /* error handling */
627 );
628
629/* Encodes a Py_UNICODE buffer of the given size and returns a
630 Python string object. */
631
Mark Hammond91a681d2002-08-12 07:21:58 +0000632PyAPI_FUNC(PyObject*) PyUnicode_Encode(
Guido van Rossumd8225182000-03-10 22:33:05 +0000633 const Py_UNICODE *s, /* Unicode char buffer */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000634 Py_ssize_t size, /* number of Py_UNICODE chars to encode */
Guido van Rossumd8225182000-03-10 22:33:05 +0000635 const char *encoding, /* encoding */
636 const char *errors /* error handling */
637 );
638
Marc-André Lemburgd2d45982004-07-08 17:57:32 +0000639/* Encodes a Unicode object and returns the result as Python
640 object. */
641
642PyAPI_FUNC(PyObject*) PyUnicode_AsEncodedObject(
643 PyObject *unicode, /* Unicode object */
644 const char *encoding, /* encoding */
645 const char *errors /* error handling */
646 );
647
Guido van Rossumd8225182000-03-10 22:33:05 +0000648/* Encodes a Unicode object and returns the result as Python string
649 object. */
650
Mark Hammond91a681d2002-08-12 07:21:58 +0000651PyAPI_FUNC(PyObject*) PyUnicode_AsEncodedString(
Guido van Rossumd8225182000-03-10 22:33:05 +0000652 PyObject *unicode, /* Unicode object */
653 const char *encoding, /* encoding */
654 const char *errors /* error handling */
655 );
656
Marc-André Lemburgc60e6f72001-09-20 10:35:46 +0000657/* --- UTF-7 Codecs ------------------------------------------------------- */
658
Mark Hammond91a681d2002-08-12 07:21:58 +0000659PyAPI_FUNC(PyObject*) PyUnicode_DecodeUTF7(
Marc-André Lemburgc60e6f72001-09-20 10:35:46 +0000660 const char *string, /* UTF-7 encoded string */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000661 Py_ssize_t length, /* size of string */
Marc-André Lemburgc60e6f72001-09-20 10:35:46 +0000662 const char *errors /* error handling */
663 );
664
Mark Hammond91a681d2002-08-12 07:21:58 +0000665PyAPI_FUNC(PyObject*) PyUnicode_EncodeUTF7(
Marc-André Lemburgc60e6f72001-09-20 10:35:46 +0000666 const Py_UNICODE *data, /* Unicode char buffer */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000667 Py_ssize_t length, /* number of Py_UNICODE chars to encode */
Marc-André Lemburgc60e6f72001-09-20 10:35:46 +0000668 int encodeSetO, /* force the encoder to encode characters in
669 Set O, as described in RFC2152 */
670 int encodeWhiteSpace, /* force the encoder to encode space, tab,
671 carriage return and linefeed characters */
672 const char *errors /* error handling */
673 );
674
Guido van Rossumd8225182000-03-10 22:33:05 +0000675/* --- UTF-8 Codecs ------------------------------------------------------- */
676
Mark Hammond91a681d2002-08-12 07:21:58 +0000677PyAPI_FUNC(PyObject*) PyUnicode_DecodeUTF8(
Guido van Rossumd8225182000-03-10 22:33:05 +0000678 const char *string, /* UTF-8 encoded string */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000679 Py_ssize_t length, /* size of string */
Guido van Rossumd8225182000-03-10 22:33:05 +0000680 const char *errors /* error handling */
681 );
682
Walter Dörwald69652032004-09-07 20:24:22 +0000683PyAPI_FUNC(PyObject*) PyUnicode_DecodeUTF8Stateful(
684 const char *string, /* UTF-8 encoded string */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000685 Py_ssize_t length, /* size of string */
Walter Dörwald69652032004-09-07 20:24:22 +0000686 const char *errors, /* error handling */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000687 Py_ssize_t *consumed /* bytes consumed */
Walter Dörwald69652032004-09-07 20:24:22 +0000688 );
689
Mark Hammond91a681d2002-08-12 07:21:58 +0000690PyAPI_FUNC(PyObject*) PyUnicode_AsUTF8String(
Guido van Rossumd8225182000-03-10 22:33:05 +0000691 PyObject *unicode /* Unicode object */
692 );
693
Mark Hammond91a681d2002-08-12 07:21:58 +0000694PyAPI_FUNC(PyObject*) PyUnicode_EncodeUTF8(
Guido van Rossumd8225182000-03-10 22:33:05 +0000695 const Py_UNICODE *data, /* Unicode char buffer */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000696 Py_ssize_t length, /* number of Py_UNICODE chars to encode */
Guido van Rossumd8225182000-03-10 22:33:05 +0000697 const char *errors /* error handling */
698 );
699
700/* --- UTF-16 Codecs ------------------------------------------------------ */
701
Guido van Rossum9e896b32000-04-05 20:11:21 +0000702/* Decodes length bytes from a UTF-16 encoded buffer string and returns
Guido van Rossumd8225182000-03-10 22:33:05 +0000703 the corresponding Unicode object.
704
705 errors (if non-NULL) defines the error handling. It defaults
706 to "strict".
707
708 If byteorder is non-NULL, the decoder starts decoding using the
709 given byte order:
710
711 *byteorder == -1: little endian
712 *byteorder == 0: native order
713 *byteorder == 1: big endian
714
Marc-André Lemburg489b56e2001-05-21 20:30:15 +0000715 In native mode, the first two bytes of the stream are checked for a
716 BOM mark. If found, the BOM mark is analysed, the byte order
717 adjusted and the BOM skipped. In the other modes, no BOM mark
718 interpretation is done. After completion, *byteorder is set to the
719 current byte order at the end of input data.
Guido van Rossumd8225182000-03-10 22:33:05 +0000720
721 If byteorder is NULL, the codec starts in native order mode.
722
723*/
724
Mark Hammond91a681d2002-08-12 07:21:58 +0000725PyAPI_FUNC(PyObject*) PyUnicode_DecodeUTF16(
Guido van Rossumd8225182000-03-10 22:33:05 +0000726 const char *string, /* UTF-16 encoded string */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000727 Py_ssize_t length, /* size of string */
Guido van Rossumd8225182000-03-10 22:33:05 +0000728 const char *errors, /* error handling */
729 int *byteorder /* pointer to byteorder to use
730 0=native;-1=LE,1=BE; updated on
731 exit */
732 );
733
Walter Dörwald69652032004-09-07 20:24:22 +0000734PyAPI_FUNC(PyObject*) PyUnicode_DecodeUTF16Stateful(
735 const char *string, /* UTF-16 encoded string */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000736 Py_ssize_t length, /* size of string */
Walter Dörwald69652032004-09-07 20:24:22 +0000737 const char *errors, /* error handling */
738 int *byteorder, /* pointer to byteorder to use
739 0=native;-1=LE,1=BE; updated on
740 exit */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000741 Py_ssize_t *consumed /* bytes consumed */
Walter Dörwald69652032004-09-07 20:24:22 +0000742 );
743
Guido van Rossumd8225182000-03-10 22:33:05 +0000744/* Returns a Python string using the UTF-16 encoding in native byte
745 order. The string always starts with a BOM mark. */
746
Mark Hammond91a681d2002-08-12 07:21:58 +0000747PyAPI_FUNC(PyObject*) PyUnicode_AsUTF16String(
Guido van Rossumd8225182000-03-10 22:33:05 +0000748 PyObject *unicode /* Unicode object */
749 );
750
751/* Returns a Python string object holding the UTF-16 encoded value of
Guido van Rossum9e896b32000-04-05 20:11:21 +0000752 the Unicode data.
Guido van Rossumd8225182000-03-10 22:33:05 +0000753
754 If byteorder is not 0, output is written according to the following
755 byte order:
756
757 byteorder == -1: little endian
758 byteorder == 0: native byte order (writes a BOM mark)
759 byteorder == 1: big endian
760
761 If byteorder is 0, the output string will always start with the
762 Unicode BOM mark (U+FEFF). In the other two modes, no BOM mark is
763 prepended.
764
765 Note that Py_UNICODE data is being interpreted as UTF-16 reduced to
766 UCS-2. This trick makes it possible to add full UTF-16 capabilities
Thomas Wouters7e474022000-07-16 12:04:32 +0000767 at a later point without compromising the APIs.
Guido van Rossumd8225182000-03-10 22:33:05 +0000768
769*/
770
Mark Hammond91a681d2002-08-12 07:21:58 +0000771PyAPI_FUNC(PyObject*) PyUnicode_EncodeUTF16(
Guido van Rossumd8225182000-03-10 22:33:05 +0000772 const Py_UNICODE *data, /* Unicode char buffer */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000773 Py_ssize_t length, /* number of Py_UNICODE chars to encode */
Guido van Rossumd8225182000-03-10 22:33:05 +0000774 const char *errors, /* error handling */
775 int byteorder /* byteorder to use 0=BOM+native;-1=LE,1=BE */
776 );
777
778/* --- Unicode-Escape Codecs ---------------------------------------------- */
779
Mark Hammond91a681d2002-08-12 07:21:58 +0000780PyAPI_FUNC(PyObject*) PyUnicode_DecodeUnicodeEscape(
Guido van Rossumd8225182000-03-10 22:33:05 +0000781 const char *string, /* Unicode-Escape encoded string */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000782 Py_ssize_t length, /* size of string */
Guido van Rossumd8225182000-03-10 22:33:05 +0000783 const char *errors /* error handling */
784 );
785
Mark Hammond91a681d2002-08-12 07:21:58 +0000786PyAPI_FUNC(PyObject*) PyUnicode_AsUnicodeEscapeString(
Guido van Rossumd8225182000-03-10 22:33:05 +0000787 PyObject *unicode /* Unicode object */
788 );
789
Mark Hammond91a681d2002-08-12 07:21:58 +0000790PyAPI_FUNC(PyObject*) PyUnicode_EncodeUnicodeEscape(
Guido van Rossumd8225182000-03-10 22:33:05 +0000791 const Py_UNICODE *data, /* Unicode char buffer */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000792 Py_ssize_t length /* Number of Py_UNICODE chars to encode */
Guido van Rossumd8225182000-03-10 22:33:05 +0000793 );
794
795/* --- Raw-Unicode-Escape Codecs ------------------------------------------ */
796
Mark Hammond91a681d2002-08-12 07:21:58 +0000797PyAPI_FUNC(PyObject*) PyUnicode_DecodeRawUnicodeEscape(
Guido van Rossumd8225182000-03-10 22:33:05 +0000798 const char *string, /* Raw-Unicode-Escape encoded string */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000799 Py_ssize_t length, /* size of string */
Guido van Rossumd8225182000-03-10 22:33:05 +0000800 const char *errors /* error handling */
801 );
802
Mark Hammond91a681d2002-08-12 07:21:58 +0000803PyAPI_FUNC(PyObject*) PyUnicode_AsRawUnicodeEscapeString(
Guido van Rossumd8225182000-03-10 22:33:05 +0000804 PyObject *unicode /* Unicode object */
805 );
806
Mark Hammond91a681d2002-08-12 07:21:58 +0000807PyAPI_FUNC(PyObject*) PyUnicode_EncodeRawUnicodeEscape(
Guido van Rossumd8225182000-03-10 22:33:05 +0000808 const Py_UNICODE *data, /* Unicode char buffer */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000809 Py_ssize_t length /* Number of Py_UNICODE chars to encode */
Guido van Rossumd8225182000-03-10 22:33:05 +0000810 );
811
Walter Dörwalda47d1c02005-08-30 10:23:14 +0000812/* --- Unicode Internal Codec ---------------------------------------------
813
814 Only for internal use in _codecsmodule.c */
815
816PyObject *_PyUnicode_DecodeUnicodeInternal(
817 const char *string,
Martin v. Löwis18e16552006-02-15 17:27:45 +0000818 Py_ssize_t length,
Walter Dörwalda47d1c02005-08-30 10:23:14 +0000819 const char *errors
820 );
821
Guido van Rossumd8225182000-03-10 22:33:05 +0000822/* --- Latin-1 Codecs -----------------------------------------------------
823
824 Note: Latin-1 corresponds to the first 256 Unicode ordinals.
825
826*/
827
Mark Hammond91a681d2002-08-12 07:21:58 +0000828PyAPI_FUNC(PyObject*) PyUnicode_DecodeLatin1(
Guido van Rossumd8225182000-03-10 22:33:05 +0000829 const char *string, /* Latin-1 encoded string */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000830 Py_ssize_t length, /* size of string */
Guido van Rossumd8225182000-03-10 22:33:05 +0000831 const char *errors /* error handling */
832 );
833
Mark Hammond91a681d2002-08-12 07:21:58 +0000834PyAPI_FUNC(PyObject*) PyUnicode_AsLatin1String(
Guido van Rossumd8225182000-03-10 22:33:05 +0000835 PyObject *unicode /* Unicode object */
836 );
837
Mark Hammond91a681d2002-08-12 07:21:58 +0000838PyAPI_FUNC(PyObject*) PyUnicode_EncodeLatin1(
Guido van Rossumd8225182000-03-10 22:33:05 +0000839 const Py_UNICODE *data, /* Unicode char buffer */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000840 Py_ssize_t length, /* Number of Py_UNICODE chars to encode */
Guido van Rossumd8225182000-03-10 22:33:05 +0000841 const char *errors /* error handling */
842 );
843
844/* --- ASCII Codecs -------------------------------------------------------
845
846 Only 7-bit ASCII data is excepted. All other codes generate errors.
847
848*/
849
Mark Hammond91a681d2002-08-12 07:21:58 +0000850PyAPI_FUNC(PyObject*) PyUnicode_DecodeASCII(
Guido van Rossumd8225182000-03-10 22:33:05 +0000851 const char *string, /* ASCII encoded string */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000852 Py_ssize_t length, /* size of string */
Guido van Rossumd8225182000-03-10 22:33:05 +0000853 const char *errors /* error handling */
854 );
855
Mark Hammond91a681d2002-08-12 07:21:58 +0000856PyAPI_FUNC(PyObject*) PyUnicode_AsASCIIString(
Guido van Rossumd8225182000-03-10 22:33:05 +0000857 PyObject *unicode /* Unicode object */
858 );
859
Mark Hammond91a681d2002-08-12 07:21:58 +0000860PyAPI_FUNC(PyObject*) PyUnicode_EncodeASCII(
Guido van Rossumd8225182000-03-10 22:33:05 +0000861 const Py_UNICODE *data, /* Unicode char buffer */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000862 Py_ssize_t length, /* Number of Py_UNICODE chars to encode */
Guido van Rossumd8225182000-03-10 22:33:05 +0000863 const char *errors /* error handling */
864 );
865
866/* --- Character Map Codecs -----------------------------------------------
867
868 This codec uses mappings to encode and decode characters.
869
870 Decoding mappings must map single string characters to single
871 Unicode characters, integers (which are then interpreted as Unicode
872 ordinals) or None (meaning "undefined mapping" and causing an
873 error).
874
875 Encoding mappings must map single Unicode characters to single
876 string characters, integers (which are then interpreted as Latin-1
877 ordinals) or None (meaning "undefined mapping" and causing an
878 error).
879
880 If a character lookup fails with a LookupError, the character is
881 copied as-is meaning that its ordinal value will be interpreted as
882 Unicode or Latin-1 ordinal resp. Because of this mappings only need
883 to contain those mappings which map characters to different code
884 points.
885
886*/
887
Mark Hammond91a681d2002-08-12 07:21:58 +0000888PyAPI_FUNC(PyObject*) PyUnicode_DecodeCharmap(
Guido van Rossumd8225182000-03-10 22:33:05 +0000889 const char *string, /* Encoded string */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000890 Py_ssize_t length, /* size of string */
Guido van Rossumd8225182000-03-10 22:33:05 +0000891 PyObject *mapping, /* character mapping
892 (char ordinal -> unicode ordinal) */
893 const char *errors /* error handling */
894 );
895
Mark Hammond91a681d2002-08-12 07:21:58 +0000896PyAPI_FUNC(PyObject*) PyUnicode_AsCharmapString(
Guido van Rossumd8225182000-03-10 22:33:05 +0000897 PyObject *unicode, /* Unicode object */
898 PyObject *mapping /* character mapping
899 (unicode ordinal -> char ordinal) */
900 );
901
Mark Hammond91a681d2002-08-12 07:21:58 +0000902PyAPI_FUNC(PyObject*) PyUnicode_EncodeCharmap(
Guido van Rossumd8225182000-03-10 22:33:05 +0000903 const Py_UNICODE *data, /* Unicode char buffer */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000904 Py_ssize_t length, /* Number of Py_UNICODE chars to encode */
Guido van Rossumd8225182000-03-10 22:33:05 +0000905 PyObject *mapping, /* character mapping
906 (unicode ordinal -> char ordinal) */
907 const char *errors /* error handling */
908 );
909
910/* Translate a Py_UNICODE buffer of the given length by applying a
911 character mapping table to it and return the resulting Unicode
912 object.
913
914 The mapping table must map Unicode ordinal integers to Unicode
915 ordinal integers or None (causing deletion of the character).
916
917 Mapping tables may be dictionaries or sequences. Unmapped character
918 ordinals (ones which cause a LookupError) are left untouched and
919 are copied as-is.
920
921*/
922
Mark Hammond91a681d2002-08-12 07:21:58 +0000923PyAPI_FUNC(PyObject *) PyUnicode_TranslateCharmap(
Guido van Rossumd8225182000-03-10 22:33:05 +0000924 const Py_UNICODE *data, /* Unicode char buffer */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000925 Py_ssize_t length, /* Number of Py_UNICODE chars to encode */
Guido van Rossumd8225182000-03-10 22:33:05 +0000926 PyObject *table, /* Translate table */
927 const char *errors /* error handling */
928 );
929
Guido van Rossumefec1152000-03-28 02:01:15 +0000930#ifdef MS_WIN32
Guido van Rossum24bdb042000-03-28 20:29:59 +0000931
Guido van Rossumefec1152000-03-28 02:01:15 +0000932/* --- MBCS codecs for Windows -------------------------------------------- */
Guido van Rossum24bdb042000-03-28 20:29:59 +0000933
Mark Hammond91a681d2002-08-12 07:21:58 +0000934PyAPI_FUNC(PyObject*) PyUnicode_DecodeMBCS(
Guido van Rossumefec1152000-03-28 02:01:15 +0000935 const char *string, /* MBCS encoded string */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000936 Py_ssize_t length, /* size of string */
Guido van Rossumefec1152000-03-28 02:01:15 +0000937 const char *errors /* error handling */
938 );
939
Mark Hammond91a681d2002-08-12 07:21:58 +0000940PyAPI_FUNC(PyObject*) PyUnicode_AsMBCSString(
Guido van Rossumefec1152000-03-28 02:01:15 +0000941 PyObject *unicode /* Unicode object */
942 );
943
Mark Hammond91a681d2002-08-12 07:21:58 +0000944PyAPI_FUNC(PyObject*) PyUnicode_EncodeMBCS(
Guido van Rossumefec1152000-03-28 02:01:15 +0000945 const Py_UNICODE *data, /* Unicode char buffer */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000946 Py_ssize_t length, /* Number of Py_UNICODE chars to encode */
Guido van Rossumefec1152000-03-28 02:01:15 +0000947 const char *errors /* error handling */
948 );
949
Guido van Rossumefec1152000-03-28 02:01:15 +0000950#endif /* MS_WIN32 */
Guido van Rossum24bdb042000-03-28 20:29:59 +0000951
Guido van Rossum9e896b32000-04-05 20:11:21 +0000952/* --- Decimal Encoder ---------------------------------------------------- */
953
954/* Takes a Unicode string holding a decimal value and writes it into
955 an output buffer using standard ASCII digit codes.
956
957 The output buffer has to provide at least length+1 bytes of storage
958 area. The output string is 0-terminated.
959
960 The encoder converts whitespace to ' ', decimal characters to their
961 corresponding ASCII digit and all other Latin-1 characters except
962 \0 as-is. Characters outside this range (Unicode ordinals 1-256)
963 are treated as errors. This includes embedded NULL bytes.
964
965 Error handling is defined by the errors argument:
966
967 NULL or "strict": raise a ValueError
968 "ignore": ignore the wrong characters (these are not copied to the
969 output buffer)
970 "replace": replaces illegal characters with '?'
971
972 Returns 0 on success, -1 on failure.
973
974*/
975
Mark Hammond91a681d2002-08-12 07:21:58 +0000976PyAPI_FUNC(int) PyUnicode_EncodeDecimal(
Guido van Rossum9e896b32000-04-05 20:11:21 +0000977 Py_UNICODE *s, /* Unicode buffer */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000978 Py_ssize_t length, /* Number of Py_UNICODE chars to encode */
Guido van Rossum9e896b32000-04-05 20:11:21 +0000979 char *output, /* Output buffer; must have size >= length */
980 const char *errors /* error handling */
981 );
982
Guido van Rossumd8225182000-03-10 22:33:05 +0000983/* --- Methods & Slots ----------------------------------------------------
984
985 These are capable of handling Unicode objects and strings on input
986 (we refer to them as strings in the descriptions) and return
987 Unicode objects or integers as apporpriate. */
988
989/* Concat two strings giving a new Unicode string. */
990
Mark Hammond91a681d2002-08-12 07:21:58 +0000991PyAPI_FUNC(PyObject*) PyUnicode_Concat(
Guido van Rossumd8225182000-03-10 22:33:05 +0000992 PyObject *left, /* Left string */
993 PyObject *right /* Right string */
994 );
995
996/* Split a string giving a list of Unicode strings.
997
998 If sep is NULL, splitting will be done at all whitespace
999 substrings. Otherwise, splits occur at the given separator.
1000
1001 At most maxsplit splits will be done. If negative, no limit is set.
1002
1003 Separators are not included in the resulting list.
1004
1005*/
1006
Mark Hammond91a681d2002-08-12 07:21:58 +00001007PyAPI_FUNC(PyObject*) PyUnicode_Split(
Guido van Rossumd8225182000-03-10 22:33:05 +00001008 PyObject *s, /* String to split */
1009 PyObject *sep, /* String separator */
Martin v. Löwis18e16552006-02-15 17:27:45 +00001010 Py_ssize_t maxsplit /* Maxsplit count */
Guido van Rossumd8225182000-03-10 22:33:05 +00001011 );
1012
1013/* Dito, but split at line breaks.
1014
1015 CRLF is considered to be one line break. Line breaks are not
1016 included in the resulting list. */
1017
Mark Hammond91a681d2002-08-12 07:21:58 +00001018PyAPI_FUNC(PyObject*) PyUnicode_Splitlines(
Guido van Rossumd8225182000-03-10 22:33:05 +00001019 PyObject *s, /* String to split */
Guido van Rossum004d64f2000-04-11 15:39:46 +00001020 int keepends /* If true, line end markers are included */
Guido van Rossumd8225182000-03-10 22:33:05 +00001021 );
1022
Fredrik Lundh06a69dd2006-05-26 08:54:28 +00001023/* Partition a string using a given separator. */
1024
1025PyAPI_FUNC(PyObject*) PyUnicode_Partition(
1026 PyObject *s, /* String to partition */
1027 PyObject *sep /* String separator */
1028 );
1029
Hye-Shik Chang3ae811b2003-12-15 18:49:53 +00001030/* Split a string giving a list of Unicode strings.
1031
1032 If sep is NULL, splitting will be done at all whitespace
1033 substrings. Otherwise, splits occur at the given separator.
1034
1035 At most maxsplit splits will be done. But unlike PyUnicode_Split
1036 PyUnicode_RSplit splits from the end of the string. If negative,
1037 no limit is set.
1038
1039 Separators are not included in the resulting list.
1040
1041*/
1042
1043PyAPI_FUNC(PyObject*) PyUnicode_RSplit(
1044 PyObject *s, /* String to split */
1045 PyObject *sep, /* String separator */
Martin v. Löwis18e16552006-02-15 17:27:45 +00001046 Py_ssize_t maxsplit /* Maxsplit count */
Hye-Shik Chang3ae811b2003-12-15 18:49:53 +00001047 );
1048
Guido van Rossumd8225182000-03-10 22:33:05 +00001049/* Translate a string by applying a character mapping table to it and
1050 return the resulting Unicode object.
1051
1052 The mapping table must map Unicode ordinal integers to Unicode
1053 ordinal integers or None (causing deletion of the character).
1054
1055 Mapping tables may be dictionaries or sequences. Unmapped character
1056 ordinals (ones which cause a LookupError) are left untouched and
1057 are copied as-is.
1058
1059*/
1060
Mark Hammond91a681d2002-08-12 07:21:58 +00001061PyAPI_FUNC(PyObject *) PyUnicode_Translate(
Guido van Rossumd8225182000-03-10 22:33:05 +00001062 PyObject *str, /* String */
1063 PyObject *table, /* Translate table */
1064 const char *errors /* error handling */
1065 );
1066
1067/* Join a sequence of strings using the given separator and return
1068 the resulting Unicode string. */
1069
Mark Hammond91a681d2002-08-12 07:21:58 +00001070PyAPI_FUNC(PyObject*) PyUnicode_Join(
Guido van Rossumd8225182000-03-10 22:33:05 +00001071 PyObject *separator, /* Separator string */
1072 PyObject *seq /* Sequence object */
1073 );
1074
1075/* Return 1 if substr matches str[start:end] at the given tail end, 0
1076 otherwise. */
1077
Martin v. Löwis18e16552006-02-15 17:27:45 +00001078PyAPI_FUNC(Py_ssize_t) PyUnicode_Tailmatch(
Guido van Rossumd8225182000-03-10 22:33:05 +00001079 PyObject *str, /* String */
1080 PyObject *substr, /* Prefix or Suffix string */
Martin v. Löwis18e16552006-02-15 17:27:45 +00001081 Py_ssize_t start, /* Start index */
1082 Py_ssize_t end, /* Stop index */
Guido van Rossumd8225182000-03-10 22:33:05 +00001083 int direction /* Tail end: -1 prefix, +1 suffix */
1084 );
1085
1086/* Return the first position of substr in str[start:end] using the
Marc-André Lemburg4da6fd62002-05-29 11:33:13 +00001087 given search direction or -1 if not found. -2 is returned in case
1088 an error occurred and an exception is set. */
Guido van Rossumd8225182000-03-10 22:33:05 +00001089
Martin v. Löwis18e16552006-02-15 17:27:45 +00001090PyAPI_FUNC(Py_ssize_t) PyUnicode_Find(
Guido van Rossumd8225182000-03-10 22:33:05 +00001091 PyObject *str, /* String */
1092 PyObject *substr, /* Substring to find */
Martin v. Löwis18e16552006-02-15 17:27:45 +00001093 Py_ssize_t start, /* Start index */
1094 Py_ssize_t end, /* Stop index */
Guido van Rossumd8225182000-03-10 22:33:05 +00001095 int direction /* Find direction: +1 forward, -1 backward */
1096 );
1097
Barry Warsaw51ac5802000-03-20 16:36:48 +00001098/* Count the number of occurrences of substr in str[start:end]. */
Guido van Rossumd8225182000-03-10 22:33:05 +00001099
Martin v. Löwis18e16552006-02-15 17:27:45 +00001100PyAPI_FUNC(Py_ssize_t) PyUnicode_Count(
Guido van Rossumd8225182000-03-10 22:33:05 +00001101 PyObject *str, /* String */
1102 PyObject *substr, /* Substring to count */
Martin v. Löwis18e16552006-02-15 17:27:45 +00001103 Py_ssize_t start, /* Start index */
1104 Py_ssize_t end /* Stop index */
Guido van Rossumd8225182000-03-10 22:33:05 +00001105 );
1106
Barry Warsaw51ac5802000-03-20 16:36:48 +00001107/* Replace at most maxcount occurrences of substr in str with replstr
Guido van Rossumd8225182000-03-10 22:33:05 +00001108 and return the resulting Unicode object. */
1109
Mark Hammond91a681d2002-08-12 07:21:58 +00001110PyAPI_FUNC(PyObject *) PyUnicode_Replace(
Guido van Rossumd8225182000-03-10 22:33:05 +00001111 PyObject *str, /* String */
1112 PyObject *substr, /* Substring to find */
1113 PyObject *replstr, /* Substring to replace */
Martin v. Löwis18e16552006-02-15 17:27:45 +00001114 Py_ssize_t maxcount /* Max. number of replacements to apply;
Guido van Rossumd8225182000-03-10 22:33:05 +00001115 -1 = all */
1116 );
1117
1118/* Compare two strings and return -1, 0, 1 for less than, equal,
1119 greater than resp. */
1120
Mark Hammond91a681d2002-08-12 07:21:58 +00001121PyAPI_FUNC(int) PyUnicode_Compare(
Guido van Rossumd8225182000-03-10 22:33:05 +00001122 PyObject *left, /* Left string */
1123 PyObject *right /* Right string */
1124 );
1125
Thomas Wouters7e474022000-07-16 12:04:32 +00001126/* Apply a argument tuple or dictionary to a format string and return
Guido van Rossumd8225182000-03-10 22:33:05 +00001127 the resulting Unicode string. */
1128
Mark Hammond91a681d2002-08-12 07:21:58 +00001129PyAPI_FUNC(PyObject *) PyUnicode_Format(
Guido van Rossumd8225182000-03-10 22:33:05 +00001130 PyObject *format, /* Format string */
1131 PyObject *args /* Argument tuple or dictionary */
1132 );
1133
Guido van Rossumd0d366b2000-03-13 23:22:24 +00001134/* Checks whether element is contained in container and return 1/0
1135 accordingly.
1136
1137 element has to coerce to an one element Unicode string. -1 is
1138 returned in case of an error. */
1139
Mark Hammond91a681d2002-08-12 07:21:58 +00001140PyAPI_FUNC(int) PyUnicode_Contains(
Guido van Rossumd0d366b2000-03-13 23:22:24 +00001141 PyObject *container, /* Container string */
1142 PyObject *element /* Element string */
1143 );
1144
Walter Dörwaldde02bcb2002-04-22 17:42:37 +00001145/* Externally visible for str.strip(unicode) */
Mark Hammond91a681d2002-08-12 07:21:58 +00001146PyAPI_FUNC(PyObject *) _PyUnicode_XStrip(
Walter Dörwaldde02bcb2002-04-22 17:42:37 +00001147 PyUnicodeObject *self,
1148 int striptype,
1149 PyObject *sepobj
1150 );
1151
Guido van Rossumd8225182000-03-10 22:33:05 +00001152/* === Characters Type APIs =============================================== */
1153
1154/* These should not be used directly. Use the Py_UNICODE_IS* and
1155 Py_UNICODE_TO* macros instead.
1156
1157 These APIs are implemented in Objects/unicodectype.c.
1158
1159*/
1160
Mark Hammond91a681d2002-08-12 07:21:58 +00001161PyAPI_FUNC(int) _PyUnicode_IsLowercase(
Fredrik Lundh72b06852001-06-27 22:08:26 +00001162 Py_UNICODE ch /* Unicode character */
Guido van Rossumd8225182000-03-10 22:33:05 +00001163 );
1164
Mark Hammond91a681d2002-08-12 07:21:58 +00001165PyAPI_FUNC(int) _PyUnicode_IsUppercase(
Fredrik Lundh72b06852001-06-27 22:08:26 +00001166 Py_UNICODE ch /* Unicode character */
Guido van Rossumd8225182000-03-10 22:33:05 +00001167 );
1168
Mark Hammond91a681d2002-08-12 07:21:58 +00001169PyAPI_FUNC(int) _PyUnicode_IsTitlecase(
Fredrik Lundh72b06852001-06-27 22:08:26 +00001170 Py_UNICODE ch /* Unicode character */
Guido van Rossumd8225182000-03-10 22:33:05 +00001171 );
1172
Mark Hammond91a681d2002-08-12 07:21:58 +00001173PyAPI_FUNC(int) _PyUnicode_IsWhitespace(
Tim Peters2576c972005-10-29 02:33:18 +00001174 const Py_UNICODE ch /* Unicode character */
Guido van Rossumd8225182000-03-10 22:33:05 +00001175 );
1176
Mark Hammond91a681d2002-08-12 07:21:58 +00001177PyAPI_FUNC(int) _PyUnicode_IsLinebreak(
Tim Peters2576c972005-10-29 02:33:18 +00001178 const Py_UNICODE ch /* Unicode character */
Guido van Rossumd8225182000-03-10 22:33:05 +00001179 );
1180
Mark Hammond91a681d2002-08-12 07:21:58 +00001181PyAPI_FUNC(Py_UNICODE) _PyUnicode_ToLowercase(
Fredrik Lundh72b06852001-06-27 22:08:26 +00001182 Py_UNICODE ch /* Unicode character */
Guido van Rossumd8225182000-03-10 22:33:05 +00001183 );
1184
Mark Hammond91a681d2002-08-12 07:21:58 +00001185PyAPI_FUNC(Py_UNICODE) _PyUnicode_ToUppercase(
Fredrik Lundh72b06852001-06-27 22:08:26 +00001186 Py_UNICODE ch /* Unicode character */
Guido van Rossumd8225182000-03-10 22:33:05 +00001187 );
1188
Mark Hammond91a681d2002-08-12 07:21:58 +00001189PyAPI_FUNC(Py_UNICODE) _PyUnicode_ToTitlecase(
Fredrik Lundh72b06852001-06-27 22:08:26 +00001190 Py_UNICODE ch /* Unicode character */
Guido van Rossumd8225182000-03-10 22:33:05 +00001191 );
1192
Mark Hammond91a681d2002-08-12 07:21:58 +00001193PyAPI_FUNC(int) _PyUnicode_ToDecimalDigit(
Fredrik Lundh72b06852001-06-27 22:08:26 +00001194 Py_UNICODE ch /* Unicode character */
Guido van Rossumd8225182000-03-10 22:33:05 +00001195 );
1196
Mark Hammond91a681d2002-08-12 07:21:58 +00001197PyAPI_FUNC(int) _PyUnicode_ToDigit(
Fredrik Lundh72b06852001-06-27 22:08:26 +00001198 Py_UNICODE ch /* Unicode character */
Guido van Rossumd8225182000-03-10 22:33:05 +00001199 );
1200
Mark Hammond91a681d2002-08-12 07:21:58 +00001201PyAPI_FUNC(double) _PyUnicode_ToNumeric(
Fredrik Lundh72b06852001-06-27 22:08:26 +00001202 Py_UNICODE ch /* Unicode character */
Guido van Rossumd8225182000-03-10 22:33:05 +00001203 );
1204
Mark Hammond91a681d2002-08-12 07:21:58 +00001205PyAPI_FUNC(int) _PyUnicode_IsDecimalDigit(
Fredrik Lundh72b06852001-06-27 22:08:26 +00001206 Py_UNICODE ch /* Unicode character */
Guido van Rossumd8225182000-03-10 22:33:05 +00001207 );
1208
Mark Hammond91a681d2002-08-12 07:21:58 +00001209PyAPI_FUNC(int) _PyUnicode_IsDigit(
Fredrik Lundh72b06852001-06-27 22:08:26 +00001210 Py_UNICODE ch /* Unicode character */
Guido van Rossumd8225182000-03-10 22:33:05 +00001211 );
1212
Mark Hammond91a681d2002-08-12 07:21:58 +00001213PyAPI_FUNC(int) _PyUnicode_IsNumeric(
Fredrik Lundh72b06852001-06-27 22:08:26 +00001214 Py_UNICODE ch /* Unicode character */
Guido van Rossumd8225182000-03-10 22:33:05 +00001215 );
1216
Mark Hammond91a681d2002-08-12 07:21:58 +00001217PyAPI_FUNC(int) _PyUnicode_IsAlpha(
Fredrik Lundh72b06852001-06-27 22:08:26 +00001218 Py_UNICODE ch /* Unicode character */
Marc-André Lemburgf03e7412000-07-05 09:45:59 +00001219 );
1220
Guido van Rossumd8225182000-03-10 22:33:05 +00001221#ifdef __cplusplus
1222}
1223#endif
Martin v. Löwis339d0f72001-08-17 18:39:25 +00001224#endif /* Py_USING_UNICODE */
Guido van Rossumd8225182000-03-10 22:33:05 +00001225#endif /* !Py_UNICODEOBJECT_H */