blob: 58c9a998ff8dffe8718a2bfd546fd7ba18ab717e [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 *, ...);
Victor Stinner6518a932017-01-17 01:29:49 +010029PyAPI_FUNC(int) _PyArg_ParseStack_SizeT(PyObject **args, Py_ssize_t nargs,
30 const char *format, ...);
Victor Stinner3e1fad62017-01-17 01:29:01 +010031PyAPI_FUNC(int) _PyArg_ParseStackAndKeywords_SizeT(PyObject **args, Py_ssize_t nargs, PyObject *kwnames,
Benjamin Peterson819a46f2016-09-09 20:45:06 -070032 struct _PyArg_Parser *parser, ...);
Serhiy Storchakaef1585e2015-12-25 20:01:53 +020033PyAPI_FUNC(int) _PyArg_ParseTuple_SizeT(PyObject *, const char *, ...);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000034PyAPI_FUNC(int) _PyArg_ParseTupleAndKeywords_SizeT(PyObject *, PyObject *,
35 const char *, char **, ...);
36PyAPI_FUNC(PyObject *) _Py_BuildValue_SizeT(const char *, ...);
Serhiy Storchakaef1585e2015-12-25 20:01:53 +020037PyAPI_FUNC(int) _PyArg_VaParse_SizeT(PyObject *, const char *, va_list);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000038PyAPI_FUNC(int) _PyArg_VaParseTupleAndKeywords_SizeT(PyObject *, PyObject *,
39 const char *, char **, va_list);
Benjamin Peterson4eef5052016-09-10 17:04:36 -070040
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +030041PyAPI_FUNC(int) _PyArg_ParseTupleAndKeywordsFast_SizeT(PyObject *, PyObject *,
42 struct _PyArg_Parser *, ...);
43PyAPI_FUNC(int) _PyArg_VaParseTupleAndKeywordsFast_SizeT(PyObject *, PyObject *,
44 struct _PyArg_Parser *, va_list);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000045#endif
46
Martin v. Löwis18e16552006-02-15 17:27:45 +000047#define FLAG_COMPAT 1
48#define FLAG_SIZE_T 2
49
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -040050typedef int (*destr_t)(PyObject *, void *);
51
52
53/* Keep track of "objects" that have been allocated or initialized and
54 which will need to be deallocated or cleaned up somehow if overall
55 parsing fails.
56*/
57typedef struct {
58 void *item;
59 destr_t destructor;
60} freelistentry_t;
61
62typedef struct {
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -040063 freelistentry_t *entries;
Antoine Pitrou7056cb22013-02-17 01:04:57 +010064 int first_available;
65 int entries_malloced;
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -040066} freelist_t;
67
Antoine Pitrou7056cb22013-02-17 01:04:57 +010068#define STATIC_FREELIST_ENTRIES 8
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000069
70/* Forward */
Victor Stinner6518a932017-01-17 01:29:49 +010071static int vgetargs1_impl(PyObject *args, PyObject **stack, Py_ssize_t nargs,
72 const char *format, va_list *p_va, int flags);
Jeremy Hyltonaf68c872005-12-10 18:50:16 +000073static int vgetargs1(PyObject *, const char *, va_list *, int);
Victor Stinner84bb1cf2013-05-17 00:12:04 +020074static void seterror(Py_ssize_t, const char *, int *, const char *, const char *);
Serhiy Storchakaef1585e2015-12-25 20:01:53 +020075static const char *convertitem(PyObject *, const char **, va_list *, int, int *,
76 char *, size_t, freelist_t *);
77static const char *converttuple(PyObject *, const char **, va_list *, int,
78 int *, char *, size_t, int, freelist_t *);
79static const char *convertsimple(PyObject *, const char **, va_list *, int,
80 char *, size_t, freelist_t *);
Serhiy Storchaka85b0f5b2016-11-20 10:16:47 +020081static Py_ssize_t convertbuffer(PyObject *, const void **p, const char **);
Serhiy Storchakaef1585e2015-12-25 20:01:53 +020082static int getbuffer(PyObject *, Py_buffer *, const char**);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000083
Tim Petersdbd9ba62000-07-09 03:09:57 +000084static int vgetargskeywords(PyObject *, PyObject *,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000085 const char *, char **, va_list *, int);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +030086static int vgetargskeywordsfast(PyObject *, PyObject *,
87 struct _PyArg_Parser *, va_list *, int);
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -070088static int vgetargskeywordsfast_impl(PyObject **args, Py_ssize_t nargs,
89 PyObject *keywords, PyObject *kwnames,
90 struct _PyArg_Parser *parser,
91 va_list *p_va, int flags);
Serhiy Storchakaef1585e2015-12-25 20:01:53 +020092static const char *skipitem(const char **, va_list *, int);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000093
Fred Drake563dfc22001-10-23 14:41:08 +000094int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +000095PyArg_Parse(PyObject *args, const char *format, ...)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000096{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000097 int retval;
98 va_list va;
Guido van Rossum98297ee2007-11-06 21:34:58 +000099
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000100 va_start(va, format);
101 retval = vgetargs1(args, format, &va, FLAG_COMPAT);
102 va_end(va);
103 return retval;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000104}
105
106int
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200107_PyArg_Parse_SizeT(PyObject *args, const char *format, ...)
Martin v. Löwis18e16552006-02-15 17:27:45 +0000108{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000109 int retval;
110 va_list va;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000111
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000112 va_start(va, format);
113 retval = vgetargs1(args, format, &va, FLAG_COMPAT|FLAG_SIZE_T);
114 va_end(va);
115 return retval;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000116}
117
118
Fred Drake563dfc22001-10-23 14:41:08 +0000119int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000120PyArg_ParseTuple(PyObject *args, const char *format, ...)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000121{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000122 int retval;
123 va_list va;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000124
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000125 va_start(va, format);
126 retval = vgetargs1(args, format, &va, 0);
127 va_end(va);
128 return retval;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000129}
130
Martin v. Löwis18e16552006-02-15 17:27:45 +0000131int
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200132_PyArg_ParseTuple_SizeT(PyObject *args, const char *format, ...)
Martin v. Löwis18e16552006-02-15 17:27:45 +0000133{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000134 int retval;
135 va_list va;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000136
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000137 va_start(va, format);
138 retval = vgetargs1(args, format, &va, FLAG_SIZE_T);
139 va_end(va);
140 return retval;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000141}
142
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000143
144int
Victor Stinner6518a932017-01-17 01:29:49 +0100145_PyArg_ParseStack(PyObject **args, Py_ssize_t nargs, const char *format, ...)
146{
147 int retval;
148 va_list va;
149
150 va_start(va, format);
151 retval = vgetargs1_impl(NULL, args, nargs, format, &va, 0);
152 va_end(va);
153 return retval;
154}
155
156int
157_PyArg_ParseStack_SizeT(PyObject **args, Py_ssize_t nargs, const char *format, ...)
158{
159 int retval;
160 va_list va;
161
162 va_start(va, format);
163 retval = vgetargs1_impl(NULL, args, nargs, format, &va, FLAG_SIZE_T);
164 va_end(va);
165 return retval;
166}
167
168
169int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000170PyArg_VaParse(PyObject *args, const char *format, va_list va)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000171{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000172 va_list lva;
Christian Heimes2f2fee12016-09-21 11:37:27 +0200173 int retval;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000174
Benjamin Peterson0c212142016-09-20 20:39:33 -0700175 va_copy(lva, va);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000176
Christian Heimes2f2fee12016-09-21 11:37:27 +0200177 retval = vgetargs1(args, format, &lva, 0);
178 va_end(lva);
179 return retval;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000180}
181
Martin v. Löwis18e16552006-02-15 17:27:45 +0000182int
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200183_PyArg_VaParse_SizeT(PyObject *args, const char *format, va_list va)
Martin v. Löwis18e16552006-02-15 17:27:45 +0000184{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000185 va_list lva;
Christian Heimes2f2fee12016-09-21 11:37:27 +0200186 int retval;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000187
Benjamin Peterson0c212142016-09-20 20:39:33 -0700188 va_copy(lva, va);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000189
Christian Heimes2f2fee12016-09-21 11:37:27 +0200190 retval = vgetargs1(args, format, &lva, FLAG_SIZE_T);
191 va_end(lva);
192 return retval;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000193}
194
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000195
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000196/* Handle cleanup of allocated memory in case of exception */
197
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400198static int
199cleanup_ptr(PyObject *self, void *ptr)
Antoine Pitrouf71995782008-08-29 18:37:05 +0000200{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000201 if (ptr) {
202 PyMem_FREE(ptr);
203 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000204 return 0;
Martin v. Löwisc15bdef2009-05-29 14:47:46 +0000205}
206
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000207static int
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400208cleanup_buffer(PyObject *self, void *ptr)
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000209{
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400210 Py_buffer *buf = (Py_buffer *)ptr;
211 if (buf) {
212 PyBuffer_Release(buf);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000213 }
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400214 return 0;
215}
216
217static int
218addcleanup(void *ptr, freelist_t *freelist, destr_t destructor)
219{
220 int index;
221
222 index = freelist->first_available;
223 freelist->first_available += 1;
224
225 freelist->entries[index].item = ptr;
226 freelist->entries[index].destructor = destructor;
227
228 return 0;
229}
230
231static int
232cleanreturn(int retval, freelist_t *freelist)
233{
234 int index;
235
236 if (retval == 0) {
237 /* A failure occurred, therefore execute all of the cleanup
238 functions.
239 */
240 for (index = 0; index < freelist->first_available; ++index) {
241 freelist->entries[index].destructor(NULL,
242 freelist->entries[index].item);
243 }
244 }
Antoine Pitrou7056cb22013-02-17 01:04:57 +0100245 if (freelist->entries_malloced)
246 PyMem_FREE(freelist->entries);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000247 return retval;
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000248}
249
250
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000251static int
Victor Stinner6518a932017-01-17 01:29:49 +0100252vgetargs1_impl(PyObject *compat_args, PyObject **stack, Py_ssize_t nargs, const char *format,
253 va_list *p_va, int flags)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000254{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000255 char msgbuf[256];
256 int levels[32];
257 const char *fname = NULL;
258 const char *message = NULL;
259 int min = -1;
260 int max = 0;
261 int level = 0;
262 int endfmt = 0;
263 const char *formatsave = format;
Victor Stinner6518a932017-01-17 01:29:49 +0100264 Py_ssize_t i;
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200265 const char *msg;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000266 int compat = flags & FLAG_COMPAT;
Benjamin Peterson40be9e52014-02-11 10:09:27 -0500267 freelistentry_t static_entries[STATIC_FREELIST_ENTRIES];
268 freelist_t freelist;
269
Victor Stinner6518a932017-01-17 01:29:49 +0100270 assert(nargs == 0 || stack != NULL);
271
Benjamin Peterson40be9e52014-02-11 10:09:27 -0500272 freelist.entries = static_entries;
273 freelist.first_available = 0;
274 freelist.entries_malloced = 0;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000275
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000276 flags = flags & ~FLAG_COMPAT;
Tim Peters5c4d5bf2001-02-12 22:13:26 +0000277
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000278 while (endfmt == 0) {
279 int c = *format++;
280 switch (c) {
281 case '(':
282 if (level == 0)
283 max++;
284 level++;
285 if (level >= 30)
286 Py_FatalError("too many tuple nesting levels "
287 "in argument format string");
288 break;
289 case ')':
290 if (level == 0)
291 Py_FatalError("excess ')' in getargs format");
292 else
293 level--;
294 break;
295 case '\0':
296 endfmt = 1;
297 break;
298 case ':':
299 fname = format;
300 endfmt = 1;
301 break;
302 case ';':
303 message = format;
304 endfmt = 1;
305 break;
Antoine Pitrou7056cb22013-02-17 01:04:57 +0100306 case '|':
307 if (level == 0)
308 min = max;
309 break;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000310 default:
311 if (level == 0) {
Antoine Pitrou7056cb22013-02-17 01:04:57 +0100312 if (Py_ISALPHA(Py_CHARMASK(c)))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000313 if (c != 'e') /* skip encoded */
314 max++;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000315 }
316 break;
317 }
318 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000319
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000320 if (level != 0)
321 Py_FatalError(/* '(' */ "missing ')' in getargs format");
Guido van Rossum98297ee2007-11-06 21:34:58 +0000322
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000323 if (min < 0)
324 min = max;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000325
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000326 format = formatsave;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000327
Antoine Pitrou7056cb22013-02-17 01:04:57 +0100328 if (max > STATIC_FREELIST_ENTRIES) {
329 freelist.entries = PyMem_NEW(freelistentry_t, max);
330 if (freelist.entries == NULL) {
331 PyErr_NoMemory();
332 return 0;
333 }
334 freelist.entries_malloced = 1;
Benjamin Peterson7ed67272012-03-16 12:21:02 -0500335 }
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400336
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000337 if (compat) {
338 if (max == 0) {
Victor Stinner6518a932017-01-17 01:29:49 +0100339 if (compat_args == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000340 return 1;
Victor Stinner6ced7c42011-03-21 18:15:42 +0100341 PyErr_Format(PyExc_TypeError,
342 "%.200s%s takes no arguments",
343 fname==NULL ? "function" : fname,
344 fname==NULL ? "" : "()");
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400345 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000346 }
347 else if (min == 1 && max == 1) {
Victor Stinner6518a932017-01-17 01:29:49 +0100348 if (compat_args == NULL) {
Victor Stinner6ced7c42011-03-21 18:15:42 +0100349 PyErr_Format(PyExc_TypeError,
350 "%.200s%s takes at least one argument",
351 fname==NULL ? "function" : fname,
352 fname==NULL ? "" : "()");
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400353 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000354 }
Victor Stinner6518a932017-01-17 01:29:49 +0100355 msg = convertitem(compat_args, &format, p_va, flags, levels,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000356 msgbuf, sizeof(msgbuf), &freelist);
357 if (msg == NULL)
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400358 return cleanreturn(1, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000359 seterror(levels[0], msg, levels+1, fname, message);
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400360 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000361 }
362 else {
363 PyErr_SetString(PyExc_SystemError,
364 "old style getargs format uses new features");
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400365 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000366 }
367 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000368
Victor Stinner6518a932017-01-17 01:29:49 +0100369 if (nargs < min || max < nargs) {
Victor Stinner6ced7c42011-03-21 18:15:42 +0100370 if (message == NULL)
371 PyErr_Format(PyExc_TypeError,
372 "%.150s%s takes %s %d argument%s (%ld given)",
373 fname==NULL ? "function" : fname,
374 fname==NULL ? "" : "()",
375 min==max ? "exactly"
Victor Stinner6518a932017-01-17 01:29:49 +0100376 : nargs < min ? "at least" : "at most",
377 nargs < min ? min : max,
378 (nargs < min ? min : max) == 1 ? "" : "s",
379 Py_SAFE_DOWNCAST(nargs, Py_ssize_t, long));
Victor Stinner6ced7c42011-03-21 18:15:42 +0100380 else
381 PyErr_SetString(PyExc_TypeError, message);
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400382 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000383 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000384
Victor Stinner6518a932017-01-17 01:29:49 +0100385 for (i = 0; i < nargs; i++) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000386 if (*format == '|')
387 format++;
Victor Stinner6518a932017-01-17 01:29:49 +0100388 msg = convertitem(stack[i], &format, p_va,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000389 flags, levels, msgbuf,
390 sizeof(msgbuf), &freelist);
391 if (msg) {
Serhiy Storchakac4b813d2016-02-08 01:06:11 +0200392 seterror(i+1, msg, levels, fname, message);
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400393 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000394 }
395 }
Guido van Rossum231a41e1997-12-09 20:36:39 +0000396
Antoine Pitrou4de74572013-02-09 23:11:27 +0100397 if (*format != '\0' && !Py_ISALPHA(Py_CHARMASK(*format)) &&
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000398 *format != '(' &&
399 *format != '|' && *format != ':' && *format != ';') {
400 PyErr_Format(PyExc_SystemError,
401 "bad format string: %.200s", formatsave);
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400402 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000403 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000404
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400405 return cleanreturn(1, &freelist);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000406}
407
Victor Stinner6518a932017-01-17 01:29:49 +0100408static int
409vgetargs1(PyObject *args, const char *format, va_list *p_va, int flags)
410{
411 PyObject **stack;
412 Py_ssize_t nargs;
413
414 if (!(flags & FLAG_COMPAT)) {
415 assert(args != NULL);
416
417 if (!PyTuple_Check(args)) {
418 PyErr_SetString(PyExc_SystemError,
419 "new style getargs format but argument is not a tuple");
420 return 0;
421 }
422
423 stack = &PyTuple_GET_ITEM(args, 0);
424 nargs = PyTuple_GET_SIZE(args);
425 }
426 else {
427 stack = NULL;
428 nargs = 0;
429 }
430
431 return vgetargs1_impl(args, stack, nargs, format, p_va, flags);
432}
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000433
434
435static void
Victor Stinner84bb1cf2013-05-17 00:12:04 +0200436seterror(Py_ssize_t iarg, const char *msg, int *levels, const char *fname,
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000437 const char *message)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000438{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000439 char buf[512];
440 int i;
441 char *p = buf;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000442
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000443 if (PyErr_Occurred())
444 return;
445 else if (message == NULL) {
446 if (fname != NULL) {
447 PyOS_snprintf(p, sizeof(buf), "%.200s() ", fname);
448 p += strlen(p);
449 }
450 if (iarg != 0) {
451 PyOS_snprintf(p, sizeof(buf) - (p - buf),
Richard Oudkerk25296ce2013-05-18 17:35:19 +0100452 "argument %" PY_FORMAT_SIZE_T "d", iarg);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000453 i = 0;
454 p += strlen(p);
Georg Brandl142ad662013-10-14 07:01:11 +0200455 while (i < 32 && levels[i] > 0 && (int)(p-buf) < 220) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000456 PyOS_snprintf(p, sizeof(buf) - (p - buf),
457 ", item %d", levels[i]-1);
458 p += strlen(p);
459 i++;
460 }
461 }
462 else {
463 PyOS_snprintf(p, sizeof(buf) - (p - buf), "argument");
464 p += strlen(p);
465 }
466 PyOS_snprintf(p, sizeof(buf) - (p - buf), " %.256s", msg);
467 message = buf;
468 }
Serhiy Storchaka4cd63ef2016-02-08 01:22:47 +0200469 if (msg[0] == '(') {
470 PyErr_SetString(PyExc_SystemError, message);
471 }
472 else {
473 PyErr_SetString(PyExc_TypeError, message);
474 }
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000475}
476
477
478/* Convert a tuple argument.
479 On entry, *p_format points to the character _after_ the opening '('.
480 On successful exit, *p_format points to the closing ')'.
481 If successful:
482 *p_format and *p_va are updated,
483 *levels and *msgbuf are untouched,
484 and NULL is returned.
485 If the argument is invalid:
486 *p_format is unchanged,
487 *p_va is undefined,
488 *levels is a 0-terminated list of item numbers,
489 *msgbuf contains an error message, whose format is:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000490 "must be <typename1>, not <typename2>", where:
491 <typename1> is the name of the expected type, and
492 <typename2> is the name of the actual type,
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000493 and msgbuf is returned.
494*/
495
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200496static const char *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000497converttuple(PyObject *arg, const char **p_format, va_list *p_va, int flags,
Guido van Rossum98297ee2007-11-06 21:34:58 +0000498 int *levels, char *msgbuf, size_t bufsize, int toplevel,
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400499 freelist_t *freelist)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000500{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000501 int level = 0;
502 int n = 0;
503 const char *format = *p_format;
504 int i;
Victor Stinner74387f52013-11-18 01:21:12 +0100505 Py_ssize_t len;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000506
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000507 for (;;) {
508 int c = *format++;
509 if (c == '(') {
510 if (level == 0)
511 n++;
512 level++;
513 }
514 else if (c == ')') {
515 if (level == 0)
516 break;
517 level--;
518 }
519 else if (c == ':' || c == ';' || c == '\0')
520 break;
Antoine Pitrou4de74572013-02-09 23:11:27 +0100521 else if (level == 0 && Py_ISALPHA(Py_CHARMASK(c)))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000522 n++;
523 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000524
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000525 if (!PySequence_Check(arg) || PyBytes_Check(arg)) {
526 levels[0] = 0;
527 PyOS_snprintf(msgbuf, bufsize,
528 toplevel ? "expected %d arguments, not %.50s" :
529 "must be %d-item sequence, not %.50s",
530 n,
531 arg == Py_None ? "None" : arg->ob_type->tp_name);
532 return msgbuf;
533 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000534
Victor Stinner74387f52013-11-18 01:21:12 +0100535 len = PySequence_Size(arg);
536 if (len != n) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000537 levels[0] = 0;
Victor Stinner74387f52013-11-18 01:21:12 +0100538 if (toplevel) {
539 PyOS_snprintf(msgbuf, bufsize,
540 "expected %d arguments, not %" PY_FORMAT_SIZE_T "d",
541 n, len);
542 }
543 else {
544 PyOS_snprintf(msgbuf, bufsize,
545 "must be sequence of length %d, "
546 "not %" PY_FORMAT_SIZE_T "d",
547 n, len);
548 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000549 return msgbuf;
550 }
Ka-Ping Yee20579702001-01-15 22:14:16 +0000551
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000552 format = *p_format;
553 for (i = 0; i < n; i++) {
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200554 const char *msg;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000555 PyObject *item;
556 item = PySequence_GetItem(arg, i);
557 if (item == NULL) {
558 PyErr_Clear();
559 levels[0] = i+1;
560 levels[1] = 0;
561 strncpy(msgbuf, "is not retrievable", bufsize);
562 return msgbuf;
563 }
564 msg = convertitem(item, &format, p_va, flags, levels+1,
565 msgbuf, bufsize, freelist);
566 /* PySequence_GetItem calls tp->sq_item, which INCREFs */
567 Py_XDECREF(item);
568 if (msg != NULL) {
569 levels[0] = i+1;
570 return msg;
571 }
572 }
Ka-Ping Yee20579702001-01-15 22:14:16 +0000573
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000574 *p_format = format;
575 return NULL;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000576}
577
578
579/* Convert a single item. */
580
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200581static const char *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000582convertitem(PyObject *arg, const char **p_format, va_list *p_va, int flags,
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400583 int *levels, char *msgbuf, size_t bufsize, freelist_t *freelist)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000584{
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200585 const char *msg;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000586 const char *format = *p_format;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000587
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000588 if (*format == '(' /* ')' */) {
589 format++;
590 msg = converttuple(arg, &format, p_va, flags, levels, msgbuf,
591 bufsize, 0, freelist);
592 if (msg == NULL)
593 format++;
594 }
595 else {
596 msg = convertsimple(arg, &format, p_va, flags,
597 msgbuf, bufsize, freelist);
598 if (msg != NULL)
599 levels[0] = 0;
600 }
601 if (msg == NULL)
602 *p_format = format;
603 return msg;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000604}
605
606
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000607
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000608/* Format an error message generated by convertsimple(). */
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000609
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200610static const char *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000611converterr(const char *expected, PyObject *arg, char *msgbuf, size_t bufsize)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000612{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000613 assert(expected != NULL);
614 assert(arg != NULL);
Serhiy Storchakac4b813d2016-02-08 01:06:11 +0200615 if (expected[0] == '(') {
616 PyOS_snprintf(msgbuf, bufsize,
617 "%.100s", expected);
618 }
619 else {
620 PyOS_snprintf(msgbuf, bufsize,
621 "must be %.50s, not %.50s", expected,
622 arg == Py_None ? "None" : arg->ob_type->tp_name);
623 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000624 return msgbuf;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000625}
626
627#define CONV_UNICODE "(unicode conversion error)"
628
Guido van Rossum45aecf42006-03-15 04:58:47 +0000629/* Explicitly check for float arguments when integers are expected.
630 Return 1 for error, 0 if ok. */
Neil Schemenauer5042da62003-02-04 20:59:40 +0000631static int
632float_argument_error(PyObject *arg)
633{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000634 if (PyFloat_Check(arg)) {
635 PyErr_SetString(PyExc_TypeError,
636 "integer argument expected, got float" );
637 return 1;
638 }
639 else
640 return 0;
Neil Schemenauer5042da62003-02-04 20:59:40 +0000641}
642
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000643/* Convert a non-tuple argument. Return NULL if conversion went OK,
644 or a string with a message describing the failure. The message is
645 formatted as "must be <desired type>, not <actual type>".
646 When failing, an exception may or may not have been raised.
Georg Brandl6dd14612005-09-14 19:29:53 +0000647 Don't call if a tuple is expected.
648
649 When you add new format codes, please don't forget poor skipitem() below.
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000650*/
651
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200652static const char *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000653convertsimple(PyObject *arg, const char **p_format, va_list *p_va, int flags,
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400654 char *msgbuf, size_t bufsize, freelist_t *freelist)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000655{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000656 /* For # codes */
657#define FETCH_SIZE int *q=NULL;Py_ssize_t *q2=NULL;\
658 if (flags & FLAG_SIZE_T) q2=va_arg(*p_va, Py_ssize_t*); \
659 else q=va_arg(*p_va, int*);
Victor Stinnerb3c9e072011-01-04 02:07:34 +0000660#define STORE_SIZE(s) \
661 if (flags & FLAG_SIZE_T) \
662 *q2=s; \
663 else { \
664 if (INT_MAX < s) { \
665 PyErr_SetString(PyExc_OverflowError, \
666 "size does not fit in an int"); \
667 return converterr("", arg, msgbuf, bufsize); \
668 } \
Victor Stinner9550ef32013-06-05 01:18:13 +0200669 *q = (int)s; \
Victor Stinnerb3c9e072011-01-04 02:07:34 +0000670 }
Martin v. Löwis18e16552006-02-15 17:27:45 +0000671#define BUFFER_LEN ((flags & FLAG_SIZE_T) ? *q2:*q)
Victor Stinner6ab8e822011-01-04 11:16:49 +0000672#define RETURN_ERR_OCCURRED return msgbuf
Martin v. Löwis18e16552006-02-15 17:27:45 +0000673
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000674 const char *format = *p_format;
675 char c = *format++;
Serhiy Storchaka85b0f5b2016-11-20 10:16:47 +0200676 const char *sarg;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000677
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000678 switch (c) {
Guido van Rossum98297ee2007-11-06 21:34:58 +0000679
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000680 case 'b': { /* unsigned byte -- very short int */
681 char *p = va_arg(*p_va, char *);
682 long ival;
683 if (float_argument_error(arg))
Victor Stinner6ab8e822011-01-04 11:16:49 +0000684 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000685 ival = PyLong_AsLong(arg);
686 if (ival == -1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000687 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000688 else if (ival < 0) {
689 PyErr_SetString(PyExc_OverflowError,
Victor Stinner6ab8e822011-01-04 11:16:49 +0000690 "unsigned byte integer is less than minimum");
691 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000692 }
693 else if (ival > UCHAR_MAX) {
694 PyErr_SetString(PyExc_OverflowError,
Victor Stinner6ab8e822011-01-04 11:16:49 +0000695 "unsigned byte integer is greater than maximum");
696 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000697 }
698 else
699 *p = (unsigned char) ival;
700 break;
701 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000702
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000703 case 'B': {/* byte sized bitfield - both signed and unsigned
704 values allowed */
705 char *p = va_arg(*p_va, char *);
706 long ival;
707 if (float_argument_error(arg))
Victor Stinner6ab8e822011-01-04 11:16:49 +0000708 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000709 ival = PyLong_AsUnsignedLongMask(arg);
710 if (ival == -1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000711 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000712 else
713 *p = (unsigned char) ival;
714 break;
715 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000716
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000717 case 'h': {/* signed short int */
718 short *p = va_arg(*p_va, short *);
719 long ival;
720 if (float_argument_error(arg))
Victor Stinner6ab8e822011-01-04 11:16:49 +0000721 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000722 ival = PyLong_AsLong(arg);
723 if (ival == -1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000724 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000725 else if (ival < SHRT_MIN) {
726 PyErr_SetString(PyExc_OverflowError,
Victor Stinner6ab8e822011-01-04 11:16:49 +0000727 "signed short integer is less than minimum");
728 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000729 }
730 else if (ival > SHRT_MAX) {
731 PyErr_SetString(PyExc_OverflowError,
Victor Stinner6ab8e822011-01-04 11:16:49 +0000732 "signed short integer is greater than maximum");
733 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000734 }
735 else
736 *p = (short) ival;
737 break;
738 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000739
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000740 case 'H': { /* short int sized bitfield, both signed and
741 unsigned allowed */
742 unsigned short *p = va_arg(*p_va, unsigned short *);
743 long ival;
744 if (float_argument_error(arg))
Victor Stinner6ab8e822011-01-04 11:16:49 +0000745 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000746 ival = PyLong_AsUnsignedLongMask(arg);
747 if (ival == -1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000748 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000749 else
750 *p = (unsigned short) ival;
751 break;
752 }
Martin v. Löwis18e16552006-02-15 17:27:45 +0000753
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000754 case 'i': {/* signed int */
755 int *p = va_arg(*p_va, int *);
756 long ival;
757 if (float_argument_error(arg))
Victor Stinner6ab8e822011-01-04 11:16:49 +0000758 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000759 ival = PyLong_AsLong(arg);
760 if (ival == -1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000761 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000762 else if (ival > INT_MAX) {
763 PyErr_SetString(PyExc_OverflowError,
Victor Stinner6ab8e822011-01-04 11:16:49 +0000764 "signed integer is greater than maximum");
765 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000766 }
767 else if (ival < INT_MIN) {
768 PyErr_SetString(PyExc_OverflowError,
Victor Stinner6ab8e822011-01-04 11:16:49 +0000769 "signed integer is less than minimum");
770 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000771 }
772 else
773 *p = ival;
774 break;
775 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000776
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000777 case 'I': { /* int sized bitfield, both signed and
778 unsigned allowed */
779 unsigned int *p = va_arg(*p_va, unsigned int *);
780 unsigned int ival;
781 if (float_argument_error(arg))
Victor Stinner6ab8e822011-01-04 11:16:49 +0000782 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000783 ival = (unsigned int)PyLong_AsUnsignedLongMask(arg);
784 if (ival == (unsigned int)-1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000785 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000786 else
787 *p = ival;
788 break;
789 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000790
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000791 case 'n': /* Py_ssize_t */
792 {
793 PyObject *iobj;
794 Py_ssize_t *p = va_arg(*p_va, Py_ssize_t *);
795 Py_ssize_t ival = -1;
796 if (float_argument_error(arg))
Victor Stinner6ab8e822011-01-04 11:16:49 +0000797 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000798 iobj = PyNumber_Index(arg);
799 if (iobj != NULL) {
800 ival = PyLong_AsSsize_t(iobj);
801 Py_DECREF(iobj);
802 }
803 if (ival == -1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000804 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000805 *p = ival;
806 break;
807 }
808 case 'l': {/* long int */
809 long *p = va_arg(*p_va, long *);
810 long ival;
811 if (float_argument_error(arg))
Victor Stinner6ab8e822011-01-04 11:16:49 +0000812 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000813 ival = PyLong_AsLong(arg);
814 if (ival == -1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000815 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000816 else
817 *p = ival;
818 break;
819 }
Thomas Hellera4ea6032003-04-17 18:55:45 +0000820
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000821 case 'k': { /* long sized bitfield */
822 unsigned long *p = va_arg(*p_va, unsigned long *);
823 unsigned long ival;
824 if (PyLong_Check(arg))
825 ival = PyLong_AsUnsignedLongMask(arg);
826 else
Serhiy Storchakac4b813d2016-02-08 01:06:11 +0200827 return converterr("int", arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000828 *p = ival;
829 break;
830 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000831
Benjamin Petersonaf580df2016-09-06 10:46:49 -0700832 case 'L': {/* long long */
833 long long *p = va_arg( *p_va, long long * );
834 long long ival;
Mark Dickinsonc7301312010-06-10 16:05:10 +0000835 if (float_argument_error(arg))
Victor Stinner6ab8e822011-01-04 11:16:49 +0000836 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000837 ival = PyLong_AsLongLong(arg);
Benjamin Petersonaf580df2016-09-06 10:46:49 -0700838 if (ival == (long long)-1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000839 RETURN_ERR_OCCURRED;
Mark Dickinsonc7301312010-06-10 16:05:10 +0000840 else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000841 *p = ival;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000842 break;
843 }
Thomas Hellera4ea6032003-04-17 18:55:45 +0000844
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000845 case 'K': { /* long long sized bitfield */
Benjamin Petersonaf580df2016-09-06 10:46:49 -0700846 unsigned long long *p = va_arg(*p_va, unsigned long long *);
847 unsigned long long ival;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000848 if (PyLong_Check(arg))
849 ival = PyLong_AsUnsignedLongLongMask(arg);
850 else
Serhiy Storchakac4b813d2016-02-08 01:06:11 +0200851 return converterr("int", arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000852 *p = ival;
853 break;
854 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000855
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000856 case 'f': {/* float */
857 float *p = va_arg(*p_va, float *);
858 double dval = PyFloat_AsDouble(arg);
859 if (PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000860 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000861 else
862 *p = (float) dval;
863 break;
864 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000865
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000866 case 'd': {/* double */
867 double *p = va_arg(*p_va, double *);
868 double dval = PyFloat_AsDouble(arg);
869 if (PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000870 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000871 else
872 *p = dval;
873 break;
874 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000875
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000876 case 'D': {/* complex double */
877 Py_complex *p = va_arg(*p_va, Py_complex *);
878 Py_complex cval;
879 cval = PyComplex_AsCComplex(arg);
880 if (PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000881 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000882 else
883 *p = cval;
884 break;
885 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000886
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000887 case 'c': {/* char */
888 char *p = va_arg(*p_va, char *);
889 if (PyBytes_Check(arg) && PyBytes_Size(arg) == 1)
890 *p = PyBytes_AS_STRING(arg)[0];
Eli Bendersky906b88f2011-07-29 07:05:08 +0300891 else if (PyByteArray_Check(arg) && PyByteArray_Size(arg) == 1)
892 *p = PyByteArray_AS_STRING(arg)[0];
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000893 else
894 return converterr("a byte string of length 1", arg, msgbuf, bufsize);
895 break;
896 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000897
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000898 case 'C': {/* unicode char */
899 int *p = va_arg(*p_va, int *);
Victor Stinnere1335c72011-10-04 20:53:03 +0200900 int kind;
901 void *data;
902
903 if (!PyUnicode_Check(arg))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000904 return converterr("a unicode character", arg, msgbuf, bufsize);
Victor Stinnere1335c72011-10-04 20:53:03 +0200905
906 if (PyUnicode_READY(arg))
907 RETURN_ERR_OCCURRED;
908
909 if (PyUnicode_GET_LENGTH(arg) != 1)
910 return converterr("a unicode character", arg, msgbuf, bufsize);
911
912 kind = PyUnicode_KIND(arg);
913 data = PyUnicode_DATA(arg);
914 *p = PyUnicode_READ(kind, data, 0);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000915 break;
916 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000917
Larry Hastingsfaf91e72012-05-05 16:54:29 -0700918 case 'p': {/* boolean *p*redicate */
919 int *p = va_arg(*p_va, int *);
920 int val = PyObject_IsTrue(arg);
921 if (val > 0)
922 *p = 1;
923 else if (val == 0)
924 *p = 0;
925 else
926 RETURN_ERR_OCCURRED;
927 break;
928 }
929
Victor Stinner3dcb5ac2010-06-08 22:54:19 +0000930 /* XXX WAAAAH! 's', 'y', 'z', 'u', 'Z', 'e', 'w' codes all
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000931 need to be cleaned up! */
Guido van Rossum98297ee2007-11-06 21:34:58 +0000932
Serhiy Storchakab757c832014-12-05 22:25:22 +0200933 case 'y': {/* any bytes-like object */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000934 void **p = (void **)va_arg(*p_va, char **);
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200935 const char *buf;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000936 Py_ssize_t count;
937 if (*format == '*') {
938 if (getbuffer(arg, (Py_buffer*)p, &buf) < 0)
939 return converterr(buf, arg, msgbuf, bufsize);
940 format++;
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400941 if (addcleanup(p, freelist, cleanup_buffer)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000942 return converterr(
943 "(cleanup problem)",
944 arg, msgbuf, bufsize);
945 }
946 break;
947 }
Serhiy Storchaka85b0f5b2016-11-20 10:16:47 +0200948 count = convertbuffer(arg, (const void **)p, &buf);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000949 if (count < 0)
950 return converterr(buf, arg, msgbuf, bufsize);
Victor Stinner06e49dd2010-06-13 18:21:50 +0000951 if (*format == '#') {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000952 FETCH_SIZE;
953 STORE_SIZE(count);
954 format++;
Victor Stinner06e49dd2010-06-13 18:21:50 +0000955 } else {
Serhiy Storchakad8a14472014-09-06 20:07:17 +0300956 if (strlen(*p) != (size_t)count) {
957 PyErr_SetString(PyExc_ValueError, "embedded null byte");
958 RETURN_ERR_OCCURRED;
959 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000960 }
961 break;
962 }
Walter Dörwald612344f2007-05-04 19:28:21 +0000963
Serhiy Storchakab757c832014-12-05 22:25:22 +0200964 case 's': /* text string or bytes-like object */
965 case 'z': /* text string, bytes-like object or None */
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000966 {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000967 if (*format == '*') {
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000968 /* "s*" or "z*" */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000969 Py_buffer *p = (Py_buffer *)va_arg(*p_va, Py_buffer *);
Martin v. Löwis423be952008-08-13 15:53:07 +0000970
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000971 if (c == 'z' && arg == Py_None)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000972 PyBuffer_FillInfo(p, NULL, NULL, 0, 1, 0);
973 else if (PyUnicode_Check(arg)) {
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200974 Py_ssize_t len;
975 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 Storchaka85b0f5b2016-11-20 10:16:47 +0200979 PyBuffer_FillInfo(p, arg, (void *)sarg, len, 1, 0);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000980 }
Serhiy Storchakab757c832014-12-05 22:25:22 +0200981 else { /* any bytes-like object */
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200982 const char *buf;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000983 if (getbuffer(arg, p, &buf) < 0)
984 return converterr(buf, arg, msgbuf, bufsize);
985 }
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400986 if (addcleanup(p, freelist, cleanup_buffer)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000987 return converterr(
988 "(cleanup problem)",
989 arg, msgbuf, bufsize);
990 }
991 format++;
Serhiy Storchakab757c832014-12-05 22:25:22 +0200992 } else if (*format == '#') { /* a string or read-only bytes-like object */
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000993 /* "s#" or "z#" */
Serhiy Storchaka85b0f5b2016-11-20 10:16:47 +0200994 const void **p = (const void **)va_arg(*p_va, const char **);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000995 FETCH_SIZE;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000996
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000997 if (c == 'z' && arg == Py_None) {
998 *p = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000999 STORE_SIZE(0);
1000 }
1001 else if (PyUnicode_Check(arg)) {
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001002 Py_ssize_t len;
1003 sarg = PyUnicode_AsUTF8AndSize(arg, &len);
1004 if (sarg == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001005 return converterr(CONV_UNICODE,
1006 arg, msgbuf, bufsize);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001007 *p = sarg;
1008 STORE_SIZE(len);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001009 }
Serhiy Storchakab757c832014-12-05 22:25:22 +02001010 else { /* read-only bytes-like object */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001011 /* XXX Really? */
Serhiy Storchakaef1585e2015-12-25 20:01:53 +02001012 const char *buf;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001013 Py_ssize_t count = convertbuffer(arg, p, &buf);
1014 if (count < 0)
1015 return converterr(buf, arg, msgbuf, bufsize);
1016 STORE_SIZE(count);
1017 }
1018 format++;
1019 } else {
Victor Stinner3c9e6e92010-06-24 22:31:12 +00001020 /* "s" or "z" */
Serhiy Storchaka85b0f5b2016-11-20 10:16:47 +02001021 const char **p = va_arg(*p_va, const char **);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001022 Py_ssize_t len;
1023 sarg = NULL;
Guido van Rossum98297ee2007-11-06 21:34:58 +00001024
Victor Stinner3c9e6e92010-06-24 22:31:12 +00001025 if (c == 'z' && arg == Py_None)
1026 *p = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001027 else if (PyUnicode_Check(arg)) {
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001028 sarg = PyUnicode_AsUTF8AndSize(arg, &len);
1029 if (sarg == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001030 return converterr(CONV_UNICODE,
1031 arg, msgbuf, bufsize);
Serhiy Storchakad8a14472014-09-06 20:07:17 +03001032 if (strlen(sarg) != (size_t)len) {
1033 PyErr_SetString(PyExc_ValueError, "embedded null character");
1034 RETURN_ERR_OCCURRED;
1035 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001036 *p = sarg;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001037 }
1038 else
Victor Stinner3c9e6e92010-06-24 22:31:12 +00001039 return converterr(c == 'z' ? "str or None" : "str",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001040 arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001041 }
1042 break;
1043 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001044
Victor Stinner3c9e6e92010-06-24 22:31:12 +00001045 case 'u': /* raw unicode buffer (Py_UNICODE *) */
1046 case 'Z': /* raw unicode buffer or None */
1047 {
Brett Cannonb94767f2011-02-22 20:15:44 +00001048 Py_UNICODE **p = va_arg(*p_va, Py_UNICODE **);
1049
Serhiy Storchakab757c832014-12-05 22:25:22 +02001050 if (*format == '#') {
Serhiy Storchakad6e53da2015-04-19 21:11:30 +03001051 /* "u#" or "Z#" */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001052 FETCH_SIZE;
Travis E. Oliphantddacf962007-10-13 21:03:27 +00001053
Victor Stinner3c9e6e92010-06-24 22:31:12 +00001054 if (c == 'Z' && arg == Py_None) {
1055 *p = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001056 STORE_SIZE(0);
1057 }
1058 else if (PyUnicode_Check(arg)) {
Victor Stinnerbeac78b2011-10-11 21:55:01 +02001059 Py_ssize_t len;
1060 *p = PyUnicode_AsUnicodeAndSize(arg, &len);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001061 if (*p == NULL)
1062 RETURN_ERR_OCCURRED;
Victor Stinnerbeac78b2011-10-11 21:55:01 +02001063 STORE_SIZE(len);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001064 }
Victor Stinner5216e6d2010-06-08 21:45:51 +00001065 else
Serhiy Storchakad6e53da2015-04-19 21:11:30 +03001066 return converterr(c == 'Z' ? "str or None" : "str",
1067 arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001068 format++;
1069 } else {
Serhiy Storchakad6e53da2015-04-19 21:11:30 +03001070 /* "u" or "Z" */
Victor Stinner3c9e6e92010-06-24 22:31:12 +00001071 if (c == 'Z' && arg == Py_None)
1072 *p = NULL;
Victor Stinner06e49dd2010-06-13 18:21:50 +00001073 else if (PyUnicode_Check(arg)) {
Victor Stinnerbeac78b2011-10-11 21:55:01 +02001074 Py_ssize_t len;
1075 *p = PyUnicode_AsUnicodeAndSize(arg, &len);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001076 if (*p == NULL)
1077 RETURN_ERR_OCCURRED;
Serhiy Storchaka460bd0d2016-11-20 12:16:46 +02001078 if (wcslen(*p) != (size_t)len) {
Serhiy Storchakad8a14472014-09-06 20:07:17 +03001079 PyErr_SetString(PyExc_ValueError, "embedded null character");
1080 RETURN_ERR_OCCURRED;
1081 }
Victor Stinner06e49dd2010-06-13 18:21:50 +00001082 } else
Victor Stinner3c9e6e92010-06-24 22:31:12 +00001083 return converterr(c == 'Z' ? "str or None" : "str",
1084 arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001085 }
1086 break;
1087 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001088
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001089 case 'e': {/* encoded string */
1090 char **buffer;
1091 const char *encoding;
1092 PyObject *s;
1093 int recode_strings;
1094 Py_ssize_t size;
1095 const char *ptr;
Jeremy Hylton4819e972001-10-11 14:40:37 +00001096
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001097 /* Get 'e' parameter: the encoding name */
1098 encoding = (const char *)va_arg(*p_va, const char *);
1099 if (encoding == NULL)
1100 encoding = PyUnicode_GetDefaultEncoding();
Martin v. Löwis423be952008-08-13 15:53:07 +00001101
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001102 /* Get output buffer parameter:
1103 's' (recode all objects via Unicode) or
1104 't' (only recode non-string objects)
1105 */
1106 if (*format == 's')
1107 recode_strings = 1;
1108 else if (*format == 't')
1109 recode_strings = 0;
1110 else
1111 return converterr(
1112 "(unknown parser marker combination)",
1113 arg, msgbuf, bufsize);
1114 buffer = (char **)va_arg(*p_va, char **);
1115 format++;
1116 if (buffer == NULL)
1117 return converterr("(buffer is NULL)",
1118 arg, msgbuf, bufsize);
Benjamin Peterson9edd2bd2008-08-27 00:31:37 +00001119
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001120 /* Encode object */
1121 if (!recode_strings &&
1122 (PyBytes_Check(arg) || PyByteArray_Check(arg))) {
1123 s = arg;
1124 Py_INCREF(s);
Serhiy Storchaka460bd0d2016-11-20 12:16:46 +02001125 if (PyBytes_Check(arg)) {
1126 size = PyBytes_GET_SIZE(s);
1127 ptr = PyBytes_AS_STRING(s);
1128 }
1129 else {
1130 size = PyByteArray_GET_SIZE(s);
1131 ptr = PyByteArray_AS_STRING(s);
1132 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001133 }
Serhiy Storchaka21a663e2016-04-13 15:37:23 +03001134 else if (PyUnicode_Check(arg)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001135 /* Encode object; use default error handling */
Serhiy Storchaka21a663e2016-04-13 15:37:23 +03001136 s = PyUnicode_AsEncodedString(arg,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001137 encoding,
1138 NULL);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001139 if (s == NULL)
1140 return converterr("(encoding failed)",
1141 arg, msgbuf, bufsize);
Serhiy Storchaka21a663e2016-04-13 15:37:23 +03001142 assert(PyBytes_Check(s));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001143 size = PyBytes_GET_SIZE(s);
1144 ptr = PyBytes_AS_STRING(s);
1145 if (ptr == NULL)
1146 ptr = "";
1147 }
Serhiy Storchaka21a663e2016-04-13 15:37:23 +03001148 else {
1149 return converterr(
1150 recode_strings ? "str" : "str, bytes or bytearray",
1151 arg, msgbuf, bufsize);
1152 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001153
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001154 /* Write output; output is guaranteed to be 0-terminated */
1155 if (*format == '#') {
1156 /* Using buffer length parameter '#':
1157
1158 - if *buffer is NULL, a new buffer of the
1159 needed size is allocated and the data
1160 copied into it; *buffer is updated to point
1161 to the new buffer; the caller is
1162 responsible for PyMem_Free()ing it after
1163 usage
1164
1165 - if *buffer is not NULL, the data is
1166 copied to *buffer; *buffer_len has to be
1167 set to the size of the buffer on input;
1168 buffer overflow is signalled with an error;
1169 buffer has to provide enough room for the
1170 encoded string plus the trailing 0-byte
1171
1172 - in both cases, *buffer_len is updated to
1173 the size of the buffer /excluding/ the
1174 trailing 0-byte
1175
1176 */
1177 FETCH_SIZE;
1178
1179 format++;
1180 if (q == NULL && q2 == NULL) {
1181 Py_DECREF(s);
1182 return converterr(
1183 "(buffer_len is NULL)",
1184 arg, msgbuf, bufsize);
1185 }
1186 if (*buffer == NULL) {
1187 *buffer = PyMem_NEW(char, size + 1);
1188 if (*buffer == NULL) {
1189 Py_DECREF(s);
Victor Stinner2872e5b2010-06-06 20:38:02 +00001190 PyErr_NoMemory();
Victor Stinner6ab8e822011-01-04 11:16:49 +00001191 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001192 }
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001193 if (addcleanup(*buffer, freelist, cleanup_ptr)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001194 Py_DECREF(s);
1195 return converterr(
1196 "(cleanup problem)",
1197 arg, msgbuf, bufsize);
1198 }
1199 } else {
1200 if (size + 1 > BUFFER_LEN) {
1201 Py_DECREF(s);
Serhiy Storchaka4cd63ef2016-02-08 01:22:47 +02001202 PyErr_Format(PyExc_ValueError,
Serhiy Storchakac4b813d2016-02-08 01:06:11 +02001203 "encoded string too long "
1204 "(%zd, maximum length %zd)",
1205 (Py_ssize_t)size, (Py_ssize_t)(BUFFER_LEN-1));
1206 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001207 }
1208 }
1209 memcpy(*buffer, ptr, size+1);
1210 STORE_SIZE(size);
1211 } else {
1212 /* Using a 0-terminated buffer:
1213
1214 - the encoded string has to be 0-terminated
1215 for this variant to work; if it is not, an
1216 error raised
1217
1218 - a new buffer of the needed size is
1219 allocated and the data copied into it;
1220 *buffer is updated to point to the new
1221 buffer; the caller is responsible for
1222 PyMem_Free()ing it after usage
1223
1224 */
1225 if ((Py_ssize_t)strlen(ptr) != size) {
1226 Py_DECREF(s);
1227 return converterr(
Serhiy Storchakac4b813d2016-02-08 01:06:11 +02001228 "encoded string without null bytes",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001229 arg, msgbuf, bufsize);
1230 }
1231 *buffer = PyMem_NEW(char, size + 1);
1232 if (*buffer == NULL) {
1233 Py_DECREF(s);
Victor Stinner2872e5b2010-06-06 20:38:02 +00001234 PyErr_NoMemory();
Victor Stinner6ab8e822011-01-04 11:16:49 +00001235 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001236 }
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001237 if (addcleanup(*buffer, freelist, cleanup_ptr)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001238 Py_DECREF(s);
1239 return converterr("(cleanup problem)",
1240 arg, msgbuf, bufsize);
1241 }
1242 memcpy(*buffer, ptr, size+1);
1243 }
1244 Py_DECREF(s);
1245 break;
1246 }
1247
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001248 case 'S': { /* PyBytes object */
1249 PyObject **p = va_arg(*p_va, PyObject **);
1250 if (PyBytes_Check(arg))
1251 *p = arg;
1252 else
1253 return converterr("bytes", arg, msgbuf, bufsize);
1254 break;
1255 }
1256
1257 case 'Y': { /* PyByteArray object */
1258 PyObject **p = va_arg(*p_va, PyObject **);
1259 if (PyByteArray_Check(arg))
1260 *p = arg;
1261 else
Victor Stinner5216e6d2010-06-08 21:45:51 +00001262 return converterr("bytearray", arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001263 break;
1264 }
1265
1266 case 'U': { /* PyUnicode object */
1267 PyObject **p = va_arg(*p_va, PyObject **);
Victor Stinnera1b0c9f2012-05-29 12:30:29 +02001268 if (PyUnicode_Check(arg)) {
1269 if (PyUnicode_READY(arg) == -1)
1270 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001271 *p = arg;
Victor Stinnera1b0c9f2012-05-29 12:30:29 +02001272 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001273 else
1274 return converterr("str", arg, msgbuf, bufsize);
1275 break;
1276 }
1277
1278 case 'O': { /* object */
1279 PyTypeObject *type;
1280 PyObject **p;
1281 if (*format == '!') {
1282 type = va_arg(*p_va, PyTypeObject*);
1283 p = va_arg(*p_va, PyObject **);
1284 format++;
1285 if (PyType_IsSubtype(arg->ob_type, type))
1286 *p = arg;
1287 else
1288 return converterr(type->tp_name, arg, msgbuf, bufsize);
1289
1290 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001291 else if (*format == '&') {
1292 typedef int (*converter)(PyObject *, void *);
1293 converter convert = va_arg(*p_va, converter);
1294 void *addr = va_arg(*p_va, void *);
1295 int res;
1296 format++;
1297 if (! (res = (*convert)(arg, addr)))
1298 return converterr("(unspecified)",
1299 arg, msgbuf, bufsize);
1300 if (res == Py_CLEANUP_SUPPORTED &&
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001301 addcleanup(addr, freelist, convert) == -1)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001302 return converterr("(cleanup problem)",
1303 arg, msgbuf, bufsize);
1304 }
1305 else {
1306 p = va_arg(*p_va, PyObject **);
1307 *p = arg;
1308 }
1309 break;
1310 }
1311
1312
Victor Stinner25e8ec42010-06-25 00:02:38 +00001313 case 'w': { /* "w*": memory buffer, read-write access */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001314 void **p = va_arg(*p_va, void **);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001315
Victor Stinner25e8ec42010-06-25 00:02:38 +00001316 if (*format != '*')
1317 return converterr(
Serhiy Storchakac4b813d2016-02-08 01:06:11 +02001318 "(invalid use of 'w' format character)",
Victor Stinner25e8ec42010-06-25 00:02:38 +00001319 arg, msgbuf, bufsize);
1320 format++;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001321
Victor Stinner25e8ec42010-06-25 00:02:38 +00001322 /* Caller is interested in Py_buffer, and the object
1323 supports it directly. */
1324 if (PyObject_GetBuffer(arg, (Py_buffer*)p, PyBUF_WRITABLE) < 0) {
1325 PyErr_Clear();
R David Murray861470c2014-10-05 11:47:01 -04001326 return converterr("read-write bytes-like object",
1327 arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001328 }
Victor Stinner8182b712010-07-28 00:40:58 +00001329 if (!PyBuffer_IsContiguous((Py_buffer*)p, 'C')) {
1330 PyBuffer_Release((Py_buffer*)p);
1331 return converterr("contiguous buffer", arg, msgbuf, bufsize);
1332 }
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001333 if (addcleanup(p, freelist, cleanup_buffer)) {
Victor Stinner25e8ec42010-06-25 00:02:38 +00001334 return converterr(
1335 "(cleanup problem)",
1336 arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001337 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001338 break;
1339 }
1340
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001341 default:
Serhiy Storchakac4b813d2016-02-08 01:06:11 +02001342 return converterr("(impossible<bad format char>)", arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001343
1344 }
1345
1346 *p_format = format;
1347 return NULL;
Victor Stinner6ab8e822011-01-04 11:16:49 +00001348
1349#undef FETCH_SIZE
1350#undef STORE_SIZE
1351#undef BUFFER_LEN
1352#undef RETURN_ERR_OCCURRED
Guido van Rossumfe3f1a21994-09-29 09:42:55 +00001353}
Guido van Rossumaa354651996-08-19 19:32:04 +00001354
Martin v. Löwis18e16552006-02-15 17:27:45 +00001355static Py_ssize_t
Serhiy Storchaka85b0f5b2016-11-20 10:16:47 +02001356convertbuffer(PyObject *arg, const void **p, const char **errmsg)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001357{
Victor Stinner5cb62392010-06-06 20:27:51 +00001358 PyBufferProcs *pb = Py_TYPE(arg)->tp_as_buffer;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001359 Py_ssize_t count;
1360 Py_buffer view;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001361
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001362 *errmsg = NULL;
1363 *p = NULL;
Victor Stinner8182b712010-07-28 00:40:58 +00001364 if (pb != NULL && pb->bf_releasebuffer != NULL) {
R David Murray861470c2014-10-05 11:47:01 -04001365 *errmsg = "read-only bytes-like object";
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001366 return -1;
1367 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001368
Victor Stinner8182b712010-07-28 00:40:58 +00001369 if (getbuffer(arg, &view, errmsg) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001370 return -1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001371 count = view.len;
1372 *p = view.buf;
1373 PyBuffer_Release(&view);
1374 return count;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001375}
Guido van Rossumaa354651996-08-19 19:32:04 +00001376
Martin v. Löwis423be952008-08-13 15:53:07 +00001377static int
Serhiy Storchakaef1585e2015-12-25 20:01:53 +02001378getbuffer(PyObject *arg, Py_buffer *view, const char **errmsg)
Martin v. Löwis423be952008-08-13 15:53:07 +00001379{
Victor Stinner8182b712010-07-28 00:40:58 +00001380 if (PyObject_GetBuffer(arg, view, PyBUF_SIMPLE) != 0) {
R David Murray861470c2014-10-05 11:47:01 -04001381 *errmsg = "bytes-like object";
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001382 return -1;
1383 }
Victor Stinner5cb62392010-06-06 20:27:51 +00001384 if (!PyBuffer_IsContiguous(view, 'C')) {
Victor Stinner21e09482010-06-24 22:57:10 +00001385 PyBuffer_Release(view);
Victor Stinner5cb62392010-06-06 20:27:51 +00001386 *errmsg = "contiguous buffer";
1387 return -1;
1388 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001389 return 0;
Martin v. Löwis423be952008-08-13 15:53:07 +00001390}
1391
Guido van Rossumaa354651996-08-19 19:32:04 +00001392/* Support for keyword arguments donated by
1393 Geoff Philbrick <philbric@delphi.hks.com> */
1394
Tim Petersf8cd3e82001-10-27 04:26:57 +00001395/* Return false (0) for error, else true. */
Fred Drake563dfc22001-10-23 14:41:08 +00001396int
1397PyArg_ParseTupleAndKeywords(PyObject *args,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001398 PyObject *keywords,
1399 const char *format,
1400 char **kwlist, ...)
Guido van Rossumaa354651996-08-19 19:32:04 +00001401{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001402 int retval;
1403 va_list va;
Tim Peters45772cd2001-10-27 03:58:40 +00001404
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001405 if ((args == NULL || !PyTuple_Check(args)) ||
1406 (keywords != NULL && !PyDict_Check(keywords)) ||
1407 format == NULL ||
1408 kwlist == NULL)
1409 {
1410 PyErr_BadInternalCall();
1411 return 0;
1412 }
Tim Peters45772cd2001-10-27 03:58:40 +00001413
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001414 va_start(va, kwlist);
1415 retval = vgetargskeywords(args, keywords, format, kwlist, &va, 0);
1416 va_end(va);
1417 return retval;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001418}
1419
1420int
1421_PyArg_ParseTupleAndKeywords_SizeT(PyObject *args,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001422 PyObject *keywords,
1423 const char *format,
1424 char **kwlist, ...)
Martin v. Löwis18e16552006-02-15 17:27:45 +00001425{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001426 int retval;
1427 va_list va;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001428
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001429 if ((args == NULL || !PyTuple_Check(args)) ||
1430 (keywords != NULL && !PyDict_Check(keywords)) ||
1431 format == NULL ||
1432 kwlist == NULL)
1433 {
1434 PyErr_BadInternalCall();
1435 return 0;
1436 }
Martin v. Löwis18e16552006-02-15 17:27:45 +00001437
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001438 va_start(va, kwlist);
1439 retval = vgetargskeywords(args, keywords, format,
1440 kwlist, &va, FLAG_SIZE_T);
1441 va_end(va);
1442 return retval;
Guido van Rossumaa354651996-08-19 19:32:04 +00001443}
1444
1445
Brett Cannon711e7d92004-07-10 22:20:32 +00001446int
1447PyArg_VaParseTupleAndKeywords(PyObject *args,
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001448 PyObject *keywords,
Guido van Rossum98297ee2007-11-06 21:34:58 +00001449 const char *format,
Martin v. Löwis15e62742006-02-27 16:46:16 +00001450 char **kwlist, va_list va)
Brett Cannon711e7d92004-07-10 22:20:32 +00001451{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001452 int retval;
1453 va_list lva;
Brett Cannon711e7d92004-07-10 22:20:32 +00001454
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001455 if ((args == NULL || !PyTuple_Check(args)) ||
1456 (keywords != NULL && !PyDict_Check(keywords)) ||
1457 format == NULL ||
1458 kwlist == NULL)
1459 {
1460 PyErr_BadInternalCall();
1461 return 0;
1462 }
Brett Cannon711e7d92004-07-10 22:20:32 +00001463
Benjamin Peterson0c212142016-09-20 20:39:33 -07001464 va_copy(lva, va);
Brett Cannon711e7d92004-07-10 22:20:32 +00001465
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001466 retval = vgetargskeywords(args, keywords, format, kwlist, &lva, 0);
Christian Heimes2f2fee12016-09-21 11:37:27 +02001467 va_end(lva);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001468 return retval;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001469}
1470
1471int
1472_PyArg_VaParseTupleAndKeywords_SizeT(PyObject *args,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001473 PyObject *keywords,
1474 const char *format,
1475 char **kwlist, va_list va)
Martin v. Löwis18e16552006-02-15 17:27:45 +00001476{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001477 int retval;
1478 va_list lva;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001479
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001480 if ((args == NULL || !PyTuple_Check(args)) ||
1481 (keywords != NULL && !PyDict_Check(keywords)) ||
1482 format == NULL ||
1483 kwlist == NULL)
1484 {
1485 PyErr_BadInternalCall();
1486 return 0;
1487 }
Martin v. Löwis18e16552006-02-15 17:27:45 +00001488
Benjamin Peterson0c212142016-09-20 20:39:33 -07001489 va_copy(lva, va);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001490
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001491 retval = vgetargskeywords(args, keywords, format,
1492 kwlist, &lva, FLAG_SIZE_T);
Christian Heimes2f2fee12016-09-21 11:37:27 +02001493 va_end(lva);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001494 return retval;
Brett Cannon711e7d92004-07-10 22:20:32 +00001495}
1496
Benjamin Petersonfb886362010-04-24 18:21:17 +00001497int
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001498_PyArg_ParseTupleAndKeywordsFast(PyObject *args, PyObject *keywords,
1499 struct _PyArg_Parser *parser, ...)
1500{
1501 int retval;
1502 va_list va;
1503
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001504 va_start(va, parser);
1505 retval = vgetargskeywordsfast(args, keywords, parser, &va, 0);
1506 va_end(va);
1507 return retval;
1508}
1509
1510int
1511_PyArg_ParseTupleAndKeywordsFast_SizeT(PyObject *args, PyObject *keywords,
1512 struct _PyArg_Parser *parser, ...)
1513{
1514 int retval;
1515 va_list va;
1516
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001517 va_start(va, parser);
1518 retval = vgetargskeywordsfast(args, keywords, parser, &va, FLAG_SIZE_T);
1519 va_end(va);
1520 return retval;
1521}
1522
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07001523int
Victor Stinner3e1fad62017-01-17 01:29:01 +01001524_PyArg_ParseStackAndKeywords(PyObject **args, Py_ssize_t nargs, PyObject *kwnames,
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07001525 struct _PyArg_Parser *parser, ...)
1526{
1527 int retval;
1528 va_list va;
1529
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07001530 va_start(va, parser);
1531 retval = vgetargskeywordsfast_impl(args, nargs, NULL, kwnames, parser, &va, 0);
1532 va_end(va);
1533 return retval;
1534}
1535
1536int
Victor Stinner3e1fad62017-01-17 01:29:01 +01001537_PyArg_ParseStackAndKeywords_SizeT(PyObject **args, Py_ssize_t nargs, PyObject *kwnames,
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07001538 struct _PyArg_Parser *parser, ...)
1539{
1540 int retval;
1541 va_list va;
1542
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07001543 va_start(va, parser);
1544 retval = vgetargskeywordsfast_impl(args, nargs, NULL, kwnames, parser, &va, FLAG_SIZE_T);
1545 va_end(va);
1546 return retval;
1547}
1548
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001549
1550int
1551_PyArg_VaParseTupleAndKeywordsFast(PyObject *args, PyObject *keywords,
1552 struct _PyArg_Parser *parser, va_list va)
1553{
1554 int retval;
1555 va_list lva;
1556
Benjamin Peterson0c212142016-09-20 20:39:33 -07001557 va_copy(lva, va);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001558
1559 retval = vgetargskeywordsfast(args, keywords, parser, &lva, 0);
Christian Heimes2f2fee12016-09-21 11:37:27 +02001560 va_end(lva);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001561 return retval;
1562}
1563
1564int
1565_PyArg_VaParseTupleAndKeywordsFast_SizeT(PyObject *args, PyObject *keywords,
1566 struct _PyArg_Parser *parser, va_list va)
1567{
1568 int retval;
1569 va_list lva;
1570
Benjamin Peterson0c212142016-09-20 20:39:33 -07001571 va_copy(lva, va);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001572
1573 retval = vgetargskeywordsfast(args, keywords, parser, &lva, FLAG_SIZE_T);
Christian Heimes2f2fee12016-09-21 11:37:27 +02001574 va_end(lva);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001575 return retval;
1576}
1577
1578int
Benjamin Petersonfb886362010-04-24 18:21:17 +00001579PyArg_ValidateKeywordArguments(PyObject *kwargs)
1580{
Benjamin Petersonf6096542010-11-17 22:33:12 +00001581 if (!PyDict_Check(kwargs)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001582 PyErr_BadInternalCall();
1583 return 0;
1584 }
1585 if (!_PyDict_HasOnlyStringKeys(kwargs)) {
1586 PyErr_SetString(PyExc_TypeError,
Michael Seifert64c8f702017-04-09 09:47:12 +02001587 "keywords must be strings");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001588 return 0;
1589 }
1590 return 1;
Benjamin Petersonfb886362010-04-24 18:21:17 +00001591}
1592
Christian Heimes380f7f22008-02-28 11:19:05 +00001593#define IS_END_OF_FORMAT(c) (c == '\0' || c == ';' || c == ':')
Brett Cannon711e7d92004-07-10 22:20:32 +00001594
Guido van Rossumaa354651996-08-19 19:32:04 +00001595static int
Victor Stinnerc0083fc2017-01-17 00:37:42 +01001596vgetargskeywords(PyObject *args, PyObject *kwargs, const char *format,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001597 char **kwlist, va_list *p_va, int flags)
Guido van Rossumaa354651996-08-19 19:32:04 +00001598{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001599 char msgbuf[512];
1600 int levels[32];
Serhiy Storchaka17414412017-01-17 10:07:25 +02001601 const char *fname, *msg, *custom_msg;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001602 int min = INT_MAX;
Larry Hastings83a9f482012-03-20 20:06:16 +00001603 int max = INT_MAX;
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001604 int i, pos, len;
1605 int skip = 0;
Victor Stinnerc0083fc2017-01-17 00:37:42 +01001606 Py_ssize_t nargs, nkwargs;
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001607 PyObject *current_arg;
Antoine Pitrou7056cb22013-02-17 01:04:57 +01001608 freelistentry_t static_entries[STATIC_FREELIST_ENTRIES];
Benjamin Peterson40be9e52014-02-11 10:09:27 -05001609 freelist_t freelist;
1610
1611 freelist.entries = static_entries;
1612 freelist.first_available = 0;
1613 freelist.entries_malloced = 0;
Tim Petersf4331c12001-10-27 00:17:34 +00001614
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001615 assert(args != NULL && PyTuple_Check(args));
Victor Stinnerc0083fc2017-01-17 00:37:42 +01001616 assert(kwargs == NULL || PyDict_Check(kwargs));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001617 assert(format != NULL);
1618 assert(kwlist != NULL);
1619 assert(p_va != NULL);
Tim Peters45772cd2001-10-27 03:58:40 +00001620
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001621 /* grab the function name or custom error msg first (mutually exclusive) */
1622 fname = strchr(format, ':');
1623 if (fname) {
1624 fname++;
1625 custom_msg = NULL;
1626 }
1627 else {
1628 custom_msg = strchr(format,';');
1629 if (custom_msg)
1630 custom_msg++;
1631 }
Christian Heimes380f7f22008-02-28 11:19:05 +00001632
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001633 /* scan kwlist and count the number of positional-only parameters */
1634 for (pos = 0; kwlist[pos] && !*kwlist[pos]; pos++) {
1635 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001636 /* scan kwlist and get greatest possible nbr of args */
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001637 for (len = pos; kwlist[len]; len++) {
1638 if (!*kwlist[len]) {
1639 PyErr_SetString(PyExc_SystemError,
1640 "Empty keyword parameter name");
1641 return cleanreturn(0, &freelist);
1642 }
1643 }
Tim Petersf8cd3e82001-10-27 04:26:57 +00001644
Antoine Pitrou7056cb22013-02-17 01:04:57 +01001645 if (len > STATIC_FREELIST_ENTRIES) {
1646 freelist.entries = PyMem_NEW(freelistentry_t, len);
1647 if (freelist.entries == NULL) {
1648 PyErr_NoMemory();
1649 return 0;
1650 }
1651 freelist.entries_malloced = 1;
Benjamin Peterson7ed67272012-03-16 12:21:02 -05001652 }
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001653
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001654 nargs = PyTuple_GET_SIZE(args);
Victor Stinnerc0083fc2017-01-17 00:37:42 +01001655 nkwargs = (kwargs == NULL) ? 0 : PyDict_GET_SIZE(kwargs);
1656 if (nargs + nkwargs > len) {
Victor Stinner6ced7c42011-03-21 18:15:42 +01001657 PyErr_Format(PyExc_TypeError,
Michael Seifert64c8f702017-04-09 09:47:12 +02001658 "%.200s%s takes at most %d argument%s (%zd given)",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001659 (fname == NULL) ? "function" : fname,
1660 (fname == NULL) ? "" : "()",
1661 len,
1662 (len == 1) ? "" : "s",
Victor Stinnerc0083fc2017-01-17 00:37:42 +01001663 nargs + nkwargs);
Benjamin Peterson01feaec2012-03-16 13:25:58 -05001664 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001665 }
Tim Petersc2f01122001-10-27 07:25:06 +00001666
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001667 /* convert tuple args and keyword args in same loop, using kwlist to drive process */
1668 for (i = 0; i < len; i++) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001669 if (*format == '|') {
Larry Hastings83a9f482012-03-20 20:06:16 +00001670 if (min != INT_MAX) {
Serhiy Storchakaa9725f82016-02-11 12:41:40 +02001671 PyErr_SetString(PyExc_SystemError,
Larry Hastings83a9f482012-03-20 20:06:16 +00001672 "Invalid format string (| specified twice)");
1673 return cleanreturn(0, &freelist);
1674 }
1675
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001676 min = i;
1677 format++;
Larry Hastings83a9f482012-03-20 20:06:16 +00001678
1679 if (max != INT_MAX) {
Serhiy Storchakaa9725f82016-02-11 12:41:40 +02001680 PyErr_SetString(PyExc_SystemError,
Larry Hastings83a9f482012-03-20 20:06:16 +00001681 "Invalid format string ($ before |)");
1682 return cleanreturn(0, &freelist);
1683 }
1684 }
1685 if (*format == '$') {
1686 if (max != INT_MAX) {
Serhiy Storchakaa9725f82016-02-11 12:41:40 +02001687 PyErr_SetString(PyExc_SystemError,
Larry Hastings83a9f482012-03-20 20:06:16 +00001688 "Invalid format string ($ specified twice)");
1689 return cleanreturn(0, &freelist);
1690 }
1691
1692 max = i;
1693 format++;
1694
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001695 if (max < pos) {
1696 PyErr_SetString(PyExc_SystemError,
1697 "Empty parameter name after $");
1698 return cleanreturn(0, &freelist);
1699 }
1700 if (skip) {
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001701 /* Now we know the minimal and the maximal numbers of
1702 * positional arguments and can raise an exception with
1703 * informative message (see below). */
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001704 break;
1705 }
Larry Hastings83a9f482012-03-20 20:06:16 +00001706 if (max < nargs) {
1707 PyErr_Format(PyExc_TypeError,
Michael Seifert64c8f702017-04-09 09:47:12 +02001708 "%.200s%s takes %s %d positional arguments"
Larry Hastings83a9f482012-03-20 20:06:16 +00001709 " (%d given)",
Michael Seifert64c8f702017-04-09 09:47:12 +02001710 (fname == NULL) ? "function" : fname,
1711 (fname == NULL) ? "" : "()",
Larry Hastings83a9f482012-03-20 20:06:16 +00001712 (min != INT_MAX) ? "at most" : "exactly",
1713 max, nargs);
1714 return cleanreturn(0, &freelist);
1715 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001716 }
1717 if (IS_END_OF_FORMAT(*format)) {
Serhiy Storchakaa9725f82016-02-11 12:41:40 +02001718 PyErr_Format(PyExc_SystemError,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001719 "More keyword list entries (%d) than "
1720 "format specifiers (%d)", len, i);
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001721 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001722 }
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001723 if (!skip) {
Serhiy Storchaka17414412017-01-17 10:07:25 +02001724 if (i < nargs) {
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001725 current_arg = PyTuple_GET_ITEM(args, i);
Serhiy Storchaka17414412017-01-17 10:07:25 +02001726 }
1727 else if (nkwargs && i >= pos) {
1728 current_arg = PyDict_GetItemString(kwargs, kwlist[i]);
1729 if (current_arg)
1730 --nkwargs;
1731 }
1732 else {
1733 current_arg = NULL;
1734 }
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001735
1736 if (current_arg) {
1737 msg = convertitem(current_arg, &format, p_va, flags,
1738 levels, msgbuf, sizeof(msgbuf), &freelist);
1739 if (msg) {
1740 seterror(i+1, msg, levels, fname, custom_msg);
1741 return cleanreturn(0, &freelist);
1742 }
1743 continue;
1744 }
1745
1746 if (i < min) {
1747 if (i < pos) {
1748 assert (min == INT_MAX);
1749 assert (max == INT_MAX);
1750 skip = 1;
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001751 /* At that moment we still don't know the minimal and
1752 * the maximal numbers of positional arguments. Raising
1753 * an exception is deferred until we encounter | and $
1754 * or the end of the format. */
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001755 }
1756 else {
Michael Seifert64c8f702017-04-09 09:47:12 +02001757 PyErr_Format(PyExc_TypeError, "%.200s%s missing required "
1758 "argument '%s' (pos %d)",
1759 (fname == NULL) ? "function" : fname,
1760 (fname == NULL) ? "" : "()",
Serhiy Storchaka17414412017-01-17 10:07:25 +02001761 kwlist[i], i+1);
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001762 return cleanreturn(0, &freelist);
1763 }
1764 }
1765 /* current code reports success when all required args
1766 * fulfilled and no keyword args left, with no further
1767 * validation. XXX Maybe skip this in debug build ?
1768 */
Victor Stinnerc0083fc2017-01-17 00:37:42 +01001769 if (!nkwargs && !skip) {
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001770 return cleanreturn(1, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001771 }
1772 }
Guido van Rossumaa354651996-08-19 19:32:04 +00001773
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001774 /* We are into optional args, skip thru to any remaining
1775 * keyword args */
1776 msg = skipitem(&format, p_va, flags);
1777 if (msg) {
Serhiy Storchakaa9725f82016-02-11 12:41:40 +02001778 PyErr_Format(PyExc_SystemError, "%s: '%s'", msg,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001779 format);
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001780 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001781 }
1782 }
Tim Petersb054be42001-10-27 05:07:41 +00001783
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001784 if (skip) {
1785 PyErr_Format(PyExc_TypeError,
Michael Seifert64c8f702017-04-09 09:47:12 +02001786 "%.200s%s takes %s %d positional arguments"
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001787 " (%d given)",
Michael Seifert64c8f702017-04-09 09:47:12 +02001788 (fname == NULL) ? "function" : fname,
1789 (fname == NULL) ? "" : "()",
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001790 (Py_MIN(pos, min) < i) ? "at least" : "exactly",
1791 Py_MIN(pos, min), nargs);
1792 return cleanreturn(0, &freelist);
1793 }
1794
Larry Hastings83a9f482012-03-20 20:06:16 +00001795 if (!IS_END_OF_FORMAT(*format) && (*format != '|') && (*format != '$')) {
Serhiy Storchakaa9725f82016-02-11 12:41:40 +02001796 PyErr_Format(PyExc_SystemError,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001797 "more argument specifiers than keyword list entries "
1798 "(remaining format:'%s')", format);
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001799 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001800 }
Tim Petersc2f01122001-10-27 07:25:06 +00001801
Victor Stinnerc0083fc2017-01-17 00:37:42 +01001802 if (nkwargs > 0) {
Serhiy Storchaka17414412017-01-17 10:07:25 +02001803 PyObject *key;
1804 Py_ssize_t j;
1805 /* make sure there are no arguments given by name and position */
1806 for (i = pos; i < nargs; i++) {
1807 current_arg = PyDict_GetItemString(kwargs, kwlist[i]);
1808 if (current_arg) {
1809 /* arg present in tuple and in dict */
1810 PyErr_Format(PyExc_TypeError,
Michael Seifert64c8f702017-04-09 09:47:12 +02001811 "argument for %.200s%s given by name ('%s') "
Serhiy Storchaka17414412017-01-17 10:07:25 +02001812 "and position (%d)",
Michael Seifert64c8f702017-04-09 09:47:12 +02001813 (fname == NULL) ? "function" : fname,
1814 (fname == NULL) ? "" : "()",
Serhiy Storchaka17414412017-01-17 10:07:25 +02001815 kwlist[i], i+1);
1816 return cleanreturn(0, &freelist);
1817 }
1818 }
1819 /* make sure there are no extraneous keyword arguments */
1820 j = 0;
1821 while (PyDict_Next(kwargs, &j, &key, NULL)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001822 int match = 0;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001823 if (!PyUnicode_Check(key)) {
1824 PyErr_SetString(PyExc_TypeError,
1825 "keywords must be strings");
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001826 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001827 }
Serhiy Storchaka17414412017-01-17 10:07:25 +02001828 for (i = pos; i < len; i++) {
1829 if (_PyUnicode_EqualToASCIIString(key, kwlist[i])) {
Antoine Pitrou7056cb22013-02-17 01:04:57 +01001830 match = 1;
1831 break;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001832 }
1833 }
1834 if (!match) {
1835 PyErr_Format(PyExc_TypeError,
Victor Stinner93b55132010-05-19 00:54:06 +00001836 "'%U' is an invalid keyword "
Michael Seifert64c8f702017-04-09 09:47:12 +02001837 "argument for %.200s%s",
1838 key,
1839 (fname == NULL) ? "this function" : fname,
1840 (fname == NULL) ? "" : "()");
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001841 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001842 }
1843 }
1844 }
1845
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001846 return cleanreturn(1, &freelist);
Guido van Rossumaa354651996-08-19 19:32:04 +00001847}
1848
1849
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001850/* List of static parsers. */
1851static struct _PyArg_Parser *static_arg_parsers = NULL;
1852
1853static int
1854parser_init(struct _PyArg_Parser *parser)
1855{
1856 const char * const *keywords;
1857 const char *format, *msg;
1858 int i, len, min, max, nkw;
1859 PyObject *kwtuple;
1860
1861 assert(parser->format != NULL);
1862 assert(parser->keywords != NULL);
1863 if (parser->kwtuple != NULL) {
1864 return 1;
1865 }
1866
1867 /* grab the function name or custom error msg first (mutually exclusive) */
1868 parser->fname = strchr(parser->format, ':');
1869 if (parser->fname) {
1870 parser->fname++;
1871 parser->custom_msg = NULL;
1872 }
1873 else {
1874 parser->custom_msg = strchr(parser->format,';');
1875 if (parser->custom_msg)
1876 parser->custom_msg++;
1877 }
1878
1879 keywords = parser->keywords;
1880 /* scan keywords and count the number of positional-only parameters */
1881 for (i = 0; keywords[i] && !*keywords[i]; i++) {
1882 }
1883 parser->pos = i;
1884 /* scan keywords and get greatest possible nbr of args */
1885 for (; keywords[i]; i++) {
1886 if (!*keywords[i]) {
1887 PyErr_SetString(PyExc_SystemError,
1888 "Empty keyword parameter name");
1889 return 0;
1890 }
1891 }
1892 len = i;
1893
1894 min = max = INT_MAX;
1895 format = parser->format;
1896 for (i = 0; i < len; i++) {
1897 if (*format == '|') {
1898 if (min != INT_MAX) {
1899 PyErr_SetString(PyExc_SystemError,
1900 "Invalid format string (| specified twice)");
1901 return 0;
1902 }
1903 if (max != INT_MAX) {
1904 PyErr_SetString(PyExc_SystemError,
1905 "Invalid format string ($ before |)");
1906 return 0;
1907 }
1908 min = i;
1909 format++;
1910 }
1911 if (*format == '$') {
1912 if (max != INT_MAX) {
1913 PyErr_SetString(PyExc_SystemError,
1914 "Invalid format string ($ specified twice)");
1915 return 0;
1916 }
1917 if (i < parser->pos) {
1918 PyErr_SetString(PyExc_SystemError,
1919 "Empty parameter name after $");
1920 return 0;
1921 }
1922 max = i;
1923 format++;
1924 }
1925 if (IS_END_OF_FORMAT(*format)) {
1926 PyErr_Format(PyExc_SystemError,
1927 "More keyword list entries (%d) than "
1928 "format specifiers (%d)", len, i);
1929 return 0;
1930 }
1931
1932 msg = skipitem(&format, NULL, 0);
1933 if (msg) {
1934 PyErr_Format(PyExc_SystemError, "%s: '%s'", msg,
1935 format);
1936 return 0;
1937 }
1938 }
1939 parser->min = Py_MIN(min, len);
1940 parser->max = Py_MIN(max, len);
1941
1942 if (!IS_END_OF_FORMAT(*format) && (*format != '|') && (*format != '$')) {
1943 PyErr_Format(PyExc_SystemError,
1944 "more argument specifiers than keyword list entries "
1945 "(remaining format:'%s')", format);
1946 return 0;
1947 }
1948
1949 nkw = len - parser->pos;
1950 kwtuple = PyTuple_New(nkw);
1951 if (kwtuple == NULL) {
1952 return 0;
1953 }
1954 keywords = parser->keywords + parser->pos;
1955 for (i = 0; i < nkw; i++) {
1956 PyObject *str = PyUnicode_FromString(keywords[i]);
1957 if (str == NULL) {
1958 Py_DECREF(kwtuple);
1959 return 0;
1960 }
1961 PyUnicode_InternInPlace(&str);
1962 PyTuple_SET_ITEM(kwtuple, i, str);
1963 }
1964 parser->kwtuple = kwtuple;
1965
1966 assert(parser->next == NULL);
1967 parser->next = static_arg_parsers;
1968 static_arg_parsers = parser;
1969 return 1;
1970}
1971
1972static void
1973parser_clear(struct _PyArg_Parser *parser)
1974{
1975 Py_CLEAR(parser->kwtuple);
1976}
1977
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07001978static PyObject*
Serhiy Storchaka17414412017-01-17 10:07:25 +02001979find_keyword(PyObject *kwargs, PyObject *kwnames, PyObject **kwstack, PyObject *key)
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07001980{
1981 Py_ssize_t i, nkwargs;
1982
Serhiy Storchaka17414412017-01-17 10:07:25 +02001983 if (kwargs != NULL) {
1984 return PyDict_GetItem(kwargs, key);
1985 }
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07001986 nkwargs = PyTuple_GET_SIZE(kwnames);
1987 for (i=0; i < nkwargs; i++) {
1988 PyObject *kwname = PyTuple_GET_ITEM(kwnames, i);
1989
1990 /* ptr==ptr should match in most cases since keyword keys
1991 should be interned strings */
1992 if (kwname == key) {
1993 return kwstack[i];
1994 }
1995 if (!PyUnicode_Check(kwname)) {
1996 /* ignore non-string keyword keys:
Serhiy Storchaka17414412017-01-17 10:07:25 +02001997 an error will be raised below */
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07001998 continue;
1999 }
2000 if (_PyUnicode_EQ(kwname, key)) {
2001 return kwstack[i];
2002 }
2003 }
2004 return NULL;
2005}
2006
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002007static int
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002008vgetargskeywordsfast_impl(PyObject **args, Py_ssize_t nargs,
Victor Stinnerc0083fc2017-01-17 00:37:42 +01002009 PyObject *kwargs, PyObject *kwnames,
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002010 struct _PyArg_Parser *parser,
2011 va_list *p_va, int flags)
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002012{
2013 PyObject *kwtuple;
2014 char msgbuf[512];
2015 int levels[32];
2016 const char *format;
2017 const char *msg;
2018 PyObject *keyword;
2019 int i, pos, len;
Victor Stinnerc0083fc2017-01-17 00:37:42 +01002020 Py_ssize_t nkwargs;
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002021 PyObject *current_arg;
2022 freelistentry_t static_entries[STATIC_FREELIST_ENTRIES];
2023 freelist_t freelist;
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002024 PyObject **kwstack = NULL;
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002025
2026 freelist.entries = static_entries;
2027 freelist.first_available = 0;
2028 freelist.entries_malloced = 0;
2029
Victor Stinnerc0083fc2017-01-17 00:37:42 +01002030 assert(kwargs == NULL || PyDict_Check(kwargs));
Serhiy Storchaka17414412017-01-17 10:07:25 +02002031 assert(kwargs == NULL || kwnames == NULL);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002032 assert(p_va != NULL);
2033
Victor Stinner80ab22f2017-01-16 23:16:47 +01002034 if (parser == NULL) {
2035 PyErr_BadInternalCall();
2036 return 0;
2037 }
2038
2039 if (kwnames != NULL && !PyTuple_Check(kwnames)) {
2040 PyErr_BadInternalCall();
2041 return 0;
2042 }
2043
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002044 if (!parser_init(parser)) {
2045 return 0;
2046 }
2047
2048 kwtuple = parser->kwtuple;
2049 pos = parser->pos;
2050 len = pos + PyTuple_GET_SIZE(kwtuple);
2051
2052 if (len > STATIC_FREELIST_ENTRIES) {
2053 freelist.entries = PyMem_NEW(freelistentry_t, len);
2054 if (freelist.entries == NULL) {
2055 PyErr_NoMemory();
2056 return 0;
2057 }
2058 freelist.entries_malloced = 1;
2059 }
2060
Victor Stinnerc0083fc2017-01-17 00:37:42 +01002061 if (kwargs != NULL) {
2062 nkwargs = PyDict_GET_SIZE(kwargs);
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002063 }
2064 else if (kwnames != NULL) {
Victor Stinnerc0083fc2017-01-17 00:37:42 +01002065 nkwargs = PyTuple_GET_SIZE(kwnames);
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002066 kwstack = args + nargs;
2067 }
2068 else {
Victor Stinnerc0083fc2017-01-17 00:37:42 +01002069 nkwargs = 0;
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002070 }
Victor Stinnerc0083fc2017-01-17 00:37:42 +01002071 if (nargs + nkwargs > len) {
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002072 PyErr_Format(PyExc_TypeError,
Michael Seifert64c8f702017-04-09 09:47:12 +02002073 "%.200s%s takes at most %d argument%s (%zd given)",
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002074 (parser->fname == NULL) ? "function" : parser->fname,
2075 (parser->fname == NULL) ? "" : "()",
2076 len,
2077 (len == 1) ? "" : "s",
Victor Stinnerc0083fc2017-01-17 00:37:42 +01002078 nargs + nkwargs);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002079 return cleanreturn(0, &freelist);
2080 }
2081 if (parser->max < nargs) {
2082 PyErr_Format(PyExc_TypeError,
Michael Seifert64c8f702017-04-09 09:47:12 +02002083 "%200s%s takes %s %d positional arguments (%d given)",
2084 (parser->fname == NULL) ? "function" : parser->fname,
2085 (parser->fname == NULL) ? "" : "()",
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002086 (parser->min != INT_MAX) ? "at most" : "exactly",
2087 parser->max, nargs);
2088 return cleanreturn(0, &freelist);
2089 }
2090
2091 format = parser->format;
2092 /* convert tuple args and keyword args in same loop, using kwtuple to drive process */
2093 for (i = 0; i < len; i++) {
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002094 if (*format == '|') {
2095 format++;
2096 }
2097 if (*format == '$') {
2098 format++;
2099 }
2100 assert(!IS_END_OF_FORMAT(*format));
2101
Serhiy Storchaka17414412017-01-17 10:07:25 +02002102 if (i < nargs) {
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002103 current_arg = args[i];
Victor Stinnera9efb2f2016-09-09 17:40:22 -07002104 }
Serhiy Storchaka17414412017-01-17 10:07:25 +02002105 else if (nkwargs && i >= pos) {
2106 keyword = PyTuple_GET_ITEM(kwtuple, i - pos);
2107 current_arg = find_keyword(kwargs, kwnames, kwstack, keyword);
2108 if (current_arg)
2109 --nkwargs;
2110 }
2111 else {
2112 current_arg = NULL;
2113 }
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002114
2115 if (current_arg) {
2116 msg = convertitem(current_arg, &format, p_va, flags,
2117 levels, msgbuf, sizeof(msgbuf), &freelist);
2118 if (msg) {
2119 seterror(i+1, msg, levels, parser->fname, parser->custom_msg);
2120 return cleanreturn(0, &freelist);
2121 }
2122 continue;
2123 }
2124
2125 if (i < parser->min) {
2126 /* Less arguments than required */
2127 if (i < pos) {
Serhiy Storchaka17414412017-01-17 10:07:25 +02002128 Py_ssize_t min = Py_MIN(pos, parser->min);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002129 PyErr_Format(PyExc_TypeError,
Michael Seifert64c8f702017-04-09 09:47:12 +02002130 "%.200s%s takes %s %d positional arguments"
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002131 " (%d given)",
Michael Seifert64c8f702017-04-09 09:47:12 +02002132 (parser->fname == NULL) ? "function" : parser->fname,
2133 (parser->fname == NULL) ? "" : "()",
Serhiy Storchaka17414412017-01-17 10:07:25 +02002134 min < parser->max ? "at least" : "exactly",
2135 min, nargs);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002136 }
2137 else {
Serhiy Storchaka17414412017-01-17 10:07:25 +02002138 keyword = PyTuple_GET_ITEM(kwtuple, i - pos);
Michael Seifert64c8f702017-04-09 09:47:12 +02002139 PyErr_Format(PyExc_TypeError, "%.200s%s missing required "
2140 "argument '%U' (pos %d)",
2141 (parser->fname == NULL) ? "function" : parser->fname,
2142 (parser->fname == NULL) ? "" : "()",
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002143 keyword, i+1);
2144 }
2145 return cleanreturn(0, &freelist);
2146 }
2147 /* current code reports success when all required args
2148 * fulfilled and no keyword args left, with no further
2149 * validation. XXX Maybe skip this in debug build ?
2150 */
Victor Stinnerc0083fc2017-01-17 00:37:42 +01002151 if (!nkwargs) {
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002152 return cleanreturn(1, &freelist);
2153 }
2154
2155 /* We are into optional args, skip thru to any remaining
2156 * keyword args */
2157 msg = skipitem(&format, p_va, flags);
2158 assert(msg == NULL);
2159 }
2160
2161 assert(IS_END_OF_FORMAT(*format) || (*format == '|') || (*format == '$'));
2162
Victor Stinnerc0083fc2017-01-17 00:37:42 +01002163 if (nkwargs > 0) {
Serhiy Storchaka17414412017-01-17 10:07:25 +02002164 Py_ssize_t j;
2165 /* make sure there are no arguments given by name and position */
2166 for (i = pos; i < nargs; i++) {
2167 keyword = PyTuple_GET_ITEM(kwtuple, i - pos);
2168 current_arg = find_keyword(kwargs, kwnames, kwstack, keyword);
2169 if (current_arg) {
2170 /* arg present in tuple and in dict */
2171 PyErr_Format(PyExc_TypeError,
Michael Seifert64c8f702017-04-09 09:47:12 +02002172 "argument for %.200s%s given by name ('%U') "
Serhiy Storchaka17414412017-01-17 10:07:25 +02002173 "and position (%d)",
Michael Seifert64c8f702017-04-09 09:47:12 +02002174 (parser->fname == NULL) ? "function" : parser->fname,
2175 (parser->fname == NULL) ? "" : "()",
Serhiy Storchaka17414412017-01-17 10:07:25 +02002176 keyword, i+1);
2177 return cleanreturn(0, &freelist);
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002178 }
2179 }
Serhiy Storchaka17414412017-01-17 10:07:25 +02002180 /* make sure there are no extraneous keyword arguments */
2181 j = 0;
2182 while (1) {
2183 int match;
2184 if (kwargs != NULL) {
2185 if (!PyDict_Next(kwargs, &j, &keyword, NULL))
2186 break;
2187 }
2188 else {
2189 if (j >= PyTuple_GET_SIZE(kwnames))
2190 break;
2191 keyword = PyTuple_GET_ITEM(kwnames, j);
2192 j++;
2193 }
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002194
Serhiy Storchaka17414412017-01-17 10:07:25 +02002195 if (!PyUnicode_Check(keyword)) {
2196 PyErr_SetString(PyExc_TypeError,
2197 "keywords must be strings");
2198 return cleanreturn(0, &freelist);
2199 }
2200 match = PySequence_Contains(kwtuple, keyword);
2201 if (match <= 0) {
2202 if (!match) {
2203 PyErr_Format(PyExc_TypeError,
2204 "'%U' is an invalid keyword "
Michael Seifert64c8f702017-04-09 09:47:12 +02002205 "argument for %.200s%s",
2206 keyword,
2207 (parser->fname == NULL) ? "this function" : parser->fname,
2208 (parser->fname == NULL) ? "" : "()");
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002209 }
Serhiy Storchaka17414412017-01-17 10:07:25 +02002210 return cleanreturn(0, &freelist);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002211 }
2212 }
2213 }
2214
2215 return cleanreturn(1, &freelist);
2216}
2217
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002218static int
2219vgetargskeywordsfast(PyObject *args, PyObject *keywords,
2220 struct _PyArg_Parser *parser, va_list *p_va, int flags)
2221{
2222 PyObject **stack;
2223 Py_ssize_t nargs;
2224
Victor Stinner80ab22f2017-01-16 23:16:47 +01002225 if (args == NULL
2226 || !PyTuple_Check(args)
2227 || (keywords != NULL && !PyDict_Check(keywords)))
2228 {
2229 PyErr_BadInternalCall();
2230 return 0;
2231 }
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002232
2233 stack = &PyTuple_GET_ITEM(args, 0);
2234 nargs = PyTuple_GET_SIZE(args);
2235 return vgetargskeywordsfast_impl(stack, nargs, keywords, NULL,
2236 parser, p_va, flags);
2237}
2238
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002239
Serhiy Storchakaef1585e2015-12-25 20:01:53 +02002240static const char *
Martin v. Löwis18e16552006-02-15 17:27:45 +00002241skipitem(const char **p_format, va_list *p_va, int flags)
Guido van Rossumaa354651996-08-19 19:32:04 +00002242{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002243 const char *format = *p_format;
2244 char c = *format++;
Guido van Rossum98297ee2007-11-06 21:34:58 +00002245
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002246 switch (c) {
Georg Brandl6dd14612005-09-14 19:29:53 +00002247
Larry Hastingsa3479012012-05-08 23:52:03 -07002248 /*
2249 * codes that take a single data pointer as an argument
2250 * (the type of the pointer is irrelevant)
2251 */
Georg Brandl6dd14612005-09-14 19:29:53 +00002252
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002253 case 'b': /* byte -- very short int */
2254 case 'B': /* byte as bitfield */
2255 case 'h': /* short int */
2256 case 'H': /* short int as bitfield */
2257 case 'i': /* int */
2258 case 'I': /* int sized bitfield */
2259 case 'l': /* long int */
2260 case 'k': /* long int sized bitfield */
Benjamin Petersonaf580df2016-09-06 10:46:49 -07002261 case 'L': /* long long */
2262 case 'K': /* long long sized bitfield */
Larry Hastingsa3479012012-05-08 23:52:03 -07002263 case 'n': /* Py_ssize_t */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002264 case 'f': /* float */
2265 case 'd': /* double */
2266 case 'D': /* complex double */
2267 case 'c': /* char */
2268 case 'C': /* unicode char */
Larry Hastings10ba07a2012-05-07 02:44:50 -07002269 case 'p': /* boolean predicate */
Larry Hastingsa3479012012-05-08 23:52:03 -07002270 case 'S': /* string object */
2271 case 'Y': /* string object */
2272 case 'U': /* unicode string object */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002273 {
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002274 if (p_va != NULL) {
2275 (void) va_arg(*p_va, void *);
2276 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002277 break;
2278 }
Martin v. Löwis18e16552006-02-15 17:27:45 +00002279
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002280 /* string codes */
Guido van Rossum98297ee2007-11-06 21:34:58 +00002281
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002282 case 'e': /* string with encoding */
2283 {
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002284 if (p_va != NULL) {
2285 (void) va_arg(*p_va, const char *);
2286 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002287 if (!(*format == 's' || *format == 't'))
2288 /* after 'e', only 's' and 't' is allowed */
2289 goto err;
2290 format++;
2291 /* explicit fallthrough to string cases */
2292 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00002293
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002294 case 's': /* string */
2295 case 'z': /* string or None */
2296 case 'y': /* bytes */
2297 case 'u': /* unicode string */
Larry Hastingsd9e4a412012-05-08 03:51:18 -07002298 case 'Z': /* unicode string or None */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002299 case 'w': /* buffer, read-write */
2300 {
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002301 if (p_va != NULL) {
2302 (void) va_arg(*p_va, char **);
2303 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002304 if (*format == '#') {
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002305 if (p_va != NULL) {
2306 if (flags & FLAG_SIZE_T)
2307 (void) va_arg(*p_va, Py_ssize_t *);
2308 else
2309 (void) va_arg(*p_va, int *);
2310 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002311 format++;
2312 } else if ((c == 's' || c == 'z' || c == 'y') && *format == '*') {
2313 format++;
2314 }
2315 break;
2316 }
Georg Brandl6dd14612005-09-14 19:29:53 +00002317
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002318 case 'O': /* object */
2319 {
2320 if (*format == '!') {
2321 format++;
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002322 if (p_va != NULL) {
2323 (void) va_arg(*p_va, PyTypeObject*);
2324 (void) va_arg(*p_va, PyObject **);
2325 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002326 }
2327 else if (*format == '&') {
2328 typedef int (*converter)(PyObject *, void *);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002329 if (p_va != NULL) {
2330 (void) va_arg(*p_va, converter);
2331 (void) va_arg(*p_va, void *);
2332 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002333 format++;
2334 }
2335 else {
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002336 if (p_va != NULL) {
2337 (void) va_arg(*p_va, PyObject **);
2338 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002339 }
2340 break;
2341 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00002342
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002343 case '(': /* bypass tuple, not handled at all previously */
2344 {
Serhiy Storchakaef1585e2015-12-25 20:01:53 +02002345 const char *msg;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002346 for (;;) {
2347 if (*format==')')
2348 break;
2349 if (IS_END_OF_FORMAT(*format))
2350 return "Unmatched left paren in format "
2351 "string";
2352 msg = skipitem(&format, p_va, flags);
2353 if (msg)
2354 return msg;
2355 }
2356 format++;
2357 break;
2358 }
Christian Heimes380f7f22008-02-28 11:19:05 +00002359
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002360 case ')':
2361 return "Unmatched right paren in format string";
Christian Heimes380f7f22008-02-28 11:19:05 +00002362
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002363 default:
Georg Brandl6dd14612005-09-14 19:29:53 +00002364err:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002365 return "impossible<bad format char>";
Guido van Rossum98297ee2007-11-06 21:34:58 +00002366
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002367 }
Georg Brandl6dd14612005-09-14 19:29:53 +00002368
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002369 *p_format = format;
2370 return NULL;
Guido van Rossumaa354651996-08-19 19:32:04 +00002371}
Fred Drakee4616e62001-10-23 21:09:29 +00002372
2373
Victor Stinnerfe54dd82017-01-17 02:33:55 +01002374static int
Victor Stinnerfdbc3972017-02-01 17:42:18 +01002375unpack_stack(PyObject **args, Py_ssize_t nargs, const char *name,
2376 Py_ssize_t min, Py_ssize_t max, va_list vargs)
Fred Drakee4616e62001-10-23 21:09:29 +00002377{
Victor Stinnerfe54dd82017-01-17 02:33:55 +01002378 Py_ssize_t i;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002379 PyObject **o;
Fred Drakee4616e62001-10-23 21:09:29 +00002380
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002381 assert(min >= 0);
2382 assert(min <= max);
Victor Stinnerfe54dd82017-01-17 02:33:55 +01002383
Victor Stinnerfdbc3972017-02-01 17:42:18 +01002384 if (nargs < min) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002385 if (name != NULL)
2386 PyErr_Format(
2387 PyExc_TypeError,
Michael Seifert64c8f702017-04-09 09:47:12 +02002388 "%.200s expected %s%zd arguments, got %zd",
Victor Stinnerfdbc3972017-02-01 17:42:18 +01002389 name, (min == max ? "" : "at least "), min, nargs);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002390 else
2391 PyErr_Format(
2392 PyExc_TypeError,
2393 "unpacked tuple should have %s%zd elements,"
2394 " but has %zd",
Victor Stinnerfdbc3972017-02-01 17:42:18 +01002395 (min == max ? "" : "at least "), min, nargs);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002396 return 0;
2397 }
Victor Stinnerfe54dd82017-01-17 02:33:55 +01002398
Victor Stinnerfdbc3972017-02-01 17:42:18 +01002399 if (nargs == 0) {
Raymond Hettinger94230232016-03-26 03:02:48 -07002400 return 1;
Victor Stinnerfe54dd82017-01-17 02:33:55 +01002401 }
2402
Victor Stinnerfdbc3972017-02-01 17:42:18 +01002403 if (nargs > max) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002404 if (name != NULL)
2405 PyErr_Format(
2406 PyExc_TypeError,
Michael Seifert64c8f702017-04-09 09:47:12 +02002407 "%.200s expected %s%zd arguments, got %zd",
Victor Stinnerfdbc3972017-02-01 17:42:18 +01002408 name, (min == max ? "" : "at most "), max, nargs);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002409 else
2410 PyErr_Format(
2411 PyExc_TypeError,
2412 "unpacked tuple should have %s%zd elements,"
2413 " but has %zd",
Victor Stinnerfdbc3972017-02-01 17:42:18 +01002414 (min == max ? "" : "at most "), max, nargs);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002415 return 0;
2416 }
Raymond Hettinger94230232016-03-26 03:02:48 -07002417
Victor Stinnerfdbc3972017-02-01 17:42:18 +01002418 for (i = 0; i < nargs; i++) {
Victor Stinnerfe54dd82017-01-17 02:33:55 +01002419 o = va_arg(vargs, PyObject **);
2420 *o = args[i];
2421 }
2422 return 1;
2423}
2424
2425int
2426PyArg_UnpackTuple(PyObject *args, const char *name, Py_ssize_t min, Py_ssize_t max, ...)
2427{
2428 PyObject **stack;
2429 Py_ssize_t nargs;
2430 int retval;
2431 va_list vargs;
2432
2433 if (!PyTuple_Check(args)) {
2434 PyErr_SetString(PyExc_SystemError,
2435 "PyArg_UnpackTuple() argument list is not a tuple");
2436 return 0;
2437 }
2438 stack = &PyTuple_GET_ITEM(args, 0);
2439 nargs = PyTuple_GET_SIZE(args);
2440
Raymond Hettinger94230232016-03-26 03:02:48 -07002441#ifdef HAVE_STDARG_PROTOTYPES
2442 va_start(vargs, max);
2443#else
2444 va_start(vargs);
2445#endif
Victor Stinnerfdbc3972017-02-01 17:42:18 +01002446 retval = unpack_stack(stack, nargs, name, min, max, vargs);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002447 va_end(vargs);
Victor Stinnerfe54dd82017-01-17 02:33:55 +01002448 return retval;
2449}
2450
2451int
2452_PyArg_UnpackStack(PyObject **args, Py_ssize_t nargs, const char *name,
2453 Py_ssize_t min, Py_ssize_t max, ...)
2454{
2455 int retval;
2456 va_list vargs;
2457
2458#ifdef HAVE_STDARG_PROTOTYPES
2459 va_start(vargs, max);
2460#else
2461 va_start(vargs);
2462#endif
Victor Stinnerfdbc3972017-02-01 17:42:18 +01002463 retval = unpack_stack(args, nargs, name, min, max, vargs);
Victor Stinnerfe54dd82017-01-17 02:33:55 +01002464 va_end(vargs);
2465 return retval;
Fred Drakee4616e62001-10-23 21:09:29 +00002466}
Georg Brandl02c42872005-08-26 06:42:30 +00002467
2468
Serhiy Storchaka68a001d2017-02-06 10:41:46 +02002469#undef _PyArg_NoKeywords
2470#undef _PyArg_NoStackKeywords
2471#undef _PyArg_NoPositional
2472
Georg Brandl02c42872005-08-26 06:42:30 +00002473/* For type constructors that don't take keyword args
2474 *
Larry Hastingsb7ccb202014-01-18 23:50:21 -08002475 * Sets a TypeError and returns 0 if the args/kwargs is
Thomas Wouters89f507f2006-12-13 04:49:30 +00002476 * not empty, returns 1 otherwise
Georg Brandl02c42872005-08-26 06:42:30 +00002477 */
2478int
Victor Stinner29d39cc2017-01-17 01:40:01 +01002479_PyArg_NoKeywords(const char *funcname, PyObject *kwargs)
Georg Brandl02c42872005-08-26 06:42:30 +00002480{
Victor Stinnerfe54dd82017-01-17 02:33:55 +01002481 if (kwargs == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002482 return 1;
Victor Stinnerfe54dd82017-01-17 02:33:55 +01002483 }
Victor Stinner29d39cc2017-01-17 01:40:01 +01002484 if (!PyDict_CheckExact(kwargs)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002485 PyErr_BadInternalCall();
2486 return 0;
2487 }
Victor Stinner29d39cc2017-01-17 01:40:01 +01002488 if (PyDict_GET_SIZE(kwargs) == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002489 return 1;
Victor Stinner29d39cc2017-01-17 01:40:01 +01002490 }
2491
Michael Seifert64c8f702017-04-09 09:47:12 +02002492 PyErr_Format(PyExc_TypeError, "%.200s does not take keyword arguments",
Victor Stinner29d39cc2017-01-17 01:40:01 +01002493 funcname);
2494 return 0;
2495}
2496
2497
2498int
2499_PyArg_NoStackKeywords(const char *funcname, PyObject *kwnames)
2500{
Victor Stinnerfe54dd82017-01-17 02:33:55 +01002501 if (kwnames == NULL) {
Victor Stinner29d39cc2017-01-17 01:40:01 +01002502 return 1;
Victor Stinnerfe54dd82017-01-17 02:33:55 +01002503 }
Victor Stinner29d39cc2017-01-17 01:40:01 +01002504 assert(PyTuple_CheckExact(kwnames));
2505 if (PyTuple_GET_SIZE(kwnames) == 0) {
2506 return 1;
2507 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00002508
Michael Seifert64c8f702017-04-09 09:47:12 +02002509 PyErr_Format(PyExc_TypeError, "%.200s does not take keyword arguments",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002510 funcname);
2511 return 0;
Georg Brandl02c42872005-08-26 06:42:30 +00002512}
Larry Hastingsb7ccb202014-01-18 23:50:21 -08002513
2514
2515int
2516_PyArg_NoPositional(const char *funcname, PyObject *args)
2517{
2518 if (args == NULL)
2519 return 1;
2520 if (!PyTuple_CheckExact(args)) {
2521 PyErr_BadInternalCall();
2522 return 0;
2523 }
2524 if (PyTuple_GET_SIZE(args) == 0)
2525 return 1;
2526
Michael Seifert64c8f702017-04-09 09:47:12 +02002527 PyErr_Format(PyExc_TypeError, "%.200s does not take positional arguments",
Larry Hastingsb7ccb202014-01-18 23:50:21 -08002528 funcname);
2529 return 0;
2530}
2531
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002532void
2533_PyArg_Fini(void)
2534{
2535 struct _PyArg_Parser *tmp, *s = static_arg_parsers;
2536 while (s) {
2537 tmp = s->next;
2538 s->next = NULL;
2539 parser_clear(s);
2540 s = tmp;
2541 }
2542 static_arg_parsers = NULL;
2543}
2544
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002545#ifdef __cplusplus
2546};
2547#endif