blob: 8aab067865b81b91dd51b44af463b67ffbb0ac27 [file] [log] [blame]
Guido van Rossumfe3f1a21994-09-29 09:42:55 +00001
2/* New getargs implementation */
3
Guido van Rossum79f25d91997-04-29 20:08:16 +00004#include "Python.h"
Guido van Rossumfe3f1a21994-09-29 09:42:55 +00005
Guido van Rossumc1d50531996-08-21 23:38:24 +00006#include <ctype.h>
7
Guido van Rossumfe3f1a21994-09-29 09:42:55 +00008
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00009#ifdef __cplusplus
Guido van Rossum98297ee2007-11-06 21:34:58 +000010extern "C" {
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000011#endif
Jeremy Hyltonaf68c872005-12-10 18:50:16 +000012int PyArg_Parse(PyObject *, const char *, ...);
13int PyArg_ParseTuple(PyObject *, const char *, ...);
14int PyArg_VaParse(PyObject *, const char *, va_list);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000015
Tim Petersdbd9ba62000-07-09 03:09:57 +000016int PyArg_ParseTupleAndKeywords(PyObject *, PyObject *,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000017 const char *, char **, ...);
Brett Cannon711e7d92004-07-10 22:20:32 +000018int PyArg_VaParseTupleAndKeywords(PyObject *, PyObject *,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000019 const char *, char **, va_list);
Brett Cannon711e7d92004-07-10 22:20:32 +000020
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000021#ifdef HAVE_DECLSPEC_DLL
22/* Export functions */
23PyAPI_FUNC(int) _PyArg_Parse_SizeT(PyObject *, char *, ...);
24PyAPI_FUNC(int) _PyArg_ParseTuple_SizeT(PyObject *, char *, ...);
25PyAPI_FUNC(int) _PyArg_ParseTupleAndKeywords_SizeT(PyObject *, PyObject *,
26 const char *, char **, ...);
27PyAPI_FUNC(PyObject *) _Py_BuildValue_SizeT(const char *, ...);
28PyAPI_FUNC(int) _PyArg_VaParse_SizeT(PyObject *, char *, va_list);
29PyAPI_FUNC(int) _PyArg_VaParseTupleAndKeywords_SizeT(PyObject *, PyObject *,
30 const char *, char **, va_list);
31#endif
32
Martin v. Löwis18e16552006-02-15 17:27:45 +000033#define FLAG_COMPAT 1
34#define FLAG_SIZE_T 2
35
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -040036typedef int (*destr_t)(PyObject *, void *);
37
38
39/* Keep track of "objects" that have been allocated or initialized and
40 which will need to be deallocated or cleaned up somehow if overall
41 parsing fails.
42*/
43typedef struct {
44 void *item;
45 destr_t destructor;
46} freelistentry_t;
47
48typedef struct {
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -040049 freelistentry_t *entries;
Antoine Pitrou7056cb22013-02-17 01:04:57 +010050 int first_available;
51 int entries_malloced;
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -040052} freelist_t;
53
Antoine Pitrou7056cb22013-02-17 01:04:57 +010054#define STATIC_FREELIST_ENTRIES 8
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000055
56/* Forward */
Jeremy Hyltonaf68c872005-12-10 18:50:16 +000057static int vgetargs1(PyObject *, const char *, va_list *, int);
Victor Stinner84bb1cf2013-05-17 00:12:04 +020058static void seterror(Py_ssize_t, const char *, int *, const char *, const char *);
Guido van Rossum98297ee2007-11-06 21:34:58 +000059static char *convertitem(PyObject *, const char **, va_list *, int, int *,
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -040060 char *, size_t, freelist_t *);
Martin v. Löwis18e16552006-02-15 17:27:45 +000061static char *converttuple(PyObject *, const char **, va_list *, int,
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -040062 int *, char *, size_t, int, freelist_t *);
Martin v. Löwis18e16552006-02-15 17:27:45 +000063static char *convertsimple(PyObject *, const char **, va_list *, int, char *,
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -040064 size_t, freelist_t *);
Martin v. Löwis18e16552006-02-15 17:27:45 +000065static Py_ssize_t convertbuffer(PyObject *, void **p, char **);
Martin v. Löwis423be952008-08-13 15:53:07 +000066static int getbuffer(PyObject *, Py_buffer *, char**);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000067
Tim Petersdbd9ba62000-07-09 03:09:57 +000068static int vgetargskeywords(PyObject *, PyObject *,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000069 const char *, char **, va_list *, int);
Martin v. Löwis18e16552006-02-15 17:27:45 +000070static char *skipitem(const char **, va_list *, int);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000071
Fred Drake563dfc22001-10-23 14:41:08 +000072int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +000073PyArg_Parse(PyObject *args, const char *format, ...)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000074{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000075 int retval;
76 va_list va;
Guido van Rossum98297ee2007-11-06 21:34:58 +000077
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000078 va_start(va, format);
79 retval = vgetargs1(args, format, &va, FLAG_COMPAT);
80 va_end(va);
81 return retval;
Martin v. Löwis18e16552006-02-15 17:27:45 +000082}
83
84int
85_PyArg_Parse_SizeT(PyObject *args, char *format, ...)
86{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000087 int retval;
88 va_list va;
Guido van Rossum98297ee2007-11-06 21:34:58 +000089
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000090 va_start(va, format);
91 retval = vgetargs1(args, format, &va, FLAG_COMPAT|FLAG_SIZE_T);
92 va_end(va);
93 return retval;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000094}
95
96
Fred Drake563dfc22001-10-23 14:41:08 +000097int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +000098PyArg_ParseTuple(PyObject *args, const char *format, ...)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000099{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000100 int retval;
101 va_list va;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000102
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000103 va_start(va, format);
104 retval = vgetargs1(args, format, &va, 0);
105 va_end(va);
106 return retval;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000107}
108
Martin v. Löwis18e16552006-02-15 17:27:45 +0000109int
110_PyArg_ParseTuple_SizeT(PyObject *args, char *format, ...)
111{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000112 int retval;
113 va_list va;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000114
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000115 va_start(va, format);
116 retval = vgetargs1(args, format, &va, FLAG_SIZE_T);
117 va_end(va);
118 return retval;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000119}
120
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000121
122int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000123PyArg_VaParse(PyObject *args, const char *format, va_list va)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000124{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000125 va_list lva;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000126
Alexander Belopolskyf0f45142010-08-11 17:31:17 +0000127 Py_VA_COPY(lva, va);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000128
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000129 return vgetargs1(args, format, &lva, 0);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000130}
131
Martin v. Löwis18e16552006-02-15 17:27:45 +0000132int
133_PyArg_VaParse_SizeT(PyObject *args, char *format, va_list va)
134{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000135 va_list lva;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000136
Alexander Belopolskyf0f45142010-08-11 17:31:17 +0000137 Py_VA_COPY(lva, va);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000138
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000139 return vgetargs1(args, format, &lva, FLAG_SIZE_T);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000140}
141
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000142
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000143/* Handle cleanup of allocated memory in case of exception */
144
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400145static int
146cleanup_ptr(PyObject *self, void *ptr)
Antoine Pitrouf71995782008-08-29 18:37:05 +0000147{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000148 if (ptr) {
149 PyMem_FREE(ptr);
150 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000151 return 0;
Martin v. Löwisc15bdef2009-05-29 14:47:46 +0000152}
153
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000154static int
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400155cleanup_buffer(PyObject *self, void *ptr)
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000156{
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400157 Py_buffer *buf = (Py_buffer *)ptr;
158 if (buf) {
159 PyBuffer_Release(buf);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000160 }
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400161 return 0;
162}
163
164static int
165addcleanup(void *ptr, freelist_t *freelist, destr_t destructor)
166{
167 int index;
168
169 index = freelist->first_available;
170 freelist->first_available += 1;
171
172 freelist->entries[index].item = ptr;
173 freelist->entries[index].destructor = destructor;
174
175 return 0;
176}
177
178static int
179cleanreturn(int retval, freelist_t *freelist)
180{
181 int index;
182
183 if (retval == 0) {
184 /* A failure occurred, therefore execute all of the cleanup
185 functions.
186 */
187 for (index = 0; index < freelist->first_available; ++index) {
188 freelist->entries[index].destructor(NULL,
189 freelist->entries[index].item);
190 }
191 }
Antoine Pitrou7056cb22013-02-17 01:04:57 +0100192 if (freelist->entries_malloced)
193 PyMem_FREE(freelist->entries);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000194 return retval;
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000195}
196
197
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000198static int
Martin v. Löwis18e16552006-02-15 17:27:45 +0000199vgetargs1(PyObject *args, const char *format, va_list *p_va, int flags)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000200{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000201 char msgbuf[256];
202 int levels[32];
203 const char *fname = NULL;
204 const char *message = NULL;
205 int min = -1;
206 int max = 0;
207 int level = 0;
208 int endfmt = 0;
209 const char *formatsave = format;
210 Py_ssize_t i, len;
211 char *msg;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000212 int compat = flags & FLAG_COMPAT;
Benjamin Peterson40be9e52014-02-11 10:09:27 -0500213 freelistentry_t static_entries[STATIC_FREELIST_ENTRIES];
214 freelist_t freelist;
215
216 freelist.entries = static_entries;
217 freelist.first_available = 0;
218 freelist.entries_malloced = 0;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000219
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000220 assert(compat || (args != (PyObject*)NULL));
221 flags = flags & ~FLAG_COMPAT;
Tim Peters5c4d5bf2001-02-12 22:13:26 +0000222
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000223 while (endfmt == 0) {
224 int c = *format++;
225 switch (c) {
226 case '(':
227 if (level == 0)
228 max++;
229 level++;
230 if (level >= 30)
231 Py_FatalError("too many tuple nesting levels "
232 "in argument format string");
233 break;
234 case ')':
235 if (level == 0)
236 Py_FatalError("excess ')' in getargs format");
237 else
238 level--;
239 break;
240 case '\0':
241 endfmt = 1;
242 break;
243 case ':':
244 fname = format;
245 endfmt = 1;
246 break;
247 case ';':
248 message = format;
249 endfmt = 1;
250 break;
Antoine Pitrou7056cb22013-02-17 01:04:57 +0100251 case '|':
252 if (level == 0)
253 min = max;
254 break;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000255 default:
256 if (level == 0) {
Antoine Pitrou7056cb22013-02-17 01:04:57 +0100257 if (Py_ISALPHA(Py_CHARMASK(c)))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000258 if (c != 'e') /* skip encoded */
259 max++;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000260 }
261 break;
262 }
263 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000264
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000265 if (level != 0)
266 Py_FatalError(/* '(' */ "missing ')' in getargs format");
Guido van Rossum98297ee2007-11-06 21:34:58 +0000267
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000268 if (min < 0)
269 min = max;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000270
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000271 format = formatsave;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000272
Antoine Pitrou7056cb22013-02-17 01:04:57 +0100273 if (max > STATIC_FREELIST_ENTRIES) {
274 freelist.entries = PyMem_NEW(freelistentry_t, max);
275 if (freelist.entries == NULL) {
276 PyErr_NoMemory();
277 return 0;
278 }
279 freelist.entries_malloced = 1;
Benjamin Peterson7ed67272012-03-16 12:21:02 -0500280 }
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400281
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000282 if (compat) {
283 if (max == 0) {
284 if (args == NULL)
285 return 1;
Victor Stinner6ced7c42011-03-21 18:15:42 +0100286 PyErr_Format(PyExc_TypeError,
287 "%.200s%s takes no arguments",
288 fname==NULL ? "function" : fname,
289 fname==NULL ? "" : "()");
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400290 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000291 }
292 else if (min == 1 && max == 1) {
293 if (args == NULL) {
Victor Stinner6ced7c42011-03-21 18:15:42 +0100294 PyErr_Format(PyExc_TypeError,
295 "%.200s%s takes at least one argument",
296 fname==NULL ? "function" : fname,
297 fname==NULL ? "" : "()");
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400298 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000299 }
300 msg = convertitem(args, &format, p_va, flags, levels,
301 msgbuf, sizeof(msgbuf), &freelist);
302 if (msg == NULL)
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400303 return cleanreturn(1, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000304 seterror(levels[0], msg, levels+1, fname, message);
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400305 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000306 }
307 else {
308 PyErr_SetString(PyExc_SystemError,
309 "old style getargs format uses new features");
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400310 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000311 }
312 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000313
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000314 if (!PyTuple_Check(args)) {
315 PyErr_SetString(PyExc_SystemError,
316 "new style getargs format but argument is not a tuple");
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400317 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000318 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000319
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000320 len = PyTuple_GET_SIZE(args);
Guido van Rossum98297ee2007-11-06 21:34:58 +0000321
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000322 if (len < min || max < len) {
Victor Stinner6ced7c42011-03-21 18:15:42 +0100323 if (message == NULL)
324 PyErr_Format(PyExc_TypeError,
325 "%.150s%s takes %s %d argument%s (%ld given)",
326 fname==NULL ? "function" : fname,
327 fname==NULL ? "" : "()",
328 min==max ? "exactly"
329 : len < min ? "at least" : "at most",
330 len < min ? min : max,
331 (len < min ? min : max) == 1 ? "" : "s",
332 Py_SAFE_DOWNCAST(len, Py_ssize_t, long));
333 else
334 PyErr_SetString(PyExc_TypeError, message);
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400335 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000336 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000337
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000338 for (i = 0; i < len; i++) {
339 if (*format == '|')
340 format++;
341 msg = convertitem(PyTuple_GET_ITEM(args, i), &format, p_va,
342 flags, levels, msgbuf,
343 sizeof(msgbuf), &freelist);
344 if (msg) {
Serhiy Storchakac4b813d2016-02-08 01:06:11 +0200345 seterror(i+1, msg, levels, fname, message);
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400346 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000347 }
348 }
Guido van Rossum231a41e1997-12-09 20:36:39 +0000349
Antoine Pitrou4de74572013-02-09 23:11:27 +0100350 if (*format != '\0' && !Py_ISALPHA(Py_CHARMASK(*format)) &&
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000351 *format != '(' &&
352 *format != '|' && *format != ':' && *format != ';') {
353 PyErr_Format(PyExc_SystemError,
354 "bad format string: %.200s", formatsave);
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400355 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000356 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000357
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400358 return cleanreturn(1, &freelist);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000359}
360
361
362
363static void
Victor Stinner84bb1cf2013-05-17 00:12:04 +0200364seterror(Py_ssize_t iarg, const char *msg, int *levels, const char *fname,
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000365 const char *message)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000366{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000367 char buf[512];
368 int i;
369 char *p = buf;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000370
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000371 if (PyErr_Occurred())
372 return;
373 else if (message == NULL) {
374 if (fname != NULL) {
375 PyOS_snprintf(p, sizeof(buf), "%.200s() ", fname);
376 p += strlen(p);
377 }
378 if (iarg != 0) {
379 PyOS_snprintf(p, sizeof(buf) - (p - buf),
Richard Oudkerk25296ce2013-05-18 17:35:19 +0100380 "argument %" PY_FORMAT_SIZE_T "d", iarg);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000381 i = 0;
382 p += strlen(p);
Georg Brandl142ad662013-10-14 07:01:11 +0200383 while (i < 32 && levels[i] > 0 && (int)(p-buf) < 220) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000384 PyOS_snprintf(p, sizeof(buf) - (p - buf),
385 ", item %d", levels[i]-1);
386 p += strlen(p);
387 i++;
388 }
389 }
390 else {
391 PyOS_snprintf(p, sizeof(buf) - (p - buf), "argument");
392 p += strlen(p);
393 }
394 PyOS_snprintf(p, sizeof(buf) - (p - buf), " %.256s", msg);
395 message = buf;
396 }
397 PyErr_SetString(PyExc_TypeError, message);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000398}
399
400
401/* Convert a tuple argument.
402 On entry, *p_format points to the character _after_ the opening '('.
403 On successful exit, *p_format points to the closing ')'.
404 If successful:
405 *p_format and *p_va are updated,
406 *levels and *msgbuf are untouched,
407 and NULL is returned.
408 If the argument is invalid:
409 *p_format is unchanged,
410 *p_va is undefined,
411 *levels is a 0-terminated list of item numbers,
412 *msgbuf contains an error message, whose format is:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000413 "must be <typename1>, not <typename2>", where:
414 <typename1> is the name of the expected type, and
415 <typename2> is the name of the actual type,
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000416 and msgbuf is returned.
417*/
418
419static char *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000420converttuple(PyObject *arg, const char **p_format, va_list *p_va, int flags,
Guido van Rossum98297ee2007-11-06 21:34:58 +0000421 int *levels, char *msgbuf, size_t bufsize, int toplevel,
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400422 freelist_t *freelist)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000423{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000424 int level = 0;
425 int n = 0;
426 const char *format = *p_format;
427 int i;
Victor Stinner74387f52013-11-18 01:21:12 +0100428 Py_ssize_t len;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000429
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000430 for (;;) {
431 int c = *format++;
432 if (c == '(') {
433 if (level == 0)
434 n++;
435 level++;
436 }
437 else if (c == ')') {
438 if (level == 0)
439 break;
440 level--;
441 }
442 else if (c == ':' || c == ';' || c == '\0')
443 break;
Antoine Pitrou4de74572013-02-09 23:11:27 +0100444 else if (level == 0 && Py_ISALPHA(Py_CHARMASK(c)))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000445 n++;
446 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000447
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000448 if (!PySequence_Check(arg) || PyBytes_Check(arg)) {
449 levels[0] = 0;
450 PyOS_snprintf(msgbuf, bufsize,
451 toplevel ? "expected %d arguments, not %.50s" :
452 "must be %d-item sequence, not %.50s",
453 n,
454 arg == Py_None ? "None" : arg->ob_type->tp_name);
455 return msgbuf;
456 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000457
Victor Stinner74387f52013-11-18 01:21:12 +0100458 len = PySequence_Size(arg);
459 if (len != n) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000460 levels[0] = 0;
Victor Stinner74387f52013-11-18 01:21:12 +0100461 if (toplevel) {
462 PyOS_snprintf(msgbuf, bufsize,
463 "expected %d arguments, not %" PY_FORMAT_SIZE_T "d",
464 n, len);
465 }
466 else {
467 PyOS_snprintf(msgbuf, bufsize,
468 "must be sequence of length %d, "
469 "not %" PY_FORMAT_SIZE_T "d",
470 n, len);
471 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000472 return msgbuf;
473 }
Ka-Ping Yee20579702001-01-15 22:14:16 +0000474
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000475 format = *p_format;
476 for (i = 0; i < n; i++) {
477 char *msg;
478 PyObject *item;
479 item = PySequence_GetItem(arg, i);
480 if (item == NULL) {
481 PyErr_Clear();
482 levels[0] = i+1;
483 levels[1] = 0;
484 strncpy(msgbuf, "is not retrievable", bufsize);
485 return msgbuf;
486 }
487 msg = convertitem(item, &format, p_va, flags, levels+1,
488 msgbuf, bufsize, freelist);
489 /* PySequence_GetItem calls tp->sq_item, which INCREFs */
490 Py_XDECREF(item);
491 if (msg != NULL) {
492 levels[0] = i+1;
493 return msg;
494 }
495 }
Ka-Ping Yee20579702001-01-15 22:14:16 +0000496
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000497 *p_format = format;
498 return NULL;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000499}
500
501
502/* Convert a single item. */
503
504static char *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000505convertitem(PyObject *arg, const char **p_format, va_list *p_va, int flags,
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400506 int *levels, char *msgbuf, size_t bufsize, freelist_t *freelist)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000507{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000508 char *msg;
509 const char *format = *p_format;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000510
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000511 if (*format == '(' /* ')' */) {
512 format++;
513 msg = converttuple(arg, &format, p_va, flags, levels, msgbuf,
514 bufsize, 0, freelist);
515 if (msg == NULL)
516 format++;
517 }
518 else {
519 msg = convertsimple(arg, &format, p_va, flags,
520 msgbuf, bufsize, freelist);
521 if (msg != NULL)
522 levels[0] = 0;
523 }
524 if (msg == NULL)
525 *p_format = format;
526 return msg;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000527}
528
529
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000530
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000531/* Format an error message generated by convertsimple(). */
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000532
533static char *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000534converterr(const char *expected, PyObject *arg, char *msgbuf, size_t bufsize)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000535{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000536 assert(expected != NULL);
537 assert(arg != NULL);
Serhiy Storchakac4b813d2016-02-08 01:06:11 +0200538 if (expected[0] == '(') {
539 PyOS_snprintf(msgbuf, bufsize,
540 "%.100s", expected);
541 }
542 else {
543 PyOS_snprintf(msgbuf, bufsize,
544 "must be %.50s, not %.50s", expected,
545 arg == Py_None ? "None" : arg->ob_type->tp_name);
546 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000547 return msgbuf;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000548}
549
550#define CONV_UNICODE "(unicode conversion error)"
551
Guido van Rossum45aecf42006-03-15 04:58:47 +0000552/* Explicitly check for float arguments when integers are expected.
553 Return 1 for error, 0 if ok. */
Neil Schemenauer5042da62003-02-04 20:59:40 +0000554static int
555float_argument_error(PyObject *arg)
556{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000557 if (PyFloat_Check(arg)) {
558 PyErr_SetString(PyExc_TypeError,
559 "integer argument expected, got float" );
560 return 1;
561 }
562 else
563 return 0;
Neil Schemenauer5042da62003-02-04 20:59:40 +0000564}
565
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000566/* Convert a non-tuple argument. Return NULL if conversion went OK,
567 or a string with a message describing the failure. The message is
568 formatted as "must be <desired type>, not <actual type>".
569 When failing, an exception may or may not have been raised.
Georg Brandl6dd14612005-09-14 19:29:53 +0000570 Don't call if a tuple is expected.
571
572 When you add new format codes, please don't forget poor skipitem() below.
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000573*/
574
575static char *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000576convertsimple(PyObject *arg, const char **p_format, va_list *p_va, int flags,
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400577 char *msgbuf, size_t bufsize, freelist_t *freelist)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000578{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000579 /* For # codes */
580#define FETCH_SIZE int *q=NULL;Py_ssize_t *q2=NULL;\
581 if (flags & FLAG_SIZE_T) q2=va_arg(*p_va, Py_ssize_t*); \
582 else q=va_arg(*p_va, int*);
Victor Stinnerb3c9e072011-01-04 02:07:34 +0000583#define STORE_SIZE(s) \
584 if (flags & FLAG_SIZE_T) \
585 *q2=s; \
586 else { \
587 if (INT_MAX < s) { \
588 PyErr_SetString(PyExc_OverflowError, \
589 "size does not fit in an int"); \
590 return converterr("", arg, msgbuf, bufsize); \
591 } \
Victor Stinner9550ef32013-06-05 01:18:13 +0200592 *q = (int)s; \
Victor Stinnerb3c9e072011-01-04 02:07:34 +0000593 }
Martin v. Löwis18e16552006-02-15 17:27:45 +0000594#define BUFFER_LEN ((flags & FLAG_SIZE_T) ? *q2:*q)
Victor Stinner6ab8e822011-01-04 11:16:49 +0000595#define RETURN_ERR_OCCURRED return msgbuf
Martin v. Löwis18e16552006-02-15 17:27:45 +0000596
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000597 const char *format = *p_format;
598 char c = *format++;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200599 char *sarg;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000600
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000601 switch (c) {
Guido van Rossum98297ee2007-11-06 21:34:58 +0000602
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000603 case 'b': { /* unsigned byte -- very short int */
604 char *p = va_arg(*p_va, char *);
605 long ival;
606 if (float_argument_error(arg))
Victor Stinner6ab8e822011-01-04 11:16:49 +0000607 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000608 ival = PyLong_AsLong(arg);
609 if (ival == -1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000610 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000611 else if (ival < 0) {
612 PyErr_SetString(PyExc_OverflowError,
Victor Stinner6ab8e822011-01-04 11:16:49 +0000613 "unsigned byte integer is less than minimum");
614 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000615 }
616 else if (ival > UCHAR_MAX) {
617 PyErr_SetString(PyExc_OverflowError,
Victor Stinner6ab8e822011-01-04 11:16:49 +0000618 "unsigned byte integer is greater than maximum");
619 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000620 }
621 else
622 *p = (unsigned char) ival;
623 break;
624 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000625
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000626 case 'B': {/* byte sized bitfield - both signed and unsigned
627 values allowed */
628 char *p = va_arg(*p_va, char *);
629 long ival;
630 if (float_argument_error(arg))
Victor Stinner6ab8e822011-01-04 11:16:49 +0000631 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000632 ival = PyLong_AsUnsignedLongMask(arg);
633 if (ival == -1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000634 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000635 else
636 *p = (unsigned char) ival;
637 break;
638 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000639
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000640 case 'h': {/* signed short int */
641 short *p = va_arg(*p_va, short *);
642 long ival;
643 if (float_argument_error(arg))
Victor Stinner6ab8e822011-01-04 11:16:49 +0000644 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000645 ival = PyLong_AsLong(arg);
646 if (ival == -1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000647 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000648 else if (ival < SHRT_MIN) {
649 PyErr_SetString(PyExc_OverflowError,
Victor Stinner6ab8e822011-01-04 11:16:49 +0000650 "signed short integer is less than minimum");
651 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000652 }
653 else if (ival > SHRT_MAX) {
654 PyErr_SetString(PyExc_OverflowError,
Victor Stinner6ab8e822011-01-04 11:16:49 +0000655 "signed short integer is greater than maximum");
656 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000657 }
658 else
659 *p = (short) ival;
660 break;
661 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000662
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000663 case 'H': { /* short int sized bitfield, both signed and
664 unsigned allowed */
665 unsigned short *p = va_arg(*p_va, unsigned short *);
666 long ival;
667 if (float_argument_error(arg))
Victor Stinner6ab8e822011-01-04 11:16:49 +0000668 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000669 ival = PyLong_AsUnsignedLongMask(arg);
670 if (ival == -1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000671 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000672 else
673 *p = (unsigned short) ival;
674 break;
675 }
Martin v. Löwis18e16552006-02-15 17:27:45 +0000676
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000677 case 'i': {/* signed int */
678 int *p = va_arg(*p_va, int *);
679 long ival;
680 if (float_argument_error(arg))
Victor Stinner6ab8e822011-01-04 11:16:49 +0000681 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000682 ival = PyLong_AsLong(arg);
683 if (ival == -1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000684 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000685 else if (ival > INT_MAX) {
686 PyErr_SetString(PyExc_OverflowError,
Victor Stinner6ab8e822011-01-04 11:16:49 +0000687 "signed integer is greater than maximum");
688 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000689 }
690 else if (ival < INT_MIN) {
691 PyErr_SetString(PyExc_OverflowError,
Victor Stinner6ab8e822011-01-04 11:16:49 +0000692 "signed integer is less than minimum");
693 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000694 }
695 else
696 *p = ival;
697 break;
698 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000699
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000700 case 'I': { /* int sized bitfield, both signed and
701 unsigned allowed */
702 unsigned int *p = va_arg(*p_va, unsigned int *);
703 unsigned int ival;
704 if (float_argument_error(arg))
Victor Stinner6ab8e822011-01-04 11:16:49 +0000705 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000706 ival = (unsigned int)PyLong_AsUnsignedLongMask(arg);
707 if (ival == (unsigned int)-1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000708 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000709 else
710 *p = ival;
711 break;
712 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000713
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000714 case 'n': /* Py_ssize_t */
715 {
716 PyObject *iobj;
717 Py_ssize_t *p = va_arg(*p_va, Py_ssize_t *);
718 Py_ssize_t ival = -1;
719 if (float_argument_error(arg))
Victor Stinner6ab8e822011-01-04 11:16:49 +0000720 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000721 iobj = PyNumber_Index(arg);
722 if (iobj != NULL) {
723 ival = PyLong_AsSsize_t(iobj);
724 Py_DECREF(iobj);
725 }
726 if (ival == -1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000727 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000728 *p = ival;
729 break;
730 }
731 case 'l': {/* long int */
732 long *p = va_arg(*p_va, long *);
733 long 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 = PyLong_AsLong(arg);
737 if (ival == -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 }
Thomas Hellera4ea6032003-04-17 18:55:45 +0000743
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000744 case 'k': { /* long sized bitfield */
745 unsigned long *p = va_arg(*p_va, unsigned long *);
746 unsigned long ival;
747 if (PyLong_Check(arg))
748 ival = PyLong_AsUnsignedLongMask(arg);
749 else
Serhiy Storchakac4b813d2016-02-08 01:06:11 +0200750 return converterr("int", arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000751 *p = ival;
752 break;
753 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000754
Guido van Rossum3dbba6e1999-01-25 21:48:56 +0000755#ifdef HAVE_LONG_LONG
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000756 case 'L': {/* PY_LONG_LONG */
757 PY_LONG_LONG *p = va_arg( *p_va, PY_LONG_LONG * );
758 PY_LONG_LONG ival;
Mark Dickinsonc7301312010-06-10 16:05:10 +0000759 if (float_argument_error(arg))
Victor Stinner6ab8e822011-01-04 11:16:49 +0000760 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000761 ival = PyLong_AsLongLong(arg);
Mark Dickinsonc7301312010-06-10 16:05:10 +0000762 if (ival == (PY_LONG_LONG)-1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000763 RETURN_ERR_OCCURRED;
Mark Dickinsonc7301312010-06-10 16:05:10 +0000764 else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000765 *p = ival;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000766 break;
767 }
Thomas Hellera4ea6032003-04-17 18:55:45 +0000768
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000769 case 'K': { /* long long sized bitfield */
770 unsigned PY_LONG_LONG *p = va_arg(*p_va, unsigned PY_LONG_LONG *);
771 unsigned PY_LONG_LONG ival;
772 if (PyLong_Check(arg))
773 ival = PyLong_AsUnsignedLongLongMask(arg);
774 else
Serhiy Storchakac4b813d2016-02-08 01:06:11 +0200775 return converterr("int", arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000776 *p = ival;
777 break;
778 }
Guido van Rossum1a8791e1998-08-04 22:46:29 +0000779#endif
Guido van Rossum98297ee2007-11-06 21:34:58 +0000780
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000781 case 'f': {/* float */
782 float *p = va_arg(*p_va, float *);
783 double dval = PyFloat_AsDouble(arg);
784 if (PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000785 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000786 else
787 *p = (float) dval;
788 break;
789 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000790
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000791 case 'd': {/* double */
792 double *p = va_arg(*p_va, double *);
793 double dval = PyFloat_AsDouble(arg);
794 if (PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000795 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000796 else
797 *p = dval;
798 break;
799 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000800
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000801 case 'D': {/* complex double */
802 Py_complex *p = va_arg(*p_va, Py_complex *);
803 Py_complex cval;
804 cval = PyComplex_AsCComplex(arg);
805 if (PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000806 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000807 else
808 *p = cval;
809 break;
810 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000811
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000812 case 'c': {/* char */
813 char *p = va_arg(*p_va, char *);
814 if (PyBytes_Check(arg) && PyBytes_Size(arg) == 1)
815 *p = PyBytes_AS_STRING(arg)[0];
Eli Bendersky906b88f2011-07-29 07:05:08 +0300816 else if (PyByteArray_Check(arg) && PyByteArray_Size(arg) == 1)
817 *p = PyByteArray_AS_STRING(arg)[0];
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000818 else
819 return converterr("a byte string of length 1", arg, msgbuf, bufsize);
820 break;
821 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000822
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000823 case 'C': {/* unicode char */
824 int *p = va_arg(*p_va, int *);
Victor Stinnere1335c72011-10-04 20:53:03 +0200825 int kind;
826 void *data;
827
828 if (!PyUnicode_Check(arg))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000829 return converterr("a unicode character", arg, msgbuf, bufsize);
Victor Stinnere1335c72011-10-04 20:53:03 +0200830
831 if (PyUnicode_READY(arg))
832 RETURN_ERR_OCCURRED;
833
834 if (PyUnicode_GET_LENGTH(arg) != 1)
835 return converterr("a unicode character", arg, msgbuf, bufsize);
836
837 kind = PyUnicode_KIND(arg);
838 data = PyUnicode_DATA(arg);
839 *p = PyUnicode_READ(kind, data, 0);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000840 break;
841 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000842
Larry Hastingsfaf91e72012-05-05 16:54:29 -0700843 case 'p': {/* boolean *p*redicate */
844 int *p = va_arg(*p_va, int *);
845 int val = PyObject_IsTrue(arg);
846 if (val > 0)
847 *p = 1;
848 else if (val == 0)
849 *p = 0;
850 else
851 RETURN_ERR_OCCURRED;
852 break;
853 }
854
Victor Stinner3dcb5ac2010-06-08 22:54:19 +0000855 /* XXX WAAAAH! 's', 'y', 'z', 'u', 'Z', 'e', 'w' codes all
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000856 need to be cleaned up! */
Guido van Rossum98297ee2007-11-06 21:34:58 +0000857
Serhiy Storchakab757c832014-12-05 22:25:22 +0200858 case 'y': {/* any bytes-like object */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000859 void **p = (void **)va_arg(*p_va, char **);
860 char *buf;
861 Py_ssize_t count;
862 if (*format == '*') {
863 if (getbuffer(arg, (Py_buffer*)p, &buf) < 0)
864 return converterr(buf, arg, msgbuf, bufsize);
865 format++;
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400866 if (addcleanup(p, freelist, cleanup_buffer)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000867 return converterr(
868 "(cleanup problem)",
869 arg, msgbuf, bufsize);
870 }
871 break;
872 }
873 count = convertbuffer(arg, p, &buf);
874 if (count < 0)
875 return converterr(buf, arg, msgbuf, bufsize);
Victor Stinner06e49dd2010-06-13 18:21:50 +0000876 if (*format == '#') {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000877 FETCH_SIZE;
878 STORE_SIZE(count);
879 format++;
Victor Stinner06e49dd2010-06-13 18:21:50 +0000880 } else {
Serhiy Storchakad8a14472014-09-06 20:07:17 +0300881 if (strlen(*p) != (size_t)count) {
882 PyErr_SetString(PyExc_ValueError, "embedded null byte");
883 RETURN_ERR_OCCURRED;
884 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000885 }
886 break;
887 }
Walter Dörwald612344f2007-05-04 19:28:21 +0000888
Serhiy Storchakab757c832014-12-05 22:25:22 +0200889 case 's': /* text string or bytes-like object */
890 case 'z': /* text string, bytes-like object or None */
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000891 {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000892 if (*format == '*') {
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000893 /* "s*" or "z*" */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000894 Py_buffer *p = (Py_buffer *)va_arg(*p_va, Py_buffer *);
Martin v. Löwis423be952008-08-13 15:53:07 +0000895
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000896 if (c == 'z' && arg == Py_None)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000897 PyBuffer_FillInfo(p, NULL, NULL, 0, 1, 0);
898 else if (PyUnicode_Check(arg)) {
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200899 Py_ssize_t len;
900 sarg = PyUnicode_AsUTF8AndSize(arg, &len);
901 if (sarg == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000902 return converterr(CONV_UNICODE,
903 arg, msgbuf, bufsize);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200904 PyBuffer_FillInfo(p, arg, sarg, len, 1, 0);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000905 }
Serhiy Storchakab757c832014-12-05 22:25:22 +0200906 else { /* any bytes-like object */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000907 char *buf;
908 if (getbuffer(arg, p, &buf) < 0)
909 return converterr(buf, arg, msgbuf, bufsize);
910 }
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400911 if (addcleanup(p, freelist, cleanup_buffer)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000912 return converterr(
913 "(cleanup problem)",
914 arg, msgbuf, bufsize);
915 }
916 format++;
Serhiy Storchakab757c832014-12-05 22:25:22 +0200917 } else if (*format == '#') { /* a string or read-only bytes-like object */
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000918 /* "s#" or "z#" */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000919 void **p = (void **)va_arg(*p_va, char **);
920 FETCH_SIZE;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000921
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000922 if (c == 'z' && arg == Py_None) {
923 *p = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000924 STORE_SIZE(0);
925 }
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 *p = sarg;
933 STORE_SIZE(len);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000934 }
Serhiy Storchakab757c832014-12-05 22:25:22 +0200935 else { /* read-only bytes-like object */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000936 /* XXX Really? */
937 char *buf;
938 Py_ssize_t count = convertbuffer(arg, p, &buf);
939 if (count < 0)
940 return converterr(buf, arg, msgbuf, bufsize);
941 STORE_SIZE(count);
942 }
943 format++;
944 } else {
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000945 /* "s" or "z" */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000946 char **p = va_arg(*p_va, char **);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200947 Py_ssize_t len;
948 sarg = NULL;
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 else if (PyUnicode_Check(arg)) {
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200953 sarg = PyUnicode_AsUTF8AndSize(arg, &len);
954 if (sarg == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000955 return converterr(CONV_UNICODE,
956 arg, msgbuf, bufsize);
Serhiy Storchakad8a14472014-09-06 20:07:17 +0300957 if (strlen(sarg) != (size_t)len) {
958 PyErr_SetString(PyExc_ValueError, "embedded null character");
959 RETURN_ERR_OCCURRED;
960 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200961 *p = sarg;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000962 }
963 else
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000964 return converterr(c == 'z' ? "str or None" : "str",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000965 arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000966 }
967 break;
968 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000969
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000970 case 'u': /* raw unicode buffer (Py_UNICODE *) */
971 case 'Z': /* raw unicode buffer or None */
972 {
Brett Cannonb94767f2011-02-22 20:15:44 +0000973 Py_UNICODE **p = va_arg(*p_va, Py_UNICODE **);
974
Serhiy Storchakab757c832014-12-05 22:25:22 +0200975 if (*format == '#') {
Serhiy Storchakad6e53da2015-04-19 21:11:30 +0300976 /* "u#" or "Z#" */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000977 FETCH_SIZE;
Travis E. Oliphantddacf962007-10-13 21:03:27 +0000978
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000979 if (c == 'Z' && arg == Py_None) {
980 *p = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000981 STORE_SIZE(0);
982 }
983 else if (PyUnicode_Check(arg)) {
Victor Stinnerbeac78b2011-10-11 21:55:01 +0200984 Py_ssize_t len;
985 *p = PyUnicode_AsUnicodeAndSize(arg, &len);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200986 if (*p == NULL)
987 RETURN_ERR_OCCURRED;
Victor Stinnerbeac78b2011-10-11 21:55:01 +0200988 STORE_SIZE(len);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000989 }
Victor Stinner5216e6d2010-06-08 21:45:51 +0000990 else
Serhiy Storchakad6e53da2015-04-19 21:11:30 +0300991 return converterr(c == 'Z' ? "str or None" : "str",
992 arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000993 format++;
994 } else {
Serhiy Storchakad6e53da2015-04-19 21:11:30 +0300995 /* "u" or "Z" */
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000996 if (c == 'Z' && arg == Py_None)
997 *p = NULL;
Victor Stinner06e49dd2010-06-13 18:21:50 +0000998 else if (PyUnicode_Check(arg)) {
Victor Stinnerbeac78b2011-10-11 21:55:01 +0200999 Py_ssize_t len;
1000 *p = PyUnicode_AsUnicodeAndSize(arg, &len);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001001 if (*p == NULL)
1002 RETURN_ERR_OCCURRED;
Serhiy Storchakad8a14472014-09-06 20:07:17 +03001003 if (Py_UNICODE_strlen(*p) != (size_t)len) {
1004 PyErr_SetString(PyExc_ValueError, "embedded null character");
1005 RETURN_ERR_OCCURRED;
1006 }
Victor Stinner06e49dd2010-06-13 18:21:50 +00001007 } else
Victor Stinner3c9e6e92010-06-24 22:31:12 +00001008 return converterr(c == 'Z' ? "str or None" : "str",
1009 arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001010 }
1011 break;
1012 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001013
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001014 case 'e': {/* encoded string */
1015 char **buffer;
1016 const char *encoding;
1017 PyObject *s;
1018 int recode_strings;
1019 Py_ssize_t size;
1020 const char *ptr;
Jeremy Hylton4819e972001-10-11 14:40:37 +00001021
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001022 /* Get 'e' parameter: the encoding name */
1023 encoding = (const char *)va_arg(*p_va, const char *);
1024 if (encoding == NULL)
1025 encoding = PyUnicode_GetDefaultEncoding();
Martin v. Löwis423be952008-08-13 15:53:07 +00001026
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001027 /* Get output buffer parameter:
1028 's' (recode all objects via Unicode) or
1029 't' (only recode non-string objects)
1030 */
1031 if (*format == 's')
1032 recode_strings = 1;
1033 else if (*format == 't')
1034 recode_strings = 0;
1035 else
1036 return converterr(
1037 "(unknown parser marker combination)",
1038 arg, msgbuf, bufsize);
1039 buffer = (char **)va_arg(*p_va, char **);
1040 format++;
1041 if (buffer == NULL)
1042 return converterr("(buffer is NULL)",
1043 arg, msgbuf, bufsize);
Benjamin Peterson9edd2bd2008-08-27 00:31:37 +00001044
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001045 /* Encode object */
1046 if (!recode_strings &&
1047 (PyBytes_Check(arg) || PyByteArray_Check(arg))) {
1048 s = arg;
1049 Py_INCREF(s);
1050 if (PyObject_AsCharBuffer(s, &ptr, &size) < 0)
1051 return converterr("(AsCharBuffer failed)",
1052 arg, msgbuf, bufsize);
1053 }
1054 else {
1055 PyObject *u;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001056
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001057 /* Convert object to Unicode */
1058 u = PyUnicode_FromObject(arg);
1059 if (u == NULL)
1060 return converterr(
1061 "string or unicode or text buffer",
1062 arg, msgbuf, bufsize);
Guido van Rossum98297ee2007-11-06 21:34:58 +00001063
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001064 /* Encode object; use default error handling */
1065 s = PyUnicode_AsEncodedString(u,
1066 encoding,
1067 NULL);
1068 Py_DECREF(u);
1069 if (s == NULL)
1070 return converterr("(encoding failed)",
1071 arg, msgbuf, bufsize);
1072 if (!PyBytes_Check(s)) {
1073 Py_DECREF(s);
1074 return converterr(
1075 "(encoder failed to return bytes)",
1076 arg, msgbuf, bufsize);
1077 }
1078 size = PyBytes_GET_SIZE(s);
1079 ptr = PyBytes_AS_STRING(s);
1080 if (ptr == NULL)
1081 ptr = "";
1082 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001083
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001084 /* Write output; output is guaranteed to be 0-terminated */
1085 if (*format == '#') {
1086 /* Using buffer length parameter '#':
1087
1088 - if *buffer is NULL, a new buffer of the
1089 needed size is allocated and the data
1090 copied into it; *buffer is updated to point
1091 to the new buffer; the caller is
1092 responsible for PyMem_Free()ing it after
1093 usage
1094
1095 - if *buffer is not NULL, the data is
1096 copied to *buffer; *buffer_len has to be
1097 set to the size of the buffer on input;
1098 buffer overflow is signalled with an error;
1099 buffer has to provide enough room for the
1100 encoded string plus the trailing 0-byte
1101
1102 - in both cases, *buffer_len is updated to
1103 the size of the buffer /excluding/ the
1104 trailing 0-byte
1105
1106 */
1107 FETCH_SIZE;
1108
1109 format++;
1110 if (q == NULL && q2 == NULL) {
1111 Py_DECREF(s);
1112 return converterr(
1113 "(buffer_len is NULL)",
1114 arg, msgbuf, bufsize);
1115 }
1116 if (*buffer == NULL) {
1117 *buffer = PyMem_NEW(char, size + 1);
1118 if (*buffer == NULL) {
1119 Py_DECREF(s);
Victor Stinner2872e5b2010-06-06 20:38:02 +00001120 PyErr_NoMemory();
Victor Stinner6ab8e822011-01-04 11:16:49 +00001121 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001122 }
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001123 if (addcleanup(*buffer, freelist, cleanup_ptr)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001124 Py_DECREF(s);
1125 return converterr(
1126 "(cleanup problem)",
1127 arg, msgbuf, bufsize);
1128 }
1129 } else {
1130 if (size + 1 > BUFFER_LEN) {
1131 Py_DECREF(s);
Serhiy Storchakac4b813d2016-02-08 01:06:11 +02001132 PyErr_Format(PyExc_TypeError,
1133 "encoded string too long "
1134 "(%zd, maximum length %zd)",
1135 (Py_ssize_t)size, (Py_ssize_t)(BUFFER_LEN-1));
1136 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001137 }
1138 }
1139 memcpy(*buffer, ptr, size+1);
1140 STORE_SIZE(size);
1141 } else {
1142 /* Using a 0-terminated buffer:
1143
1144 - the encoded string has to be 0-terminated
1145 for this variant to work; if it is not, an
1146 error raised
1147
1148 - a new buffer of the needed size is
1149 allocated and the data copied into it;
1150 *buffer is updated to point to the new
1151 buffer; the caller is responsible for
1152 PyMem_Free()ing it after usage
1153
1154 */
1155 if ((Py_ssize_t)strlen(ptr) != size) {
1156 Py_DECREF(s);
1157 return converterr(
Serhiy Storchakac4b813d2016-02-08 01:06:11 +02001158 "encoded string without null bytes",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001159 arg, msgbuf, bufsize);
1160 }
1161 *buffer = PyMem_NEW(char, size + 1);
1162 if (*buffer == NULL) {
1163 Py_DECREF(s);
Victor Stinner2872e5b2010-06-06 20:38:02 +00001164 PyErr_NoMemory();
Victor Stinner6ab8e822011-01-04 11:16:49 +00001165 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001166 }
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001167 if (addcleanup(*buffer, freelist, cleanup_ptr)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001168 Py_DECREF(s);
1169 return converterr("(cleanup problem)",
1170 arg, msgbuf, bufsize);
1171 }
1172 memcpy(*buffer, ptr, size+1);
1173 }
1174 Py_DECREF(s);
1175 break;
1176 }
1177
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001178 case 'S': { /* PyBytes object */
1179 PyObject **p = va_arg(*p_va, PyObject **);
1180 if (PyBytes_Check(arg))
1181 *p = arg;
1182 else
1183 return converterr("bytes", arg, msgbuf, bufsize);
1184 break;
1185 }
1186
1187 case 'Y': { /* PyByteArray object */
1188 PyObject **p = va_arg(*p_va, PyObject **);
1189 if (PyByteArray_Check(arg))
1190 *p = arg;
1191 else
Victor Stinner5216e6d2010-06-08 21:45:51 +00001192 return converterr("bytearray", arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001193 break;
1194 }
1195
1196 case 'U': { /* PyUnicode object */
1197 PyObject **p = va_arg(*p_va, PyObject **);
Victor Stinnera1b0c9f2012-05-29 12:30:29 +02001198 if (PyUnicode_Check(arg)) {
1199 if (PyUnicode_READY(arg) == -1)
1200 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001201 *p = arg;
Victor Stinnera1b0c9f2012-05-29 12:30:29 +02001202 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001203 else
1204 return converterr("str", arg, msgbuf, bufsize);
1205 break;
1206 }
1207
1208 case 'O': { /* object */
1209 PyTypeObject *type;
1210 PyObject **p;
1211 if (*format == '!') {
1212 type = va_arg(*p_va, PyTypeObject*);
1213 p = va_arg(*p_va, PyObject **);
1214 format++;
1215 if (PyType_IsSubtype(arg->ob_type, type))
1216 *p = arg;
1217 else
1218 return converterr(type->tp_name, arg, msgbuf, bufsize);
1219
1220 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001221 else if (*format == '&') {
1222 typedef int (*converter)(PyObject *, void *);
1223 converter convert = va_arg(*p_va, converter);
1224 void *addr = va_arg(*p_va, void *);
1225 int res;
1226 format++;
1227 if (! (res = (*convert)(arg, addr)))
1228 return converterr("(unspecified)",
1229 arg, msgbuf, bufsize);
1230 if (res == Py_CLEANUP_SUPPORTED &&
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001231 addcleanup(addr, freelist, convert) == -1)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001232 return converterr("(cleanup problem)",
1233 arg, msgbuf, bufsize);
1234 }
1235 else {
1236 p = va_arg(*p_va, PyObject **);
1237 *p = arg;
1238 }
1239 break;
1240 }
1241
1242
Victor Stinner25e8ec42010-06-25 00:02:38 +00001243 case 'w': { /* "w*": memory buffer, read-write access */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001244 void **p = va_arg(*p_va, void **);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001245
Victor Stinner25e8ec42010-06-25 00:02:38 +00001246 if (*format != '*')
1247 return converterr(
Serhiy Storchakac4b813d2016-02-08 01:06:11 +02001248 "(invalid use of 'w' format character)",
Victor Stinner25e8ec42010-06-25 00:02:38 +00001249 arg, msgbuf, bufsize);
1250 format++;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001251
Victor Stinner25e8ec42010-06-25 00:02:38 +00001252 /* Caller is interested in Py_buffer, and the object
1253 supports it directly. */
1254 if (PyObject_GetBuffer(arg, (Py_buffer*)p, PyBUF_WRITABLE) < 0) {
1255 PyErr_Clear();
R David Murray861470c2014-10-05 11:47:01 -04001256 return converterr("read-write bytes-like object",
1257 arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001258 }
Victor Stinner8182b712010-07-28 00:40:58 +00001259 if (!PyBuffer_IsContiguous((Py_buffer*)p, 'C')) {
1260 PyBuffer_Release((Py_buffer*)p);
1261 return converterr("contiguous buffer", arg, msgbuf, bufsize);
1262 }
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001263 if (addcleanup(p, freelist, cleanup_buffer)) {
Victor Stinner25e8ec42010-06-25 00:02:38 +00001264 return converterr(
1265 "(cleanup problem)",
1266 arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001267 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001268 break;
1269 }
1270
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001271 default:
Serhiy Storchakac4b813d2016-02-08 01:06:11 +02001272 return converterr("(impossible<bad format char>)", arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001273
1274 }
1275
1276 *p_format = format;
1277 return NULL;
Victor Stinner6ab8e822011-01-04 11:16:49 +00001278
1279#undef FETCH_SIZE
1280#undef STORE_SIZE
1281#undef BUFFER_LEN
1282#undef RETURN_ERR_OCCURRED
Guido van Rossumfe3f1a21994-09-29 09:42:55 +00001283}
Guido van Rossumaa354651996-08-19 19:32:04 +00001284
Martin v. Löwis18e16552006-02-15 17:27:45 +00001285static Py_ssize_t
Fred Drake563dfc22001-10-23 14:41:08 +00001286convertbuffer(PyObject *arg, void **p, char **errmsg)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001287{
Victor Stinner5cb62392010-06-06 20:27:51 +00001288 PyBufferProcs *pb = Py_TYPE(arg)->tp_as_buffer;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001289 Py_ssize_t count;
1290 Py_buffer view;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001291
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001292 *errmsg = NULL;
1293 *p = NULL;
Victor Stinner8182b712010-07-28 00:40:58 +00001294 if (pb != NULL && pb->bf_releasebuffer != NULL) {
R David Murray861470c2014-10-05 11:47:01 -04001295 *errmsg = "read-only bytes-like object";
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001296 return -1;
1297 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001298
Victor Stinner8182b712010-07-28 00:40:58 +00001299 if (getbuffer(arg, &view, errmsg) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001300 return -1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001301 count = view.len;
1302 *p = view.buf;
1303 PyBuffer_Release(&view);
1304 return count;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001305}
Guido van Rossumaa354651996-08-19 19:32:04 +00001306
Martin v. Löwis423be952008-08-13 15:53:07 +00001307static int
Neal Norwitz2f99b242008-08-24 05:48:10 +00001308getbuffer(PyObject *arg, Py_buffer *view, char **errmsg)
Martin v. Löwis423be952008-08-13 15:53:07 +00001309{
Victor Stinner8182b712010-07-28 00:40:58 +00001310 if (PyObject_GetBuffer(arg, view, PyBUF_SIMPLE) != 0) {
R David Murray861470c2014-10-05 11:47:01 -04001311 *errmsg = "bytes-like object";
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001312 return -1;
1313 }
Victor Stinner5cb62392010-06-06 20:27:51 +00001314 if (!PyBuffer_IsContiguous(view, 'C')) {
Victor Stinner21e09482010-06-24 22:57:10 +00001315 PyBuffer_Release(view);
Victor Stinner5cb62392010-06-06 20:27:51 +00001316 *errmsg = "contiguous buffer";
1317 return -1;
1318 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001319 return 0;
Martin v. Löwis423be952008-08-13 15:53:07 +00001320}
1321
Guido van Rossumaa354651996-08-19 19:32:04 +00001322/* Support for keyword arguments donated by
1323 Geoff Philbrick <philbric@delphi.hks.com> */
1324
Tim Petersf8cd3e82001-10-27 04:26:57 +00001325/* Return false (0) for error, else true. */
Fred Drake563dfc22001-10-23 14:41:08 +00001326int
1327PyArg_ParseTupleAndKeywords(PyObject *args,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001328 PyObject *keywords,
1329 const char *format,
1330 char **kwlist, ...)
Guido van Rossumaa354651996-08-19 19:32:04 +00001331{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001332 int retval;
1333 va_list va;
Tim Peters45772cd2001-10-27 03:58:40 +00001334
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001335 if ((args == NULL || !PyTuple_Check(args)) ||
1336 (keywords != NULL && !PyDict_Check(keywords)) ||
1337 format == NULL ||
1338 kwlist == NULL)
1339 {
1340 PyErr_BadInternalCall();
1341 return 0;
1342 }
Tim Peters45772cd2001-10-27 03:58:40 +00001343
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001344 va_start(va, kwlist);
1345 retval = vgetargskeywords(args, keywords, format, kwlist, &va, 0);
1346 va_end(va);
1347 return retval;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001348}
1349
1350int
1351_PyArg_ParseTupleAndKeywords_SizeT(PyObject *args,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001352 PyObject *keywords,
1353 const char *format,
1354 char **kwlist, ...)
Martin v. Löwis18e16552006-02-15 17:27:45 +00001355{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001356 int retval;
1357 va_list va;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001358
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001359 if ((args == NULL || !PyTuple_Check(args)) ||
1360 (keywords != NULL && !PyDict_Check(keywords)) ||
1361 format == NULL ||
1362 kwlist == NULL)
1363 {
1364 PyErr_BadInternalCall();
1365 return 0;
1366 }
Martin v. Löwis18e16552006-02-15 17:27:45 +00001367
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001368 va_start(va, kwlist);
1369 retval = vgetargskeywords(args, keywords, format,
1370 kwlist, &va, FLAG_SIZE_T);
1371 va_end(va);
1372 return retval;
Guido van Rossumaa354651996-08-19 19:32:04 +00001373}
1374
1375
Brett Cannon711e7d92004-07-10 22:20:32 +00001376int
1377PyArg_VaParseTupleAndKeywords(PyObject *args,
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001378 PyObject *keywords,
Guido van Rossum98297ee2007-11-06 21:34:58 +00001379 const char *format,
Martin v. Löwis15e62742006-02-27 16:46:16 +00001380 char **kwlist, va_list va)
Brett Cannon711e7d92004-07-10 22:20:32 +00001381{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001382 int retval;
1383 va_list lva;
Brett Cannon711e7d92004-07-10 22:20:32 +00001384
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001385 if ((args == NULL || !PyTuple_Check(args)) ||
1386 (keywords != NULL && !PyDict_Check(keywords)) ||
1387 format == NULL ||
1388 kwlist == NULL)
1389 {
1390 PyErr_BadInternalCall();
1391 return 0;
1392 }
Brett Cannon711e7d92004-07-10 22:20:32 +00001393
Alexander Belopolskyf0f45142010-08-11 17:31:17 +00001394 Py_VA_COPY(lva, va);
Brett Cannon711e7d92004-07-10 22:20:32 +00001395
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001396 retval = vgetargskeywords(args, keywords, format, kwlist, &lva, 0);
1397 return retval;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001398}
1399
1400int
1401_PyArg_VaParseTupleAndKeywords_SizeT(PyObject *args,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001402 PyObject *keywords,
1403 const char *format,
1404 char **kwlist, va_list va)
Martin v. Löwis18e16552006-02-15 17:27:45 +00001405{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001406 int retval;
1407 va_list lva;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001408
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001409 if ((args == NULL || !PyTuple_Check(args)) ||
1410 (keywords != NULL && !PyDict_Check(keywords)) ||
1411 format == NULL ||
1412 kwlist == NULL)
1413 {
1414 PyErr_BadInternalCall();
1415 return 0;
1416 }
Martin v. Löwis18e16552006-02-15 17:27:45 +00001417
Alexander Belopolskyf0f45142010-08-11 17:31:17 +00001418 Py_VA_COPY(lva, va);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001419
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001420 retval = vgetargskeywords(args, keywords, format,
1421 kwlist, &lva, FLAG_SIZE_T);
1422 return retval;
Brett Cannon711e7d92004-07-10 22:20:32 +00001423}
1424
Benjamin Petersonfb886362010-04-24 18:21:17 +00001425int
1426PyArg_ValidateKeywordArguments(PyObject *kwargs)
1427{
Benjamin Petersonf6096542010-11-17 22:33:12 +00001428 if (!PyDict_Check(kwargs)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001429 PyErr_BadInternalCall();
1430 return 0;
1431 }
1432 if (!_PyDict_HasOnlyStringKeys(kwargs)) {
1433 PyErr_SetString(PyExc_TypeError,
1434 "keyword arguments must be strings");
1435 return 0;
1436 }
1437 return 1;
Benjamin Petersonfb886362010-04-24 18:21:17 +00001438}
1439
Christian Heimes380f7f22008-02-28 11:19:05 +00001440#define IS_END_OF_FORMAT(c) (c == '\0' || c == ';' || c == ':')
Brett Cannon711e7d92004-07-10 22:20:32 +00001441
Guido van Rossumaa354651996-08-19 19:32:04 +00001442static int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001443vgetargskeywords(PyObject *args, PyObject *keywords, const char *format,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001444 char **kwlist, va_list *p_va, int flags)
Guido van Rossumaa354651996-08-19 19:32:04 +00001445{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001446 char msgbuf[512];
1447 int levels[32];
1448 const char *fname, *msg, *custom_msg, *keyword;
1449 int min = INT_MAX;
Larry Hastings83a9f482012-03-20 20:06:16 +00001450 int max = INT_MAX;
Victor Stinner74387f52013-11-18 01:21:12 +01001451 int i, len;
1452 Py_ssize_t nargs, nkeywords;
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001453 PyObject *current_arg;
Antoine Pitrou7056cb22013-02-17 01:04:57 +01001454 freelistentry_t static_entries[STATIC_FREELIST_ENTRIES];
Benjamin Peterson40be9e52014-02-11 10:09:27 -05001455 freelist_t freelist;
1456
1457 freelist.entries = static_entries;
1458 freelist.first_available = 0;
1459 freelist.entries_malloced = 0;
Tim Petersf4331c12001-10-27 00:17:34 +00001460
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001461 assert(args != NULL && PyTuple_Check(args));
1462 assert(keywords == NULL || PyDict_Check(keywords));
1463 assert(format != NULL);
1464 assert(kwlist != NULL);
1465 assert(p_va != NULL);
Tim Peters45772cd2001-10-27 03:58:40 +00001466
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001467 /* grab the function name or custom error msg first (mutually exclusive) */
1468 fname = strchr(format, ':');
1469 if (fname) {
1470 fname++;
1471 custom_msg = NULL;
1472 }
1473 else {
1474 custom_msg = strchr(format,';');
1475 if (custom_msg)
1476 custom_msg++;
1477 }
Christian Heimes380f7f22008-02-28 11:19:05 +00001478
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001479 /* scan kwlist and get greatest possible nbr of args */
1480 for (len=0; kwlist[len]; len++)
1481 continue;
Tim Petersf8cd3e82001-10-27 04:26:57 +00001482
Antoine Pitrou7056cb22013-02-17 01:04:57 +01001483 if (len > STATIC_FREELIST_ENTRIES) {
1484 freelist.entries = PyMem_NEW(freelistentry_t, len);
1485 if (freelist.entries == NULL) {
1486 PyErr_NoMemory();
1487 return 0;
1488 }
1489 freelist.entries_malloced = 1;
Benjamin Peterson7ed67272012-03-16 12:21:02 -05001490 }
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001491
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001492 nargs = PyTuple_GET_SIZE(args);
1493 nkeywords = (keywords == NULL) ? 0 : PyDict_Size(keywords);
1494 if (nargs + nkeywords > len) {
Victor Stinner6ced7c42011-03-21 18:15:42 +01001495 PyErr_Format(PyExc_TypeError,
Victor Stinnercb29ec52013-11-18 02:05:31 +01001496 "%s%s takes at most %d argument%s (%zd given)",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001497 (fname == NULL) ? "function" : fname,
1498 (fname == NULL) ? "" : "()",
1499 len,
1500 (len == 1) ? "" : "s",
1501 nargs + nkeywords);
Benjamin Peterson01feaec2012-03-16 13:25:58 -05001502 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001503 }
Tim Petersc2f01122001-10-27 07:25:06 +00001504
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001505 /* convert tuple args and keyword args in same loop, using kwlist to drive process */
1506 for (i = 0; i < len; i++) {
1507 keyword = kwlist[i];
1508 if (*format == '|') {
Larry Hastings83a9f482012-03-20 20:06:16 +00001509 if (min != INT_MAX) {
1510 PyErr_SetString(PyExc_RuntimeError,
1511 "Invalid format string (| specified twice)");
1512 return cleanreturn(0, &freelist);
1513 }
1514
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001515 min = i;
1516 format++;
Larry Hastings83a9f482012-03-20 20:06:16 +00001517
1518 if (max != INT_MAX) {
1519 PyErr_SetString(PyExc_RuntimeError,
1520 "Invalid format string ($ before |)");
1521 return cleanreturn(0, &freelist);
1522 }
1523 }
1524 if (*format == '$') {
1525 if (max != INT_MAX) {
1526 PyErr_SetString(PyExc_RuntimeError,
1527 "Invalid format string ($ specified twice)");
1528 return cleanreturn(0, &freelist);
1529 }
1530
1531 max = i;
1532 format++;
1533
1534 if (max < nargs) {
1535 PyErr_Format(PyExc_TypeError,
1536 "Function takes %s %d positional arguments"
1537 " (%d given)",
1538 (min != INT_MAX) ? "at most" : "exactly",
1539 max, nargs);
1540 return cleanreturn(0, &freelist);
1541 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001542 }
1543 if (IS_END_OF_FORMAT(*format)) {
1544 PyErr_Format(PyExc_RuntimeError,
1545 "More keyword list entries (%d) than "
1546 "format specifiers (%d)", len, i);
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001547 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001548 }
1549 current_arg = NULL;
1550 if (nkeywords) {
1551 current_arg = PyDict_GetItemString(keywords, keyword);
1552 }
1553 if (current_arg) {
1554 --nkeywords;
1555 if (i < nargs) {
1556 /* arg present in tuple and in dict */
1557 PyErr_Format(PyExc_TypeError,
1558 "Argument given by name ('%s') "
1559 "and position (%d)",
1560 keyword, i+1);
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001561 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001562 }
1563 }
1564 else if (nkeywords && PyErr_Occurred())
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001565 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001566 else if (i < nargs)
1567 current_arg = PyTuple_GET_ITEM(args, i);
Christian Heimes380f7f22008-02-28 11:19:05 +00001568
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001569 if (current_arg) {
1570 msg = convertitem(current_arg, &format, p_va, flags,
1571 levels, msgbuf, sizeof(msgbuf), &freelist);
1572 if (msg) {
1573 seterror(i+1, msg, levels, fname, custom_msg);
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001574 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001575 }
1576 continue;
1577 }
Christian Heimes380f7f22008-02-28 11:19:05 +00001578
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001579 if (i < min) {
1580 PyErr_Format(PyExc_TypeError, "Required argument "
1581 "'%s' (pos %d) not found",
1582 keyword, i+1);
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001583 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001584 }
1585 /* current code reports success when all required args
1586 * fulfilled and no keyword args left, with no further
1587 * validation. XXX Maybe skip this in debug build ?
1588 */
1589 if (!nkeywords)
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001590 return cleanreturn(1, &freelist);
Guido van Rossumaa354651996-08-19 19:32:04 +00001591
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001592 /* We are into optional args, skip thru to any remaining
1593 * keyword args */
1594 msg = skipitem(&format, p_va, flags);
1595 if (msg) {
1596 PyErr_Format(PyExc_RuntimeError, "%s: '%s'", msg,
1597 format);
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001598 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001599 }
1600 }
Tim Petersb054be42001-10-27 05:07:41 +00001601
Larry Hastings83a9f482012-03-20 20:06:16 +00001602 if (!IS_END_OF_FORMAT(*format) && (*format != '|') && (*format != '$')) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001603 PyErr_Format(PyExc_RuntimeError,
1604 "more argument specifiers than keyword list entries "
1605 "(remaining format:'%s')", format);
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001606 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001607 }
Tim Petersc2f01122001-10-27 07:25:06 +00001608
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001609 /* make sure there are no extraneous keyword arguments */
1610 if (nkeywords > 0) {
1611 PyObject *key, *value;
1612 Py_ssize_t pos = 0;
1613 while (PyDict_Next(keywords, &pos, &key, &value)) {
1614 int match = 0;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001615 if (!PyUnicode_Check(key)) {
1616 PyErr_SetString(PyExc_TypeError,
1617 "keywords must be strings");
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001618 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001619 }
Antoine Pitrou7056cb22013-02-17 01:04:57 +01001620 for (i = 0; i < len; i++) {
1621 if (!PyUnicode_CompareWithASCIIString(key, kwlist[i])) {
1622 match = 1;
1623 break;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001624 }
1625 }
1626 if (!match) {
1627 PyErr_Format(PyExc_TypeError,
Victor Stinner93b55132010-05-19 00:54:06 +00001628 "'%U' is an invalid keyword "
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001629 "argument for this function",
Victor Stinner93b55132010-05-19 00:54:06 +00001630 key);
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001631 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001632 }
1633 }
1634 }
1635
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001636 return cleanreturn(1, &freelist);
Guido van Rossumaa354651996-08-19 19:32:04 +00001637}
1638
1639
1640static char *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001641skipitem(const char **p_format, va_list *p_va, int flags)
Guido van Rossumaa354651996-08-19 19:32:04 +00001642{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001643 const char *format = *p_format;
1644 char c = *format++;
Guido van Rossum98297ee2007-11-06 21:34:58 +00001645
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001646 switch (c) {
Georg Brandl6dd14612005-09-14 19:29:53 +00001647
Larry Hastingsa3479012012-05-08 23:52:03 -07001648 /*
1649 * codes that take a single data pointer as an argument
1650 * (the type of the pointer is irrelevant)
1651 */
Georg Brandl6dd14612005-09-14 19:29:53 +00001652
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001653 case 'b': /* byte -- very short int */
1654 case 'B': /* byte as bitfield */
1655 case 'h': /* short int */
1656 case 'H': /* short int as bitfield */
1657 case 'i': /* int */
1658 case 'I': /* int sized bitfield */
1659 case 'l': /* long int */
1660 case 'k': /* long int sized bitfield */
Guido van Rossum3dbba6e1999-01-25 21:48:56 +00001661#ifdef HAVE_LONG_LONG
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001662 case 'L': /* PY_LONG_LONG */
1663 case 'K': /* PY_LONG_LONG sized bitfield */
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001664#endif
Larry Hastingsa3479012012-05-08 23:52:03 -07001665 case 'n': /* Py_ssize_t */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001666 case 'f': /* float */
1667 case 'd': /* double */
1668 case 'D': /* complex double */
1669 case 'c': /* char */
1670 case 'C': /* unicode char */
Larry Hastings10ba07a2012-05-07 02:44:50 -07001671 case 'p': /* boolean predicate */
Larry Hastingsa3479012012-05-08 23:52:03 -07001672 case 'S': /* string object */
1673 case 'Y': /* string object */
1674 case 'U': /* unicode string object */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001675 {
1676 (void) va_arg(*p_va, void *);
1677 break;
1678 }
Martin v. Löwis18e16552006-02-15 17:27:45 +00001679
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001680 /* string codes */
Guido van Rossum98297ee2007-11-06 21:34:58 +00001681
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001682 case 'e': /* string with encoding */
1683 {
1684 (void) va_arg(*p_va, const char *);
1685 if (!(*format == 's' || *format == 't'))
1686 /* after 'e', only 's' and 't' is allowed */
1687 goto err;
1688 format++;
1689 /* explicit fallthrough to string cases */
1690 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001691
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001692 case 's': /* string */
1693 case 'z': /* string or None */
1694 case 'y': /* bytes */
1695 case 'u': /* unicode string */
Larry Hastingsd9e4a412012-05-08 03:51:18 -07001696 case 'Z': /* unicode string or None */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001697 case 'w': /* buffer, read-write */
1698 {
1699 (void) va_arg(*p_va, char **);
1700 if (*format == '#') {
1701 if (flags & FLAG_SIZE_T)
1702 (void) va_arg(*p_va, Py_ssize_t *);
1703 else
1704 (void) va_arg(*p_va, int *);
1705 format++;
1706 } else if ((c == 's' || c == 'z' || c == 'y') && *format == '*') {
1707 format++;
1708 }
1709 break;
1710 }
Georg Brandl6dd14612005-09-14 19:29:53 +00001711
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001712 case 'O': /* object */
1713 {
1714 if (*format == '!') {
1715 format++;
1716 (void) va_arg(*p_va, PyTypeObject*);
1717 (void) va_arg(*p_va, PyObject **);
1718 }
1719 else if (*format == '&') {
1720 typedef int (*converter)(PyObject *, void *);
1721 (void) va_arg(*p_va, converter);
1722 (void) va_arg(*p_va, void *);
1723 format++;
1724 }
1725 else {
1726 (void) va_arg(*p_va, PyObject **);
1727 }
1728 break;
1729 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001730
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001731 case '(': /* bypass tuple, not handled at all previously */
1732 {
1733 char *msg;
1734 for (;;) {
1735 if (*format==')')
1736 break;
1737 if (IS_END_OF_FORMAT(*format))
1738 return "Unmatched left paren in format "
1739 "string";
1740 msg = skipitem(&format, p_va, flags);
1741 if (msg)
1742 return msg;
1743 }
1744 format++;
1745 break;
1746 }
Christian Heimes380f7f22008-02-28 11:19:05 +00001747
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001748 case ')':
1749 return "Unmatched right paren in format string";
Christian Heimes380f7f22008-02-28 11:19:05 +00001750
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001751 default:
Georg Brandl6dd14612005-09-14 19:29:53 +00001752err:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001753 return "impossible<bad format char>";
Guido van Rossum98297ee2007-11-06 21:34:58 +00001754
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001755 }
Georg Brandl6dd14612005-09-14 19:29:53 +00001756
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001757 *p_format = format;
1758 return NULL;
Guido van Rossumaa354651996-08-19 19:32:04 +00001759}
Fred Drakee4616e62001-10-23 21:09:29 +00001760
1761
1762int
Martin v. Löwis76246742006-03-01 04:06:10 +00001763PyArg_UnpackTuple(PyObject *args, const char *name, Py_ssize_t min, Py_ssize_t max, ...)
Fred Drakee4616e62001-10-23 21:09:29 +00001764{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001765 Py_ssize_t i, l;
1766 PyObject **o;
1767 va_list vargs;
Fred Drakee4616e62001-10-23 21:09:29 +00001768
1769#ifdef HAVE_STDARG_PROTOTYPES
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001770 va_start(vargs, max);
Fred Drakee4616e62001-10-23 21:09:29 +00001771#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001772 va_start(vargs);
Fred Drakee4616e62001-10-23 21:09:29 +00001773#endif
1774
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001775 assert(min >= 0);
1776 assert(min <= max);
1777 if (!PyTuple_Check(args)) {
Christian Heimes48d8d212012-09-10 13:16:45 +02001778 va_end(vargs);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001779 PyErr_SetString(PyExc_SystemError,
1780 "PyArg_UnpackTuple() argument list is not a tuple");
1781 return 0;
1782 }
1783 l = PyTuple_GET_SIZE(args);
1784 if (l < min) {
1785 if (name != NULL)
1786 PyErr_Format(
1787 PyExc_TypeError,
1788 "%s expected %s%zd arguments, got %zd",
1789 name, (min == max ? "" : "at least "), min, l);
1790 else
1791 PyErr_Format(
1792 PyExc_TypeError,
1793 "unpacked tuple should have %s%zd elements,"
1794 " but has %zd",
1795 (min == max ? "" : "at least "), min, l);
1796 va_end(vargs);
1797 return 0;
1798 }
1799 if (l > max) {
1800 if (name != NULL)
1801 PyErr_Format(
1802 PyExc_TypeError,
1803 "%s expected %s%zd arguments, got %zd",
1804 name, (min == max ? "" : "at most "), max, l);
1805 else
1806 PyErr_Format(
1807 PyExc_TypeError,
1808 "unpacked tuple should have %s%zd elements,"
1809 " but has %zd",
1810 (min == max ? "" : "at most "), max, l);
1811 va_end(vargs);
1812 return 0;
1813 }
1814 for (i = 0; i < l; i++) {
1815 o = va_arg(vargs, PyObject **);
1816 *o = PyTuple_GET_ITEM(args, i);
1817 }
1818 va_end(vargs);
1819 return 1;
Fred Drakee4616e62001-10-23 21:09:29 +00001820}
Georg Brandl02c42872005-08-26 06:42:30 +00001821
1822
1823/* For type constructors that don't take keyword args
1824 *
Larry Hastingsb7ccb202014-01-18 23:50:21 -08001825 * Sets a TypeError and returns 0 if the args/kwargs is
Thomas Wouters89f507f2006-12-13 04:49:30 +00001826 * not empty, returns 1 otherwise
Georg Brandl02c42872005-08-26 06:42:30 +00001827 */
1828int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001829_PyArg_NoKeywords(const char *funcname, PyObject *kw)
Georg Brandl02c42872005-08-26 06:42:30 +00001830{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001831 if (kw == NULL)
1832 return 1;
1833 if (!PyDict_CheckExact(kw)) {
1834 PyErr_BadInternalCall();
1835 return 0;
1836 }
1837 if (PyDict_Size(kw) == 0)
1838 return 1;
Guido van Rossum98297ee2007-11-06 21:34:58 +00001839
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001840 PyErr_Format(PyExc_TypeError, "%s does not take keyword arguments",
1841 funcname);
1842 return 0;
Georg Brandl02c42872005-08-26 06:42:30 +00001843}
Larry Hastingsb7ccb202014-01-18 23:50:21 -08001844
1845
1846int
1847_PyArg_NoPositional(const char *funcname, PyObject *args)
1848{
1849 if (args == NULL)
1850 return 1;
1851 if (!PyTuple_CheckExact(args)) {
1852 PyErr_BadInternalCall();
1853 return 0;
1854 }
1855 if (PyTuple_GET_SIZE(args) == 0)
1856 return 1;
1857
1858 PyErr_Format(PyExc_TypeError, "%s does not take positional arguments",
1859 funcname);
1860 return 0;
1861}
1862
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001863#ifdef __cplusplus
1864};
1865#endif