blob: 7339191cf74cfeb4e3f0a891ba255d8e19df9496 [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
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +030021int _PyArg_ParseTupleAndKeywordsFast(PyObject *, PyObject *,
22 struct _PyArg_Parser *, ...);
23int _PyArg_VaParseTupleAndKeywordsFast(PyObject *, PyObject *,
24 struct _PyArg_Parser *, va_list);
25
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000026#ifdef HAVE_DECLSPEC_DLL
27/* Export functions */
Serhiy Storchakaef1585e2015-12-25 20:01:53 +020028PyAPI_FUNC(int) _PyArg_Parse_SizeT(PyObject *, const char *, ...);
Benjamin Peterson819a46f2016-09-09 20:45:06 -070029PyAPI_FUNC(int) _PyArg_ParseStack_SizeT(PyObject **args, Py_ssize_t nargs, PyObject *kwnames,
30 struct _PyArg_Parser *parser, ...);
Serhiy Storchakaef1585e2015-12-25 20:01:53 +020031PyAPI_FUNC(int) _PyArg_ParseTuple_SizeT(PyObject *, const char *, ...);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000032PyAPI_FUNC(int) _PyArg_ParseTupleAndKeywords_SizeT(PyObject *, PyObject *,
33 const char *, char **, ...);
34PyAPI_FUNC(PyObject *) _Py_BuildValue_SizeT(const char *, ...);
Serhiy Storchakaef1585e2015-12-25 20:01:53 +020035PyAPI_FUNC(int) _PyArg_VaParse_SizeT(PyObject *, const char *, va_list);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000036PyAPI_FUNC(int) _PyArg_VaParseTupleAndKeywords_SizeT(PyObject *, PyObject *,
37 const char *, char **, va_list);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +030038PyAPI_FUNC(int) _PyArg_ParseTupleAndKeywordsFast_SizeT(PyObject *, PyObject *,
39 struct _PyArg_Parser *, ...);
40PyAPI_FUNC(int) _PyArg_VaParseTupleAndKeywordsFast_SizeT(PyObject *, PyObject *,
41 struct _PyArg_Parser *, va_list);
Victor Stinnerc7454ff2016-09-09 20:56:52 -070042PyAPI_FUNC(int) _PyArg_ParseStack_SizeT(PyObject **args, Py_ssize_t nargs,
43 PyObject *kwnames, struct _PyArg_Parser *parser, ...);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000044#endif
45
Martin v. Löwis18e16552006-02-15 17:27:45 +000046#define FLAG_COMPAT 1
47#define FLAG_SIZE_T 2
48
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -040049typedef int (*destr_t)(PyObject *, void *);
50
51
52/* Keep track of "objects" that have been allocated or initialized and
53 which will need to be deallocated or cleaned up somehow if overall
54 parsing fails.
55*/
56typedef struct {
57 void *item;
58 destr_t destructor;
59} freelistentry_t;
60
61typedef struct {
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -040062 freelistentry_t *entries;
Antoine Pitrou7056cb22013-02-17 01:04:57 +010063 int first_available;
64 int entries_malloced;
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -040065} freelist_t;
66
Antoine Pitrou7056cb22013-02-17 01:04:57 +010067#define STATIC_FREELIST_ENTRIES 8
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000068
69/* Forward */
Jeremy Hyltonaf68c872005-12-10 18:50:16 +000070static int vgetargs1(PyObject *, const char *, va_list *, int);
Victor Stinner84bb1cf2013-05-17 00:12:04 +020071static void seterror(Py_ssize_t, const char *, int *, const char *, const char *);
Serhiy Storchakaef1585e2015-12-25 20:01:53 +020072static const char *convertitem(PyObject *, const char **, va_list *, int, int *,
73 char *, size_t, freelist_t *);
74static const char *converttuple(PyObject *, const char **, va_list *, int,
75 int *, char *, size_t, int, freelist_t *);
76static const char *convertsimple(PyObject *, const char **, va_list *, int,
77 char *, size_t, freelist_t *);
78static Py_ssize_t convertbuffer(PyObject *, void **p, const char **);
79static int getbuffer(PyObject *, Py_buffer *, const char**);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000080
Tim Petersdbd9ba62000-07-09 03:09:57 +000081static int vgetargskeywords(PyObject *, PyObject *,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000082 const char *, char **, va_list *, int);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +030083static int vgetargskeywordsfast(PyObject *, PyObject *,
84 struct _PyArg_Parser *, va_list *, int);
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -070085static int vgetargskeywordsfast_impl(PyObject **args, Py_ssize_t nargs,
86 PyObject *keywords, PyObject *kwnames,
87 struct _PyArg_Parser *parser,
88 va_list *p_va, int flags);
Serhiy Storchakaef1585e2015-12-25 20:01:53 +020089static const char *skipitem(const char **, va_list *, int);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000090
Fred Drake563dfc22001-10-23 14:41:08 +000091int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +000092PyArg_Parse(PyObject *args, const char *format, ...)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000093{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000094 int retval;
95 va_list va;
Guido van Rossum98297ee2007-11-06 21:34:58 +000096
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000097 va_start(va, format);
98 retval = vgetargs1(args, format, &va, FLAG_COMPAT);
99 va_end(va);
100 return retval;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000101}
102
103int
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200104_PyArg_Parse_SizeT(PyObject *args, const char *format, ...)
Martin v. Löwis18e16552006-02-15 17:27:45 +0000105{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000106 int retval;
107 va_list va;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000108
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000109 va_start(va, format);
110 retval = vgetargs1(args, format, &va, FLAG_COMPAT|FLAG_SIZE_T);
111 va_end(va);
112 return retval;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000113}
114
115
Fred Drake563dfc22001-10-23 14:41:08 +0000116int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000117PyArg_ParseTuple(PyObject *args, const char *format, ...)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000118{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000119 int retval;
120 va_list va;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000121
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000122 va_start(va, format);
123 retval = vgetargs1(args, format, &va, 0);
124 va_end(va);
125 return retval;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000126}
127
Martin v. Löwis18e16552006-02-15 17:27:45 +0000128int
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200129_PyArg_ParseTuple_SizeT(PyObject *args, const char *format, ...)
Martin v. Löwis18e16552006-02-15 17:27:45 +0000130{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000131 int retval;
132 va_list va;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000133
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000134 va_start(va, format);
135 retval = vgetargs1(args, format, &va, FLAG_SIZE_T);
136 va_end(va);
137 return retval;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000138}
139
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000140
141int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000142PyArg_VaParse(PyObject *args, const char *format, va_list va)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000143{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000144 va_list lva;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000145
Alexander Belopolskyf0f45142010-08-11 17:31:17 +0000146 Py_VA_COPY(lva, va);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000147
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000148 return vgetargs1(args, format, &lva, 0);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000149}
150
Martin v. Löwis18e16552006-02-15 17:27:45 +0000151int
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200152_PyArg_VaParse_SizeT(PyObject *args, const char *format, va_list va)
Martin v. Löwis18e16552006-02-15 17:27:45 +0000153{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000154 va_list lva;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000155
Alexander Belopolskyf0f45142010-08-11 17:31:17 +0000156 Py_VA_COPY(lva, va);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000157
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000158 return vgetargs1(args, format, &lva, FLAG_SIZE_T);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000159}
160
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000161
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000162/* Handle cleanup of allocated memory in case of exception */
163
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400164static int
165cleanup_ptr(PyObject *self, void *ptr)
Antoine Pitrouf71995782008-08-29 18:37:05 +0000166{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000167 if (ptr) {
168 PyMem_FREE(ptr);
169 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000170 return 0;
Martin v. Löwisc15bdef2009-05-29 14:47:46 +0000171}
172
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000173static int
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400174cleanup_buffer(PyObject *self, void *ptr)
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000175{
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400176 Py_buffer *buf = (Py_buffer *)ptr;
177 if (buf) {
178 PyBuffer_Release(buf);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000179 }
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400180 return 0;
181}
182
183static int
184addcleanup(void *ptr, freelist_t *freelist, destr_t destructor)
185{
186 int index;
187
188 index = freelist->first_available;
189 freelist->first_available += 1;
190
191 freelist->entries[index].item = ptr;
192 freelist->entries[index].destructor = destructor;
193
194 return 0;
195}
196
197static int
198cleanreturn(int retval, freelist_t *freelist)
199{
200 int index;
201
202 if (retval == 0) {
203 /* A failure occurred, therefore execute all of the cleanup
204 functions.
205 */
206 for (index = 0; index < freelist->first_available; ++index) {
207 freelist->entries[index].destructor(NULL,
208 freelist->entries[index].item);
209 }
210 }
Antoine Pitrou7056cb22013-02-17 01:04:57 +0100211 if (freelist->entries_malloced)
212 PyMem_FREE(freelist->entries);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000213 return retval;
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000214}
215
216
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000217static int
Martin v. Löwis18e16552006-02-15 17:27:45 +0000218vgetargs1(PyObject *args, const char *format, va_list *p_va, int flags)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000219{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000220 char msgbuf[256];
221 int levels[32];
222 const char *fname = NULL;
223 const char *message = NULL;
224 int min = -1;
225 int max = 0;
226 int level = 0;
227 int endfmt = 0;
228 const char *formatsave = format;
229 Py_ssize_t i, len;
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200230 const char *msg;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000231 int compat = flags & FLAG_COMPAT;
Benjamin Peterson40be9e52014-02-11 10:09:27 -0500232 freelistentry_t static_entries[STATIC_FREELIST_ENTRIES];
233 freelist_t freelist;
234
235 freelist.entries = static_entries;
236 freelist.first_available = 0;
237 freelist.entries_malloced = 0;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000238
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000239 assert(compat || (args != (PyObject*)NULL));
240 flags = flags & ~FLAG_COMPAT;
Tim Peters5c4d5bf2001-02-12 22:13:26 +0000241
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000242 while (endfmt == 0) {
243 int c = *format++;
244 switch (c) {
245 case '(':
246 if (level == 0)
247 max++;
248 level++;
249 if (level >= 30)
250 Py_FatalError("too many tuple nesting levels "
251 "in argument format string");
252 break;
253 case ')':
254 if (level == 0)
255 Py_FatalError("excess ')' in getargs format");
256 else
257 level--;
258 break;
259 case '\0':
260 endfmt = 1;
261 break;
262 case ':':
263 fname = format;
264 endfmt = 1;
265 break;
266 case ';':
267 message = format;
268 endfmt = 1;
269 break;
Antoine Pitrou7056cb22013-02-17 01:04:57 +0100270 case '|':
271 if (level == 0)
272 min = max;
273 break;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000274 default:
275 if (level == 0) {
Antoine Pitrou7056cb22013-02-17 01:04:57 +0100276 if (Py_ISALPHA(Py_CHARMASK(c)))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000277 if (c != 'e') /* skip encoded */
278 max++;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000279 }
280 break;
281 }
282 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000283
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000284 if (level != 0)
285 Py_FatalError(/* '(' */ "missing ')' in getargs format");
Guido van Rossum98297ee2007-11-06 21:34:58 +0000286
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000287 if (min < 0)
288 min = max;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000289
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000290 format = formatsave;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000291
Antoine Pitrou7056cb22013-02-17 01:04:57 +0100292 if (max > STATIC_FREELIST_ENTRIES) {
293 freelist.entries = PyMem_NEW(freelistentry_t, max);
294 if (freelist.entries == NULL) {
295 PyErr_NoMemory();
296 return 0;
297 }
298 freelist.entries_malloced = 1;
Benjamin Peterson7ed67272012-03-16 12:21:02 -0500299 }
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400300
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000301 if (compat) {
302 if (max == 0) {
303 if (args == NULL)
304 return 1;
Victor Stinner6ced7c42011-03-21 18:15:42 +0100305 PyErr_Format(PyExc_TypeError,
306 "%.200s%s takes no arguments",
307 fname==NULL ? "function" : fname,
308 fname==NULL ? "" : "()");
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400309 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000310 }
311 else if (min == 1 && max == 1) {
312 if (args == NULL) {
Victor Stinner6ced7c42011-03-21 18:15:42 +0100313 PyErr_Format(PyExc_TypeError,
314 "%.200s%s takes at least one argument",
315 fname==NULL ? "function" : fname,
316 fname==NULL ? "" : "()");
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400317 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000318 }
319 msg = convertitem(args, &format, p_va, flags, levels,
320 msgbuf, sizeof(msgbuf), &freelist);
321 if (msg == NULL)
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400322 return cleanreturn(1, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000323 seterror(levels[0], msg, levels+1, fname, message);
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400324 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000325 }
326 else {
327 PyErr_SetString(PyExc_SystemError,
328 "old style getargs format uses new features");
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400329 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000330 }
331 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000332
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000333 if (!PyTuple_Check(args)) {
334 PyErr_SetString(PyExc_SystemError,
335 "new style getargs format but argument is not a tuple");
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400336 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000337 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000338
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000339 len = PyTuple_GET_SIZE(args);
Guido van Rossum98297ee2007-11-06 21:34:58 +0000340
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000341 if (len < min || max < len) {
Victor Stinner6ced7c42011-03-21 18:15:42 +0100342 if (message == NULL)
343 PyErr_Format(PyExc_TypeError,
344 "%.150s%s takes %s %d argument%s (%ld given)",
345 fname==NULL ? "function" : fname,
346 fname==NULL ? "" : "()",
347 min==max ? "exactly"
348 : len < min ? "at least" : "at most",
349 len < min ? min : max,
350 (len < min ? min : max) == 1 ? "" : "s",
351 Py_SAFE_DOWNCAST(len, Py_ssize_t, long));
352 else
353 PyErr_SetString(PyExc_TypeError, message);
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400354 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000355 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000356
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000357 for (i = 0; i < len; i++) {
358 if (*format == '|')
359 format++;
360 msg = convertitem(PyTuple_GET_ITEM(args, i), &format, p_va,
361 flags, levels, msgbuf,
362 sizeof(msgbuf), &freelist);
363 if (msg) {
Serhiy Storchakac4b813d2016-02-08 01:06:11 +0200364 seterror(i+1, msg, levels, fname, message);
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400365 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000366 }
367 }
Guido van Rossum231a41e1997-12-09 20:36:39 +0000368
Antoine Pitrou4de74572013-02-09 23:11:27 +0100369 if (*format != '\0' && !Py_ISALPHA(Py_CHARMASK(*format)) &&
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000370 *format != '(' &&
371 *format != '|' && *format != ':' && *format != ';') {
372 PyErr_Format(PyExc_SystemError,
373 "bad format string: %.200s", formatsave);
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400374 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000375 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000376
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400377 return cleanreturn(1, &freelist);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000378}
379
380
381
382static void
Victor Stinner84bb1cf2013-05-17 00:12:04 +0200383seterror(Py_ssize_t iarg, const char *msg, int *levels, const char *fname,
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000384 const char *message)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000385{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000386 char buf[512];
387 int i;
388 char *p = buf;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000389
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000390 if (PyErr_Occurred())
391 return;
392 else if (message == NULL) {
393 if (fname != NULL) {
394 PyOS_snprintf(p, sizeof(buf), "%.200s() ", fname);
395 p += strlen(p);
396 }
397 if (iarg != 0) {
398 PyOS_snprintf(p, sizeof(buf) - (p - buf),
Richard Oudkerk25296ce2013-05-18 17:35:19 +0100399 "argument %" PY_FORMAT_SIZE_T "d", iarg);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000400 i = 0;
401 p += strlen(p);
Georg Brandl142ad662013-10-14 07:01:11 +0200402 while (i < 32 && levels[i] > 0 && (int)(p-buf) < 220) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000403 PyOS_snprintf(p, sizeof(buf) - (p - buf),
404 ", item %d", levels[i]-1);
405 p += strlen(p);
406 i++;
407 }
408 }
409 else {
410 PyOS_snprintf(p, sizeof(buf) - (p - buf), "argument");
411 p += strlen(p);
412 }
413 PyOS_snprintf(p, sizeof(buf) - (p - buf), " %.256s", msg);
414 message = buf;
415 }
Serhiy Storchaka4cd63ef2016-02-08 01:22:47 +0200416 if (msg[0] == '(') {
417 PyErr_SetString(PyExc_SystemError, message);
418 }
419 else {
420 PyErr_SetString(PyExc_TypeError, message);
421 }
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000422}
423
424
425/* Convert a tuple argument.
426 On entry, *p_format points to the character _after_ the opening '('.
427 On successful exit, *p_format points to the closing ')'.
428 If successful:
429 *p_format and *p_va are updated,
430 *levels and *msgbuf are untouched,
431 and NULL is returned.
432 If the argument is invalid:
433 *p_format is unchanged,
434 *p_va is undefined,
435 *levels is a 0-terminated list of item numbers,
436 *msgbuf contains an error message, whose format is:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000437 "must be <typename1>, not <typename2>", where:
438 <typename1> is the name of the expected type, and
439 <typename2> is the name of the actual type,
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000440 and msgbuf is returned.
441*/
442
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200443static const char *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000444converttuple(PyObject *arg, const char **p_format, va_list *p_va, int flags,
Guido van Rossum98297ee2007-11-06 21:34:58 +0000445 int *levels, char *msgbuf, size_t bufsize, int toplevel,
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400446 freelist_t *freelist)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000447{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000448 int level = 0;
449 int n = 0;
450 const char *format = *p_format;
451 int i;
Victor Stinner74387f52013-11-18 01:21:12 +0100452 Py_ssize_t len;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000453
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000454 for (;;) {
455 int c = *format++;
456 if (c == '(') {
457 if (level == 0)
458 n++;
459 level++;
460 }
461 else if (c == ')') {
462 if (level == 0)
463 break;
464 level--;
465 }
466 else if (c == ':' || c == ';' || c == '\0')
467 break;
Antoine Pitrou4de74572013-02-09 23:11:27 +0100468 else if (level == 0 && Py_ISALPHA(Py_CHARMASK(c)))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000469 n++;
470 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000471
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000472 if (!PySequence_Check(arg) || PyBytes_Check(arg)) {
473 levels[0] = 0;
474 PyOS_snprintf(msgbuf, bufsize,
475 toplevel ? "expected %d arguments, not %.50s" :
476 "must be %d-item sequence, not %.50s",
477 n,
478 arg == Py_None ? "None" : arg->ob_type->tp_name);
479 return msgbuf;
480 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000481
Victor Stinner74387f52013-11-18 01:21:12 +0100482 len = PySequence_Size(arg);
483 if (len != n) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000484 levels[0] = 0;
Victor Stinner74387f52013-11-18 01:21:12 +0100485 if (toplevel) {
486 PyOS_snprintf(msgbuf, bufsize,
487 "expected %d arguments, not %" PY_FORMAT_SIZE_T "d",
488 n, len);
489 }
490 else {
491 PyOS_snprintf(msgbuf, bufsize,
492 "must be sequence of length %d, "
493 "not %" PY_FORMAT_SIZE_T "d",
494 n, len);
495 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000496 return msgbuf;
497 }
Ka-Ping Yee20579702001-01-15 22:14:16 +0000498
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000499 format = *p_format;
500 for (i = 0; i < n; i++) {
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200501 const char *msg;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000502 PyObject *item;
503 item = PySequence_GetItem(arg, i);
504 if (item == NULL) {
505 PyErr_Clear();
506 levels[0] = i+1;
507 levels[1] = 0;
508 strncpy(msgbuf, "is not retrievable", bufsize);
509 return msgbuf;
510 }
511 msg = convertitem(item, &format, p_va, flags, levels+1,
512 msgbuf, bufsize, freelist);
513 /* PySequence_GetItem calls tp->sq_item, which INCREFs */
514 Py_XDECREF(item);
515 if (msg != NULL) {
516 levels[0] = i+1;
517 return msg;
518 }
519 }
Ka-Ping Yee20579702001-01-15 22:14:16 +0000520
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000521 *p_format = format;
522 return NULL;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000523}
524
525
526/* Convert a single item. */
527
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200528static const char *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000529convertitem(PyObject *arg, const char **p_format, va_list *p_va, int flags,
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400530 int *levels, char *msgbuf, size_t bufsize, freelist_t *freelist)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000531{
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200532 const char *msg;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000533 const char *format = *p_format;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000534
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000535 if (*format == '(' /* ')' */) {
536 format++;
537 msg = converttuple(arg, &format, p_va, flags, levels, msgbuf,
538 bufsize, 0, freelist);
539 if (msg == NULL)
540 format++;
541 }
542 else {
543 msg = convertsimple(arg, &format, p_va, flags,
544 msgbuf, bufsize, freelist);
545 if (msg != NULL)
546 levels[0] = 0;
547 }
548 if (msg == NULL)
549 *p_format = format;
550 return msg;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000551}
552
553
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000554
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000555/* Format an error message generated by convertsimple(). */
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000556
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200557static const char *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000558converterr(const char *expected, PyObject *arg, char *msgbuf, size_t bufsize)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000559{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000560 assert(expected != NULL);
561 assert(arg != NULL);
Serhiy Storchakac4b813d2016-02-08 01:06:11 +0200562 if (expected[0] == '(') {
563 PyOS_snprintf(msgbuf, bufsize,
564 "%.100s", expected);
565 }
566 else {
567 PyOS_snprintf(msgbuf, bufsize,
568 "must be %.50s, not %.50s", expected,
569 arg == Py_None ? "None" : arg->ob_type->tp_name);
570 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000571 return msgbuf;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000572}
573
574#define CONV_UNICODE "(unicode conversion error)"
575
Guido van Rossum45aecf42006-03-15 04:58:47 +0000576/* Explicitly check for float arguments when integers are expected.
577 Return 1 for error, 0 if ok. */
Neil Schemenauer5042da62003-02-04 20:59:40 +0000578static int
579float_argument_error(PyObject *arg)
580{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000581 if (PyFloat_Check(arg)) {
582 PyErr_SetString(PyExc_TypeError,
583 "integer argument expected, got float" );
584 return 1;
585 }
586 else
587 return 0;
Neil Schemenauer5042da62003-02-04 20:59:40 +0000588}
589
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000590/* Convert a non-tuple argument. Return NULL if conversion went OK,
591 or a string with a message describing the failure. The message is
592 formatted as "must be <desired type>, not <actual type>".
593 When failing, an exception may or may not have been raised.
Georg Brandl6dd14612005-09-14 19:29:53 +0000594 Don't call if a tuple is expected.
595
596 When you add new format codes, please don't forget poor skipitem() below.
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000597*/
598
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200599static const char *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000600convertsimple(PyObject *arg, const char **p_format, va_list *p_va, int flags,
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400601 char *msgbuf, size_t bufsize, freelist_t *freelist)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000602{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000603 /* For # codes */
604#define FETCH_SIZE int *q=NULL;Py_ssize_t *q2=NULL;\
605 if (flags & FLAG_SIZE_T) q2=va_arg(*p_va, Py_ssize_t*); \
606 else q=va_arg(*p_va, int*);
Victor Stinnerb3c9e072011-01-04 02:07:34 +0000607#define STORE_SIZE(s) \
608 if (flags & FLAG_SIZE_T) \
609 *q2=s; \
610 else { \
611 if (INT_MAX < s) { \
612 PyErr_SetString(PyExc_OverflowError, \
613 "size does not fit in an int"); \
614 return converterr("", arg, msgbuf, bufsize); \
615 } \
Victor Stinner9550ef32013-06-05 01:18:13 +0200616 *q = (int)s; \
Victor Stinnerb3c9e072011-01-04 02:07:34 +0000617 }
Martin v. Löwis18e16552006-02-15 17:27:45 +0000618#define BUFFER_LEN ((flags & FLAG_SIZE_T) ? *q2:*q)
Victor Stinner6ab8e822011-01-04 11:16:49 +0000619#define RETURN_ERR_OCCURRED return msgbuf
Martin v. Löwis18e16552006-02-15 17:27:45 +0000620
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000621 const char *format = *p_format;
622 char c = *format++;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200623 char *sarg;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000624
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000625 switch (c) {
Guido van Rossum98297ee2007-11-06 21:34:58 +0000626
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000627 case 'b': { /* unsigned byte -- very short int */
628 char *p = va_arg(*p_va, char *);
629 long ival;
630 if (float_argument_error(arg))
Victor Stinner6ab8e822011-01-04 11:16:49 +0000631 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000632 ival = PyLong_AsLong(arg);
633 if (ival == -1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000634 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000635 else if (ival < 0) {
636 PyErr_SetString(PyExc_OverflowError,
Victor Stinner6ab8e822011-01-04 11:16:49 +0000637 "unsigned byte integer is less than minimum");
638 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000639 }
640 else if (ival > UCHAR_MAX) {
641 PyErr_SetString(PyExc_OverflowError,
Victor Stinner6ab8e822011-01-04 11:16:49 +0000642 "unsigned byte integer is greater than maximum");
643 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000644 }
645 else
646 *p = (unsigned char) ival;
647 break;
648 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000649
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000650 case 'B': {/* byte sized bitfield - both signed and unsigned
651 values allowed */
652 char *p = va_arg(*p_va, char *);
653 long ival;
654 if (float_argument_error(arg))
Victor Stinner6ab8e822011-01-04 11:16:49 +0000655 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000656 ival = PyLong_AsUnsignedLongMask(arg);
657 if (ival == -1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000658 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000659 else
660 *p = (unsigned char) ival;
661 break;
662 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000663
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000664 case 'h': {/* signed short int */
665 short *p = va_arg(*p_va, short *);
666 long ival;
667 if (float_argument_error(arg))
Victor Stinner6ab8e822011-01-04 11:16:49 +0000668 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000669 ival = PyLong_AsLong(arg);
670 if (ival == -1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000671 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000672 else if (ival < SHRT_MIN) {
673 PyErr_SetString(PyExc_OverflowError,
Victor Stinner6ab8e822011-01-04 11:16:49 +0000674 "signed short integer is less than minimum");
675 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000676 }
677 else if (ival > SHRT_MAX) {
678 PyErr_SetString(PyExc_OverflowError,
Victor Stinner6ab8e822011-01-04 11:16:49 +0000679 "signed short integer is greater than maximum");
680 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000681 }
682 else
683 *p = (short) ival;
684 break;
685 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000686
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000687 case 'H': { /* short int sized bitfield, both signed and
688 unsigned allowed */
689 unsigned short *p = va_arg(*p_va, unsigned short *);
690 long ival;
691 if (float_argument_error(arg))
Victor Stinner6ab8e822011-01-04 11:16:49 +0000692 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000693 ival = PyLong_AsUnsignedLongMask(arg);
694 if (ival == -1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000695 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000696 else
697 *p = (unsigned short) ival;
698 break;
699 }
Martin v. Löwis18e16552006-02-15 17:27:45 +0000700
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000701 case 'i': {/* signed int */
702 int *p = va_arg(*p_va, int *);
703 long ival;
704 if (float_argument_error(arg))
Victor Stinner6ab8e822011-01-04 11:16:49 +0000705 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000706 ival = PyLong_AsLong(arg);
707 if (ival == -1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000708 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000709 else if (ival > INT_MAX) {
710 PyErr_SetString(PyExc_OverflowError,
Victor Stinner6ab8e822011-01-04 11:16:49 +0000711 "signed integer is greater than maximum");
712 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000713 }
714 else if (ival < INT_MIN) {
715 PyErr_SetString(PyExc_OverflowError,
Victor Stinner6ab8e822011-01-04 11:16:49 +0000716 "signed integer is less than minimum");
717 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000718 }
719 else
720 *p = ival;
721 break;
722 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000723
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000724 case 'I': { /* int sized bitfield, both signed and
725 unsigned allowed */
726 unsigned int *p = va_arg(*p_va, unsigned int *);
727 unsigned int ival;
728 if (float_argument_error(arg))
Victor Stinner6ab8e822011-01-04 11:16:49 +0000729 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000730 ival = (unsigned int)PyLong_AsUnsignedLongMask(arg);
731 if (ival == (unsigned int)-1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000732 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000733 else
734 *p = ival;
735 break;
736 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000737
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000738 case 'n': /* Py_ssize_t */
739 {
740 PyObject *iobj;
741 Py_ssize_t *p = va_arg(*p_va, Py_ssize_t *);
742 Py_ssize_t ival = -1;
743 if (float_argument_error(arg))
Victor Stinner6ab8e822011-01-04 11:16:49 +0000744 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000745 iobj = PyNumber_Index(arg);
746 if (iobj != NULL) {
747 ival = PyLong_AsSsize_t(iobj);
748 Py_DECREF(iobj);
749 }
750 if (ival == -1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000751 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000752 *p = ival;
753 break;
754 }
755 case 'l': {/* long int */
756 long *p = va_arg(*p_va, long *);
757 long ival;
758 if (float_argument_error(arg))
Victor Stinner6ab8e822011-01-04 11:16:49 +0000759 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000760 ival = PyLong_AsLong(arg);
761 if (ival == -1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000762 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000763 else
764 *p = ival;
765 break;
766 }
Thomas Hellera4ea6032003-04-17 18:55:45 +0000767
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000768 case 'k': { /* long sized bitfield */
769 unsigned long *p = va_arg(*p_va, unsigned long *);
770 unsigned long ival;
771 if (PyLong_Check(arg))
772 ival = PyLong_AsUnsignedLongMask(arg);
773 else
Serhiy Storchakac4b813d2016-02-08 01:06:11 +0200774 return converterr("int", arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000775 *p = ival;
776 break;
777 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000778
Benjamin Petersonaf580df2016-09-06 10:46:49 -0700779 case 'L': {/* long long */
780 long long *p = va_arg( *p_va, long long * );
781 long long ival;
Mark Dickinsonc7301312010-06-10 16:05:10 +0000782 if (float_argument_error(arg))
Victor Stinner6ab8e822011-01-04 11:16:49 +0000783 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000784 ival = PyLong_AsLongLong(arg);
Benjamin Petersonaf580df2016-09-06 10:46:49 -0700785 if (ival == (long long)-1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000786 RETURN_ERR_OCCURRED;
Mark Dickinsonc7301312010-06-10 16:05:10 +0000787 else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000788 *p = ival;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000789 break;
790 }
Thomas Hellera4ea6032003-04-17 18:55:45 +0000791
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000792 case 'K': { /* long long sized bitfield */
Benjamin Petersonaf580df2016-09-06 10:46:49 -0700793 unsigned long long *p = va_arg(*p_va, unsigned long long *);
794 unsigned long long ival;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000795 if (PyLong_Check(arg))
796 ival = PyLong_AsUnsignedLongLongMask(arg);
797 else
Serhiy Storchakac4b813d2016-02-08 01:06:11 +0200798 return converterr("int", arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000799 *p = ival;
800 break;
801 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000802
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000803 case 'f': {/* float */
804 float *p = va_arg(*p_va, float *);
805 double dval = PyFloat_AsDouble(arg);
806 if (PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000807 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000808 else
809 *p = (float) dval;
810 break;
811 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000812
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000813 case 'd': {/* double */
814 double *p = va_arg(*p_va, double *);
815 double dval = PyFloat_AsDouble(arg);
816 if (PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000817 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000818 else
819 *p = dval;
820 break;
821 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000822
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000823 case 'D': {/* complex double */
824 Py_complex *p = va_arg(*p_va, Py_complex *);
825 Py_complex cval;
826 cval = PyComplex_AsCComplex(arg);
827 if (PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000828 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000829 else
830 *p = cval;
831 break;
832 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000833
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000834 case 'c': {/* char */
835 char *p = va_arg(*p_va, char *);
836 if (PyBytes_Check(arg) && PyBytes_Size(arg) == 1)
837 *p = PyBytes_AS_STRING(arg)[0];
Eli Bendersky906b88f2011-07-29 07:05:08 +0300838 else if (PyByteArray_Check(arg) && PyByteArray_Size(arg) == 1)
839 *p = PyByteArray_AS_STRING(arg)[0];
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000840 else
841 return converterr("a byte string of length 1", arg, msgbuf, bufsize);
842 break;
843 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000844
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000845 case 'C': {/* unicode char */
846 int *p = va_arg(*p_va, int *);
Victor Stinnere1335c72011-10-04 20:53:03 +0200847 int kind;
848 void *data;
849
850 if (!PyUnicode_Check(arg))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000851 return converterr("a unicode character", arg, msgbuf, bufsize);
Victor Stinnere1335c72011-10-04 20:53:03 +0200852
853 if (PyUnicode_READY(arg))
854 RETURN_ERR_OCCURRED;
855
856 if (PyUnicode_GET_LENGTH(arg) != 1)
857 return converterr("a unicode character", arg, msgbuf, bufsize);
858
859 kind = PyUnicode_KIND(arg);
860 data = PyUnicode_DATA(arg);
861 *p = PyUnicode_READ(kind, data, 0);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000862 break;
863 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000864
Larry Hastingsfaf91e72012-05-05 16:54:29 -0700865 case 'p': {/* boolean *p*redicate */
866 int *p = va_arg(*p_va, int *);
867 int val = PyObject_IsTrue(arg);
868 if (val > 0)
869 *p = 1;
870 else if (val == 0)
871 *p = 0;
872 else
873 RETURN_ERR_OCCURRED;
874 break;
875 }
876
Victor Stinner3dcb5ac2010-06-08 22:54:19 +0000877 /* XXX WAAAAH! 's', 'y', 'z', 'u', 'Z', 'e', 'w' codes all
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000878 need to be cleaned up! */
Guido van Rossum98297ee2007-11-06 21:34:58 +0000879
Serhiy Storchakab757c832014-12-05 22:25:22 +0200880 case 'y': {/* any bytes-like object */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000881 void **p = (void **)va_arg(*p_va, char **);
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200882 const char *buf;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000883 Py_ssize_t count;
884 if (*format == '*') {
885 if (getbuffer(arg, (Py_buffer*)p, &buf) < 0)
886 return converterr(buf, arg, msgbuf, bufsize);
887 format++;
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400888 if (addcleanup(p, freelist, cleanup_buffer)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000889 return converterr(
890 "(cleanup problem)",
891 arg, msgbuf, bufsize);
892 }
893 break;
894 }
895 count = convertbuffer(arg, p, &buf);
896 if (count < 0)
897 return converterr(buf, arg, msgbuf, bufsize);
Victor Stinner06e49dd2010-06-13 18:21:50 +0000898 if (*format == '#') {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000899 FETCH_SIZE;
900 STORE_SIZE(count);
901 format++;
Victor Stinner06e49dd2010-06-13 18:21:50 +0000902 } else {
Serhiy Storchakad8a14472014-09-06 20:07:17 +0300903 if (strlen(*p) != (size_t)count) {
904 PyErr_SetString(PyExc_ValueError, "embedded null byte");
905 RETURN_ERR_OCCURRED;
906 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000907 }
908 break;
909 }
Walter Dörwald612344f2007-05-04 19:28:21 +0000910
Serhiy Storchakab757c832014-12-05 22:25:22 +0200911 case 's': /* text string or bytes-like object */
912 case 'z': /* text string, bytes-like object or None */
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000913 {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000914 if (*format == '*') {
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000915 /* "s*" or "z*" */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000916 Py_buffer *p = (Py_buffer *)va_arg(*p_va, Py_buffer *);
Martin v. Löwis423be952008-08-13 15:53:07 +0000917
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000918 if (c == 'z' && arg == Py_None)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000919 PyBuffer_FillInfo(p, NULL, NULL, 0, 1, 0);
920 else if (PyUnicode_Check(arg)) {
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200921 Py_ssize_t len;
922 sarg = PyUnicode_AsUTF8AndSize(arg, &len);
923 if (sarg == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000924 return converterr(CONV_UNICODE,
925 arg, msgbuf, bufsize);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200926 PyBuffer_FillInfo(p, arg, sarg, len, 1, 0);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000927 }
Serhiy Storchakab757c832014-12-05 22:25:22 +0200928 else { /* any bytes-like object */
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200929 const char *buf;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000930 if (getbuffer(arg, p, &buf) < 0)
931 return converterr(buf, arg, msgbuf, bufsize);
932 }
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400933 if (addcleanup(p, freelist, cleanup_buffer)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000934 return converterr(
935 "(cleanup problem)",
936 arg, msgbuf, bufsize);
937 }
938 format++;
Serhiy Storchakab757c832014-12-05 22:25:22 +0200939 } else if (*format == '#') { /* a string or read-only bytes-like object */
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000940 /* "s#" or "z#" */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000941 void **p = (void **)va_arg(*p_va, char **);
942 FETCH_SIZE;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000943
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000944 if (c == 'z' && arg == Py_None) {
945 *p = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000946 STORE_SIZE(0);
947 }
948 else if (PyUnicode_Check(arg)) {
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200949 Py_ssize_t len;
950 sarg = PyUnicode_AsUTF8AndSize(arg, &len);
951 if (sarg == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000952 return converterr(CONV_UNICODE,
953 arg, msgbuf, bufsize);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200954 *p = sarg;
955 STORE_SIZE(len);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000956 }
Serhiy Storchakab757c832014-12-05 22:25:22 +0200957 else { /* read-only bytes-like object */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000958 /* XXX Really? */
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200959 const char *buf;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000960 Py_ssize_t count = convertbuffer(arg, p, &buf);
961 if (count < 0)
962 return converterr(buf, arg, msgbuf, bufsize);
963 STORE_SIZE(count);
964 }
965 format++;
966 } else {
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000967 /* "s" or "z" */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000968 char **p = va_arg(*p_va, char **);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200969 Py_ssize_t len;
970 sarg = NULL;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000971
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000972 if (c == 'z' && arg == Py_None)
973 *p = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000974 else if (PyUnicode_Check(arg)) {
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200975 sarg = PyUnicode_AsUTF8AndSize(arg, &len);
976 if (sarg == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000977 return converterr(CONV_UNICODE,
978 arg, msgbuf, bufsize);
Serhiy Storchakad8a14472014-09-06 20:07:17 +0300979 if (strlen(sarg) != (size_t)len) {
980 PyErr_SetString(PyExc_ValueError, "embedded null character");
981 RETURN_ERR_OCCURRED;
982 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200983 *p = sarg;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000984 }
985 else
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000986 return converterr(c == 'z' ? "str or None" : "str",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000987 arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000988 }
989 break;
990 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000991
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000992 case 'u': /* raw unicode buffer (Py_UNICODE *) */
993 case 'Z': /* raw unicode buffer or None */
994 {
Brett Cannonb94767f2011-02-22 20:15:44 +0000995 Py_UNICODE **p = va_arg(*p_va, Py_UNICODE **);
996
Serhiy Storchakab757c832014-12-05 22:25:22 +0200997 if (*format == '#') {
Serhiy Storchakad6e53da2015-04-19 21:11:30 +0300998 /* "u#" or "Z#" */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000999 FETCH_SIZE;
Travis E. Oliphantddacf962007-10-13 21:03:27 +00001000
Victor Stinner3c9e6e92010-06-24 22:31:12 +00001001 if (c == 'Z' && arg == Py_None) {
1002 *p = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001003 STORE_SIZE(0);
1004 }
1005 else if (PyUnicode_Check(arg)) {
Victor Stinnerbeac78b2011-10-11 21:55:01 +02001006 Py_ssize_t len;
1007 *p = PyUnicode_AsUnicodeAndSize(arg, &len);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001008 if (*p == NULL)
1009 RETURN_ERR_OCCURRED;
Victor Stinnerbeac78b2011-10-11 21:55:01 +02001010 STORE_SIZE(len);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001011 }
Victor Stinner5216e6d2010-06-08 21:45:51 +00001012 else
Serhiy Storchakad6e53da2015-04-19 21:11:30 +03001013 return converterr(c == 'Z' ? "str or None" : "str",
1014 arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001015 format++;
1016 } else {
Serhiy Storchakad6e53da2015-04-19 21:11:30 +03001017 /* "u" or "Z" */
Victor Stinner3c9e6e92010-06-24 22:31:12 +00001018 if (c == 'Z' && arg == Py_None)
1019 *p = NULL;
Victor Stinner06e49dd2010-06-13 18:21:50 +00001020 else if (PyUnicode_Check(arg)) {
Victor Stinnerbeac78b2011-10-11 21:55:01 +02001021 Py_ssize_t len;
1022 *p = PyUnicode_AsUnicodeAndSize(arg, &len);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001023 if (*p == NULL)
1024 RETURN_ERR_OCCURRED;
Serhiy Storchakad8a14472014-09-06 20:07:17 +03001025 if (Py_UNICODE_strlen(*p) != (size_t)len) {
1026 PyErr_SetString(PyExc_ValueError, "embedded null character");
1027 RETURN_ERR_OCCURRED;
1028 }
Victor Stinner06e49dd2010-06-13 18:21:50 +00001029 } else
Victor Stinner3c9e6e92010-06-24 22:31:12 +00001030 return converterr(c == 'Z' ? "str or None" : "str",
1031 arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001032 }
1033 break;
1034 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001035
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001036 case 'e': {/* encoded string */
1037 char **buffer;
1038 const char *encoding;
1039 PyObject *s;
1040 int recode_strings;
1041 Py_ssize_t size;
1042 const char *ptr;
Jeremy Hylton4819e972001-10-11 14:40:37 +00001043
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001044 /* Get 'e' parameter: the encoding name */
1045 encoding = (const char *)va_arg(*p_va, const char *);
1046 if (encoding == NULL)
1047 encoding = PyUnicode_GetDefaultEncoding();
Martin v. Löwis423be952008-08-13 15:53:07 +00001048
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001049 /* Get output buffer parameter:
1050 's' (recode all objects via Unicode) or
1051 't' (only recode non-string objects)
1052 */
1053 if (*format == 's')
1054 recode_strings = 1;
1055 else if (*format == 't')
1056 recode_strings = 0;
1057 else
1058 return converterr(
1059 "(unknown parser marker combination)",
1060 arg, msgbuf, bufsize);
1061 buffer = (char **)va_arg(*p_va, char **);
1062 format++;
1063 if (buffer == NULL)
1064 return converterr("(buffer is NULL)",
1065 arg, msgbuf, bufsize);
Benjamin Peterson9edd2bd2008-08-27 00:31:37 +00001066
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001067 /* Encode object */
1068 if (!recode_strings &&
1069 (PyBytes_Check(arg) || PyByteArray_Check(arg))) {
1070 s = arg;
1071 Py_INCREF(s);
1072 if (PyObject_AsCharBuffer(s, &ptr, &size) < 0)
1073 return converterr("(AsCharBuffer failed)",
1074 arg, msgbuf, bufsize);
1075 }
Serhiy Storchaka21a663e2016-04-13 15:37:23 +03001076 else if (PyUnicode_Check(arg)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001077 /* Encode object; use default error handling */
Serhiy Storchaka21a663e2016-04-13 15:37:23 +03001078 s = PyUnicode_AsEncodedString(arg,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001079 encoding,
1080 NULL);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001081 if (s == NULL)
1082 return converterr("(encoding failed)",
1083 arg, msgbuf, bufsize);
Serhiy Storchaka21a663e2016-04-13 15:37:23 +03001084 assert(PyBytes_Check(s));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001085 size = PyBytes_GET_SIZE(s);
1086 ptr = PyBytes_AS_STRING(s);
1087 if (ptr == NULL)
1088 ptr = "";
1089 }
Serhiy Storchaka21a663e2016-04-13 15:37:23 +03001090 else {
1091 return converterr(
1092 recode_strings ? "str" : "str, bytes or bytearray",
1093 arg, msgbuf, bufsize);
1094 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001095
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001096 /* Write output; output is guaranteed to be 0-terminated */
1097 if (*format == '#') {
1098 /* Using buffer length parameter '#':
1099
1100 - if *buffer is NULL, a new buffer of the
1101 needed size is allocated and the data
1102 copied into it; *buffer is updated to point
1103 to the new buffer; the caller is
1104 responsible for PyMem_Free()ing it after
1105 usage
1106
1107 - if *buffer is not NULL, the data is
1108 copied to *buffer; *buffer_len has to be
1109 set to the size of the buffer on input;
1110 buffer overflow is signalled with an error;
1111 buffer has to provide enough room for the
1112 encoded string plus the trailing 0-byte
1113
1114 - in both cases, *buffer_len is updated to
1115 the size of the buffer /excluding/ the
1116 trailing 0-byte
1117
1118 */
1119 FETCH_SIZE;
1120
1121 format++;
1122 if (q == NULL && q2 == NULL) {
1123 Py_DECREF(s);
1124 return converterr(
1125 "(buffer_len is NULL)",
1126 arg, msgbuf, bufsize);
1127 }
1128 if (*buffer == NULL) {
1129 *buffer = PyMem_NEW(char, size + 1);
1130 if (*buffer == NULL) {
1131 Py_DECREF(s);
Victor Stinner2872e5b2010-06-06 20:38:02 +00001132 PyErr_NoMemory();
Victor Stinner6ab8e822011-01-04 11:16:49 +00001133 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001134 }
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001135 if (addcleanup(*buffer, freelist, cleanup_ptr)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001136 Py_DECREF(s);
1137 return converterr(
1138 "(cleanup problem)",
1139 arg, msgbuf, bufsize);
1140 }
1141 } else {
1142 if (size + 1 > BUFFER_LEN) {
1143 Py_DECREF(s);
Serhiy Storchaka4cd63ef2016-02-08 01:22:47 +02001144 PyErr_Format(PyExc_ValueError,
Serhiy Storchakac4b813d2016-02-08 01:06:11 +02001145 "encoded string too long "
1146 "(%zd, maximum length %zd)",
1147 (Py_ssize_t)size, (Py_ssize_t)(BUFFER_LEN-1));
1148 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001149 }
1150 }
1151 memcpy(*buffer, ptr, size+1);
1152 STORE_SIZE(size);
1153 } else {
1154 /* Using a 0-terminated buffer:
1155
1156 - the encoded string has to be 0-terminated
1157 for this variant to work; if it is not, an
1158 error raised
1159
1160 - a new buffer of the needed size is
1161 allocated and the data copied into it;
1162 *buffer is updated to point to the new
1163 buffer; the caller is responsible for
1164 PyMem_Free()ing it after usage
1165
1166 */
1167 if ((Py_ssize_t)strlen(ptr) != size) {
1168 Py_DECREF(s);
1169 return converterr(
Serhiy Storchakac4b813d2016-02-08 01:06:11 +02001170 "encoded string without null bytes",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001171 arg, msgbuf, bufsize);
1172 }
1173 *buffer = PyMem_NEW(char, size + 1);
1174 if (*buffer == NULL) {
1175 Py_DECREF(s);
Victor Stinner2872e5b2010-06-06 20:38:02 +00001176 PyErr_NoMemory();
Victor Stinner6ab8e822011-01-04 11:16:49 +00001177 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001178 }
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001179 if (addcleanup(*buffer, freelist, cleanup_ptr)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001180 Py_DECREF(s);
1181 return converterr("(cleanup problem)",
1182 arg, msgbuf, bufsize);
1183 }
1184 memcpy(*buffer, ptr, size+1);
1185 }
1186 Py_DECREF(s);
1187 break;
1188 }
1189
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001190 case 'S': { /* PyBytes object */
1191 PyObject **p = va_arg(*p_va, PyObject **);
1192 if (PyBytes_Check(arg))
1193 *p = arg;
1194 else
1195 return converterr("bytes", arg, msgbuf, bufsize);
1196 break;
1197 }
1198
1199 case 'Y': { /* PyByteArray object */
1200 PyObject **p = va_arg(*p_va, PyObject **);
1201 if (PyByteArray_Check(arg))
1202 *p = arg;
1203 else
Victor Stinner5216e6d2010-06-08 21:45:51 +00001204 return converterr("bytearray", arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001205 break;
1206 }
1207
1208 case 'U': { /* PyUnicode object */
1209 PyObject **p = va_arg(*p_va, PyObject **);
Victor Stinnera1b0c9f2012-05-29 12:30:29 +02001210 if (PyUnicode_Check(arg)) {
1211 if (PyUnicode_READY(arg) == -1)
1212 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001213 *p = arg;
Victor Stinnera1b0c9f2012-05-29 12:30:29 +02001214 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001215 else
1216 return converterr("str", arg, msgbuf, bufsize);
1217 break;
1218 }
1219
1220 case 'O': { /* object */
1221 PyTypeObject *type;
1222 PyObject **p;
1223 if (*format == '!') {
1224 type = va_arg(*p_va, PyTypeObject*);
1225 p = va_arg(*p_va, PyObject **);
1226 format++;
1227 if (PyType_IsSubtype(arg->ob_type, type))
1228 *p = arg;
1229 else
1230 return converterr(type->tp_name, arg, msgbuf, bufsize);
1231
1232 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001233 else if (*format == '&') {
1234 typedef int (*converter)(PyObject *, void *);
1235 converter convert = va_arg(*p_va, converter);
1236 void *addr = va_arg(*p_va, void *);
1237 int res;
1238 format++;
1239 if (! (res = (*convert)(arg, addr)))
1240 return converterr("(unspecified)",
1241 arg, msgbuf, bufsize);
1242 if (res == Py_CLEANUP_SUPPORTED &&
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001243 addcleanup(addr, freelist, convert) == -1)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001244 return converterr("(cleanup problem)",
1245 arg, msgbuf, bufsize);
1246 }
1247 else {
1248 p = va_arg(*p_va, PyObject **);
1249 *p = arg;
1250 }
1251 break;
1252 }
1253
1254
Victor Stinner25e8ec42010-06-25 00:02:38 +00001255 case 'w': { /* "w*": memory buffer, read-write access */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001256 void **p = va_arg(*p_va, void **);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001257
Victor Stinner25e8ec42010-06-25 00:02:38 +00001258 if (*format != '*')
1259 return converterr(
Serhiy Storchakac4b813d2016-02-08 01:06:11 +02001260 "(invalid use of 'w' format character)",
Victor Stinner25e8ec42010-06-25 00:02:38 +00001261 arg, msgbuf, bufsize);
1262 format++;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001263
Victor Stinner25e8ec42010-06-25 00:02:38 +00001264 /* Caller is interested in Py_buffer, and the object
1265 supports it directly. */
1266 if (PyObject_GetBuffer(arg, (Py_buffer*)p, PyBUF_WRITABLE) < 0) {
1267 PyErr_Clear();
R David Murray861470c2014-10-05 11:47:01 -04001268 return converterr("read-write bytes-like object",
1269 arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001270 }
Victor Stinner8182b712010-07-28 00:40:58 +00001271 if (!PyBuffer_IsContiguous((Py_buffer*)p, 'C')) {
1272 PyBuffer_Release((Py_buffer*)p);
1273 return converterr("contiguous buffer", arg, msgbuf, bufsize);
1274 }
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001275 if (addcleanup(p, freelist, cleanup_buffer)) {
Victor Stinner25e8ec42010-06-25 00:02:38 +00001276 return converterr(
1277 "(cleanup problem)",
1278 arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001279 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001280 break;
1281 }
1282
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001283 default:
Serhiy Storchakac4b813d2016-02-08 01:06:11 +02001284 return converterr("(impossible<bad format char>)", arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001285
1286 }
1287
1288 *p_format = format;
1289 return NULL;
Victor Stinner6ab8e822011-01-04 11:16:49 +00001290
1291#undef FETCH_SIZE
1292#undef STORE_SIZE
1293#undef BUFFER_LEN
1294#undef RETURN_ERR_OCCURRED
Guido van Rossumfe3f1a21994-09-29 09:42:55 +00001295}
Guido van Rossumaa354651996-08-19 19:32:04 +00001296
Martin v. Löwis18e16552006-02-15 17:27:45 +00001297static Py_ssize_t
Serhiy Storchakaef1585e2015-12-25 20:01:53 +02001298convertbuffer(PyObject *arg, void **p, const char **errmsg)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001299{
Victor Stinner5cb62392010-06-06 20:27:51 +00001300 PyBufferProcs *pb = Py_TYPE(arg)->tp_as_buffer;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001301 Py_ssize_t count;
1302 Py_buffer view;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001303
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001304 *errmsg = NULL;
1305 *p = NULL;
Victor Stinner8182b712010-07-28 00:40:58 +00001306 if (pb != NULL && pb->bf_releasebuffer != NULL) {
R David Murray861470c2014-10-05 11:47:01 -04001307 *errmsg = "read-only bytes-like object";
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001308 return -1;
1309 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001310
Victor Stinner8182b712010-07-28 00:40:58 +00001311 if (getbuffer(arg, &view, errmsg) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001312 return -1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001313 count = view.len;
1314 *p = view.buf;
1315 PyBuffer_Release(&view);
1316 return count;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001317}
Guido van Rossumaa354651996-08-19 19:32:04 +00001318
Martin v. Löwis423be952008-08-13 15:53:07 +00001319static int
Serhiy Storchakaef1585e2015-12-25 20:01:53 +02001320getbuffer(PyObject *arg, Py_buffer *view, const char **errmsg)
Martin v. Löwis423be952008-08-13 15:53:07 +00001321{
Victor Stinner8182b712010-07-28 00:40:58 +00001322 if (PyObject_GetBuffer(arg, view, PyBUF_SIMPLE) != 0) {
R David Murray861470c2014-10-05 11:47:01 -04001323 *errmsg = "bytes-like object";
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001324 return -1;
1325 }
Victor Stinner5cb62392010-06-06 20:27:51 +00001326 if (!PyBuffer_IsContiguous(view, 'C')) {
Victor Stinner21e09482010-06-24 22:57:10 +00001327 PyBuffer_Release(view);
Victor Stinner5cb62392010-06-06 20:27:51 +00001328 *errmsg = "contiguous buffer";
1329 return -1;
1330 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001331 return 0;
Martin v. Löwis423be952008-08-13 15:53:07 +00001332}
1333
Guido van Rossumaa354651996-08-19 19:32:04 +00001334/* Support for keyword arguments donated by
1335 Geoff Philbrick <philbric@delphi.hks.com> */
1336
Tim Petersf8cd3e82001-10-27 04:26:57 +00001337/* Return false (0) for error, else true. */
Fred Drake563dfc22001-10-23 14:41:08 +00001338int
1339PyArg_ParseTupleAndKeywords(PyObject *args,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001340 PyObject *keywords,
1341 const char *format,
1342 char **kwlist, ...)
Guido van Rossumaa354651996-08-19 19:32:04 +00001343{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001344 int retval;
1345 va_list va;
Tim Peters45772cd2001-10-27 03:58:40 +00001346
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001347 if ((args == NULL || !PyTuple_Check(args)) ||
1348 (keywords != NULL && !PyDict_Check(keywords)) ||
1349 format == NULL ||
1350 kwlist == NULL)
1351 {
1352 PyErr_BadInternalCall();
1353 return 0;
1354 }
Tim Peters45772cd2001-10-27 03:58:40 +00001355
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001356 va_start(va, kwlist);
1357 retval = vgetargskeywords(args, keywords, format, kwlist, &va, 0);
1358 va_end(va);
1359 return retval;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001360}
1361
1362int
1363_PyArg_ParseTupleAndKeywords_SizeT(PyObject *args,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001364 PyObject *keywords,
1365 const char *format,
1366 char **kwlist, ...)
Martin v. Löwis18e16552006-02-15 17:27:45 +00001367{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001368 int retval;
1369 va_list va;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001370
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001371 if ((args == NULL || !PyTuple_Check(args)) ||
1372 (keywords != NULL && !PyDict_Check(keywords)) ||
1373 format == NULL ||
1374 kwlist == NULL)
1375 {
1376 PyErr_BadInternalCall();
1377 return 0;
1378 }
Martin v. Löwis18e16552006-02-15 17:27:45 +00001379
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001380 va_start(va, kwlist);
1381 retval = vgetargskeywords(args, keywords, format,
1382 kwlist, &va, FLAG_SIZE_T);
1383 va_end(va);
1384 return retval;
Guido van Rossumaa354651996-08-19 19:32:04 +00001385}
1386
1387
Brett Cannon711e7d92004-07-10 22:20:32 +00001388int
1389PyArg_VaParseTupleAndKeywords(PyObject *args,
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001390 PyObject *keywords,
Guido van Rossum98297ee2007-11-06 21:34:58 +00001391 const char *format,
Martin v. Löwis15e62742006-02-27 16:46:16 +00001392 char **kwlist, va_list va)
Brett Cannon711e7d92004-07-10 22:20:32 +00001393{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001394 int retval;
1395 va_list lva;
Brett Cannon711e7d92004-07-10 22:20:32 +00001396
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001397 if ((args == NULL || !PyTuple_Check(args)) ||
1398 (keywords != NULL && !PyDict_Check(keywords)) ||
1399 format == NULL ||
1400 kwlist == NULL)
1401 {
1402 PyErr_BadInternalCall();
1403 return 0;
1404 }
Brett Cannon711e7d92004-07-10 22:20:32 +00001405
Alexander Belopolskyf0f45142010-08-11 17:31:17 +00001406 Py_VA_COPY(lva, va);
Brett Cannon711e7d92004-07-10 22:20:32 +00001407
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001408 retval = vgetargskeywords(args, keywords, format, kwlist, &lva, 0);
1409 return retval;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001410}
1411
1412int
1413_PyArg_VaParseTupleAndKeywords_SizeT(PyObject *args,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001414 PyObject *keywords,
1415 const char *format,
1416 char **kwlist, va_list va)
Martin v. Löwis18e16552006-02-15 17:27:45 +00001417{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001418 int retval;
1419 va_list lva;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001420
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001421 if ((args == NULL || !PyTuple_Check(args)) ||
1422 (keywords != NULL && !PyDict_Check(keywords)) ||
1423 format == NULL ||
1424 kwlist == NULL)
1425 {
1426 PyErr_BadInternalCall();
1427 return 0;
1428 }
Martin v. Löwis18e16552006-02-15 17:27:45 +00001429
Alexander Belopolskyf0f45142010-08-11 17:31:17 +00001430 Py_VA_COPY(lva, va);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001431
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001432 retval = vgetargskeywords(args, keywords, format,
1433 kwlist, &lva, FLAG_SIZE_T);
1434 return retval;
Brett Cannon711e7d92004-07-10 22:20:32 +00001435}
1436
Benjamin Petersonfb886362010-04-24 18:21:17 +00001437int
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001438_PyArg_ParseTupleAndKeywordsFast(PyObject *args, PyObject *keywords,
1439 struct _PyArg_Parser *parser, ...)
1440{
1441 int retval;
1442 va_list va;
1443
1444 if ((args == NULL || !PyTuple_Check(args)) ||
1445 (keywords != NULL && !PyDict_Check(keywords)) ||
1446 parser == NULL)
1447 {
1448 PyErr_BadInternalCall();
1449 return 0;
1450 }
1451
1452 va_start(va, parser);
1453 retval = vgetargskeywordsfast(args, keywords, parser, &va, 0);
1454 va_end(va);
1455 return retval;
1456}
1457
1458int
1459_PyArg_ParseTupleAndKeywordsFast_SizeT(PyObject *args, PyObject *keywords,
1460 struct _PyArg_Parser *parser, ...)
1461{
1462 int retval;
1463 va_list va;
1464
1465 if ((args == NULL || !PyTuple_Check(args)) ||
1466 (keywords != NULL && !PyDict_Check(keywords)) ||
1467 parser == NULL)
1468 {
1469 PyErr_BadInternalCall();
1470 return 0;
1471 }
1472
1473 va_start(va, parser);
1474 retval = vgetargskeywordsfast(args, keywords, parser, &va, FLAG_SIZE_T);
1475 va_end(va);
1476 return retval;
1477}
1478
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07001479int
1480_PyArg_ParseStack(PyObject **args, Py_ssize_t nargs, PyObject *kwnames,
1481 struct _PyArg_Parser *parser, ...)
1482{
1483 int retval;
1484 va_list va;
1485
1486 if ((kwnames != NULL && !PyTuple_Check(kwnames)) ||
1487 parser == NULL)
1488 {
1489 PyErr_BadInternalCall();
1490 return 0;
1491 }
1492
1493 va_start(va, parser);
1494 retval = vgetargskeywordsfast_impl(args, nargs, NULL, kwnames, parser, &va, 0);
1495 va_end(va);
1496 return retval;
1497}
1498
1499int
1500_PyArg_ParseStack_SizeT(PyObject **args, Py_ssize_t nargs, PyObject *kwnames,
1501 struct _PyArg_Parser *parser, ...)
1502{
1503 int retval;
1504 va_list va;
1505
1506 if ((kwnames != NULL && !PyTuple_Check(kwnames)) ||
1507 parser == NULL)
1508 {
1509 PyErr_BadInternalCall();
1510 return 0;
1511 }
1512
1513 va_start(va, parser);
1514 retval = vgetargskeywordsfast_impl(args, nargs, NULL, kwnames, parser, &va, FLAG_SIZE_T);
1515 va_end(va);
1516 return retval;
1517}
1518
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001519
1520int
1521_PyArg_VaParseTupleAndKeywordsFast(PyObject *args, PyObject *keywords,
1522 struct _PyArg_Parser *parser, va_list va)
1523{
1524 int retval;
1525 va_list lva;
1526
1527 if ((args == NULL || !PyTuple_Check(args)) ||
1528 (keywords != NULL && !PyDict_Check(keywords)) ||
1529 parser == NULL)
1530 {
1531 PyErr_BadInternalCall();
1532 return 0;
1533 }
1534
1535 Py_VA_COPY(lva, va);
1536
1537 retval = vgetargskeywordsfast(args, keywords, parser, &lva, 0);
1538 return retval;
1539}
1540
1541int
1542_PyArg_VaParseTupleAndKeywordsFast_SizeT(PyObject *args, PyObject *keywords,
1543 struct _PyArg_Parser *parser, va_list va)
1544{
1545 int retval;
1546 va_list lva;
1547
1548 if ((args == NULL || !PyTuple_Check(args)) ||
1549 (keywords != NULL && !PyDict_Check(keywords)) ||
1550 parser == NULL)
1551 {
1552 PyErr_BadInternalCall();
1553 return 0;
1554 }
1555
1556 Py_VA_COPY(lva, va);
1557
1558 retval = vgetargskeywordsfast(args, keywords, parser, &lva, FLAG_SIZE_T);
1559 return retval;
1560}
1561
1562int
Benjamin Petersonfb886362010-04-24 18:21:17 +00001563PyArg_ValidateKeywordArguments(PyObject *kwargs)
1564{
Benjamin Petersonf6096542010-11-17 22:33:12 +00001565 if (!PyDict_Check(kwargs)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001566 PyErr_BadInternalCall();
1567 return 0;
1568 }
1569 if (!_PyDict_HasOnlyStringKeys(kwargs)) {
1570 PyErr_SetString(PyExc_TypeError,
1571 "keyword arguments must be strings");
1572 return 0;
1573 }
1574 return 1;
Benjamin Petersonfb886362010-04-24 18:21:17 +00001575}
1576
Christian Heimes380f7f22008-02-28 11:19:05 +00001577#define IS_END_OF_FORMAT(c) (c == '\0' || c == ';' || c == ':')
Brett Cannon711e7d92004-07-10 22:20:32 +00001578
Guido van Rossumaa354651996-08-19 19:32:04 +00001579static int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001580vgetargskeywords(PyObject *args, PyObject *keywords, const char *format,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001581 char **kwlist, va_list *p_va, int flags)
Guido van Rossumaa354651996-08-19 19:32:04 +00001582{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001583 char msgbuf[512];
1584 int levels[32];
1585 const char *fname, *msg, *custom_msg, *keyword;
1586 int min = INT_MAX;
Larry Hastings83a9f482012-03-20 20:06:16 +00001587 int max = INT_MAX;
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001588 int i, pos, len;
1589 int skip = 0;
Victor Stinner74387f52013-11-18 01:21:12 +01001590 Py_ssize_t nargs, nkeywords;
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001591 PyObject *current_arg;
Antoine Pitrou7056cb22013-02-17 01:04:57 +01001592 freelistentry_t static_entries[STATIC_FREELIST_ENTRIES];
Benjamin Peterson40be9e52014-02-11 10:09:27 -05001593 freelist_t freelist;
1594
1595 freelist.entries = static_entries;
1596 freelist.first_available = 0;
1597 freelist.entries_malloced = 0;
Tim Petersf4331c12001-10-27 00:17:34 +00001598
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001599 assert(args != NULL && PyTuple_Check(args));
1600 assert(keywords == NULL || PyDict_Check(keywords));
1601 assert(format != NULL);
1602 assert(kwlist != NULL);
1603 assert(p_va != NULL);
Tim Peters45772cd2001-10-27 03:58:40 +00001604
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001605 /* grab the function name or custom error msg first (mutually exclusive) */
1606 fname = strchr(format, ':');
1607 if (fname) {
1608 fname++;
1609 custom_msg = NULL;
1610 }
1611 else {
1612 custom_msg = strchr(format,';');
1613 if (custom_msg)
1614 custom_msg++;
1615 }
Christian Heimes380f7f22008-02-28 11:19:05 +00001616
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001617 /* scan kwlist and count the number of positional-only parameters */
1618 for (pos = 0; kwlist[pos] && !*kwlist[pos]; pos++) {
1619 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001620 /* scan kwlist and get greatest possible nbr of args */
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001621 for (len = pos; kwlist[len]; len++) {
1622 if (!*kwlist[len]) {
1623 PyErr_SetString(PyExc_SystemError,
1624 "Empty keyword parameter name");
1625 return cleanreturn(0, &freelist);
1626 }
1627 }
Tim Petersf8cd3e82001-10-27 04:26:57 +00001628
Antoine Pitrou7056cb22013-02-17 01:04:57 +01001629 if (len > STATIC_FREELIST_ENTRIES) {
1630 freelist.entries = PyMem_NEW(freelistentry_t, len);
1631 if (freelist.entries == NULL) {
1632 PyErr_NoMemory();
1633 return 0;
1634 }
1635 freelist.entries_malloced = 1;
Benjamin Peterson7ed67272012-03-16 12:21:02 -05001636 }
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001637
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001638 nargs = PyTuple_GET_SIZE(args);
1639 nkeywords = (keywords == NULL) ? 0 : PyDict_Size(keywords);
1640 if (nargs + nkeywords > len) {
Victor Stinner6ced7c42011-03-21 18:15:42 +01001641 PyErr_Format(PyExc_TypeError,
Victor Stinnercb29ec52013-11-18 02:05:31 +01001642 "%s%s takes at most %d argument%s (%zd given)",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001643 (fname == NULL) ? "function" : fname,
1644 (fname == NULL) ? "" : "()",
1645 len,
1646 (len == 1) ? "" : "s",
1647 nargs + nkeywords);
Benjamin Peterson01feaec2012-03-16 13:25:58 -05001648 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001649 }
Tim Petersc2f01122001-10-27 07:25:06 +00001650
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001651 /* convert tuple args and keyword args in same loop, using kwlist to drive process */
1652 for (i = 0; i < len; i++) {
1653 keyword = kwlist[i];
1654 if (*format == '|') {
Larry Hastings83a9f482012-03-20 20:06:16 +00001655 if (min != INT_MAX) {
Serhiy Storchakaa9725f82016-02-11 12:41:40 +02001656 PyErr_SetString(PyExc_SystemError,
Larry Hastings83a9f482012-03-20 20:06:16 +00001657 "Invalid format string (| specified twice)");
1658 return cleanreturn(0, &freelist);
1659 }
1660
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001661 min = i;
1662 format++;
Larry Hastings83a9f482012-03-20 20:06:16 +00001663
1664 if (max != INT_MAX) {
Serhiy Storchakaa9725f82016-02-11 12:41:40 +02001665 PyErr_SetString(PyExc_SystemError,
Larry Hastings83a9f482012-03-20 20:06:16 +00001666 "Invalid format string ($ before |)");
1667 return cleanreturn(0, &freelist);
1668 }
1669 }
1670 if (*format == '$') {
1671 if (max != INT_MAX) {
Serhiy Storchakaa9725f82016-02-11 12:41:40 +02001672 PyErr_SetString(PyExc_SystemError,
Larry Hastings83a9f482012-03-20 20:06:16 +00001673 "Invalid format string ($ specified twice)");
1674 return cleanreturn(0, &freelist);
1675 }
1676
1677 max = i;
1678 format++;
1679
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001680 if (max < pos) {
1681 PyErr_SetString(PyExc_SystemError,
1682 "Empty parameter name after $");
1683 return cleanreturn(0, &freelist);
1684 }
1685 if (skip) {
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001686 /* Now we know the minimal and the maximal numbers of
1687 * positional arguments and can raise an exception with
1688 * informative message (see below). */
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001689 break;
1690 }
Larry Hastings83a9f482012-03-20 20:06:16 +00001691 if (max < nargs) {
1692 PyErr_Format(PyExc_TypeError,
1693 "Function takes %s %d positional arguments"
1694 " (%d given)",
1695 (min != INT_MAX) ? "at most" : "exactly",
1696 max, nargs);
1697 return cleanreturn(0, &freelist);
1698 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001699 }
1700 if (IS_END_OF_FORMAT(*format)) {
Serhiy Storchakaa9725f82016-02-11 12:41:40 +02001701 PyErr_Format(PyExc_SystemError,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001702 "More keyword list entries (%d) than "
1703 "format specifiers (%d)", len, i);
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001704 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001705 }
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001706 if (!skip) {
1707 current_arg = NULL;
1708 if (nkeywords && i >= pos) {
1709 current_arg = PyDict_GetItemString(keywords, keyword);
1710 if (!current_arg && PyErr_Occurred()) {
1711 return cleanreturn(0, &freelist);
1712 }
1713 }
1714 if (current_arg) {
1715 --nkeywords;
1716 if (i < nargs) {
1717 /* arg present in tuple and in dict */
1718 PyErr_Format(PyExc_TypeError,
1719 "Argument given by name ('%s') "
1720 "and position (%d)",
1721 keyword, i+1);
1722 return cleanreturn(0, &freelist);
1723 }
1724 }
1725 else if (i < nargs)
1726 current_arg = PyTuple_GET_ITEM(args, i);
1727
1728 if (current_arg) {
1729 msg = convertitem(current_arg, &format, p_va, flags,
1730 levels, msgbuf, sizeof(msgbuf), &freelist);
1731 if (msg) {
1732 seterror(i+1, msg, levels, fname, custom_msg);
1733 return cleanreturn(0, &freelist);
1734 }
1735 continue;
1736 }
1737
1738 if (i < min) {
1739 if (i < pos) {
1740 assert (min == INT_MAX);
1741 assert (max == INT_MAX);
1742 skip = 1;
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001743 /* At that moment we still don't know the minimal and
1744 * the maximal numbers of positional arguments. Raising
1745 * an exception is deferred until we encounter | and $
1746 * or the end of the format. */
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001747 }
1748 else {
1749 PyErr_Format(PyExc_TypeError, "Required argument "
1750 "'%s' (pos %d) not found",
1751 keyword, i+1);
1752 return cleanreturn(0, &freelist);
1753 }
1754 }
1755 /* current code reports success when all required args
1756 * fulfilled and no keyword args left, with no further
1757 * validation. XXX Maybe skip this in debug build ?
1758 */
1759 if (!nkeywords && !skip) {
1760 return cleanreturn(1, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001761 }
1762 }
Guido van Rossumaa354651996-08-19 19:32:04 +00001763
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001764 /* We are into optional args, skip thru to any remaining
1765 * keyword args */
1766 msg = skipitem(&format, p_va, flags);
1767 if (msg) {
Serhiy Storchakaa9725f82016-02-11 12:41:40 +02001768 PyErr_Format(PyExc_SystemError, "%s: '%s'", msg,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001769 format);
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001770 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001771 }
1772 }
Tim Petersb054be42001-10-27 05:07:41 +00001773
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001774 if (skip) {
1775 PyErr_Format(PyExc_TypeError,
1776 "Function takes %s %d positional arguments"
1777 " (%d given)",
1778 (Py_MIN(pos, min) < i) ? "at least" : "exactly",
1779 Py_MIN(pos, min), nargs);
1780 return cleanreturn(0, &freelist);
1781 }
1782
Larry Hastings83a9f482012-03-20 20:06:16 +00001783 if (!IS_END_OF_FORMAT(*format) && (*format != '|') && (*format != '$')) {
Serhiy Storchakaa9725f82016-02-11 12:41:40 +02001784 PyErr_Format(PyExc_SystemError,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001785 "more argument specifiers than keyword list entries "
1786 "(remaining format:'%s')", format);
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001787 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001788 }
Tim Petersc2f01122001-10-27 07:25:06 +00001789
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001790 /* make sure there are no extraneous keyword arguments */
1791 if (nkeywords > 0) {
1792 PyObject *key, *value;
1793 Py_ssize_t pos = 0;
1794 while (PyDict_Next(keywords, &pos, &key, &value)) {
1795 int match = 0;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001796 if (!PyUnicode_Check(key)) {
1797 PyErr_SetString(PyExc_TypeError,
1798 "keywords must be strings");
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001799 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001800 }
Antoine Pitrou7056cb22013-02-17 01:04:57 +01001801 for (i = 0; i < len; i++) {
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001802 if (*kwlist[i] && !PyUnicode_CompareWithASCIIString(key, kwlist[i])) {
Antoine Pitrou7056cb22013-02-17 01:04:57 +01001803 match = 1;
1804 break;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001805 }
1806 }
1807 if (!match) {
1808 PyErr_Format(PyExc_TypeError,
Victor Stinner93b55132010-05-19 00:54:06 +00001809 "'%U' is an invalid keyword "
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001810 "argument for this function",
Victor Stinner93b55132010-05-19 00:54:06 +00001811 key);
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001812 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001813 }
1814 }
1815 }
1816
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001817 return cleanreturn(1, &freelist);
Guido van Rossumaa354651996-08-19 19:32:04 +00001818}
1819
1820
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001821/* List of static parsers. */
1822static struct _PyArg_Parser *static_arg_parsers = NULL;
1823
1824static int
1825parser_init(struct _PyArg_Parser *parser)
1826{
1827 const char * const *keywords;
1828 const char *format, *msg;
1829 int i, len, min, max, nkw;
1830 PyObject *kwtuple;
1831
1832 assert(parser->format != NULL);
1833 assert(parser->keywords != NULL);
1834 if (parser->kwtuple != NULL) {
1835 return 1;
1836 }
1837
1838 /* grab the function name or custom error msg first (mutually exclusive) */
1839 parser->fname = strchr(parser->format, ':');
1840 if (parser->fname) {
1841 parser->fname++;
1842 parser->custom_msg = NULL;
1843 }
1844 else {
1845 parser->custom_msg = strchr(parser->format,';');
1846 if (parser->custom_msg)
1847 parser->custom_msg++;
1848 }
1849
1850 keywords = parser->keywords;
1851 /* scan keywords and count the number of positional-only parameters */
1852 for (i = 0; keywords[i] && !*keywords[i]; i++) {
1853 }
1854 parser->pos = i;
1855 /* scan keywords and get greatest possible nbr of args */
1856 for (; keywords[i]; i++) {
1857 if (!*keywords[i]) {
1858 PyErr_SetString(PyExc_SystemError,
1859 "Empty keyword parameter name");
1860 return 0;
1861 }
1862 }
1863 len = i;
1864
1865 min = max = INT_MAX;
1866 format = parser->format;
1867 for (i = 0; i < len; i++) {
1868 if (*format == '|') {
1869 if (min != INT_MAX) {
1870 PyErr_SetString(PyExc_SystemError,
1871 "Invalid format string (| specified twice)");
1872 return 0;
1873 }
1874 if (max != INT_MAX) {
1875 PyErr_SetString(PyExc_SystemError,
1876 "Invalid format string ($ before |)");
1877 return 0;
1878 }
1879 min = i;
1880 format++;
1881 }
1882 if (*format == '$') {
1883 if (max != INT_MAX) {
1884 PyErr_SetString(PyExc_SystemError,
1885 "Invalid format string ($ specified twice)");
1886 return 0;
1887 }
1888 if (i < parser->pos) {
1889 PyErr_SetString(PyExc_SystemError,
1890 "Empty parameter name after $");
1891 return 0;
1892 }
1893 max = i;
1894 format++;
1895 }
1896 if (IS_END_OF_FORMAT(*format)) {
1897 PyErr_Format(PyExc_SystemError,
1898 "More keyword list entries (%d) than "
1899 "format specifiers (%d)", len, i);
1900 return 0;
1901 }
1902
1903 msg = skipitem(&format, NULL, 0);
1904 if (msg) {
1905 PyErr_Format(PyExc_SystemError, "%s: '%s'", msg,
1906 format);
1907 return 0;
1908 }
1909 }
1910 parser->min = Py_MIN(min, len);
1911 parser->max = Py_MIN(max, len);
1912
1913 if (!IS_END_OF_FORMAT(*format) && (*format != '|') && (*format != '$')) {
1914 PyErr_Format(PyExc_SystemError,
1915 "more argument specifiers than keyword list entries "
1916 "(remaining format:'%s')", format);
1917 return 0;
1918 }
1919
1920 nkw = len - parser->pos;
1921 kwtuple = PyTuple_New(nkw);
1922 if (kwtuple == NULL) {
1923 return 0;
1924 }
1925 keywords = parser->keywords + parser->pos;
1926 for (i = 0; i < nkw; i++) {
1927 PyObject *str = PyUnicode_FromString(keywords[i]);
1928 if (str == NULL) {
1929 Py_DECREF(kwtuple);
1930 return 0;
1931 }
1932 PyUnicode_InternInPlace(&str);
1933 PyTuple_SET_ITEM(kwtuple, i, str);
1934 }
1935 parser->kwtuple = kwtuple;
1936
1937 assert(parser->next == NULL);
1938 parser->next = static_arg_parsers;
1939 static_arg_parsers = parser;
1940 return 1;
1941}
1942
1943static void
1944parser_clear(struct _PyArg_Parser *parser)
1945{
1946 Py_CLEAR(parser->kwtuple);
1947}
1948
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07001949static PyObject*
1950find_keyword(PyObject *kwnames, PyObject **kwstack, PyObject *key)
1951{
1952 Py_ssize_t i, nkwargs;
1953
1954 nkwargs = PyTuple_GET_SIZE(kwnames);
1955 for (i=0; i < nkwargs; i++) {
1956 PyObject *kwname = PyTuple_GET_ITEM(kwnames, i);
1957
1958 /* ptr==ptr should match in most cases since keyword keys
1959 should be interned strings */
1960 if (kwname == key) {
1961 return kwstack[i];
1962 }
1963 if (!PyUnicode_Check(kwname)) {
1964 /* ignore non-string keyword keys:
1965 an error will be raised above */
1966 continue;
1967 }
1968 if (_PyUnicode_EQ(kwname, key)) {
1969 return kwstack[i];
1970 }
1971 }
1972 return NULL;
1973}
1974
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001975static int
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07001976vgetargskeywordsfast_impl(PyObject **args, Py_ssize_t nargs,
1977 PyObject *keywords, PyObject *kwnames,
1978 struct _PyArg_Parser *parser,
1979 va_list *p_va, int flags)
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001980{
1981 PyObject *kwtuple;
1982 char msgbuf[512];
1983 int levels[32];
1984 const char *format;
1985 const char *msg;
1986 PyObject *keyword;
1987 int i, pos, len;
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07001988 Py_ssize_t nkeywords;
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001989 PyObject *current_arg;
1990 freelistentry_t static_entries[STATIC_FREELIST_ENTRIES];
1991 freelist_t freelist;
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07001992 PyObject **kwstack = NULL;
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001993
1994 freelist.entries = static_entries;
1995 freelist.first_available = 0;
1996 freelist.entries_malloced = 0;
1997
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001998 assert(keywords == NULL || PyDict_Check(keywords));
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07001999 assert(kwnames == NULL || PyTuple_Check(kwnames));
2000 assert((keywords != NULL || kwnames != NULL)
2001 || (keywords == NULL && kwnames == NULL));
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002002 assert(parser != NULL);
2003 assert(p_va != NULL);
2004
2005 if (!parser_init(parser)) {
2006 return 0;
2007 }
2008
2009 kwtuple = parser->kwtuple;
2010 pos = parser->pos;
2011 len = pos + PyTuple_GET_SIZE(kwtuple);
2012
2013 if (len > STATIC_FREELIST_ENTRIES) {
2014 freelist.entries = PyMem_NEW(freelistentry_t, len);
2015 if (freelist.entries == NULL) {
2016 PyErr_NoMemory();
2017 return 0;
2018 }
2019 freelist.entries_malloced = 1;
2020 }
2021
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002022 if (keywords != NULL) {
2023 nkeywords = PyDict_Size(keywords);
2024 }
2025 else if (kwnames != NULL) {
2026 nkeywords = PyTuple_GET_SIZE(kwnames);
2027 kwstack = args + nargs;
2028 }
2029 else {
2030 nkeywords = 0;
2031 }
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002032 if (nargs + nkeywords > len) {
2033 PyErr_Format(PyExc_TypeError,
2034 "%s%s takes at most %d argument%s (%zd given)",
2035 (parser->fname == NULL) ? "function" : parser->fname,
2036 (parser->fname == NULL) ? "" : "()",
2037 len,
2038 (len == 1) ? "" : "s",
2039 nargs + nkeywords);
2040 return cleanreturn(0, &freelist);
2041 }
2042 if (parser->max < nargs) {
2043 PyErr_Format(PyExc_TypeError,
2044 "Function takes %s %d positional arguments (%d given)",
2045 (parser->min != INT_MAX) ? "at most" : "exactly",
2046 parser->max, nargs);
2047 return cleanreturn(0, &freelist);
2048 }
2049
2050 format = parser->format;
2051 /* convert tuple args and keyword args in same loop, using kwtuple to drive process */
2052 for (i = 0; i < len; i++) {
2053 keyword = (i >= pos) ? PyTuple_GET_ITEM(kwtuple, i - pos) : NULL;
2054 if (*format == '|') {
2055 format++;
2056 }
2057 if (*format == '$') {
2058 format++;
2059 }
2060 assert(!IS_END_OF_FORMAT(*format));
2061
2062 current_arg = NULL;
2063 if (nkeywords && i >= pos) {
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002064 if (keywords != NULL) {
2065 current_arg = PyDict_GetItem(keywords, keyword);
2066 if (!current_arg && PyErr_Occurred()) {
2067 return cleanreturn(0, &freelist);
2068 }
2069 }
2070 else {
2071 current_arg = find_keyword(kwnames, kwstack, keyword);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002072 }
2073 }
2074 if (current_arg) {
2075 --nkeywords;
2076 if (i < nargs) {
2077 /* arg present in tuple and in dict */
2078 PyErr_Format(PyExc_TypeError,
2079 "Argument given by name ('%U') "
2080 "and position (%d)",
2081 keyword, i+1);
2082 return cleanreturn(0, &freelist);
2083 }
2084 }
Victor Stinnera9efb2f2016-09-09 17:40:22 -07002085 else if (i < nargs) {
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002086 current_arg = args[i];
Victor Stinnera9efb2f2016-09-09 17:40:22 -07002087 }
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002088
2089 if (current_arg) {
2090 msg = convertitem(current_arg, &format, p_va, flags,
2091 levels, msgbuf, sizeof(msgbuf), &freelist);
2092 if (msg) {
2093 seterror(i+1, msg, levels, parser->fname, parser->custom_msg);
2094 return cleanreturn(0, &freelist);
2095 }
2096 continue;
2097 }
2098
2099 if (i < parser->min) {
2100 /* Less arguments than required */
2101 if (i < pos) {
2102 PyErr_Format(PyExc_TypeError,
2103 "Function takes %s %d positional arguments"
2104 " (%d given)",
2105 (Py_MIN(pos, parser->min) < parser->max) ? "at least" : "exactly",
2106 Py_MIN(pos, parser->min), nargs);
2107 }
2108 else {
2109 PyErr_Format(PyExc_TypeError, "Required argument "
2110 "'%U' (pos %d) not found",
2111 keyword, i+1);
2112 }
2113 return cleanreturn(0, &freelist);
2114 }
2115 /* current code reports success when all required args
2116 * fulfilled and no keyword args left, with no further
2117 * validation. XXX Maybe skip this in debug build ?
2118 */
2119 if (!nkeywords) {
2120 return cleanreturn(1, &freelist);
2121 }
2122
2123 /* We are into optional args, skip thru to any remaining
2124 * keyword args */
2125 msg = skipitem(&format, p_va, flags);
2126 assert(msg == NULL);
2127 }
2128
2129 assert(IS_END_OF_FORMAT(*format) || (*format == '|') || (*format == '$'));
2130
2131 /* make sure there are no extraneous keyword arguments */
2132 if (nkeywords > 0) {
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002133 if (keywords != NULL) {
2134 PyObject *key, *value;
2135 Py_ssize_t pos = 0;
2136 while (PyDict_Next(keywords, &pos, &key, &value)) {
2137 int match;
2138 if (!PyUnicode_Check(key)) {
2139 PyErr_SetString(PyExc_TypeError,
2140 "keywords must be strings");
2141 return cleanreturn(0, &freelist);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002142 }
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002143 match = PySequence_Contains(kwtuple, key);
2144 if (match <= 0) {
2145 if (!match) {
2146 PyErr_Format(PyExc_TypeError,
2147 "'%U' is an invalid keyword "
2148 "argument for this function",
2149 key);
2150 }
2151 return cleanreturn(0, &freelist);
2152 }
2153 }
2154 }
2155 else {
2156 Py_ssize_t j, nkwargs;
2157
2158 nkwargs = PyTuple_GET_SIZE(kwnames);
2159 for (j=0; j < nkwargs; j++) {
2160 PyObject *key = PyTuple_GET_ITEM(kwnames, j);
2161 int match;
2162
2163 if (!PyUnicode_Check(key)) {
2164 PyErr_SetString(PyExc_TypeError,
2165 "keywords must be strings");
2166 return cleanreturn(0, &freelist);
2167 }
2168
2169 match = PySequence_Contains(kwtuple, key);
2170 if (match <= 0) {
2171 if (!match) {
2172 PyErr_Format(PyExc_TypeError,
2173 "'%U' is an invalid keyword "
2174 "argument for this function",
2175 key);
2176 }
2177 return cleanreturn(0, &freelist);
2178 }
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002179 }
2180 }
2181 }
2182
2183 return cleanreturn(1, &freelist);
2184}
2185
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002186static int
2187vgetargskeywordsfast(PyObject *args, PyObject *keywords,
2188 struct _PyArg_Parser *parser, va_list *p_va, int flags)
2189{
2190 PyObject **stack;
2191 Py_ssize_t nargs;
2192
2193 assert(args != NULL && PyTuple_Check(args));
2194
2195 stack = &PyTuple_GET_ITEM(args, 0);
2196 nargs = PyTuple_GET_SIZE(args);
2197 return vgetargskeywordsfast_impl(stack, nargs, keywords, NULL,
2198 parser, p_va, flags);
2199}
2200
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002201
Serhiy Storchakaef1585e2015-12-25 20:01:53 +02002202static const char *
Martin v. Löwis18e16552006-02-15 17:27:45 +00002203skipitem(const char **p_format, va_list *p_va, int flags)
Guido van Rossumaa354651996-08-19 19:32:04 +00002204{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002205 const char *format = *p_format;
2206 char c = *format++;
Guido van Rossum98297ee2007-11-06 21:34:58 +00002207
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002208 switch (c) {
Georg Brandl6dd14612005-09-14 19:29:53 +00002209
Larry Hastingsa3479012012-05-08 23:52:03 -07002210 /*
2211 * codes that take a single data pointer as an argument
2212 * (the type of the pointer is irrelevant)
2213 */
Georg Brandl6dd14612005-09-14 19:29:53 +00002214
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002215 case 'b': /* byte -- very short int */
2216 case 'B': /* byte as bitfield */
2217 case 'h': /* short int */
2218 case 'H': /* short int as bitfield */
2219 case 'i': /* int */
2220 case 'I': /* int sized bitfield */
2221 case 'l': /* long int */
2222 case 'k': /* long int sized bitfield */
Benjamin Petersonaf580df2016-09-06 10:46:49 -07002223 case 'L': /* long long */
2224 case 'K': /* long long sized bitfield */
Larry Hastingsa3479012012-05-08 23:52:03 -07002225 case 'n': /* Py_ssize_t */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002226 case 'f': /* float */
2227 case 'd': /* double */
2228 case 'D': /* complex double */
2229 case 'c': /* char */
2230 case 'C': /* unicode char */
Larry Hastings10ba07a2012-05-07 02:44:50 -07002231 case 'p': /* boolean predicate */
Larry Hastingsa3479012012-05-08 23:52:03 -07002232 case 'S': /* string object */
2233 case 'Y': /* string object */
2234 case 'U': /* unicode string object */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002235 {
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002236 if (p_va != NULL) {
2237 (void) va_arg(*p_va, void *);
2238 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002239 break;
2240 }
Martin v. Löwis18e16552006-02-15 17:27:45 +00002241
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002242 /* string codes */
Guido van Rossum98297ee2007-11-06 21:34:58 +00002243
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002244 case 'e': /* string with encoding */
2245 {
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002246 if (p_va != NULL) {
2247 (void) va_arg(*p_va, const char *);
2248 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002249 if (!(*format == 's' || *format == 't'))
2250 /* after 'e', only 's' and 't' is allowed */
2251 goto err;
2252 format++;
2253 /* explicit fallthrough to string cases */
2254 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00002255
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002256 case 's': /* string */
2257 case 'z': /* string or None */
2258 case 'y': /* bytes */
2259 case 'u': /* unicode string */
Larry Hastingsd9e4a412012-05-08 03:51:18 -07002260 case 'Z': /* unicode string or None */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002261 case 'w': /* buffer, read-write */
2262 {
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002263 if (p_va != NULL) {
2264 (void) va_arg(*p_va, char **);
2265 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002266 if (*format == '#') {
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002267 if (p_va != NULL) {
2268 if (flags & FLAG_SIZE_T)
2269 (void) va_arg(*p_va, Py_ssize_t *);
2270 else
2271 (void) va_arg(*p_va, int *);
2272 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002273 format++;
2274 } else if ((c == 's' || c == 'z' || c == 'y') && *format == '*') {
2275 format++;
2276 }
2277 break;
2278 }
Georg Brandl6dd14612005-09-14 19:29:53 +00002279
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002280 case 'O': /* object */
2281 {
2282 if (*format == '!') {
2283 format++;
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002284 if (p_va != NULL) {
2285 (void) va_arg(*p_va, PyTypeObject*);
2286 (void) va_arg(*p_va, PyObject **);
2287 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002288 }
2289 else if (*format == '&') {
2290 typedef int (*converter)(PyObject *, void *);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002291 if (p_va != NULL) {
2292 (void) va_arg(*p_va, converter);
2293 (void) va_arg(*p_va, void *);
2294 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002295 format++;
2296 }
2297 else {
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002298 if (p_va != NULL) {
2299 (void) va_arg(*p_va, PyObject **);
2300 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002301 }
2302 break;
2303 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00002304
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002305 case '(': /* bypass tuple, not handled at all previously */
2306 {
Serhiy Storchakaef1585e2015-12-25 20:01:53 +02002307 const char *msg;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002308 for (;;) {
2309 if (*format==')')
2310 break;
2311 if (IS_END_OF_FORMAT(*format))
2312 return "Unmatched left paren in format "
2313 "string";
2314 msg = skipitem(&format, p_va, flags);
2315 if (msg)
2316 return msg;
2317 }
2318 format++;
2319 break;
2320 }
Christian Heimes380f7f22008-02-28 11:19:05 +00002321
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002322 case ')':
2323 return "Unmatched right paren in format string";
Christian Heimes380f7f22008-02-28 11:19:05 +00002324
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002325 default:
Georg Brandl6dd14612005-09-14 19:29:53 +00002326err:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002327 return "impossible<bad format char>";
Guido van Rossum98297ee2007-11-06 21:34:58 +00002328
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002329 }
Georg Brandl6dd14612005-09-14 19:29:53 +00002330
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002331 *p_format = format;
2332 return NULL;
Guido van Rossumaa354651996-08-19 19:32:04 +00002333}
Fred Drakee4616e62001-10-23 21:09:29 +00002334
2335
2336int
Martin v. Löwis76246742006-03-01 04:06:10 +00002337PyArg_UnpackTuple(PyObject *args, const char *name, Py_ssize_t min, Py_ssize_t max, ...)
Fred Drakee4616e62001-10-23 21:09:29 +00002338{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002339 Py_ssize_t i, l;
2340 PyObject **o;
2341 va_list vargs;
Fred Drakee4616e62001-10-23 21:09:29 +00002342
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002343 assert(min >= 0);
2344 assert(min <= max);
2345 if (!PyTuple_Check(args)) {
2346 PyErr_SetString(PyExc_SystemError,
2347 "PyArg_UnpackTuple() argument list is not a tuple");
2348 return 0;
2349 }
2350 l = PyTuple_GET_SIZE(args);
2351 if (l < min) {
2352 if (name != NULL)
2353 PyErr_Format(
2354 PyExc_TypeError,
2355 "%s expected %s%zd arguments, got %zd",
2356 name, (min == max ? "" : "at least "), min, l);
2357 else
2358 PyErr_Format(
2359 PyExc_TypeError,
2360 "unpacked tuple should have %s%zd elements,"
2361 " but has %zd",
2362 (min == max ? "" : "at least "), min, l);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002363 return 0;
2364 }
Raymond Hettinger94230232016-03-26 03:02:48 -07002365 if (l == 0)
2366 return 1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002367 if (l > max) {
2368 if (name != NULL)
2369 PyErr_Format(
2370 PyExc_TypeError,
2371 "%s expected %s%zd arguments, got %zd",
2372 name, (min == max ? "" : "at most "), max, l);
2373 else
2374 PyErr_Format(
2375 PyExc_TypeError,
2376 "unpacked tuple should have %s%zd elements,"
2377 " but has %zd",
2378 (min == max ? "" : "at most "), max, l);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002379 return 0;
2380 }
Raymond Hettinger94230232016-03-26 03:02:48 -07002381
2382#ifdef HAVE_STDARG_PROTOTYPES
2383 va_start(vargs, max);
2384#else
2385 va_start(vargs);
2386#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002387 for (i = 0; i < l; i++) {
2388 o = va_arg(vargs, PyObject **);
2389 *o = PyTuple_GET_ITEM(args, i);
2390 }
2391 va_end(vargs);
2392 return 1;
Fred Drakee4616e62001-10-23 21:09:29 +00002393}
Georg Brandl02c42872005-08-26 06:42:30 +00002394
2395
2396/* For type constructors that don't take keyword args
2397 *
Larry Hastingsb7ccb202014-01-18 23:50:21 -08002398 * Sets a TypeError and returns 0 if the args/kwargs is
Thomas Wouters89f507f2006-12-13 04:49:30 +00002399 * not empty, returns 1 otherwise
Georg Brandl02c42872005-08-26 06:42:30 +00002400 */
2401int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00002402_PyArg_NoKeywords(const char *funcname, PyObject *kw)
Georg Brandl02c42872005-08-26 06:42:30 +00002403{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002404 if (kw == NULL)
2405 return 1;
2406 if (!PyDict_CheckExact(kw)) {
2407 PyErr_BadInternalCall();
2408 return 0;
2409 }
2410 if (PyDict_Size(kw) == 0)
2411 return 1;
Guido van Rossum98297ee2007-11-06 21:34:58 +00002412
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002413 PyErr_Format(PyExc_TypeError, "%s does not take keyword arguments",
2414 funcname);
2415 return 0;
Georg Brandl02c42872005-08-26 06:42:30 +00002416}
Larry Hastingsb7ccb202014-01-18 23:50:21 -08002417
2418
2419int
2420_PyArg_NoPositional(const char *funcname, PyObject *args)
2421{
2422 if (args == NULL)
2423 return 1;
2424 if (!PyTuple_CheckExact(args)) {
2425 PyErr_BadInternalCall();
2426 return 0;
2427 }
2428 if (PyTuple_GET_SIZE(args) == 0)
2429 return 1;
2430
2431 PyErr_Format(PyExc_TypeError, "%s does not take positional arguments",
2432 funcname);
2433 return 0;
2434}
2435
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002436void
2437_PyArg_Fini(void)
2438{
2439 struct _PyArg_Parser *tmp, *s = static_arg_parsers;
2440 while (s) {
2441 tmp = s->next;
2442 s->next = NULL;
2443 parser_clear(s);
2444 s = tmp;
2445 }
2446 static_arg_parsers = NULL;
2447}
2448
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002449#ifdef __cplusplus
2450};
2451#endif