blob: 607feea81c39345b6a65c38dfaf7bb409af9f8e3 [file] [log] [blame]
Guido van Rossumfeee4b92000-03-10 22:57:27 +00001/* ------------------------------------------------------------------------
2
3 Python Codec Registry and support functions
4
5Written by Marc-Andre Lemburg (mal@lemburg.com).
6
Guido van Rossum16b1ad92000-08-03 16:24:25 +00007Copyright (c) Corporation for National Research Initiatives.
Guido van Rossumfeee4b92000-03-10 22:57:27 +00008
9 ------------------------------------------------------------------------ */
10
11#include "Python.h"
12#include <ctype.h>
13
Victor Stinnerf5cff562011-10-14 02:13:11 +020014const char *Py_hexdigits = "0123456789abcdef";
15
Guido van Rossumfeee4b92000-03-10 22:57:27 +000016/* --- Codec Registry ----------------------------------------------------- */
17
18/* Import the standard encodings package which will register the first
Guido van Rossum98297ee2007-11-06 21:34:58 +000019 codec search function.
Guido van Rossumfeee4b92000-03-10 22:57:27 +000020
21 This is done in a lazy way so that the Unicode implementation does
22 not downgrade startup time of scripts not needing it.
23
Guido van Rossumb95de4f2000-03-31 17:25:23 +000024 ImportErrors are silently ignored by this function. Only one try is
25 made.
Guido van Rossumfeee4b92000-03-10 22:57:27 +000026
27*/
28
Gustavo Niemeyer5ddd4c32003-03-19 00:35:36 +000029static int _PyCodecRegistry_Init(void); /* Forward */
Guido van Rossumfeee4b92000-03-10 22:57:27 +000030
Guido van Rossumfeee4b92000-03-10 22:57:27 +000031int PyCodec_Register(PyObject *search_function)
32{
Nicholas Bastine5662ae2004-03-24 22:22:12 +000033 PyInterpreterState *interp = PyThreadState_GET()->interp;
Gustavo Niemeyer5ddd4c32003-03-19 00:35:36 +000034 if (interp->codec_search_path == NULL && _PyCodecRegistry_Init())
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000035 goto onError;
Guido van Rossumfeee4b92000-03-10 22:57:27 +000036 if (search_function == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000037 PyErr_BadArgument();
38 goto onError;
Guido van Rossumfeee4b92000-03-10 22:57:27 +000039 }
40 if (!PyCallable_Check(search_function)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000041 PyErr_SetString(PyExc_TypeError, "argument must be callable");
42 goto onError;
Guido van Rossumfeee4b92000-03-10 22:57:27 +000043 }
Gustavo Niemeyer5ddd4c32003-03-19 00:35:36 +000044 return PyList_Append(interp->codec_search_path, search_function);
Guido van Rossumb95de4f2000-03-31 17:25:23 +000045
46 onError:
47 return -1;
Guido van Rossumfeee4b92000-03-10 22:57:27 +000048}
49
Guido van Rossum9e896b32000-04-05 20:11:21 +000050/* Convert a string to a normalized Python string: all characters are
51 converted to lower case, spaces are replaced with underscores. */
52
Guido van Rossumfeee4b92000-03-10 22:57:27 +000053static
Guido van Rossum9e896b32000-04-05 20:11:21 +000054PyObject *normalizestring(const char *string)
Guido van Rossumfeee4b92000-03-10 22:57:27 +000055{
Guido van Rossum33831132000-06-29 14:50:15 +000056 register size_t i;
Guido van Rossum582acec2000-06-28 22:07:35 +000057 size_t len = strlen(string);
Guido van Rossumfeee4b92000-03-10 22:57:27 +000058 char *p;
59 PyObject *v;
Guido van Rossum21431e82007-10-19 21:48:41 +000060
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000061 if (len > PY_SSIZE_T_MAX) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000062 PyErr_SetString(PyExc_OverflowError, "string is too large");
63 return NULL;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000064 }
Guido van Rossum21431e82007-10-19 21:48:41 +000065
66 p = PyMem_Malloc(len + 1);
67 if (p == NULL)
68 return NULL;
Guido van Rossum9e896b32000-04-05 20:11:21 +000069 for (i = 0; i < len; i++) {
70 register char ch = string[i];
71 if (ch == ' ')
72 ch = '-';
73 else
Antoine Pitroucf9d3c02011-07-24 02:27:04 +020074 ch = Py_TOLOWER(Py_CHARMASK(ch));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000075 p[i] = ch;
Guido van Rossum9e896b32000-04-05 20:11:21 +000076 }
Guido van Rossum21431e82007-10-19 21:48:41 +000077 p[i] = '\0';
78 v = PyUnicode_FromString(p);
79 if (v == NULL)
80 return NULL;
81 PyMem_Free(p);
Guido van Rossumfeee4b92000-03-10 22:57:27 +000082 return v;
83}
84
85/* Lookup the given encoding and return a tuple providing the codec
86 facilities.
87
88 The encoding string is looked up converted to all lower-case
89 characters. This makes encodings looked up through this mechanism
90 effectively case-insensitive.
91
Guido van Rossum98297ee2007-11-06 21:34:58 +000092 If no codec is found, a LookupError is set and NULL returned.
Guido van Rossumb95de4f2000-03-31 17:25:23 +000093
94 As side effect, this tries to load the encodings package, if not
95 yet done. This is part of the lazy load strategy for the encodings
96 package.
97
98*/
Guido van Rossumfeee4b92000-03-10 22:57:27 +000099
100PyObject *_PyCodec_Lookup(const char *encoding)
101{
Gustavo Niemeyer5ddd4c32003-03-19 00:35:36 +0000102 PyInterpreterState *interp;
Guido van Rossum5ba3c842000-03-24 20:52:23 +0000103 PyObject *result, *args = NULL, *v;
Thomas Wouters477c8d52006-05-27 19:21:47 +0000104 Py_ssize_t i, len;
Guido van Rossumfeee4b92000-03-10 22:57:27 +0000105
Fred Drake766de832000-05-09 19:55:59 +0000106 if (encoding == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000107 PyErr_BadArgument();
108 goto onError;
Fred Drake766de832000-05-09 19:55:59 +0000109 }
Gustavo Niemeyer5ddd4c32003-03-19 00:35:36 +0000110
Nicholas Bastine5662ae2004-03-24 22:22:12 +0000111 interp = PyThreadState_GET()->interp;
Gustavo Niemeyer5ddd4c32003-03-19 00:35:36 +0000112 if (interp->codec_search_path == NULL && _PyCodecRegistry_Init())
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000113 goto onError;
Guido van Rossumfeee4b92000-03-10 22:57:27 +0000114
Guido van Rossum9e896b32000-04-05 20:11:21 +0000115 /* Convert the encoding to a normalized Python string: all
Thomas Wouters7e474022000-07-16 12:04:32 +0000116 characters are converted to lower case, spaces and hyphens are
Guido van Rossum9e896b32000-04-05 20:11:21 +0000117 replaced with underscores. */
118 v = normalizestring(encoding);
Guido van Rossumfeee4b92000-03-10 22:57:27 +0000119 if (v == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000120 goto onError;
Guido van Rossum21431e82007-10-19 21:48:41 +0000121 PyUnicode_InternInPlace(&v);
Guido van Rossumfeee4b92000-03-10 22:57:27 +0000122
123 /* First, try to lookup the name in the registry dictionary */
Gustavo Niemeyer5ddd4c32003-03-19 00:35:36 +0000124 result = PyDict_GetItem(interp->codec_search_cache, v);
Guido van Rossumfeee4b92000-03-10 22:57:27 +0000125 if (result != NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000126 Py_INCREF(result);
127 Py_DECREF(v);
128 return result;
Guido van Rossumfeee4b92000-03-10 22:57:27 +0000129 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000130
Guido van Rossumfeee4b92000-03-10 22:57:27 +0000131 /* Next, scan the search functions in order of registration */
Guido van Rossumfeee4b92000-03-10 22:57:27 +0000132 args = PyTuple_New(1);
133 if (args == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000134 goto onError;
Guido van Rossumfeee4b92000-03-10 22:57:27 +0000135 PyTuple_SET_ITEM(args,0,v);
Guido van Rossum5ba3c842000-03-24 20:52:23 +0000136
Gustavo Niemeyer5ddd4c32003-03-19 00:35:36 +0000137 len = PyList_Size(interp->codec_search_path);
Guido van Rossum5ba3c842000-03-24 20:52:23 +0000138 if (len < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000139 goto onError;
Guido van Rossumb95de4f2000-03-31 17:25:23 +0000140 if (len == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000141 PyErr_SetString(PyExc_LookupError,
142 "no codec search functions registered: "
143 "can't find encoding");
144 goto onError;
Guido van Rossumb95de4f2000-03-31 17:25:23 +0000145 }
Guido van Rossumfeee4b92000-03-10 22:57:27 +0000146
147 for (i = 0; i < len; i++) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000148 PyObject *func;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000149
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000150 func = PyList_GetItem(interp->codec_search_path, i);
151 if (func == NULL)
152 goto onError;
153 result = PyEval_CallObject(func, args);
154 if (result == NULL)
155 goto onError;
156 if (result == Py_None) {
157 Py_DECREF(result);
158 continue;
159 }
160 if (!PyTuple_Check(result) || PyTuple_GET_SIZE(result) != 4) {
161 PyErr_SetString(PyExc_TypeError,
162 "codec search functions must return 4-tuples");
163 Py_DECREF(result);
164 goto onError;
165 }
166 break;
Guido van Rossumfeee4b92000-03-10 22:57:27 +0000167 }
168 if (i == len) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000169 /* XXX Perhaps we should cache misses too ? */
170 PyErr_Format(PyExc_LookupError,
Martin v. Löwiseb42b022002-09-26 16:01:24 +0000171 "unknown encoding: %s", encoding);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000172 goto onError;
Guido van Rossumfeee4b92000-03-10 22:57:27 +0000173 }
174
175 /* Cache and return the result */
Neal Norwitz9edcc2e2007-08-11 04:58:26 +0000176 if (PyDict_SetItem(interp->codec_search_cache, v, result) < 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000177 Py_DECREF(result);
178 goto onError;
Neal Norwitz9edcc2e2007-08-11 04:58:26 +0000179 }
Guido van Rossumfeee4b92000-03-10 22:57:27 +0000180 Py_DECREF(args);
181 return result;
182
183 onError:
184 Py_XDECREF(args);
185 return NULL;
186}
187
Marc-André Lemburgb2750b52008-06-06 12:18:17 +0000188/* Codec registry encoding check API. */
189
190int PyCodec_KnownEncoding(const char *encoding)
191{
192 PyObject *codecs;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000193
Marc-André Lemburgb2750b52008-06-06 12:18:17 +0000194 codecs = _PyCodec_Lookup(encoding);
195 if (!codecs) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000196 PyErr_Clear();
197 return 0;
Marc-André Lemburgb2750b52008-06-06 12:18:17 +0000198 }
199 else {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000200 Py_DECREF(codecs);
201 return 1;
Marc-André Lemburgb2750b52008-06-06 12:18:17 +0000202 }
203}
204
Guido van Rossumfeee4b92000-03-10 22:57:27 +0000205static
206PyObject *args_tuple(PyObject *object,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000207 const char *errors)
Guido van Rossumfeee4b92000-03-10 22:57:27 +0000208{
209 PyObject *args;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000210
Guido van Rossumfeee4b92000-03-10 22:57:27 +0000211 args = PyTuple_New(1 + (errors != NULL));
212 if (args == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000213 return NULL;
Guido van Rossumfeee4b92000-03-10 22:57:27 +0000214 Py_INCREF(object);
215 PyTuple_SET_ITEM(args,0,object);
216 if (errors) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000217 PyObject *v;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000218
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000219 v = PyUnicode_FromString(errors);
220 if (v == NULL) {
221 Py_DECREF(args);
222 return NULL;
223 }
224 PyTuple_SET_ITEM(args, 1, v);
Guido van Rossumfeee4b92000-03-10 22:57:27 +0000225 }
226 return args;
227}
228
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000229/* Helper function to get a codec item */
Guido van Rossumfeee4b92000-03-10 22:57:27 +0000230
231static
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000232PyObject *codec_getitem(const char *encoding, int index)
Guido van Rossumfeee4b92000-03-10 22:57:27 +0000233{
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000234 PyObject *codecs;
235 PyObject *v;
Guido van Rossumfeee4b92000-03-10 22:57:27 +0000236
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000237 codecs = _PyCodec_Lookup(encoding);
238 if (codecs == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000239 return NULL;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000240 v = PyTuple_GET_ITEM(codecs, index);
241 Py_DECREF(codecs);
242 Py_INCREF(v);
243 return v;
244}
245
246/* Helper function to create an incremental codec. */
247
248static
249PyObject *codec_getincrementalcodec(const char *encoding,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000250 const char *errors,
251 const char *attrname)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000252{
253 PyObject *codecs, *ret, *inccodec;
254
255 codecs = _PyCodec_Lookup(encoding);
256 if (codecs == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000257 return NULL;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000258 inccodec = PyObject_GetAttrString(codecs, attrname);
259 Py_DECREF(codecs);
260 if (inccodec == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000261 return NULL;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000262 if (errors)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000263 ret = PyObject_CallFunction(inccodec, "s", errors);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000264 else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000265 ret = PyObject_CallFunction(inccodec, NULL);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000266 Py_DECREF(inccodec);
267 return ret;
268}
269
270/* Helper function to create a stream codec. */
271
272static
273PyObject *codec_getstreamcodec(const char *encoding,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000274 PyObject *stream,
275 const char *errors,
276 const int index)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000277{
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000278 PyObject *codecs, *streamcodec, *codeccls;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000279
280 codecs = _PyCodec_Lookup(encoding);
281 if (codecs == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000282 return NULL;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000283
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000284 codeccls = PyTuple_GET_ITEM(codecs, index);
285 if (errors != NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000286 streamcodec = PyObject_CallFunction(codeccls, "Os", stream, errors);
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000287 else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000288 streamcodec = PyObject_CallFunction(codeccls, "O", stream);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000289 Py_DECREF(codecs);
290 return streamcodec;
Guido van Rossumfeee4b92000-03-10 22:57:27 +0000291}
292
Guido van Rossum98297ee2007-11-06 21:34:58 +0000293/* Convenience APIs to query the Codec registry.
294
Guido van Rossumfeee4b92000-03-10 22:57:27 +0000295 All APIs return a codec object with incremented refcount.
Guido van Rossum98297ee2007-11-06 21:34:58 +0000296
Guido van Rossumfeee4b92000-03-10 22:57:27 +0000297 */
298
299PyObject *PyCodec_Encoder(const char *encoding)
300{
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000301 return codec_getitem(encoding, 0);
Guido van Rossumfeee4b92000-03-10 22:57:27 +0000302}
303
304PyObject *PyCodec_Decoder(const char *encoding)
305{
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000306 return codec_getitem(encoding, 1);
Guido van Rossumfeee4b92000-03-10 22:57:27 +0000307}
308
Thomas Woutersa9773292006-04-21 09:43:23 +0000309PyObject *PyCodec_IncrementalEncoder(const char *encoding,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000310 const char *errors)
Thomas Woutersa9773292006-04-21 09:43:23 +0000311{
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000312 return codec_getincrementalcodec(encoding, errors, "incrementalencoder");
Thomas Woutersa9773292006-04-21 09:43:23 +0000313}
314
315PyObject *PyCodec_IncrementalDecoder(const char *encoding,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000316 const char *errors)
Thomas Woutersa9773292006-04-21 09:43:23 +0000317{
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000318 return codec_getincrementalcodec(encoding, errors, "incrementaldecoder");
Thomas Woutersa9773292006-04-21 09:43:23 +0000319}
320
Guido van Rossumfeee4b92000-03-10 22:57:27 +0000321PyObject *PyCodec_StreamReader(const char *encoding,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000322 PyObject *stream,
323 const char *errors)
Guido van Rossumfeee4b92000-03-10 22:57:27 +0000324{
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000325 return codec_getstreamcodec(encoding, stream, errors, 2);
Guido van Rossumfeee4b92000-03-10 22:57:27 +0000326}
327
328PyObject *PyCodec_StreamWriter(const char *encoding,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000329 PyObject *stream,
330 const char *errors)
Guido van Rossumfeee4b92000-03-10 22:57:27 +0000331{
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000332 return codec_getstreamcodec(encoding, stream, errors, 3);
Guido van Rossumfeee4b92000-03-10 22:57:27 +0000333}
334
335/* Encode an object (e.g. an Unicode object) using the given encoding
336 and return the resulting encoded object (usually a Python string).
337
338 errors is passed to the encoder factory as argument if non-NULL. */
339
340PyObject *PyCodec_Encode(PyObject *object,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000341 const char *encoding,
342 const char *errors)
Guido van Rossumfeee4b92000-03-10 22:57:27 +0000343{
344 PyObject *encoder = NULL;
Neal Norwitz3715c3e2005-11-24 22:09:18 +0000345 PyObject *args = NULL, *result = NULL;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000346 PyObject *v = NULL;
Guido van Rossumfeee4b92000-03-10 22:57:27 +0000347
348 encoder = PyCodec_Encoder(encoding);
349 if (encoder == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000350 goto onError;
Guido van Rossumfeee4b92000-03-10 22:57:27 +0000351
352 args = args_tuple(object, errors);
353 if (args == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000354 goto onError;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000355
356 result = PyEval_CallObject(encoder, args);
Guido van Rossumfeee4b92000-03-10 22:57:27 +0000357 if (result == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000358 goto onError;
Guido van Rossumfeee4b92000-03-10 22:57:27 +0000359
Guido van Rossum98297ee2007-11-06 21:34:58 +0000360 if (!PyTuple_Check(result) ||
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000361 PyTuple_GET_SIZE(result) != 2) {
362 PyErr_SetString(PyExc_TypeError,
363 "encoder must return a tuple (object, integer)");
364 goto onError;
Guido van Rossumfeee4b92000-03-10 22:57:27 +0000365 }
Marc-André Lemburgb2750b52008-06-06 12:18:17 +0000366 v = PyTuple_GET_ITEM(result,0);
367 Py_INCREF(v);
Guido van Rossumfeee4b92000-03-10 22:57:27 +0000368 /* We don't check or use the second (integer) entry. */
369
Marc-André Lemburgb2750b52008-06-06 12:18:17 +0000370 Py_DECREF(args);
371 Py_DECREF(encoder);
372 Py_DECREF(result);
373 return v;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000374
Guido van Rossumfeee4b92000-03-10 22:57:27 +0000375 onError:
Neal Norwitz3715c3e2005-11-24 22:09:18 +0000376 Py_XDECREF(result);
Guido van Rossumfeee4b92000-03-10 22:57:27 +0000377 Py_XDECREF(args);
378 Py_XDECREF(encoder);
Marc-André Lemburgb2750b52008-06-06 12:18:17 +0000379 return NULL;
Guido van Rossumfeee4b92000-03-10 22:57:27 +0000380}
381
382/* Decode an object (usually a Python string) using the given encoding
383 and return an equivalent object (e.g. an Unicode object).
384
385 errors is passed to the decoder factory as argument if non-NULL. */
386
387PyObject *PyCodec_Decode(PyObject *object,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000388 const char *encoding,
389 const char *errors)
Guido van Rossumfeee4b92000-03-10 22:57:27 +0000390{
391 PyObject *decoder = NULL;
392 PyObject *args = NULL, *result = NULL;
393 PyObject *v;
394
395 decoder = PyCodec_Decoder(encoding);
396 if (decoder == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000397 goto onError;
Guido van Rossumfeee4b92000-03-10 22:57:27 +0000398
399 args = args_tuple(object, errors);
400 if (args == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000401 goto onError;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000402
Guido van Rossumfeee4b92000-03-10 22:57:27 +0000403 result = PyEval_CallObject(decoder,args);
404 if (result == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000405 goto onError;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000406 if (!PyTuple_Check(result) ||
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000407 PyTuple_GET_SIZE(result) != 2) {
408 PyErr_SetString(PyExc_TypeError,
409 "decoder must return a tuple (object,integer)");
410 goto onError;
Guido van Rossumfeee4b92000-03-10 22:57:27 +0000411 }
412 v = PyTuple_GET_ITEM(result,0);
413 Py_INCREF(v);
414 /* We don't check or use the second (integer) entry. */
415
416 Py_DECREF(args);
417 Py_DECREF(decoder);
418 Py_DECREF(result);
419 return v;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000420
Guido van Rossumfeee4b92000-03-10 22:57:27 +0000421 onError:
422 Py_XDECREF(args);
423 Py_XDECREF(decoder);
424 Py_XDECREF(result);
425 return NULL;
426}
427
Walter Dörwald3aeb6322002-09-02 13:14:32 +0000428/* Register the error handling callback function error under the name
429 name. This function will be called by the codec when it encounters
430 an unencodable characters/undecodable bytes and doesn't know the
431 callback name, when name is specified as the error parameter
432 in the call to the encode/decode function.
433 Return 0 on success, -1 on error */
434int PyCodec_RegisterError(const char *name, PyObject *error)
435{
Nicholas Bastine5662ae2004-03-24 22:22:12 +0000436 PyInterpreterState *interp = PyThreadState_GET()->interp;
Gustavo Niemeyer5ddd4c32003-03-19 00:35:36 +0000437 if (interp->codec_search_path == NULL && _PyCodecRegistry_Init())
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000438 return -1;
Walter Dörwald3aeb6322002-09-02 13:14:32 +0000439 if (!PyCallable_Check(error)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000440 PyErr_SetString(PyExc_TypeError, "handler must be callable");
441 return -1;
Walter Dörwald3aeb6322002-09-02 13:14:32 +0000442 }
Gustavo Niemeyer5ddd4c32003-03-19 00:35:36 +0000443 return PyDict_SetItemString(interp->codec_error_registry,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000444 (char *)name, error);
Walter Dörwald3aeb6322002-09-02 13:14:32 +0000445}
446
447/* Lookup the error handling callback function registered under the
448 name error. As a special case NULL can be passed, in which case
449 the error handling callback for strict encoding will be returned. */
450PyObject *PyCodec_LookupError(const char *name)
451{
452 PyObject *handler = NULL;
453
Nicholas Bastine5662ae2004-03-24 22:22:12 +0000454 PyInterpreterState *interp = PyThreadState_GET()->interp;
Gustavo Niemeyer5ddd4c32003-03-19 00:35:36 +0000455 if (interp->codec_search_path == NULL && _PyCodecRegistry_Init())
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000456 return NULL;
Gustavo Niemeyer5ddd4c32003-03-19 00:35:36 +0000457
Walter Dörwald3aeb6322002-09-02 13:14:32 +0000458 if (name==NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000459 name = "strict";
Gustavo Niemeyer5ddd4c32003-03-19 00:35:36 +0000460 handler = PyDict_GetItemString(interp->codec_error_registry, (char *)name);
Walter Dörwald3aeb6322002-09-02 13:14:32 +0000461 if (!handler)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000462 PyErr_Format(PyExc_LookupError, "unknown error handler name '%.400s'", name);
Walter Dörwald3aeb6322002-09-02 13:14:32 +0000463 else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000464 Py_INCREF(handler);
Walter Dörwald3aeb6322002-09-02 13:14:32 +0000465 return handler;
466}
467
468static void wrong_exception_type(PyObject *exc)
469{
Martin v. Löwisbd928fe2011-10-14 10:20:37 +0200470 _Py_IDENTIFIER(__class__);
471 _Py_IDENTIFIER(__name__);
Martin v. Löwis1ee1b6f2011-10-10 18:11:30 +0200472 PyObject *type = _PyObject_GetAttrId(exc, &PyId___class__);
Walter Dörwald3aeb6322002-09-02 13:14:32 +0000473 if (type != NULL) {
Martin v. Löwis1ee1b6f2011-10-10 18:11:30 +0200474 PyObject *name = _PyObject_GetAttrId(type, &PyId___name__);
Walter Dörwald573c08c2007-05-25 15:46:59 +0000475 Py_DECREF(type);
476 if (name != NULL) {
477 PyErr_Format(PyExc_TypeError,
478 "don't know how to handle %S in error callback", name);
479 Py_DECREF(name);
480 }
Walter Dörwald3aeb6322002-09-02 13:14:32 +0000481 }
482}
483
484PyObject *PyCodec_StrictErrors(PyObject *exc)
485{
Brett Cannonbf364092006-03-01 04:25:17 +0000486 if (PyExceptionInstance_Check(exc))
487 PyErr_SetObject(PyExceptionInstance_Class(exc), exc);
Walter Dörwald3aeb6322002-09-02 13:14:32 +0000488 else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000489 PyErr_SetString(PyExc_TypeError, "codec must pass exception instance");
Walter Dörwald3aeb6322002-09-02 13:14:32 +0000490 return NULL;
491}
492
493
494PyObject *PyCodec_IgnoreErrors(PyObject *exc)
495{
Martin v. Löwis18e16552006-02-15 17:27:45 +0000496 Py_ssize_t end;
Walter Dörwald3aeb6322002-09-02 13:14:32 +0000497 if (PyObject_IsInstance(exc, PyExc_UnicodeEncodeError)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000498 if (PyUnicodeEncodeError_GetEnd(exc, &end))
499 return NULL;
Walter Dörwald3aeb6322002-09-02 13:14:32 +0000500 }
501 else if (PyObject_IsInstance(exc, PyExc_UnicodeDecodeError)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000502 if (PyUnicodeDecodeError_GetEnd(exc, &end))
503 return NULL;
Walter Dörwald3aeb6322002-09-02 13:14:32 +0000504 }
505 else if (PyObject_IsInstance(exc, PyExc_UnicodeTranslateError)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000506 if (PyUnicodeTranslateError_GetEnd(exc, &end))
507 return NULL;
Walter Dörwald3aeb6322002-09-02 13:14:32 +0000508 }
509 else {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000510 wrong_exception_type(exc);
511 return NULL;
Walter Dörwald3aeb6322002-09-02 13:14:32 +0000512 }
Victor Stinneree450092011-12-01 02:52:11 +0100513 return Py_BuildValue("(Nn)", PyUnicode_New(0, 0), end);
Walter Dörwald3aeb6322002-09-02 13:14:32 +0000514}
515
516
517PyObject *PyCodec_ReplaceErrors(PyObject *exc)
518{
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200519 Py_ssize_t start, end, i, len;
Walter Dörwald3aeb6322002-09-02 13:14:32 +0000520
521 if (PyObject_IsInstance(exc, PyExc_UnicodeEncodeError)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000522 PyObject *res;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200523 int kind;
524 void *data;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000525 if (PyUnicodeEncodeError_GetStart(exc, &start))
526 return NULL;
527 if (PyUnicodeEncodeError_GetEnd(exc, &end))
528 return NULL;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200529 len = end - start;
530 res = PyUnicode_New(len, '?');
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000531 if (res == NULL)
532 return NULL;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200533 kind = PyUnicode_KIND(res);
534 data = PyUnicode_DATA(res);
535 for (i = 0; i < len; ++i)
536 PyUnicode_WRITE(kind, data, i, '?');
537 return Py_BuildValue("(Nn)", res, end);
Walter Dörwald3aeb6322002-09-02 13:14:32 +0000538 }
539 else if (PyObject_IsInstance(exc, PyExc_UnicodeDecodeError)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000540 if (PyUnicodeDecodeError_GetEnd(exc, &end))
541 return NULL;
Victor Stinner1a15aba2011-10-02 19:00:15 +0200542 return Py_BuildValue("(Cn)",
543 (int)Py_UNICODE_REPLACEMENT_CHARACTER,
544 end);
Walter Dörwald3aeb6322002-09-02 13:14:32 +0000545 }
546 else if (PyObject_IsInstance(exc, PyExc_UnicodeTranslateError)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000547 PyObject *res;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200548 int kind;
549 void *data;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000550 if (PyUnicodeTranslateError_GetStart(exc, &start))
551 return NULL;
552 if (PyUnicodeTranslateError_GetEnd(exc, &end))
553 return NULL;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200554 len = end - start;
555 res = PyUnicode_New(len, Py_UNICODE_REPLACEMENT_CHARACTER);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000556 if (res == NULL)
557 return NULL;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200558 kind = PyUnicode_KIND(res);
559 data = PyUnicode_DATA(res);
560 for (i=0; i < len; i++)
561 PyUnicode_WRITE(kind, data, i, Py_UNICODE_REPLACEMENT_CHARACTER);
562 return Py_BuildValue("(Nn)", res, end);
Walter Dörwald3aeb6322002-09-02 13:14:32 +0000563 }
564 else {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000565 wrong_exception_type(exc);
566 return NULL;
Walter Dörwald3aeb6322002-09-02 13:14:32 +0000567 }
568}
569
570PyObject *PyCodec_XMLCharRefReplaceErrors(PyObject *exc)
571{
572 if (PyObject_IsInstance(exc, PyExc_UnicodeEncodeError)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000573 PyObject *restuple;
574 PyObject *object;
Victor Stinnerb31f1bc2011-11-04 21:29:10 +0100575 Py_ssize_t i;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000576 Py_ssize_t start;
577 Py_ssize_t end;
578 PyObject *res;
Martin v. Löwisb09af032011-11-04 11:16:41 +0100579 unsigned char *outp;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000580 int ressize;
Martin v. Löwisb09af032011-11-04 11:16:41 +0100581 Py_UCS4 ch;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000582 if (PyUnicodeEncodeError_GetStart(exc, &start))
583 return NULL;
584 if (PyUnicodeEncodeError_GetEnd(exc, &end))
585 return NULL;
586 if (!(object = PyUnicodeEncodeError_GetObject(exc)))
587 return NULL;
Martin v. Löwisb09af032011-11-04 11:16:41 +0100588 for (i = start, ressize = 0; i < end; ++i) {
589 /* object is guaranteed to be "ready" */
590 ch = PyUnicode_READ_CHAR(object, i);
591 if (ch<10)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000592 ressize += 2+1+1;
Martin v. Löwisb09af032011-11-04 11:16:41 +0100593 else if (ch<100)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000594 ressize += 2+2+1;
Martin v. Löwisb09af032011-11-04 11:16:41 +0100595 else if (ch<1000)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000596 ressize += 2+3+1;
Martin v. Löwisb09af032011-11-04 11:16:41 +0100597 else if (ch<10000)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000598 ressize += 2+4+1;
Martin v. Löwisb09af032011-11-04 11:16:41 +0100599 else if (ch<100000)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000600 ressize += 2+5+1;
Martin v. Löwisb09af032011-11-04 11:16:41 +0100601 else if (ch<1000000)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000602 ressize += 2+6+1;
603 else
604 ressize += 2+7+1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000605 }
606 /* allocate replacement */
Martin v. Löwisb09af032011-11-04 11:16:41 +0100607 res = PyUnicode_New(ressize, 127);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000608 if (res == NULL) {
609 Py_DECREF(object);
610 return NULL;
611 }
Martin v. Löwisb09af032011-11-04 11:16:41 +0100612 outp = PyUnicode_1BYTE_DATA(res);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000613 /* generate replacement */
Victor Stinnerb31f1bc2011-11-04 21:29:10 +0100614 for (i = start; i < end; ++i) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000615 int digits;
616 int base;
Martin v. Löwis8ba79302011-11-04 12:26:49 +0100617 ch = PyUnicode_READ_CHAR(object, i);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000618 *outp++ = '&';
619 *outp++ = '#';
Martin v. Löwisb09af032011-11-04 11:16:41 +0100620 if (ch<10) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000621 digits = 1;
622 base = 1;
623 }
Martin v. Löwisb09af032011-11-04 11:16:41 +0100624 else if (ch<100) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000625 digits = 2;
626 base = 10;
627 }
Martin v. Löwisb09af032011-11-04 11:16:41 +0100628 else if (ch<1000) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000629 digits = 3;
630 base = 100;
631 }
Martin v. Löwisb09af032011-11-04 11:16:41 +0100632 else if (ch<10000) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000633 digits = 4;
634 base = 1000;
635 }
Martin v. Löwisb09af032011-11-04 11:16:41 +0100636 else if (ch<100000) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000637 digits = 5;
638 base = 10000;
639 }
Martin v. Löwisb09af032011-11-04 11:16:41 +0100640 else if (ch<1000000) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000641 digits = 6;
642 base = 100000;
643 }
644 else {
645 digits = 7;
646 base = 1000000;
647 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000648 while (digits-->0) {
Martin v. Löwisb09af032011-11-04 11:16:41 +0100649 *outp++ = '0' + ch/base;
650 ch %= base;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000651 base /= 10;
652 }
653 *outp++ = ';';
654 }
655 restuple = Py_BuildValue("(On)", res, end);
656 Py_DECREF(res);
657 Py_DECREF(object);
658 return restuple;
Walter Dörwald3aeb6322002-09-02 13:14:32 +0000659 }
660 else {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000661 wrong_exception_type(exc);
662 return NULL;
Walter Dörwald3aeb6322002-09-02 13:14:32 +0000663 }
664}
665
Walter Dörwald3aeb6322002-09-02 13:14:32 +0000666PyObject *PyCodec_BackslashReplaceErrors(PyObject *exc)
667{
668 if (PyObject_IsInstance(exc, PyExc_UnicodeEncodeError)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000669 PyObject *restuple;
670 PyObject *object;
Martin v. Löwisb09af032011-11-04 11:16:41 +0100671 Py_ssize_t i;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000672 Py_ssize_t start;
673 Py_ssize_t end;
674 PyObject *res;
Martin v. Löwisb09af032011-11-04 11:16:41 +0100675 unsigned char *outp;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000676 int ressize;
Martin v. Löwisb09af032011-11-04 11:16:41 +0100677 Py_UCS4 c;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000678 if (PyUnicodeEncodeError_GetStart(exc, &start))
679 return NULL;
680 if (PyUnicodeEncodeError_GetEnd(exc, &end))
681 return NULL;
682 if (!(object = PyUnicodeEncodeError_GetObject(exc)))
683 return NULL;
Martin v. Löwisb09af032011-11-04 11:16:41 +0100684 for (i = start, ressize = 0; i < end; ++i) {
685 /* object is guaranteed to be "ready" */
686 c = PyUnicode_READ_CHAR(object, i);
687 if (c >= 0x10000) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000688 ressize += 1+1+8;
Martin v. Löwisb09af032011-11-04 11:16:41 +0100689 }
690 else if (c >= 0x100) {
691 ressize += 1+1+4;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000692 }
693 else
694 ressize += 1+1+2;
695 }
Martin v. Löwisb09af032011-11-04 11:16:41 +0100696 res = PyUnicode_New(ressize, 127);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000697 if (res==NULL)
698 return NULL;
Martin v. Löwisb09af032011-11-04 11:16:41 +0100699 for (i = start, outp = PyUnicode_1BYTE_DATA(res);
700 i < end; ++i) {
701 c = PyUnicode_READ_CHAR(object, i);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000702 *outp++ = '\\';
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000703 if (c >= 0x00010000) {
704 *outp++ = 'U';
Victor Stinnerf5cff562011-10-14 02:13:11 +0200705 *outp++ = Py_hexdigits[(c>>28)&0xf];
706 *outp++ = Py_hexdigits[(c>>24)&0xf];
707 *outp++ = Py_hexdigits[(c>>20)&0xf];
708 *outp++ = Py_hexdigits[(c>>16)&0xf];
709 *outp++ = Py_hexdigits[(c>>12)&0xf];
710 *outp++ = Py_hexdigits[(c>>8)&0xf];
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000711 }
Antoine Pitroue4a18922010-09-09 20:30:23 +0000712 else if (c >= 0x100) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000713 *outp++ = 'u';
Victor Stinnerf5cff562011-10-14 02:13:11 +0200714 *outp++ = Py_hexdigits[(c>>12)&0xf];
715 *outp++ = Py_hexdigits[(c>>8)&0xf];
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000716 }
717 else
718 *outp++ = 'x';
Victor Stinnerf5cff562011-10-14 02:13:11 +0200719 *outp++ = Py_hexdigits[(c>>4)&0xf];
720 *outp++ = Py_hexdigits[c&0xf];
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000721 }
Walter Dörwald3aeb6322002-09-02 13:14:32 +0000722
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000723 restuple = Py_BuildValue("(On)", res, end);
724 Py_DECREF(res);
725 Py_DECREF(object);
726 return restuple;
Walter Dörwald3aeb6322002-09-02 13:14:32 +0000727 }
728 else {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000729 wrong_exception_type(exc);
730 return NULL;
Walter Dörwald3aeb6322002-09-02 13:14:32 +0000731 }
732}
733
Martin v. Löwisaef3fb02009-05-02 19:27:30 +0000734/* This handler is declared static until someone demonstrates
735 a need to call it directly. */
736static PyObject *
Martin v. Löwise0a2b722009-05-10 08:08:56 +0000737PyCodec_SurrogatePassErrors(PyObject *exc)
Martin v. Löwisdb12d452009-05-02 18:52:14 +0000738{
739 PyObject *restuple;
740 PyObject *object;
Martin v. Löwisb09af032011-11-04 11:16:41 +0100741 Py_ssize_t i;
Martin v. Löwisdb12d452009-05-02 18:52:14 +0000742 Py_ssize_t start;
743 Py_ssize_t end;
744 PyObject *res;
745 if (PyObject_IsInstance(exc, PyExc_UnicodeEncodeError)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000746 char *outp;
747 if (PyUnicodeEncodeError_GetStart(exc, &start))
748 return NULL;
749 if (PyUnicodeEncodeError_GetEnd(exc, &end))
750 return NULL;
751 if (!(object = PyUnicodeEncodeError_GetObject(exc)))
752 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000753 res = PyBytes_FromStringAndSize(NULL, 3*(end-start));
754 if (!res) {
755 Py_DECREF(object);
756 return NULL;
757 }
758 outp = PyBytes_AsString(res);
Martin v. Löwisb09af032011-11-04 11:16:41 +0100759 for (i = start; i < end; i++) {
760 /* object is guaranteed to be "ready" */
761 Py_UCS4 ch = PyUnicode_READ_CHAR(object, i);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000762 if (ch < 0xd800 || ch > 0xdfff) {
763 /* Not a surrogate, fail with original exception */
764 PyErr_SetObject(PyExceptionInstance_Class(exc), exc);
765 Py_DECREF(res);
766 Py_DECREF(object);
767 return NULL;
768 }
769 *outp++ = (char)(0xe0 | (ch >> 12));
770 *outp++ = (char)(0x80 | ((ch >> 6) & 0x3f));
771 *outp++ = (char)(0x80 | (ch & 0x3f));
772 }
773 restuple = Py_BuildValue("(On)", res, end);
774 Py_DECREF(res);
775 Py_DECREF(object);
776 return restuple;
Martin v. Löwisdb12d452009-05-02 18:52:14 +0000777 }
778 else if (PyObject_IsInstance(exc, PyExc_UnicodeDecodeError)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000779 unsigned char *p;
Victor Stinnerc06bb7a2011-11-04 21:36:35 +0100780 Py_UCS4 ch = 0;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000781 if (PyUnicodeDecodeError_GetStart(exc, &start))
782 return NULL;
783 if (!(object = PyUnicodeDecodeError_GetObject(exc)))
784 return NULL;
785 if (!(p = (unsigned char*)PyBytes_AsString(object))) {
786 Py_DECREF(object);
787 return NULL;
788 }
789 /* Try decoding a single surrogate character. If
790 there are more, let the codec call us again. */
791 p += start;
792 if ((p[0] & 0xf0) == 0xe0 ||
793 (p[1] & 0xc0) == 0x80 ||
794 (p[2] & 0xc0) == 0x80) {
795 /* it's a three-byte code */
796 ch = ((p[0] & 0x0f) << 12) + ((p[1] & 0x3f) << 6) + (p[2] & 0x3f);
797 if (ch < 0xd800 || ch > 0xdfff)
798 /* it's not a surrogate - fail */
799 ch = 0;
800 }
801 Py_DECREF(object);
802 if (ch == 0) {
803 PyErr_SetObject(PyExceptionInstance_Class(exc), exc);
804 return NULL;
805 }
Victor Stinnerc06bb7a2011-11-04 21:36:35 +0100806 res = PyUnicode_FromOrdinal(ch);
807 if (res == NULL)
808 return NULL;
809 return Py_BuildValue("(Nn)", res, start+3);
Martin v. Löwisdb12d452009-05-02 18:52:14 +0000810 }
811 else {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000812 wrong_exception_type(exc);
813 return NULL;
Martin v. Löwisdb12d452009-05-02 18:52:14 +0000814 }
815}
816
Martin v. Löwis011e8422009-05-05 04:43:17 +0000817static PyObject *
Martin v. Löwis43c57782009-05-10 08:15:24 +0000818PyCodec_SurrogateEscapeErrors(PyObject *exc)
Martin v. Löwis011e8422009-05-05 04:43:17 +0000819{
820 PyObject *restuple;
821 PyObject *object;
Martin v. Löwisb09af032011-11-04 11:16:41 +0100822 Py_ssize_t i;
Martin v. Löwis011e8422009-05-05 04:43:17 +0000823 Py_ssize_t start;
824 Py_ssize_t end;
825 PyObject *res;
826 if (PyObject_IsInstance(exc, PyExc_UnicodeEncodeError)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000827 char *outp;
828 if (PyUnicodeEncodeError_GetStart(exc, &start))
829 return NULL;
830 if (PyUnicodeEncodeError_GetEnd(exc, &end))
831 return NULL;
832 if (!(object = PyUnicodeEncodeError_GetObject(exc)))
833 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000834 res = PyBytes_FromStringAndSize(NULL, end-start);
835 if (!res) {
836 Py_DECREF(object);
837 return NULL;
838 }
839 outp = PyBytes_AsString(res);
Martin v. Löwisb09af032011-11-04 11:16:41 +0100840 for (i = start; i < end; i++) {
841 /* object is guaranteed to be "ready" */
842 Py_UCS4 ch = PyUnicode_READ_CHAR(object, i);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000843 if (ch < 0xdc80 || ch > 0xdcff) {
844 /* Not a UTF-8b surrogate, fail with original exception */
845 PyErr_SetObject(PyExceptionInstance_Class(exc), exc);
846 Py_DECREF(res);
847 Py_DECREF(object);
848 return NULL;
849 }
850 *outp++ = ch - 0xdc00;
851 }
852 restuple = Py_BuildValue("(On)", res, end);
853 Py_DECREF(res);
854 Py_DECREF(object);
855 return restuple;
Martin v. Löwis011e8422009-05-05 04:43:17 +0000856 }
857 else if (PyObject_IsInstance(exc, PyExc_UnicodeDecodeError)) {
Victor Stinnerc06bb7a2011-11-04 21:36:35 +0100858 PyObject *str;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000859 unsigned char *p;
Victor Stinnerc06bb7a2011-11-04 21:36:35 +0100860 Py_UCS2 ch[4]; /* decode up to 4 bad bytes. */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000861 int consumed = 0;
862 if (PyUnicodeDecodeError_GetStart(exc, &start))
863 return NULL;
864 if (PyUnicodeDecodeError_GetEnd(exc, &end))
865 return NULL;
866 if (!(object = PyUnicodeDecodeError_GetObject(exc)))
867 return NULL;
868 if (!(p = (unsigned char*)PyBytes_AsString(object))) {
869 Py_DECREF(object);
870 return NULL;
871 }
872 while (consumed < 4 && consumed < end-start) {
873 /* Refuse to escape ASCII bytes. */
874 if (p[start+consumed] < 128)
875 break;
876 ch[consumed] = 0xdc00 + p[start+consumed];
877 consumed++;
878 }
879 Py_DECREF(object);
880 if (!consumed) {
881 /* codec complained about ASCII byte. */
882 PyErr_SetObject(PyExceptionInstance_Class(exc), exc);
883 return NULL;
884 }
Victor Stinnerc06bb7a2011-11-04 21:36:35 +0100885 str = PyUnicode_FromKindAndData(PyUnicode_2BYTE_KIND, ch, consumed);
886 if (str == NULL)
887 return NULL;
888 return Py_BuildValue("(Nn)", str, start+consumed);
Martin v. Löwis011e8422009-05-05 04:43:17 +0000889 }
890 else {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000891 wrong_exception_type(exc);
892 return NULL;
Martin v. Löwis011e8422009-05-05 04:43:17 +0000893 }
894}
895
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000896
Walter Dörwald3aeb6322002-09-02 13:14:32 +0000897static PyObject *strict_errors(PyObject *self, PyObject *exc)
898{
899 return PyCodec_StrictErrors(exc);
900}
901
902
903static PyObject *ignore_errors(PyObject *self, PyObject *exc)
904{
905 return PyCodec_IgnoreErrors(exc);
906}
907
908
909static PyObject *replace_errors(PyObject *self, PyObject *exc)
910{
911 return PyCodec_ReplaceErrors(exc);
912}
913
914
915static PyObject *xmlcharrefreplace_errors(PyObject *self, PyObject *exc)
916{
917 return PyCodec_XMLCharRefReplaceErrors(exc);
918}
919
920
921static PyObject *backslashreplace_errors(PyObject *self, PyObject *exc)
922{
923 return PyCodec_BackslashReplaceErrors(exc);
924}
925
Martin v. Löwise0a2b722009-05-10 08:08:56 +0000926static PyObject *surrogatepass_errors(PyObject *self, PyObject *exc)
Martin v. Löwisdb12d452009-05-02 18:52:14 +0000927{
Martin v. Löwise0a2b722009-05-10 08:08:56 +0000928 return PyCodec_SurrogatePassErrors(exc);
Martin v. Löwisdb12d452009-05-02 18:52:14 +0000929}
930
Martin v. Löwis43c57782009-05-10 08:15:24 +0000931static PyObject *surrogateescape_errors(PyObject *self, PyObject *exc)
Martin v. Löwis011e8422009-05-05 04:43:17 +0000932{
Martin v. Löwis43c57782009-05-10 08:15:24 +0000933 return PyCodec_SurrogateEscapeErrors(exc);
Martin v. Löwis011e8422009-05-05 04:43:17 +0000934}
935
Gustavo Niemeyer5ddd4c32003-03-19 00:35:36 +0000936static int _PyCodecRegistry_Init(void)
Guido van Rossumfeee4b92000-03-10 22:57:27 +0000937{
Walter Dörwald3aeb6322002-09-02 13:14:32 +0000938 static struct {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000939 char *name;
940 PyMethodDef def;
Walter Dörwald3aeb6322002-09-02 13:14:32 +0000941 } methods[] =
942 {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000943 {
944 "strict",
945 {
946 "strict_errors",
947 strict_errors,
948 METH_O,
949 PyDoc_STR("Implements the 'strict' error handling, which "
950 "raises a UnicodeError on coding errors.")
951 }
952 },
953 {
954 "ignore",
955 {
956 "ignore_errors",
957 ignore_errors,
958 METH_O,
959 PyDoc_STR("Implements the 'ignore' error handling, which "
960 "ignores malformed data and continues.")
961 }
962 },
963 {
964 "replace",
965 {
966 "replace_errors",
967 replace_errors,
968 METH_O,
969 PyDoc_STR("Implements the 'replace' error handling, which "
970 "replaces malformed data with a replacement marker.")
971 }
972 },
973 {
974 "xmlcharrefreplace",
975 {
976 "xmlcharrefreplace_errors",
977 xmlcharrefreplace_errors,
978 METH_O,
979 PyDoc_STR("Implements the 'xmlcharrefreplace' error handling, "
980 "which replaces an unencodable character with the "
981 "appropriate XML character reference.")
982 }
983 },
984 {
985 "backslashreplace",
986 {
987 "backslashreplace_errors",
988 backslashreplace_errors,
989 METH_O,
990 PyDoc_STR("Implements the 'backslashreplace' error handling, "
991 "which replaces an unencodable character with a "
992 "backslashed escape sequence.")
993 }
994 },
995 {
996 "surrogatepass",
997 {
998 "surrogatepass",
999 surrogatepass_errors,
1000 METH_O
1001 }
1002 },
1003 {
1004 "surrogateescape",
1005 {
1006 "surrogateescape",
1007 surrogateescape_errors,
1008 METH_O
1009 }
1010 }
Walter Dörwald3aeb6322002-09-02 13:14:32 +00001011 };
Walter Dörwald3aeb6322002-09-02 13:14:32 +00001012
Nicholas Bastine5662ae2004-03-24 22:22:12 +00001013 PyInterpreterState *interp = PyThreadState_GET()->interp;
Gustavo Niemeyer5ddd4c32003-03-19 00:35:36 +00001014 PyObject *mod;
Neal Norwitz739a8f82004-07-08 01:55:58 +00001015 unsigned i;
Gustavo Niemeyer5ddd4c32003-03-19 00:35:36 +00001016
1017 if (interp->codec_search_path != NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001018 return 0;
Gustavo Niemeyer5ddd4c32003-03-19 00:35:36 +00001019
1020 interp->codec_search_path = PyList_New(0);
1021 interp->codec_search_cache = PyDict_New();
1022 interp->codec_error_registry = PyDict_New();
1023
1024 if (interp->codec_error_registry) {
Victor Stinner63941882011-09-29 00:42:28 +02001025 for (i = 0; i < Py_ARRAY_LENGTH(methods); ++i) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001026 PyObject *func = PyCFunction_New(&methods[i].def, NULL);
1027 int res;
1028 if (!func)
1029 Py_FatalError("can't initialize codec error registry");
1030 res = PyCodec_RegisterError(methods[i].name, func);
1031 Py_DECREF(func);
1032 if (res)
1033 Py_FatalError("can't initialize codec error registry");
1034 }
Walter Dörwald3aeb6322002-09-02 13:14:32 +00001035 }
Guido van Rossumfeee4b92000-03-10 22:57:27 +00001036
Gustavo Niemeyer5ddd4c32003-03-19 00:35:36 +00001037 if (interp->codec_search_path == NULL ||
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001038 interp->codec_search_cache == NULL ||
1039 interp->codec_error_registry == NULL)
1040 Py_FatalError("can't initialize codec registry");
Gustavo Niemeyer5ddd4c32003-03-19 00:35:36 +00001041
Christian Heimes819b8bf2008-01-03 23:05:47 +00001042 mod = PyImport_ImportModuleNoBlock("encodings");
Gustavo Niemeyer5ddd4c32003-03-19 00:35:36 +00001043 if (mod == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001044 return -1;
Gustavo Niemeyer5ddd4c32003-03-19 00:35:36 +00001045 }
1046 Py_DECREF(mod);
Christian Heimes6a27efa2008-10-30 21:48:26 +00001047 interp->codecs_initialized = 1;
Gustavo Niemeyer5ddd4c32003-03-19 00:35:36 +00001048 return 0;
Guido van Rossumfeee4b92000-03-10 22:57:27 +00001049}