blob: 82a023275902afb56e71582b59789f66bc305708 [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
187# define PyUnicode_Replace PyUnicodeUCS2_Replace
188# define PyUnicode_Resize PyUnicodeUCS2_Resize
189# define PyUnicode_SetDefaultEncoding PyUnicodeUCS2_SetDefaultEncoding
190# define PyUnicode_Split PyUnicodeUCS2_Split
Hye-Shik Chang3ae811b2003-12-15 18:49:53 +0000191# define PyUnicode_RSplit PyUnicodeUCS2_RSplit
Marc-André Lemburgb5ac6f62001-07-31 14:30:16 +0000192# define PyUnicode_Splitlines PyUnicodeUCS2_Splitlines
193# define PyUnicode_Tailmatch PyUnicodeUCS2_Tailmatch
194# define PyUnicode_Translate PyUnicodeUCS2_Translate
195# define PyUnicode_TranslateCharmap PyUnicodeUCS2_TranslateCharmap
196# define _PyUnicode_AsDefaultEncodedString _PyUnicodeUCS2_AsDefaultEncodedString
197# define _PyUnicode_Fini _PyUnicodeUCS2_Fini
198# define _PyUnicode_Init _PyUnicodeUCS2_Init
199# define _PyUnicode_IsAlpha _PyUnicodeUCS2_IsAlpha
200# define _PyUnicode_IsDecimalDigit _PyUnicodeUCS2_IsDecimalDigit
201# define _PyUnicode_IsDigit _PyUnicodeUCS2_IsDigit
202# define _PyUnicode_IsLinebreak _PyUnicodeUCS2_IsLinebreak
203# define _PyUnicode_IsLowercase _PyUnicodeUCS2_IsLowercase
204# define _PyUnicode_IsNumeric _PyUnicodeUCS2_IsNumeric
205# define _PyUnicode_IsTitlecase _PyUnicodeUCS2_IsTitlecase
206# define _PyUnicode_IsUppercase _PyUnicodeUCS2_IsUppercase
207# define _PyUnicode_IsWhitespace _PyUnicodeUCS2_IsWhitespace
208# define _PyUnicode_ToDecimalDigit _PyUnicodeUCS2_ToDecimalDigit
209# define _PyUnicode_ToDigit _PyUnicodeUCS2_ToDigit
210# define _PyUnicode_ToLowercase _PyUnicodeUCS2_ToLowercase
211# define _PyUnicode_ToNumeric _PyUnicodeUCS2_ToNumeric
212# define _PyUnicode_ToTitlecase _PyUnicodeUCS2_ToTitlecase
213# define _PyUnicode_ToUppercase _PyUnicodeUCS2_ToUppercase
214
215#else
216
217# define PyUnicode_AsASCIIString PyUnicodeUCS4_AsASCIIString
218# define PyUnicode_AsCharmapString PyUnicodeUCS4_AsCharmapString
Marc-André Lemburgd2d45982004-07-08 17:57:32 +0000219# define PyUnicode_AsEncodedObject PyUnicodeUCS4_AsEncodedObject
Marc-André Lemburgb5ac6f62001-07-31 14:30:16 +0000220# define PyUnicode_AsEncodedString PyUnicodeUCS4_AsEncodedString
221# define PyUnicode_AsLatin1String PyUnicodeUCS4_AsLatin1String
222# define PyUnicode_AsRawUnicodeEscapeString PyUnicodeUCS4_AsRawUnicodeEscapeString
223# define PyUnicode_AsUTF16String PyUnicodeUCS4_AsUTF16String
224# define PyUnicode_AsUTF8String PyUnicodeUCS4_AsUTF8String
225# define PyUnicode_AsUnicode PyUnicodeUCS4_AsUnicode
226# define PyUnicode_AsUnicodeEscapeString PyUnicodeUCS4_AsUnicodeEscapeString
227# define PyUnicode_AsWideChar PyUnicodeUCS4_AsWideChar
228# define PyUnicode_Compare PyUnicodeUCS4_Compare
229# define PyUnicode_Concat PyUnicodeUCS4_Concat
230# define PyUnicode_Contains PyUnicodeUCS4_Contains
231# define PyUnicode_Count PyUnicodeUCS4_Count
232# define PyUnicode_Decode PyUnicodeUCS4_Decode
233# define PyUnicode_DecodeASCII PyUnicodeUCS4_DecodeASCII
234# define PyUnicode_DecodeCharmap PyUnicodeUCS4_DecodeCharmap
235# define PyUnicode_DecodeLatin1 PyUnicodeUCS4_DecodeLatin1
236# define PyUnicode_DecodeRawUnicodeEscape PyUnicodeUCS4_DecodeRawUnicodeEscape
237# define PyUnicode_DecodeUTF16 PyUnicodeUCS4_DecodeUTF16
Walter Dörwald69652032004-09-07 20:24:22 +0000238# define PyUnicode_DecodeUTF16Stateful PyUnicodeUCS4_DecodeUTF16Stateful
Marc-André Lemburgb5ac6f62001-07-31 14:30:16 +0000239# define PyUnicode_DecodeUTF8 PyUnicodeUCS4_DecodeUTF8
Walter Dörwald69652032004-09-07 20:24:22 +0000240# define PyUnicode_DecodeUTF8Stateful PyUnicodeUCS4_DecodeUTF8Stateful
Marc-André Lemburgb5ac6f62001-07-31 14:30:16 +0000241# define PyUnicode_DecodeUnicodeEscape PyUnicodeUCS4_DecodeUnicodeEscape
242# define PyUnicode_Encode PyUnicodeUCS4_Encode
243# define PyUnicode_EncodeASCII PyUnicodeUCS4_EncodeASCII
244# define PyUnicode_EncodeCharmap PyUnicodeUCS4_EncodeCharmap
245# define PyUnicode_EncodeDecimal PyUnicodeUCS4_EncodeDecimal
246# define PyUnicode_EncodeLatin1 PyUnicodeUCS4_EncodeLatin1
247# define PyUnicode_EncodeRawUnicodeEscape PyUnicodeUCS4_EncodeRawUnicodeEscape
248# define PyUnicode_EncodeUTF16 PyUnicodeUCS4_EncodeUTF16
249# define PyUnicode_EncodeUTF8 PyUnicodeUCS4_EncodeUTF8
250# define PyUnicode_EncodeUnicodeEscape PyUnicodeUCS4_EncodeUnicodeEscape
251# define PyUnicode_Find PyUnicodeUCS4_Find
252# define PyUnicode_Format PyUnicodeUCS4_Format
253# define PyUnicode_FromEncodedObject PyUnicodeUCS4_FromEncodedObject
254# define PyUnicode_FromObject PyUnicodeUCS4_FromObject
Marc-André Lemburg9c329de2002-08-12 08:19:10 +0000255# define PyUnicode_FromOrdinal PyUnicodeUCS4_FromOrdinal
Marc-André Lemburgb5ac6f62001-07-31 14:30:16 +0000256# define PyUnicode_FromUnicode PyUnicodeUCS4_FromUnicode
257# define PyUnicode_FromWideChar PyUnicodeUCS4_FromWideChar
258# define PyUnicode_GetDefaultEncoding PyUnicodeUCS4_GetDefaultEncoding
259# define PyUnicode_GetMax PyUnicodeUCS4_GetMax
260# define PyUnicode_GetSize PyUnicodeUCS4_GetSize
261# define PyUnicode_Join PyUnicodeUCS4_Join
262# define PyUnicode_Replace PyUnicodeUCS4_Replace
263# define PyUnicode_Resize PyUnicodeUCS4_Resize
264# define PyUnicode_SetDefaultEncoding PyUnicodeUCS4_SetDefaultEncoding
265# define PyUnicode_Split PyUnicodeUCS4_Split
266# define PyUnicode_Splitlines PyUnicodeUCS4_Splitlines
267# define PyUnicode_Tailmatch PyUnicodeUCS4_Tailmatch
268# define PyUnicode_Translate PyUnicodeUCS4_Translate
269# define PyUnicode_TranslateCharmap PyUnicodeUCS4_TranslateCharmap
270# define _PyUnicode_AsDefaultEncodedString _PyUnicodeUCS4_AsDefaultEncodedString
271# define _PyUnicode_Fini _PyUnicodeUCS4_Fini
272# define _PyUnicode_Init _PyUnicodeUCS4_Init
273# define _PyUnicode_IsAlpha _PyUnicodeUCS4_IsAlpha
274# define _PyUnicode_IsDecimalDigit _PyUnicodeUCS4_IsDecimalDigit
275# define _PyUnicode_IsDigit _PyUnicodeUCS4_IsDigit
276# define _PyUnicode_IsLinebreak _PyUnicodeUCS4_IsLinebreak
277# define _PyUnicode_IsLowercase _PyUnicodeUCS4_IsLowercase
278# define _PyUnicode_IsNumeric _PyUnicodeUCS4_IsNumeric
279# define _PyUnicode_IsTitlecase _PyUnicodeUCS4_IsTitlecase
280# define _PyUnicode_IsUppercase _PyUnicodeUCS4_IsUppercase
281# define _PyUnicode_IsWhitespace _PyUnicodeUCS4_IsWhitespace
282# define _PyUnicode_ToDecimalDigit _PyUnicodeUCS4_ToDecimalDigit
283# define _PyUnicode_ToDigit _PyUnicodeUCS4_ToDigit
284# define _PyUnicode_ToLowercase _PyUnicodeUCS4_ToLowercase
285# define _PyUnicode_ToNumeric _PyUnicodeUCS4_ToNumeric
286# define _PyUnicode_ToTitlecase _PyUnicodeUCS4_ToTitlecase
287# define _PyUnicode_ToUppercase _PyUnicodeUCS4_ToUppercase
288
289
290#endif
291
Guido van Rossumd8225182000-03-10 22:33:05 +0000292/* --- Internal Unicode Operations ---------------------------------------- */
293
294/* If you want Python to use the compiler's wctype.h functions instead
Barry Warsaw51ac5802000-03-20 16:36:48 +0000295 of the ones supplied with Python, define WANT_WCTYPE_FUNCTIONS or
Raymond Hettinger57341c32004-10-31 05:46:59 +0000296 configure Python using --with-wctype-functions. This reduces the
Barry Warsaw51ac5802000-03-20 16:36:48 +0000297 interpreter's code size. */
Guido van Rossumd8225182000-03-10 22:33:05 +0000298
299#if defined(HAVE_USABLE_WCHAR_T) && defined(WANT_WCTYPE_FUNCTIONS)
300
Marc-André Lemburg5e6007c2001-09-19 11:21:03 +0000301#include <wctype.h>
Guido van Rossumd8225182000-03-10 22:33:05 +0000302
303#define Py_UNICODE_ISSPACE(ch) iswspace(ch)
304
305#define Py_UNICODE_ISLOWER(ch) iswlower(ch)
306#define Py_UNICODE_ISUPPER(ch) iswupper(ch)
307#define Py_UNICODE_ISTITLE(ch) _PyUnicode_IsTitlecase(ch)
308#define Py_UNICODE_ISLINEBREAK(ch) _PyUnicode_IsLinebreak(ch)
309
310#define Py_UNICODE_TOLOWER(ch) towlower(ch)
311#define Py_UNICODE_TOUPPER(ch) towupper(ch)
312#define Py_UNICODE_TOTITLE(ch) _PyUnicode_ToTitlecase(ch)
313
314#define Py_UNICODE_ISDECIMAL(ch) _PyUnicode_IsDecimalDigit(ch)
315#define Py_UNICODE_ISDIGIT(ch) _PyUnicode_IsDigit(ch)
316#define Py_UNICODE_ISNUMERIC(ch) _PyUnicode_IsNumeric(ch)
317
318#define Py_UNICODE_TODECIMAL(ch) _PyUnicode_ToDecimalDigit(ch)
319#define Py_UNICODE_TODIGIT(ch) _PyUnicode_ToDigit(ch)
320#define Py_UNICODE_TONUMERIC(ch) _PyUnicode_ToNumeric(ch)
321
Marc-André Lemburgf03e7412000-07-05 09:45:59 +0000322#define Py_UNICODE_ISALPHA(ch) iswalpha(ch)
323
Guido van Rossumd8225182000-03-10 22:33:05 +0000324#else
325
326#define Py_UNICODE_ISSPACE(ch) _PyUnicode_IsWhitespace(ch)
327
328#define Py_UNICODE_ISLOWER(ch) _PyUnicode_IsLowercase(ch)
329#define Py_UNICODE_ISUPPER(ch) _PyUnicode_IsUppercase(ch)
330#define Py_UNICODE_ISTITLE(ch) _PyUnicode_IsTitlecase(ch)
331#define Py_UNICODE_ISLINEBREAK(ch) _PyUnicode_IsLinebreak(ch)
332
333#define Py_UNICODE_TOLOWER(ch) _PyUnicode_ToLowercase(ch)
334#define Py_UNICODE_TOUPPER(ch) _PyUnicode_ToUppercase(ch)
335#define Py_UNICODE_TOTITLE(ch) _PyUnicode_ToTitlecase(ch)
336
337#define Py_UNICODE_ISDECIMAL(ch) _PyUnicode_IsDecimalDigit(ch)
338#define Py_UNICODE_ISDIGIT(ch) _PyUnicode_IsDigit(ch)
339#define Py_UNICODE_ISNUMERIC(ch) _PyUnicode_IsNumeric(ch)
340
341#define Py_UNICODE_TODECIMAL(ch) _PyUnicode_ToDecimalDigit(ch)
342#define Py_UNICODE_TODIGIT(ch) _PyUnicode_ToDigit(ch)
343#define Py_UNICODE_TONUMERIC(ch) _PyUnicode_ToNumeric(ch)
344
Marc-André Lemburgf03e7412000-07-05 09:45:59 +0000345#define Py_UNICODE_ISALPHA(ch) _PyUnicode_IsAlpha(ch)
Guido van Rossumd8225182000-03-10 22:33:05 +0000346
Marc-André Lemburgf03e7412000-07-05 09:45:59 +0000347#endif
Marc-André Lemburga9c103b2000-07-03 10:52:13 +0000348
349#define Py_UNICODE_ISALNUM(ch) \
350 (Py_UNICODE_ISALPHA(ch) || \
351 Py_UNICODE_ISDECIMAL(ch) || \
352 Py_UNICODE_ISDIGIT(ch) || \
353 Py_UNICODE_ISNUMERIC(ch))
354
Fredrik Lundh8a8e05a2006-05-22 17:12:58 +0000355/* memcpy has a considerable setup overhead on many platforms; use a
356 loop for short strings (the "16" below is pretty arbitary) */
Fredrik Lundhf1d60a52006-05-22 16:29:30 +0000357#define Py_UNICODE_COPY(target, source, length) do\
Fredrik Lundh8a8e05a2006-05-22 17:12:58 +0000358 {Py_ssize_t i_; Py_UNICODE *t_ = (target); const Py_UNICODE *s_ = (source);\
359 if (length > 16)\
360 memcpy(t_, s_, (length)*sizeof(Py_UNICODE));\
361 else\
362 for (i_ = 0; i_ < (length); i_++) t_[i_] = s_[i_];\
Fredrik Lundhf1d60a52006-05-22 16:29:30 +0000363 } while (0)
Guido van Rossumd8225182000-03-10 22:33:05 +0000364
365#define Py_UNICODE_FILL(target, value, length) do\
Fredrik Lundh8a8e05a2006-05-22 17:12:58 +0000366 {Py_ssize_t i_; Py_UNICODE *t_ = (target); Py_UNICODE v_ = (value);\
367 for (i_ = 0; i_ < (length); i_++) t_[i_] = v_;\
Fredrik Lundhf1d60a52006-05-22 16:29:30 +0000368 } while (0)
Guido van Rossumd8225182000-03-10 22:33:05 +0000369
Fredrik Lundh3d885e02006-05-23 10:10:57 +0000370/* check if substring matches at given offset. the offset must be
371 valid, and the substring must not be empty */
372#define Py_UNICODE_MATCH(string, offset, substring) \
373 ((*((string)->str + (offset)) == *((substring)->str)) && \
374 ((*((string)->str + (offset) + (substring)->length-1) == *((substring)->str + (substring)->length-1))) && \
375 !memcmp((string)->str + (offset), (substring)->str, (substring)->length*sizeof(Py_UNICODE)))
Guido van Rossumd8225182000-03-10 22:33:05 +0000376
Barry Warsaw51ac5802000-03-20 16:36:48 +0000377#ifdef __cplusplus
378extern "C" {
379#endif
380
Guido van Rossumd8225182000-03-10 22:33:05 +0000381/* --- Unicode Type ------------------------------------------------------- */
382
383typedef struct {
384 PyObject_HEAD
Martin v. Löwis18e16552006-02-15 17:27:45 +0000385 Py_ssize_t length; /* Length of raw Unicode data in buffer */
Guido van Rossumd8225182000-03-10 22:33:05 +0000386 Py_UNICODE *str; /* Raw Unicode buffer */
387 long hash; /* Hash value; -1 if not set */
Marc-André Lemburgbff879c2000-08-03 18:46:08 +0000388 PyObject *defenc; /* (Default) Encoded version as Python
389 string, or NULL; this is used for
390 implementing the buffer protocol */
Guido van Rossumd8225182000-03-10 22:33:05 +0000391} PyUnicodeObject;
392
Mark Hammond91a681d2002-08-12 07:21:58 +0000393PyAPI_DATA(PyTypeObject) PyUnicode_Type;
Guido van Rossumd8225182000-03-10 22:33:05 +0000394
Guido van Rossum5eef77a2001-08-30 03:08:07 +0000395#define PyUnicode_Check(op) PyObject_TypeCheck(op, &PyUnicode_Type)
Tim Peters78e0fc72001-09-11 03:07:38 +0000396#define PyUnicode_CheckExact(op) ((op)->ob_type == &PyUnicode_Type)
Guido van Rossumd8225182000-03-10 22:33:05 +0000397
398/* Fast access macros */
399#define PyUnicode_GET_SIZE(op) \
400 (((PyUnicodeObject *)(op))->length)
401#define PyUnicode_GET_DATA_SIZE(op) \
402 (((PyUnicodeObject *)(op))->length * sizeof(Py_UNICODE))
403#define PyUnicode_AS_UNICODE(op) \
404 (((PyUnicodeObject *)(op))->str)
405#define PyUnicode_AS_DATA(op) \
406 ((const char *)((PyUnicodeObject *)(op))->str)
407
408/* --- Constants ---------------------------------------------------------- */
409
410/* This Unicode character will be used as replacement character during
411 decoding if the errors argument is set to "replace". Note: the
412 Unicode character U+FFFD is the official REPLACEMENT CHARACTER in
413 Unicode 3.0. */
414
415#define Py_UNICODE_REPLACEMENT_CHARACTER ((Py_UNICODE) 0xFFFD)
416
417/* === Public API ========================================================= */
418
419/* --- Plain Py_UNICODE --------------------------------------------------- */
420
421/* Create a Unicode Object from the Py_UNICODE buffer u of the given
Marc-André Lemburg8155e0e2001-04-23 14:44:21 +0000422 size.
423
424 u may be NULL which causes the contents to be undefined. It is the
425 user's responsibility to fill in the needed data afterwards. Note
426 that modifying the Unicode object contents after construction is
427 only allowed if u was set to NULL.
Guido van Rossumd8225182000-03-10 22:33:05 +0000428
429 The buffer is copied into the new object. */
430
Mark Hammond91a681d2002-08-12 07:21:58 +0000431PyAPI_FUNC(PyObject*) PyUnicode_FromUnicode(
Guido van Rossumd8225182000-03-10 22:33:05 +0000432 const Py_UNICODE *u, /* Unicode buffer */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000433 Py_ssize_t size /* size of buffer */
Guido van Rossumd8225182000-03-10 22:33:05 +0000434 );
435
436/* Return a read-only pointer to the Unicode object's internal
437 Py_UNICODE buffer. */
438
Mark Hammond91a681d2002-08-12 07:21:58 +0000439PyAPI_FUNC(Py_UNICODE *) PyUnicode_AsUnicode(
Guido van Rossumd8225182000-03-10 22:33:05 +0000440 PyObject *unicode /* Unicode object */
441 );
442
443/* Get the length of the Unicode object. */
444
Martin v. Löwis18e16552006-02-15 17:27:45 +0000445PyAPI_FUNC(Py_ssize_t) PyUnicode_GetSize(
Guido van Rossumd8225182000-03-10 22:33:05 +0000446 PyObject *unicode /* Unicode object */
447 );
448
Martin v. Löwisce9b5a52001-06-27 06:28:56 +0000449/* Get the maximum ordinal for a Unicode character. */
Mark Hammond91a681d2002-08-12 07:21:58 +0000450PyAPI_FUNC(Py_UNICODE) PyUnicode_GetMax(void);
Martin v. Löwisce9b5a52001-06-27 06:28:56 +0000451
Guido van Rossum52c23592000-04-10 13:41:41 +0000452/* Resize an already allocated Unicode object to the new size length.
453
454 *unicode is modified to point to the new (resized) object and 0
455 returned on success.
456
457 This API may only be called by the function which also called the
458 Unicode constructor. The refcount on the object must be 1. Otherwise,
459 an error is returned.
460
461 Error handling is implemented as follows: an exception is set, -1
462 is returned and *unicode left untouched.
463
464*/
465
Mark Hammond91a681d2002-08-12 07:21:58 +0000466PyAPI_FUNC(int) PyUnicode_Resize(
Guido van Rossum52c23592000-04-10 13:41:41 +0000467 PyObject **unicode, /* Pointer to the Unicode object */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000468 Py_ssize_t length /* New length */
Guido van Rossum52c23592000-04-10 13:41:41 +0000469 );
470
Guido van Rossumd8225182000-03-10 22:33:05 +0000471/* Coerce obj to an Unicode object and return a reference with
472 *incremented* refcount.
473
474 Coercion is done in the following way:
475
Guido van Rossumb8c65bc2001-10-19 02:01:31 +0000476 1. String and other char buffer compatible objects are decoded
Fred Drakecb093fe2000-05-09 19:51:53 +0000477 under the assumptions that they contain data using the current
478 default encoding. Decoding is done in "strict" mode.
Guido van Rossumd8225182000-03-10 22:33:05 +0000479
Guido van Rossumb8c65bc2001-10-19 02:01:31 +0000480 2. All other objects (including Unicode objects) raise an
481 exception.
Guido van Rossumd8225182000-03-10 22:33:05 +0000482
483 The API returns NULL in case of an error. The caller is responsible
484 for decref'ing the returned objects.
485
486*/
487
Mark Hammond91a681d2002-08-12 07:21:58 +0000488PyAPI_FUNC(PyObject*) PyUnicode_FromEncodedObject(
Marc-André Lemburg5a5c81a2000-07-07 13:46:42 +0000489 register PyObject *obj, /* Object */
490 const char *encoding, /* encoding */
491 const char *errors /* error handling */
492 );
493
Guido van Rossumb8c65bc2001-10-19 02:01:31 +0000494/* Coerce obj to an Unicode object and return a reference with
Marc-André Lemburg5a5c81a2000-07-07 13:46:42 +0000495 *incremented* refcount.
Guido van Rossumb8c65bc2001-10-19 02:01:31 +0000496
497 Unicode objects are passed back as-is (subclasses are converted to
498 true Unicode objects), all other objects are delegated to
499 PyUnicode_FromEncodedObject(obj, NULL, "strict") which results in
500 using the default encoding as basis for decoding the object.
Marc-André Lemburg5a5c81a2000-07-07 13:46:42 +0000501
502 The API returns NULL in case of an error. The caller is responsible
503 for decref'ing the returned objects.
504
505*/
506
Mark Hammond91a681d2002-08-12 07:21:58 +0000507PyAPI_FUNC(PyObject*) PyUnicode_FromObject(
Guido van Rossumd8225182000-03-10 22:33:05 +0000508 register PyObject *obj /* Object */
509 );
510
511/* --- wchar_t support for platforms which support it --------------------- */
512
513#ifdef HAVE_WCHAR_H
514
515/* Create a Unicode Object from the whcar_t buffer w of the given
516 size.
517
518 The buffer is copied into the new object. */
519
Mark Hammond91a681d2002-08-12 07:21:58 +0000520PyAPI_FUNC(PyObject*) PyUnicode_FromWideChar(
Guido van Rossumd8225182000-03-10 22:33:05 +0000521 register const wchar_t *w, /* wchar_t buffer */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000522 Py_ssize_t size /* size of buffer */
Guido van Rossumd8225182000-03-10 22:33:05 +0000523 );
524
Marc-André Lemburga9cadcd2004-11-22 13:02:31 +0000525/* Copies the Unicode Object contents into the wchar_t buffer w. At
Guido van Rossumd8225182000-03-10 22:33:05 +0000526 most size wchar_t characters are copied.
527
Marc-André Lemburga9cadcd2004-11-22 13:02:31 +0000528 Note that the resulting wchar_t string may or may not be
529 0-terminated. It is the responsibility of the caller to make sure
530 that the wchar_t string is 0-terminated in case this is required by
531 the application.
532
533 Returns the number of wchar_t characters copied (excluding a
534 possibly trailing 0-termination character) or -1 in case of an
Guido van Rossumd8225182000-03-10 22:33:05 +0000535 error. */
536
Martin v. Löwis18e16552006-02-15 17:27:45 +0000537PyAPI_FUNC(Py_ssize_t) PyUnicode_AsWideChar(
Guido van Rossumd8225182000-03-10 22:33:05 +0000538 PyUnicodeObject *unicode, /* Unicode object */
539 register wchar_t *w, /* wchar_t buffer */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000540 Py_ssize_t size /* size of buffer */
Guido van Rossumd8225182000-03-10 22:33:05 +0000541 );
542
543#endif
544
Marc-André Lemburgcc8764c2002-08-11 12:23:04 +0000545/* --- Unicode ordinals --------------------------------------------------- */
546
547/* Create a Unicode Object from the given Unicode code point ordinal.
548
549 The ordinal must be in range(0x10000) on narrow Python builds
550 (UCS2), and range(0x110000) on wide builds (UCS4). A ValueError is
551 raised in case it is not.
552
553*/
554
Marc-André Lemburg9c329de2002-08-12 08:19:10 +0000555PyAPI_FUNC(PyObject*) PyUnicode_FromOrdinal(int ordinal);
Marc-André Lemburgcc8764c2002-08-11 12:23:04 +0000556
Guido van Rossumd8225182000-03-10 22:33:05 +0000557/* === Builtin Codecs =====================================================
558
559 Many of these APIs take two arguments encoding and errors. These
560 parameters encoding and errors have the same semantics as the ones
561 of the builtin unicode() API.
562
Fred Drakecb093fe2000-05-09 19:51:53 +0000563 Setting encoding to NULL causes the default encoding to be used.
Guido van Rossumd8225182000-03-10 22:33:05 +0000564
565 Error handling is set by errors which may also be set to NULL
566 meaning to use the default handling defined for the codec. Default
567 error handling for all builtin codecs is "strict" (ValueErrors are
568 raised).
569
570 The codecs all use a similar interface. Only deviation from the
571 generic ones are documented.
572
573*/
574
Fred Drakecb093fe2000-05-09 19:51:53 +0000575/* --- Manage the default encoding ---------------------------------------- */
576
Jeremy Hylton3ce45382001-07-30 22:34:24 +0000577/* Return a Python string holding the default encoded value of the
578 Unicode object.
579
580 The resulting string is cached in the Unicode object for subsequent
581 usage by this function. The cached version is needed to implement
582 the character buffer interface and will live (at least) as long as
583 the Unicode object itself.
584
585 The refcount of the string is *not* incremented.
586
587 *** Exported for internal use by the interpreter only !!! ***
588
589*/
590
Mark Hammond91a681d2002-08-12 07:21:58 +0000591PyAPI_FUNC(PyObject *) _PyUnicode_AsDefaultEncodedString(
Jeremy Hylton3ce45382001-07-30 22:34:24 +0000592 PyObject *, const char *);
593
Fred Drakecb093fe2000-05-09 19:51:53 +0000594/* Returns the currently active default encoding.
595
596 The default encoding is currently implemented as run-time settable
597 process global. This may change in future versions of the
598 interpreter to become a parameter which is managed on a per-thread
599 basis.
600
601 */
602
Mark Hammond91a681d2002-08-12 07:21:58 +0000603PyAPI_FUNC(const char*) PyUnicode_GetDefaultEncoding(void);
Fred Drakecb093fe2000-05-09 19:51:53 +0000604
605/* Sets the currently active default encoding.
606
607 Returns 0 on success, -1 in case of an error.
608
609 */
610
Mark Hammond91a681d2002-08-12 07:21:58 +0000611PyAPI_FUNC(int) PyUnicode_SetDefaultEncoding(
Fred Drakecb093fe2000-05-09 19:51:53 +0000612 const char *encoding /* Encoding name in standard form */
613 );
614
Guido van Rossumd8225182000-03-10 22:33:05 +0000615/* --- Generic Codecs ----------------------------------------------------- */
616
617/* Create a Unicode object by decoding the encoded string s of the
618 given size. */
619
Mark Hammond91a681d2002-08-12 07:21:58 +0000620PyAPI_FUNC(PyObject*) PyUnicode_Decode(
Guido van Rossumd8225182000-03-10 22:33:05 +0000621 const char *s, /* encoded string */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000622 Py_ssize_t size, /* size of buffer */
Guido van Rossumd8225182000-03-10 22:33:05 +0000623 const char *encoding, /* encoding */
624 const char *errors /* error handling */
625 );
626
627/* Encodes a Py_UNICODE buffer of the given size and returns a
628 Python string object. */
629
Mark Hammond91a681d2002-08-12 07:21:58 +0000630PyAPI_FUNC(PyObject*) PyUnicode_Encode(
Guido van Rossumd8225182000-03-10 22:33:05 +0000631 const Py_UNICODE *s, /* Unicode char buffer */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000632 Py_ssize_t size, /* number of Py_UNICODE chars to encode */
Guido van Rossumd8225182000-03-10 22:33:05 +0000633 const char *encoding, /* encoding */
634 const char *errors /* error handling */
635 );
636
Marc-André Lemburgd2d45982004-07-08 17:57:32 +0000637/* Encodes a Unicode object and returns the result as Python
638 object. */
639
640PyAPI_FUNC(PyObject*) PyUnicode_AsEncodedObject(
641 PyObject *unicode, /* Unicode object */
642 const char *encoding, /* encoding */
643 const char *errors /* error handling */
644 );
645
Guido van Rossumd8225182000-03-10 22:33:05 +0000646/* Encodes a Unicode object and returns the result as Python string
647 object. */
648
Mark Hammond91a681d2002-08-12 07:21:58 +0000649PyAPI_FUNC(PyObject*) PyUnicode_AsEncodedString(
Guido van Rossumd8225182000-03-10 22:33:05 +0000650 PyObject *unicode, /* Unicode object */
651 const char *encoding, /* encoding */
652 const char *errors /* error handling */
653 );
654
Marc-André Lemburgc60e6f72001-09-20 10:35:46 +0000655/* --- UTF-7 Codecs ------------------------------------------------------- */
656
Mark Hammond91a681d2002-08-12 07:21:58 +0000657PyAPI_FUNC(PyObject*) PyUnicode_DecodeUTF7(
Marc-André Lemburgc60e6f72001-09-20 10:35:46 +0000658 const char *string, /* UTF-7 encoded string */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000659 Py_ssize_t length, /* size of string */
Marc-André Lemburgc60e6f72001-09-20 10:35:46 +0000660 const char *errors /* error handling */
661 );
662
Mark Hammond91a681d2002-08-12 07:21:58 +0000663PyAPI_FUNC(PyObject*) PyUnicode_EncodeUTF7(
Marc-André Lemburgc60e6f72001-09-20 10:35:46 +0000664 const Py_UNICODE *data, /* Unicode char buffer */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000665 Py_ssize_t length, /* number of Py_UNICODE chars to encode */
Marc-André Lemburgc60e6f72001-09-20 10:35:46 +0000666 int encodeSetO, /* force the encoder to encode characters in
667 Set O, as described in RFC2152 */
668 int encodeWhiteSpace, /* force the encoder to encode space, tab,
669 carriage return and linefeed characters */
670 const char *errors /* error handling */
671 );
672
Guido van Rossumd8225182000-03-10 22:33:05 +0000673/* --- UTF-8 Codecs ------------------------------------------------------- */
674
Mark Hammond91a681d2002-08-12 07:21:58 +0000675PyAPI_FUNC(PyObject*) PyUnicode_DecodeUTF8(
Guido van Rossumd8225182000-03-10 22:33:05 +0000676 const char *string, /* UTF-8 encoded string */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000677 Py_ssize_t length, /* size of string */
Guido van Rossumd8225182000-03-10 22:33:05 +0000678 const char *errors /* error handling */
679 );
680
Walter Dörwald69652032004-09-07 20:24:22 +0000681PyAPI_FUNC(PyObject*) PyUnicode_DecodeUTF8Stateful(
682 const char *string, /* UTF-8 encoded string */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000683 Py_ssize_t length, /* size of string */
Walter Dörwald69652032004-09-07 20:24:22 +0000684 const char *errors, /* error handling */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000685 Py_ssize_t *consumed /* bytes consumed */
Walter Dörwald69652032004-09-07 20:24:22 +0000686 );
687
Mark Hammond91a681d2002-08-12 07:21:58 +0000688PyAPI_FUNC(PyObject*) PyUnicode_AsUTF8String(
Guido van Rossumd8225182000-03-10 22:33:05 +0000689 PyObject *unicode /* Unicode object */
690 );
691
Mark Hammond91a681d2002-08-12 07:21:58 +0000692PyAPI_FUNC(PyObject*) PyUnicode_EncodeUTF8(
Guido van Rossumd8225182000-03-10 22:33:05 +0000693 const Py_UNICODE *data, /* Unicode char buffer */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000694 Py_ssize_t length, /* number of Py_UNICODE chars to encode */
Guido van Rossumd8225182000-03-10 22:33:05 +0000695 const char *errors /* error handling */
696 );
697
698/* --- UTF-16 Codecs ------------------------------------------------------ */
699
Guido van Rossum9e896b32000-04-05 20:11:21 +0000700/* Decodes length bytes from a UTF-16 encoded buffer string and returns
Guido van Rossumd8225182000-03-10 22:33:05 +0000701 the corresponding Unicode object.
702
703 errors (if non-NULL) defines the error handling. It defaults
704 to "strict".
705
706 If byteorder is non-NULL, the decoder starts decoding using the
707 given byte order:
708
709 *byteorder == -1: little endian
710 *byteorder == 0: native order
711 *byteorder == 1: big endian
712
Marc-André Lemburg489b56e2001-05-21 20:30:15 +0000713 In native mode, the first two bytes of the stream are checked for a
714 BOM mark. If found, the BOM mark is analysed, the byte order
715 adjusted and the BOM skipped. In the other modes, no BOM mark
716 interpretation is done. After completion, *byteorder is set to the
717 current byte order at the end of input data.
Guido van Rossumd8225182000-03-10 22:33:05 +0000718
719 If byteorder is NULL, the codec starts in native order mode.
720
721*/
722
Mark Hammond91a681d2002-08-12 07:21:58 +0000723PyAPI_FUNC(PyObject*) PyUnicode_DecodeUTF16(
Guido van Rossumd8225182000-03-10 22:33:05 +0000724 const char *string, /* UTF-16 encoded string */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000725 Py_ssize_t length, /* size of string */
Guido van Rossumd8225182000-03-10 22:33:05 +0000726 const char *errors, /* error handling */
727 int *byteorder /* pointer to byteorder to use
728 0=native;-1=LE,1=BE; updated on
729 exit */
730 );
731
Walter Dörwald69652032004-09-07 20:24:22 +0000732PyAPI_FUNC(PyObject*) PyUnicode_DecodeUTF16Stateful(
733 const char *string, /* UTF-16 encoded string */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000734 Py_ssize_t length, /* size of string */
Walter Dörwald69652032004-09-07 20:24:22 +0000735 const char *errors, /* error handling */
736 int *byteorder, /* pointer to byteorder to use
737 0=native;-1=LE,1=BE; updated on
738 exit */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000739 Py_ssize_t *consumed /* bytes consumed */
Walter Dörwald69652032004-09-07 20:24:22 +0000740 );
741
Guido van Rossumd8225182000-03-10 22:33:05 +0000742/* Returns a Python string using the UTF-16 encoding in native byte
743 order. The string always starts with a BOM mark. */
744
Mark Hammond91a681d2002-08-12 07:21:58 +0000745PyAPI_FUNC(PyObject*) PyUnicode_AsUTF16String(
Guido van Rossumd8225182000-03-10 22:33:05 +0000746 PyObject *unicode /* Unicode object */
747 );
748
749/* Returns a Python string object holding the UTF-16 encoded value of
Guido van Rossum9e896b32000-04-05 20:11:21 +0000750 the Unicode data.
Guido van Rossumd8225182000-03-10 22:33:05 +0000751
752 If byteorder is not 0, output is written according to the following
753 byte order:
754
755 byteorder == -1: little endian
756 byteorder == 0: native byte order (writes a BOM mark)
757 byteorder == 1: big endian
758
759 If byteorder is 0, the output string will always start with the
760 Unicode BOM mark (U+FEFF). In the other two modes, no BOM mark is
761 prepended.
762
763 Note that Py_UNICODE data is being interpreted as UTF-16 reduced to
764 UCS-2. This trick makes it possible to add full UTF-16 capabilities
Thomas Wouters7e474022000-07-16 12:04:32 +0000765 at a later point without compromising the APIs.
Guido van Rossumd8225182000-03-10 22:33:05 +0000766
767*/
768
Mark Hammond91a681d2002-08-12 07:21:58 +0000769PyAPI_FUNC(PyObject*) PyUnicode_EncodeUTF16(
Guido van Rossumd8225182000-03-10 22:33:05 +0000770 const Py_UNICODE *data, /* Unicode char buffer */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000771 Py_ssize_t length, /* number of Py_UNICODE chars to encode */
Guido van Rossumd8225182000-03-10 22:33:05 +0000772 const char *errors, /* error handling */
773 int byteorder /* byteorder to use 0=BOM+native;-1=LE,1=BE */
774 );
775
776/* --- Unicode-Escape Codecs ---------------------------------------------- */
777
Mark Hammond91a681d2002-08-12 07:21:58 +0000778PyAPI_FUNC(PyObject*) PyUnicode_DecodeUnicodeEscape(
Guido van Rossumd8225182000-03-10 22:33:05 +0000779 const char *string, /* Unicode-Escape encoded string */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000780 Py_ssize_t length, /* size of string */
Guido van Rossumd8225182000-03-10 22:33:05 +0000781 const char *errors /* error handling */
782 );
783
Mark Hammond91a681d2002-08-12 07:21:58 +0000784PyAPI_FUNC(PyObject*) PyUnicode_AsUnicodeEscapeString(
Guido van Rossumd8225182000-03-10 22:33:05 +0000785 PyObject *unicode /* Unicode object */
786 );
787
Mark Hammond91a681d2002-08-12 07:21:58 +0000788PyAPI_FUNC(PyObject*) PyUnicode_EncodeUnicodeEscape(
Guido van Rossumd8225182000-03-10 22:33:05 +0000789 const Py_UNICODE *data, /* Unicode char buffer */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000790 Py_ssize_t length /* Number of Py_UNICODE chars to encode */
Guido van Rossumd8225182000-03-10 22:33:05 +0000791 );
792
793/* --- Raw-Unicode-Escape Codecs ------------------------------------------ */
794
Mark Hammond91a681d2002-08-12 07:21:58 +0000795PyAPI_FUNC(PyObject*) PyUnicode_DecodeRawUnicodeEscape(
Guido van Rossumd8225182000-03-10 22:33:05 +0000796 const char *string, /* Raw-Unicode-Escape encoded string */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000797 Py_ssize_t length, /* size of string */
Guido van Rossumd8225182000-03-10 22:33:05 +0000798 const char *errors /* error handling */
799 );
800
Mark Hammond91a681d2002-08-12 07:21:58 +0000801PyAPI_FUNC(PyObject*) PyUnicode_AsRawUnicodeEscapeString(
Guido van Rossumd8225182000-03-10 22:33:05 +0000802 PyObject *unicode /* Unicode object */
803 );
804
Mark Hammond91a681d2002-08-12 07:21:58 +0000805PyAPI_FUNC(PyObject*) PyUnicode_EncodeRawUnicodeEscape(
Guido van Rossumd8225182000-03-10 22:33:05 +0000806 const Py_UNICODE *data, /* Unicode char buffer */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000807 Py_ssize_t length /* Number of Py_UNICODE chars to encode */
Guido van Rossumd8225182000-03-10 22:33:05 +0000808 );
809
Walter Dörwalda47d1c02005-08-30 10:23:14 +0000810/* --- Unicode Internal Codec ---------------------------------------------
811
812 Only for internal use in _codecsmodule.c */
813
814PyObject *_PyUnicode_DecodeUnicodeInternal(
815 const char *string,
Martin v. Löwis18e16552006-02-15 17:27:45 +0000816 Py_ssize_t length,
Walter Dörwalda47d1c02005-08-30 10:23:14 +0000817 const char *errors
818 );
819
Guido van Rossumd8225182000-03-10 22:33:05 +0000820/* --- Latin-1 Codecs -----------------------------------------------------
821
822 Note: Latin-1 corresponds to the first 256 Unicode ordinals.
823
824*/
825
Mark Hammond91a681d2002-08-12 07:21:58 +0000826PyAPI_FUNC(PyObject*) PyUnicode_DecodeLatin1(
Guido van Rossumd8225182000-03-10 22:33:05 +0000827 const char *string, /* Latin-1 encoded string */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000828 Py_ssize_t length, /* size of string */
Guido van Rossumd8225182000-03-10 22:33:05 +0000829 const char *errors /* error handling */
830 );
831
Mark Hammond91a681d2002-08-12 07:21:58 +0000832PyAPI_FUNC(PyObject*) PyUnicode_AsLatin1String(
Guido van Rossumd8225182000-03-10 22:33:05 +0000833 PyObject *unicode /* Unicode object */
834 );
835
Mark Hammond91a681d2002-08-12 07:21:58 +0000836PyAPI_FUNC(PyObject*) PyUnicode_EncodeLatin1(
Guido van Rossumd8225182000-03-10 22:33:05 +0000837 const Py_UNICODE *data, /* Unicode char buffer */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000838 Py_ssize_t length, /* Number of Py_UNICODE chars to encode */
Guido van Rossumd8225182000-03-10 22:33:05 +0000839 const char *errors /* error handling */
840 );
841
842/* --- ASCII Codecs -------------------------------------------------------
843
844 Only 7-bit ASCII data is excepted. All other codes generate errors.
845
846*/
847
Mark Hammond91a681d2002-08-12 07:21:58 +0000848PyAPI_FUNC(PyObject*) PyUnicode_DecodeASCII(
Guido van Rossumd8225182000-03-10 22:33:05 +0000849 const char *string, /* ASCII encoded string */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000850 Py_ssize_t length, /* size of string */
Guido van Rossumd8225182000-03-10 22:33:05 +0000851 const char *errors /* error handling */
852 );
853
Mark Hammond91a681d2002-08-12 07:21:58 +0000854PyAPI_FUNC(PyObject*) PyUnicode_AsASCIIString(
Guido van Rossumd8225182000-03-10 22:33:05 +0000855 PyObject *unicode /* Unicode object */
856 );
857
Mark Hammond91a681d2002-08-12 07:21:58 +0000858PyAPI_FUNC(PyObject*) PyUnicode_EncodeASCII(
Guido van Rossumd8225182000-03-10 22:33:05 +0000859 const Py_UNICODE *data, /* Unicode char buffer */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000860 Py_ssize_t length, /* Number of Py_UNICODE chars to encode */
Guido van Rossumd8225182000-03-10 22:33:05 +0000861 const char *errors /* error handling */
862 );
863
864/* --- Character Map Codecs -----------------------------------------------
865
866 This codec uses mappings to encode and decode characters.
867
868 Decoding mappings must map single string characters to single
869 Unicode characters, integers (which are then interpreted as Unicode
870 ordinals) or None (meaning "undefined mapping" and causing an
871 error).
872
873 Encoding mappings must map single Unicode characters to single
874 string characters, integers (which are then interpreted as Latin-1
875 ordinals) or None (meaning "undefined mapping" and causing an
876 error).
877
878 If a character lookup fails with a LookupError, the character is
879 copied as-is meaning that its ordinal value will be interpreted as
880 Unicode or Latin-1 ordinal resp. Because of this mappings only need
881 to contain those mappings which map characters to different code
882 points.
883
884*/
885
Mark Hammond91a681d2002-08-12 07:21:58 +0000886PyAPI_FUNC(PyObject*) PyUnicode_DecodeCharmap(
Guido van Rossumd8225182000-03-10 22:33:05 +0000887 const char *string, /* Encoded string */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000888 Py_ssize_t length, /* size of string */
Guido van Rossumd8225182000-03-10 22:33:05 +0000889 PyObject *mapping, /* character mapping
890 (char ordinal -> unicode ordinal) */
891 const char *errors /* error handling */
892 );
893
Mark Hammond91a681d2002-08-12 07:21:58 +0000894PyAPI_FUNC(PyObject*) PyUnicode_AsCharmapString(
Guido van Rossumd8225182000-03-10 22:33:05 +0000895 PyObject *unicode, /* Unicode object */
896 PyObject *mapping /* character mapping
897 (unicode ordinal -> char ordinal) */
898 );
899
Mark Hammond91a681d2002-08-12 07:21:58 +0000900PyAPI_FUNC(PyObject*) PyUnicode_EncodeCharmap(
Guido van Rossumd8225182000-03-10 22:33:05 +0000901 const Py_UNICODE *data, /* Unicode char buffer */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000902 Py_ssize_t length, /* Number of Py_UNICODE chars to encode */
Guido van Rossumd8225182000-03-10 22:33:05 +0000903 PyObject *mapping, /* character mapping
904 (unicode ordinal -> char ordinal) */
905 const char *errors /* error handling */
906 );
907
908/* Translate a Py_UNICODE buffer of the given length by applying a
909 character mapping table to it and return the resulting Unicode
910 object.
911
912 The mapping table must map Unicode ordinal integers to Unicode
913 ordinal integers or None (causing deletion of the character).
914
915 Mapping tables may be dictionaries or sequences. Unmapped character
916 ordinals (ones which cause a LookupError) are left untouched and
917 are copied as-is.
918
919*/
920
Mark Hammond91a681d2002-08-12 07:21:58 +0000921PyAPI_FUNC(PyObject *) PyUnicode_TranslateCharmap(
Guido van Rossumd8225182000-03-10 22:33:05 +0000922 const Py_UNICODE *data, /* Unicode char buffer */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000923 Py_ssize_t length, /* Number of Py_UNICODE chars to encode */
Guido van Rossumd8225182000-03-10 22:33:05 +0000924 PyObject *table, /* Translate table */
925 const char *errors /* error handling */
926 );
927
Guido van Rossumefec1152000-03-28 02:01:15 +0000928#ifdef MS_WIN32
Guido van Rossum24bdb042000-03-28 20:29:59 +0000929
Guido van Rossumefec1152000-03-28 02:01:15 +0000930/* --- MBCS codecs for Windows -------------------------------------------- */
Guido van Rossum24bdb042000-03-28 20:29:59 +0000931
Mark Hammond91a681d2002-08-12 07:21:58 +0000932PyAPI_FUNC(PyObject*) PyUnicode_DecodeMBCS(
Guido van Rossumefec1152000-03-28 02:01:15 +0000933 const char *string, /* MBCS encoded string */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000934 Py_ssize_t length, /* size of string */
Guido van Rossumefec1152000-03-28 02:01:15 +0000935 const char *errors /* error handling */
936 );
937
Mark Hammond91a681d2002-08-12 07:21:58 +0000938PyAPI_FUNC(PyObject*) PyUnicode_AsMBCSString(
Guido van Rossumefec1152000-03-28 02:01:15 +0000939 PyObject *unicode /* Unicode object */
940 );
941
Mark Hammond91a681d2002-08-12 07:21:58 +0000942PyAPI_FUNC(PyObject*) PyUnicode_EncodeMBCS(
Guido van Rossumefec1152000-03-28 02:01:15 +0000943 const Py_UNICODE *data, /* Unicode char buffer */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000944 Py_ssize_t length, /* Number of Py_UNICODE chars to encode */
Guido van Rossumefec1152000-03-28 02:01:15 +0000945 const char *errors /* error handling */
946 );
947
Guido van Rossumefec1152000-03-28 02:01:15 +0000948#endif /* MS_WIN32 */
Guido van Rossum24bdb042000-03-28 20:29:59 +0000949
Guido van Rossum9e896b32000-04-05 20:11:21 +0000950/* --- Decimal Encoder ---------------------------------------------------- */
951
952/* Takes a Unicode string holding a decimal value and writes it into
953 an output buffer using standard ASCII digit codes.
954
955 The output buffer has to provide at least length+1 bytes of storage
956 area. The output string is 0-terminated.
957
958 The encoder converts whitespace to ' ', decimal characters to their
959 corresponding ASCII digit and all other Latin-1 characters except
960 \0 as-is. Characters outside this range (Unicode ordinals 1-256)
961 are treated as errors. This includes embedded NULL bytes.
962
963 Error handling is defined by the errors argument:
964
965 NULL or "strict": raise a ValueError
966 "ignore": ignore the wrong characters (these are not copied to the
967 output buffer)
968 "replace": replaces illegal characters with '?'
969
970 Returns 0 on success, -1 on failure.
971
972*/
973
Mark Hammond91a681d2002-08-12 07:21:58 +0000974PyAPI_FUNC(int) PyUnicode_EncodeDecimal(
Guido van Rossum9e896b32000-04-05 20:11:21 +0000975 Py_UNICODE *s, /* Unicode buffer */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000976 Py_ssize_t length, /* Number of Py_UNICODE chars to encode */
Guido van Rossum9e896b32000-04-05 20:11:21 +0000977 char *output, /* Output buffer; must have size >= length */
978 const char *errors /* error handling */
979 );
980
Guido van Rossumd8225182000-03-10 22:33:05 +0000981/* --- Methods & Slots ----------------------------------------------------
982
983 These are capable of handling Unicode objects and strings on input
984 (we refer to them as strings in the descriptions) and return
985 Unicode objects or integers as apporpriate. */
986
987/* Concat two strings giving a new Unicode string. */
988
Mark Hammond91a681d2002-08-12 07:21:58 +0000989PyAPI_FUNC(PyObject*) PyUnicode_Concat(
Guido van Rossumd8225182000-03-10 22:33:05 +0000990 PyObject *left, /* Left string */
991 PyObject *right /* Right string */
992 );
993
994/* Split a string giving a list of Unicode strings.
995
996 If sep is NULL, splitting will be done at all whitespace
997 substrings. Otherwise, splits occur at the given separator.
998
999 At most maxsplit splits will be done. If negative, no limit is set.
1000
1001 Separators are not included in the resulting list.
1002
1003*/
1004
Mark Hammond91a681d2002-08-12 07:21:58 +00001005PyAPI_FUNC(PyObject*) PyUnicode_Split(
Guido van Rossumd8225182000-03-10 22:33:05 +00001006 PyObject *s, /* String to split */
1007 PyObject *sep, /* String separator */
Martin v. Löwis18e16552006-02-15 17:27:45 +00001008 Py_ssize_t maxsplit /* Maxsplit count */
Guido van Rossumd8225182000-03-10 22:33:05 +00001009 );
1010
1011/* Dito, but split at line breaks.
1012
1013 CRLF is considered to be one line break. Line breaks are not
1014 included in the resulting list. */
1015
Mark Hammond91a681d2002-08-12 07:21:58 +00001016PyAPI_FUNC(PyObject*) PyUnicode_Splitlines(
Guido van Rossumd8225182000-03-10 22:33:05 +00001017 PyObject *s, /* String to split */
Guido van Rossum004d64f2000-04-11 15:39:46 +00001018 int keepends /* If true, line end markers are included */
Guido van Rossumd8225182000-03-10 22:33:05 +00001019 );
1020
Hye-Shik Chang3ae811b2003-12-15 18:49:53 +00001021/* Split a string giving a list of Unicode strings.
1022
1023 If sep is NULL, splitting will be done at all whitespace
1024 substrings. Otherwise, splits occur at the given separator.
1025
1026 At most maxsplit splits will be done. But unlike PyUnicode_Split
1027 PyUnicode_RSplit splits from the end of the string. If negative,
1028 no limit is set.
1029
1030 Separators are not included in the resulting list.
1031
1032*/
1033
1034PyAPI_FUNC(PyObject*) PyUnicode_RSplit(
1035 PyObject *s, /* String to split */
1036 PyObject *sep, /* String separator */
Martin v. Löwis18e16552006-02-15 17:27:45 +00001037 Py_ssize_t maxsplit /* Maxsplit count */
Hye-Shik Chang3ae811b2003-12-15 18:49:53 +00001038 );
1039
Guido van Rossumd8225182000-03-10 22:33:05 +00001040/* Translate a string by applying a character mapping table to it and
1041 return the resulting Unicode object.
1042
1043 The mapping table must map Unicode ordinal integers to Unicode
1044 ordinal integers or None (causing deletion of the character).
1045
1046 Mapping tables may be dictionaries or sequences. Unmapped character
1047 ordinals (ones which cause a LookupError) are left untouched and
1048 are copied as-is.
1049
1050*/
1051
Mark Hammond91a681d2002-08-12 07:21:58 +00001052PyAPI_FUNC(PyObject *) PyUnicode_Translate(
Guido van Rossumd8225182000-03-10 22:33:05 +00001053 PyObject *str, /* String */
1054 PyObject *table, /* Translate table */
1055 const char *errors /* error handling */
1056 );
1057
1058/* Join a sequence of strings using the given separator and return
1059 the resulting Unicode string. */
1060
Mark Hammond91a681d2002-08-12 07:21:58 +00001061PyAPI_FUNC(PyObject*) PyUnicode_Join(
Guido van Rossumd8225182000-03-10 22:33:05 +00001062 PyObject *separator, /* Separator string */
1063 PyObject *seq /* Sequence object */
1064 );
1065
1066/* Return 1 if substr matches str[start:end] at the given tail end, 0
1067 otherwise. */
1068
Martin v. Löwis18e16552006-02-15 17:27:45 +00001069PyAPI_FUNC(Py_ssize_t) PyUnicode_Tailmatch(
Guido van Rossumd8225182000-03-10 22:33:05 +00001070 PyObject *str, /* String */
1071 PyObject *substr, /* Prefix or Suffix string */
Martin v. Löwis18e16552006-02-15 17:27:45 +00001072 Py_ssize_t start, /* Start index */
1073 Py_ssize_t end, /* Stop index */
Guido van Rossumd8225182000-03-10 22:33:05 +00001074 int direction /* Tail end: -1 prefix, +1 suffix */
1075 );
1076
1077/* Return the first position of substr in str[start:end] using the
Marc-André Lemburg4da6fd62002-05-29 11:33:13 +00001078 given search direction or -1 if not found. -2 is returned in case
1079 an error occurred and an exception is set. */
Guido van Rossumd8225182000-03-10 22:33:05 +00001080
Martin v. Löwis18e16552006-02-15 17:27:45 +00001081PyAPI_FUNC(Py_ssize_t) PyUnicode_Find(
Guido van Rossumd8225182000-03-10 22:33:05 +00001082 PyObject *str, /* String */
1083 PyObject *substr, /* Substring to find */
Martin v. Löwis18e16552006-02-15 17:27:45 +00001084 Py_ssize_t start, /* Start index */
1085 Py_ssize_t end, /* Stop index */
Guido van Rossumd8225182000-03-10 22:33:05 +00001086 int direction /* Find direction: +1 forward, -1 backward */
1087 );
1088
Barry Warsaw51ac5802000-03-20 16:36:48 +00001089/* Count the number of occurrences of substr in str[start:end]. */
Guido van Rossumd8225182000-03-10 22:33:05 +00001090
Martin v. Löwis18e16552006-02-15 17:27:45 +00001091PyAPI_FUNC(Py_ssize_t) PyUnicode_Count(
Guido van Rossumd8225182000-03-10 22:33:05 +00001092 PyObject *str, /* String */
1093 PyObject *substr, /* Substring to count */
Martin v. Löwis18e16552006-02-15 17:27:45 +00001094 Py_ssize_t start, /* Start index */
1095 Py_ssize_t end /* Stop index */
Guido van Rossumd8225182000-03-10 22:33:05 +00001096 );
1097
Barry Warsaw51ac5802000-03-20 16:36:48 +00001098/* Replace at most maxcount occurrences of substr in str with replstr
Guido van Rossumd8225182000-03-10 22:33:05 +00001099 and return the resulting Unicode object. */
1100
Mark Hammond91a681d2002-08-12 07:21:58 +00001101PyAPI_FUNC(PyObject *) PyUnicode_Replace(
Guido van Rossumd8225182000-03-10 22:33:05 +00001102 PyObject *str, /* String */
1103 PyObject *substr, /* Substring to find */
1104 PyObject *replstr, /* Substring to replace */
Martin v. Löwis18e16552006-02-15 17:27:45 +00001105 Py_ssize_t maxcount /* Max. number of replacements to apply;
Guido van Rossumd8225182000-03-10 22:33:05 +00001106 -1 = all */
1107 );
1108
1109/* Compare two strings and return -1, 0, 1 for less than, equal,
1110 greater than resp. */
1111
Mark Hammond91a681d2002-08-12 07:21:58 +00001112PyAPI_FUNC(int) PyUnicode_Compare(
Guido van Rossumd8225182000-03-10 22:33:05 +00001113 PyObject *left, /* Left string */
1114 PyObject *right /* Right string */
1115 );
1116
Thomas Wouters7e474022000-07-16 12:04:32 +00001117/* Apply a argument tuple or dictionary to a format string and return
Guido van Rossumd8225182000-03-10 22:33:05 +00001118 the resulting Unicode string. */
1119
Mark Hammond91a681d2002-08-12 07:21:58 +00001120PyAPI_FUNC(PyObject *) PyUnicode_Format(
Guido van Rossumd8225182000-03-10 22:33:05 +00001121 PyObject *format, /* Format string */
1122 PyObject *args /* Argument tuple or dictionary */
1123 );
1124
Guido van Rossumd0d366b2000-03-13 23:22:24 +00001125/* Checks whether element is contained in container and return 1/0
1126 accordingly.
1127
1128 element has to coerce to an one element Unicode string. -1 is
1129 returned in case of an error. */
1130
Mark Hammond91a681d2002-08-12 07:21:58 +00001131PyAPI_FUNC(int) PyUnicode_Contains(
Guido van Rossumd0d366b2000-03-13 23:22:24 +00001132 PyObject *container, /* Container string */
1133 PyObject *element /* Element string */
1134 );
1135
Walter Dörwaldde02bcb2002-04-22 17:42:37 +00001136/* Externally visible for str.strip(unicode) */
Mark Hammond91a681d2002-08-12 07:21:58 +00001137PyAPI_FUNC(PyObject *) _PyUnicode_XStrip(
Walter Dörwaldde02bcb2002-04-22 17:42:37 +00001138 PyUnicodeObject *self,
1139 int striptype,
1140 PyObject *sepobj
1141 );
1142
Guido van Rossumd8225182000-03-10 22:33:05 +00001143/* === Characters Type APIs =============================================== */
1144
1145/* These should not be used directly. Use the Py_UNICODE_IS* and
1146 Py_UNICODE_TO* macros instead.
1147
1148 These APIs are implemented in Objects/unicodectype.c.
1149
1150*/
1151
Mark Hammond91a681d2002-08-12 07:21:58 +00001152PyAPI_FUNC(int) _PyUnicode_IsLowercase(
Fredrik Lundh72b06852001-06-27 22:08:26 +00001153 Py_UNICODE ch /* Unicode character */
Guido van Rossumd8225182000-03-10 22:33:05 +00001154 );
1155
Mark Hammond91a681d2002-08-12 07:21:58 +00001156PyAPI_FUNC(int) _PyUnicode_IsUppercase(
Fredrik Lundh72b06852001-06-27 22:08:26 +00001157 Py_UNICODE ch /* Unicode character */
Guido van Rossumd8225182000-03-10 22:33:05 +00001158 );
1159
Mark Hammond91a681d2002-08-12 07:21:58 +00001160PyAPI_FUNC(int) _PyUnicode_IsTitlecase(
Fredrik Lundh72b06852001-06-27 22:08:26 +00001161 Py_UNICODE ch /* Unicode character */
Guido van Rossumd8225182000-03-10 22:33:05 +00001162 );
1163
Mark Hammond91a681d2002-08-12 07:21:58 +00001164PyAPI_FUNC(int) _PyUnicode_IsWhitespace(
Tim Peters2576c972005-10-29 02:33:18 +00001165 const Py_UNICODE ch /* Unicode character */
Guido van Rossumd8225182000-03-10 22:33:05 +00001166 );
1167
Mark Hammond91a681d2002-08-12 07:21:58 +00001168PyAPI_FUNC(int) _PyUnicode_IsLinebreak(
Tim Peters2576c972005-10-29 02:33:18 +00001169 const Py_UNICODE ch /* Unicode character */
Guido van Rossumd8225182000-03-10 22:33:05 +00001170 );
1171
Mark Hammond91a681d2002-08-12 07:21:58 +00001172PyAPI_FUNC(Py_UNICODE) _PyUnicode_ToLowercase(
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(Py_UNICODE) _PyUnicode_ToUppercase(
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(Py_UNICODE) _PyUnicode_ToTitlecase(
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_ToDecimalDigit(
Fredrik Lundh72b06852001-06-27 22:08:26 +00001185 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_ToDigit(
Fredrik Lundh72b06852001-06-27 22:08:26 +00001189 Py_UNICODE ch /* Unicode character */
Guido van Rossumd8225182000-03-10 22:33:05 +00001190 );
1191
Mark Hammond91a681d2002-08-12 07:21:58 +00001192PyAPI_FUNC(double) _PyUnicode_ToNumeric(
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(int) _PyUnicode_IsDecimalDigit(
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(int) _PyUnicode_IsDigit(
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_IsNumeric(
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_IsAlpha(
Fredrik Lundh72b06852001-06-27 22:08:26 +00001209 Py_UNICODE ch /* Unicode character */
Marc-André Lemburgf03e7412000-07-05 09:45:59 +00001210 );
1211
Guido van Rossumd8225182000-03-10 22:33:05 +00001212#ifdef __cplusplus
1213}
1214#endif
Martin v. Löwis339d0f72001-08-17 18:39:25 +00001215#endif /* Py_USING_UNICODE */
Guido van Rossumd8225182000-03-10 22:33:05 +00001216#endif /* !Py_UNICODEOBJECT_H */