blob: dd7ca9fed15ed2c762166e90c4d8d8022c353f05 [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>
Benjamin Petersona853a8b2017-09-07 11:13:59 -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 *, ...);
Victor Stinner6518a932017-01-17 01:29:49 +010030PyAPI_FUNC(int) _PyArg_ParseStack_SizeT(PyObject **args, Py_ssize_t nargs,
31 const char *format, ...);
Victor Stinner3e1fad62017-01-17 01:29:01 +010032PyAPI_FUNC(int) _PyArg_ParseStackAndKeywords_SizeT(PyObject **args, Py_ssize_t nargs, PyObject *kwnames,
Benjamin Peterson819a46f2016-09-09 20:45:06 -070033 struct _PyArg_Parser *parser, ...);
Serhiy Storchakaef1585e2015-12-25 20:01:53 +020034PyAPI_FUNC(int) _PyArg_ParseTuple_SizeT(PyObject *, const char *, ...);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000035PyAPI_FUNC(int) _PyArg_ParseTupleAndKeywords_SizeT(PyObject *, PyObject *,
36 const char *, char **, ...);
37PyAPI_FUNC(PyObject *) _Py_BuildValue_SizeT(const char *, ...);
Serhiy Storchakaef1585e2015-12-25 20:01:53 +020038PyAPI_FUNC(int) _PyArg_VaParse_SizeT(PyObject *, const char *, va_list);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000039PyAPI_FUNC(int) _PyArg_VaParseTupleAndKeywords_SizeT(PyObject *, PyObject *,
40 const char *, char **, va_list);
Benjamin Peterson4eef5052016-09-10 17:04:36 -070041
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +030042PyAPI_FUNC(int) _PyArg_ParseTupleAndKeywordsFast_SizeT(PyObject *, PyObject *,
43 struct _PyArg_Parser *, ...);
44PyAPI_FUNC(int) _PyArg_VaParseTupleAndKeywordsFast_SizeT(PyObject *, PyObject *,
45 struct _PyArg_Parser *, va_list);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000046#endif
47
Martin v. Löwis18e16552006-02-15 17:27:45 +000048#define FLAG_COMPAT 1
49#define FLAG_SIZE_T 2
50
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -040051typedef int (*destr_t)(PyObject *, void *);
52
53
54/* Keep track of "objects" that have been allocated or initialized and
55 which will need to be deallocated or cleaned up somehow if overall
56 parsing fails.
57*/
58typedef struct {
59 void *item;
60 destr_t destructor;
61} freelistentry_t;
62
63typedef struct {
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -040064 freelistentry_t *entries;
Antoine Pitrou7056cb22013-02-17 01:04:57 +010065 int first_available;
66 int entries_malloced;
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -040067} freelist_t;
68
Antoine Pitrou7056cb22013-02-17 01:04:57 +010069#define STATIC_FREELIST_ENTRIES 8
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000070
71/* Forward */
Victor Stinner6518a932017-01-17 01:29:49 +010072static int vgetargs1_impl(PyObject *args, PyObject **stack, Py_ssize_t nargs,
73 const char *format, va_list *p_va, int flags);
Jeremy Hyltonaf68c872005-12-10 18:50:16 +000074static int vgetargs1(PyObject *, const char *, va_list *, int);
Victor Stinner84bb1cf2013-05-17 00:12:04 +020075static void seterror(Py_ssize_t, const char *, int *, const char *, const char *);
Serhiy Storchakaef1585e2015-12-25 20:01:53 +020076static const char *convertitem(PyObject *, const char **, va_list *, int, int *,
77 char *, size_t, freelist_t *);
78static const char *converttuple(PyObject *, const char **, va_list *, int,
79 int *, char *, size_t, int, freelist_t *);
80static const char *convertsimple(PyObject *, const char **, va_list *, int,
81 char *, size_t, freelist_t *);
Serhiy Storchaka85b0f5b2016-11-20 10:16:47 +020082static Py_ssize_t convertbuffer(PyObject *, const void **p, const char **);
Serhiy Storchakaef1585e2015-12-25 20:01:53 +020083static int getbuffer(PyObject *, Py_buffer *, const char**);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000084
Tim Petersdbd9ba62000-07-09 03:09:57 +000085static int vgetargskeywords(PyObject *, PyObject *,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000086 const char *, char **, va_list *, int);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +030087static int vgetargskeywordsfast(PyObject *, PyObject *,
88 struct _PyArg_Parser *, va_list *, int);
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -070089static int vgetargskeywordsfast_impl(PyObject **args, Py_ssize_t nargs,
90 PyObject *keywords, PyObject *kwnames,
91 struct _PyArg_Parser *parser,
92 va_list *p_va, int flags);
Serhiy Storchakaef1585e2015-12-25 20:01:53 +020093static const char *skipitem(const char **, va_list *, int);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000094
Fred Drake563dfc22001-10-23 14:41:08 +000095int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +000096PyArg_Parse(PyObject *args, const char *format, ...)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000097{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000098 int retval;
99 va_list va;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000100
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000101 va_start(va, format);
102 retval = vgetargs1(args, format, &va, FLAG_COMPAT);
103 va_end(va);
104 return retval;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000105}
106
107int
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200108_PyArg_Parse_SizeT(PyObject *args, const char *format, ...)
Martin v. Löwis18e16552006-02-15 17:27:45 +0000109{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000110 int retval;
111 va_list va;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000112
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000113 va_start(va, format);
114 retval = vgetargs1(args, format, &va, FLAG_COMPAT|FLAG_SIZE_T);
115 va_end(va);
116 return retval;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000117}
118
119
Fred Drake563dfc22001-10-23 14:41:08 +0000120int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000121PyArg_ParseTuple(PyObject *args, const char *format, ...)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000122{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000123 int retval;
124 va_list va;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000125
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000126 va_start(va, format);
127 retval = vgetargs1(args, format, &va, 0);
128 va_end(va);
129 return retval;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000130}
131
Martin v. Löwis18e16552006-02-15 17:27:45 +0000132int
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200133_PyArg_ParseTuple_SizeT(PyObject *args, const char *format, ...)
Martin v. Löwis18e16552006-02-15 17:27:45 +0000134{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000135 int retval;
136 va_list va;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000137
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000138 va_start(va, format);
139 retval = vgetargs1(args, format, &va, FLAG_SIZE_T);
140 va_end(va);
141 return retval;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000142}
143
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000144
145int
Victor Stinner6518a932017-01-17 01:29:49 +0100146_PyArg_ParseStack(PyObject **args, Py_ssize_t nargs, const char *format, ...)
147{
148 int retval;
149 va_list va;
150
151 va_start(va, format);
152 retval = vgetargs1_impl(NULL, args, nargs, format, &va, 0);
153 va_end(va);
154 return retval;
155}
156
157int
158_PyArg_ParseStack_SizeT(PyObject **args, Py_ssize_t nargs, const char *format, ...)
159{
160 int retval;
161 va_list va;
162
163 va_start(va, format);
164 retval = vgetargs1_impl(NULL, args, nargs, format, &va, FLAG_SIZE_T);
165 va_end(va);
166 return retval;
167}
168
169
170int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000171PyArg_VaParse(PyObject *args, const char *format, va_list va)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000172{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000173 va_list lva;
Christian Heimes2f2fee12016-09-21 11:37:27 +0200174 int retval;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000175
Benjamin Peterson0c212142016-09-20 20:39:33 -0700176 va_copy(lva, va);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000177
Christian Heimes2f2fee12016-09-21 11:37:27 +0200178 retval = vgetargs1(args, format, &lva, 0);
179 va_end(lva);
180 return retval;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000181}
182
Martin v. Löwis18e16552006-02-15 17:27:45 +0000183int
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200184_PyArg_VaParse_SizeT(PyObject *args, const char *format, va_list va)
Martin v. Löwis18e16552006-02-15 17:27:45 +0000185{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000186 va_list lva;
Christian Heimes2f2fee12016-09-21 11:37:27 +0200187 int retval;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000188
Benjamin Peterson0c212142016-09-20 20:39:33 -0700189 va_copy(lva, va);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000190
Christian Heimes2f2fee12016-09-21 11:37:27 +0200191 retval = vgetargs1(args, format, &lva, FLAG_SIZE_T);
192 va_end(lva);
193 return retval;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000194}
195
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000196
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000197/* Handle cleanup of allocated memory in case of exception */
198
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400199static int
200cleanup_ptr(PyObject *self, void *ptr)
Antoine Pitrouf71995782008-08-29 18:37:05 +0000201{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000202 if (ptr) {
203 PyMem_FREE(ptr);
204 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000205 return 0;
Martin v. Löwisc15bdef2009-05-29 14:47:46 +0000206}
207
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000208static int
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400209cleanup_buffer(PyObject *self, void *ptr)
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000210{
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400211 Py_buffer *buf = (Py_buffer *)ptr;
212 if (buf) {
213 PyBuffer_Release(buf);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000214 }
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400215 return 0;
216}
217
218static int
219addcleanup(void *ptr, freelist_t *freelist, destr_t destructor)
220{
221 int index;
222
223 index = freelist->first_available;
224 freelist->first_available += 1;
225
226 freelist->entries[index].item = ptr;
227 freelist->entries[index].destructor = destructor;
228
229 return 0;
230}
231
232static int
233cleanreturn(int retval, freelist_t *freelist)
234{
235 int index;
236
237 if (retval == 0) {
238 /* A failure occurred, therefore execute all of the cleanup
239 functions.
240 */
241 for (index = 0; index < freelist->first_available; ++index) {
242 freelist->entries[index].destructor(NULL,
243 freelist->entries[index].item);
244 }
245 }
Antoine Pitrou7056cb22013-02-17 01:04:57 +0100246 if (freelist->entries_malloced)
247 PyMem_FREE(freelist->entries);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000248 return retval;
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000249}
250
251
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000252static int
Victor Stinner6518a932017-01-17 01:29:49 +0100253vgetargs1_impl(PyObject *compat_args, PyObject **stack, Py_ssize_t nargs, const char *format,
254 va_list *p_va, int flags)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000255{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000256 char msgbuf[256];
257 int levels[32];
258 const char *fname = NULL;
259 const char *message = NULL;
260 int min = -1;
261 int max = 0;
262 int level = 0;
263 int endfmt = 0;
264 const char *formatsave = format;
Victor Stinner6518a932017-01-17 01:29:49 +0100265 Py_ssize_t i;
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200266 const char *msg;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000267 int compat = flags & FLAG_COMPAT;
Benjamin Peterson40be9e52014-02-11 10:09:27 -0500268 freelistentry_t static_entries[STATIC_FREELIST_ENTRIES];
269 freelist_t freelist;
270
Victor Stinner6518a932017-01-17 01:29:49 +0100271 assert(nargs == 0 || stack != NULL);
272
Benjamin Peterson40be9e52014-02-11 10:09:27 -0500273 freelist.entries = static_entries;
274 freelist.first_available = 0;
275 freelist.entries_malloced = 0;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000276
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000277 flags = flags & ~FLAG_COMPAT;
Tim Peters5c4d5bf2001-02-12 22:13:26 +0000278
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000279 while (endfmt == 0) {
280 int c = *format++;
281 switch (c) {
282 case '(':
283 if (level == 0)
284 max++;
285 level++;
286 if (level >= 30)
287 Py_FatalError("too many tuple nesting levels "
288 "in argument format string");
289 break;
290 case ')':
291 if (level == 0)
292 Py_FatalError("excess ')' in getargs format");
293 else
294 level--;
295 break;
296 case '\0':
297 endfmt = 1;
298 break;
299 case ':':
300 fname = format;
301 endfmt = 1;
302 break;
303 case ';':
304 message = format;
305 endfmt = 1;
306 break;
Antoine Pitrou7056cb22013-02-17 01:04:57 +0100307 case '|':
308 if (level == 0)
309 min = max;
310 break;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000311 default:
312 if (level == 0) {
Antoine Pitrou7056cb22013-02-17 01:04:57 +0100313 if (Py_ISALPHA(Py_CHARMASK(c)))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000314 if (c != 'e') /* skip encoded */
315 max++;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000316 }
317 break;
318 }
319 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000320
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000321 if (level != 0)
322 Py_FatalError(/* '(' */ "missing ')' in getargs format");
Guido van Rossum98297ee2007-11-06 21:34:58 +0000323
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000324 if (min < 0)
325 min = max;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000326
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000327 format = formatsave;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000328
Antoine Pitrou7056cb22013-02-17 01:04:57 +0100329 if (max > STATIC_FREELIST_ENTRIES) {
330 freelist.entries = PyMem_NEW(freelistentry_t, max);
331 if (freelist.entries == NULL) {
332 PyErr_NoMemory();
333 return 0;
334 }
335 freelist.entries_malloced = 1;
Benjamin Peterson7ed67272012-03-16 12:21:02 -0500336 }
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400337
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000338 if (compat) {
339 if (max == 0) {
Victor Stinner6518a932017-01-17 01:29:49 +0100340 if (compat_args == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000341 return 1;
Victor Stinner6ced7c42011-03-21 18:15:42 +0100342 PyErr_Format(PyExc_TypeError,
343 "%.200s%s takes no arguments",
344 fname==NULL ? "function" : fname,
345 fname==NULL ? "" : "()");
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400346 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000347 }
348 else if (min == 1 && max == 1) {
Victor Stinner6518a932017-01-17 01:29:49 +0100349 if (compat_args == NULL) {
Victor Stinner6ced7c42011-03-21 18:15:42 +0100350 PyErr_Format(PyExc_TypeError,
351 "%.200s%s takes at least one argument",
352 fname==NULL ? "function" : fname,
353 fname==NULL ? "" : "()");
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400354 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000355 }
Victor Stinner6518a932017-01-17 01:29:49 +0100356 msg = convertitem(compat_args, &format, p_va, flags, levels,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000357 msgbuf, sizeof(msgbuf), &freelist);
358 if (msg == NULL)
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400359 return cleanreturn(1, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000360 seterror(levels[0], msg, levels+1, fname, message);
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400361 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000362 }
363 else {
364 PyErr_SetString(PyExc_SystemError,
365 "old style getargs format uses new features");
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400366 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000367 }
368 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000369
Victor Stinner6518a932017-01-17 01:29:49 +0100370 if (nargs < min || max < nargs) {
Victor Stinner6ced7c42011-03-21 18:15:42 +0100371 if (message == NULL)
372 PyErr_Format(PyExc_TypeError,
373 "%.150s%s takes %s %d argument%s (%ld given)",
374 fname==NULL ? "function" : fname,
375 fname==NULL ? "" : "()",
376 min==max ? "exactly"
Victor Stinner6518a932017-01-17 01:29:49 +0100377 : nargs < min ? "at least" : "at most",
378 nargs < min ? min : max,
379 (nargs < min ? min : max) == 1 ? "" : "s",
380 Py_SAFE_DOWNCAST(nargs, Py_ssize_t, long));
Victor Stinner6ced7c42011-03-21 18:15:42 +0100381 else
382 PyErr_SetString(PyExc_TypeError, message);
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400383 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000384 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000385
Victor Stinner6518a932017-01-17 01:29:49 +0100386 for (i = 0; i < nargs; i++) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000387 if (*format == '|')
388 format++;
Victor Stinner6518a932017-01-17 01:29:49 +0100389 msg = convertitem(stack[i], &format, p_va,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000390 flags, levels, msgbuf,
391 sizeof(msgbuf), &freelist);
392 if (msg) {
Serhiy Storchakac4b813d2016-02-08 01:06:11 +0200393 seterror(i+1, msg, levels, fname, message);
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400394 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000395 }
396 }
Guido van Rossum231a41e1997-12-09 20:36:39 +0000397
Antoine Pitrou4de74572013-02-09 23:11:27 +0100398 if (*format != '\0' && !Py_ISALPHA(Py_CHARMASK(*format)) &&
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000399 *format != '(' &&
400 *format != '|' && *format != ':' && *format != ';') {
401 PyErr_Format(PyExc_SystemError,
402 "bad format string: %.200s", formatsave);
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400403 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000404 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000405
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400406 return cleanreturn(1, &freelist);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000407}
408
Victor Stinner6518a932017-01-17 01:29:49 +0100409static int
410vgetargs1(PyObject *args, const char *format, va_list *p_va, int flags)
411{
412 PyObject **stack;
413 Py_ssize_t nargs;
414
415 if (!(flags & FLAG_COMPAT)) {
416 assert(args != NULL);
417
418 if (!PyTuple_Check(args)) {
419 PyErr_SetString(PyExc_SystemError,
420 "new style getargs format but argument is not a tuple");
421 return 0;
422 }
423
424 stack = &PyTuple_GET_ITEM(args, 0);
425 nargs = PyTuple_GET_SIZE(args);
426 }
427 else {
428 stack = NULL;
429 nargs = 0;
430 }
431
432 return vgetargs1_impl(args, stack, nargs, format, p_va, flags);
433}
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000434
435
436static void
Victor Stinner84bb1cf2013-05-17 00:12:04 +0200437seterror(Py_ssize_t iarg, const char *msg, int *levels, const char *fname,
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000438 const char *message)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000439{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000440 char buf[512];
441 int i;
442 char *p = buf;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000443
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000444 if (PyErr_Occurred())
445 return;
446 else if (message == NULL) {
447 if (fname != NULL) {
448 PyOS_snprintf(p, sizeof(buf), "%.200s() ", fname);
449 p += strlen(p);
450 }
451 if (iarg != 0) {
452 PyOS_snprintf(p, sizeof(buf) - (p - buf),
Richard Oudkerk25296ce2013-05-18 17:35:19 +0100453 "argument %" PY_FORMAT_SIZE_T "d", iarg);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000454 i = 0;
455 p += strlen(p);
Georg Brandl142ad662013-10-14 07:01:11 +0200456 while (i < 32 && levels[i] > 0 && (int)(p-buf) < 220) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000457 PyOS_snprintf(p, sizeof(buf) - (p - buf),
458 ", item %d", levels[i]-1);
459 p += strlen(p);
460 i++;
461 }
462 }
463 else {
464 PyOS_snprintf(p, sizeof(buf) - (p - buf), "argument");
465 p += strlen(p);
466 }
467 PyOS_snprintf(p, sizeof(buf) - (p - buf), " %.256s", msg);
468 message = buf;
469 }
Serhiy Storchaka4cd63ef2016-02-08 01:22:47 +0200470 if (msg[0] == '(') {
471 PyErr_SetString(PyExc_SystemError, message);
472 }
473 else {
474 PyErr_SetString(PyExc_TypeError, message);
475 }
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000476}
477
478
479/* Convert a tuple argument.
480 On entry, *p_format points to the character _after_ the opening '('.
481 On successful exit, *p_format points to the closing ')'.
482 If successful:
483 *p_format and *p_va are updated,
484 *levels and *msgbuf are untouched,
485 and NULL is returned.
486 If the argument is invalid:
487 *p_format is unchanged,
488 *p_va is undefined,
489 *levels is a 0-terminated list of item numbers,
490 *msgbuf contains an error message, whose format is:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000491 "must be <typename1>, not <typename2>", where:
492 <typename1> is the name of the expected type, and
493 <typename2> is the name of the actual type,
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000494 and msgbuf is returned.
495*/
496
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200497static const char *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000498converttuple(PyObject *arg, const char **p_format, va_list *p_va, int flags,
Guido van Rossum98297ee2007-11-06 21:34:58 +0000499 int *levels, char *msgbuf, size_t bufsize, int toplevel,
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400500 freelist_t *freelist)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000501{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000502 int level = 0;
503 int n = 0;
504 const char *format = *p_format;
505 int i;
Victor Stinner74387f52013-11-18 01:21:12 +0100506 Py_ssize_t len;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000507
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000508 for (;;) {
509 int c = *format++;
510 if (c == '(') {
511 if (level == 0)
512 n++;
513 level++;
514 }
515 else if (c == ')') {
516 if (level == 0)
517 break;
518 level--;
519 }
520 else if (c == ':' || c == ';' || c == '\0')
521 break;
Antoine Pitrou4de74572013-02-09 23:11:27 +0100522 else if (level == 0 && Py_ISALPHA(Py_CHARMASK(c)))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000523 n++;
524 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000525
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000526 if (!PySequence_Check(arg) || PyBytes_Check(arg)) {
527 levels[0] = 0;
528 PyOS_snprintf(msgbuf, bufsize,
529 toplevel ? "expected %d arguments, not %.50s" :
530 "must be %d-item sequence, not %.50s",
531 n,
532 arg == Py_None ? "None" : arg->ob_type->tp_name);
533 return msgbuf;
534 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000535
Victor Stinner74387f52013-11-18 01:21:12 +0100536 len = PySequence_Size(arg);
537 if (len != n) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000538 levels[0] = 0;
Victor Stinner74387f52013-11-18 01:21:12 +0100539 if (toplevel) {
540 PyOS_snprintf(msgbuf, bufsize,
541 "expected %d arguments, not %" PY_FORMAT_SIZE_T "d",
542 n, len);
543 }
544 else {
545 PyOS_snprintf(msgbuf, bufsize,
546 "must be sequence of length %d, "
547 "not %" PY_FORMAT_SIZE_T "d",
548 n, len);
549 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000550 return msgbuf;
551 }
Ka-Ping Yee20579702001-01-15 22:14:16 +0000552
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000553 format = *p_format;
554 for (i = 0; i < n; i++) {
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200555 const char *msg;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000556 PyObject *item;
557 item = PySequence_GetItem(arg, i);
558 if (item == NULL) {
559 PyErr_Clear();
560 levels[0] = i+1;
561 levels[1] = 0;
562 strncpy(msgbuf, "is not retrievable", bufsize);
563 return msgbuf;
564 }
565 msg = convertitem(item, &format, p_va, flags, levels+1,
566 msgbuf, bufsize, freelist);
567 /* PySequence_GetItem calls tp->sq_item, which INCREFs */
568 Py_XDECREF(item);
569 if (msg != NULL) {
570 levels[0] = i+1;
571 return msg;
572 }
573 }
Ka-Ping Yee20579702001-01-15 22:14:16 +0000574
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000575 *p_format = format;
576 return NULL;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000577}
578
579
580/* Convert a single item. */
581
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200582static const char *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000583convertitem(PyObject *arg, const char **p_format, va_list *p_va, int flags,
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400584 int *levels, char *msgbuf, size_t bufsize, freelist_t *freelist)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000585{
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200586 const char *msg;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000587 const char *format = *p_format;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000588
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000589 if (*format == '(' /* ')' */) {
590 format++;
591 msg = converttuple(arg, &format, p_va, flags, levels, msgbuf,
592 bufsize, 0, freelist);
593 if (msg == NULL)
594 format++;
595 }
596 else {
597 msg = convertsimple(arg, &format, p_va, flags,
598 msgbuf, bufsize, freelist);
599 if (msg != NULL)
600 levels[0] = 0;
601 }
602 if (msg == NULL)
603 *p_format = format;
604 return msg;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000605}
606
607
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000608
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000609/* Format an error message generated by convertsimple(). */
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000610
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200611static const char *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000612converterr(const char *expected, PyObject *arg, char *msgbuf, size_t bufsize)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000613{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000614 assert(expected != NULL);
615 assert(arg != NULL);
Serhiy Storchakac4b813d2016-02-08 01:06:11 +0200616 if (expected[0] == '(') {
617 PyOS_snprintf(msgbuf, bufsize,
618 "%.100s", expected);
619 }
620 else {
621 PyOS_snprintf(msgbuf, bufsize,
622 "must be %.50s, not %.50s", expected,
623 arg == Py_None ? "None" : arg->ob_type->tp_name);
624 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000625 return msgbuf;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000626}
627
628#define CONV_UNICODE "(unicode conversion error)"
629
Guido van Rossum45aecf42006-03-15 04:58:47 +0000630/* Explicitly check for float arguments when integers are expected.
631 Return 1 for error, 0 if ok. */
Neil Schemenauer5042da62003-02-04 20:59:40 +0000632static int
633float_argument_error(PyObject *arg)
634{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000635 if (PyFloat_Check(arg)) {
636 PyErr_SetString(PyExc_TypeError,
637 "integer argument expected, got float" );
638 return 1;
639 }
640 else
641 return 0;
Neil Schemenauer5042da62003-02-04 20:59:40 +0000642}
643
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000644/* Convert a non-tuple argument. Return NULL if conversion went OK,
645 or a string with a message describing the failure. The message is
646 formatted as "must be <desired type>, not <actual type>".
647 When failing, an exception may or may not have been raised.
Georg Brandl6dd14612005-09-14 19:29:53 +0000648 Don't call if a tuple is expected.
649
650 When you add new format codes, please don't forget poor skipitem() below.
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000651*/
652
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200653static const char *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000654convertsimple(PyObject *arg, const char **p_format, va_list *p_va, int flags,
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400655 char *msgbuf, size_t bufsize, freelist_t *freelist)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000656{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000657 /* For # codes */
658#define FETCH_SIZE int *q=NULL;Py_ssize_t *q2=NULL;\
659 if (flags & FLAG_SIZE_T) q2=va_arg(*p_va, Py_ssize_t*); \
660 else q=va_arg(*p_va, int*);
Victor Stinnerb3c9e072011-01-04 02:07:34 +0000661#define STORE_SIZE(s) \
662 if (flags & FLAG_SIZE_T) \
663 *q2=s; \
664 else { \
665 if (INT_MAX < s) { \
666 PyErr_SetString(PyExc_OverflowError, \
667 "size does not fit in an int"); \
668 return converterr("", arg, msgbuf, bufsize); \
669 } \
Victor Stinner9550ef32013-06-05 01:18:13 +0200670 *q = (int)s; \
Victor Stinnerb3c9e072011-01-04 02:07:34 +0000671 }
Martin v. Löwis18e16552006-02-15 17:27:45 +0000672#define BUFFER_LEN ((flags & FLAG_SIZE_T) ? *q2:*q)
Victor Stinner6ab8e822011-01-04 11:16:49 +0000673#define RETURN_ERR_OCCURRED return msgbuf
Martin v. Löwis18e16552006-02-15 17:27:45 +0000674
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000675 const char *format = *p_format;
676 char c = *format++;
Serhiy Storchaka85b0f5b2016-11-20 10:16:47 +0200677 const char *sarg;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000678
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000679 switch (c) {
Guido van Rossum98297ee2007-11-06 21:34:58 +0000680
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000681 case 'b': { /* unsigned byte -- very short int */
682 char *p = va_arg(*p_va, char *);
683 long ival;
684 if (float_argument_error(arg))
Victor Stinner6ab8e822011-01-04 11:16:49 +0000685 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000686 ival = PyLong_AsLong(arg);
687 if (ival == -1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000688 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000689 else if (ival < 0) {
690 PyErr_SetString(PyExc_OverflowError,
Victor Stinner6ab8e822011-01-04 11:16:49 +0000691 "unsigned byte integer is less than minimum");
692 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000693 }
694 else if (ival > UCHAR_MAX) {
695 PyErr_SetString(PyExc_OverflowError,
Victor Stinner6ab8e822011-01-04 11:16:49 +0000696 "unsigned byte integer is greater than maximum");
697 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000698 }
699 else
700 *p = (unsigned char) ival;
701 break;
702 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000703
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000704 case 'B': {/* byte sized bitfield - both signed and unsigned
705 values allowed */
706 char *p = va_arg(*p_va, char *);
707 long ival;
708 if (float_argument_error(arg))
Victor Stinner6ab8e822011-01-04 11:16:49 +0000709 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000710 ival = PyLong_AsUnsignedLongMask(arg);
711 if (ival == -1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000712 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000713 else
714 *p = (unsigned char) ival;
715 break;
716 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000717
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000718 case 'h': {/* signed short int */
719 short *p = va_arg(*p_va, short *);
720 long ival;
721 if (float_argument_error(arg))
Victor Stinner6ab8e822011-01-04 11:16:49 +0000722 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000723 ival = PyLong_AsLong(arg);
724 if (ival == -1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000725 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000726 else if (ival < SHRT_MIN) {
727 PyErr_SetString(PyExc_OverflowError,
Victor Stinner6ab8e822011-01-04 11:16:49 +0000728 "signed short integer is less than minimum");
729 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000730 }
731 else if (ival > SHRT_MAX) {
732 PyErr_SetString(PyExc_OverflowError,
Victor Stinner6ab8e822011-01-04 11:16:49 +0000733 "signed short integer is greater than maximum");
734 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000735 }
736 else
737 *p = (short) ival;
738 break;
739 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000740
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000741 case 'H': { /* short int sized bitfield, both signed and
742 unsigned allowed */
743 unsigned short *p = va_arg(*p_va, unsigned short *);
744 long ival;
745 if (float_argument_error(arg))
Victor Stinner6ab8e822011-01-04 11:16:49 +0000746 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000747 ival = PyLong_AsUnsignedLongMask(arg);
748 if (ival == -1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000749 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000750 else
751 *p = (unsigned short) ival;
752 break;
753 }
Martin v. Löwis18e16552006-02-15 17:27:45 +0000754
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000755 case 'i': {/* signed int */
756 int *p = va_arg(*p_va, int *);
757 long ival;
758 if (float_argument_error(arg))
Victor Stinner6ab8e822011-01-04 11:16:49 +0000759 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000760 ival = PyLong_AsLong(arg);
761 if (ival == -1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000762 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000763 else if (ival > INT_MAX) {
764 PyErr_SetString(PyExc_OverflowError,
Victor Stinner6ab8e822011-01-04 11:16:49 +0000765 "signed integer is greater than maximum");
766 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000767 }
768 else if (ival < INT_MIN) {
769 PyErr_SetString(PyExc_OverflowError,
Victor Stinner6ab8e822011-01-04 11:16:49 +0000770 "signed integer is less than minimum");
771 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000772 }
773 else
774 *p = ival;
775 break;
776 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000777
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000778 case 'I': { /* int sized bitfield, both signed and
779 unsigned allowed */
780 unsigned int *p = va_arg(*p_va, unsigned int *);
781 unsigned int ival;
782 if (float_argument_error(arg))
Victor Stinner6ab8e822011-01-04 11:16:49 +0000783 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000784 ival = (unsigned int)PyLong_AsUnsignedLongMask(arg);
785 if (ival == (unsigned int)-1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000786 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000787 else
788 *p = ival;
789 break;
790 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000791
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000792 case 'n': /* Py_ssize_t */
793 {
794 PyObject *iobj;
795 Py_ssize_t *p = va_arg(*p_va, Py_ssize_t *);
796 Py_ssize_t ival = -1;
797 if (float_argument_error(arg))
Victor Stinner6ab8e822011-01-04 11:16:49 +0000798 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000799 iobj = PyNumber_Index(arg);
800 if (iobj != NULL) {
801 ival = PyLong_AsSsize_t(iobj);
802 Py_DECREF(iobj);
803 }
804 if (ival == -1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000805 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000806 *p = ival;
807 break;
808 }
809 case 'l': {/* long int */
810 long *p = va_arg(*p_va, long *);
811 long ival;
812 if (float_argument_error(arg))
Victor Stinner6ab8e822011-01-04 11:16:49 +0000813 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000814 ival = PyLong_AsLong(arg);
815 if (ival == -1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000816 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000817 else
818 *p = ival;
819 break;
820 }
Thomas Hellera4ea6032003-04-17 18:55:45 +0000821
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000822 case 'k': { /* long sized bitfield */
823 unsigned long *p = va_arg(*p_va, unsigned long *);
824 unsigned long ival;
825 if (PyLong_Check(arg))
826 ival = PyLong_AsUnsignedLongMask(arg);
827 else
Serhiy Storchakac4b813d2016-02-08 01:06:11 +0200828 return converterr("int", arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000829 *p = ival;
830 break;
831 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000832
Benjamin Petersonaf580df2016-09-06 10:46:49 -0700833 case 'L': {/* long long */
834 long long *p = va_arg( *p_va, long long * );
835 long long ival;
Mark Dickinsonc7301312010-06-10 16:05:10 +0000836 if (float_argument_error(arg))
Victor Stinner6ab8e822011-01-04 11:16:49 +0000837 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000838 ival = PyLong_AsLongLong(arg);
Benjamin Petersonaf580df2016-09-06 10:46:49 -0700839 if (ival == (long long)-1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000840 RETURN_ERR_OCCURRED;
Mark Dickinsonc7301312010-06-10 16:05:10 +0000841 else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000842 *p = ival;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000843 break;
844 }
Thomas Hellera4ea6032003-04-17 18:55:45 +0000845
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000846 case 'K': { /* long long sized bitfield */
Benjamin Petersonaf580df2016-09-06 10:46:49 -0700847 unsigned long long *p = va_arg(*p_va, unsigned long long *);
848 unsigned long long ival;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000849 if (PyLong_Check(arg))
850 ival = PyLong_AsUnsignedLongLongMask(arg);
851 else
Serhiy Storchakac4b813d2016-02-08 01:06:11 +0200852 return converterr("int", arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000853 *p = ival;
854 break;
855 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000856
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000857 case 'f': {/* float */
858 float *p = va_arg(*p_va, float *);
859 double dval = PyFloat_AsDouble(arg);
860 if (PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000861 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000862 else
863 *p = (float) dval;
864 break;
865 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000866
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000867 case 'd': {/* double */
868 double *p = va_arg(*p_va, double *);
869 double dval = PyFloat_AsDouble(arg);
870 if (PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000871 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000872 else
873 *p = dval;
874 break;
875 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000876
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000877 case 'D': {/* complex double */
878 Py_complex *p = va_arg(*p_va, Py_complex *);
879 Py_complex cval;
880 cval = PyComplex_AsCComplex(arg);
881 if (PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000882 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000883 else
884 *p = cval;
885 break;
886 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000887
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000888 case 'c': {/* char */
889 char *p = va_arg(*p_va, char *);
890 if (PyBytes_Check(arg) && PyBytes_Size(arg) == 1)
891 *p = PyBytes_AS_STRING(arg)[0];
Eli Bendersky906b88f2011-07-29 07:05:08 +0300892 else if (PyByteArray_Check(arg) && PyByteArray_Size(arg) == 1)
893 *p = PyByteArray_AS_STRING(arg)[0];
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000894 else
895 return converterr("a byte string of length 1", arg, msgbuf, bufsize);
896 break;
897 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000898
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000899 case 'C': {/* unicode char */
900 int *p = va_arg(*p_va, int *);
Victor Stinnere1335c72011-10-04 20:53:03 +0200901 int kind;
902 void *data;
903
904 if (!PyUnicode_Check(arg))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000905 return converterr("a unicode character", arg, msgbuf, bufsize);
Victor Stinnere1335c72011-10-04 20:53:03 +0200906
907 if (PyUnicode_READY(arg))
908 RETURN_ERR_OCCURRED;
909
910 if (PyUnicode_GET_LENGTH(arg) != 1)
911 return converterr("a unicode character", arg, msgbuf, bufsize);
912
913 kind = PyUnicode_KIND(arg);
914 data = PyUnicode_DATA(arg);
915 *p = PyUnicode_READ(kind, data, 0);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000916 break;
917 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000918
Larry Hastingsfaf91e72012-05-05 16:54:29 -0700919 case 'p': {/* boolean *p*redicate */
920 int *p = va_arg(*p_va, int *);
921 int val = PyObject_IsTrue(arg);
922 if (val > 0)
923 *p = 1;
924 else if (val == 0)
925 *p = 0;
926 else
927 RETURN_ERR_OCCURRED;
928 break;
929 }
930
Victor Stinner3dcb5ac2010-06-08 22:54:19 +0000931 /* XXX WAAAAH! 's', 'y', 'z', 'u', 'Z', 'e', 'w' codes all
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000932 need to be cleaned up! */
Guido van Rossum98297ee2007-11-06 21:34:58 +0000933
Serhiy Storchakab757c832014-12-05 22:25:22 +0200934 case 'y': {/* any bytes-like object */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000935 void **p = (void **)va_arg(*p_va, char **);
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200936 const char *buf;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000937 Py_ssize_t count;
938 if (*format == '*') {
939 if (getbuffer(arg, (Py_buffer*)p, &buf) < 0)
940 return converterr(buf, arg, msgbuf, bufsize);
941 format++;
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400942 if (addcleanup(p, freelist, cleanup_buffer)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000943 return converterr(
944 "(cleanup problem)",
945 arg, msgbuf, bufsize);
946 }
947 break;
948 }
Serhiy Storchaka85b0f5b2016-11-20 10:16:47 +0200949 count = convertbuffer(arg, (const void **)p, &buf);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000950 if (count < 0)
951 return converterr(buf, arg, msgbuf, bufsize);
Victor Stinner06e49dd2010-06-13 18:21:50 +0000952 if (*format == '#') {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000953 FETCH_SIZE;
954 STORE_SIZE(count);
955 format++;
Victor Stinner06e49dd2010-06-13 18:21:50 +0000956 } else {
Serhiy Storchakad8a14472014-09-06 20:07:17 +0300957 if (strlen(*p) != (size_t)count) {
958 PyErr_SetString(PyExc_ValueError, "embedded null byte");
959 RETURN_ERR_OCCURRED;
960 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000961 }
962 break;
963 }
Walter Dörwald612344f2007-05-04 19:28:21 +0000964
Serhiy Storchakab757c832014-12-05 22:25:22 +0200965 case 's': /* text string or bytes-like object */
966 case 'z': /* text string, bytes-like object or None */
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000967 {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000968 if (*format == '*') {
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000969 /* "s*" or "z*" */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000970 Py_buffer *p = (Py_buffer *)va_arg(*p_va, Py_buffer *);
Martin v. Löwis423be952008-08-13 15:53:07 +0000971
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000972 if (c == 'z' && arg == Py_None)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000973 PyBuffer_FillInfo(p, NULL, NULL, 0, 1, 0);
974 else if (PyUnicode_Check(arg)) {
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200975 Py_ssize_t len;
976 sarg = PyUnicode_AsUTF8AndSize(arg, &len);
977 if (sarg == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000978 return converterr(CONV_UNICODE,
979 arg, msgbuf, bufsize);
Serhiy Storchaka85b0f5b2016-11-20 10:16:47 +0200980 PyBuffer_FillInfo(p, arg, (void *)sarg, len, 1, 0);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000981 }
Serhiy Storchakab757c832014-12-05 22:25:22 +0200982 else { /* any bytes-like object */
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200983 const char *buf;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000984 if (getbuffer(arg, p, &buf) < 0)
985 return converterr(buf, arg, msgbuf, bufsize);
986 }
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400987 if (addcleanup(p, freelist, cleanup_buffer)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000988 return converterr(
989 "(cleanup problem)",
990 arg, msgbuf, bufsize);
991 }
992 format++;
Serhiy Storchakab757c832014-12-05 22:25:22 +0200993 } else if (*format == '#') { /* a string or read-only bytes-like object */
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000994 /* "s#" or "z#" */
Serhiy Storchaka85b0f5b2016-11-20 10:16:47 +0200995 const void **p = (const void **)va_arg(*p_va, const char **);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000996 FETCH_SIZE;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000997
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000998 if (c == 'z' && arg == Py_None) {
999 *p = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001000 STORE_SIZE(0);
1001 }
1002 else if (PyUnicode_Check(arg)) {
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001003 Py_ssize_t len;
1004 sarg = PyUnicode_AsUTF8AndSize(arg, &len);
1005 if (sarg == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001006 return converterr(CONV_UNICODE,
1007 arg, msgbuf, bufsize);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001008 *p = sarg;
1009 STORE_SIZE(len);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001010 }
Serhiy Storchakab757c832014-12-05 22:25:22 +02001011 else { /* read-only bytes-like object */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001012 /* XXX Really? */
Serhiy Storchakaef1585e2015-12-25 20:01:53 +02001013 const char *buf;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001014 Py_ssize_t count = convertbuffer(arg, p, &buf);
1015 if (count < 0)
1016 return converterr(buf, arg, msgbuf, bufsize);
1017 STORE_SIZE(count);
1018 }
1019 format++;
1020 } else {
Victor Stinner3c9e6e92010-06-24 22:31:12 +00001021 /* "s" or "z" */
Serhiy Storchaka85b0f5b2016-11-20 10:16:47 +02001022 const char **p = va_arg(*p_va, const char **);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001023 Py_ssize_t len;
1024 sarg = NULL;
Guido van Rossum98297ee2007-11-06 21:34:58 +00001025
Victor Stinner3c9e6e92010-06-24 22:31:12 +00001026 if (c == 'z' && arg == Py_None)
1027 *p = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001028 else if (PyUnicode_Check(arg)) {
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001029 sarg = PyUnicode_AsUTF8AndSize(arg, &len);
1030 if (sarg == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001031 return converterr(CONV_UNICODE,
1032 arg, msgbuf, bufsize);
Serhiy Storchakad8a14472014-09-06 20:07:17 +03001033 if (strlen(sarg) != (size_t)len) {
1034 PyErr_SetString(PyExc_ValueError, "embedded null character");
1035 RETURN_ERR_OCCURRED;
1036 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001037 *p = sarg;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001038 }
1039 else
Victor Stinner3c9e6e92010-06-24 22:31:12 +00001040 return converterr(c == 'z' ? "str or None" : "str",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001041 arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001042 }
1043 break;
1044 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001045
Victor Stinner3c9e6e92010-06-24 22:31:12 +00001046 case 'u': /* raw unicode buffer (Py_UNICODE *) */
1047 case 'Z': /* raw unicode buffer or None */
1048 {
Brett Cannonb94767f2011-02-22 20:15:44 +00001049 Py_UNICODE **p = va_arg(*p_va, Py_UNICODE **);
1050
Serhiy Storchakab757c832014-12-05 22:25:22 +02001051 if (*format == '#') {
Serhiy Storchakad6e53da2015-04-19 21:11:30 +03001052 /* "u#" or "Z#" */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001053 FETCH_SIZE;
Travis E. Oliphantddacf962007-10-13 21:03:27 +00001054
Victor Stinner3c9e6e92010-06-24 22:31:12 +00001055 if (c == 'Z' && arg == Py_None) {
1056 *p = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001057 STORE_SIZE(0);
1058 }
1059 else if (PyUnicode_Check(arg)) {
Victor Stinnerbeac78b2011-10-11 21:55:01 +02001060 Py_ssize_t len;
1061 *p = PyUnicode_AsUnicodeAndSize(arg, &len);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001062 if (*p == NULL)
1063 RETURN_ERR_OCCURRED;
Victor Stinnerbeac78b2011-10-11 21:55:01 +02001064 STORE_SIZE(len);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001065 }
Victor Stinner5216e6d2010-06-08 21:45:51 +00001066 else
Serhiy Storchakad6e53da2015-04-19 21:11:30 +03001067 return converterr(c == 'Z' ? "str or None" : "str",
1068 arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001069 format++;
1070 } else {
Serhiy Storchakad6e53da2015-04-19 21:11:30 +03001071 /* "u" or "Z" */
Victor Stinner3c9e6e92010-06-24 22:31:12 +00001072 if (c == 'Z' && arg == Py_None)
1073 *p = NULL;
Victor Stinner06e49dd2010-06-13 18:21:50 +00001074 else if (PyUnicode_Check(arg)) {
Victor Stinnerbeac78b2011-10-11 21:55:01 +02001075 Py_ssize_t len;
1076 *p = PyUnicode_AsUnicodeAndSize(arg, &len);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001077 if (*p == NULL)
1078 RETURN_ERR_OCCURRED;
Serhiy Storchaka460bd0d2016-11-20 12:16:46 +02001079 if (wcslen(*p) != (size_t)len) {
Serhiy Storchakad8a14472014-09-06 20:07:17 +03001080 PyErr_SetString(PyExc_ValueError, "embedded null character");
1081 RETURN_ERR_OCCURRED;
1082 }
Victor Stinner06e49dd2010-06-13 18:21:50 +00001083 } else
Victor Stinner3c9e6e92010-06-24 22:31:12 +00001084 return converterr(c == 'Z' ? "str or None" : "str",
1085 arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001086 }
1087 break;
1088 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001089
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001090 case 'e': {/* encoded string */
1091 char **buffer;
1092 const char *encoding;
1093 PyObject *s;
1094 int recode_strings;
1095 Py_ssize_t size;
1096 const char *ptr;
Jeremy Hylton4819e972001-10-11 14:40:37 +00001097
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001098 /* Get 'e' parameter: the encoding name */
1099 encoding = (const char *)va_arg(*p_va, const char *);
1100 if (encoding == NULL)
1101 encoding = PyUnicode_GetDefaultEncoding();
Martin v. Löwis423be952008-08-13 15:53:07 +00001102
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001103 /* Get output buffer parameter:
1104 's' (recode all objects via Unicode) or
1105 't' (only recode non-string objects)
1106 */
1107 if (*format == 's')
1108 recode_strings = 1;
1109 else if (*format == 't')
1110 recode_strings = 0;
1111 else
1112 return converterr(
1113 "(unknown parser marker combination)",
1114 arg, msgbuf, bufsize);
1115 buffer = (char **)va_arg(*p_va, char **);
1116 format++;
1117 if (buffer == NULL)
1118 return converterr("(buffer is NULL)",
1119 arg, msgbuf, bufsize);
Benjamin Peterson9edd2bd2008-08-27 00:31:37 +00001120
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001121 /* Encode object */
1122 if (!recode_strings &&
1123 (PyBytes_Check(arg) || PyByteArray_Check(arg))) {
1124 s = arg;
1125 Py_INCREF(s);
Serhiy Storchaka460bd0d2016-11-20 12:16:46 +02001126 if (PyBytes_Check(arg)) {
1127 size = PyBytes_GET_SIZE(s);
1128 ptr = PyBytes_AS_STRING(s);
1129 }
1130 else {
1131 size = PyByteArray_GET_SIZE(s);
1132 ptr = PyByteArray_AS_STRING(s);
1133 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001134 }
Serhiy Storchaka21a663e2016-04-13 15:37:23 +03001135 else if (PyUnicode_Check(arg)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001136 /* Encode object; use default error handling */
Serhiy Storchaka21a663e2016-04-13 15:37:23 +03001137 s = PyUnicode_AsEncodedString(arg,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001138 encoding,
1139 NULL);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001140 if (s == NULL)
1141 return converterr("(encoding failed)",
1142 arg, msgbuf, bufsize);
Serhiy Storchaka21a663e2016-04-13 15:37:23 +03001143 assert(PyBytes_Check(s));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001144 size = PyBytes_GET_SIZE(s);
1145 ptr = PyBytes_AS_STRING(s);
1146 if (ptr == NULL)
1147 ptr = "";
1148 }
Serhiy Storchaka21a663e2016-04-13 15:37:23 +03001149 else {
1150 return converterr(
1151 recode_strings ? "str" : "str, bytes or bytearray",
1152 arg, msgbuf, bufsize);
1153 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001154
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001155 /* Write output; output is guaranteed to be 0-terminated */
1156 if (*format == '#') {
1157 /* Using buffer length parameter '#':
1158
1159 - if *buffer is NULL, a new buffer of the
1160 needed size is allocated and the data
1161 copied into it; *buffer is updated to point
1162 to the new buffer; the caller is
1163 responsible for PyMem_Free()ing it after
1164 usage
1165
1166 - if *buffer is not NULL, the data is
1167 copied to *buffer; *buffer_len has to be
1168 set to the size of the buffer on input;
1169 buffer overflow is signalled with an error;
1170 buffer has to provide enough room for the
1171 encoded string plus the trailing 0-byte
1172
1173 - in both cases, *buffer_len is updated to
1174 the size of the buffer /excluding/ the
1175 trailing 0-byte
1176
1177 */
1178 FETCH_SIZE;
1179
1180 format++;
1181 if (q == NULL && q2 == NULL) {
1182 Py_DECREF(s);
1183 return converterr(
1184 "(buffer_len is NULL)",
1185 arg, msgbuf, bufsize);
1186 }
1187 if (*buffer == NULL) {
1188 *buffer = PyMem_NEW(char, size + 1);
1189 if (*buffer == NULL) {
1190 Py_DECREF(s);
Victor Stinner2872e5b2010-06-06 20:38:02 +00001191 PyErr_NoMemory();
Victor Stinner6ab8e822011-01-04 11:16:49 +00001192 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001193 }
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001194 if (addcleanup(*buffer, freelist, cleanup_ptr)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001195 Py_DECREF(s);
1196 return converterr(
1197 "(cleanup problem)",
1198 arg, msgbuf, bufsize);
1199 }
1200 } else {
1201 if (size + 1 > BUFFER_LEN) {
1202 Py_DECREF(s);
Serhiy Storchaka4cd63ef2016-02-08 01:22:47 +02001203 PyErr_Format(PyExc_ValueError,
Serhiy Storchakac4b813d2016-02-08 01:06:11 +02001204 "encoded string too long "
1205 "(%zd, maximum length %zd)",
1206 (Py_ssize_t)size, (Py_ssize_t)(BUFFER_LEN-1));
1207 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001208 }
1209 }
1210 memcpy(*buffer, ptr, size+1);
1211 STORE_SIZE(size);
1212 } else {
1213 /* Using a 0-terminated buffer:
1214
1215 - the encoded string has to be 0-terminated
1216 for this variant to work; if it is not, an
1217 error raised
1218
1219 - a new buffer of the needed size is
1220 allocated and the data copied into it;
1221 *buffer is updated to point to the new
1222 buffer; the caller is responsible for
1223 PyMem_Free()ing it after usage
1224
1225 */
1226 if ((Py_ssize_t)strlen(ptr) != size) {
1227 Py_DECREF(s);
1228 return converterr(
Serhiy Storchakac4b813d2016-02-08 01:06:11 +02001229 "encoded string without null bytes",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001230 arg, msgbuf, bufsize);
1231 }
1232 *buffer = PyMem_NEW(char, size + 1);
1233 if (*buffer == NULL) {
1234 Py_DECREF(s);
Victor Stinner2872e5b2010-06-06 20:38:02 +00001235 PyErr_NoMemory();
Victor Stinner6ab8e822011-01-04 11:16:49 +00001236 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001237 }
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001238 if (addcleanup(*buffer, freelist, cleanup_ptr)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001239 Py_DECREF(s);
1240 return converterr("(cleanup problem)",
1241 arg, msgbuf, bufsize);
1242 }
1243 memcpy(*buffer, ptr, size+1);
1244 }
1245 Py_DECREF(s);
1246 break;
1247 }
1248
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001249 case 'S': { /* PyBytes object */
1250 PyObject **p = va_arg(*p_va, PyObject **);
1251 if (PyBytes_Check(arg))
1252 *p = arg;
1253 else
1254 return converterr("bytes", arg, msgbuf, bufsize);
1255 break;
1256 }
1257
1258 case 'Y': { /* PyByteArray object */
1259 PyObject **p = va_arg(*p_va, PyObject **);
1260 if (PyByteArray_Check(arg))
1261 *p = arg;
1262 else
Victor Stinner5216e6d2010-06-08 21:45:51 +00001263 return converterr("bytearray", arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001264 break;
1265 }
1266
1267 case 'U': { /* PyUnicode object */
1268 PyObject **p = va_arg(*p_va, PyObject **);
Victor Stinnera1b0c9f2012-05-29 12:30:29 +02001269 if (PyUnicode_Check(arg)) {
1270 if (PyUnicode_READY(arg) == -1)
1271 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001272 *p = arg;
Victor Stinnera1b0c9f2012-05-29 12:30:29 +02001273 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001274 else
1275 return converterr("str", arg, msgbuf, bufsize);
1276 break;
1277 }
1278
1279 case 'O': { /* object */
1280 PyTypeObject *type;
1281 PyObject **p;
1282 if (*format == '!') {
1283 type = va_arg(*p_va, PyTypeObject*);
1284 p = va_arg(*p_va, PyObject **);
1285 format++;
1286 if (PyType_IsSubtype(arg->ob_type, type))
1287 *p = arg;
1288 else
1289 return converterr(type->tp_name, arg, msgbuf, bufsize);
1290
1291 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001292 else if (*format == '&') {
1293 typedef int (*converter)(PyObject *, void *);
1294 converter convert = va_arg(*p_va, converter);
1295 void *addr = va_arg(*p_va, void *);
1296 int res;
1297 format++;
1298 if (! (res = (*convert)(arg, addr)))
1299 return converterr("(unspecified)",
1300 arg, msgbuf, bufsize);
1301 if (res == Py_CLEANUP_SUPPORTED &&
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001302 addcleanup(addr, freelist, convert) == -1)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001303 return converterr("(cleanup problem)",
1304 arg, msgbuf, bufsize);
1305 }
1306 else {
1307 p = va_arg(*p_va, PyObject **);
1308 *p = arg;
1309 }
1310 break;
1311 }
1312
1313
Victor Stinner25e8ec42010-06-25 00:02:38 +00001314 case 'w': { /* "w*": memory buffer, read-write access */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001315 void **p = va_arg(*p_va, void **);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001316
Victor Stinner25e8ec42010-06-25 00:02:38 +00001317 if (*format != '*')
1318 return converterr(
Serhiy Storchakac4b813d2016-02-08 01:06:11 +02001319 "(invalid use of 'w' format character)",
Victor Stinner25e8ec42010-06-25 00:02:38 +00001320 arg, msgbuf, bufsize);
1321 format++;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001322
Victor Stinner25e8ec42010-06-25 00:02:38 +00001323 /* Caller is interested in Py_buffer, and the object
1324 supports it directly. */
1325 if (PyObject_GetBuffer(arg, (Py_buffer*)p, PyBUF_WRITABLE) < 0) {
1326 PyErr_Clear();
R David Murray861470c2014-10-05 11:47:01 -04001327 return converterr("read-write bytes-like object",
1328 arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001329 }
Victor Stinner8182b712010-07-28 00:40:58 +00001330 if (!PyBuffer_IsContiguous((Py_buffer*)p, 'C')) {
1331 PyBuffer_Release((Py_buffer*)p);
1332 return converterr("contiguous buffer", arg, msgbuf, bufsize);
1333 }
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001334 if (addcleanup(p, freelist, cleanup_buffer)) {
Victor Stinner25e8ec42010-06-25 00:02:38 +00001335 return converterr(
1336 "(cleanup problem)",
1337 arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001338 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001339 break;
1340 }
1341
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001342 default:
Serhiy Storchakac4b813d2016-02-08 01:06:11 +02001343 return converterr("(impossible<bad format char>)", arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001344
1345 }
1346
1347 *p_format = format;
1348 return NULL;
Victor Stinner6ab8e822011-01-04 11:16:49 +00001349
1350#undef FETCH_SIZE
1351#undef STORE_SIZE
1352#undef BUFFER_LEN
1353#undef RETURN_ERR_OCCURRED
Guido van Rossumfe3f1a21994-09-29 09:42:55 +00001354}
Guido van Rossumaa354651996-08-19 19:32:04 +00001355
Martin v. Löwis18e16552006-02-15 17:27:45 +00001356static Py_ssize_t
Serhiy Storchaka85b0f5b2016-11-20 10:16:47 +02001357convertbuffer(PyObject *arg, const void **p, const char **errmsg)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001358{
Victor Stinner5cb62392010-06-06 20:27:51 +00001359 PyBufferProcs *pb = Py_TYPE(arg)->tp_as_buffer;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001360 Py_ssize_t count;
1361 Py_buffer view;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001362
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001363 *errmsg = NULL;
1364 *p = NULL;
Victor Stinner8182b712010-07-28 00:40:58 +00001365 if (pb != NULL && pb->bf_releasebuffer != NULL) {
R David Murray861470c2014-10-05 11:47:01 -04001366 *errmsg = "read-only bytes-like object";
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001367 return -1;
1368 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001369
Victor Stinner8182b712010-07-28 00:40:58 +00001370 if (getbuffer(arg, &view, errmsg) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001371 return -1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001372 count = view.len;
1373 *p = view.buf;
1374 PyBuffer_Release(&view);
1375 return count;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001376}
Guido van Rossumaa354651996-08-19 19:32:04 +00001377
Martin v. Löwis423be952008-08-13 15:53:07 +00001378static int
Serhiy Storchakaef1585e2015-12-25 20:01:53 +02001379getbuffer(PyObject *arg, Py_buffer *view, const char **errmsg)
Martin v. Löwis423be952008-08-13 15:53:07 +00001380{
Victor Stinner8182b712010-07-28 00:40:58 +00001381 if (PyObject_GetBuffer(arg, view, PyBUF_SIMPLE) != 0) {
R David Murray861470c2014-10-05 11:47:01 -04001382 *errmsg = "bytes-like object";
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001383 return -1;
1384 }
Victor Stinner5cb62392010-06-06 20:27:51 +00001385 if (!PyBuffer_IsContiguous(view, 'C')) {
Victor Stinner21e09482010-06-24 22:57:10 +00001386 PyBuffer_Release(view);
Victor Stinner5cb62392010-06-06 20:27:51 +00001387 *errmsg = "contiguous buffer";
1388 return -1;
1389 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001390 return 0;
Martin v. Löwis423be952008-08-13 15:53:07 +00001391}
1392
Guido van Rossumaa354651996-08-19 19:32:04 +00001393/* Support for keyword arguments donated by
1394 Geoff Philbrick <philbric@delphi.hks.com> */
1395
Tim Petersf8cd3e82001-10-27 04:26:57 +00001396/* Return false (0) for error, else true. */
Fred Drake563dfc22001-10-23 14:41:08 +00001397int
1398PyArg_ParseTupleAndKeywords(PyObject *args,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001399 PyObject *keywords,
1400 const char *format,
1401 char **kwlist, ...)
Guido van Rossumaa354651996-08-19 19:32:04 +00001402{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001403 int retval;
1404 va_list va;
Tim Peters45772cd2001-10-27 03:58:40 +00001405
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001406 if ((args == NULL || !PyTuple_Check(args)) ||
1407 (keywords != NULL && !PyDict_Check(keywords)) ||
1408 format == NULL ||
1409 kwlist == NULL)
1410 {
1411 PyErr_BadInternalCall();
1412 return 0;
1413 }
Tim Peters45772cd2001-10-27 03:58:40 +00001414
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001415 va_start(va, kwlist);
1416 retval = vgetargskeywords(args, keywords, format, kwlist, &va, 0);
1417 va_end(va);
1418 return retval;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001419}
1420
1421int
1422_PyArg_ParseTupleAndKeywords_SizeT(PyObject *args,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001423 PyObject *keywords,
1424 const char *format,
1425 char **kwlist, ...)
Martin v. Löwis18e16552006-02-15 17:27:45 +00001426{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001427 int retval;
1428 va_list va;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001429
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001430 if ((args == NULL || !PyTuple_Check(args)) ||
1431 (keywords != NULL && !PyDict_Check(keywords)) ||
1432 format == NULL ||
1433 kwlist == NULL)
1434 {
1435 PyErr_BadInternalCall();
1436 return 0;
1437 }
Martin v. Löwis18e16552006-02-15 17:27:45 +00001438
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001439 va_start(va, kwlist);
1440 retval = vgetargskeywords(args, keywords, format,
1441 kwlist, &va, FLAG_SIZE_T);
1442 va_end(va);
1443 return retval;
Guido van Rossumaa354651996-08-19 19:32:04 +00001444}
1445
1446
Brett Cannon711e7d92004-07-10 22:20:32 +00001447int
1448PyArg_VaParseTupleAndKeywords(PyObject *args,
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001449 PyObject *keywords,
Guido van Rossum98297ee2007-11-06 21:34:58 +00001450 const char *format,
Martin v. Löwis15e62742006-02-27 16:46:16 +00001451 char **kwlist, va_list va)
Brett Cannon711e7d92004-07-10 22:20:32 +00001452{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001453 int retval;
1454 va_list lva;
Brett Cannon711e7d92004-07-10 22:20:32 +00001455
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001456 if ((args == NULL || !PyTuple_Check(args)) ||
1457 (keywords != NULL && !PyDict_Check(keywords)) ||
1458 format == NULL ||
1459 kwlist == NULL)
1460 {
1461 PyErr_BadInternalCall();
1462 return 0;
1463 }
Brett Cannon711e7d92004-07-10 22:20:32 +00001464
Benjamin Peterson0c212142016-09-20 20:39:33 -07001465 va_copy(lva, va);
Brett Cannon711e7d92004-07-10 22:20:32 +00001466
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001467 retval = vgetargskeywords(args, keywords, format, kwlist, &lva, 0);
Christian Heimes2f2fee12016-09-21 11:37:27 +02001468 va_end(lva);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001469 return retval;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001470}
1471
1472int
1473_PyArg_VaParseTupleAndKeywords_SizeT(PyObject *args,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001474 PyObject *keywords,
1475 const char *format,
1476 char **kwlist, va_list va)
Martin v. Löwis18e16552006-02-15 17:27:45 +00001477{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001478 int retval;
1479 va_list lva;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001480
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001481 if ((args == NULL || !PyTuple_Check(args)) ||
1482 (keywords != NULL && !PyDict_Check(keywords)) ||
1483 format == NULL ||
1484 kwlist == NULL)
1485 {
1486 PyErr_BadInternalCall();
1487 return 0;
1488 }
Martin v. Löwis18e16552006-02-15 17:27:45 +00001489
Benjamin Peterson0c212142016-09-20 20:39:33 -07001490 va_copy(lva, va);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001491
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001492 retval = vgetargskeywords(args, keywords, format,
1493 kwlist, &lva, FLAG_SIZE_T);
Christian Heimes2f2fee12016-09-21 11:37:27 +02001494 va_end(lva);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001495 return retval;
Brett Cannon711e7d92004-07-10 22:20:32 +00001496}
1497
Benjamin Petersonfb886362010-04-24 18:21:17 +00001498int
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001499_PyArg_ParseTupleAndKeywordsFast(PyObject *args, PyObject *keywords,
1500 struct _PyArg_Parser *parser, ...)
1501{
1502 int retval;
1503 va_list va;
1504
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001505 va_start(va, parser);
1506 retval = vgetargskeywordsfast(args, keywords, parser, &va, 0);
1507 va_end(va);
1508 return retval;
1509}
1510
1511int
1512_PyArg_ParseTupleAndKeywordsFast_SizeT(PyObject *args, PyObject *keywords,
1513 struct _PyArg_Parser *parser, ...)
1514{
1515 int retval;
1516 va_list va;
1517
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001518 va_start(va, parser);
1519 retval = vgetargskeywordsfast(args, keywords, parser, &va, FLAG_SIZE_T);
1520 va_end(va);
1521 return retval;
1522}
1523
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07001524int
Victor Stinner3e1fad62017-01-17 01:29:01 +01001525_PyArg_ParseStackAndKeywords(PyObject **args, Py_ssize_t nargs, PyObject *kwnames,
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07001526 struct _PyArg_Parser *parser, ...)
1527{
1528 int retval;
1529 va_list va;
1530
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07001531 va_start(va, parser);
1532 retval = vgetargskeywordsfast_impl(args, nargs, NULL, kwnames, parser, &va, 0);
1533 va_end(va);
1534 return retval;
1535}
1536
1537int
Victor Stinner3e1fad62017-01-17 01:29:01 +01001538_PyArg_ParseStackAndKeywords_SizeT(PyObject **args, Py_ssize_t nargs, PyObject *kwnames,
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07001539 struct _PyArg_Parser *parser, ...)
1540{
1541 int retval;
1542 va_list va;
1543
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07001544 va_start(va, parser);
1545 retval = vgetargskeywordsfast_impl(args, nargs, NULL, kwnames, parser, &va, FLAG_SIZE_T);
1546 va_end(va);
1547 return retval;
1548}
1549
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001550
1551int
1552_PyArg_VaParseTupleAndKeywordsFast(PyObject *args, PyObject *keywords,
1553 struct _PyArg_Parser *parser, va_list va)
1554{
1555 int retval;
1556 va_list lva;
1557
Benjamin Peterson0c212142016-09-20 20:39:33 -07001558 va_copy(lva, va);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001559
1560 retval = vgetargskeywordsfast(args, keywords, parser, &lva, 0);
Christian Heimes2f2fee12016-09-21 11:37:27 +02001561 va_end(lva);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001562 return retval;
1563}
1564
1565int
1566_PyArg_VaParseTupleAndKeywordsFast_SizeT(PyObject *args, PyObject *keywords,
1567 struct _PyArg_Parser *parser, va_list va)
1568{
1569 int retval;
1570 va_list lva;
1571
Benjamin Peterson0c212142016-09-20 20:39:33 -07001572 va_copy(lva, va);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001573
1574 retval = vgetargskeywordsfast(args, keywords, parser, &lva, FLAG_SIZE_T);
Christian Heimes2f2fee12016-09-21 11:37:27 +02001575 va_end(lva);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001576 return retval;
1577}
1578
1579int
Benjamin Petersonfb886362010-04-24 18:21:17 +00001580PyArg_ValidateKeywordArguments(PyObject *kwargs)
1581{
Benjamin Petersonf6096542010-11-17 22:33:12 +00001582 if (!PyDict_Check(kwargs)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001583 PyErr_BadInternalCall();
1584 return 0;
1585 }
1586 if (!_PyDict_HasOnlyStringKeys(kwargs)) {
1587 PyErr_SetString(PyExc_TypeError,
Michael Seifert64c8f702017-04-09 09:47:12 +02001588 "keywords must be strings");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001589 return 0;
1590 }
1591 return 1;
Benjamin Petersonfb886362010-04-24 18:21:17 +00001592}
1593
Christian Heimes380f7f22008-02-28 11:19:05 +00001594#define IS_END_OF_FORMAT(c) (c == '\0' || c == ';' || c == ':')
Brett Cannon711e7d92004-07-10 22:20:32 +00001595
Guido van Rossumaa354651996-08-19 19:32:04 +00001596static int
Victor Stinnerc0083fc2017-01-17 00:37:42 +01001597vgetargskeywords(PyObject *args, PyObject *kwargs, const char *format,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001598 char **kwlist, va_list *p_va, int flags)
Guido van Rossumaa354651996-08-19 19:32:04 +00001599{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001600 char msgbuf[512];
1601 int levels[32];
Serhiy Storchaka17414412017-01-17 10:07:25 +02001602 const char *fname, *msg, *custom_msg;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001603 int min = INT_MAX;
Larry Hastings83a9f482012-03-20 20:06:16 +00001604 int max = INT_MAX;
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001605 int i, pos, len;
1606 int skip = 0;
Victor Stinnerc0083fc2017-01-17 00:37:42 +01001607 Py_ssize_t nargs, nkwargs;
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001608 PyObject *current_arg;
Antoine Pitrou7056cb22013-02-17 01:04:57 +01001609 freelistentry_t static_entries[STATIC_FREELIST_ENTRIES];
Benjamin Peterson40be9e52014-02-11 10:09:27 -05001610 freelist_t freelist;
1611
1612 freelist.entries = static_entries;
1613 freelist.first_available = 0;
1614 freelist.entries_malloced = 0;
Tim Petersf4331c12001-10-27 00:17:34 +00001615
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001616 assert(args != NULL && PyTuple_Check(args));
Victor Stinnerc0083fc2017-01-17 00:37:42 +01001617 assert(kwargs == NULL || PyDict_Check(kwargs));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001618 assert(format != NULL);
1619 assert(kwlist != NULL);
1620 assert(p_va != NULL);
Tim Peters45772cd2001-10-27 03:58:40 +00001621
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001622 /* grab the function name or custom error msg first (mutually exclusive) */
1623 fname = strchr(format, ':');
1624 if (fname) {
1625 fname++;
1626 custom_msg = NULL;
1627 }
1628 else {
1629 custom_msg = strchr(format,';');
1630 if (custom_msg)
1631 custom_msg++;
1632 }
Christian Heimes380f7f22008-02-28 11:19:05 +00001633
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001634 /* scan kwlist and count the number of positional-only parameters */
1635 for (pos = 0; kwlist[pos] && !*kwlist[pos]; pos++) {
1636 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001637 /* scan kwlist and get greatest possible nbr of args */
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001638 for (len = pos; kwlist[len]; len++) {
1639 if (!*kwlist[len]) {
1640 PyErr_SetString(PyExc_SystemError,
1641 "Empty keyword parameter name");
1642 return cleanreturn(0, &freelist);
1643 }
1644 }
Tim Petersf8cd3e82001-10-27 04:26:57 +00001645
Antoine Pitrou7056cb22013-02-17 01:04:57 +01001646 if (len > STATIC_FREELIST_ENTRIES) {
1647 freelist.entries = PyMem_NEW(freelistentry_t, len);
1648 if (freelist.entries == NULL) {
1649 PyErr_NoMemory();
1650 return 0;
1651 }
1652 freelist.entries_malloced = 1;
Benjamin Peterson7ed67272012-03-16 12:21:02 -05001653 }
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001654
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001655 nargs = PyTuple_GET_SIZE(args);
Victor Stinnerc0083fc2017-01-17 00:37:42 +01001656 nkwargs = (kwargs == NULL) ? 0 : PyDict_GET_SIZE(kwargs);
1657 if (nargs + nkwargs > len) {
Oren Milmanbf9075a2017-08-23 21:16:48 +03001658 /* Adding "keyword" (when nargs == 0) prevents producing wrong error
1659 messages in some special cases (see bpo-31229). */
Victor Stinner6ced7c42011-03-21 18:15:42 +01001660 PyErr_Format(PyExc_TypeError,
Oren Milmanbf9075a2017-08-23 21:16:48 +03001661 "%.200s%s takes at most %d %sargument%s (%zd given)",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001662 (fname == NULL) ? "function" : fname,
1663 (fname == NULL) ? "" : "()",
1664 len,
Oren Milmanbf9075a2017-08-23 21:16:48 +03001665 (nargs == 0) ? "keyword " : "",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001666 (len == 1) ? "" : "s",
Victor Stinnerc0083fc2017-01-17 00:37:42 +01001667 nargs + nkwargs);
Benjamin Peterson01feaec2012-03-16 13:25:58 -05001668 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001669 }
Tim Petersc2f01122001-10-27 07:25:06 +00001670
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001671 /* convert tuple args and keyword args in same loop, using kwlist to drive process */
1672 for (i = 0; i < len; i++) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001673 if (*format == '|') {
Larry Hastings83a9f482012-03-20 20:06:16 +00001674 if (min != 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 (| specified twice)");
1677 return cleanreturn(0, &freelist);
1678 }
1679
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001680 min = i;
1681 format++;
Larry Hastings83a9f482012-03-20 20:06:16 +00001682
1683 if (max != INT_MAX) {
Serhiy Storchakaa9725f82016-02-11 12:41:40 +02001684 PyErr_SetString(PyExc_SystemError,
Larry Hastings83a9f482012-03-20 20:06:16 +00001685 "Invalid format string ($ before |)");
1686 return cleanreturn(0, &freelist);
1687 }
1688 }
1689 if (*format == '$') {
1690 if (max != INT_MAX) {
Serhiy Storchakaa9725f82016-02-11 12:41:40 +02001691 PyErr_SetString(PyExc_SystemError,
Larry Hastings83a9f482012-03-20 20:06:16 +00001692 "Invalid format string ($ specified twice)");
1693 return cleanreturn(0, &freelist);
1694 }
1695
1696 max = i;
1697 format++;
1698
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001699 if (max < pos) {
1700 PyErr_SetString(PyExc_SystemError,
1701 "Empty parameter name after $");
1702 return cleanreturn(0, &freelist);
1703 }
1704 if (skip) {
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001705 /* Now we know the minimal and the maximal numbers of
1706 * positional arguments and can raise an exception with
1707 * informative message (see below). */
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001708 break;
1709 }
Larry Hastings83a9f482012-03-20 20:06:16 +00001710 if (max < nargs) {
Serhiy Storchaka5eb788b2017-06-06 18:45:22 +03001711 if (max == 0) {
1712 PyErr_Format(PyExc_TypeError,
1713 "%.200s%s takes no positional arguments",
1714 (fname == NULL) ? "function" : fname,
1715 (fname == NULL) ? "" : "()");
1716 }
1717 else {
1718 PyErr_Format(PyExc_TypeError,
1719 "%.200s%s takes %s %d positional arguments"
1720 " (%d given)",
1721 (fname == NULL) ? "function" : fname,
1722 (fname == NULL) ? "" : "()",
1723 (min != INT_MAX) ? "at most" : "exactly",
1724 max, nargs);
1725 }
Larry Hastings83a9f482012-03-20 20:06:16 +00001726 return cleanreturn(0, &freelist);
1727 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001728 }
1729 if (IS_END_OF_FORMAT(*format)) {
Serhiy Storchakaa9725f82016-02-11 12:41:40 +02001730 PyErr_Format(PyExc_SystemError,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001731 "More keyword list entries (%d) than "
1732 "format specifiers (%d)", len, i);
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001733 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001734 }
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001735 if (!skip) {
Serhiy Storchaka17414412017-01-17 10:07:25 +02001736 if (i < nargs) {
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001737 current_arg = PyTuple_GET_ITEM(args, i);
Serhiy Storchaka17414412017-01-17 10:07:25 +02001738 }
1739 else if (nkwargs && i >= pos) {
1740 current_arg = PyDict_GetItemString(kwargs, kwlist[i]);
1741 if (current_arg)
1742 --nkwargs;
1743 }
1744 else {
1745 current_arg = NULL;
1746 }
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001747
1748 if (current_arg) {
1749 msg = convertitem(current_arg, &format, p_va, flags,
1750 levels, msgbuf, sizeof(msgbuf), &freelist);
1751 if (msg) {
1752 seterror(i+1, msg, levels, fname, custom_msg);
1753 return cleanreturn(0, &freelist);
1754 }
1755 continue;
1756 }
1757
1758 if (i < min) {
1759 if (i < pos) {
1760 assert (min == INT_MAX);
1761 assert (max == INT_MAX);
1762 skip = 1;
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001763 /* At that moment we still don't know the minimal and
1764 * the maximal numbers of positional arguments. Raising
1765 * an exception is deferred until we encounter | and $
1766 * or the end of the format. */
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001767 }
1768 else {
Michael Seifert64c8f702017-04-09 09:47:12 +02001769 PyErr_Format(PyExc_TypeError, "%.200s%s missing required "
1770 "argument '%s' (pos %d)",
1771 (fname == NULL) ? "function" : fname,
1772 (fname == NULL) ? "" : "()",
Serhiy Storchaka17414412017-01-17 10:07:25 +02001773 kwlist[i], i+1);
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001774 return cleanreturn(0, &freelist);
1775 }
1776 }
1777 /* current code reports success when all required args
1778 * fulfilled and no keyword args left, with no further
1779 * validation. XXX Maybe skip this in debug build ?
1780 */
Victor Stinnerc0083fc2017-01-17 00:37:42 +01001781 if (!nkwargs && !skip) {
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001782 return cleanreturn(1, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001783 }
1784 }
Guido van Rossumaa354651996-08-19 19:32:04 +00001785
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001786 /* We are into optional args, skip thru to any remaining
1787 * keyword args */
1788 msg = skipitem(&format, p_va, flags);
1789 if (msg) {
Serhiy Storchakaa9725f82016-02-11 12:41:40 +02001790 PyErr_Format(PyExc_SystemError, "%s: '%s'", msg,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001791 format);
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001792 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001793 }
1794 }
Tim Petersb054be42001-10-27 05:07:41 +00001795
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001796 if (skip) {
1797 PyErr_Format(PyExc_TypeError,
Michael Seifert64c8f702017-04-09 09:47:12 +02001798 "%.200s%s takes %s %d positional arguments"
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001799 " (%d given)",
Michael Seifert64c8f702017-04-09 09:47:12 +02001800 (fname == NULL) ? "function" : fname,
1801 (fname == NULL) ? "" : "()",
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001802 (Py_MIN(pos, min) < i) ? "at least" : "exactly",
1803 Py_MIN(pos, min), nargs);
1804 return cleanreturn(0, &freelist);
1805 }
1806
Larry Hastings83a9f482012-03-20 20:06:16 +00001807 if (!IS_END_OF_FORMAT(*format) && (*format != '|') && (*format != '$')) {
Serhiy Storchakaa9725f82016-02-11 12:41:40 +02001808 PyErr_Format(PyExc_SystemError,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001809 "more argument specifiers than keyword list entries "
1810 "(remaining format:'%s')", format);
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001811 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001812 }
Tim Petersc2f01122001-10-27 07:25:06 +00001813
Victor Stinnerc0083fc2017-01-17 00:37:42 +01001814 if (nkwargs > 0) {
Serhiy Storchaka17414412017-01-17 10:07:25 +02001815 PyObject *key;
1816 Py_ssize_t j;
1817 /* make sure there are no arguments given by name and position */
1818 for (i = pos; i < nargs; i++) {
1819 current_arg = PyDict_GetItemString(kwargs, kwlist[i]);
1820 if (current_arg) {
1821 /* arg present in tuple and in dict */
1822 PyErr_Format(PyExc_TypeError,
Michael Seifert64c8f702017-04-09 09:47:12 +02001823 "argument for %.200s%s given by name ('%s') "
Serhiy Storchaka17414412017-01-17 10:07:25 +02001824 "and position (%d)",
Michael Seifert64c8f702017-04-09 09:47:12 +02001825 (fname == NULL) ? "function" : fname,
1826 (fname == NULL) ? "" : "()",
Serhiy Storchaka17414412017-01-17 10:07:25 +02001827 kwlist[i], i+1);
1828 return cleanreturn(0, &freelist);
1829 }
1830 }
1831 /* make sure there are no extraneous keyword arguments */
1832 j = 0;
1833 while (PyDict_Next(kwargs, &j, &key, NULL)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001834 int match = 0;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001835 if (!PyUnicode_Check(key)) {
1836 PyErr_SetString(PyExc_TypeError,
1837 "keywords must be strings");
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001838 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001839 }
Serhiy Storchaka17414412017-01-17 10:07:25 +02001840 for (i = pos; i < len; i++) {
1841 if (_PyUnicode_EqualToASCIIString(key, kwlist[i])) {
Antoine Pitrou7056cb22013-02-17 01:04:57 +01001842 match = 1;
1843 break;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001844 }
1845 }
1846 if (!match) {
1847 PyErr_Format(PyExc_TypeError,
Victor Stinner93b55132010-05-19 00:54:06 +00001848 "'%U' is an invalid keyword "
Michael Seifert64c8f702017-04-09 09:47:12 +02001849 "argument for %.200s%s",
1850 key,
1851 (fname == NULL) ? "this function" : fname,
1852 (fname == NULL) ? "" : "()");
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001853 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001854 }
1855 }
1856 }
1857
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001858 return cleanreturn(1, &freelist);
Guido van Rossumaa354651996-08-19 19:32:04 +00001859}
1860
1861
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001862/* List of static parsers. */
1863static struct _PyArg_Parser *static_arg_parsers = NULL;
1864
1865static int
1866parser_init(struct _PyArg_Parser *parser)
1867{
1868 const char * const *keywords;
1869 const char *format, *msg;
1870 int i, len, min, max, nkw;
1871 PyObject *kwtuple;
1872
1873 assert(parser->format != NULL);
1874 assert(parser->keywords != NULL);
1875 if (parser->kwtuple != NULL) {
1876 return 1;
1877 }
1878
1879 /* grab the function name or custom error msg first (mutually exclusive) */
1880 parser->fname = strchr(parser->format, ':');
1881 if (parser->fname) {
1882 parser->fname++;
1883 parser->custom_msg = NULL;
1884 }
1885 else {
1886 parser->custom_msg = strchr(parser->format,';');
1887 if (parser->custom_msg)
1888 parser->custom_msg++;
1889 }
1890
1891 keywords = parser->keywords;
1892 /* scan keywords and count the number of positional-only parameters */
1893 for (i = 0; keywords[i] && !*keywords[i]; i++) {
1894 }
1895 parser->pos = i;
1896 /* scan keywords and get greatest possible nbr of args */
1897 for (; keywords[i]; i++) {
1898 if (!*keywords[i]) {
1899 PyErr_SetString(PyExc_SystemError,
1900 "Empty keyword parameter name");
1901 return 0;
1902 }
1903 }
1904 len = i;
1905
1906 min = max = INT_MAX;
1907 format = parser->format;
1908 for (i = 0; i < len; i++) {
1909 if (*format == '|') {
1910 if (min != INT_MAX) {
1911 PyErr_SetString(PyExc_SystemError,
1912 "Invalid format string (| specified twice)");
1913 return 0;
1914 }
1915 if (max != INT_MAX) {
1916 PyErr_SetString(PyExc_SystemError,
1917 "Invalid format string ($ before |)");
1918 return 0;
1919 }
1920 min = i;
1921 format++;
1922 }
1923 if (*format == '$') {
1924 if (max != INT_MAX) {
1925 PyErr_SetString(PyExc_SystemError,
1926 "Invalid format string ($ specified twice)");
1927 return 0;
1928 }
1929 if (i < parser->pos) {
1930 PyErr_SetString(PyExc_SystemError,
1931 "Empty parameter name after $");
1932 return 0;
1933 }
1934 max = i;
1935 format++;
1936 }
1937 if (IS_END_OF_FORMAT(*format)) {
1938 PyErr_Format(PyExc_SystemError,
1939 "More keyword list entries (%d) than "
1940 "format specifiers (%d)", len, i);
1941 return 0;
1942 }
1943
1944 msg = skipitem(&format, NULL, 0);
1945 if (msg) {
1946 PyErr_Format(PyExc_SystemError, "%s: '%s'", msg,
1947 format);
1948 return 0;
1949 }
1950 }
1951 parser->min = Py_MIN(min, len);
1952 parser->max = Py_MIN(max, len);
1953
1954 if (!IS_END_OF_FORMAT(*format) && (*format != '|') && (*format != '$')) {
1955 PyErr_Format(PyExc_SystemError,
1956 "more argument specifiers than keyword list entries "
1957 "(remaining format:'%s')", format);
1958 return 0;
1959 }
1960
1961 nkw = len - parser->pos;
1962 kwtuple = PyTuple_New(nkw);
1963 if (kwtuple == NULL) {
1964 return 0;
1965 }
1966 keywords = parser->keywords + parser->pos;
1967 for (i = 0; i < nkw; i++) {
1968 PyObject *str = PyUnicode_FromString(keywords[i]);
1969 if (str == NULL) {
1970 Py_DECREF(kwtuple);
1971 return 0;
1972 }
1973 PyUnicode_InternInPlace(&str);
1974 PyTuple_SET_ITEM(kwtuple, i, str);
1975 }
1976 parser->kwtuple = kwtuple;
1977
1978 assert(parser->next == NULL);
1979 parser->next = static_arg_parsers;
1980 static_arg_parsers = parser;
1981 return 1;
1982}
1983
1984static void
1985parser_clear(struct _PyArg_Parser *parser)
1986{
1987 Py_CLEAR(parser->kwtuple);
1988}
1989
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07001990static PyObject*
Serhiy Storchaka17414412017-01-17 10:07:25 +02001991find_keyword(PyObject *kwargs, PyObject *kwnames, PyObject **kwstack, PyObject *key)
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07001992{
1993 Py_ssize_t i, nkwargs;
1994
Serhiy Storchaka17414412017-01-17 10:07:25 +02001995 if (kwargs != NULL) {
1996 return PyDict_GetItem(kwargs, key);
1997 }
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07001998 nkwargs = PyTuple_GET_SIZE(kwnames);
1999 for (i=0; i < nkwargs; i++) {
2000 PyObject *kwname = PyTuple_GET_ITEM(kwnames, i);
2001
2002 /* ptr==ptr should match in most cases since keyword keys
2003 should be interned strings */
2004 if (kwname == key) {
2005 return kwstack[i];
2006 }
2007 if (!PyUnicode_Check(kwname)) {
2008 /* ignore non-string keyword keys:
Serhiy Storchaka17414412017-01-17 10:07:25 +02002009 an error will be raised below */
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002010 continue;
2011 }
2012 if (_PyUnicode_EQ(kwname, key)) {
2013 return kwstack[i];
2014 }
2015 }
2016 return NULL;
2017}
2018
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002019static int
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002020vgetargskeywordsfast_impl(PyObject **args, Py_ssize_t nargs,
Victor Stinnerc0083fc2017-01-17 00:37:42 +01002021 PyObject *kwargs, PyObject *kwnames,
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002022 struct _PyArg_Parser *parser,
2023 va_list *p_va, int flags)
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002024{
2025 PyObject *kwtuple;
2026 char msgbuf[512];
2027 int levels[32];
2028 const char *format;
2029 const char *msg;
2030 PyObject *keyword;
2031 int i, pos, len;
Victor Stinnerc0083fc2017-01-17 00:37:42 +01002032 Py_ssize_t nkwargs;
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002033 PyObject *current_arg;
2034 freelistentry_t static_entries[STATIC_FREELIST_ENTRIES];
2035 freelist_t freelist;
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002036 PyObject **kwstack = NULL;
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002037
2038 freelist.entries = static_entries;
2039 freelist.first_available = 0;
2040 freelist.entries_malloced = 0;
2041
Victor Stinnerc0083fc2017-01-17 00:37:42 +01002042 assert(kwargs == NULL || PyDict_Check(kwargs));
Serhiy Storchaka17414412017-01-17 10:07:25 +02002043 assert(kwargs == NULL || kwnames == NULL);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002044 assert(p_va != NULL);
2045
Victor Stinner80ab22f2017-01-16 23:16:47 +01002046 if (parser == NULL) {
2047 PyErr_BadInternalCall();
2048 return 0;
2049 }
2050
2051 if (kwnames != NULL && !PyTuple_Check(kwnames)) {
2052 PyErr_BadInternalCall();
2053 return 0;
2054 }
2055
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002056 if (!parser_init(parser)) {
2057 return 0;
2058 }
2059
2060 kwtuple = parser->kwtuple;
2061 pos = parser->pos;
Segev Finere7bc7aa2017-07-26 18:58:25 +03002062 len = pos + (int)PyTuple_GET_SIZE(kwtuple);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002063
2064 if (len > STATIC_FREELIST_ENTRIES) {
2065 freelist.entries = PyMem_NEW(freelistentry_t, len);
2066 if (freelist.entries == NULL) {
2067 PyErr_NoMemory();
2068 return 0;
2069 }
2070 freelist.entries_malloced = 1;
2071 }
2072
Victor Stinnerc0083fc2017-01-17 00:37:42 +01002073 if (kwargs != NULL) {
2074 nkwargs = PyDict_GET_SIZE(kwargs);
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002075 }
2076 else if (kwnames != NULL) {
Victor Stinnerc0083fc2017-01-17 00:37:42 +01002077 nkwargs = PyTuple_GET_SIZE(kwnames);
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002078 kwstack = args + nargs;
2079 }
2080 else {
Victor Stinnerc0083fc2017-01-17 00:37:42 +01002081 nkwargs = 0;
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002082 }
Victor Stinnerc0083fc2017-01-17 00:37:42 +01002083 if (nargs + nkwargs > len) {
Oren Milmanbf9075a2017-08-23 21:16:48 +03002084 /* Adding "keyword" (when nargs == 0) prevents producing wrong error
2085 messages in some special cases (see bpo-31229). */
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002086 PyErr_Format(PyExc_TypeError,
Oren Milmanbf9075a2017-08-23 21:16:48 +03002087 "%.200s%s takes at most %d %sargument%s (%zd given)",
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002088 (parser->fname == NULL) ? "function" : parser->fname,
2089 (parser->fname == NULL) ? "" : "()",
2090 len,
Oren Milmanbf9075a2017-08-23 21:16:48 +03002091 (nargs == 0) ? "keyword " : "",
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002092 (len == 1) ? "" : "s",
Victor Stinnerc0083fc2017-01-17 00:37:42 +01002093 nargs + nkwargs);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002094 return cleanreturn(0, &freelist);
2095 }
2096 if (parser->max < nargs) {
Serhiy Storchaka5eb788b2017-06-06 18:45:22 +03002097 if (parser->max == 0) {
2098 PyErr_Format(PyExc_TypeError,
Serhiy Storchakaf9f1cca2017-06-09 19:27:06 +03002099 "%.200s%s takes no positional arguments",
Serhiy Storchaka5eb788b2017-06-06 18:45:22 +03002100 (parser->fname == NULL) ? "function" : parser->fname,
2101 (parser->fname == NULL) ? "" : "()");
2102 }
2103 else {
2104 PyErr_Format(PyExc_TypeError,
Serhiy Storchakaf9f1cca2017-06-09 19:27:06 +03002105 "%.200s%s takes %s %d positional arguments (%d given)",
Serhiy Storchaka5eb788b2017-06-06 18:45:22 +03002106 (parser->fname == NULL) ? "function" : parser->fname,
2107 (parser->fname == NULL) ? "" : "()",
2108 (parser->min != INT_MAX) ? "at most" : "exactly",
2109 parser->max, nargs);
2110 }
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002111 return cleanreturn(0, &freelist);
2112 }
2113
2114 format = parser->format;
2115 /* convert tuple args and keyword args in same loop, using kwtuple to drive process */
2116 for (i = 0; i < len; i++) {
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002117 if (*format == '|') {
2118 format++;
2119 }
2120 if (*format == '$') {
2121 format++;
2122 }
2123 assert(!IS_END_OF_FORMAT(*format));
2124
Serhiy Storchaka17414412017-01-17 10:07:25 +02002125 if (i < nargs) {
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002126 current_arg = args[i];
Victor Stinnera9efb2f2016-09-09 17:40:22 -07002127 }
Serhiy Storchaka17414412017-01-17 10:07:25 +02002128 else if (nkwargs && i >= pos) {
2129 keyword = PyTuple_GET_ITEM(kwtuple, i - pos);
2130 current_arg = find_keyword(kwargs, kwnames, kwstack, keyword);
2131 if (current_arg)
2132 --nkwargs;
2133 }
2134 else {
2135 current_arg = NULL;
2136 }
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002137
2138 if (current_arg) {
2139 msg = convertitem(current_arg, &format, p_va, flags,
2140 levels, msgbuf, sizeof(msgbuf), &freelist);
2141 if (msg) {
2142 seterror(i+1, msg, levels, parser->fname, parser->custom_msg);
2143 return cleanreturn(0, &freelist);
2144 }
2145 continue;
2146 }
2147
2148 if (i < parser->min) {
2149 /* Less arguments than required */
2150 if (i < pos) {
Serhiy Storchaka17414412017-01-17 10:07:25 +02002151 Py_ssize_t min = Py_MIN(pos, parser->min);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002152 PyErr_Format(PyExc_TypeError,
Michael Seifert64c8f702017-04-09 09:47:12 +02002153 "%.200s%s takes %s %d positional arguments"
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002154 " (%d given)",
Michael Seifert64c8f702017-04-09 09:47:12 +02002155 (parser->fname == NULL) ? "function" : parser->fname,
2156 (parser->fname == NULL) ? "" : "()",
Serhiy Storchaka17414412017-01-17 10:07:25 +02002157 min < parser->max ? "at least" : "exactly",
2158 min, nargs);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002159 }
2160 else {
Serhiy Storchaka17414412017-01-17 10:07:25 +02002161 keyword = PyTuple_GET_ITEM(kwtuple, i - pos);
Michael Seifert64c8f702017-04-09 09:47:12 +02002162 PyErr_Format(PyExc_TypeError, "%.200s%s missing required "
2163 "argument '%U' (pos %d)",
2164 (parser->fname == NULL) ? "function" : parser->fname,
2165 (parser->fname == NULL) ? "" : "()",
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002166 keyword, i+1);
2167 }
2168 return cleanreturn(0, &freelist);
2169 }
2170 /* current code reports success when all required args
2171 * fulfilled and no keyword args left, with no further
2172 * validation. XXX Maybe skip this in debug build ?
2173 */
Victor Stinnerc0083fc2017-01-17 00:37:42 +01002174 if (!nkwargs) {
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002175 return cleanreturn(1, &freelist);
2176 }
2177
2178 /* We are into optional args, skip thru to any remaining
2179 * keyword args */
2180 msg = skipitem(&format, p_va, flags);
2181 assert(msg == NULL);
2182 }
2183
2184 assert(IS_END_OF_FORMAT(*format) || (*format == '|') || (*format == '$'));
2185
Victor Stinnerc0083fc2017-01-17 00:37:42 +01002186 if (nkwargs > 0) {
Serhiy Storchaka17414412017-01-17 10:07:25 +02002187 Py_ssize_t j;
2188 /* make sure there are no arguments given by name and position */
2189 for (i = pos; i < nargs; i++) {
2190 keyword = PyTuple_GET_ITEM(kwtuple, i - pos);
2191 current_arg = find_keyword(kwargs, kwnames, kwstack, keyword);
2192 if (current_arg) {
2193 /* arg present in tuple and in dict */
2194 PyErr_Format(PyExc_TypeError,
Michael Seifert64c8f702017-04-09 09:47:12 +02002195 "argument for %.200s%s given by name ('%U') "
Serhiy Storchaka17414412017-01-17 10:07:25 +02002196 "and position (%d)",
Michael Seifert64c8f702017-04-09 09:47:12 +02002197 (parser->fname == NULL) ? "function" : parser->fname,
2198 (parser->fname == NULL) ? "" : "()",
Serhiy Storchaka17414412017-01-17 10:07:25 +02002199 keyword, i+1);
2200 return cleanreturn(0, &freelist);
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002201 }
2202 }
Serhiy Storchaka17414412017-01-17 10:07:25 +02002203 /* make sure there are no extraneous keyword arguments */
2204 j = 0;
2205 while (1) {
2206 int match;
2207 if (kwargs != NULL) {
2208 if (!PyDict_Next(kwargs, &j, &keyword, NULL))
2209 break;
2210 }
2211 else {
2212 if (j >= PyTuple_GET_SIZE(kwnames))
2213 break;
2214 keyword = PyTuple_GET_ITEM(kwnames, j);
2215 j++;
2216 }
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002217
Serhiy Storchaka17414412017-01-17 10:07:25 +02002218 if (!PyUnicode_Check(keyword)) {
2219 PyErr_SetString(PyExc_TypeError,
2220 "keywords must be strings");
2221 return cleanreturn(0, &freelist);
2222 }
2223 match = PySequence_Contains(kwtuple, keyword);
2224 if (match <= 0) {
2225 if (!match) {
2226 PyErr_Format(PyExc_TypeError,
2227 "'%U' is an invalid keyword "
Michael Seifert64c8f702017-04-09 09:47:12 +02002228 "argument for %.200s%s",
2229 keyword,
2230 (parser->fname == NULL) ? "this function" : parser->fname,
2231 (parser->fname == NULL) ? "" : "()");
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002232 }
Serhiy Storchaka17414412017-01-17 10:07:25 +02002233 return cleanreturn(0, &freelist);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002234 }
2235 }
2236 }
2237
2238 return cleanreturn(1, &freelist);
2239}
2240
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002241static int
2242vgetargskeywordsfast(PyObject *args, PyObject *keywords,
2243 struct _PyArg_Parser *parser, va_list *p_va, int flags)
2244{
2245 PyObject **stack;
2246 Py_ssize_t nargs;
2247
Victor Stinner80ab22f2017-01-16 23:16:47 +01002248 if (args == NULL
2249 || !PyTuple_Check(args)
2250 || (keywords != NULL && !PyDict_Check(keywords)))
2251 {
2252 PyErr_BadInternalCall();
2253 return 0;
2254 }
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002255
2256 stack = &PyTuple_GET_ITEM(args, 0);
2257 nargs = PyTuple_GET_SIZE(args);
2258 return vgetargskeywordsfast_impl(stack, nargs, keywords, NULL,
2259 parser, p_va, flags);
2260}
2261
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002262
Serhiy Storchakaef1585e2015-12-25 20:01:53 +02002263static const char *
Martin v. Löwis18e16552006-02-15 17:27:45 +00002264skipitem(const char **p_format, va_list *p_va, int flags)
Guido van Rossumaa354651996-08-19 19:32:04 +00002265{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002266 const char *format = *p_format;
2267 char c = *format++;
Guido van Rossum98297ee2007-11-06 21:34:58 +00002268
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002269 switch (c) {
Georg Brandl6dd14612005-09-14 19:29:53 +00002270
Larry Hastingsa3479012012-05-08 23:52:03 -07002271 /*
2272 * codes that take a single data pointer as an argument
2273 * (the type of the pointer is irrelevant)
2274 */
Georg Brandl6dd14612005-09-14 19:29:53 +00002275
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002276 case 'b': /* byte -- very short int */
2277 case 'B': /* byte as bitfield */
2278 case 'h': /* short int */
2279 case 'H': /* short int as bitfield */
2280 case 'i': /* int */
2281 case 'I': /* int sized bitfield */
2282 case 'l': /* long int */
2283 case 'k': /* long int sized bitfield */
Benjamin Petersonaf580df2016-09-06 10:46:49 -07002284 case 'L': /* long long */
2285 case 'K': /* long long sized bitfield */
Larry Hastingsa3479012012-05-08 23:52:03 -07002286 case 'n': /* Py_ssize_t */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002287 case 'f': /* float */
2288 case 'd': /* double */
2289 case 'D': /* complex double */
2290 case 'c': /* char */
2291 case 'C': /* unicode char */
Larry Hastings10ba07a2012-05-07 02:44:50 -07002292 case 'p': /* boolean predicate */
Larry Hastingsa3479012012-05-08 23:52:03 -07002293 case 'S': /* string object */
2294 case 'Y': /* string object */
2295 case 'U': /* unicode string object */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002296 {
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002297 if (p_va != NULL) {
2298 (void) va_arg(*p_va, void *);
2299 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002300 break;
2301 }
Martin v. Löwis18e16552006-02-15 17:27:45 +00002302
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002303 /* string codes */
Guido van Rossum98297ee2007-11-06 21:34:58 +00002304
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002305 case 'e': /* string with encoding */
2306 {
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002307 if (p_va != NULL) {
2308 (void) va_arg(*p_va, const char *);
2309 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002310 if (!(*format == 's' || *format == 't'))
2311 /* after 'e', only 's' and 't' is allowed */
2312 goto err;
2313 format++;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002314 }
Stefan Krahf432a322017-08-21 13:09:59 +02002315 /* fall through */
Guido van Rossum98297ee2007-11-06 21:34:58 +00002316
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002317 case 's': /* string */
2318 case 'z': /* string or None */
2319 case 'y': /* bytes */
2320 case 'u': /* unicode string */
Larry Hastingsd9e4a412012-05-08 03:51:18 -07002321 case 'Z': /* unicode string or None */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002322 case 'w': /* buffer, read-write */
2323 {
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002324 if (p_va != NULL) {
2325 (void) va_arg(*p_va, char **);
2326 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002327 if (*format == '#') {
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002328 if (p_va != NULL) {
2329 if (flags & FLAG_SIZE_T)
2330 (void) va_arg(*p_va, Py_ssize_t *);
2331 else
2332 (void) va_arg(*p_va, int *);
2333 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002334 format++;
2335 } else if ((c == 's' || c == 'z' || c == 'y') && *format == '*') {
2336 format++;
2337 }
2338 break;
2339 }
Georg Brandl6dd14612005-09-14 19:29:53 +00002340
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002341 case 'O': /* object */
2342 {
2343 if (*format == '!') {
2344 format++;
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002345 if (p_va != NULL) {
2346 (void) va_arg(*p_va, PyTypeObject*);
2347 (void) va_arg(*p_va, PyObject **);
2348 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002349 }
2350 else if (*format == '&') {
2351 typedef int (*converter)(PyObject *, void *);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002352 if (p_va != NULL) {
2353 (void) va_arg(*p_va, converter);
2354 (void) va_arg(*p_va, void *);
2355 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002356 format++;
2357 }
2358 else {
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002359 if (p_va != NULL) {
2360 (void) va_arg(*p_va, PyObject **);
2361 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002362 }
2363 break;
2364 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00002365
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002366 case '(': /* bypass tuple, not handled at all previously */
2367 {
Serhiy Storchakaef1585e2015-12-25 20:01:53 +02002368 const char *msg;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002369 for (;;) {
2370 if (*format==')')
2371 break;
2372 if (IS_END_OF_FORMAT(*format))
2373 return "Unmatched left paren in format "
2374 "string";
2375 msg = skipitem(&format, p_va, flags);
2376 if (msg)
2377 return msg;
2378 }
2379 format++;
2380 break;
2381 }
Christian Heimes380f7f22008-02-28 11:19:05 +00002382
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002383 case ')':
2384 return "Unmatched right paren in format string";
Christian Heimes380f7f22008-02-28 11:19:05 +00002385
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002386 default:
Georg Brandl6dd14612005-09-14 19:29:53 +00002387err:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002388 return "impossible<bad format char>";
Guido van Rossum98297ee2007-11-06 21:34:58 +00002389
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002390 }
Georg Brandl6dd14612005-09-14 19:29:53 +00002391
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002392 *p_format = format;
2393 return NULL;
Guido van Rossumaa354651996-08-19 19:32:04 +00002394}
Fred Drakee4616e62001-10-23 21:09:29 +00002395
2396
Victor Stinnerfe54dd82017-01-17 02:33:55 +01002397static int
Victor Stinnerfdbc3972017-02-01 17:42:18 +01002398unpack_stack(PyObject **args, Py_ssize_t nargs, const char *name,
2399 Py_ssize_t min, Py_ssize_t max, va_list vargs)
Fred Drakee4616e62001-10-23 21:09:29 +00002400{
Victor Stinnerfe54dd82017-01-17 02:33:55 +01002401 Py_ssize_t i;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002402 PyObject **o;
Fred Drakee4616e62001-10-23 21:09:29 +00002403
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002404 assert(min >= 0);
2405 assert(min <= max);
Victor Stinnerfe54dd82017-01-17 02:33:55 +01002406
Victor Stinnerfdbc3972017-02-01 17:42:18 +01002407 if (nargs < min) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002408 if (name != NULL)
2409 PyErr_Format(
2410 PyExc_TypeError,
Michael Seifert64c8f702017-04-09 09:47:12 +02002411 "%.200s expected %s%zd arguments, got %zd",
Victor Stinnerfdbc3972017-02-01 17:42:18 +01002412 name, (min == max ? "" : "at least "), min, nargs);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002413 else
2414 PyErr_Format(
2415 PyExc_TypeError,
2416 "unpacked tuple should have %s%zd elements,"
2417 " but has %zd",
Victor Stinnerfdbc3972017-02-01 17:42:18 +01002418 (min == max ? "" : "at least "), min, nargs);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002419 return 0;
2420 }
Victor Stinnerfe54dd82017-01-17 02:33:55 +01002421
Victor Stinnerfdbc3972017-02-01 17:42:18 +01002422 if (nargs == 0) {
Raymond Hettinger94230232016-03-26 03:02:48 -07002423 return 1;
Victor Stinnerfe54dd82017-01-17 02:33:55 +01002424 }
2425
Victor Stinnerfdbc3972017-02-01 17:42:18 +01002426 if (nargs > max) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002427 if (name != NULL)
2428 PyErr_Format(
2429 PyExc_TypeError,
Michael Seifert64c8f702017-04-09 09:47:12 +02002430 "%.200s expected %s%zd arguments, got %zd",
Victor Stinnerfdbc3972017-02-01 17:42:18 +01002431 name, (min == max ? "" : "at most "), max, nargs);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002432 else
2433 PyErr_Format(
2434 PyExc_TypeError,
2435 "unpacked tuple should have %s%zd elements,"
2436 " but has %zd",
Victor Stinnerfdbc3972017-02-01 17:42:18 +01002437 (min == max ? "" : "at most "), max, nargs);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002438 return 0;
2439 }
Raymond Hettinger94230232016-03-26 03:02:48 -07002440
Victor Stinnerfdbc3972017-02-01 17:42:18 +01002441 for (i = 0; i < nargs; i++) {
Victor Stinnerfe54dd82017-01-17 02:33:55 +01002442 o = va_arg(vargs, PyObject **);
2443 *o = args[i];
2444 }
2445 return 1;
2446}
2447
2448int
2449PyArg_UnpackTuple(PyObject *args, const char *name, Py_ssize_t min, Py_ssize_t max, ...)
2450{
2451 PyObject **stack;
2452 Py_ssize_t nargs;
2453 int retval;
2454 va_list vargs;
2455
2456 if (!PyTuple_Check(args)) {
2457 PyErr_SetString(PyExc_SystemError,
2458 "PyArg_UnpackTuple() argument list is not a tuple");
2459 return 0;
2460 }
2461 stack = &PyTuple_GET_ITEM(args, 0);
2462 nargs = PyTuple_GET_SIZE(args);
2463
Raymond Hettinger94230232016-03-26 03:02:48 -07002464#ifdef HAVE_STDARG_PROTOTYPES
2465 va_start(vargs, max);
2466#else
2467 va_start(vargs);
2468#endif
Victor Stinnerfdbc3972017-02-01 17:42:18 +01002469 retval = unpack_stack(stack, nargs, name, min, max, vargs);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002470 va_end(vargs);
Victor Stinnerfe54dd82017-01-17 02:33:55 +01002471 return retval;
2472}
2473
2474int
2475_PyArg_UnpackStack(PyObject **args, Py_ssize_t nargs, const char *name,
2476 Py_ssize_t min, Py_ssize_t max, ...)
2477{
2478 int retval;
2479 va_list vargs;
2480
2481#ifdef HAVE_STDARG_PROTOTYPES
2482 va_start(vargs, max);
2483#else
2484 va_start(vargs);
2485#endif
Victor Stinnerfdbc3972017-02-01 17:42:18 +01002486 retval = unpack_stack(args, nargs, name, min, max, vargs);
Victor Stinnerfe54dd82017-01-17 02:33:55 +01002487 va_end(vargs);
2488 return retval;
Fred Drakee4616e62001-10-23 21:09:29 +00002489}
Georg Brandl02c42872005-08-26 06:42:30 +00002490
2491
Serhiy Storchaka68a001d2017-02-06 10:41:46 +02002492#undef _PyArg_NoKeywords
Serhiy Storchaka68a001d2017-02-06 10:41:46 +02002493#undef _PyArg_NoPositional
2494
Georg Brandl02c42872005-08-26 06:42:30 +00002495/* For type constructors that don't take keyword args
2496 *
Larry Hastingsb7ccb202014-01-18 23:50:21 -08002497 * Sets a TypeError and returns 0 if the args/kwargs is
Thomas Wouters89f507f2006-12-13 04:49:30 +00002498 * not empty, returns 1 otherwise
Georg Brandl02c42872005-08-26 06:42:30 +00002499 */
2500int
Victor Stinner29d39cc2017-01-17 01:40:01 +01002501_PyArg_NoKeywords(const char *funcname, PyObject *kwargs)
Georg Brandl02c42872005-08-26 06:42:30 +00002502{
Victor Stinnerfe54dd82017-01-17 02:33:55 +01002503 if (kwargs == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002504 return 1;
Victor Stinnerfe54dd82017-01-17 02:33:55 +01002505 }
Victor Stinner29d39cc2017-01-17 01:40:01 +01002506 if (!PyDict_CheckExact(kwargs)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002507 PyErr_BadInternalCall();
2508 return 0;
2509 }
Victor Stinner29d39cc2017-01-17 01:40:01 +01002510 if (PyDict_GET_SIZE(kwargs) == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002511 return 1;
Victor Stinner29d39cc2017-01-17 01:40:01 +01002512 }
2513
Serhiy Storchaka5eb788b2017-06-06 18:45:22 +03002514 PyErr_Format(PyExc_TypeError, "%.200s() takes no keyword arguments",
Victor Stinner29d39cc2017-01-17 01:40:01 +01002515 funcname);
2516 return 0;
2517}
2518
2519
2520int
Larry Hastingsb7ccb202014-01-18 23:50:21 -08002521_PyArg_NoPositional(const char *funcname, PyObject *args)
2522{
2523 if (args == NULL)
2524 return 1;
2525 if (!PyTuple_CheckExact(args)) {
2526 PyErr_BadInternalCall();
2527 return 0;
2528 }
2529 if (PyTuple_GET_SIZE(args) == 0)
2530 return 1;
2531
Serhiy Storchaka5eb788b2017-06-06 18:45:22 +03002532 PyErr_Format(PyExc_TypeError, "%.200s() takes no positional arguments",
Larry Hastingsb7ccb202014-01-18 23:50:21 -08002533 funcname);
2534 return 0;
2535}
2536
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002537void
2538_PyArg_Fini(void)
2539{
2540 struct _PyArg_Parser *tmp, *s = static_arg_parsers;
2541 while (s) {
2542 tmp = s->next;
2543 s->next = NULL;
2544 parser_clear(s);
2545 s = tmp;
2546 }
2547 static_arg_parsers = NULL;
2548}
2549
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002550#ifdef __cplusplus
2551};
2552#endif