blob: 05ec27bfbb194ac1ee02b82e7bf4fef4289112a6 [file] [log] [blame]
Guido van Rossumfe3f1a21994-09-29 09:42:55 +00001
2/* New getargs implementation */
3
Guido van Rossum79f25d91997-04-29 20:08:16 +00004#include "Python.h"
Guido van Rossumfe3f1a21994-09-29 09:42:55 +00005
Guido van Rossumc1d50531996-08-21 23:38:24 +00006#include <ctype.h>
7
Guido van Rossumfe3f1a21994-09-29 09:42:55 +00008
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00009#ifdef __cplusplus
Guido van Rossum98297ee2007-11-06 21:34:58 +000010extern "C" {
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000011#endif
Jeremy Hyltonaf68c872005-12-10 18:50:16 +000012int PyArg_Parse(PyObject *, const char *, ...);
13int PyArg_ParseTuple(PyObject *, const char *, ...);
14int PyArg_VaParse(PyObject *, const char *, va_list);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000015
Tim Petersdbd9ba62000-07-09 03:09:57 +000016int PyArg_ParseTupleAndKeywords(PyObject *, PyObject *,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000017 const char *, char **, ...);
Brett Cannon711e7d92004-07-10 22:20:32 +000018int PyArg_VaParseTupleAndKeywords(PyObject *, PyObject *,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000019 const char *, char **, va_list);
Brett Cannon711e7d92004-07-10 22:20:32 +000020
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000021#ifdef HAVE_DECLSPEC_DLL
22/* Export functions */
Serhiy Storchakaef1585e2015-12-25 20:01:53 +020023PyAPI_FUNC(int) _PyArg_Parse_SizeT(PyObject *, const char *, ...);
24PyAPI_FUNC(int) _PyArg_ParseTuple_SizeT(PyObject *, const char *, ...);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000025PyAPI_FUNC(int) _PyArg_ParseTupleAndKeywords_SizeT(PyObject *, PyObject *,
26 const char *, char **, ...);
27PyAPI_FUNC(PyObject *) _Py_BuildValue_SizeT(const char *, ...);
Serhiy Storchakaef1585e2015-12-25 20:01:53 +020028PyAPI_FUNC(int) _PyArg_VaParse_SizeT(PyObject *, const char *, va_list);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000029PyAPI_FUNC(int) _PyArg_VaParseTupleAndKeywords_SizeT(PyObject *, PyObject *,
30 const char *, char **, va_list);
31#endif
32
Martin v. Löwis18e16552006-02-15 17:27:45 +000033#define FLAG_COMPAT 1
34#define FLAG_SIZE_T 2
35
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -040036typedef int (*destr_t)(PyObject *, void *);
37
38
39/* Keep track of "objects" that have been allocated or initialized and
40 which will need to be deallocated or cleaned up somehow if overall
41 parsing fails.
42*/
43typedef struct {
44 void *item;
45 destr_t destructor;
46} freelistentry_t;
47
48typedef struct {
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -040049 freelistentry_t *entries;
Antoine Pitrou7056cb22013-02-17 01:04:57 +010050 int first_available;
51 int entries_malloced;
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -040052} freelist_t;
53
Antoine Pitrou7056cb22013-02-17 01:04:57 +010054#define STATIC_FREELIST_ENTRIES 8
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000055
56/* Forward */
Jeremy Hyltonaf68c872005-12-10 18:50:16 +000057static int vgetargs1(PyObject *, const char *, va_list *, int);
Victor Stinner84bb1cf2013-05-17 00:12:04 +020058static void seterror(Py_ssize_t, const char *, int *, const char *, const char *);
Serhiy Storchakaef1585e2015-12-25 20:01:53 +020059static const char *convertitem(PyObject *, const char **, va_list *, int, int *,
60 char *, size_t, freelist_t *);
61static const char *converttuple(PyObject *, const char **, va_list *, int,
62 int *, char *, size_t, int, freelist_t *);
63static const char *convertsimple(PyObject *, const char **, va_list *, int,
64 char *, size_t, freelist_t *);
65static Py_ssize_t convertbuffer(PyObject *, void **p, const char **);
66static int getbuffer(PyObject *, Py_buffer *, const char**);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000067
Tim Petersdbd9ba62000-07-09 03:09:57 +000068static int vgetargskeywords(PyObject *, PyObject *,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000069 const char *, char **, va_list *, int);
Serhiy Storchakaef1585e2015-12-25 20:01:53 +020070static const char *skipitem(const char **, va_list *, int);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000071
Fred Drake563dfc22001-10-23 14:41:08 +000072int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +000073PyArg_Parse(PyObject *args, const char *format, ...)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000074{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000075 int retval;
76 va_list va;
Guido van Rossum98297ee2007-11-06 21:34:58 +000077
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000078 va_start(va, format);
79 retval = vgetargs1(args, format, &va, FLAG_COMPAT);
80 va_end(va);
81 return retval;
Martin v. Löwis18e16552006-02-15 17:27:45 +000082}
83
84int
Serhiy Storchakaef1585e2015-12-25 20:01:53 +020085_PyArg_Parse_SizeT(PyObject *args, const char *format, ...)
Martin v. Löwis18e16552006-02-15 17:27:45 +000086{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000087 int retval;
88 va_list va;
Guido van Rossum98297ee2007-11-06 21:34:58 +000089
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000090 va_start(va, format);
91 retval = vgetargs1(args, format, &va, FLAG_COMPAT|FLAG_SIZE_T);
92 va_end(va);
93 return retval;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000094}
95
96
Fred Drake563dfc22001-10-23 14:41:08 +000097int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +000098PyArg_ParseTuple(PyObject *args, const char *format, ...)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000099{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000100 int retval;
101 va_list va;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000102
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000103 va_start(va, format);
104 retval = vgetargs1(args, format, &va, 0);
105 va_end(va);
106 return retval;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000107}
108
Martin v. Löwis18e16552006-02-15 17:27:45 +0000109int
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200110_PyArg_ParseTuple_SizeT(PyObject *args, const char *format, ...)
Martin v. Löwis18e16552006-02-15 17:27:45 +0000111{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000112 int retval;
113 va_list va;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000114
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000115 va_start(va, format);
116 retval = vgetargs1(args, format, &va, FLAG_SIZE_T);
117 va_end(va);
118 return retval;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000119}
120
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000121
122int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000123PyArg_VaParse(PyObject *args, const char *format, va_list va)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000124{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000125 va_list lva;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000126
Alexander Belopolskyf0f45142010-08-11 17:31:17 +0000127 Py_VA_COPY(lva, va);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000128
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000129 return vgetargs1(args, format, &lva, 0);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000130}
131
Martin v. Löwis18e16552006-02-15 17:27:45 +0000132int
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200133_PyArg_VaParse_SizeT(PyObject *args, const char *format, va_list va)
Martin v. Löwis18e16552006-02-15 17:27:45 +0000134{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000135 va_list lva;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000136
Alexander Belopolskyf0f45142010-08-11 17:31:17 +0000137 Py_VA_COPY(lva, va);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000138
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000139 return vgetargs1(args, format, &lva, FLAG_SIZE_T);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000140}
141
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000142
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000143/* Handle cleanup of allocated memory in case of exception */
144
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400145static int
146cleanup_ptr(PyObject *self, void *ptr)
Antoine Pitrouf71995782008-08-29 18:37:05 +0000147{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000148 if (ptr) {
149 PyMem_FREE(ptr);
150 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000151 return 0;
Martin v. Löwisc15bdef2009-05-29 14:47:46 +0000152}
153
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000154static int
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400155cleanup_buffer(PyObject *self, void *ptr)
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000156{
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400157 Py_buffer *buf = (Py_buffer *)ptr;
158 if (buf) {
159 PyBuffer_Release(buf);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000160 }
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400161 return 0;
162}
163
164static int
165addcleanup(void *ptr, freelist_t *freelist, destr_t destructor)
166{
167 int index;
168
169 index = freelist->first_available;
170 freelist->first_available += 1;
171
172 freelist->entries[index].item = ptr;
173 freelist->entries[index].destructor = destructor;
174
175 return 0;
176}
177
178static int
179cleanreturn(int retval, freelist_t *freelist)
180{
181 int index;
182
183 if (retval == 0) {
184 /* A failure occurred, therefore execute all of the cleanup
185 functions.
186 */
187 for (index = 0; index < freelist->first_available; ++index) {
188 freelist->entries[index].destructor(NULL,
189 freelist->entries[index].item);
190 }
191 }
Antoine Pitrou7056cb22013-02-17 01:04:57 +0100192 if (freelist->entries_malloced)
193 PyMem_FREE(freelist->entries);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000194 return retval;
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000195}
196
197
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000198static int
Martin v. Löwis18e16552006-02-15 17:27:45 +0000199vgetargs1(PyObject *args, const char *format, va_list *p_va, int flags)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000200{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000201 char msgbuf[256];
202 int levels[32];
203 const char *fname = NULL;
204 const char *message = NULL;
205 int min = -1;
206 int max = 0;
207 int level = 0;
208 int endfmt = 0;
209 const char *formatsave = format;
210 Py_ssize_t i, len;
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200211 const char *msg;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000212 int compat = flags & FLAG_COMPAT;
Benjamin Peterson40be9e52014-02-11 10:09:27 -0500213 freelistentry_t static_entries[STATIC_FREELIST_ENTRIES];
214 freelist_t freelist;
215
216 freelist.entries = static_entries;
217 freelist.first_available = 0;
218 freelist.entries_malloced = 0;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000219
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000220 assert(compat || (args != (PyObject*)NULL));
221 flags = flags & ~FLAG_COMPAT;
Tim Peters5c4d5bf2001-02-12 22:13:26 +0000222
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000223 while (endfmt == 0) {
224 int c = *format++;
225 switch (c) {
226 case '(':
227 if (level == 0)
228 max++;
229 level++;
230 if (level >= 30)
231 Py_FatalError("too many tuple nesting levels "
232 "in argument format string");
233 break;
234 case ')':
235 if (level == 0)
236 Py_FatalError("excess ')' in getargs format");
237 else
238 level--;
239 break;
240 case '\0':
241 endfmt = 1;
242 break;
243 case ':':
244 fname = format;
245 endfmt = 1;
246 break;
247 case ';':
248 message = format;
249 endfmt = 1;
250 break;
Antoine Pitrou7056cb22013-02-17 01:04:57 +0100251 case '|':
252 if (level == 0)
253 min = max;
254 break;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000255 default:
256 if (level == 0) {
Antoine Pitrou7056cb22013-02-17 01:04:57 +0100257 if (Py_ISALPHA(Py_CHARMASK(c)))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000258 if (c != 'e') /* skip encoded */
259 max++;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000260 }
261 break;
262 }
263 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000264
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000265 if (level != 0)
266 Py_FatalError(/* '(' */ "missing ')' in getargs format");
Guido van Rossum98297ee2007-11-06 21:34:58 +0000267
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000268 if (min < 0)
269 min = max;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000270
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000271 format = formatsave;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000272
Antoine Pitrou7056cb22013-02-17 01:04:57 +0100273 if (max > STATIC_FREELIST_ENTRIES) {
274 freelist.entries = PyMem_NEW(freelistentry_t, max);
275 if (freelist.entries == NULL) {
276 PyErr_NoMemory();
277 return 0;
278 }
279 freelist.entries_malloced = 1;
Benjamin Peterson7ed67272012-03-16 12:21:02 -0500280 }
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400281
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000282 if (compat) {
283 if (max == 0) {
284 if (args == NULL)
285 return 1;
Victor Stinner6ced7c42011-03-21 18:15:42 +0100286 PyErr_Format(PyExc_TypeError,
287 "%.200s%s takes no arguments",
288 fname==NULL ? "function" : fname,
289 fname==NULL ? "" : "()");
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400290 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000291 }
292 else if (min == 1 && max == 1) {
293 if (args == NULL) {
Victor Stinner6ced7c42011-03-21 18:15:42 +0100294 PyErr_Format(PyExc_TypeError,
295 "%.200s%s takes at least one argument",
296 fname==NULL ? "function" : fname,
297 fname==NULL ? "" : "()");
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400298 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000299 }
300 msg = convertitem(args, &format, p_va, flags, levels,
301 msgbuf, sizeof(msgbuf), &freelist);
302 if (msg == NULL)
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400303 return cleanreturn(1, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000304 seterror(levels[0], msg, levels+1, fname, message);
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400305 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000306 }
307 else {
308 PyErr_SetString(PyExc_SystemError,
309 "old style getargs format uses new features");
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400310 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000311 }
312 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000313
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000314 if (!PyTuple_Check(args)) {
315 PyErr_SetString(PyExc_SystemError,
316 "new style getargs format but argument is not a tuple");
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400317 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000318 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000319
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000320 len = PyTuple_GET_SIZE(args);
Guido van Rossum98297ee2007-11-06 21:34:58 +0000321
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000322 if (len < min || max < len) {
Victor Stinner6ced7c42011-03-21 18:15:42 +0100323 if (message == NULL)
324 PyErr_Format(PyExc_TypeError,
325 "%.150s%s takes %s %d argument%s (%ld given)",
326 fname==NULL ? "function" : fname,
327 fname==NULL ? "" : "()",
328 min==max ? "exactly"
329 : len < min ? "at least" : "at most",
330 len < min ? min : max,
331 (len < min ? min : max) == 1 ? "" : "s",
332 Py_SAFE_DOWNCAST(len, Py_ssize_t, long));
333 else
334 PyErr_SetString(PyExc_TypeError, message);
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400335 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000336 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000337
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000338 for (i = 0; i < len; i++) {
339 if (*format == '|')
340 format++;
341 msg = convertitem(PyTuple_GET_ITEM(args, i), &format, p_va,
342 flags, levels, msgbuf,
343 sizeof(msgbuf), &freelist);
344 if (msg) {
Serhiy Storchakac4b813d2016-02-08 01:06:11 +0200345 seterror(i+1, msg, levels, fname, message);
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400346 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000347 }
348 }
Guido van Rossum231a41e1997-12-09 20:36:39 +0000349
Antoine Pitrou4de74572013-02-09 23:11:27 +0100350 if (*format != '\0' && !Py_ISALPHA(Py_CHARMASK(*format)) &&
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000351 *format != '(' &&
352 *format != '|' && *format != ':' && *format != ';') {
353 PyErr_Format(PyExc_SystemError,
354 "bad format string: %.200s", formatsave);
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400355 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000356 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000357
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400358 return cleanreturn(1, &freelist);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000359}
360
361
362
363static void
Victor Stinner84bb1cf2013-05-17 00:12:04 +0200364seterror(Py_ssize_t iarg, const char *msg, int *levels, const char *fname,
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000365 const char *message)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000366{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000367 char buf[512];
368 int i;
369 char *p = buf;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000370
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000371 if (PyErr_Occurred())
372 return;
373 else if (message == NULL) {
374 if (fname != NULL) {
375 PyOS_snprintf(p, sizeof(buf), "%.200s() ", fname);
376 p += strlen(p);
377 }
378 if (iarg != 0) {
379 PyOS_snprintf(p, sizeof(buf) - (p - buf),
Richard Oudkerk25296ce2013-05-18 17:35:19 +0100380 "argument %" PY_FORMAT_SIZE_T "d", iarg);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000381 i = 0;
382 p += strlen(p);
Georg Brandl142ad662013-10-14 07:01:11 +0200383 while (i < 32 && levels[i] > 0 && (int)(p-buf) < 220) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000384 PyOS_snprintf(p, sizeof(buf) - (p - buf),
385 ", item %d", levels[i]-1);
386 p += strlen(p);
387 i++;
388 }
389 }
390 else {
391 PyOS_snprintf(p, sizeof(buf) - (p - buf), "argument");
392 p += strlen(p);
393 }
394 PyOS_snprintf(p, sizeof(buf) - (p - buf), " %.256s", msg);
395 message = buf;
396 }
Serhiy Storchaka4cd63ef2016-02-08 01:22:47 +0200397 if (msg[0] == '(') {
398 PyErr_SetString(PyExc_SystemError, message);
399 }
400 else {
401 PyErr_SetString(PyExc_TypeError, message);
402 }
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000403}
404
405
406/* Convert a tuple argument.
407 On entry, *p_format points to the character _after_ the opening '('.
408 On successful exit, *p_format points to the closing ')'.
409 If successful:
410 *p_format and *p_va are updated,
411 *levels and *msgbuf are untouched,
412 and NULL is returned.
413 If the argument is invalid:
414 *p_format is unchanged,
415 *p_va is undefined,
416 *levels is a 0-terminated list of item numbers,
417 *msgbuf contains an error message, whose format is:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000418 "must be <typename1>, not <typename2>", where:
419 <typename1> is the name of the expected type, and
420 <typename2> is the name of the actual type,
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000421 and msgbuf is returned.
422*/
423
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200424static const char *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000425converttuple(PyObject *arg, const char **p_format, va_list *p_va, int flags,
Guido van Rossum98297ee2007-11-06 21:34:58 +0000426 int *levels, char *msgbuf, size_t bufsize, int toplevel,
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400427 freelist_t *freelist)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000428{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000429 int level = 0;
430 int n = 0;
431 const char *format = *p_format;
432 int i;
Victor Stinner74387f52013-11-18 01:21:12 +0100433 Py_ssize_t len;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000434
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000435 for (;;) {
436 int c = *format++;
437 if (c == '(') {
438 if (level == 0)
439 n++;
440 level++;
441 }
442 else if (c == ')') {
443 if (level == 0)
444 break;
445 level--;
446 }
447 else if (c == ':' || c == ';' || c == '\0')
448 break;
Antoine Pitrou4de74572013-02-09 23:11:27 +0100449 else if (level == 0 && Py_ISALPHA(Py_CHARMASK(c)))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000450 n++;
451 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000452
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000453 if (!PySequence_Check(arg) || PyBytes_Check(arg)) {
454 levels[0] = 0;
455 PyOS_snprintf(msgbuf, bufsize,
456 toplevel ? "expected %d arguments, not %.50s" :
457 "must be %d-item sequence, not %.50s",
458 n,
459 arg == Py_None ? "None" : arg->ob_type->tp_name);
460 return msgbuf;
461 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000462
Victor Stinner74387f52013-11-18 01:21:12 +0100463 len = PySequence_Size(arg);
464 if (len != n) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000465 levels[0] = 0;
Victor Stinner74387f52013-11-18 01:21:12 +0100466 if (toplevel) {
467 PyOS_snprintf(msgbuf, bufsize,
468 "expected %d arguments, not %" PY_FORMAT_SIZE_T "d",
469 n, len);
470 }
471 else {
472 PyOS_snprintf(msgbuf, bufsize,
473 "must be sequence of length %d, "
474 "not %" PY_FORMAT_SIZE_T "d",
475 n, len);
476 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000477 return msgbuf;
478 }
Ka-Ping Yee20579702001-01-15 22:14:16 +0000479
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000480 format = *p_format;
481 for (i = 0; i < n; i++) {
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200482 const char *msg;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000483 PyObject *item;
484 item = PySequence_GetItem(arg, i);
485 if (item == NULL) {
486 PyErr_Clear();
487 levels[0] = i+1;
488 levels[1] = 0;
489 strncpy(msgbuf, "is not retrievable", bufsize);
490 return msgbuf;
491 }
492 msg = convertitem(item, &format, p_va, flags, levels+1,
493 msgbuf, bufsize, freelist);
494 /* PySequence_GetItem calls tp->sq_item, which INCREFs */
495 Py_XDECREF(item);
496 if (msg != NULL) {
497 levels[0] = i+1;
498 return msg;
499 }
500 }
Ka-Ping Yee20579702001-01-15 22:14:16 +0000501
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000502 *p_format = format;
503 return NULL;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000504}
505
506
507/* Convert a single item. */
508
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200509static const char *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000510convertitem(PyObject *arg, const char **p_format, va_list *p_va, int flags,
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400511 int *levels, char *msgbuf, size_t bufsize, freelist_t *freelist)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000512{
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200513 const char *msg;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000514 const char *format = *p_format;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000515
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000516 if (*format == '(' /* ')' */) {
517 format++;
518 msg = converttuple(arg, &format, p_va, flags, levels, msgbuf,
519 bufsize, 0, freelist);
520 if (msg == NULL)
521 format++;
522 }
523 else {
524 msg = convertsimple(arg, &format, p_va, flags,
525 msgbuf, bufsize, freelist);
526 if (msg != NULL)
527 levels[0] = 0;
528 }
529 if (msg == NULL)
530 *p_format = format;
531 return msg;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000532}
533
534
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000535
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000536/* Format an error message generated by convertsimple(). */
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000537
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200538static const char *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000539converterr(const char *expected, PyObject *arg, char *msgbuf, size_t bufsize)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000540{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000541 assert(expected != NULL);
542 assert(arg != NULL);
Serhiy Storchakac4b813d2016-02-08 01:06:11 +0200543 if (expected[0] == '(') {
544 PyOS_snprintf(msgbuf, bufsize,
545 "%.100s", expected);
546 }
547 else {
548 PyOS_snprintf(msgbuf, bufsize,
549 "must be %.50s, not %.50s", expected,
550 arg == Py_None ? "None" : arg->ob_type->tp_name);
551 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000552 return msgbuf;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000553}
554
555#define CONV_UNICODE "(unicode conversion error)"
556
Guido van Rossum45aecf42006-03-15 04:58:47 +0000557/* Explicitly check for float arguments when integers are expected.
558 Return 1 for error, 0 if ok. */
Neil Schemenauer5042da62003-02-04 20:59:40 +0000559static int
560float_argument_error(PyObject *arg)
561{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000562 if (PyFloat_Check(arg)) {
563 PyErr_SetString(PyExc_TypeError,
564 "integer argument expected, got float" );
565 return 1;
566 }
567 else
568 return 0;
Neil Schemenauer5042da62003-02-04 20:59:40 +0000569}
570
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000571/* Convert a non-tuple argument. Return NULL if conversion went OK,
572 or a string with a message describing the failure. The message is
573 formatted as "must be <desired type>, not <actual type>".
574 When failing, an exception may or may not have been raised.
Georg Brandl6dd14612005-09-14 19:29:53 +0000575 Don't call if a tuple is expected.
576
577 When you add new format codes, please don't forget poor skipitem() below.
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000578*/
579
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200580static const char *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000581convertsimple(PyObject *arg, const char **p_format, va_list *p_va, int flags,
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400582 char *msgbuf, size_t bufsize, freelist_t *freelist)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000583{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000584 /* For # codes */
585#define FETCH_SIZE int *q=NULL;Py_ssize_t *q2=NULL;\
586 if (flags & FLAG_SIZE_T) q2=va_arg(*p_va, Py_ssize_t*); \
587 else q=va_arg(*p_va, int*);
Victor Stinnerb3c9e072011-01-04 02:07:34 +0000588#define STORE_SIZE(s) \
589 if (flags & FLAG_SIZE_T) \
590 *q2=s; \
591 else { \
592 if (INT_MAX < s) { \
593 PyErr_SetString(PyExc_OverflowError, \
594 "size does not fit in an int"); \
595 return converterr("", arg, msgbuf, bufsize); \
596 } \
Victor Stinner9550ef32013-06-05 01:18:13 +0200597 *q = (int)s; \
Victor Stinnerb3c9e072011-01-04 02:07:34 +0000598 }
Martin v. Löwis18e16552006-02-15 17:27:45 +0000599#define BUFFER_LEN ((flags & FLAG_SIZE_T) ? *q2:*q)
Victor Stinner6ab8e822011-01-04 11:16:49 +0000600#define RETURN_ERR_OCCURRED return msgbuf
Martin v. Löwis18e16552006-02-15 17:27:45 +0000601
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000602 const char *format = *p_format;
603 char c = *format++;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200604 char *sarg;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000605
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000606 switch (c) {
Guido van Rossum98297ee2007-11-06 21:34:58 +0000607
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000608 case 'b': { /* unsigned byte -- very short int */
609 char *p = va_arg(*p_va, char *);
610 long ival;
611 if (float_argument_error(arg))
Victor Stinner6ab8e822011-01-04 11:16:49 +0000612 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000613 ival = PyLong_AsLong(arg);
614 if (ival == -1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000615 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000616 else if (ival < 0) {
617 PyErr_SetString(PyExc_OverflowError,
Victor Stinner6ab8e822011-01-04 11:16:49 +0000618 "unsigned byte integer is less than minimum");
619 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000620 }
621 else if (ival > UCHAR_MAX) {
622 PyErr_SetString(PyExc_OverflowError,
Victor Stinner6ab8e822011-01-04 11:16:49 +0000623 "unsigned byte integer is greater than maximum");
624 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000625 }
626 else
627 *p = (unsigned char) ival;
628 break;
629 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000630
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000631 case 'B': {/* byte sized bitfield - both signed and unsigned
632 values allowed */
633 char *p = va_arg(*p_va, char *);
634 long ival;
635 if (float_argument_error(arg))
Victor Stinner6ab8e822011-01-04 11:16:49 +0000636 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000637 ival = PyLong_AsUnsignedLongMask(arg);
638 if (ival == -1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000639 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000640 else
641 *p = (unsigned char) ival;
642 break;
643 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000644
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000645 case 'h': {/* signed short int */
646 short *p = va_arg(*p_va, short *);
647 long ival;
648 if (float_argument_error(arg))
Victor Stinner6ab8e822011-01-04 11:16:49 +0000649 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000650 ival = PyLong_AsLong(arg);
651 if (ival == -1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000652 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000653 else if (ival < SHRT_MIN) {
654 PyErr_SetString(PyExc_OverflowError,
Victor Stinner6ab8e822011-01-04 11:16:49 +0000655 "signed short integer is less than minimum");
656 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000657 }
658 else if (ival > SHRT_MAX) {
659 PyErr_SetString(PyExc_OverflowError,
Victor Stinner6ab8e822011-01-04 11:16:49 +0000660 "signed short integer is greater than maximum");
661 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000662 }
663 else
664 *p = (short) ival;
665 break;
666 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000667
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000668 case 'H': { /* short int sized bitfield, both signed and
669 unsigned allowed */
670 unsigned short *p = va_arg(*p_va, unsigned short *);
671 long ival;
672 if (float_argument_error(arg))
Victor Stinner6ab8e822011-01-04 11:16:49 +0000673 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000674 ival = PyLong_AsUnsignedLongMask(arg);
675 if (ival == -1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000676 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000677 else
678 *p = (unsigned short) ival;
679 break;
680 }
Martin v. Löwis18e16552006-02-15 17:27:45 +0000681
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000682 case 'i': {/* signed int */
683 int *p = va_arg(*p_va, int *);
684 long ival;
685 if (float_argument_error(arg))
Victor Stinner6ab8e822011-01-04 11:16:49 +0000686 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000687 ival = PyLong_AsLong(arg);
688 if (ival == -1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000689 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000690 else if (ival > INT_MAX) {
691 PyErr_SetString(PyExc_OverflowError,
Victor Stinner6ab8e822011-01-04 11:16:49 +0000692 "signed integer is greater than maximum");
693 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000694 }
695 else if (ival < INT_MIN) {
696 PyErr_SetString(PyExc_OverflowError,
Victor Stinner6ab8e822011-01-04 11:16:49 +0000697 "signed integer is less than minimum");
698 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000699 }
700 else
701 *p = ival;
702 break;
703 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000704
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000705 case 'I': { /* int sized bitfield, both signed and
706 unsigned allowed */
707 unsigned int *p = va_arg(*p_va, unsigned int *);
708 unsigned int ival;
709 if (float_argument_error(arg))
Victor Stinner6ab8e822011-01-04 11:16:49 +0000710 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000711 ival = (unsigned int)PyLong_AsUnsignedLongMask(arg);
712 if (ival == (unsigned int)-1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000713 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000714 else
715 *p = ival;
716 break;
717 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000718
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000719 case 'n': /* Py_ssize_t */
720 {
721 PyObject *iobj;
722 Py_ssize_t *p = va_arg(*p_va, Py_ssize_t *);
723 Py_ssize_t ival = -1;
724 if (float_argument_error(arg))
Victor Stinner6ab8e822011-01-04 11:16:49 +0000725 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000726 iobj = PyNumber_Index(arg);
727 if (iobj != NULL) {
728 ival = PyLong_AsSsize_t(iobj);
729 Py_DECREF(iobj);
730 }
731 if (ival == -1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000732 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000733 *p = ival;
734 break;
735 }
736 case 'l': {/* long int */
737 long *p = va_arg(*p_va, long *);
738 long ival;
739 if (float_argument_error(arg))
Victor Stinner6ab8e822011-01-04 11:16:49 +0000740 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000741 ival = PyLong_AsLong(arg);
742 if (ival == -1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000743 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000744 else
745 *p = ival;
746 break;
747 }
Thomas Hellera4ea6032003-04-17 18:55:45 +0000748
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000749 case 'k': { /* long sized bitfield */
750 unsigned long *p = va_arg(*p_va, unsigned long *);
751 unsigned long ival;
752 if (PyLong_Check(arg))
753 ival = PyLong_AsUnsignedLongMask(arg);
754 else
Serhiy Storchakac4b813d2016-02-08 01:06:11 +0200755 return converterr("int", arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000756 *p = ival;
757 break;
758 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000759
Guido van Rossum3dbba6e1999-01-25 21:48:56 +0000760#ifdef HAVE_LONG_LONG
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000761 case 'L': {/* PY_LONG_LONG */
762 PY_LONG_LONG *p = va_arg( *p_va, PY_LONG_LONG * );
763 PY_LONG_LONG ival;
Mark Dickinsonc7301312010-06-10 16:05:10 +0000764 if (float_argument_error(arg))
Victor Stinner6ab8e822011-01-04 11:16:49 +0000765 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000766 ival = PyLong_AsLongLong(arg);
Mark Dickinsonc7301312010-06-10 16:05:10 +0000767 if (ival == (PY_LONG_LONG)-1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000768 RETURN_ERR_OCCURRED;
Mark Dickinsonc7301312010-06-10 16:05:10 +0000769 else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000770 *p = ival;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000771 break;
772 }
Thomas Hellera4ea6032003-04-17 18:55:45 +0000773
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000774 case 'K': { /* long long sized bitfield */
775 unsigned PY_LONG_LONG *p = va_arg(*p_va, unsigned PY_LONG_LONG *);
776 unsigned PY_LONG_LONG ival;
777 if (PyLong_Check(arg))
778 ival = PyLong_AsUnsignedLongLongMask(arg);
779 else
Serhiy Storchakac4b813d2016-02-08 01:06:11 +0200780 return converterr("int", arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000781 *p = ival;
782 break;
783 }
Guido van Rossum1a8791e1998-08-04 22:46:29 +0000784#endif
Guido van Rossum98297ee2007-11-06 21:34:58 +0000785
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000786 case 'f': {/* float */
787 float *p = va_arg(*p_va, float *);
788 double dval = PyFloat_AsDouble(arg);
789 if (PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000790 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000791 else
792 *p = (float) dval;
793 break;
794 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000795
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000796 case 'd': {/* double */
797 double *p = va_arg(*p_va, double *);
798 double dval = PyFloat_AsDouble(arg);
799 if (PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000800 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000801 else
802 *p = dval;
803 break;
804 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000805
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000806 case 'D': {/* complex double */
807 Py_complex *p = va_arg(*p_va, Py_complex *);
808 Py_complex cval;
809 cval = PyComplex_AsCComplex(arg);
810 if (PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000811 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000812 else
813 *p = cval;
814 break;
815 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000816
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000817 case 'c': {/* char */
818 char *p = va_arg(*p_va, char *);
819 if (PyBytes_Check(arg) && PyBytes_Size(arg) == 1)
820 *p = PyBytes_AS_STRING(arg)[0];
Eli Bendersky906b88f2011-07-29 07:05:08 +0300821 else if (PyByteArray_Check(arg) && PyByteArray_Size(arg) == 1)
822 *p = PyByteArray_AS_STRING(arg)[0];
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000823 else
824 return converterr("a byte string of length 1", arg, msgbuf, bufsize);
825 break;
826 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000827
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000828 case 'C': {/* unicode char */
829 int *p = va_arg(*p_va, int *);
Victor Stinnere1335c72011-10-04 20:53:03 +0200830 int kind;
831 void *data;
832
833 if (!PyUnicode_Check(arg))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000834 return converterr("a unicode character", arg, msgbuf, bufsize);
Victor Stinnere1335c72011-10-04 20:53:03 +0200835
836 if (PyUnicode_READY(arg))
837 RETURN_ERR_OCCURRED;
838
839 if (PyUnicode_GET_LENGTH(arg) != 1)
840 return converterr("a unicode character", arg, msgbuf, bufsize);
841
842 kind = PyUnicode_KIND(arg);
843 data = PyUnicode_DATA(arg);
844 *p = PyUnicode_READ(kind, data, 0);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000845 break;
846 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000847
Larry Hastingsfaf91e72012-05-05 16:54:29 -0700848 case 'p': {/* boolean *p*redicate */
849 int *p = va_arg(*p_va, int *);
850 int val = PyObject_IsTrue(arg);
851 if (val > 0)
852 *p = 1;
853 else if (val == 0)
854 *p = 0;
855 else
856 RETURN_ERR_OCCURRED;
857 break;
858 }
859
Victor Stinner3dcb5ac2010-06-08 22:54:19 +0000860 /* XXX WAAAAH! 's', 'y', 'z', 'u', 'Z', 'e', 'w' codes all
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000861 need to be cleaned up! */
Guido van Rossum98297ee2007-11-06 21:34:58 +0000862
Serhiy Storchakab757c832014-12-05 22:25:22 +0200863 case 'y': {/* any bytes-like object */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000864 void **p = (void **)va_arg(*p_va, char **);
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200865 const char *buf;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000866 Py_ssize_t count;
867 if (*format == '*') {
868 if (getbuffer(arg, (Py_buffer*)p, &buf) < 0)
869 return converterr(buf, arg, msgbuf, bufsize);
870 format++;
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400871 if (addcleanup(p, freelist, cleanup_buffer)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000872 return converterr(
873 "(cleanup problem)",
874 arg, msgbuf, bufsize);
875 }
876 break;
877 }
878 count = convertbuffer(arg, p, &buf);
879 if (count < 0)
880 return converterr(buf, arg, msgbuf, bufsize);
Victor Stinner06e49dd2010-06-13 18:21:50 +0000881 if (*format == '#') {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000882 FETCH_SIZE;
883 STORE_SIZE(count);
884 format++;
Victor Stinner06e49dd2010-06-13 18:21:50 +0000885 } else {
Serhiy Storchakad8a14472014-09-06 20:07:17 +0300886 if (strlen(*p) != (size_t)count) {
887 PyErr_SetString(PyExc_ValueError, "embedded null byte");
888 RETURN_ERR_OCCURRED;
889 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000890 }
891 break;
892 }
Walter Dörwald612344f2007-05-04 19:28:21 +0000893
Serhiy Storchakab757c832014-12-05 22:25:22 +0200894 case 's': /* text string or bytes-like object */
895 case 'z': /* text string, bytes-like object or None */
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000896 {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000897 if (*format == '*') {
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000898 /* "s*" or "z*" */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000899 Py_buffer *p = (Py_buffer *)va_arg(*p_va, Py_buffer *);
Martin v. Löwis423be952008-08-13 15:53:07 +0000900
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000901 if (c == 'z' && arg == Py_None)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000902 PyBuffer_FillInfo(p, NULL, NULL, 0, 1, 0);
903 else if (PyUnicode_Check(arg)) {
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200904 Py_ssize_t len;
905 sarg = PyUnicode_AsUTF8AndSize(arg, &len);
906 if (sarg == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000907 return converterr(CONV_UNICODE,
908 arg, msgbuf, bufsize);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200909 PyBuffer_FillInfo(p, arg, sarg, len, 1, 0);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000910 }
Serhiy Storchakab757c832014-12-05 22:25:22 +0200911 else { /* any bytes-like object */
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200912 const char *buf;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000913 if (getbuffer(arg, p, &buf) < 0)
914 return converterr(buf, arg, msgbuf, bufsize);
915 }
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400916 if (addcleanup(p, freelist, cleanup_buffer)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000917 return converterr(
918 "(cleanup problem)",
919 arg, msgbuf, bufsize);
920 }
921 format++;
Serhiy Storchakab757c832014-12-05 22:25:22 +0200922 } else if (*format == '#') { /* a string or read-only bytes-like object */
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000923 /* "s#" or "z#" */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000924 void **p = (void **)va_arg(*p_va, char **);
925 FETCH_SIZE;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000926
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000927 if (c == 'z' && arg == Py_None) {
928 *p = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000929 STORE_SIZE(0);
930 }
931 else if (PyUnicode_Check(arg)) {
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200932 Py_ssize_t len;
933 sarg = PyUnicode_AsUTF8AndSize(arg, &len);
934 if (sarg == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000935 return converterr(CONV_UNICODE,
936 arg, msgbuf, bufsize);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200937 *p = sarg;
938 STORE_SIZE(len);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000939 }
Serhiy Storchakab757c832014-12-05 22:25:22 +0200940 else { /* read-only bytes-like object */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000941 /* XXX Really? */
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200942 const char *buf;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000943 Py_ssize_t count = convertbuffer(arg, p, &buf);
944 if (count < 0)
945 return converterr(buf, arg, msgbuf, bufsize);
946 STORE_SIZE(count);
947 }
948 format++;
949 } else {
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000950 /* "s" or "z" */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000951 char **p = va_arg(*p_va, char **);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200952 Py_ssize_t len;
953 sarg = NULL;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000954
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000955 if (c == 'z' && arg == Py_None)
956 *p = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000957 else if (PyUnicode_Check(arg)) {
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200958 sarg = PyUnicode_AsUTF8AndSize(arg, &len);
959 if (sarg == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000960 return converterr(CONV_UNICODE,
961 arg, msgbuf, bufsize);
Serhiy Storchakad8a14472014-09-06 20:07:17 +0300962 if (strlen(sarg) != (size_t)len) {
963 PyErr_SetString(PyExc_ValueError, "embedded null character");
964 RETURN_ERR_OCCURRED;
965 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200966 *p = sarg;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000967 }
968 else
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000969 return converterr(c == 'z' ? "str or None" : "str",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000970 arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000971 }
972 break;
973 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000974
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000975 case 'u': /* raw unicode buffer (Py_UNICODE *) */
976 case 'Z': /* raw unicode buffer or None */
977 {
Brett Cannonb94767f2011-02-22 20:15:44 +0000978 Py_UNICODE **p = va_arg(*p_va, Py_UNICODE **);
979
Serhiy Storchakab757c832014-12-05 22:25:22 +0200980 if (*format == '#') {
Serhiy Storchakad6e53da2015-04-19 21:11:30 +0300981 /* "u#" or "Z#" */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000982 FETCH_SIZE;
Travis E. Oliphantddacf962007-10-13 21:03:27 +0000983
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000984 if (c == 'Z' && arg == Py_None) {
985 *p = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000986 STORE_SIZE(0);
987 }
988 else if (PyUnicode_Check(arg)) {
Victor Stinnerbeac78b2011-10-11 21:55:01 +0200989 Py_ssize_t len;
990 *p = PyUnicode_AsUnicodeAndSize(arg, &len);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200991 if (*p == NULL)
992 RETURN_ERR_OCCURRED;
Victor Stinnerbeac78b2011-10-11 21:55:01 +0200993 STORE_SIZE(len);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000994 }
Victor Stinner5216e6d2010-06-08 21:45:51 +0000995 else
Serhiy Storchakad6e53da2015-04-19 21:11:30 +0300996 return converterr(c == 'Z' ? "str or None" : "str",
997 arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000998 format++;
999 } else {
Serhiy Storchakad6e53da2015-04-19 21:11:30 +03001000 /* "u" or "Z" */
Victor Stinner3c9e6e92010-06-24 22:31:12 +00001001 if (c == 'Z' && arg == Py_None)
1002 *p = NULL;
Victor Stinner06e49dd2010-06-13 18:21:50 +00001003 else if (PyUnicode_Check(arg)) {
Victor Stinnerbeac78b2011-10-11 21:55:01 +02001004 Py_ssize_t len;
1005 *p = PyUnicode_AsUnicodeAndSize(arg, &len);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001006 if (*p == NULL)
1007 RETURN_ERR_OCCURRED;
Serhiy Storchakad8a14472014-09-06 20:07:17 +03001008 if (Py_UNICODE_strlen(*p) != (size_t)len) {
1009 PyErr_SetString(PyExc_ValueError, "embedded null character");
1010 RETURN_ERR_OCCURRED;
1011 }
Victor Stinner06e49dd2010-06-13 18:21:50 +00001012 } else
Victor Stinner3c9e6e92010-06-24 22:31:12 +00001013 return converterr(c == 'Z' ? "str or None" : "str",
1014 arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001015 }
1016 break;
1017 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001018
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001019 case 'e': {/* encoded string */
1020 char **buffer;
1021 const char *encoding;
1022 PyObject *s;
1023 int recode_strings;
1024 Py_ssize_t size;
1025 const char *ptr;
Jeremy Hylton4819e972001-10-11 14:40:37 +00001026
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001027 /* Get 'e' parameter: the encoding name */
1028 encoding = (const char *)va_arg(*p_va, const char *);
1029 if (encoding == NULL)
1030 encoding = PyUnicode_GetDefaultEncoding();
Martin v. Löwis423be952008-08-13 15:53:07 +00001031
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001032 /* Get output buffer parameter:
1033 's' (recode all objects via Unicode) or
1034 't' (only recode non-string objects)
1035 */
1036 if (*format == 's')
1037 recode_strings = 1;
1038 else if (*format == 't')
1039 recode_strings = 0;
1040 else
1041 return converterr(
1042 "(unknown parser marker combination)",
1043 arg, msgbuf, bufsize);
1044 buffer = (char **)va_arg(*p_va, char **);
1045 format++;
1046 if (buffer == NULL)
1047 return converterr("(buffer is NULL)",
1048 arg, msgbuf, bufsize);
Benjamin Peterson9edd2bd2008-08-27 00:31:37 +00001049
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001050 /* Encode object */
1051 if (!recode_strings &&
1052 (PyBytes_Check(arg) || PyByteArray_Check(arg))) {
1053 s = arg;
1054 Py_INCREF(s);
1055 if (PyObject_AsCharBuffer(s, &ptr, &size) < 0)
1056 return converterr("(AsCharBuffer failed)",
1057 arg, msgbuf, bufsize);
1058 }
1059 else {
1060 PyObject *u;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001061
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001062 /* Convert object to Unicode */
1063 u = PyUnicode_FromObject(arg);
1064 if (u == NULL)
1065 return converterr(
1066 "string or unicode or text buffer",
1067 arg, msgbuf, bufsize);
Guido van Rossum98297ee2007-11-06 21:34:58 +00001068
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001069 /* Encode object; use default error handling */
1070 s = PyUnicode_AsEncodedString(u,
1071 encoding,
1072 NULL);
1073 Py_DECREF(u);
1074 if (s == NULL)
1075 return converterr("(encoding failed)",
1076 arg, msgbuf, bufsize);
1077 if (!PyBytes_Check(s)) {
1078 Py_DECREF(s);
1079 return converterr(
1080 "(encoder failed to return bytes)",
1081 arg, msgbuf, bufsize);
1082 }
1083 size = PyBytes_GET_SIZE(s);
1084 ptr = PyBytes_AS_STRING(s);
1085 if (ptr == NULL)
1086 ptr = "";
1087 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001088
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001089 /* Write output; output is guaranteed to be 0-terminated */
1090 if (*format == '#') {
1091 /* Using buffer length parameter '#':
1092
1093 - if *buffer is NULL, a new buffer of the
1094 needed size is allocated and the data
1095 copied into it; *buffer is updated to point
1096 to the new buffer; the caller is
1097 responsible for PyMem_Free()ing it after
1098 usage
1099
1100 - if *buffer is not NULL, the data is
1101 copied to *buffer; *buffer_len has to be
1102 set to the size of the buffer on input;
1103 buffer overflow is signalled with an error;
1104 buffer has to provide enough room for the
1105 encoded string plus the trailing 0-byte
1106
1107 - in both cases, *buffer_len is updated to
1108 the size of the buffer /excluding/ the
1109 trailing 0-byte
1110
1111 */
1112 FETCH_SIZE;
1113
1114 format++;
1115 if (q == NULL && q2 == NULL) {
1116 Py_DECREF(s);
1117 return converterr(
1118 "(buffer_len is NULL)",
1119 arg, msgbuf, bufsize);
1120 }
1121 if (*buffer == NULL) {
1122 *buffer = PyMem_NEW(char, size + 1);
1123 if (*buffer == NULL) {
1124 Py_DECREF(s);
Victor Stinner2872e5b2010-06-06 20:38:02 +00001125 PyErr_NoMemory();
Victor Stinner6ab8e822011-01-04 11:16:49 +00001126 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001127 }
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001128 if (addcleanup(*buffer, freelist, cleanup_ptr)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001129 Py_DECREF(s);
1130 return converterr(
1131 "(cleanup problem)",
1132 arg, msgbuf, bufsize);
1133 }
1134 } else {
1135 if (size + 1 > BUFFER_LEN) {
1136 Py_DECREF(s);
Serhiy Storchaka4cd63ef2016-02-08 01:22:47 +02001137 PyErr_Format(PyExc_ValueError,
Serhiy Storchakac4b813d2016-02-08 01:06:11 +02001138 "encoded string too long "
1139 "(%zd, maximum length %zd)",
1140 (Py_ssize_t)size, (Py_ssize_t)(BUFFER_LEN-1));
1141 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001142 }
1143 }
1144 memcpy(*buffer, ptr, size+1);
1145 STORE_SIZE(size);
1146 } else {
1147 /* Using a 0-terminated buffer:
1148
1149 - the encoded string has to be 0-terminated
1150 for this variant to work; if it is not, an
1151 error raised
1152
1153 - a new buffer of the needed size is
1154 allocated and the data copied into it;
1155 *buffer is updated to point to the new
1156 buffer; the caller is responsible for
1157 PyMem_Free()ing it after usage
1158
1159 */
1160 if ((Py_ssize_t)strlen(ptr) != size) {
1161 Py_DECREF(s);
1162 return converterr(
Serhiy Storchakac4b813d2016-02-08 01:06:11 +02001163 "encoded string without null bytes",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001164 arg, msgbuf, bufsize);
1165 }
1166 *buffer = PyMem_NEW(char, size + 1);
1167 if (*buffer == NULL) {
1168 Py_DECREF(s);
Victor Stinner2872e5b2010-06-06 20:38:02 +00001169 PyErr_NoMemory();
Victor Stinner6ab8e822011-01-04 11:16:49 +00001170 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001171 }
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001172 if (addcleanup(*buffer, freelist, cleanup_ptr)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001173 Py_DECREF(s);
1174 return converterr("(cleanup problem)",
1175 arg, msgbuf, bufsize);
1176 }
1177 memcpy(*buffer, ptr, size+1);
1178 }
1179 Py_DECREF(s);
1180 break;
1181 }
1182
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001183 case 'S': { /* PyBytes object */
1184 PyObject **p = va_arg(*p_va, PyObject **);
1185 if (PyBytes_Check(arg))
1186 *p = arg;
1187 else
1188 return converterr("bytes", arg, msgbuf, bufsize);
1189 break;
1190 }
1191
1192 case 'Y': { /* PyByteArray object */
1193 PyObject **p = va_arg(*p_va, PyObject **);
1194 if (PyByteArray_Check(arg))
1195 *p = arg;
1196 else
Victor Stinner5216e6d2010-06-08 21:45:51 +00001197 return converterr("bytearray", arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001198 break;
1199 }
1200
1201 case 'U': { /* PyUnicode object */
1202 PyObject **p = va_arg(*p_va, PyObject **);
Victor Stinnera1b0c9f2012-05-29 12:30:29 +02001203 if (PyUnicode_Check(arg)) {
1204 if (PyUnicode_READY(arg) == -1)
1205 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001206 *p = arg;
Victor Stinnera1b0c9f2012-05-29 12:30:29 +02001207 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001208 else
1209 return converterr("str", arg, msgbuf, bufsize);
1210 break;
1211 }
1212
1213 case 'O': { /* object */
1214 PyTypeObject *type;
1215 PyObject **p;
1216 if (*format == '!') {
1217 type = va_arg(*p_va, PyTypeObject*);
1218 p = va_arg(*p_va, PyObject **);
1219 format++;
1220 if (PyType_IsSubtype(arg->ob_type, type))
1221 *p = arg;
1222 else
1223 return converterr(type->tp_name, arg, msgbuf, bufsize);
1224
1225 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001226 else if (*format == '&') {
1227 typedef int (*converter)(PyObject *, void *);
1228 converter convert = va_arg(*p_va, converter);
1229 void *addr = va_arg(*p_va, void *);
1230 int res;
1231 format++;
1232 if (! (res = (*convert)(arg, addr)))
1233 return converterr("(unspecified)",
1234 arg, msgbuf, bufsize);
1235 if (res == Py_CLEANUP_SUPPORTED &&
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001236 addcleanup(addr, freelist, convert) == -1)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001237 return converterr("(cleanup problem)",
1238 arg, msgbuf, bufsize);
1239 }
1240 else {
1241 p = va_arg(*p_va, PyObject **);
1242 *p = arg;
1243 }
1244 break;
1245 }
1246
1247
Victor Stinner25e8ec42010-06-25 00:02:38 +00001248 case 'w': { /* "w*": memory buffer, read-write access */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001249 void **p = va_arg(*p_va, void **);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001250
Victor Stinner25e8ec42010-06-25 00:02:38 +00001251 if (*format != '*')
1252 return converterr(
Serhiy Storchakac4b813d2016-02-08 01:06:11 +02001253 "(invalid use of 'w' format character)",
Victor Stinner25e8ec42010-06-25 00:02:38 +00001254 arg, msgbuf, bufsize);
1255 format++;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001256
Victor Stinner25e8ec42010-06-25 00:02:38 +00001257 /* Caller is interested in Py_buffer, and the object
1258 supports it directly. */
1259 if (PyObject_GetBuffer(arg, (Py_buffer*)p, PyBUF_WRITABLE) < 0) {
1260 PyErr_Clear();
R David Murray861470c2014-10-05 11:47:01 -04001261 return converterr("read-write bytes-like object",
1262 arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001263 }
Victor Stinner8182b712010-07-28 00:40:58 +00001264 if (!PyBuffer_IsContiguous((Py_buffer*)p, 'C')) {
1265 PyBuffer_Release((Py_buffer*)p);
1266 return converterr("contiguous buffer", arg, msgbuf, bufsize);
1267 }
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001268 if (addcleanup(p, freelist, cleanup_buffer)) {
Victor Stinner25e8ec42010-06-25 00:02:38 +00001269 return converterr(
1270 "(cleanup problem)",
1271 arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001272 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001273 break;
1274 }
1275
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001276 default:
Serhiy Storchakac4b813d2016-02-08 01:06:11 +02001277 return converterr("(impossible<bad format char>)", arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001278
1279 }
1280
1281 *p_format = format;
1282 return NULL;
Victor Stinner6ab8e822011-01-04 11:16:49 +00001283
1284#undef FETCH_SIZE
1285#undef STORE_SIZE
1286#undef BUFFER_LEN
1287#undef RETURN_ERR_OCCURRED
Guido van Rossumfe3f1a21994-09-29 09:42:55 +00001288}
Guido van Rossumaa354651996-08-19 19:32:04 +00001289
Martin v. Löwis18e16552006-02-15 17:27:45 +00001290static Py_ssize_t
Serhiy Storchakaef1585e2015-12-25 20:01:53 +02001291convertbuffer(PyObject *arg, void **p, const char **errmsg)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001292{
Victor Stinner5cb62392010-06-06 20:27:51 +00001293 PyBufferProcs *pb = Py_TYPE(arg)->tp_as_buffer;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001294 Py_ssize_t count;
1295 Py_buffer view;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001296
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001297 *errmsg = NULL;
1298 *p = NULL;
Victor Stinner8182b712010-07-28 00:40:58 +00001299 if (pb != NULL && pb->bf_releasebuffer != NULL) {
R David Murray861470c2014-10-05 11:47:01 -04001300 *errmsg = "read-only bytes-like object";
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001301 return -1;
1302 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001303
Victor Stinner8182b712010-07-28 00:40:58 +00001304 if (getbuffer(arg, &view, errmsg) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001305 return -1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001306 count = view.len;
1307 *p = view.buf;
1308 PyBuffer_Release(&view);
1309 return count;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001310}
Guido van Rossumaa354651996-08-19 19:32:04 +00001311
Martin v. Löwis423be952008-08-13 15:53:07 +00001312static int
Serhiy Storchakaef1585e2015-12-25 20:01:53 +02001313getbuffer(PyObject *arg, Py_buffer *view, const char **errmsg)
Martin v. Löwis423be952008-08-13 15:53:07 +00001314{
Victor Stinner8182b712010-07-28 00:40:58 +00001315 if (PyObject_GetBuffer(arg, view, PyBUF_SIMPLE) != 0) {
R David Murray861470c2014-10-05 11:47:01 -04001316 *errmsg = "bytes-like object";
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001317 return -1;
1318 }
Victor Stinner5cb62392010-06-06 20:27:51 +00001319 if (!PyBuffer_IsContiguous(view, 'C')) {
Victor Stinner21e09482010-06-24 22:57:10 +00001320 PyBuffer_Release(view);
Victor Stinner5cb62392010-06-06 20:27:51 +00001321 *errmsg = "contiguous buffer";
1322 return -1;
1323 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001324 return 0;
Martin v. Löwis423be952008-08-13 15:53:07 +00001325}
1326
Guido van Rossumaa354651996-08-19 19:32:04 +00001327/* Support for keyword arguments donated by
1328 Geoff Philbrick <philbric@delphi.hks.com> */
1329
Tim Petersf8cd3e82001-10-27 04:26:57 +00001330/* Return false (0) for error, else true. */
Fred Drake563dfc22001-10-23 14:41:08 +00001331int
1332PyArg_ParseTupleAndKeywords(PyObject *args,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001333 PyObject *keywords,
1334 const char *format,
1335 char **kwlist, ...)
Guido van Rossumaa354651996-08-19 19:32:04 +00001336{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001337 int retval;
1338 va_list va;
Tim Peters45772cd2001-10-27 03:58:40 +00001339
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001340 if ((args == NULL || !PyTuple_Check(args)) ||
1341 (keywords != NULL && !PyDict_Check(keywords)) ||
1342 format == NULL ||
1343 kwlist == NULL)
1344 {
1345 PyErr_BadInternalCall();
1346 return 0;
1347 }
Tim Peters45772cd2001-10-27 03:58:40 +00001348
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001349 va_start(va, kwlist);
1350 retval = vgetargskeywords(args, keywords, format, kwlist, &va, 0);
1351 va_end(va);
1352 return retval;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001353}
1354
1355int
1356_PyArg_ParseTupleAndKeywords_SizeT(PyObject *args,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001357 PyObject *keywords,
1358 const char *format,
1359 char **kwlist, ...)
Martin v. Löwis18e16552006-02-15 17:27:45 +00001360{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001361 int retval;
1362 va_list va;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001363
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001364 if ((args == NULL || !PyTuple_Check(args)) ||
1365 (keywords != NULL && !PyDict_Check(keywords)) ||
1366 format == NULL ||
1367 kwlist == NULL)
1368 {
1369 PyErr_BadInternalCall();
1370 return 0;
1371 }
Martin v. Löwis18e16552006-02-15 17:27:45 +00001372
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001373 va_start(va, kwlist);
1374 retval = vgetargskeywords(args, keywords, format,
1375 kwlist, &va, FLAG_SIZE_T);
1376 va_end(va);
1377 return retval;
Guido van Rossumaa354651996-08-19 19:32:04 +00001378}
1379
1380
Brett Cannon711e7d92004-07-10 22:20:32 +00001381int
1382PyArg_VaParseTupleAndKeywords(PyObject *args,
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001383 PyObject *keywords,
Guido van Rossum98297ee2007-11-06 21:34:58 +00001384 const char *format,
Martin v. Löwis15e62742006-02-27 16:46:16 +00001385 char **kwlist, va_list va)
Brett Cannon711e7d92004-07-10 22:20:32 +00001386{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001387 int retval;
1388 va_list lva;
Brett Cannon711e7d92004-07-10 22:20:32 +00001389
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001390 if ((args == NULL || !PyTuple_Check(args)) ||
1391 (keywords != NULL && !PyDict_Check(keywords)) ||
1392 format == NULL ||
1393 kwlist == NULL)
1394 {
1395 PyErr_BadInternalCall();
1396 return 0;
1397 }
Brett Cannon711e7d92004-07-10 22:20:32 +00001398
Alexander Belopolskyf0f45142010-08-11 17:31:17 +00001399 Py_VA_COPY(lva, va);
Brett Cannon711e7d92004-07-10 22:20:32 +00001400
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001401 retval = vgetargskeywords(args, keywords, format, kwlist, &lva, 0);
1402 return retval;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001403}
1404
1405int
1406_PyArg_VaParseTupleAndKeywords_SizeT(PyObject *args,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001407 PyObject *keywords,
1408 const char *format,
1409 char **kwlist, va_list va)
Martin v. Löwis18e16552006-02-15 17:27:45 +00001410{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001411 int retval;
1412 va_list lva;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001413
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001414 if ((args == NULL || !PyTuple_Check(args)) ||
1415 (keywords != NULL && !PyDict_Check(keywords)) ||
1416 format == NULL ||
1417 kwlist == NULL)
1418 {
1419 PyErr_BadInternalCall();
1420 return 0;
1421 }
Martin v. Löwis18e16552006-02-15 17:27:45 +00001422
Alexander Belopolskyf0f45142010-08-11 17:31:17 +00001423 Py_VA_COPY(lva, va);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001424
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001425 retval = vgetargskeywords(args, keywords, format,
1426 kwlist, &lva, FLAG_SIZE_T);
1427 return retval;
Brett Cannon711e7d92004-07-10 22:20:32 +00001428}
1429
Benjamin Petersonfb886362010-04-24 18:21:17 +00001430int
1431PyArg_ValidateKeywordArguments(PyObject *kwargs)
1432{
Benjamin Petersonf6096542010-11-17 22:33:12 +00001433 if (!PyDict_Check(kwargs)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001434 PyErr_BadInternalCall();
1435 return 0;
1436 }
1437 if (!_PyDict_HasOnlyStringKeys(kwargs)) {
1438 PyErr_SetString(PyExc_TypeError,
1439 "keyword arguments must be strings");
1440 return 0;
1441 }
1442 return 1;
Benjamin Petersonfb886362010-04-24 18:21:17 +00001443}
1444
Christian Heimes380f7f22008-02-28 11:19:05 +00001445#define IS_END_OF_FORMAT(c) (c == '\0' || c == ';' || c == ':')
Brett Cannon711e7d92004-07-10 22:20:32 +00001446
Guido van Rossumaa354651996-08-19 19:32:04 +00001447static int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001448vgetargskeywords(PyObject *args, PyObject *keywords, const char *format,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001449 char **kwlist, va_list *p_va, int flags)
Guido van Rossumaa354651996-08-19 19:32:04 +00001450{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001451 char msgbuf[512];
1452 int levels[32];
1453 const char *fname, *msg, *custom_msg, *keyword;
1454 int min = INT_MAX;
Larry Hastings83a9f482012-03-20 20:06:16 +00001455 int max = INT_MAX;
Victor Stinner74387f52013-11-18 01:21:12 +01001456 int i, len;
1457 Py_ssize_t nargs, nkeywords;
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001458 PyObject *current_arg;
Antoine Pitrou7056cb22013-02-17 01:04:57 +01001459 freelistentry_t static_entries[STATIC_FREELIST_ENTRIES];
Benjamin Peterson40be9e52014-02-11 10:09:27 -05001460 freelist_t freelist;
1461
1462 freelist.entries = static_entries;
1463 freelist.first_available = 0;
1464 freelist.entries_malloced = 0;
Tim Petersf4331c12001-10-27 00:17:34 +00001465
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001466 assert(args != NULL && PyTuple_Check(args));
1467 assert(keywords == NULL || PyDict_Check(keywords));
1468 assert(format != NULL);
1469 assert(kwlist != NULL);
1470 assert(p_va != NULL);
Tim Peters45772cd2001-10-27 03:58:40 +00001471
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001472 /* grab the function name or custom error msg first (mutually exclusive) */
1473 fname = strchr(format, ':');
1474 if (fname) {
1475 fname++;
1476 custom_msg = NULL;
1477 }
1478 else {
1479 custom_msg = strchr(format,';');
1480 if (custom_msg)
1481 custom_msg++;
1482 }
Christian Heimes380f7f22008-02-28 11:19:05 +00001483
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001484 /* scan kwlist and get greatest possible nbr of args */
1485 for (len=0; kwlist[len]; len++)
1486 continue;
Tim Petersf8cd3e82001-10-27 04:26:57 +00001487
Antoine Pitrou7056cb22013-02-17 01:04:57 +01001488 if (len > STATIC_FREELIST_ENTRIES) {
1489 freelist.entries = PyMem_NEW(freelistentry_t, len);
1490 if (freelist.entries == NULL) {
1491 PyErr_NoMemory();
1492 return 0;
1493 }
1494 freelist.entries_malloced = 1;
Benjamin Peterson7ed67272012-03-16 12:21:02 -05001495 }
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001496
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001497 nargs = PyTuple_GET_SIZE(args);
1498 nkeywords = (keywords == NULL) ? 0 : PyDict_Size(keywords);
1499 if (nargs + nkeywords > len) {
Victor Stinner6ced7c42011-03-21 18:15:42 +01001500 PyErr_Format(PyExc_TypeError,
Victor Stinnercb29ec52013-11-18 02:05:31 +01001501 "%s%s takes at most %d argument%s (%zd given)",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001502 (fname == NULL) ? "function" : fname,
1503 (fname == NULL) ? "" : "()",
1504 len,
1505 (len == 1) ? "" : "s",
1506 nargs + nkeywords);
Benjamin Peterson01feaec2012-03-16 13:25:58 -05001507 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001508 }
Tim Petersc2f01122001-10-27 07:25:06 +00001509
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001510 /* convert tuple args and keyword args in same loop, using kwlist to drive process */
1511 for (i = 0; i < len; i++) {
1512 keyword = kwlist[i];
1513 if (*format == '|') {
Larry Hastings83a9f482012-03-20 20:06:16 +00001514 if (min != INT_MAX) {
Serhiy Storchakaa9725f82016-02-11 12:41:40 +02001515 PyErr_SetString(PyExc_SystemError,
Larry Hastings83a9f482012-03-20 20:06:16 +00001516 "Invalid format string (| specified twice)");
1517 return cleanreturn(0, &freelist);
1518 }
1519
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001520 min = i;
1521 format++;
Larry Hastings83a9f482012-03-20 20:06:16 +00001522
1523 if (max != INT_MAX) {
Serhiy Storchakaa9725f82016-02-11 12:41:40 +02001524 PyErr_SetString(PyExc_SystemError,
Larry Hastings83a9f482012-03-20 20:06:16 +00001525 "Invalid format string ($ before |)");
1526 return cleanreturn(0, &freelist);
1527 }
1528 }
1529 if (*format == '$') {
1530 if (max != INT_MAX) {
Serhiy Storchakaa9725f82016-02-11 12:41:40 +02001531 PyErr_SetString(PyExc_SystemError,
Larry Hastings83a9f482012-03-20 20:06:16 +00001532 "Invalid format string ($ specified twice)");
1533 return cleanreturn(0, &freelist);
1534 }
1535
1536 max = i;
1537 format++;
1538
1539 if (max < nargs) {
1540 PyErr_Format(PyExc_TypeError,
1541 "Function takes %s %d positional arguments"
1542 " (%d given)",
1543 (min != INT_MAX) ? "at most" : "exactly",
1544 max, nargs);
1545 return cleanreturn(0, &freelist);
1546 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001547 }
1548 if (IS_END_OF_FORMAT(*format)) {
Serhiy Storchakaa9725f82016-02-11 12:41:40 +02001549 PyErr_Format(PyExc_SystemError,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001550 "More keyword list entries (%d) than "
1551 "format specifiers (%d)", len, i);
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001552 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001553 }
1554 current_arg = NULL;
1555 if (nkeywords) {
1556 current_arg = PyDict_GetItemString(keywords, keyword);
1557 }
1558 if (current_arg) {
1559 --nkeywords;
1560 if (i < nargs) {
1561 /* arg present in tuple and in dict */
1562 PyErr_Format(PyExc_TypeError,
1563 "Argument given by name ('%s') "
1564 "and position (%d)",
1565 keyword, i+1);
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001566 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001567 }
1568 }
1569 else if (nkeywords && PyErr_Occurred())
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001570 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001571 else if (i < nargs)
1572 current_arg = PyTuple_GET_ITEM(args, i);
Christian Heimes380f7f22008-02-28 11:19:05 +00001573
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001574 if (current_arg) {
1575 msg = convertitem(current_arg, &format, p_va, flags,
1576 levels, msgbuf, sizeof(msgbuf), &freelist);
1577 if (msg) {
1578 seterror(i+1, msg, levels, fname, custom_msg);
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001579 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001580 }
1581 continue;
1582 }
Christian Heimes380f7f22008-02-28 11:19:05 +00001583
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001584 if (i < min) {
1585 PyErr_Format(PyExc_TypeError, "Required argument "
1586 "'%s' (pos %d) not found",
1587 keyword, i+1);
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001588 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001589 }
1590 /* current code reports success when all required args
1591 * fulfilled and no keyword args left, with no further
1592 * validation. XXX Maybe skip this in debug build ?
1593 */
1594 if (!nkeywords)
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001595 return cleanreturn(1, &freelist);
Guido van Rossumaa354651996-08-19 19:32:04 +00001596
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001597 /* We are into optional args, skip thru to any remaining
1598 * keyword args */
1599 msg = skipitem(&format, p_va, flags);
1600 if (msg) {
Serhiy Storchakaa9725f82016-02-11 12:41:40 +02001601 PyErr_Format(PyExc_SystemError, "%s: '%s'", msg,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001602 format);
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001603 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001604 }
1605 }
Tim Petersb054be42001-10-27 05:07:41 +00001606
Larry Hastings83a9f482012-03-20 20:06:16 +00001607 if (!IS_END_OF_FORMAT(*format) && (*format != '|') && (*format != '$')) {
Serhiy Storchakaa9725f82016-02-11 12:41:40 +02001608 PyErr_Format(PyExc_SystemError,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001609 "more argument specifiers than keyword list entries "
1610 "(remaining format:'%s')", format);
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001611 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001612 }
Tim Petersc2f01122001-10-27 07:25:06 +00001613
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001614 /* make sure there are no extraneous keyword arguments */
1615 if (nkeywords > 0) {
1616 PyObject *key, *value;
1617 Py_ssize_t pos = 0;
1618 while (PyDict_Next(keywords, &pos, &key, &value)) {
1619 int match = 0;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001620 if (!PyUnicode_Check(key)) {
1621 PyErr_SetString(PyExc_TypeError,
1622 "keywords must be strings");
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001623 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001624 }
Antoine Pitrou7056cb22013-02-17 01:04:57 +01001625 for (i = 0; i < len; i++) {
1626 if (!PyUnicode_CompareWithASCIIString(key, kwlist[i])) {
1627 match = 1;
1628 break;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001629 }
1630 }
1631 if (!match) {
1632 PyErr_Format(PyExc_TypeError,
Victor Stinner93b55132010-05-19 00:54:06 +00001633 "'%U' is an invalid keyword "
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001634 "argument for this function",
Victor Stinner93b55132010-05-19 00:54:06 +00001635 key);
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001636 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001637 }
1638 }
1639 }
1640
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001641 return cleanreturn(1, &freelist);
Guido van Rossumaa354651996-08-19 19:32:04 +00001642}
1643
1644
Serhiy Storchakaef1585e2015-12-25 20:01:53 +02001645static const char *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001646skipitem(const char **p_format, va_list *p_va, int flags)
Guido van Rossumaa354651996-08-19 19:32:04 +00001647{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001648 const char *format = *p_format;
1649 char c = *format++;
Guido van Rossum98297ee2007-11-06 21:34:58 +00001650
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001651 switch (c) {
Georg Brandl6dd14612005-09-14 19:29:53 +00001652
Larry Hastingsa3479012012-05-08 23:52:03 -07001653 /*
1654 * codes that take a single data pointer as an argument
1655 * (the type of the pointer is irrelevant)
1656 */
Georg Brandl6dd14612005-09-14 19:29:53 +00001657
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001658 case 'b': /* byte -- very short int */
1659 case 'B': /* byte as bitfield */
1660 case 'h': /* short int */
1661 case 'H': /* short int as bitfield */
1662 case 'i': /* int */
1663 case 'I': /* int sized bitfield */
1664 case 'l': /* long int */
1665 case 'k': /* long int sized bitfield */
Guido van Rossum3dbba6e1999-01-25 21:48:56 +00001666#ifdef HAVE_LONG_LONG
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001667 case 'L': /* PY_LONG_LONG */
1668 case 'K': /* PY_LONG_LONG sized bitfield */
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001669#endif
Larry Hastingsa3479012012-05-08 23:52:03 -07001670 case 'n': /* Py_ssize_t */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001671 case 'f': /* float */
1672 case 'd': /* double */
1673 case 'D': /* complex double */
1674 case 'c': /* char */
1675 case 'C': /* unicode char */
Larry Hastings10ba07a2012-05-07 02:44:50 -07001676 case 'p': /* boolean predicate */
Larry Hastingsa3479012012-05-08 23:52:03 -07001677 case 'S': /* string object */
1678 case 'Y': /* string object */
1679 case 'U': /* unicode string object */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001680 {
1681 (void) va_arg(*p_va, void *);
1682 break;
1683 }
Martin v. Löwis18e16552006-02-15 17:27:45 +00001684
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001685 /* string codes */
Guido van Rossum98297ee2007-11-06 21:34:58 +00001686
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001687 case 'e': /* string with encoding */
1688 {
1689 (void) va_arg(*p_va, const char *);
1690 if (!(*format == 's' || *format == 't'))
1691 /* after 'e', only 's' and 't' is allowed */
1692 goto err;
1693 format++;
1694 /* explicit fallthrough to string cases */
1695 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001696
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001697 case 's': /* string */
1698 case 'z': /* string or None */
1699 case 'y': /* bytes */
1700 case 'u': /* unicode string */
Larry Hastingsd9e4a412012-05-08 03:51:18 -07001701 case 'Z': /* unicode string or None */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001702 case 'w': /* buffer, read-write */
1703 {
1704 (void) va_arg(*p_va, char **);
1705 if (*format == '#') {
1706 if (flags & FLAG_SIZE_T)
1707 (void) va_arg(*p_va, Py_ssize_t *);
1708 else
1709 (void) va_arg(*p_va, int *);
1710 format++;
1711 } else if ((c == 's' || c == 'z' || c == 'y') && *format == '*') {
1712 format++;
1713 }
1714 break;
1715 }
Georg Brandl6dd14612005-09-14 19:29:53 +00001716
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001717 case 'O': /* object */
1718 {
1719 if (*format == '!') {
1720 format++;
1721 (void) va_arg(*p_va, PyTypeObject*);
1722 (void) va_arg(*p_va, PyObject **);
1723 }
1724 else if (*format == '&') {
1725 typedef int (*converter)(PyObject *, void *);
1726 (void) va_arg(*p_va, converter);
1727 (void) va_arg(*p_va, void *);
1728 format++;
1729 }
1730 else {
1731 (void) va_arg(*p_va, PyObject **);
1732 }
1733 break;
1734 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001735
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001736 case '(': /* bypass tuple, not handled at all previously */
1737 {
Serhiy Storchakaef1585e2015-12-25 20:01:53 +02001738 const char *msg;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001739 for (;;) {
1740 if (*format==')')
1741 break;
1742 if (IS_END_OF_FORMAT(*format))
1743 return "Unmatched left paren in format "
1744 "string";
1745 msg = skipitem(&format, p_va, flags);
1746 if (msg)
1747 return msg;
1748 }
1749 format++;
1750 break;
1751 }
Christian Heimes380f7f22008-02-28 11:19:05 +00001752
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001753 case ')':
1754 return "Unmatched right paren in format string";
Christian Heimes380f7f22008-02-28 11:19:05 +00001755
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001756 default:
Georg Brandl6dd14612005-09-14 19:29:53 +00001757err:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001758 return "impossible<bad format char>";
Guido van Rossum98297ee2007-11-06 21:34:58 +00001759
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001760 }
Georg Brandl6dd14612005-09-14 19:29:53 +00001761
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001762 *p_format = format;
1763 return NULL;
Guido van Rossumaa354651996-08-19 19:32:04 +00001764}
Fred Drakee4616e62001-10-23 21:09:29 +00001765
1766
1767int
Martin v. Löwis76246742006-03-01 04:06:10 +00001768PyArg_UnpackTuple(PyObject *args, const char *name, Py_ssize_t min, Py_ssize_t max, ...)
Fred Drakee4616e62001-10-23 21:09:29 +00001769{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001770 Py_ssize_t i, l;
1771 PyObject **o;
1772 va_list vargs;
Fred Drakee4616e62001-10-23 21:09:29 +00001773
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001774 assert(min >= 0);
1775 assert(min <= max);
1776 if (!PyTuple_Check(args)) {
1777 PyErr_SetString(PyExc_SystemError,
1778 "PyArg_UnpackTuple() argument list is not a tuple");
1779 return 0;
1780 }
1781 l = PyTuple_GET_SIZE(args);
1782 if (l < min) {
1783 if (name != NULL)
1784 PyErr_Format(
1785 PyExc_TypeError,
1786 "%s expected %s%zd arguments, got %zd",
1787 name, (min == max ? "" : "at least "), min, l);
1788 else
1789 PyErr_Format(
1790 PyExc_TypeError,
1791 "unpacked tuple should have %s%zd elements,"
1792 " but has %zd",
1793 (min == max ? "" : "at least "), min, l);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001794 return 0;
1795 }
Raymond Hettinger94230232016-03-26 03:02:48 -07001796 if (l == 0)
1797 return 1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001798 if (l > max) {
1799 if (name != NULL)
1800 PyErr_Format(
1801 PyExc_TypeError,
1802 "%s expected %s%zd arguments, got %zd",
1803 name, (min == max ? "" : "at most "), max, l);
1804 else
1805 PyErr_Format(
1806 PyExc_TypeError,
1807 "unpacked tuple should have %s%zd elements,"
1808 " but has %zd",
1809 (min == max ? "" : "at most "), max, l);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001810 return 0;
1811 }
Raymond Hettinger94230232016-03-26 03:02:48 -07001812
1813#ifdef HAVE_STDARG_PROTOTYPES
1814 va_start(vargs, max);
1815#else
1816 va_start(vargs);
1817#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001818 for (i = 0; i < l; i++) {
1819 o = va_arg(vargs, PyObject **);
1820 *o = PyTuple_GET_ITEM(args, i);
1821 }
1822 va_end(vargs);
1823 return 1;
Fred Drakee4616e62001-10-23 21:09:29 +00001824}
Georg Brandl02c42872005-08-26 06:42:30 +00001825
1826
1827/* For type constructors that don't take keyword args
1828 *
Larry Hastingsb7ccb202014-01-18 23:50:21 -08001829 * Sets a TypeError and returns 0 if the args/kwargs is
Thomas Wouters89f507f2006-12-13 04:49:30 +00001830 * not empty, returns 1 otherwise
Georg Brandl02c42872005-08-26 06:42:30 +00001831 */
1832int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001833_PyArg_NoKeywords(const char *funcname, PyObject *kw)
Georg Brandl02c42872005-08-26 06:42:30 +00001834{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001835 if (kw == NULL)
1836 return 1;
1837 if (!PyDict_CheckExact(kw)) {
1838 PyErr_BadInternalCall();
1839 return 0;
1840 }
1841 if (PyDict_Size(kw) == 0)
1842 return 1;
Guido van Rossum98297ee2007-11-06 21:34:58 +00001843
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001844 PyErr_Format(PyExc_TypeError, "%s does not take keyword arguments",
1845 funcname);
1846 return 0;
Georg Brandl02c42872005-08-26 06:42:30 +00001847}
Larry Hastingsb7ccb202014-01-18 23:50:21 -08001848
1849
1850int
1851_PyArg_NoPositional(const char *funcname, PyObject *args)
1852{
1853 if (args == NULL)
1854 return 1;
1855 if (!PyTuple_CheckExact(args)) {
1856 PyErr_BadInternalCall();
1857 return 0;
1858 }
1859 if (PyTuple_GET_SIZE(args) == 0)
1860 return 1;
1861
1862 PyErr_Format(PyExc_TypeError, "%s does not take positional arguments",
1863 funcname);
1864 return 0;
1865}
1866
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001867#ifdef __cplusplus
1868};
1869#endif