blob: 502944dacf69ab68e8953c5e502d63e7881bbdd1 [file] [log] [blame]
Guido van Rossumfe3f1a21994-09-29 09:42:55 +00001/***********************************************************
Guido van Rossum6d023c91995-01-04 19:12:13 +00002Copyright 1991-1995 by Stichting Mathematisch Centrum, Amsterdam,
3The Netherlands.
Guido van Rossumfe3f1a21994-09-29 09:42:55 +00004
5 All Rights Reserved
6
7Permission to use, copy, modify, and distribute this software and its
8documentation for any purpose and without fee is hereby granted,
9provided that the above copyright notice appear in all copies and that
10both that copyright notice and this permission notice appear in
11supporting documentation, and that the names of Stichting Mathematisch
Guido van Rossumd266eb41996-10-25 14:44:06 +000012Centrum or CWI or Corporation for National Research Initiatives or
13CNRI not be used in advertising or publicity pertaining to
14distribution of the software without specific, written prior
15permission.
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000016
Guido van Rossumd266eb41996-10-25 14:44:06 +000017While CWI is the initial source for this software, a modified version
18is made available by the Corporation for National Research Initiatives
19(CNRI) at the Internet address ftp://ftp.python.org.
20
21STICHTING MATHEMATISCH CENTRUM AND CNRI DISCLAIM ALL WARRANTIES WITH
22REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF
23MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL STICHTING MATHEMATISCH
24CENTRUM OR CNRI BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL
25DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
26PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
27TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
28PERFORMANCE OF THIS SOFTWARE.
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000029
30******************************************************************/
31
32/* New getargs implementation */
33
34/* XXX There are several unchecked sprintf or strcat calls in this file.
35 XXX The only way these can become a danger is if some C code in the
36 XXX Python source (or in an extension) uses ridiculously long names
37 XXX or riduculously deep nesting in format strings. */
38
Guido van Rossum79f25d91997-04-29 20:08:16 +000039#include "Python.h"
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000040
Guido van Rossumc1d50531996-08-21 23:38:24 +000041#include <ctype.h>
42
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000043
Guido van Rossum79f25d91997-04-29 20:08:16 +000044int PyArg_Parse Py_PROTO((PyObject *, char *, ...));
45int PyArg_ParseTuple Py_PROTO((PyObject *, char *, ...));
Guido van Rossum13454c31997-05-05 21:57:29 +000046int PyArg_VaParse Py_PROTO((PyObject *, char *, va_list));
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000047
Guido van Rossum79f25d91997-04-29 20:08:16 +000048int PyArg_ParseTupleAndKeywords Py_PROTO((PyObject *, PyObject *,
Guido van Rossumaa354651996-08-19 19:32:04 +000049 char *, char **, ...));
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000050
51/* Forward */
Guido van Rossum79f25d91997-04-29 20:08:16 +000052static int vgetargs1 Py_PROTO((PyObject *, char *, va_list *, int));
53static void seterror Py_PROTO((int, char *, int *, char *, char *));
54static char *convertitem Py_PROTO((PyObject *, char **, va_list *,
55 int *, char *));
56static char *converttuple Py_PROTO((PyObject *, char **, va_list *,
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000057 int *, char *, int));
Guido van Rossum79f25d91997-04-29 20:08:16 +000058static char *convertsimple Py_PROTO((PyObject *, char **, va_list *, char *));
59static char *convertsimple1 Py_PROTO((PyObject *, char **, va_list *));
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000060
Guido van Rossum79f25d91997-04-29 20:08:16 +000061static int vgetargskeywords Py_PROTO((PyObject *, PyObject *,
Guido van Rossumaa354651996-08-19 19:32:04 +000062 char *, char **, va_list *));
Guido van Rossum79f25d91997-04-29 20:08:16 +000063static char *skipitem Py_PROTO((char **, va_list *));
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000064
65#ifdef HAVE_STDARG_PROTOTYPES
66/* VARARGS2 */
Guido van Rossum79f25d91997-04-29 20:08:16 +000067int PyArg_Parse(PyObject *args, char *format, ...)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000068#else
69/* VARARGS */
Guido van Rossum79f25d91997-04-29 20:08:16 +000070int PyArg_Parse(va_alist) va_dcl
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000071#endif
72{
73 int retval;
74 va_list va;
75#ifdef HAVE_STDARG_PROTOTYPES
76
77 va_start(va, format);
78#else
Guido van Rossum79f25d91997-04-29 20:08:16 +000079 PyObject *args;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000080 char *format;
81
82 va_start(va);
Guido van Rossum79f25d91997-04-29 20:08:16 +000083 args = va_arg(va, PyObject *);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000084 format = va_arg(va, char *);
85#endif
Guido van Rossum1ae940a1995-01-02 19:04:15 +000086 retval = vgetargs1(args, format, &va, 1);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000087 va_end(va);
88 return retval;
89}
90
91
92#ifdef HAVE_STDARG_PROTOTYPES
93/* VARARGS2 */
Guido van Rossum79f25d91997-04-29 20:08:16 +000094int PyArg_ParseTuple(PyObject *args, char *format, ...)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000095#else
96/* VARARGS */
Guido van Rossum79f25d91997-04-29 20:08:16 +000097int PyArg_ParseTuple(va_alist) va_dcl
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000098#endif
99{
100 int retval;
101 va_list va;
102#ifdef HAVE_STDARG_PROTOTYPES
103
104 va_start(va, format);
105#else
Guido van Rossum79f25d91997-04-29 20:08:16 +0000106 PyObject *args;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000107 char *format;
108
109 va_start(va);
Guido van Rossum79f25d91997-04-29 20:08:16 +0000110 args = va_arg(va, PyObject *);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000111 format = va_arg(va, char *);
112#endif
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000113 retval = vgetargs1(args, format, &va, 0);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000114 va_end(va);
115 return retval;
116}
117
118
119int
Guido van Rossum13454c31997-05-05 21:57:29 +0000120PyArg_VaParse(args, format, va)
Guido van Rossum79f25d91997-04-29 20:08:16 +0000121 PyObject *args;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000122 char *format;
123 va_list va;
124{
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000125 va_list lva;
126
127#ifdef VA_LIST_IS_ARRAY
128 memcpy(lva, va, sizeof(va_list));
129#else
130 lva = va;
131#endif
132
133 return vgetargs1(args, format, &lva, 0);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000134}
135
136
137static int
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000138vgetargs1(args, format, p_va, compat)
Guido van Rossum79f25d91997-04-29 20:08:16 +0000139 PyObject *args;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000140 char *format;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000141 va_list *p_va;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000142 int compat;
143{
144 char msgbuf[256];
145 int levels[32];
146 char *fname = NULL;
147 char *message = NULL;
148 int min = -1;
149 int max = 0;
150 int level = 0;
151 char *formatsave = format;
152 int i, len;
153 char *msg;
154
155 for (;;) {
156 int c = *format++;
157 if (c == '(' /* ')' */) {
158 if (level == 0)
159 max++;
160 level++;
161 }
162 else if (/* '(' */ c == ')') {
163 if (level == 0)
Guido van Rossum79f25d91997-04-29 20:08:16 +0000164 Py_FatalError(/* '(' */
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000165 "excess ')' in getargs format");
166 else
167 level--;
168 }
169 else if (c == '\0')
170 break;
171 else if (c == ':') {
172 fname = format;
173 break;
174 }
175 else if (c == ';') {
176 message = format;
177 break;
178 }
179 else if (level != 0)
180 ; /* Pass */
181 else if (isalpha(c))
182 max++;
183 else if (c == '|')
184 min = max;
185 }
186
187 if (level != 0)
Guido van Rossum79f25d91997-04-29 20:08:16 +0000188 Py_FatalError(/* '(' */ "missing ')' in getargs format");
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000189
190 if (min < 0)
191 min = max;
192
193 format = formatsave;
194
195 if (compat) {
196 if (max == 0) {
197 if (args == NULL)
198 return 1;
199 sprintf(msgbuf, "%s requires no arguments",
200 fname==NULL ? "function" : fname);
Guido van Rossum79f25d91997-04-29 20:08:16 +0000201 PyErr_SetString(PyExc_TypeError, msgbuf);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000202 return 0;
203 }
204 else if (min == 1 && max == 1) {
Guido van Rossum13d0ed11994-11-10 22:35:48 +0000205 if (args == NULL) {
206 sprintf(msgbuf,
207 "%s requires at least one argument",
208 fname==NULL ? "function" : fname);
Guido van Rossum79f25d91997-04-29 20:08:16 +0000209 PyErr_SetString(PyExc_TypeError, msgbuf);
Guido van Rossum13d0ed11994-11-10 22:35:48 +0000210 return 0;
211 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000212 msg = convertitem(args, &format, p_va, levels, msgbuf);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000213 if (msg == NULL)
214 return 1;
215 seterror(levels[0], msg, levels+1, fname, message);
216 return 0;
217 }
218 else {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000219 PyErr_SetString(PyExc_SystemError,
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000220 "old style getargs format uses new features");
221 return 0;
222 }
223 }
224
Guido van Rossum79f25d91997-04-29 20:08:16 +0000225 if (!PyTuple_Check(args)) {
226 PyErr_SetString(PyExc_SystemError,
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000227 "new style getargs format but argument is not a tuple");
228 return 0;
229 }
230
Guido van Rossum79f25d91997-04-29 20:08:16 +0000231 len = PyTuple_Size(args);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000232
233 if (len < min || max < len) {
234 if (message == NULL) {
235 sprintf(msgbuf,
236 "%s requires %s %d argument%s; %d given",
237 fname==NULL ? "function" : fname,
238 min==max ? "exactly"
239 : len < min ? "at least" : "at most",
240 len < min ? min : max,
241 (len < min ? min : max) == 1 ? "" : "s",
242 len);
243 message = msgbuf;
244 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000245 PyErr_SetString(PyExc_TypeError, message);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000246 return 0;
247 }
248
249 for (i = 0; i < len; i++) {
250 if (*format == '|')
251 format++;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000252 msg = convertitem(PyTuple_GetItem(args, i), &format, p_va,
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000253 levels, msgbuf);
254 if (msg) {
255 seterror(i+1, msg, levels, fname, message);
256 return 0;
257 }
258 }
Guido van Rossum231a41e1997-12-09 20:36:39 +0000259
Guido van Rossum730806d1998-04-10 22:27:42 +0000260 if (*format != '\0' && !isalpha((int)(*format)) &&
Guido van Rossum7d4f68c1997-12-19 04:25:23 +0000261 *format != '(' &&
Guido van Rossum231a41e1997-12-09 20:36:39 +0000262 *format != '|' && *format != ':' && *format != ';') {
263 PyErr_Format(PyExc_SystemError,
Guido van Rossum0d6b49e1998-01-19 22:22:44 +0000264 "bad format string: %.200s", formatsave);
Guido van Rossum231a41e1997-12-09 20:36:39 +0000265 return 0;
266 }
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000267
268 return 1;
269}
270
271
272
273static void
274seterror(iarg, msg, levels, fname, message)
275 int iarg;
276 char *msg;
277 int *levels;
278 char *fname;
279 char *message;
280{
281 char buf[256];
282 int i;
283 char *p = buf;
284
Guido van Rossum79f25d91997-04-29 20:08:16 +0000285 if (PyErr_Occurred())
Guido van Rossum64fc6491995-01-21 14:09:37 +0000286 return;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000287 if (iarg == 0 && message == NULL)
288 message = msg;
289 else if (message == NULL) {
290 if (fname != NULL) {
291 sprintf(p, "%s, ", fname);
292 p += strlen(p);
293 }
294 sprintf(p, "argument %d", iarg);
295 i = 0;
296 p += strlen(p);
297 while (levels[i] > 0) {
298 sprintf(p, ", item %d", levels[i]-1);
299 p += strlen(p);
300 i++;
301 }
302 sprintf(p, ": expected %s found", msg);
303 message = buf;
304 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000305 PyErr_SetString(PyExc_TypeError, message);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000306}
307
308
309/* Convert a tuple argument.
310 On entry, *p_format points to the character _after_ the opening '('.
311 On successful exit, *p_format points to the closing ')'.
312 If successful:
313 *p_format and *p_va are updated,
314 *levels and *msgbuf are untouched,
315 and NULL is returned.
316 If the argument is invalid:
317 *p_format is unchanged,
318 *p_va is undefined,
319 *levels is a 0-terminated list of item numbers,
320 *msgbuf contains an error message, whose format is:
321 "<typename1>, <typename2>", where:
322 <typename1> is the name of the expected type, and
323 <typename2> is the name of the actual type,
324 (so you can surround it by "expected ... found"),
325 and msgbuf is returned.
326*/
327
328static char *
329converttuple(arg, p_format, p_va, levels, msgbuf, toplevel)
Guido van Rossum79f25d91997-04-29 20:08:16 +0000330 PyObject *arg;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000331 char **p_format;
332 va_list *p_va;
333 int *levels;
334 char *msgbuf;
335 int toplevel;
336{
337 int level = 0;
338 int n = 0;
339 char *format = *p_format;
340 int i;
341
342 for (;;) {
343 int c = *format++;
344 if (c == '(') {
345 if (level == 0)
346 n++;
347 level++;
348 }
349 else if (c == ')') {
350 if (level == 0)
351 break;
352 level--;
353 }
354 else if (c == ':' || c == ';' || c == '\0')
355 break;
356 else if (level == 0 && isalpha(c))
357 n++;
358 }
359
Guido van Rossum79f25d91997-04-29 20:08:16 +0000360 if (!PyTuple_Check(arg)) {
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000361 levels[0] = 0;
362 sprintf(msgbuf,
363 toplevel ? "%d arguments, %s" : "%d-tuple, %s",
Guido van Rossum79f25d91997-04-29 20:08:16 +0000364 n, arg == Py_None ? "None" : arg->ob_type->tp_name);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000365 return msgbuf;
366 }
367
Guido van Rossum79f25d91997-04-29 20:08:16 +0000368 if ((i = PyTuple_Size(arg)) != n) {
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000369 levels[0] = 0;
370 sprintf(msgbuf,
371 toplevel ? "%d arguments, %d" : "%d-tuple, %d-tuple",
372 n, i);
373 return msgbuf;
374 }
375
376 format = *p_format;
377 for (i = 0; i < n; i++) {
378 char *msg;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000379 msg = convertitem(PyTuple_GetItem(arg, i), &format, p_va,
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000380 levels+1, msgbuf);
381 if (msg != NULL) {
382 levels[0] = i+1;
383 return msg;
384 }
385 }
386
387 *p_format = format;
388 return NULL;
389}
390
391
392/* Convert a single item. */
393
394static char *
395convertitem(arg, p_format, p_va, levels, msgbuf)
Guido van Rossum79f25d91997-04-29 20:08:16 +0000396 PyObject *arg;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000397 char **p_format;
398 va_list *p_va;
399 int *levels;
400 char *msgbuf;
401{
402 char *msg;
403 char *format = *p_format;
404
405 if (*format == '(' /* ')' */) {
406 format++;
407 msg = converttuple(arg, &format, p_va, levels, msgbuf, 0);
408 if (msg == NULL)
409 format++;
410 }
411 else {
412 msg = convertsimple(arg, &format, p_va, msgbuf);
413 if (msg != NULL)
414 levels[0] = 0;
415 }
416 if (msg == NULL)
417 *p_format = format;
418 return msg;
419}
420
421
422/* Convert a non-tuple argument. Adds to convertsimple1 functionality
423 by appending ", <actual argument type>" to error message. */
424
425static char *
426convertsimple(arg, p_format, p_va, msgbuf)
Guido van Rossum79f25d91997-04-29 20:08:16 +0000427 PyObject *arg;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000428 char **p_format;
429 va_list *p_va;
430 char *msgbuf;
431{
432 char *msg = convertsimple1(arg, p_format, p_va);
433 if (msg != NULL) {
434 sprintf(msgbuf, "%.50s, %.50s", msg,
Guido van Rossum79f25d91997-04-29 20:08:16 +0000435 arg == Py_None ? "None" : arg->ob_type->tp_name);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000436 msg = msgbuf;
437 }
438 return msg;
439}
440
441
442/* Convert a non-tuple argument. Return NULL if conversion went OK,
443 or a string representing the expected type if the conversion failed.
444 When failing, an exception may or may not have been raised.
445 Don't call if a tuple is expected. */
446
447static char *
448convertsimple1(arg, p_format, p_va)
Guido van Rossum79f25d91997-04-29 20:08:16 +0000449 PyObject *arg;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000450 char **p_format;
451 va_list *p_va;
452{
453 char *format = *p_format;
454 char c = *format++;
455
456 switch (c) {
457
458 case 'b': /* byte -- very short int */
459 {
460 char *p = va_arg(*p_va, char *);
Guido van Rossum79f25d91997-04-29 20:08:16 +0000461 long ival = PyInt_AsLong(arg);
462 if (ival == -1 && PyErr_Occurred())
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000463 return "integer<b>";
464 else
Guido van Rossum6bf62da1997-04-11 20:37:35 +0000465 *p = (char) ival;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000466 break;
467 }
468
469 case 'h': /* short int */
470 {
471 short *p = va_arg(*p_va, short *);
Guido van Rossum79f25d91997-04-29 20:08:16 +0000472 long ival = PyInt_AsLong(arg);
473 if (ival == -1 && PyErr_Occurred())
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000474 return "integer<h>";
475 else
Guido van Rossum6bf62da1997-04-11 20:37:35 +0000476 *p = (short) ival;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000477 break;
478 }
479
480 case 'i': /* int */
481 {
482 int *p = va_arg(*p_va, int *);
Guido van Rossum79f25d91997-04-29 20:08:16 +0000483 long ival = PyInt_AsLong(arg);
484 if (ival == -1 && PyErr_Occurred())
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000485 return "integer<i>";
486 else
487 *p = ival;
488 break;
489 }
490
491 case 'l': /* long int */
492 {
493 long *p = va_arg(*p_va, long *);
Guido van Rossum79f25d91997-04-29 20:08:16 +0000494 long ival = PyInt_AsLong(arg);
495 if (ival == -1 && PyErr_Occurred())
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000496 return "integer<l>";
497 else
498 *p = ival;
499 break;
500 }
501
502 case 'f': /* float */
503 {
504 float *p = va_arg(*p_va, float *);
Guido van Rossum79f25d91997-04-29 20:08:16 +0000505 double dval = PyFloat_AsDouble(arg);
506 if (PyErr_Occurred())
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000507 return "float<f>";
508 else
Guido van Rossum6bf62da1997-04-11 20:37:35 +0000509 *p = (float) dval;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000510 break;
511 }
512
513 case 'd': /* double */
514 {
515 double *p = va_arg(*p_va, double *);
Guido van Rossum79f25d91997-04-29 20:08:16 +0000516 double dval = PyFloat_AsDouble(arg);
517 if (PyErr_Occurred())
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000518 return "float<d>";
519 else
520 *p = dval;
521 break;
522 }
523
Guido van Rossum530956d1996-07-21 02:27:43 +0000524#ifndef WITHOUT_COMPLEX
Guido van Rossum8a5c5d21996-01-12 01:09:56 +0000525 case 'D': /* complex double */
526 {
Guido van Rossum530956d1996-07-21 02:27:43 +0000527 Py_complex *p = va_arg(*p_va, Py_complex *);
Guido van Rossumaa354651996-08-19 19:32:04 +0000528 Py_complex cval;
529 cval = PyComplex_AsCComplex(arg);
Guido van Rossum79f25d91997-04-29 20:08:16 +0000530 if (PyErr_Occurred())
Guido van Rossum8a5c5d21996-01-12 01:09:56 +0000531 return "complex<D>";
532 else
533 *p = cval;
534 break;
535 }
Guido van Rossum530956d1996-07-21 02:27:43 +0000536#endif /* WITHOUT_COMPLEX */
Guido van Rossum8a5c5d21996-01-12 01:09:56 +0000537
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000538 case 'c': /* char */
539 {
540 char *p = va_arg(*p_va, char *);
Guido van Rossum79f25d91997-04-29 20:08:16 +0000541 if (PyString_Check(arg) && PyString_Size(arg) == 1)
542 *p = PyString_AsString(arg)[0];
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000543 else
544 return "char";
545 break;
546 }
547
548 case 's': /* string */
549 {
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000550 if (*format == '#') { /* any buffer-like object */
551 void **p = (void **)va_arg(*p_va, char **);
552 PyBufferProcs *pb = arg->ob_type->tp_as_buffer;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000553 int *q = va_arg(*p_va, int *);
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000554 int count;
555
556 if ( pb == NULL ||
557 pb->bf_getreadbuffer == NULL ||
558 pb->bf_getsegcount == NULL )
559 return "read-only buffer";
560 if ( (*pb->bf_getsegcount)(arg, NULL) != 1 )
561 return "single-segment read-only buffer";
562 if ( (count =
563 (*pb->bf_getreadbuffer)(arg, 0, p)) < 0 )
564 return "(unspecified)";
565 *q = count;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000566 format++;
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000567 } else {
568 char **p = va_arg(*p_va, char **);
569
570 if (PyString_Check(arg))
571 *p = PyString_AsString(arg);
572 else
573 return "string";
574 if ((int)strlen(*p) != PyString_Size(arg))
575 return "string without null bytes";
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000576 }
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000577 break;
578 }
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000579
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000580 case 'z': /* string, may be NULL (None) */
581 {
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000582 if (*format == '#') { /* any buffer-like object */
583 void **p = (void **)va_arg(*p_va, char **);
584 PyBufferProcs *pb = arg->ob_type->tp_as_buffer;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000585 int *q = va_arg(*p_va, int *);
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000586 int count;
587
588 if (arg == Py_None) {
589 *p = 0;
590 *q = 0;
591 } else {
592 if ( pb == NULL ||
593 pb->bf_getreadbuffer == NULL ||
594 pb->bf_getsegcount == NULL )
595 return "read-only buffer";
596 if ( (*pb->bf_getsegcount)(arg, NULL) != 1 )
597 return "single-segment read-only buffer";
598 if ( (count = (*pb->bf_getreadbuffer)
599 (arg, 0, p)) < 0 )
600 return "(unspecified)";
601 *q = count;
602 }
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000603 format++;
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000604 } else {
605 char **p = va_arg(*p_va, char **);
606
607 if (arg == Py_None)
608 *p = 0;
609 else if (PyString_Check(arg))
610 *p = PyString_AsString(arg);
611 else
612 return "None or string";
613 if (*format == '#') {
614 int *q = va_arg(*p_va, int *);
615 if (arg == Py_None)
616 *q = 0;
617 else
618 *q = PyString_Size(arg);
619 format++;
620 }
621 else if (*p != NULL &&
622 (int)strlen(*p) != PyString_Size(arg))
623 return "None or string without null bytes";
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000624 }
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000625 break;
626 }
627
628 case 'S': /* string object */
629 {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000630 PyObject **p = va_arg(*p_va, PyObject **);
631 if (PyString_Check(arg))
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000632 *p = arg;
633 else
634 return "string";
635 break;
636 }
637
638 case 'O': /* object */
639 {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000640 PyTypeObject *type;
641 PyObject **p;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000642 if (*format == '!') {
643 format++;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000644 type = va_arg(*p_va, PyTypeObject*);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000645 if (arg->ob_type != type)
646 return type->tp_name;
647 else {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000648 p = va_arg(*p_va, PyObject **);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000649 *p = arg;
650 }
651 }
652 else if (*format == '?') {
653 inquiry pred = va_arg(*p_va, inquiry);
654 format++;
655 if ((*pred)(arg)) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000656 p = va_arg(*p_va, PyObject **);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000657 *p = arg;
658 }
659 }
660 else if (*format == '&') {
Guido van Rossumaa354651996-08-19 19:32:04 +0000661 typedef int (*converter)
Guido van Rossum79f25d91997-04-29 20:08:16 +0000662 Py_PROTO((PyObject *, void *));
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000663 converter convert = va_arg(*p_va, converter);
664 void *addr = va_arg(*p_va, void *);
665 format++;
666 if (! (*convert)(arg, addr))
Guido van Rossum64fc6491995-01-21 14:09:37 +0000667 return "(unspecified)";
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000668 }
669 else {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000670 p = va_arg(*p_va, PyObject **);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000671 *p = arg;
672 }
673 break;
674 }
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000675
676
677 case 'w': /* memory buffer, read-write access */
678 {
679 void **p = va_arg(*p_va, void **);
680 PyBufferProcs *pb = arg->ob_type->tp_as_buffer;
681 int count;
682
683 if ( pb == NULL || pb->bf_getwritebuffer == NULL ||
684 pb->bf_getsegcount == NULL )
685 return "read-write buffer";
686 if ( (*pb->bf_getsegcount)(arg, NULL) != 1 )
687 return "single-segment read-write buffer";
688 if ( (count = pb->bf_getwritebuffer(arg, 0, p)) < 0 )
689 return "(unspecified)";
690 if (*format == '#') {
691 int *q = va_arg(*p_va, int *);
692
693 *q = count;
694 format++;
695 }
696 break;
697 }
698
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000699
700 default:
701 return "impossible<bad format char>";
702
703 }
704
705 *p_format = format;
706 return NULL;
707}
Guido van Rossumaa354651996-08-19 19:32:04 +0000708
709
710/* Support for keyword arguments donated by
711 Geoff Philbrick <philbric@delphi.hks.com> */
712
713#ifdef HAVE_STDARG_PROTOTYPES
714/* VARARGS2 */
Guido van Rossum79f25d91997-04-29 20:08:16 +0000715int PyArg_ParseTupleAndKeywords(PyObject *args,
716 PyObject *keywords,
Guido van Rossumaa354651996-08-19 19:32:04 +0000717 char *format,
718 char **kwlist, ...)
719#else
720/* VARARGS */
721int PyArg_ParseTupleAndKeywords(va_alist) va_dcl
722#endif
723{
724 int retval;
725 va_list va;
726#ifdef HAVE_STDARG_PROTOTYPES
727
728 va_start(va, kwlist);
729#else
Guido van Rossum79f25d91997-04-29 20:08:16 +0000730 PyObject *args;
731 PyObject *keywords;
Guido van Rossumaa354651996-08-19 19:32:04 +0000732 char *format;
733 char **kwlist;
734
735 va_start(va);
Guido van Rossum79f25d91997-04-29 20:08:16 +0000736 args = va_arg(va, PyObject *);
737 keywords = va_arg(va, PyObject *);
Guido van Rossumaa354651996-08-19 19:32:04 +0000738 format = va_arg(va, char *);
739 kwlist = va_arg(va, char **);
740#endif
741 retval = vgetargskeywords(args, keywords, format, kwlist, &va);
742 va_end(va);
743 return retval;
744}
745
746
747static int
748vgetargskeywords(args, keywords, format, kwlist, p_va)
Guido van Rossum79f25d91997-04-29 20:08:16 +0000749 PyObject *args;
750 PyObject *keywords;
Guido van Rossumaa354651996-08-19 19:32:04 +0000751 char *format;
752 char **kwlist;
753 va_list *p_va;
754{
755 char msgbuf[256];
756 int levels[32];
757 char *fname = NULL;
758 char *message = NULL;
759 int min = -1;
760 int max = 0;
Guido van Rossumaa354651996-08-19 19:32:04 +0000761 char *formatsave = format;
762 int i, len, tplen, kwlen;
763 char *msg, *ks, **p;
764 int nkwds, pos, match, converted;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000765 PyObject *key, *value;
Guido van Rossumaa354651996-08-19 19:32:04 +0000766
767 /* nested tuples cannot be parsed when using keyword arguments */
768
769 for (;;) {
770 int c = *format++;
771 if (c == '(') {
772 PyErr_SetString(PyExc_SystemError,
773 "tuple found in format when using keyword arguments");
774 return 0;
775 }
776 else if (c == '\0')
777 break;
778 else if (c == ':') {
779 fname = format;
780 break;
781 }
782 else if (c == ';') {
783 message = format;
784 break;
785 }
786 else if (isalpha(c))
787 max++;
788 else if (c == '|')
789 min = max;
790 }
791
792 if (min < 0)
793 min = max;
794
795 format = formatsave;
796
797 if (!PyTuple_Check(args)) {
798 PyErr_SetString(PyExc_SystemError,
799 "new style getargs format but argument is not a tuple");
800 return 0;
801 }
802
803 tplen = PyTuple_Size(args);
804
805 /* do a cursory check of the keywords just to see how many we got */
806
807 if (keywords) {
808 if (!PyDict_Check(keywords)) {
809 PyErr_SetString(PyExc_SystemError,
810 "non-dictionary object received when keyword dictionary expected");
811 return 0;
812 }
813 kwlen = PyDict_Size(keywords);
814 }
815 else {
816 kwlen = 0;
817 }
818
819 /* make sure there are no duplicate values for an argument;
820 its not clear when to use the term "keyword argument vs.
821 keyword parameter in messages */
822
823 if (keywords) {
824 for (i = 0; i < tplen; i++) {
825 if (PyMapping_HasKeyString(keywords, kwlist[i])) {
826 sprintf(msgbuf,
827 "keyword parameter %s redefined",
828 kwlist[i]);
829 PyErr_SetString(PyExc_TypeError, msgbuf);
830 return 0;
831 }
832 }
833 }
834 PyErr_Clear(); /* I'm not which Py functions set the error string */
835
836 /* required arguments missing from args can be supplied by keyword
837 arguments */
838
839 len = tplen;
840 if (keywords && tplen < min) {
841 for (i = tplen; i < min; i++) {
842 if (PyMapping_HasKeyString(keywords, kwlist[i])) {
843 len++;
844 }
845 }
846 }
847 PyErr_Clear();
848
849 /* make sure we got an acceptable number of arguments; the message
850 is a little confusing with keywords since keyword arguments
851 which are supplied, but don't match the required arguments
852 are not included in the "%d given" part of the message */
853
854 if (len < min || max < len) {
855 if (message == NULL) {
856 sprintf(msgbuf,
857 "%s requires %s %d argument%s; %d given",
858 fname==NULL ? "function" : fname,
859 min==max ? "exactly"
860 : len < min ? "at least" : "at most",
861 len < min ? min : max,
862 (len < min ? min : max) == 1 ? "" : "s",
863 len);
864 message = msgbuf;
865 }
866 PyErr_SetString(PyExc_TypeError, message);
867 return 0;
868 }
869
870 for (i = 0; i < tplen; i++) {
871 if (*format == '|')
872 format++;
873 msg = convertitem(PyTuple_GetItem(args, i), &format, p_va,
874 levels, msgbuf);
875 if (msg) {
876 seterror(i+1, msg, levels, fname, message);
877 return 0;
878 }
879 }
880
881 /* handle no keyword parameters in call */
882
883 if (!keywords) return 1;
884
885 /* make sure the number of keywords in the keyword list matches the
886 number of items in the format string */
887
888 nkwds = 0;
889 p = kwlist;
890 for (;;) {
891 if (!*(p++)) break;
892 nkwds++;
893 }
894
895 if (nkwds != max) {
896 PyErr_SetString(PyExc_SystemError,
897 "number of items in format string and keyword list do not match");
898 return 0;
899 }
900
901 /* convert the keyword arguments; this uses the format
902 string where it was left after processing args */
903
904 converted = 0;
905 for (i = tplen; i < nkwds; i++) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000906 PyObject *item;
Guido van Rossumaa354651996-08-19 19:32:04 +0000907 if (*format == '|')
908 format++;
Guido van Rossum80bb9651996-12-05 23:27:02 +0000909 item = PyMapping_GetItemString(keywords, kwlist[i]);
910 if (item != NULL) {
Guido van Rossumaa354651996-08-19 19:32:04 +0000911 msg = convertitem(item, &format, p_va, levels, msgbuf);
912 if (msg) {
913 seterror(i+1, msg, levels, fname, message);
914 return 0;
915 }
916 converted++;
917 }
918 else {
919 PyErr_Clear();
920 msg = skipitem(&format, p_va);
921 if (msg) {
922 seterror(i+1, msg, levels, fname, message);
923 return 0;
924 }
925 }
926 }
927
928 /* make sure there are no extraneous keyword arguments */
929
930 pos = 0;
931 if (converted < kwlen) {
932 while (PyDict_Next(keywords, &pos, &key, &value)) {
933 match = 0;
934 ks = PyString_AsString(key);
935 for (i = 0; i < nkwds; i++) {
936 if (!strcmp(ks, kwlist[i])) {
937 match = 1;
938 break;
939 }
940 }
941 if (!match) {
942 sprintf(msgbuf,
943 "%s is an invalid keyword argument for this function",
944 ks);
945 PyErr_SetString(PyExc_TypeError, msgbuf);
946 return 0;
947 }
948 }
949 }
950
951 return 1;
952}
953
954
955static char *
956skipitem(p_format, p_va)
957 char **p_format;
958 va_list *p_va;
959{
960 char *format = *p_format;
961 char c = *format++;
962
963 switch (c) {
964
965 case 'b': /* byte -- very short int */
966 {
Guido van Rossum80bb9651996-12-05 23:27:02 +0000967 (void) va_arg(*p_va, char *);
Guido van Rossumaa354651996-08-19 19:32:04 +0000968 break;
969 }
970
971 case 'h': /* short int */
972 {
Guido van Rossum80bb9651996-12-05 23:27:02 +0000973 (void) va_arg(*p_va, short *);
Guido van Rossumaa354651996-08-19 19:32:04 +0000974 break;
975 }
976
977 case 'i': /* int */
978 {
Guido van Rossum80bb9651996-12-05 23:27:02 +0000979 (void) va_arg(*p_va, int *);
Guido van Rossumaa354651996-08-19 19:32:04 +0000980 break;
981 }
982
983 case 'l': /* long int */
984 {
Guido van Rossum80bb9651996-12-05 23:27:02 +0000985 (void) va_arg(*p_va, long *);
Guido van Rossumaa354651996-08-19 19:32:04 +0000986 break;
987 }
988
989 case 'f': /* float */
990 {
Guido van Rossum80bb9651996-12-05 23:27:02 +0000991 (void) va_arg(*p_va, float *);
Guido van Rossumaa354651996-08-19 19:32:04 +0000992 break;
993 }
994
995 case 'd': /* double */
996 {
Guido van Rossum80bb9651996-12-05 23:27:02 +0000997 (void) va_arg(*p_va, double *);
Guido van Rossumaa354651996-08-19 19:32:04 +0000998 break;
999 }
1000
1001#ifndef WITHOUT_COMPLEX
1002 case 'D': /* complex double */
1003 {
Guido van Rossum80bb9651996-12-05 23:27:02 +00001004 (void) va_arg(*p_va, Py_complex *);
Guido van Rossumaa354651996-08-19 19:32:04 +00001005 break;
1006 }
1007#endif /* WITHOUT_COMPLEX */
1008
1009 case 'c': /* char */
1010 {
Guido van Rossum80bb9651996-12-05 23:27:02 +00001011 (void) va_arg(*p_va, char *);
Guido van Rossumaa354651996-08-19 19:32:04 +00001012 break;
1013 }
1014
1015 case 's': /* string */
1016 {
Guido van Rossum80bb9651996-12-05 23:27:02 +00001017 (void) va_arg(*p_va, char **);
Guido van Rossumaa354651996-08-19 19:32:04 +00001018 if (*format == '#') {
Guido van Rossum80bb9651996-12-05 23:27:02 +00001019 (void) va_arg(*p_va, int *);
Guido van Rossumaa354651996-08-19 19:32:04 +00001020 format++;
1021 }
1022 break;
1023 }
1024
1025 case 'z': /* string */
1026 {
Guido van Rossum80bb9651996-12-05 23:27:02 +00001027 (void) va_arg(*p_va, char **);
Guido van Rossumaa354651996-08-19 19:32:04 +00001028 if (*format == '#') {
Guido van Rossum80bb9651996-12-05 23:27:02 +00001029 (void) va_arg(*p_va, int *);
Guido van Rossumaa354651996-08-19 19:32:04 +00001030 format++;
1031 }
1032 break;
1033 }
1034
1035 case 'S': /* string object */
1036 {
Guido van Rossum79f25d91997-04-29 20:08:16 +00001037 (void) va_arg(*p_va, PyObject **);
Guido van Rossumaa354651996-08-19 19:32:04 +00001038 break;
1039 }
1040
1041 case 'O': /* object */
1042 {
Guido van Rossumaa354651996-08-19 19:32:04 +00001043 if (*format == '!') {
1044 format++;
Guido van Rossum79f25d91997-04-29 20:08:16 +00001045 (void) va_arg(*p_va, PyTypeObject*);
1046 (void) va_arg(*p_va, PyObject **);
Guido van Rossumaa354651996-08-19 19:32:04 +00001047 }
1048#if 0
1049/* I don't know what this is for */
1050 else if (*format == '?') {
1051 inquiry pred = va_arg(*p_va, inquiry);
1052 format++;
1053 if ((*pred)(arg)) {
Guido van Rossum79f25d91997-04-29 20:08:16 +00001054 (void) va_arg(*p_va, PyObject **);
Guido van Rossumaa354651996-08-19 19:32:04 +00001055 }
1056 }
1057#endif
1058 else if (*format == '&') {
1059 typedef int (*converter)
Guido van Rossum79f25d91997-04-29 20:08:16 +00001060 Py_PROTO((PyObject *, void *));
Guido van Rossum80bb9651996-12-05 23:27:02 +00001061 (void) va_arg(*p_va, converter);
1062 (void) va_arg(*p_va, void *);
Guido van Rossumaa354651996-08-19 19:32:04 +00001063 format++;
1064 }
1065 else {
Guido van Rossum79f25d91997-04-29 20:08:16 +00001066 (void) va_arg(*p_va, PyObject **);
Guido van Rossumaa354651996-08-19 19:32:04 +00001067 }
1068 break;
1069 }
1070
1071 default:
1072 return "impossible<bad format char>";
1073
1074 }
1075
1076 *p_format = format;
1077 return NULL;
1078}