blob: ed6b8152de453e5da13c8de87cb6669b79d4869e [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>
Miss Islington (bot)b0362322017-09-07 11:35:03 -07007#include <float.h>
Guido van Rossumc1d50531996-08-21 23:38:24 +00008
Guido van Rossumfe3f1a21994-09-29 09:42:55 +00009
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000010#ifdef __cplusplus
Guido van Rossum98297ee2007-11-06 21:34:58 +000011extern "C" {
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000012#endif
Jeremy Hyltonaf68c872005-12-10 18:50:16 +000013int PyArg_Parse(PyObject *, const char *, ...);
14int PyArg_ParseTuple(PyObject *, const char *, ...);
15int PyArg_VaParse(PyObject *, const char *, va_list);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000016
Tim Petersdbd9ba62000-07-09 03:09:57 +000017int PyArg_ParseTupleAndKeywords(PyObject *, PyObject *,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000018 const char *, char **, ...);
Brett Cannon711e7d92004-07-10 22:20:32 +000019int PyArg_VaParseTupleAndKeywords(PyObject *, PyObject *,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000020 const char *, char **, va_list);
Brett Cannon711e7d92004-07-10 22:20:32 +000021
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +030022int _PyArg_ParseTupleAndKeywordsFast(PyObject *, PyObject *,
23 struct _PyArg_Parser *, ...);
24int _PyArg_VaParseTupleAndKeywordsFast(PyObject *, PyObject *,
25 struct _PyArg_Parser *, va_list);
26
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000027#ifdef HAVE_DECLSPEC_DLL
28/* Export functions */
Serhiy Storchakaef1585e2015-12-25 20:01:53 +020029PyAPI_FUNC(int) _PyArg_Parse_SizeT(PyObject *, const char *, ...);
Benjamin Peterson819a46f2016-09-09 20:45:06 -070030PyAPI_FUNC(int) _PyArg_ParseStack_SizeT(PyObject **args, Py_ssize_t nargs, PyObject *kwnames,
31 struct _PyArg_Parser *parser, ...);
Serhiy Storchakaef1585e2015-12-25 20:01:53 +020032PyAPI_FUNC(int) _PyArg_ParseTuple_SizeT(PyObject *, const char *, ...);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000033PyAPI_FUNC(int) _PyArg_ParseTupleAndKeywords_SizeT(PyObject *, PyObject *,
34 const char *, char **, ...);
35PyAPI_FUNC(PyObject *) _Py_BuildValue_SizeT(const char *, ...);
Serhiy Storchakaef1585e2015-12-25 20:01:53 +020036PyAPI_FUNC(int) _PyArg_VaParse_SizeT(PyObject *, const char *, va_list);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000037PyAPI_FUNC(int) _PyArg_VaParseTupleAndKeywords_SizeT(PyObject *, PyObject *,
38 const char *, char **, va_list);
Benjamin Peterson4eef5052016-09-10 17:04:36 -070039
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +030040PyAPI_FUNC(int) _PyArg_ParseTupleAndKeywordsFast_SizeT(PyObject *, PyObject *,
41 struct _PyArg_Parser *, ...);
42PyAPI_FUNC(int) _PyArg_VaParseTupleAndKeywordsFast_SizeT(PyObject *, PyObject *,
43 struct _PyArg_Parser *, va_list);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000044#endif
45
Martin v. Löwis18e16552006-02-15 17:27:45 +000046#define FLAG_COMPAT 1
47#define FLAG_SIZE_T 2
48
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -040049typedef int (*destr_t)(PyObject *, void *);
50
51
52/* Keep track of "objects" that have been allocated or initialized and
53 which will need to be deallocated or cleaned up somehow if overall
54 parsing fails.
55*/
56typedef struct {
57 void *item;
58 destr_t destructor;
59} freelistentry_t;
60
61typedef struct {
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -040062 freelistentry_t *entries;
Antoine Pitrou7056cb22013-02-17 01:04:57 +010063 int first_available;
64 int entries_malloced;
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -040065} freelist_t;
66
Antoine Pitrou7056cb22013-02-17 01:04:57 +010067#define STATIC_FREELIST_ENTRIES 8
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000068
69/* Forward */
Jeremy Hyltonaf68c872005-12-10 18:50:16 +000070static int vgetargs1(PyObject *, const char *, va_list *, int);
Victor Stinner84bb1cf2013-05-17 00:12:04 +020071static void seterror(Py_ssize_t, const char *, int *, const char *, const char *);
Serhiy Storchakaef1585e2015-12-25 20:01:53 +020072static const char *convertitem(PyObject *, const char **, va_list *, int, int *,
73 char *, size_t, freelist_t *);
74static const char *converttuple(PyObject *, const char **, va_list *, int,
75 int *, char *, size_t, int, freelist_t *);
76static const char *convertsimple(PyObject *, const char **, va_list *, int,
77 char *, size_t, freelist_t *);
78static Py_ssize_t convertbuffer(PyObject *, void **p, const char **);
79static int getbuffer(PyObject *, Py_buffer *, const char**);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000080
Tim Petersdbd9ba62000-07-09 03:09:57 +000081static int vgetargskeywords(PyObject *, PyObject *,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000082 const char *, char **, va_list *, int);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +030083static int vgetargskeywordsfast(PyObject *, PyObject *,
84 struct _PyArg_Parser *, va_list *, int);
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -070085static int vgetargskeywordsfast_impl(PyObject **args, Py_ssize_t nargs,
86 PyObject *keywords, PyObject *kwnames,
87 struct _PyArg_Parser *parser,
88 va_list *p_va, int flags);
Serhiy Storchakaef1585e2015-12-25 20:01:53 +020089static const char *skipitem(const char **, va_list *, int);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000090
Fred Drake563dfc22001-10-23 14:41:08 +000091int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +000092PyArg_Parse(PyObject *args, const char *format, ...)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000093{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000094 int retval;
95 va_list va;
Guido van Rossum98297ee2007-11-06 21:34:58 +000096
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000097 va_start(va, format);
98 retval = vgetargs1(args, format, &va, FLAG_COMPAT);
99 va_end(va);
100 return retval;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000101}
102
103int
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200104_PyArg_Parse_SizeT(PyObject *args, const char *format, ...)
Martin v. Löwis18e16552006-02-15 17:27:45 +0000105{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000106 int retval;
107 va_list va;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000108
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000109 va_start(va, format);
110 retval = vgetargs1(args, format, &va, FLAG_COMPAT|FLAG_SIZE_T);
111 va_end(va);
112 return retval;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000113}
114
115
Fred Drake563dfc22001-10-23 14:41:08 +0000116int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000117PyArg_ParseTuple(PyObject *args, const char *format, ...)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000118{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000119 int retval;
120 va_list va;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000121
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000122 va_start(va, format);
123 retval = vgetargs1(args, format, &va, 0);
124 va_end(va);
125 return retval;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000126}
127
Martin v. Löwis18e16552006-02-15 17:27:45 +0000128int
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200129_PyArg_ParseTuple_SizeT(PyObject *args, const char *format, ...)
Martin v. Löwis18e16552006-02-15 17:27:45 +0000130{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000131 int retval;
132 va_list va;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000133
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000134 va_start(va, format);
135 retval = vgetargs1(args, format, &va, FLAG_SIZE_T);
136 va_end(va);
137 return retval;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000138}
139
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000140
141int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000142PyArg_VaParse(PyObject *args, const char *format, va_list va)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000143{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000144 va_list lva;
Christian Heimes2f2fee12016-09-21 11:37:27 +0200145 int retval;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000146
Benjamin Peterson0c212142016-09-20 20:39:33 -0700147 va_copy(lva, va);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000148
Christian Heimes2f2fee12016-09-21 11:37:27 +0200149 retval = vgetargs1(args, format, &lva, 0);
150 va_end(lva);
151 return retval;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000152}
153
Martin v. Löwis18e16552006-02-15 17:27:45 +0000154int
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200155_PyArg_VaParse_SizeT(PyObject *args, const char *format, va_list va)
Martin v. Löwis18e16552006-02-15 17:27:45 +0000156{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000157 va_list lva;
Christian Heimes2f2fee12016-09-21 11:37:27 +0200158 int retval;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000159
Benjamin Peterson0c212142016-09-20 20:39:33 -0700160 va_copy(lva, va);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000161
Christian Heimes2f2fee12016-09-21 11:37:27 +0200162 retval = vgetargs1(args, format, &lva, FLAG_SIZE_T);
163 va_end(lva);
164 return retval;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000165}
166
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000167
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000168/* Handle cleanup of allocated memory in case of exception */
169
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400170static int
171cleanup_ptr(PyObject *self, void *ptr)
Antoine Pitrouf71995782008-08-29 18:37:05 +0000172{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000173 if (ptr) {
174 PyMem_FREE(ptr);
175 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000176 return 0;
Martin v. Löwisc15bdef2009-05-29 14:47:46 +0000177}
178
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000179static int
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400180cleanup_buffer(PyObject *self, void *ptr)
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000181{
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400182 Py_buffer *buf = (Py_buffer *)ptr;
183 if (buf) {
184 PyBuffer_Release(buf);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000185 }
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400186 return 0;
187}
188
189static int
190addcleanup(void *ptr, freelist_t *freelist, destr_t destructor)
191{
192 int index;
193
194 index = freelist->first_available;
195 freelist->first_available += 1;
196
197 freelist->entries[index].item = ptr;
198 freelist->entries[index].destructor = destructor;
199
200 return 0;
201}
202
203static int
204cleanreturn(int retval, freelist_t *freelist)
205{
206 int index;
207
208 if (retval == 0) {
209 /* A failure occurred, therefore execute all of the cleanup
210 functions.
211 */
212 for (index = 0; index < freelist->first_available; ++index) {
213 freelist->entries[index].destructor(NULL,
214 freelist->entries[index].item);
215 }
216 }
Antoine Pitrou7056cb22013-02-17 01:04:57 +0100217 if (freelist->entries_malloced)
218 PyMem_FREE(freelist->entries);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000219 return retval;
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000220}
221
222
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000223static int
Martin v. Löwis18e16552006-02-15 17:27:45 +0000224vgetargs1(PyObject *args, const char *format, va_list *p_va, int flags)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000225{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000226 char msgbuf[256];
227 int levels[32];
228 const char *fname = NULL;
229 const char *message = NULL;
230 int min = -1;
231 int max = 0;
232 int level = 0;
233 int endfmt = 0;
234 const char *formatsave = format;
235 Py_ssize_t i, len;
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200236 const char *msg;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000237 int compat = flags & FLAG_COMPAT;
Benjamin Peterson40be9e52014-02-11 10:09:27 -0500238 freelistentry_t static_entries[STATIC_FREELIST_ENTRIES];
239 freelist_t freelist;
240
241 freelist.entries = static_entries;
242 freelist.first_available = 0;
243 freelist.entries_malloced = 0;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000244
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000245 assert(compat || (args != (PyObject*)NULL));
246 flags = flags & ~FLAG_COMPAT;
Tim Peters5c4d5bf2001-02-12 22:13:26 +0000247
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000248 while (endfmt == 0) {
249 int c = *format++;
250 switch (c) {
251 case '(':
252 if (level == 0)
253 max++;
254 level++;
255 if (level >= 30)
256 Py_FatalError("too many tuple nesting levels "
257 "in argument format string");
258 break;
259 case ')':
260 if (level == 0)
261 Py_FatalError("excess ')' in getargs format");
262 else
263 level--;
264 break;
265 case '\0':
266 endfmt = 1;
267 break;
268 case ':':
269 fname = format;
270 endfmt = 1;
271 break;
272 case ';':
273 message = format;
274 endfmt = 1;
275 break;
Antoine Pitrou7056cb22013-02-17 01:04:57 +0100276 case '|':
277 if (level == 0)
278 min = max;
279 break;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000280 default:
281 if (level == 0) {
Antoine Pitrou7056cb22013-02-17 01:04:57 +0100282 if (Py_ISALPHA(Py_CHARMASK(c)))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000283 if (c != 'e') /* skip encoded */
284 max++;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000285 }
286 break;
287 }
288 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000289
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000290 if (level != 0)
291 Py_FatalError(/* '(' */ "missing ')' in getargs format");
Guido van Rossum98297ee2007-11-06 21:34:58 +0000292
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000293 if (min < 0)
294 min = max;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000295
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000296 format = formatsave;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000297
Antoine Pitrou7056cb22013-02-17 01:04:57 +0100298 if (max > STATIC_FREELIST_ENTRIES) {
299 freelist.entries = PyMem_NEW(freelistentry_t, max);
300 if (freelist.entries == NULL) {
301 PyErr_NoMemory();
302 return 0;
303 }
304 freelist.entries_malloced = 1;
Benjamin Peterson7ed67272012-03-16 12:21:02 -0500305 }
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400306
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000307 if (compat) {
308 if (max == 0) {
309 if (args == NULL)
310 return 1;
Victor Stinner6ced7c42011-03-21 18:15:42 +0100311 PyErr_Format(PyExc_TypeError,
312 "%.200s%s takes no arguments",
313 fname==NULL ? "function" : fname,
314 fname==NULL ? "" : "()");
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400315 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000316 }
317 else if (min == 1 && max == 1) {
318 if (args == NULL) {
Victor Stinner6ced7c42011-03-21 18:15:42 +0100319 PyErr_Format(PyExc_TypeError,
320 "%.200s%s takes at least one argument",
321 fname==NULL ? "function" : fname,
322 fname==NULL ? "" : "()");
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400323 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000324 }
325 msg = convertitem(args, &format, p_va, flags, levels,
326 msgbuf, sizeof(msgbuf), &freelist);
327 if (msg == NULL)
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400328 return cleanreturn(1, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000329 seterror(levels[0], msg, levels+1, fname, message);
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400330 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000331 }
332 else {
333 PyErr_SetString(PyExc_SystemError,
334 "old style getargs format uses new features");
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400335 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000336 }
337 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000338
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000339 if (!PyTuple_Check(args)) {
340 PyErr_SetString(PyExc_SystemError,
341 "new style getargs format but argument is not a tuple");
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400342 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000343 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000344
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000345 len = PyTuple_GET_SIZE(args);
Guido van Rossum98297ee2007-11-06 21:34:58 +0000346
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000347 if (len < min || max < len) {
Victor Stinner6ced7c42011-03-21 18:15:42 +0100348 if (message == NULL)
349 PyErr_Format(PyExc_TypeError,
350 "%.150s%s takes %s %d argument%s (%ld given)",
351 fname==NULL ? "function" : fname,
352 fname==NULL ? "" : "()",
353 min==max ? "exactly"
354 : len < min ? "at least" : "at most",
355 len < min ? min : max,
356 (len < min ? min : max) == 1 ? "" : "s",
357 Py_SAFE_DOWNCAST(len, Py_ssize_t, long));
358 else
359 PyErr_SetString(PyExc_TypeError, message);
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400360 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000361 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000362
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000363 for (i = 0; i < len; i++) {
364 if (*format == '|')
365 format++;
366 msg = convertitem(PyTuple_GET_ITEM(args, i), &format, p_va,
367 flags, levels, msgbuf,
368 sizeof(msgbuf), &freelist);
369 if (msg) {
Serhiy Storchakac4b813d2016-02-08 01:06:11 +0200370 seterror(i+1, msg, levels, fname, message);
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400371 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000372 }
373 }
Guido van Rossum231a41e1997-12-09 20:36:39 +0000374
Antoine Pitrou4de74572013-02-09 23:11:27 +0100375 if (*format != '\0' && !Py_ISALPHA(Py_CHARMASK(*format)) &&
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000376 *format != '(' &&
377 *format != '|' && *format != ':' && *format != ';') {
378 PyErr_Format(PyExc_SystemError,
379 "bad format string: %.200s", formatsave);
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400380 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000381 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000382
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400383 return cleanreturn(1, &freelist);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000384}
385
386
387
388static void
Victor Stinner84bb1cf2013-05-17 00:12:04 +0200389seterror(Py_ssize_t iarg, const char *msg, int *levels, const char *fname,
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000390 const char *message)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000391{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000392 char buf[512];
393 int i;
394 char *p = buf;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000395
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000396 if (PyErr_Occurred())
397 return;
398 else if (message == NULL) {
399 if (fname != NULL) {
400 PyOS_snprintf(p, sizeof(buf), "%.200s() ", fname);
401 p += strlen(p);
402 }
403 if (iarg != 0) {
404 PyOS_snprintf(p, sizeof(buf) - (p - buf),
Richard Oudkerk25296ce2013-05-18 17:35:19 +0100405 "argument %" PY_FORMAT_SIZE_T "d", iarg);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000406 i = 0;
407 p += strlen(p);
Georg Brandl142ad662013-10-14 07:01:11 +0200408 while (i < 32 && levels[i] > 0 && (int)(p-buf) < 220) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000409 PyOS_snprintf(p, sizeof(buf) - (p - buf),
410 ", item %d", levels[i]-1);
411 p += strlen(p);
412 i++;
413 }
414 }
415 else {
416 PyOS_snprintf(p, sizeof(buf) - (p - buf), "argument");
417 p += strlen(p);
418 }
419 PyOS_snprintf(p, sizeof(buf) - (p - buf), " %.256s", msg);
420 message = buf;
421 }
Serhiy Storchaka4cd63ef2016-02-08 01:22:47 +0200422 if (msg[0] == '(') {
423 PyErr_SetString(PyExc_SystemError, message);
424 }
425 else {
426 PyErr_SetString(PyExc_TypeError, message);
427 }
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000428}
429
430
431/* Convert a tuple argument.
432 On entry, *p_format points to the character _after_ the opening '('.
433 On successful exit, *p_format points to the closing ')'.
434 If successful:
435 *p_format and *p_va are updated,
436 *levels and *msgbuf are untouched,
437 and NULL is returned.
438 If the argument is invalid:
439 *p_format is unchanged,
440 *p_va is undefined,
441 *levels is a 0-terminated list of item numbers,
442 *msgbuf contains an error message, whose format is:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000443 "must be <typename1>, not <typename2>", where:
444 <typename1> is the name of the expected type, and
445 <typename2> is the name of the actual type,
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000446 and msgbuf is returned.
447*/
448
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200449static const char *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000450converttuple(PyObject *arg, const char **p_format, va_list *p_va, int flags,
Guido van Rossum98297ee2007-11-06 21:34:58 +0000451 int *levels, char *msgbuf, size_t bufsize, int toplevel,
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400452 freelist_t *freelist)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000453{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000454 int level = 0;
455 int n = 0;
456 const char *format = *p_format;
457 int i;
Victor Stinner74387f52013-11-18 01:21:12 +0100458 Py_ssize_t len;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000459
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000460 for (;;) {
461 int c = *format++;
462 if (c == '(') {
463 if (level == 0)
464 n++;
465 level++;
466 }
467 else if (c == ')') {
468 if (level == 0)
469 break;
470 level--;
471 }
472 else if (c == ':' || c == ';' || c == '\0')
473 break;
Antoine Pitrou4de74572013-02-09 23:11:27 +0100474 else if (level == 0 && Py_ISALPHA(Py_CHARMASK(c)))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000475 n++;
476 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000477
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000478 if (!PySequence_Check(arg) || PyBytes_Check(arg)) {
479 levels[0] = 0;
480 PyOS_snprintf(msgbuf, bufsize,
481 toplevel ? "expected %d arguments, not %.50s" :
482 "must be %d-item sequence, not %.50s",
483 n,
484 arg == Py_None ? "None" : arg->ob_type->tp_name);
485 return msgbuf;
486 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000487
Victor Stinner74387f52013-11-18 01:21:12 +0100488 len = PySequence_Size(arg);
489 if (len != n) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000490 levels[0] = 0;
Victor Stinner74387f52013-11-18 01:21:12 +0100491 if (toplevel) {
492 PyOS_snprintf(msgbuf, bufsize,
493 "expected %d arguments, not %" PY_FORMAT_SIZE_T "d",
494 n, len);
495 }
496 else {
497 PyOS_snprintf(msgbuf, bufsize,
498 "must be sequence of length %d, "
499 "not %" PY_FORMAT_SIZE_T "d",
500 n, len);
501 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000502 return msgbuf;
503 }
Ka-Ping Yee20579702001-01-15 22:14:16 +0000504
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000505 format = *p_format;
506 for (i = 0; i < n; i++) {
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200507 const char *msg;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000508 PyObject *item;
509 item = PySequence_GetItem(arg, i);
510 if (item == NULL) {
511 PyErr_Clear();
512 levels[0] = i+1;
513 levels[1] = 0;
514 strncpy(msgbuf, "is not retrievable", bufsize);
515 return msgbuf;
516 }
517 msg = convertitem(item, &format, p_va, flags, levels+1,
518 msgbuf, bufsize, freelist);
519 /* PySequence_GetItem calls tp->sq_item, which INCREFs */
520 Py_XDECREF(item);
521 if (msg != NULL) {
522 levels[0] = i+1;
523 return msg;
524 }
525 }
Ka-Ping Yee20579702001-01-15 22:14:16 +0000526
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000527 *p_format = format;
528 return NULL;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000529}
530
531
532/* Convert a single item. */
533
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200534static const char *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000535convertitem(PyObject *arg, const char **p_format, va_list *p_va, int flags,
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400536 int *levels, char *msgbuf, size_t bufsize, freelist_t *freelist)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000537{
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200538 const char *msg;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000539 const char *format = *p_format;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000540
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000541 if (*format == '(' /* ')' */) {
542 format++;
543 msg = converttuple(arg, &format, p_va, flags, levels, msgbuf,
544 bufsize, 0, freelist);
545 if (msg == NULL)
546 format++;
547 }
548 else {
549 msg = convertsimple(arg, &format, p_va, flags,
550 msgbuf, bufsize, freelist);
551 if (msg != NULL)
552 levels[0] = 0;
553 }
554 if (msg == NULL)
555 *p_format = format;
556 return msg;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000557}
558
559
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000560
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000561/* Format an error message generated by convertsimple(). */
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000562
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200563static const char *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000564converterr(const char *expected, PyObject *arg, char *msgbuf, size_t bufsize)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000565{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000566 assert(expected != NULL);
567 assert(arg != NULL);
Serhiy Storchakac4b813d2016-02-08 01:06:11 +0200568 if (expected[0] == '(') {
569 PyOS_snprintf(msgbuf, bufsize,
570 "%.100s", expected);
571 }
572 else {
573 PyOS_snprintf(msgbuf, bufsize,
574 "must be %.50s, not %.50s", expected,
575 arg == Py_None ? "None" : arg->ob_type->tp_name);
576 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000577 return msgbuf;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000578}
579
580#define CONV_UNICODE "(unicode conversion error)"
581
Guido van Rossum45aecf42006-03-15 04:58:47 +0000582/* Explicitly check for float arguments when integers are expected.
583 Return 1 for error, 0 if ok. */
Neil Schemenauer5042da62003-02-04 20:59:40 +0000584static int
585float_argument_error(PyObject *arg)
586{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000587 if (PyFloat_Check(arg)) {
588 PyErr_SetString(PyExc_TypeError,
589 "integer argument expected, got float" );
590 return 1;
591 }
592 else
593 return 0;
Neil Schemenauer5042da62003-02-04 20:59:40 +0000594}
595
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000596/* Convert a non-tuple argument. Return NULL if conversion went OK,
597 or a string with a message describing the failure. The message is
598 formatted as "must be <desired type>, not <actual type>".
599 When failing, an exception may or may not have been raised.
Georg Brandl6dd14612005-09-14 19:29:53 +0000600 Don't call if a tuple is expected.
601
602 When you add new format codes, please don't forget poor skipitem() below.
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000603*/
604
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200605static const char *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000606convertsimple(PyObject *arg, const char **p_format, va_list *p_va, int flags,
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400607 char *msgbuf, size_t bufsize, freelist_t *freelist)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000608{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000609 /* For # codes */
610#define FETCH_SIZE int *q=NULL;Py_ssize_t *q2=NULL;\
611 if (flags & FLAG_SIZE_T) q2=va_arg(*p_va, Py_ssize_t*); \
612 else q=va_arg(*p_va, int*);
Victor Stinnerb3c9e072011-01-04 02:07:34 +0000613#define STORE_SIZE(s) \
614 if (flags & FLAG_SIZE_T) \
615 *q2=s; \
616 else { \
617 if (INT_MAX < s) { \
618 PyErr_SetString(PyExc_OverflowError, \
619 "size does not fit in an int"); \
620 return converterr("", arg, msgbuf, bufsize); \
621 } \
Victor Stinner9550ef32013-06-05 01:18:13 +0200622 *q = (int)s; \
Victor Stinnerb3c9e072011-01-04 02:07:34 +0000623 }
Martin v. Löwis18e16552006-02-15 17:27:45 +0000624#define BUFFER_LEN ((flags & FLAG_SIZE_T) ? *q2:*q)
Victor Stinner6ab8e822011-01-04 11:16:49 +0000625#define RETURN_ERR_OCCURRED return msgbuf
Martin v. Löwis18e16552006-02-15 17:27:45 +0000626
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000627 const char *format = *p_format;
628 char c = *format++;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200629 char *sarg;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000630
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000631 switch (c) {
Guido van Rossum98297ee2007-11-06 21:34:58 +0000632
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000633 case 'b': { /* unsigned byte -- very short int */
634 char *p = va_arg(*p_va, char *);
635 long ival;
636 if (float_argument_error(arg))
Victor Stinner6ab8e822011-01-04 11:16:49 +0000637 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000638 ival = PyLong_AsLong(arg);
639 if (ival == -1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000640 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000641 else if (ival < 0) {
642 PyErr_SetString(PyExc_OverflowError,
Victor Stinner6ab8e822011-01-04 11:16:49 +0000643 "unsigned byte integer is less than minimum");
644 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000645 }
646 else if (ival > UCHAR_MAX) {
647 PyErr_SetString(PyExc_OverflowError,
Victor Stinner6ab8e822011-01-04 11:16:49 +0000648 "unsigned byte integer is greater than maximum");
649 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000650 }
651 else
652 *p = (unsigned char) ival;
653 break;
654 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000655
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000656 case 'B': {/* byte sized bitfield - both signed and unsigned
657 values allowed */
658 char *p = va_arg(*p_va, char *);
659 long ival;
660 if (float_argument_error(arg))
Victor Stinner6ab8e822011-01-04 11:16:49 +0000661 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000662 ival = PyLong_AsUnsignedLongMask(arg);
663 if (ival == -1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000664 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000665 else
666 *p = (unsigned char) ival;
667 break;
668 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000669
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000670 case 'h': {/* signed short int */
671 short *p = va_arg(*p_va, short *);
672 long ival;
673 if (float_argument_error(arg))
Victor Stinner6ab8e822011-01-04 11:16:49 +0000674 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000675 ival = PyLong_AsLong(arg);
676 if (ival == -1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000677 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000678 else if (ival < SHRT_MIN) {
679 PyErr_SetString(PyExc_OverflowError,
Victor Stinner6ab8e822011-01-04 11:16:49 +0000680 "signed short integer is less than minimum");
681 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000682 }
683 else if (ival > SHRT_MAX) {
684 PyErr_SetString(PyExc_OverflowError,
Victor Stinner6ab8e822011-01-04 11:16:49 +0000685 "signed short integer is greater than maximum");
686 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000687 }
688 else
689 *p = (short) ival;
690 break;
691 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000692
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000693 case 'H': { /* short int sized bitfield, both signed and
694 unsigned allowed */
695 unsigned short *p = va_arg(*p_va, unsigned short *);
696 long ival;
697 if (float_argument_error(arg))
Victor Stinner6ab8e822011-01-04 11:16:49 +0000698 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000699 ival = PyLong_AsUnsignedLongMask(arg);
700 if (ival == -1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000701 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000702 else
703 *p = (unsigned short) ival;
704 break;
705 }
Martin v. Löwis18e16552006-02-15 17:27:45 +0000706
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000707 case 'i': {/* signed int */
708 int *p = va_arg(*p_va, int *);
709 long ival;
710 if (float_argument_error(arg))
Victor Stinner6ab8e822011-01-04 11:16:49 +0000711 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000712 ival = PyLong_AsLong(arg);
713 if (ival == -1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000714 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000715 else if (ival > INT_MAX) {
716 PyErr_SetString(PyExc_OverflowError,
Victor Stinner6ab8e822011-01-04 11:16:49 +0000717 "signed integer is greater than maximum");
718 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000719 }
720 else if (ival < INT_MIN) {
721 PyErr_SetString(PyExc_OverflowError,
Victor Stinner6ab8e822011-01-04 11:16:49 +0000722 "signed integer is less than minimum");
723 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000724 }
725 else
726 *p = ival;
727 break;
728 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000729
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000730 case 'I': { /* int sized bitfield, both signed and
731 unsigned allowed */
732 unsigned int *p = va_arg(*p_va, unsigned int *);
733 unsigned int ival;
734 if (float_argument_error(arg))
Victor Stinner6ab8e822011-01-04 11:16:49 +0000735 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000736 ival = (unsigned int)PyLong_AsUnsignedLongMask(arg);
737 if (ival == (unsigned int)-1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000738 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000739 else
740 *p = ival;
741 break;
742 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000743
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000744 case 'n': /* Py_ssize_t */
745 {
746 PyObject *iobj;
747 Py_ssize_t *p = va_arg(*p_va, Py_ssize_t *);
748 Py_ssize_t ival = -1;
749 if (float_argument_error(arg))
Victor Stinner6ab8e822011-01-04 11:16:49 +0000750 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000751 iobj = PyNumber_Index(arg);
752 if (iobj != NULL) {
753 ival = PyLong_AsSsize_t(iobj);
754 Py_DECREF(iobj);
755 }
756 if (ival == -1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000757 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000758 *p = ival;
759 break;
760 }
761 case 'l': {/* long int */
762 long *p = va_arg(*p_va, long *);
763 long ival;
764 if (float_argument_error(arg))
Victor Stinner6ab8e822011-01-04 11:16:49 +0000765 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000766 ival = PyLong_AsLong(arg);
767 if (ival == -1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000768 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000769 else
770 *p = ival;
771 break;
772 }
Thomas Hellera4ea6032003-04-17 18:55:45 +0000773
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000774 case 'k': { /* long sized bitfield */
775 unsigned long *p = va_arg(*p_va, unsigned long *);
776 unsigned long ival;
777 if (PyLong_Check(arg))
778 ival = PyLong_AsUnsignedLongMask(arg);
779 else
Serhiy Storchakac4b813d2016-02-08 01:06:11 +0200780 return converterr("int", arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000781 *p = ival;
782 break;
783 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000784
Benjamin Petersonaf580df2016-09-06 10:46:49 -0700785 case 'L': {/* long long */
786 long long *p = va_arg( *p_va, long long * );
787 long long ival;
Mark Dickinsonc7301312010-06-10 16:05:10 +0000788 if (float_argument_error(arg))
Victor Stinner6ab8e822011-01-04 11:16:49 +0000789 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000790 ival = PyLong_AsLongLong(arg);
Benjamin Petersonaf580df2016-09-06 10:46:49 -0700791 if (ival == (long long)-1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000792 RETURN_ERR_OCCURRED;
Mark Dickinsonc7301312010-06-10 16:05:10 +0000793 else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000794 *p = ival;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000795 break;
796 }
Thomas Hellera4ea6032003-04-17 18:55:45 +0000797
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000798 case 'K': { /* long long sized bitfield */
Benjamin Petersonaf580df2016-09-06 10:46:49 -0700799 unsigned long long *p = va_arg(*p_va, unsigned long long *);
800 unsigned long long ival;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000801 if (PyLong_Check(arg))
802 ival = PyLong_AsUnsignedLongLongMask(arg);
803 else
Serhiy Storchakac4b813d2016-02-08 01:06:11 +0200804 return converterr("int", arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000805 *p = ival;
806 break;
807 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000808
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000809 case 'f': {/* float */
810 float *p = va_arg(*p_va, float *);
811 double dval = PyFloat_AsDouble(arg);
812 if (PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000813 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000814 else
815 *p = (float) dval;
816 break;
817 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000818
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000819 case 'd': {/* double */
820 double *p = va_arg(*p_va, double *);
821 double dval = PyFloat_AsDouble(arg);
822 if (PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000823 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000824 else
825 *p = dval;
826 break;
827 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000828
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000829 case 'D': {/* complex double */
830 Py_complex *p = va_arg(*p_va, Py_complex *);
831 Py_complex cval;
832 cval = PyComplex_AsCComplex(arg);
833 if (PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000834 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000835 else
836 *p = cval;
837 break;
838 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000839
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000840 case 'c': {/* char */
841 char *p = va_arg(*p_va, char *);
842 if (PyBytes_Check(arg) && PyBytes_Size(arg) == 1)
843 *p = PyBytes_AS_STRING(arg)[0];
Eli Bendersky906b88f2011-07-29 07:05:08 +0300844 else if (PyByteArray_Check(arg) && PyByteArray_Size(arg) == 1)
845 *p = PyByteArray_AS_STRING(arg)[0];
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000846 else
847 return converterr("a byte string of length 1", arg, msgbuf, bufsize);
848 break;
849 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000850
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000851 case 'C': {/* unicode char */
852 int *p = va_arg(*p_va, int *);
Victor Stinnere1335c72011-10-04 20:53:03 +0200853 int kind;
854 void *data;
855
856 if (!PyUnicode_Check(arg))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000857 return converterr("a unicode character", arg, msgbuf, bufsize);
Victor Stinnere1335c72011-10-04 20:53:03 +0200858
859 if (PyUnicode_READY(arg))
860 RETURN_ERR_OCCURRED;
861
862 if (PyUnicode_GET_LENGTH(arg) != 1)
863 return converterr("a unicode character", arg, msgbuf, bufsize);
864
865 kind = PyUnicode_KIND(arg);
866 data = PyUnicode_DATA(arg);
867 *p = PyUnicode_READ(kind, data, 0);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000868 break;
869 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000870
Larry Hastingsfaf91e72012-05-05 16:54:29 -0700871 case 'p': {/* boolean *p*redicate */
872 int *p = va_arg(*p_va, int *);
873 int val = PyObject_IsTrue(arg);
874 if (val > 0)
875 *p = 1;
876 else if (val == 0)
877 *p = 0;
878 else
879 RETURN_ERR_OCCURRED;
880 break;
881 }
882
Victor Stinner3dcb5ac2010-06-08 22:54:19 +0000883 /* XXX WAAAAH! 's', 'y', 'z', 'u', 'Z', 'e', 'w' codes all
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000884 need to be cleaned up! */
Guido van Rossum98297ee2007-11-06 21:34:58 +0000885
Serhiy Storchakab757c832014-12-05 22:25:22 +0200886 case 'y': {/* any bytes-like object */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000887 void **p = (void **)va_arg(*p_va, char **);
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200888 const char *buf;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000889 Py_ssize_t count;
890 if (*format == '*') {
891 if (getbuffer(arg, (Py_buffer*)p, &buf) < 0)
892 return converterr(buf, arg, msgbuf, bufsize);
893 format++;
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400894 if (addcleanup(p, freelist, cleanup_buffer)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000895 return converterr(
896 "(cleanup problem)",
897 arg, msgbuf, bufsize);
898 }
899 break;
900 }
901 count = convertbuffer(arg, p, &buf);
902 if (count < 0)
903 return converterr(buf, arg, msgbuf, bufsize);
Victor Stinner06e49dd2010-06-13 18:21:50 +0000904 if (*format == '#') {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000905 FETCH_SIZE;
906 STORE_SIZE(count);
907 format++;
Victor Stinner06e49dd2010-06-13 18:21:50 +0000908 } else {
Serhiy Storchakad8a14472014-09-06 20:07:17 +0300909 if (strlen(*p) != (size_t)count) {
910 PyErr_SetString(PyExc_ValueError, "embedded null byte");
911 RETURN_ERR_OCCURRED;
912 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000913 }
914 break;
915 }
Walter Dörwald612344f2007-05-04 19:28:21 +0000916
Serhiy Storchakab757c832014-12-05 22:25:22 +0200917 case 's': /* text string or bytes-like object */
918 case 'z': /* text string, bytes-like object or None */
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000919 {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000920 if (*format == '*') {
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000921 /* "s*" or "z*" */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000922 Py_buffer *p = (Py_buffer *)va_arg(*p_va, Py_buffer *);
Martin v. Löwis423be952008-08-13 15:53:07 +0000923
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000924 if (c == 'z' && arg == Py_None)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000925 PyBuffer_FillInfo(p, NULL, NULL, 0, 1, 0);
926 else if (PyUnicode_Check(arg)) {
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200927 Py_ssize_t len;
928 sarg = PyUnicode_AsUTF8AndSize(arg, &len);
929 if (sarg == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000930 return converterr(CONV_UNICODE,
931 arg, msgbuf, bufsize);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200932 PyBuffer_FillInfo(p, arg, sarg, len, 1, 0);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000933 }
Serhiy Storchakab757c832014-12-05 22:25:22 +0200934 else { /* any bytes-like object */
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200935 const char *buf;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000936 if (getbuffer(arg, p, &buf) < 0)
937 return converterr(buf, arg, msgbuf, bufsize);
938 }
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400939 if (addcleanup(p, freelist, cleanup_buffer)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000940 return converterr(
941 "(cleanup problem)",
942 arg, msgbuf, bufsize);
943 }
944 format++;
Serhiy Storchakab757c832014-12-05 22:25:22 +0200945 } else if (*format == '#') { /* a string or read-only bytes-like object */
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000946 /* "s#" or "z#" */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000947 void **p = (void **)va_arg(*p_va, char **);
948 FETCH_SIZE;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000949
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000950 if (c == 'z' && arg == Py_None) {
951 *p = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000952 STORE_SIZE(0);
953 }
954 else if (PyUnicode_Check(arg)) {
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200955 Py_ssize_t len;
956 sarg = PyUnicode_AsUTF8AndSize(arg, &len);
957 if (sarg == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000958 return converterr(CONV_UNICODE,
959 arg, msgbuf, bufsize);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200960 *p = sarg;
961 STORE_SIZE(len);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000962 }
Serhiy Storchakab757c832014-12-05 22:25:22 +0200963 else { /* read-only bytes-like object */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000964 /* XXX Really? */
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200965 const char *buf;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000966 Py_ssize_t count = convertbuffer(arg, p, &buf);
967 if (count < 0)
968 return converterr(buf, arg, msgbuf, bufsize);
969 STORE_SIZE(count);
970 }
971 format++;
972 } else {
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000973 /* "s" or "z" */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000974 char **p = va_arg(*p_va, char **);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200975 Py_ssize_t len;
976 sarg = NULL;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000977
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000978 if (c == 'z' && arg == Py_None)
979 *p = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000980 else if (PyUnicode_Check(arg)) {
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200981 sarg = PyUnicode_AsUTF8AndSize(arg, &len);
982 if (sarg == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000983 return converterr(CONV_UNICODE,
984 arg, msgbuf, bufsize);
Serhiy Storchakad8a14472014-09-06 20:07:17 +0300985 if (strlen(sarg) != (size_t)len) {
986 PyErr_SetString(PyExc_ValueError, "embedded null character");
987 RETURN_ERR_OCCURRED;
988 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200989 *p = sarg;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000990 }
991 else
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000992 return converterr(c == 'z' ? "str or None" : "str",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000993 arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000994 }
995 break;
996 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000997
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000998 case 'u': /* raw unicode buffer (Py_UNICODE *) */
999 case 'Z': /* raw unicode buffer or None */
1000 {
Brett Cannonb94767f2011-02-22 20:15:44 +00001001 Py_UNICODE **p = va_arg(*p_va, Py_UNICODE **);
1002
Serhiy Storchakab757c832014-12-05 22:25:22 +02001003 if (*format == '#') {
Serhiy Storchakad6e53da2015-04-19 21:11:30 +03001004 /* "u#" or "Z#" */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001005 FETCH_SIZE;
Travis E. Oliphantddacf962007-10-13 21:03:27 +00001006
Victor Stinner3c9e6e92010-06-24 22:31:12 +00001007 if (c == 'Z' && arg == Py_None) {
1008 *p = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001009 STORE_SIZE(0);
1010 }
1011 else if (PyUnicode_Check(arg)) {
Victor Stinnerbeac78b2011-10-11 21:55:01 +02001012 Py_ssize_t len;
1013 *p = PyUnicode_AsUnicodeAndSize(arg, &len);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001014 if (*p == NULL)
1015 RETURN_ERR_OCCURRED;
Victor Stinnerbeac78b2011-10-11 21:55:01 +02001016 STORE_SIZE(len);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001017 }
Victor Stinner5216e6d2010-06-08 21:45:51 +00001018 else
Serhiy Storchakad6e53da2015-04-19 21:11:30 +03001019 return converterr(c == 'Z' ? "str or None" : "str",
1020 arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001021 format++;
1022 } else {
Serhiy Storchakad6e53da2015-04-19 21:11:30 +03001023 /* "u" or "Z" */
Victor Stinner3c9e6e92010-06-24 22:31:12 +00001024 if (c == 'Z' && arg == Py_None)
1025 *p = NULL;
Victor Stinner06e49dd2010-06-13 18:21:50 +00001026 else if (PyUnicode_Check(arg)) {
Victor Stinnerbeac78b2011-10-11 21:55:01 +02001027 Py_ssize_t len;
1028 *p = PyUnicode_AsUnicodeAndSize(arg, &len);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001029 if (*p == NULL)
1030 RETURN_ERR_OCCURRED;
Serhiy Storchakad8a14472014-09-06 20:07:17 +03001031 if (Py_UNICODE_strlen(*p) != (size_t)len) {
1032 PyErr_SetString(PyExc_ValueError, "embedded null character");
1033 RETURN_ERR_OCCURRED;
1034 }
Victor Stinner06e49dd2010-06-13 18:21:50 +00001035 } else
Victor Stinner3c9e6e92010-06-24 22:31:12 +00001036 return converterr(c == 'Z' ? "str or None" : "str",
1037 arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001038 }
1039 break;
1040 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001041
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001042 case 'e': {/* encoded string */
1043 char **buffer;
1044 const char *encoding;
1045 PyObject *s;
1046 int recode_strings;
1047 Py_ssize_t size;
1048 const char *ptr;
Jeremy Hylton4819e972001-10-11 14:40:37 +00001049
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001050 /* Get 'e' parameter: the encoding name */
1051 encoding = (const char *)va_arg(*p_va, const char *);
1052 if (encoding == NULL)
1053 encoding = PyUnicode_GetDefaultEncoding();
Martin v. Löwis423be952008-08-13 15:53:07 +00001054
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001055 /* Get output buffer parameter:
1056 's' (recode all objects via Unicode) or
1057 't' (only recode non-string objects)
1058 */
1059 if (*format == 's')
1060 recode_strings = 1;
1061 else if (*format == 't')
1062 recode_strings = 0;
1063 else
1064 return converterr(
1065 "(unknown parser marker combination)",
1066 arg, msgbuf, bufsize);
1067 buffer = (char **)va_arg(*p_va, char **);
1068 format++;
1069 if (buffer == NULL)
1070 return converterr("(buffer is NULL)",
1071 arg, msgbuf, bufsize);
Benjamin Peterson9edd2bd2008-08-27 00:31:37 +00001072
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001073 /* Encode object */
1074 if (!recode_strings &&
1075 (PyBytes_Check(arg) || PyByteArray_Check(arg))) {
1076 s = arg;
1077 Py_INCREF(s);
1078 if (PyObject_AsCharBuffer(s, &ptr, &size) < 0)
1079 return converterr("(AsCharBuffer failed)",
1080 arg, msgbuf, bufsize);
1081 }
Serhiy Storchaka21a663e2016-04-13 15:37:23 +03001082 else if (PyUnicode_Check(arg)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001083 /* Encode object; use default error handling */
Serhiy Storchaka21a663e2016-04-13 15:37:23 +03001084 s = PyUnicode_AsEncodedString(arg,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001085 encoding,
1086 NULL);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001087 if (s == NULL)
1088 return converterr("(encoding failed)",
1089 arg, msgbuf, bufsize);
Serhiy Storchaka21a663e2016-04-13 15:37:23 +03001090 assert(PyBytes_Check(s));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001091 size = PyBytes_GET_SIZE(s);
1092 ptr = PyBytes_AS_STRING(s);
1093 if (ptr == NULL)
1094 ptr = "";
1095 }
Serhiy Storchaka21a663e2016-04-13 15:37:23 +03001096 else {
1097 return converterr(
1098 recode_strings ? "str" : "str, bytes or bytearray",
1099 arg, msgbuf, bufsize);
1100 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001101
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001102 /* Write output; output is guaranteed to be 0-terminated */
1103 if (*format == '#') {
1104 /* Using buffer length parameter '#':
1105
1106 - if *buffer is NULL, a new buffer of the
1107 needed size is allocated and the data
1108 copied into it; *buffer is updated to point
1109 to the new buffer; the caller is
1110 responsible for PyMem_Free()ing it after
1111 usage
1112
1113 - if *buffer is not NULL, the data is
1114 copied to *buffer; *buffer_len has to be
1115 set to the size of the buffer on input;
1116 buffer overflow is signalled with an error;
1117 buffer has to provide enough room for the
1118 encoded string plus the trailing 0-byte
1119
1120 - in both cases, *buffer_len is updated to
1121 the size of the buffer /excluding/ the
1122 trailing 0-byte
1123
1124 */
1125 FETCH_SIZE;
1126
1127 format++;
1128 if (q == NULL && q2 == NULL) {
1129 Py_DECREF(s);
1130 return converterr(
1131 "(buffer_len is NULL)",
1132 arg, msgbuf, bufsize);
1133 }
1134 if (*buffer == NULL) {
1135 *buffer = PyMem_NEW(char, size + 1);
1136 if (*buffer == NULL) {
1137 Py_DECREF(s);
Victor Stinner2872e5b2010-06-06 20:38:02 +00001138 PyErr_NoMemory();
Victor Stinner6ab8e822011-01-04 11:16:49 +00001139 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001140 }
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001141 if (addcleanup(*buffer, freelist, cleanup_ptr)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001142 Py_DECREF(s);
1143 return converterr(
1144 "(cleanup problem)",
1145 arg, msgbuf, bufsize);
1146 }
1147 } else {
1148 if (size + 1 > BUFFER_LEN) {
1149 Py_DECREF(s);
Serhiy Storchaka4cd63ef2016-02-08 01:22:47 +02001150 PyErr_Format(PyExc_ValueError,
Serhiy Storchakac4b813d2016-02-08 01:06:11 +02001151 "encoded string too long "
1152 "(%zd, maximum length %zd)",
1153 (Py_ssize_t)size, (Py_ssize_t)(BUFFER_LEN-1));
1154 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001155 }
1156 }
1157 memcpy(*buffer, ptr, size+1);
1158 STORE_SIZE(size);
1159 } else {
1160 /* Using a 0-terminated buffer:
1161
1162 - the encoded string has to be 0-terminated
1163 for this variant to work; if it is not, an
1164 error raised
1165
1166 - a new buffer of the needed size is
1167 allocated and the data copied into it;
1168 *buffer is updated to point to the new
1169 buffer; the caller is responsible for
1170 PyMem_Free()ing it after usage
1171
1172 */
1173 if ((Py_ssize_t)strlen(ptr) != size) {
1174 Py_DECREF(s);
1175 return converterr(
Serhiy Storchakac4b813d2016-02-08 01:06:11 +02001176 "encoded string without null bytes",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001177 arg, msgbuf, bufsize);
1178 }
1179 *buffer = PyMem_NEW(char, size + 1);
1180 if (*buffer == NULL) {
1181 Py_DECREF(s);
Victor Stinner2872e5b2010-06-06 20:38:02 +00001182 PyErr_NoMemory();
Victor Stinner6ab8e822011-01-04 11:16:49 +00001183 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001184 }
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001185 if (addcleanup(*buffer, freelist, cleanup_ptr)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001186 Py_DECREF(s);
1187 return converterr("(cleanup problem)",
1188 arg, msgbuf, bufsize);
1189 }
1190 memcpy(*buffer, ptr, size+1);
1191 }
1192 Py_DECREF(s);
1193 break;
1194 }
1195
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001196 case 'S': { /* PyBytes object */
1197 PyObject **p = va_arg(*p_va, PyObject **);
1198 if (PyBytes_Check(arg))
1199 *p = arg;
1200 else
1201 return converterr("bytes", arg, msgbuf, bufsize);
1202 break;
1203 }
1204
1205 case 'Y': { /* PyByteArray object */
1206 PyObject **p = va_arg(*p_va, PyObject **);
1207 if (PyByteArray_Check(arg))
1208 *p = arg;
1209 else
Victor Stinner5216e6d2010-06-08 21:45:51 +00001210 return converterr("bytearray", arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001211 break;
1212 }
1213
1214 case 'U': { /* PyUnicode object */
1215 PyObject **p = va_arg(*p_va, PyObject **);
Victor Stinnera1b0c9f2012-05-29 12:30:29 +02001216 if (PyUnicode_Check(arg)) {
1217 if (PyUnicode_READY(arg) == -1)
1218 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001219 *p = arg;
Victor Stinnera1b0c9f2012-05-29 12:30:29 +02001220 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001221 else
1222 return converterr("str", arg, msgbuf, bufsize);
1223 break;
1224 }
1225
1226 case 'O': { /* object */
1227 PyTypeObject *type;
1228 PyObject **p;
1229 if (*format == '!') {
1230 type = va_arg(*p_va, PyTypeObject*);
1231 p = va_arg(*p_va, PyObject **);
1232 format++;
1233 if (PyType_IsSubtype(arg->ob_type, type))
1234 *p = arg;
1235 else
1236 return converterr(type->tp_name, arg, msgbuf, bufsize);
1237
1238 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001239 else if (*format == '&') {
1240 typedef int (*converter)(PyObject *, void *);
1241 converter convert = va_arg(*p_va, converter);
1242 void *addr = va_arg(*p_va, void *);
1243 int res;
1244 format++;
1245 if (! (res = (*convert)(arg, addr)))
1246 return converterr("(unspecified)",
1247 arg, msgbuf, bufsize);
1248 if (res == Py_CLEANUP_SUPPORTED &&
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001249 addcleanup(addr, freelist, convert) == -1)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001250 return converterr("(cleanup problem)",
1251 arg, msgbuf, bufsize);
1252 }
1253 else {
1254 p = va_arg(*p_va, PyObject **);
1255 *p = arg;
1256 }
1257 break;
1258 }
1259
1260
Victor Stinner25e8ec42010-06-25 00:02:38 +00001261 case 'w': { /* "w*": memory buffer, read-write access */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001262 void **p = va_arg(*p_va, void **);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001263
Victor Stinner25e8ec42010-06-25 00:02:38 +00001264 if (*format != '*')
1265 return converterr(
Serhiy Storchakac4b813d2016-02-08 01:06:11 +02001266 "(invalid use of 'w' format character)",
Victor Stinner25e8ec42010-06-25 00:02:38 +00001267 arg, msgbuf, bufsize);
1268 format++;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001269
Victor Stinner25e8ec42010-06-25 00:02:38 +00001270 /* Caller is interested in Py_buffer, and the object
1271 supports it directly. */
1272 if (PyObject_GetBuffer(arg, (Py_buffer*)p, PyBUF_WRITABLE) < 0) {
1273 PyErr_Clear();
R David Murray861470c2014-10-05 11:47:01 -04001274 return converterr("read-write bytes-like object",
1275 arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001276 }
Victor Stinner8182b712010-07-28 00:40:58 +00001277 if (!PyBuffer_IsContiguous((Py_buffer*)p, 'C')) {
1278 PyBuffer_Release((Py_buffer*)p);
1279 return converterr("contiguous buffer", arg, msgbuf, bufsize);
1280 }
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001281 if (addcleanup(p, freelist, cleanup_buffer)) {
Victor Stinner25e8ec42010-06-25 00:02:38 +00001282 return converterr(
1283 "(cleanup problem)",
1284 arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001285 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001286 break;
1287 }
1288
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001289 default:
Serhiy Storchakac4b813d2016-02-08 01:06:11 +02001290 return converterr("(impossible<bad format char>)", arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001291
1292 }
1293
1294 *p_format = format;
1295 return NULL;
Victor Stinner6ab8e822011-01-04 11:16:49 +00001296
1297#undef FETCH_SIZE
1298#undef STORE_SIZE
1299#undef BUFFER_LEN
1300#undef RETURN_ERR_OCCURRED
Guido van Rossumfe3f1a21994-09-29 09:42:55 +00001301}
Guido van Rossumaa354651996-08-19 19:32:04 +00001302
Martin v. Löwis18e16552006-02-15 17:27:45 +00001303static Py_ssize_t
Serhiy Storchakaef1585e2015-12-25 20:01:53 +02001304convertbuffer(PyObject *arg, void **p, const char **errmsg)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001305{
Victor Stinner5cb62392010-06-06 20:27:51 +00001306 PyBufferProcs *pb = Py_TYPE(arg)->tp_as_buffer;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001307 Py_ssize_t count;
1308 Py_buffer view;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001309
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001310 *errmsg = NULL;
1311 *p = NULL;
Victor Stinner8182b712010-07-28 00:40:58 +00001312 if (pb != NULL && pb->bf_releasebuffer != NULL) {
R David Murray861470c2014-10-05 11:47:01 -04001313 *errmsg = "read-only bytes-like object";
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001314 return -1;
1315 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001316
Victor Stinner8182b712010-07-28 00:40:58 +00001317 if (getbuffer(arg, &view, errmsg) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001318 return -1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001319 count = view.len;
1320 *p = view.buf;
1321 PyBuffer_Release(&view);
1322 return count;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001323}
Guido van Rossumaa354651996-08-19 19:32:04 +00001324
Martin v. Löwis423be952008-08-13 15:53:07 +00001325static int
Serhiy Storchakaef1585e2015-12-25 20:01:53 +02001326getbuffer(PyObject *arg, Py_buffer *view, const char **errmsg)
Martin v. Löwis423be952008-08-13 15:53:07 +00001327{
Victor Stinner8182b712010-07-28 00:40:58 +00001328 if (PyObject_GetBuffer(arg, view, PyBUF_SIMPLE) != 0) {
R David Murray861470c2014-10-05 11:47:01 -04001329 *errmsg = "bytes-like object";
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001330 return -1;
1331 }
Victor Stinner5cb62392010-06-06 20:27:51 +00001332 if (!PyBuffer_IsContiguous(view, 'C')) {
Victor Stinner21e09482010-06-24 22:57:10 +00001333 PyBuffer_Release(view);
Victor Stinner5cb62392010-06-06 20:27:51 +00001334 *errmsg = "contiguous buffer";
1335 return -1;
1336 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001337 return 0;
Martin v. Löwis423be952008-08-13 15:53:07 +00001338}
1339
Guido van Rossumaa354651996-08-19 19:32:04 +00001340/* Support for keyword arguments donated by
1341 Geoff Philbrick <philbric@delphi.hks.com> */
1342
Tim Petersf8cd3e82001-10-27 04:26:57 +00001343/* Return false (0) for error, else true. */
Fred Drake563dfc22001-10-23 14:41:08 +00001344int
1345PyArg_ParseTupleAndKeywords(PyObject *args,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001346 PyObject *keywords,
1347 const char *format,
1348 char **kwlist, ...)
Guido van Rossumaa354651996-08-19 19:32:04 +00001349{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001350 int retval;
1351 va_list va;
Tim Peters45772cd2001-10-27 03:58:40 +00001352
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001353 if ((args == NULL || !PyTuple_Check(args)) ||
1354 (keywords != NULL && !PyDict_Check(keywords)) ||
1355 format == NULL ||
1356 kwlist == NULL)
1357 {
1358 PyErr_BadInternalCall();
1359 return 0;
1360 }
Tim Peters45772cd2001-10-27 03:58:40 +00001361
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001362 va_start(va, kwlist);
1363 retval = vgetargskeywords(args, keywords, format, kwlist, &va, 0);
1364 va_end(va);
1365 return retval;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001366}
1367
1368int
1369_PyArg_ParseTupleAndKeywords_SizeT(PyObject *args,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001370 PyObject *keywords,
1371 const char *format,
1372 char **kwlist, ...)
Martin v. Löwis18e16552006-02-15 17:27:45 +00001373{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001374 int retval;
1375 va_list va;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001376
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001377 if ((args == NULL || !PyTuple_Check(args)) ||
1378 (keywords != NULL && !PyDict_Check(keywords)) ||
1379 format == NULL ||
1380 kwlist == NULL)
1381 {
1382 PyErr_BadInternalCall();
1383 return 0;
1384 }
Martin v. Löwis18e16552006-02-15 17:27:45 +00001385
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001386 va_start(va, kwlist);
1387 retval = vgetargskeywords(args, keywords, format,
1388 kwlist, &va, FLAG_SIZE_T);
1389 va_end(va);
1390 return retval;
Guido van Rossumaa354651996-08-19 19:32:04 +00001391}
1392
1393
Brett Cannon711e7d92004-07-10 22:20:32 +00001394int
1395PyArg_VaParseTupleAndKeywords(PyObject *args,
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001396 PyObject *keywords,
Guido van Rossum98297ee2007-11-06 21:34:58 +00001397 const char *format,
Martin v. Löwis15e62742006-02-27 16:46:16 +00001398 char **kwlist, va_list va)
Brett Cannon711e7d92004-07-10 22:20:32 +00001399{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001400 int retval;
1401 va_list lva;
Brett Cannon711e7d92004-07-10 22:20:32 +00001402
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001403 if ((args == NULL || !PyTuple_Check(args)) ||
1404 (keywords != NULL && !PyDict_Check(keywords)) ||
1405 format == NULL ||
1406 kwlist == NULL)
1407 {
1408 PyErr_BadInternalCall();
1409 return 0;
1410 }
Brett Cannon711e7d92004-07-10 22:20:32 +00001411
Benjamin Peterson0c212142016-09-20 20:39:33 -07001412 va_copy(lva, va);
Brett Cannon711e7d92004-07-10 22:20:32 +00001413
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001414 retval = vgetargskeywords(args, keywords, format, kwlist, &lva, 0);
Christian Heimes2f2fee12016-09-21 11:37:27 +02001415 va_end(lva);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001416 return retval;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001417}
1418
1419int
1420_PyArg_VaParseTupleAndKeywords_SizeT(PyObject *args,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001421 PyObject *keywords,
1422 const char *format,
1423 char **kwlist, va_list va)
Martin v. Löwis18e16552006-02-15 17:27:45 +00001424{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001425 int retval;
1426 va_list lva;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001427
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001428 if ((args == NULL || !PyTuple_Check(args)) ||
1429 (keywords != NULL && !PyDict_Check(keywords)) ||
1430 format == NULL ||
1431 kwlist == NULL)
1432 {
1433 PyErr_BadInternalCall();
1434 return 0;
1435 }
Martin v. Löwis18e16552006-02-15 17:27:45 +00001436
Benjamin Peterson0c212142016-09-20 20:39:33 -07001437 va_copy(lva, va);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001438
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001439 retval = vgetargskeywords(args, keywords, format,
1440 kwlist, &lva, FLAG_SIZE_T);
Christian Heimes2f2fee12016-09-21 11:37:27 +02001441 va_end(lva);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001442 return retval;
Brett Cannon711e7d92004-07-10 22:20:32 +00001443}
1444
Benjamin Petersonfb886362010-04-24 18:21:17 +00001445int
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001446_PyArg_ParseTupleAndKeywordsFast(PyObject *args, PyObject *keywords,
1447 struct _PyArg_Parser *parser, ...)
1448{
1449 int retval;
1450 va_list va;
1451
1452 if ((args == NULL || !PyTuple_Check(args)) ||
1453 (keywords != NULL && !PyDict_Check(keywords)) ||
1454 parser == NULL)
1455 {
1456 PyErr_BadInternalCall();
1457 return 0;
1458 }
1459
1460 va_start(va, parser);
1461 retval = vgetargskeywordsfast(args, keywords, parser, &va, 0);
1462 va_end(va);
1463 return retval;
1464}
1465
1466int
1467_PyArg_ParseTupleAndKeywordsFast_SizeT(PyObject *args, PyObject *keywords,
1468 struct _PyArg_Parser *parser, ...)
1469{
1470 int retval;
1471 va_list va;
1472
1473 if ((args == NULL || !PyTuple_Check(args)) ||
1474 (keywords != NULL && !PyDict_Check(keywords)) ||
1475 parser == NULL)
1476 {
1477 PyErr_BadInternalCall();
1478 return 0;
1479 }
1480
1481 va_start(va, parser);
1482 retval = vgetargskeywordsfast(args, keywords, parser, &va, FLAG_SIZE_T);
1483 va_end(va);
1484 return retval;
1485}
1486
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07001487int
1488_PyArg_ParseStack(PyObject **args, Py_ssize_t nargs, PyObject *kwnames,
1489 struct _PyArg_Parser *parser, ...)
1490{
1491 int retval;
1492 va_list va;
1493
1494 if ((kwnames != NULL && !PyTuple_Check(kwnames)) ||
1495 parser == NULL)
1496 {
1497 PyErr_BadInternalCall();
1498 return 0;
1499 }
1500
1501 va_start(va, parser);
1502 retval = vgetargskeywordsfast_impl(args, nargs, NULL, kwnames, parser, &va, 0);
1503 va_end(va);
1504 return retval;
1505}
1506
1507int
1508_PyArg_ParseStack_SizeT(PyObject **args, Py_ssize_t nargs, PyObject *kwnames,
1509 struct _PyArg_Parser *parser, ...)
1510{
1511 int retval;
1512 va_list va;
1513
1514 if ((kwnames != NULL && !PyTuple_Check(kwnames)) ||
1515 parser == NULL)
1516 {
1517 PyErr_BadInternalCall();
1518 return 0;
1519 }
1520
1521 va_start(va, parser);
1522 retval = vgetargskeywordsfast_impl(args, nargs, NULL, kwnames, parser, &va, FLAG_SIZE_T);
1523 va_end(va);
1524 return retval;
1525}
1526
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001527
1528int
1529_PyArg_VaParseTupleAndKeywordsFast(PyObject *args, PyObject *keywords,
1530 struct _PyArg_Parser *parser, va_list va)
1531{
1532 int retval;
1533 va_list lva;
1534
1535 if ((args == NULL || !PyTuple_Check(args)) ||
1536 (keywords != NULL && !PyDict_Check(keywords)) ||
1537 parser == NULL)
1538 {
1539 PyErr_BadInternalCall();
1540 return 0;
1541 }
1542
Benjamin Peterson0c212142016-09-20 20:39:33 -07001543 va_copy(lva, va);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001544
1545 retval = vgetargskeywordsfast(args, keywords, parser, &lva, 0);
Christian Heimes2f2fee12016-09-21 11:37:27 +02001546 va_end(lva);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001547 return retval;
1548}
1549
1550int
1551_PyArg_VaParseTupleAndKeywordsFast_SizeT(PyObject *args, PyObject *keywords,
1552 struct _PyArg_Parser *parser, va_list va)
1553{
1554 int retval;
1555 va_list lva;
1556
1557 if ((args == NULL || !PyTuple_Check(args)) ||
1558 (keywords != NULL && !PyDict_Check(keywords)) ||
1559 parser == NULL)
1560 {
1561 PyErr_BadInternalCall();
1562 return 0;
1563 }
1564
Benjamin Peterson0c212142016-09-20 20:39:33 -07001565 va_copy(lva, va);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001566
1567 retval = vgetargskeywordsfast(args, keywords, parser, &lva, FLAG_SIZE_T);
Christian Heimes2f2fee12016-09-21 11:37:27 +02001568 va_end(lva);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001569 return retval;
1570}
1571
1572int
Benjamin Petersonfb886362010-04-24 18:21:17 +00001573PyArg_ValidateKeywordArguments(PyObject *kwargs)
1574{
Benjamin Petersonf6096542010-11-17 22:33:12 +00001575 if (!PyDict_Check(kwargs)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001576 PyErr_BadInternalCall();
1577 return 0;
1578 }
1579 if (!_PyDict_HasOnlyStringKeys(kwargs)) {
1580 PyErr_SetString(PyExc_TypeError,
1581 "keyword arguments must be strings");
1582 return 0;
1583 }
1584 return 1;
Benjamin Petersonfb886362010-04-24 18:21:17 +00001585}
1586
Christian Heimes380f7f22008-02-28 11:19:05 +00001587#define IS_END_OF_FORMAT(c) (c == '\0' || c == ';' || c == ':')
Brett Cannon711e7d92004-07-10 22:20:32 +00001588
Guido van Rossumaa354651996-08-19 19:32:04 +00001589static int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001590vgetargskeywords(PyObject *args, PyObject *keywords, const char *format,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001591 char **kwlist, va_list *p_va, int flags)
Guido van Rossumaa354651996-08-19 19:32:04 +00001592{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001593 char msgbuf[512];
1594 int levels[32];
1595 const char *fname, *msg, *custom_msg, *keyword;
1596 int min = INT_MAX;
Larry Hastings83a9f482012-03-20 20:06:16 +00001597 int max = INT_MAX;
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001598 int i, pos, len;
1599 int skip = 0;
Victor Stinner74387f52013-11-18 01:21:12 +01001600 Py_ssize_t nargs, nkeywords;
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001601 PyObject *current_arg;
Antoine Pitrou7056cb22013-02-17 01:04:57 +01001602 freelistentry_t static_entries[STATIC_FREELIST_ENTRIES];
Benjamin Peterson40be9e52014-02-11 10:09:27 -05001603 freelist_t freelist;
1604
1605 freelist.entries = static_entries;
1606 freelist.first_available = 0;
1607 freelist.entries_malloced = 0;
Tim Petersf4331c12001-10-27 00:17:34 +00001608
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001609 assert(args != NULL && PyTuple_Check(args));
1610 assert(keywords == NULL || PyDict_Check(keywords));
1611 assert(format != NULL);
1612 assert(kwlist != NULL);
1613 assert(p_va != NULL);
Tim Peters45772cd2001-10-27 03:58:40 +00001614
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001615 /* grab the function name or custom error msg first (mutually exclusive) */
1616 fname = strchr(format, ':');
1617 if (fname) {
1618 fname++;
1619 custom_msg = NULL;
1620 }
1621 else {
1622 custom_msg = strchr(format,';');
1623 if (custom_msg)
1624 custom_msg++;
1625 }
Christian Heimes380f7f22008-02-28 11:19:05 +00001626
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001627 /* scan kwlist and count the number of positional-only parameters */
1628 for (pos = 0; kwlist[pos] && !*kwlist[pos]; pos++) {
1629 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001630 /* scan kwlist and get greatest possible nbr of args */
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001631 for (len = pos; kwlist[len]; len++) {
1632 if (!*kwlist[len]) {
1633 PyErr_SetString(PyExc_SystemError,
1634 "Empty keyword parameter name");
1635 return cleanreturn(0, &freelist);
1636 }
1637 }
Tim Petersf8cd3e82001-10-27 04:26:57 +00001638
Antoine Pitrou7056cb22013-02-17 01:04:57 +01001639 if (len > STATIC_FREELIST_ENTRIES) {
1640 freelist.entries = PyMem_NEW(freelistentry_t, len);
1641 if (freelist.entries == NULL) {
1642 PyErr_NoMemory();
1643 return 0;
1644 }
1645 freelist.entries_malloced = 1;
Benjamin Peterson7ed67272012-03-16 12:21:02 -05001646 }
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001647
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001648 nargs = PyTuple_GET_SIZE(args);
1649 nkeywords = (keywords == NULL) ? 0 : PyDict_Size(keywords);
1650 if (nargs + nkeywords > len) {
Victor Stinner6ced7c42011-03-21 18:15:42 +01001651 PyErr_Format(PyExc_TypeError,
Victor Stinnercb29ec52013-11-18 02:05:31 +01001652 "%s%s takes at most %d argument%s (%zd given)",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001653 (fname == NULL) ? "function" : fname,
1654 (fname == NULL) ? "" : "()",
1655 len,
1656 (len == 1) ? "" : "s",
1657 nargs + nkeywords);
Benjamin Peterson01feaec2012-03-16 13:25:58 -05001658 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001659 }
Tim Petersc2f01122001-10-27 07:25:06 +00001660
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001661 /* convert tuple args and keyword args in same loop, using kwlist to drive process */
1662 for (i = 0; i < len; i++) {
1663 keyword = kwlist[i];
1664 if (*format == '|') {
Larry Hastings83a9f482012-03-20 20:06:16 +00001665 if (min != INT_MAX) {
Serhiy Storchakaa9725f82016-02-11 12:41:40 +02001666 PyErr_SetString(PyExc_SystemError,
Larry Hastings83a9f482012-03-20 20:06:16 +00001667 "Invalid format string (| specified twice)");
1668 return cleanreturn(0, &freelist);
1669 }
1670
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001671 min = i;
1672 format++;
Larry Hastings83a9f482012-03-20 20:06:16 +00001673
1674 if (max != INT_MAX) {
Serhiy Storchakaa9725f82016-02-11 12:41:40 +02001675 PyErr_SetString(PyExc_SystemError,
Larry Hastings83a9f482012-03-20 20:06:16 +00001676 "Invalid format string ($ before |)");
1677 return cleanreturn(0, &freelist);
1678 }
1679 }
1680 if (*format == '$') {
1681 if (max != INT_MAX) {
Serhiy Storchakaa9725f82016-02-11 12:41:40 +02001682 PyErr_SetString(PyExc_SystemError,
Larry Hastings83a9f482012-03-20 20:06:16 +00001683 "Invalid format string ($ specified twice)");
1684 return cleanreturn(0, &freelist);
1685 }
1686
1687 max = i;
1688 format++;
1689
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001690 if (max < pos) {
1691 PyErr_SetString(PyExc_SystemError,
1692 "Empty parameter name after $");
1693 return cleanreturn(0, &freelist);
1694 }
1695 if (skip) {
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001696 /* Now we know the minimal and the maximal numbers of
1697 * positional arguments and can raise an exception with
1698 * informative message (see below). */
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001699 break;
1700 }
Larry Hastings83a9f482012-03-20 20:06:16 +00001701 if (max < nargs) {
1702 PyErr_Format(PyExc_TypeError,
1703 "Function takes %s %d positional arguments"
1704 " (%d given)",
1705 (min != INT_MAX) ? "at most" : "exactly",
1706 max, nargs);
1707 return cleanreturn(0, &freelist);
1708 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001709 }
1710 if (IS_END_OF_FORMAT(*format)) {
Serhiy Storchakaa9725f82016-02-11 12:41:40 +02001711 PyErr_Format(PyExc_SystemError,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001712 "More keyword list entries (%d) than "
1713 "format specifiers (%d)", len, i);
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001714 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001715 }
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001716 if (!skip) {
1717 current_arg = NULL;
1718 if (nkeywords && i >= pos) {
1719 current_arg = PyDict_GetItemString(keywords, keyword);
1720 if (!current_arg && PyErr_Occurred()) {
1721 return cleanreturn(0, &freelist);
1722 }
1723 }
1724 if (current_arg) {
1725 --nkeywords;
1726 if (i < nargs) {
1727 /* arg present in tuple and in dict */
1728 PyErr_Format(PyExc_TypeError,
1729 "Argument given by name ('%s') "
1730 "and position (%d)",
1731 keyword, i+1);
1732 return cleanreturn(0, &freelist);
1733 }
1734 }
1735 else if (i < nargs)
1736 current_arg = PyTuple_GET_ITEM(args, i);
1737
1738 if (current_arg) {
1739 msg = convertitem(current_arg, &format, p_va, flags,
1740 levels, msgbuf, sizeof(msgbuf), &freelist);
1741 if (msg) {
1742 seterror(i+1, msg, levels, fname, custom_msg);
1743 return cleanreturn(0, &freelist);
1744 }
1745 continue;
1746 }
1747
1748 if (i < min) {
1749 if (i < pos) {
1750 assert (min == INT_MAX);
1751 assert (max == INT_MAX);
1752 skip = 1;
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001753 /* At that moment we still don't know the minimal and
1754 * the maximal numbers of positional arguments. Raising
1755 * an exception is deferred until we encounter | and $
1756 * or the end of the format. */
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001757 }
1758 else {
1759 PyErr_Format(PyExc_TypeError, "Required argument "
1760 "'%s' (pos %d) not found",
1761 keyword, i+1);
1762 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 */
1769 if (!nkeywords && !skip) {
1770 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,
1786 "Function takes %s %d positional arguments"
1787 " (%d given)",
1788 (Py_MIN(pos, min) < i) ? "at least" : "exactly",
1789 Py_MIN(pos, min), nargs);
1790 return cleanreturn(0, &freelist);
1791 }
1792
Larry Hastings83a9f482012-03-20 20:06:16 +00001793 if (!IS_END_OF_FORMAT(*format) && (*format != '|') && (*format != '$')) {
Serhiy Storchakaa9725f82016-02-11 12:41:40 +02001794 PyErr_Format(PyExc_SystemError,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001795 "more argument specifiers than keyword list entries "
1796 "(remaining format:'%s')", format);
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001797 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001798 }
Tim Petersc2f01122001-10-27 07:25:06 +00001799
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001800 /* make sure there are no extraneous keyword arguments */
1801 if (nkeywords > 0) {
1802 PyObject *key, *value;
1803 Py_ssize_t pos = 0;
1804 while (PyDict_Next(keywords, &pos, &key, &value)) {
1805 int match = 0;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001806 if (!PyUnicode_Check(key)) {
1807 PyErr_SetString(PyExc_TypeError,
1808 "keywords must be strings");
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001809 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001810 }
Antoine Pitrou7056cb22013-02-17 01:04:57 +01001811 for (i = 0; i < len; i++) {
Serhiy Storchaka3b73ea12016-11-16 10:19:20 +02001812 if (*kwlist[i] && _PyUnicode_EqualToASCIIString(key, kwlist[i])) {
Antoine Pitrou7056cb22013-02-17 01:04:57 +01001813 match = 1;
1814 break;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001815 }
1816 }
1817 if (!match) {
1818 PyErr_Format(PyExc_TypeError,
Victor Stinner93b55132010-05-19 00:54:06 +00001819 "'%U' is an invalid keyword "
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001820 "argument for this function",
Victor Stinner93b55132010-05-19 00:54:06 +00001821 key);
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001822 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001823 }
1824 }
1825 }
1826
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001827 return cleanreturn(1, &freelist);
Guido van Rossumaa354651996-08-19 19:32:04 +00001828}
1829
1830
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001831/* List of static parsers. */
1832static struct _PyArg_Parser *static_arg_parsers = NULL;
1833
1834static int
1835parser_init(struct _PyArg_Parser *parser)
1836{
1837 const char * const *keywords;
1838 const char *format, *msg;
1839 int i, len, min, max, nkw;
1840 PyObject *kwtuple;
1841
1842 assert(parser->format != NULL);
1843 assert(parser->keywords != NULL);
1844 if (parser->kwtuple != NULL) {
1845 return 1;
1846 }
1847
1848 /* grab the function name or custom error msg first (mutually exclusive) */
1849 parser->fname = strchr(parser->format, ':');
1850 if (parser->fname) {
1851 parser->fname++;
1852 parser->custom_msg = NULL;
1853 }
1854 else {
1855 parser->custom_msg = strchr(parser->format,';');
1856 if (parser->custom_msg)
1857 parser->custom_msg++;
1858 }
1859
1860 keywords = parser->keywords;
1861 /* scan keywords and count the number of positional-only parameters */
1862 for (i = 0; keywords[i] && !*keywords[i]; i++) {
1863 }
1864 parser->pos = i;
1865 /* scan keywords and get greatest possible nbr of args */
1866 for (; keywords[i]; i++) {
1867 if (!*keywords[i]) {
1868 PyErr_SetString(PyExc_SystemError,
1869 "Empty keyword parameter name");
1870 return 0;
1871 }
1872 }
1873 len = i;
1874
1875 min = max = INT_MAX;
1876 format = parser->format;
1877 for (i = 0; i < len; i++) {
1878 if (*format == '|') {
1879 if (min != INT_MAX) {
1880 PyErr_SetString(PyExc_SystemError,
1881 "Invalid format string (| specified twice)");
1882 return 0;
1883 }
1884 if (max != INT_MAX) {
1885 PyErr_SetString(PyExc_SystemError,
1886 "Invalid format string ($ before |)");
1887 return 0;
1888 }
1889 min = i;
1890 format++;
1891 }
1892 if (*format == '$') {
1893 if (max != INT_MAX) {
1894 PyErr_SetString(PyExc_SystemError,
1895 "Invalid format string ($ specified twice)");
1896 return 0;
1897 }
1898 if (i < parser->pos) {
1899 PyErr_SetString(PyExc_SystemError,
1900 "Empty parameter name after $");
1901 return 0;
1902 }
1903 max = i;
1904 format++;
1905 }
1906 if (IS_END_OF_FORMAT(*format)) {
1907 PyErr_Format(PyExc_SystemError,
1908 "More keyword list entries (%d) than "
1909 "format specifiers (%d)", len, i);
1910 return 0;
1911 }
1912
1913 msg = skipitem(&format, NULL, 0);
1914 if (msg) {
1915 PyErr_Format(PyExc_SystemError, "%s: '%s'", msg,
1916 format);
1917 return 0;
1918 }
1919 }
1920 parser->min = Py_MIN(min, len);
1921 parser->max = Py_MIN(max, len);
1922
1923 if (!IS_END_OF_FORMAT(*format) && (*format != '|') && (*format != '$')) {
1924 PyErr_Format(PyExc_SystemError,
1925 "more argument specifiers than keyword list entries "
1926 "(remaining format:'%s')", format);
1927 return 0;
1928 }
1929
1930 nkw = len - parser->pos;
1931 kwtuple = PyTuple_New(nkw);
1932 if (kwtuple == NULL) {
1933 return 0;
1934 }
1935 keywords = parser->keywords + parser->pos;
1936 for (i = 0; i < nkw; i++) {
1937 PyObject *str = PyUnicode_FromString(keywords[i]);
1938 if (str == NULL) {
1939 Py_DECREF(kwtuple);
1940 return 0;
1941 }
1942 PyUnicode_InternInPlace(&str);
1943 PyTuple_SET_ITEM(kwtuple, i, str);
1944 }
1945 parser->kwtuple = kwtuple;
1946
1947 assert(parser->next == NULL);
1948 parser->next = static_arg_parsers;
1949 static_arg_parsers = parser;
1950 return 1;
1951}
1952
1953static void
1954parser_clear(struct _PyArg_Parser *parser)
1955{
1956 Py_CLEAR(parser->kwtuple);
1957}
1958
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07001959static PyObject*
1960find_keyword(PyObject *kwnames, PyObject **kwstack, PyObject *key)
1961{
1962 Py_ssize_t i, nkwargs;
1963
1964 nkwargs = PyTuple_GET_SIZE(kwnames);
1965 for (i=0; i < nkwargs; i++) {
1966 PyObject *kwname = PyTuple_GET_ITEM(kwnames, i);
1967
1968 /* ptr==ptr should match in most cases since keyword keys
1969 should be interned strings */
1970 if (kwname == key) {
1971 return kwstack[i];
1972 }
1973 if (!PyUnicode_Check(kwname)) {
1974 /* ignore non-string keyword keys:
1975 an error will be raised above */
1976 continue;
1977 }
1978 if (_PyUnicode_EQ(kwname, key)) {
1979 return kwstack[i];
1980 }
1981 }
1982 return NULL;
1983}
1984
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001985static int
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07001986vgetargskeywordsfast_impl(PyObject **args, Py_ssize_t nargs,
1987 PyObject *keywords, PyObject *kwnames,
1988 struct _PyArg_Parser *parser,
1989 va_list *p_va, int flags)
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001990{
1991 PyObject *kwtuple;
1992 char msgbuf[512];
1993 int levels[32];
1994 const char *format;
1995 const char *msg;
1996 PyObject *keyword;
1997 int i, pos, len;
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07001998 Py_ssize_t nkeywords;
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001999 PyObject *current_arg;
2000 freelistentry_t static_entries[STATIC_FREELIST_ENTRIES];
2001 freelist_t freelist;
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002002 PyObject **kwstack = NULL;
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002003
2004 freelist.entries = static_entries;
2005 freelist.first_available = 0;
2006 freelist.entries_malloced = 0;
2007
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002008 assert(keywords == NULL || PyDict_Check(keywords));
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002009 assert(kwnames == NULL || PyTuple_Check(kwnames));
2010 assert((keywords != NULL || kwnames != NULL)
2011 || (keywords == NULL && kwnames == NULL));
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002012 assert(parser != NULL);
2013 assert(p_va != NULL);
2014
2015 if (!parser_init(parser)) {
2016 return 0;
2017 }
2018
2019 kwtuple = parser->kwtuple;
2020 pos = parser->pos;
2021 len = pos + PyTuple_GET_SIZE(kwtuple);
2022
2023 if (len > STATIC_FREELIST_ENTRIES) {
2024 freelist.entries = PyMem_NEW(freelistentry_t, len);
2025 if (freelist.entries == NULL) {
2026 PyErr_NoMemory();
2027 return 0;
2028 }
2029 freelist.entries_malloced = 1;
2030 }
2031
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002032 if (keywords != NULL) {
2033 nkeywords = PyDict_Size(keywords);
2034 }
2035 else if (kwnames != NULL) {
2036 nkeywords = PyTuple_GET_SIZE(kwnames);
2037 kwstack = args + nargs;
2038 }
2039 else {
2040 nkeywords = 0;
2041 }
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002042 if (nargs + nkeywords > len) {
2043 PyErr_Format(PyExc_TypeError,
2044 "%s%s takes at most %d argument%s (%zd given)",
2045 (parser->fname == NULL) ? "function" : parser->fname,
2046 (parser->fname == NULL) ? "" : "()",
2047 len,
2048 (len == 1) ? "" : "s",
2049 nargs + nkeywords);
2050 return cleanreturn(0, &freelist);
2051 }
2052 if (parser->max < nargs) {
2053 PyErr_Format(PyExc_TypeError,
2054 "Function takes %s %d positional arguments (%d given)",
2055 (parser->min != INT_MAX) ? "at most" : "exactly",
2056 parser->max, nargs);
2057 return cleanreturn(0, &freelist);
2058 }
2059
2060 format = parser->format;
2061 /* convert tuple args and keyword args in same loop, using kwtuple to drive process */
2062 for (i = 0; i < len; i++) {
2063 keyword = (i >= pos) ? PyTuple_GET_ITEM(kwtuple, i - pos) : NULL;
2064 if (*format == '|') {
2065 format++;
2066 }
2067 if (*format == '$') {
2068 format++;
2069 }
2070 assert(!IS_END_OF_FORMAT(*format));
2071
2072 current_arg = NULL;
2073 if (nkeywords && i >= pos) {
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002074 if (keywords != NULL) {
2075 current_arg = PyDict_GetItem(keywords, keyword);
2076 if (!current_arg && PyErr_Occurred()) {
2077 return cleanreturn(0, &freelist);
2078 }
2079 }
2080 else {
2081 current_arg = find_keyword(kwnames, kwstack, keyword);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002082 }
2083 }
2084 if (current_arg) {
2085 --nkeywords;
2086 if (i < nargs) {
2087 /* arg present in tuple and in dict */
2088 PyErr_Format(PyExc_TypeError,
2089 "Argument given by name ('%U') "
2090 "and position (%d)",
2091 keyword, i+1);
2092 return cleanreturn(0, &freelist);
2093 }
2094 }
Victor Stinnera9efb2f2016-09-09 17:40:22 -07002095 else if (i < nargs) {
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002096 current_arg = args[i];
Victor Stinnera9efb2f2016-09-09 17:40:22 -07002097 }
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002098
2099 if (current_arg) {
2100 msg = convertitem(current_arg, &format, p_va, flags,
2101 levels, msgbuf, sizeof(msgbuf), &freelist);
2102 if (msg) {
2103 seterror(i+1, msg, levels, parser->fname, parser->custom_msg);
2104 return cleanreturn(0, &freelist);
2105 }
2106 continue;
2107 }
2108
2109 if (i < parser->min) {
2110 /* Less arguments than required */
2111 if (i < pos) {
2112 PyErr_Format(PyExc_TypeError,
2113 "Function takes %s %d positional arguments"
2114 " (%d given)",
2115 (Py_MIN(pos, parser->min) < parser->max) ? "at least" : "exactly",
2116 Py_MIN(pos, parser->min), nargs);
2117 }
2118 else {
2119 PyErr_Format(PyExc_TypeError, "Required argument "
2120 "'%U' (pos %d) not found",
2121 keyword, i+1);
2122 }
2123 return cleanreturn(0, &freelist);
2124 }
2125 /* current code reports success when all required args
2126 * fulfilled and no keyword args left, with no further
2127 * validation. XXX Maybe skip this in debug build ?
2128 */
2129 if (!nkeywords) {
2130 return cleanreturn(1, &freelist);
2131 }
2132
2133 /* We are into optional args, skip thru to any remaining
2134 * keyword args */
2135 msg = skipitem(&format, p_va, flags);
2136 assert(msg == NULL);
2137 }
2138
2139 assert(IS_END_OF_FORMAT(*format) || (*format == '|') || (*format == '$'));
2140
2141 /* make sure there are no extraneous keyword arguments */
2142 if (nkeywords > 0) {
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002143 if (keywords != NULL) {
2144 PyObject *key, *value;
2145 Py_ssize_t pos = 0;
2146 while (PyDict_Next(keywords, &pos, &key, &value)) {
2147 int match;
2148 if (!PyUnicode_Check(key)) {
2149 PyErr_SetString(PyExc_TypeError,
2150 "keywords must be strings");
2151 return cleanreturn(0, &freelist);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002152 }
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002153 match = PySequence_Contains(kwtuple, key);
2154 if (match <= 0) {
2155 if (!match) {
2156 PyErr_Format(PyExc_TypeError,
2157 "'%U' is an invalid keyword "
2158 "argument for this function",
2159 key);
2160 }
2161 return cleanreturn(0, &freelist);
2162 }
2163 }
2164 }
2165 else {
2166 Py_ssize_t j, nkwargs;
2167
2168 nkwargs = PyTuple_GET_SIZE(kwnames);
2169 for (j=0; j < nkwargs; j++) {
2170 PyObject *key = PyTuple_GET_ITEM(kwnames, j);
2171 int match;
2172
2173 if (!PyUnicode_Check(key)) {
2174 PyErr_SetString(PyExc_TypeError,
2175 "keywords must be strings");
2176 return cleanreturn(0, &freelist);
2177 }
2178
2179 match = PySequence_Contains(kwtuple, key);
2180 if (match <= 0) {
2181 if (!match) {
2182 PyErr_Format(PyExc_TypeError,
2183 "'%U' is an invalid keyword "
2184 "argument for this function",
2185 key);
2186 }
2187 return cleanreturn(0, &freelist);
2188 }
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002189 }
2190 }
2191 }
2192
2193 return cleanreturn(1, &freelist);
2194}
2195
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002196static int
2197vgetargskeywordsfast(PyObject *args, PyObject *keywords,
2198 struct _PyArg_Parser *parser, va_list *p_va, int flags)
2199{
2200 PyObject **stack;
2201 Py_ssize_t nargs;
2202
2203 assert(args != NULL && PyTuple_Check(args));
2204
2205 stack = &PyTuple_GET_ITEM(args, 0);
2206 nargs = PyTuple_GET_SIZE(args);
2207 return vgetargskeywordsfast_impl(stack, nargs, keywords, NULL,
2208 parser, p_va, flags);
2209}
2210
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002211
Serhiy Storchakaef1585e2015-12-25 20:01:53 +02002212static const char *
Martin v. Löwis18e16552006-02-15 17:27:45 +00002213skipitem(const char **p_format, va_list *p_va, int flags)
Guido van Rossumaa354651996-08-19 19:32:04 +00002214{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002215 const char *format = *p_format;
2216 char c = *format++;
Guido van Rossum98297ee2007-11-06 21:34:58 +00002217
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002218 switch (c) {
Georg Brandl6dd14612005-09-14 19:29:53 +00002219
Larry Hastingsa3479012012-05-08 23:52:03 -07002220 /*
2221 * codes that take a single data pointer as an argument
2222 * (the type of the pointer is irrelevant)
2223 */
Georg Brandl6dd14612005-09-14 19:29:53 +00002224
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002225 case 'b': /* byte -- very short int */
2226 case 'B': /* byte as bitfield */
2227 case 'h': /* short int */
2228 case 'H': /* short int as bitfield */
2229 case 'i': /* int */
2230 case 'I': /* int sized bitfield */
2231 case 'l': /* long int */
2232 case 'k': /* long int sized bitfield */
Benjamin Petersonaf580df2016-09-06 10:46:49 -07002233 case 'L': /* long long */
2234 case 'K': /* long long sized bitfield */
Larry Hastingsa3479012012-05-08 23:52:03 -07002235 case 'n': /* Py_ssize_t */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002236 case 'f': /* float */
2237 case 'd': /* double */
2238 case 'D': /* complex double */
2239 case 'c': /* char */
2240 case 'C': /* unicode char */
Larry Hastings10ba07a2012-05-07 02:44:50 -07002241 case 'p': /* boolean predicate */
Larry Hastingsa3479012012-05-08 23:52:03 -07002242 case 'S': /* string object */
2243 case 'Y': /* string object */
2244 case 'U': /* unicode string object */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002245 {
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002246 if (p_va != NULL) {
2247 (void) va_arg(*p_va, void *);
2248 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002249 break;
2250 }
Martin v. Löwis18e16552006-02-15 17:27:45 +00002251
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002252 /* string codes */
Guido van Rossum98297ee2007-11-06 21:34:58 +00002253
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002254 case 'e': /* string with encoding */
2255 {
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002256 if (p_va != NULL) {
2257 (void) va_arg(*p_va, const char *);
2258 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002259 if (!(*format == 's' || *format == 't'))
2260 /* after 'e', only 's' and 't' is allowed */
2261 goto err;
2262 format++;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002263 }
Victor Stinnerc0e77362017-09-12 16:09:44 -07002264 /* fall through */
Guido van Rossum98297ee2007-11-06 21:34:58 +00002265
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002266 case 's': /* string */
2267 case 'z': /* string or None */
2268 case 'y': /* bytes */
2269 case 'u': /* unicode string */
Larry Hastingsd9e4a412012-05-08 03:51:18 -07002270 case 'Z': /* unicode string or None */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002271 case 'w': /* buffer, read-write */
2272 {
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002273 if (p_va != NULL) {
2274 (void) va_arg(*p_va, char **);
2275 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002276 if (*format == '#') {
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002277 if (p_va != NULL) {
2278 if (flags & FLAG_SIZE_T)
2279 (void) va_arg(*p_va, Py_ssize_t *);
2280 else
2281 (void) va_arg(*p_va, int *);
2282 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002283 format++;
2284 } else if ((c == 's' || c == 'z' || c == 'y') && *format == '*') {
2285 format++;
2286 }
2287 break;
2288 }
Georg Brandl6dd14612005-09-14 19:29:53 +00002289
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002290 case 'O': /* object */
2291 {
2292 if (*format == '!') {
2293 format++;
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002294 if (p_va != NULL) {
2295 (void) va_arg(*p_va, PyTypeObject*);
2296 (void) va_arg(*p_va, PyObject **);
2297 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002298 }
2299 else if (*format == '&') {
2300 typedef int (*converter)(PyObject *, void *);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002301 if (p_va != NULL) {
2302 (void) va_arg(*p_va, converter);
2303 (void) va_arg(*p_va, void *);
2304 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002305 format++;
2306 }
2307 else {
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002308 if (p_va != NULL) {
2309 (void) va_arg(*p_va, PyObject **);
2310 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002311 }
2312 break;
2313 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00002314
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002315 case '(': /* bypass tuple, not handled at all previously */
2316 {
Serhiy Storchakaef1585e2015-12-25 20:01:53 +02002317 const char *msg;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002318 for (;;) {
2319 if (*format==')')
2320 break;
2321 if (IS_END_OF_FORMAT(*format))
2322 return "Unmatched left paren in format "
2323 "string";
2324 msg = skipitem(&format, p_va, flags);
2325 if (msg)
2326 return msg;
2327 }
2328 format++;
2329 break;
2330 }
Christian Heimes380f7f22008-02-28 11:19:05 +00002331
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002332 case ')':
2333 return "Unmatched right paren in format string";
Christian Heimes380f7f22008-02-28 11:19:05 +00002334
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002335 default:
Georg Brandl6dd14612005-09-14 19:29:53 +00002336err:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002337 return "impossible<bad format char>";
Guido van Rossum98297ee2007-11-06 21:34:58 +00002338
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002339 }
Georg Brandl6dd14612005-09-14 19:29:53 +00002340
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002341 *p_format = format;
2342 return NULL;
Guido van Rossumaa354651996-08-19 19:32:04 +00002343}
Fred Drakee4616e62001-10-23 21:09:29 +00002344
2345
2346int
Martin v. Löwis76246742006-03-01 04:06:10 +00002347PyArg_UnpackTuple(PyObject *args, const char *name, Py_ssize_t min, Py_ssize_t max, ...)
Fred Drakee4616e62001-10-23 21:09:29 +00002348{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002349 Py_ssize_t i, l;
2350 PyObject **o;
2351 va_list vargs;
Fred Drakee4616e62001-10-23 21:09:29 +00002352
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002353 assert(min >= 0);
2354 assert(min <= max);
2355 if (!PyTuple_Check(args)) {
2356 PyErr_SetString(PyExc_SystemError,
2357 "PyArg_UnpackTuple() argument list is not a tuple");
2358 return 0;
2359 }
2360 l = PyTuple_GET_SIZE(args);
2361 if (l < min) {
2362 if (name != NULL)
2363 PyErr_Format(
2364 PyExc_TypeError,
2365 "%s expected %s%zd arguments, got %zd",
2366 name, (min == max ? "" : "at least "), min, l);
2367 else
2368 PyErr_Format(
2369 PyExc_TypeError,
2370 "unpacked tuple should have %s%zd elements,"
2371 " but has %zd",
2372 (min == max ? "" : "at least "), min, l);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002373 return 0;
2374 }
Raymond Hettinger94230232016-03-26 03:02:48 -07002375 if (l == 0)
2376 return 1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002377 if (l > max) {
2378 if (name != NULL)
2379 PyErr_Format(
2380 PyExc_TypeError,
2381 "%s expected %s%zd arguments, got %zd",
2382 name, (min == max ? "" : "at most "), max, l);
2383 else
2384 PyErr_Format(
2385 PyExc_TypeError,
2386 "unpacked tuple should have %s%zd elements,"
2387 " but has %zd",
2388 (min == max ? "" : "at most "), max, l);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002389 return 0;
2390 }
Raymond Hettinger94230232016-03-26 03:02:48 -07002391
2392#ifdef HAVE_STDARG_PROTOTYPES
2393 va_start(vargs, max);
2394#else
2395 va_start(vargs);
2396#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002397 for (i = 0; i < l; i++) {
2398 o = va_arg(vargs, PyObject **);
2399 *o = PyTuple_GET_ITEM(args, i);
2400 }
2401 va_end(vargs);
2402 return 1;
Fred Drakee4616e62001-10-23 21:09:29 +00002403}
Georg Brandl02c42872005-08-26 06:42:30 +00002404
2405
2406/* For type constructors that don't take keyword args
2407 *
Larry Hastingsb7ccb202014-01-18 23:50:21 -08002408 * Sets a TypeError and returns 0 if the args/kwargs is
Thomas Wouters89f507f2006-12-13 04:49:30 +00002409 * not empty, returns 1 otherwise
Georg Brandl02c42872005-08-26 06:42:30 +00002410 */
2411int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00002412_PyArg_NoKeywords(const char *funcname, PyObject *kw)
Georg Brandl02c42872005-08-26 06:42:30 +00002413{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002414 if (kw == NULL)
2415 return 1;
2416 if (!PyDict_CheckExact(kw)) {
2417 PyErr_BadInternalCall();
2418 return 0;
2419 }
2420 if (PyDict_Size(kw) == 0)
2421 return 1;
Guido van Rossum98297ee2007-11-06 21:34:58 +00002422
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002423 PyErr_Format(PyExc_TypeError, "%s does not take keyword arguments",
2424 funcname);
2425 return 0;
Georg Brandl02c42872005-08-26 06:42:30 +00002426}
Larry Hastingsb7ccb202014-01-18 23:50:21 -08002427
2428
2429int
2430_PyArg_NoPositional(const char *funcname, PyObject *args)
2431{
2432 if (args == NULL)
2433 return 1;
2434 if (!PyTuple_CheckExact(args)) {
2435 PyErr_BadInternalCall();
2436 return 0;
2437 }
2438 if (PyTuple_GET_SIZE(args) == 0)
2439 return 1;
2440
2441 PyErr_Format(PyExc_TypeError, "%s does not take positional arguments",
2442 funcname);
2443 return 0;
2444}
2445
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002446void
2447_PyArg_Fini(void)
2448{
2449 struct _PyArg_Parser *tmp, *s = static_arg_parsers;
2450 while (s) {
2451 tmp = s->next;
2452 s->next = NULL;
2453 parser_clear(s);
2454 s = tmp;
2455 }
2456 static_arg_parsers = NULL;
2457}
2458
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002459#ifdef __cplusplus
2460};
2461#endif