blob: 5908e6beba656740529c8cb0a9ba7a1c65ecb979 [file] [log] [blame]
Guido van Rossumfe3f1a21994-09-29 09:42:55 +00001
2/* New getargs implementation */
3
Guido van Rossum79f25d91997-04-29 20:08:16 +00004#include "Python.h"
Guido van Rossumfe3f1a21994-09-29 09:42:55 +00005
Guido van Rossumc1d50531996-08-21 23:38:24 +00006#include <ctype.h>
7
Guido van Rossumfe3f1a21994-09-29 09:42:55 +00008
Anthony Baxter97300382006-04-12 04:38:54 +00009#ifdef __cplusplus
10extern "C" {
11#endif
Jeremy Hyltonaf68c872005-12-10 18:50:16 +000012int PyArg_Parse(PyObject *, const char *, ...);
13int PyArg_ParseTuple(PyObject *, const char *, ...);
14int PyArg_VaParse(PyObject *, const char *, va_list);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000015
Tim Petersdbd9ba62000-07-09 03:09:57 +000016int PyArg_ParseTupleAndKeywords(PyObject *, PyObject *,
Martin v. Löwis15e62742006-02-27 16:46:16 +000017 const char *, char **, ...);
Brett Cannon711e7d92004-07-10 22:20:32 +000018int PyArg_VaParseTupleAndKeywords(PyObject *, PyObject *,
Martin v. Löwis15e62742006-02-27 16:46:16 +000019 const char *, char **, va_list);
Brett Cannon711e7d92004-07-10 22:20:32 +000020
Martin v. Löwis18e16552006-02-15 17:27:45 +000021#define FLAG_COMPAT 1
22#define FLAG_SIZE_T 2
23
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000024
25/* Forward */
Jeremy Hyltonaf68c872005-12-10 18:50:16 +000026static int vgetargs1(PyObject *, const char *, va_list *, int);
27static void seterror(int, const char *, int *, const char *, const char *);
Martin v. Löwis18e16552006-02-15 17:27:45 +000028static char *convertitem(PyObject *, const char **, va_list *, int, int *,
29 char *, size_t, PyObject **);
30static char *converttuple(PyObject *, const char **, va_list *, int,
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +000031 int *, char *, size_t, int, PyObject **);
Martin v. Löwis18e16552006-02-15 17:27:45 +000032static char *convertsimple(PyObject *, const char **, va_list *, int, char *,
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +000033 size_t, PyObject **);
Martin v. Löwis18e16552006-02-15 17:27:45 +000034static Py_ssize_t convertbuffer(PyObject *, void **p, char **);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000035
Tim Petersdbd9ba62000-07-09 03:09:57 +000036static int vgetargskeywords(PyObject *, PyObject *,
Martin v. Löwis15e62742006-02-27 16:46:16 +000037 const char *, char **, va_list *, int);
Martin v. Löwis18e16552006-02-15 17:27:45 +000038static char *skipitem(const char **, va_list *, int);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000039
Fred Drake563dfc22001-10-23 14:41:08 +000040int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +000041PyArg_Parse(PyObject *args, const char *format, ...)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000042{
43 int retval;
44 va_list va;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000045
46 va_start(va, format);
Martin v. Löwis18e16552006-02-15 17:27:45 +000047 retval = vgetargs1(args, format, &va, FLAG_COMPAT);
48 va_end(va);
49 return retval;
50}
51
52int
53_PyArg_Parse_SizeT(PyObject *args, char *format, ...)
54{
55 int retval;
56 va_list va;
57
58 va_start(va, format);
59 retval = vgetargs1(args, format, &va, FLAG_COMPAT|FLAG_SIZE_T);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000060 va_end(va);
61 return retval;
62}
63
64
Fred Drake563dfc22001-10-23 14:41:08 +000065int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +000066PyArg_ParseTuple(PyObject *args, const char *format, ...)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000067{
68 int retval;
69 va_list va;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000070
71 va_start(va, format);
Guido van Rossum1ae940a1995-01-02 19:04:15 +000072 retval = vgetargs1(args, format, &va, 0);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000073 va_end(va);
74 return retval;
75}
76
Martin v. Löwis18e16552006-02-15 17:27:45 +000077int
78_PyArg_ParseTuple_SizeT(PyObject *args, char *format, ...)
79{
80 int retval;
81 va_list va;
82
83 va_start(va, format);
84 retval = vgetargs1(args, format, &va, FLAG_SIZE_T);
85 va_end(va);
86 return retval;
87}
88
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000089
90int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +000091PyArg_VaParse(PyObject *args, const char *format, va_list va)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000092{
Guido van Rossum1ae940a1995-01-02 19:04:15 +000093 va_list lva;
94
95#ifdef VA_LIST_IS_ARRAY
96 memcpy(lva, va, sizeof(va_list));
97#else
Martin v. Löwis75d2d942002-07-28 10:23:27 +000098#ifdef __va_copy
99 __va_copy(lva, va);
100#else
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000101 lva = va;
102#endif
Martin v. Löwis75d2d942002-07-28 10:23:27 +0000103#endif
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000104
105 return vgetargs1(args, format, &lva, 0);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000106}
107
Martin v. Löwis18e16552006-02-15 17:27:45 +0000108int
109_PyArg_VaParse_SizeT(PyObject *args, char *format, va_list va)
110{
111 va_list lva;
112
113#ifdef VA_LIST_IS_ARRAY
114 memcpy(lva, va, sizeof(va_list));
115#else
116#ifdef __va_copy
117 __va_copy(lva, va);
118#else
119 lva = va;
120#endif
121#endif
122
123 return vgetargs1(args, format, &lva, FLAG_SIZE_T);
124}
125
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000126
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000127/* Handle cleanup of allocated memory in case of exception */
128
129static int
130addcleanup(void *ptr, PyObject **freelist)
131{
132 PyObject *cobj;
133 if (!*freelist) {
134 *freelist = PyList_New(0);
135 if (!*freelist) {
136 PyMem_FREE(ptr);
137 return -1;
138 }
139 }
140 cobj = PyCObject_FromVoidPtr(ptr, NULL);
141 if (!cobj) {
142 PyMem_FREE(ptr);
143 return -1;
144 }
145 if(PyList_Append(*freelist, cobj)) {
146 PyMem_FREE(ptr);
147 Py_DECREF(cobj);
148 return -1;
149 }
150 Py_DECREF(cobj);
151 return 0;
152}
153
154static int
155cleanreturn(int retval, PyObject *freelist)
156{
157 if(freelist) {
158 if((retval) == 0) {
Martin v. Löwisd96ee902006-02-16 14:37:16 +0000159 Py_ssize_t len = PyList_GET_SIZE(freelist), i;
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000160 for (i = 0; i < len; i++)
161 PyMem_FREE(PyCObject_AsVoidPtr(
162 PyList_GET_ITEM(freelist, i)));
163 }
164 Py_DECREF(freelist);
165 }
166 return retval;
167}
168
169
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000170static int
Martin v. Löwis18e16552006-02-15 17:27:45 +0000171vgetargs1(PyObject *args, const char *format, va_list *p_va, int flags)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000172{
173 char msgbuf[256];
174 int levels[32];
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000175 const char *fname = NULL;
176 const char *message = NULL;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000177 int min = -1;
178 int max = 0;
179 int level = 0;
Jeremy Hylton25916bd2001-05-29 17:46:19 +0000180 int endfmt = 0;
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000181 const char *formatsave = format;
Martin v. Löwisd96ee902006-02-16 14:37:16 +0000182 Py_ssize_t i, len;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000183 char *msg;
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000184 PyObject *freelist = NULL;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000185 int compat = flags & FLAG_COMPAT;
186
Tim Peters5c4d5bf2001-02-12 22:13:26 +0000187 assert(compat || (args != (PyObject*)NULL));
Martin v. Löwis18e16552006-02-15 17:27:45 +0000188 flags = flags & ~FLAG_COMPAT;
Tim Peters5c4d5bf2001-02-12 22:13:26 +0000189
Jeremy Hylton25916bd2001-05-29 17:46:19 +0000190 while (endfmt == 0) {
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000191 int c = *format++;
Jeremy Hylton25916bd2001-05-29 17:46:19 +0000192 switch (c) {
193 case '(':
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000194 if (level == 0)
195 max++;
196 level++;
Jeremy Hylton25916bd2001-05-29 17:46:19 +0000197 break;
198 case ')':
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000199 if (level == 0)
Jeremy Hylton25916bd2001-05-29 17:46:19 +0000200 Py_FatalError("excess ')' in getargs format");
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000201 else
202 level--;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000203 break;
Jeremy Hylton25916bd2001-05-29 17:46:19 +0000204 case '\0':
205 endfmt = 1;
206 break;
207 case ':':
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000208 fname = format;
Jeremy Hylton25916bd2001-05-29 17:46:19 +0000209 endfmt = 1;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000210 break;
Jeremy Hylton25916bd2001-05-29 17:46:19 +0000211 case ';':
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000212 message = format;
Jeremy Hylton25916bd2001-05-29 17:46:19 +0000213 endfmt = 1;
214 break;
215 default:
216 if (level == 0) {
217 if (c == 'O')
218 max++;
Neal Norwitz30b5c5d2005-12-19 06:05:18 +0000219 else if (isalpha(Py_CHARMASK(c))) {
Jeremy Hylton25916bd2001-05-29 17:46:19 +0000220 if (c != 'e') /* skip encoded */
221 max++;
222 } else if (c == '|')
223 min = max;
224 }
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000225 break;
226 }
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000227 }
228
229 if (level != 0)
Guido van Rossum79f25d91997-04-29 20:08:16 +0000230 Py_FatalError(/* '(' */ "missing ')' in getargs format");
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000231
232 if (min < 0)
233 min = max;
234
235 format = formatsave;
236
237 if (compat) {
238 if (max == 0) {
239 if (args == NULL)
240 return 1;
Jeremy Hylton23ae9872001-11-28 20:29:22 +0000241 PyOS_snprintf(msgbuf, sizeof(msgbuf),
242 "%.200s%s takes no arguments",
243 fname==NULL ? "function" : fname,
244 fname==NULL ? "" : "()");
Guido van Rossum79f25d91997-04-29 20:08:16 +0000245 PyErr_SetString(PyExc_TypeError, msgbuf);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000246 return 0;
247 }
248 else if (min == 1 && max == 1) {
Guido van Rossum13d0ed11994-11-10 22:35:48 +0000249 if (args == NULL) {
Jeremy Hylton23ae9872001-11-28 20:29:22 +0000250 PyOS_snprintf(msgbuf, sizeof(msgbuf),
251 "%.200s%s takes at least one argument",
252 fname==NULL ? "function" : fname,
253 fname==NULL ? "" : "()");
Guido van Rossum79f25d91997-04-29 20:08:16 +0000254 PyErr_SetString(PyExc_TypeError, msgbuf);
Guido van Rossum13d0ed11994-11-10 22:35:48 +0000255 return 0;
256 }
Martin v. Löwis18e16552006-02-15 17:27:45 +0000257 msg = convertitem(args, &format, p_va, flags, levels,
258 msgbuf, sizeof(msgbuf), &freelist);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000259 if (msg == NULL)
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000260 return cleanreturn(1, freelist);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000261 seterror(levels[0], msg, levels+1, fname, message);
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000262 return cleanreturn(0, freelist);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000263 }
264 else {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000265 PyErr_SetString(PyExc_SystemError,
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000266 "old style getargs format uses new features");
267 return 0;
268 }
269 }
270
Guido van Rossum79f25d91997-04-29 20:08:16 +0000271 if (!PyTuple_Check(args)) {
272 PyErr_SetString(PyExc_SystemError,
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000273 "new style getargs format but argument is not a tuple");
274 return 0;
275 }
276
Jeremy Hylton0f8117f2001-05-18 20:57:38 +0000277 len = PyTuple_GET_SIZE(args);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000278
279 if (len < min || max < len) {
280 if (message == NULL) {
Jeremy Hylton23ae9872001-11-28 20:29:22 +0000281 PyOS_snprintf(msgbuf, sizeof(msgbuf),
282 "%.150s%s takes %s %d argument%s "
Neal Norwitz20dd93f2006-02-19 19:34:15 +0000283 "(%ld given)",
Jeremy Hylton23ae9872001-11-28 20:29:22 +0000284 fname==NULL ? "function" : fname,
285 fname==NULL ? "" : "()",
286 min==max ? "exactly"
287 : len < min ? "at least" : "at most",
288 len < min ? min : max,
289 (len < min ? min : max) == 1 ? "" : "s",
Neal Norwitz9a276172006-02-20 18:57:39 +0000290 Py_SAFE_DOWNCAST(len, Py_ssize_t, long));
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000291 message = msgbuf;
292 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000293 PyErr_SetString(PyExc_TypeError, message);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000294 return 0;
295 }
296
297 for (i = 0; i < len; i++) {
298 if (*format == '|')
299 format++;
Jeremy Hylton0f8117f2001-05-18 20:57:38 +0000300 msg = convertitem(PyTuple_GET_ITEM(args, i), &format, p_va,
Martin v. Löwis18e16552006-02-15 17:27:45 +0000301 flags, levels, msgbuf,
302 sizeof(msgbuf), &freelist);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000303 if (msg) {
304 seterror(i+1, msg, levels, fname, message);
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000305 return cleanreturn(0, freelist);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000306 }
307 }
Guido van Rossum231a41e1997-12-09 20:36:39 +0000308
Neal Norwitz4ac13df2005-12-19 06:10:07 +0000309 if (*format != '\0' && !isalpha(Py_CHARMASK(*format)) &&
Guido van Rossum7d4f68c1997-12-19 04:25:23 +0000310 *format != '(' &&
Guido van Rossum231a41e1997-12-09 20:36:39 +0000311 *format != '|' && *format != ':' && *format != ';') {
312 PyErr_Format(PyExc_SystemError,
Guido van Rossum0d6b49e1998-01-19 22:22:44 +0000313 "bad format string: %.200s", formatsave);
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000314 return cleanreturn(0, freelist);
Guido van Rossum231a41e1997-12-09 20:36:39 +0000315 }
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000316
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000317 return cleanreturn(1, freelist);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000318}
319
320
321
322static void
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000323seterror(int iarg, const char *msg, int *levels, const char *fname,
324 const char *message)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000325{
Marc-André Lemburgd4c0a9c2001-11-28 11:47:00 +0000326 char buf[512];
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000327 int i;
328 char *p = buf;
329
Guido van Rossum79f25d91997-04-29 20:08:16 +0000330 if (PyErr_Occurred())
Guido van Rossum64fc6491995-01-21 14:09:37 +0000331 return;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000332 else if (message == NULL) {
333 if (fname != NULL) {
Jeremy Hyltonf16e05e2001-11-28 21:46:59 +0000334 PyOS_snprintf(p, sizeof(buf), "%.200s() ", fname);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000335 p += strlen(p);
336 }
Ka-Ping Yee20579702001-01-15 22:14:16 +0000337 if (iarg != 0) {
Tim Petersfaad5ad2001-12-03 00:43:33 +0000338 PyOS_snprintf(p, sizeof(buf) - (p - buf),
Jeremy Hyltonf16e05e2001-11-28 21:46:59 +0000339 "argument %d", iarg);
Ka-Ping Yee20579702001-01-15 22:14:16 +0000340 i = 0;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000341 p += strlen(p);
Marc-André Lemburgd4c0a9c2001-11-28 11:47:00 +0000342 while (levels[i] > 0 && (int)(p-buf) < 220) {
Jeremy Hyltonf16e05e2001-11-28 21:46:59 +0000343 PyOS_snprintf(p, sizeof(buf) - (buf - p),
344 ", item %d", levels[i]-1);
Ka-Ping Yee20579702001-01-15 22:14:16 +0000345 p += strlen(p);
346 i++;
347 }
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000348 }
Ka-Ping Yee20579702001-01-15 22:14:16 +0000349 else {
Tim Petersfaad5ad2001-12-03 00:43:33 +0000350 PyOS_snprintf(p, sizeof(buf) - (p - buf), "argument");
Ka-Ping Yee20579702001-01-15 22:14:16 +0000351 p += strlen(p);
352 }
Tim Petersfaad5ad2001-12-03 00:43:33 +0000353 PyOS_snprintf(p, sizeof(buf) - (p - buf), " %.256s", msg);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000354 message = buf;
355 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000356 PyErr_SetString(PyExc_TypeError, message);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000357}
358
359
360/* Convert a tuple argument.
361 On entry, *p_format points to the character _after_ the opening '('.
362 On successful exit, *p_format points to the closing ')'.
363 If successful:
364 *p_format and *p_va are updated,
365 *levels and *msgbuf are untouched,
366 and NULL is returned.
367 If the argument is invalid:
368 *p_format is unchanged,
369 *p_va is undefined,
370 *levels is a 0-terminated list of item numbers,
371 *msgbuf contains an error message, whose format is:
Ka-Ping Yee20579702001-01-15 22:14:16 +0000372 "must be <typename1>, not <typename2>", where:
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000373 <typename1> is the name of the expected type, and
374 <typename2> is the name of the actual type,
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000375 and msgbuf is returned.
376*/
377
378static char *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000379converttuple(PyObject *arg, const char **p_format, va_list *p_va, int flags,
380 int *levels, char *msgbuf, size_t bufsize, int toplevel,
381 PyObject **freelist)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000382{
383 int level = 0;
384 int n = 0;
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000385 const char *format = *p_format;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000386 int i;
387
388 for (;;) {
389 int c = *format++;
390 if (c == '(') {
391 if (level == 0)
392 n++;
393 level++;
394 }
395 else if (c == ')') {
396 if (level == 0)
397 break;
398 level--;
399 }
400 else if (c == ':' || c == ';' || c == '\0')
401 break;
Neal Norwitz30b5c5d2005-12-19 06:05:18 +0000402 else if (level == 0 && isalpha(Py_CHARMASK(c)))
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000403 n++;
404 }
405
Ka-Ping Yee20579702001-01-15 22:14:16 +0000406 if (!PySequence_Check(arg) || PyString_Check(arg)) {
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000407 levels[0] = 0;
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000408 PyOS_snprintf(msgbuf, bufsize,
Jeremy Hylton23ae9872001-11-28 20:29:22 +0000409 toplevel ? "expected %d arguments, not %.50s" :
410 "must be %d-item sequence, not %.50s",
411 n,
412 arg == Py_None ? "None" : arg->ob_type->tp_name);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000413 return msgbuf;
414 }
415
Jeremy Hylton03657cf2000-07-12 13:05:33 +0000416 if ((i = PySequence_Size(arg)) != n) {
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000417 levels[0] = 0;
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000418 PyOS_snprintf(msgbuf, bufsize,
Jeremy Hylton23ae9872001-11-28 20:29:22 +0000419 toplevel ? "expected %d arguments, not %d" :
420 "must be sequence of length %d, not %d",
421 n, i);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000422 return msgbuf;
423 }
Ka-Ping Yee20579702001-01-15 22:14:16 +0000424
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000425 format = *p_format;
426 for (i = 0; i < n; i++) {
427 char *msg;
Guido van Rossum66368cc1999-02-17 23:16:43 +0000428 PyObject *item;
429 item = PySequence_GetItem(arg, i);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000430 msg = convertitem(item, &format, p_va, flags, levels+1,
431 msgbuf, bufsize, freelist);
Guido van Rossum66368cc1999-02-17 23:16:43 +0000432 /* PySequence_GetItem calls tp->sq_item, which INCREFs */
433 Py_XDECREF(item);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000434 if (msg != NULL) {
435 levels[0] = i+1;
436 return msg;
437 }
438 }
Ka-Ping Yee20579702001-01-15 22:14:16 +0000439
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000440 *p_format = format;
441 return NULL;
442}
443
444
445/* Convert a single item. */
446
447static char *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000448convertitem(PyObject *arg, const char **p_format, va_list *p_va, int flags,
449 int *levels, char *msgbuf, size_t bufsize, PyObject **freelist)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000450{
451 char *msg;
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000452 const char *format = *p_format;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000453
454 if (*format == '(' /* ')' */) {
455 format++;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000456 msg = converttuple(arg, &format, p_va, flags, levels, msgbuf,
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000457 bufsize, 0, freelist);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000458 if (msg == NULL)
459 format++;
460 }
461 else {
Martin v. Löwis18e16552006-02-15 17:27:45 +0000462 msg = convertsimple(arg, &format, p_va, flags,
463 msgbuf, bufsize, freelist);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000464 if (msg != NULL)
465 levels[0] = 0;
466 }
467 if (msg == NULL)
468 *p_format = format;
469 return msg;
470}
471
472
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000473
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000474#define UNICODE_DEFAULT_ENCODING(arg) \
475 _PyUnicode_AsDefaultEncodedString(arg, NULL)
476
477/* Format an error message generated by convertsimple(). */
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000478
479static char *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000480converterr(const char *expected, PyObject *arg, char *msgbuf, size_t bufsize)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000481{
Jeremy Hylton77b8b672001-09-10 01:54:43 +0000482 assert(expected != NULL);
483 assert(arg != NULL);
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000484 PyOS_snprintf(msgbuf, bufsize,
485 "must be %.50s, not %.50s", expected,
486 arg == Py_None ? "None" : arg->ob_type->tp_name);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000487 return msgbuf;
488}
489
490#define CONV_UNICODE "(unicode conversion error)"
491
Neil Schemenauer5042da62003-02-04 20:59:40 +0000492/* explicitly check for float arguments when integers are expected. For now
493 * signal a warning. Returns true if an exception was raised. */
494static int
495float_argument_error(PyObject *arg)
496{
497 if (PyFloat_Check(arg) &&
498 PyErr_Warn(PyExc_DeprecationWarning,
499 "integer argument expected, got float" ))
500 return 1;
501 else
502 return 0;
503}
504
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000505/* Convert a non-tuple argument. Return NULL if conversion went OK,
506 or a string with a message describing the failure. The message is
507 formatted as "must be <desired type>, not <actual type>".
508 When failing, an exception may or may not have been raised.
Georg Brandl6dd14612005-09-14 19:29:53 +0000509 Don't call if a tuple is expected.
510
511 When you add new format codes, please don't forget poor skipitem() below.
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000512*/
513
514static char *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000515convertsimple(PyObject *arg, const char **p_format, va_list *p_va, int flags,
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000516 char *msgbuf, size_t bufsize, PyObject **freelist)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000517{
Martin v. Löwis18e16552006-02-15 17:27:45 +0000518 /* For # codes */
519#define FETCH_SIZE int *q=NULL;Py_ssize_t *q2=NULL;\
520 if (flags & FLAG_SIZE_T) q2=va_arg(*p_va, Py_ssize_t*); \
521 else q=va_arg(*p_va, int*);
522#define STORE_SIZE(s) if (flags & FLAG_SIZE_T) *q2=s; else *q=s;
523#define BUFFER_LEN ((flags & FLAG_SIZE_T) ? *q2:*q)
524
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000525 const char *format = *p_format;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000526 char c = *format++;
Walter Dörwalddffda2e2002-11-21 20:23:11 +0000527#ifdef Py_USING_UNICODE
Jeremy Hylton77b8b672001-09-10 01:54:43 +0000528 PyObject *uarg;
Walter Dörwalddffda2e2002-11-21 20:23:11 +0000529#endif
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000530
531 switch (c) {
532
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000533 case 'b': { /* unsigned byte -- very short int */
534 char *p = va_arg(*p_va, char *);
Neil Schemenauerb808e992003-01-24 22:15:21 +0000535 long ival;
Neil Schemenauer5042da62003-02-04 20:59:40 +0000536 if (float_argument_error(arg))
Michael W. Hudson34553382004-08-07 17:57:16 +0000537 return converterr("integer<b>", arg, msgbuf, bufsize);
Neil Schemenauerb808e992003-01-24 22:15:21 +0000538 ival = PyInt_AsLong(arg);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000539 if (ival == -1 && PyErr_Occurred())
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000540 return converterr("integer<b>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000541 else if (ival < 0) {
542 PyErr_SetString(PyExc_OverflowError,
543 "unsigned byte integer is less than minimum");
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000544 return converterr("integer<b>", arg, msgbuf, bufsize);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000545 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000546 else if (ival > UCHAR_MAX) {
547 PyErr_SetString(PyExc_OverflowError,
548 "unsigned byte integer is greater than maximum");
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000549 return converterr("integer<b>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000550 }
551 else
552 *p = (unsigned char) ival;
553 break;
554 }
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000555
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000556 case 'B': {/* byte sized bitfield - both signed and unsigned
557 values allowed */
558 char *p = va_arg(*p_va, char *);
Neil Schemenauerb808e992003-01-24 22:15:21 +0000559 long ival;
Neil Schemenauer5042da62003-02-04 20:59:40 +0000560 if (float_argument_error(arg))
Michael W. Hudson34553382004-08-07 17:57:16 +0000561 return converterr("integer<B>", arg, msgbuf, bufsize);
Thomas Hellera4ea6032003-04-17 18:55:45 +0000562 ival = PyInt_AsUnsignedLongMask(arg);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000563 if (ival == -1 && PyErr_Occurred())
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000564 return converterr("integer<B>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000565 else
566 *p = (unsigned char) ival;
567 break;
568 }
Jack Jansencc22fbe2000-08-05 21:29:58 +0000569
Guido van Rossumfce26e72003-04-18 00:12:30 +0000570 case 'h': {/* signed short int */
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000571 short *p = va_arg(*p_va, short *);
Neil Schemenauerb808e992003-01-24 22:15:21 +0000572 long ival;
Neil Schemenauer5042da62003-02-04 20:59:40 +0000573 if (float_argument_error(arg))
Michael W. Hudson34553382004-08-07 17:57:16 +0000574 return converterr("integer<h>", arg, msgbuf, bufsize);
Neil Schemenauerb808e992003-01-24 22:15:21 +0000575 ival = PyInt_AsLong(arg);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000576 if (ival == -1 && PyErr_Occurred())
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000577 return converterr("integer<h>", arg, msgbuf, bufsize);
Guido van Rossumfce26e72003-04-18 00:12:30 +0000578 else if (ival < SHRT_MIN) {
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000579 PyErr_SetString(PyExc_OverflowError,
Guido van Rossumfce26e72003-04-18 00:12:30 +0000580 "signed short integer is less than minimum");
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000581 return converterr("integer<h>", arg, msgbuf, bufsize);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000582 }
Guido van Rossumfce26e72003-04-18 00:12:30 +0000583 else if (ival > SHRT_MAX) {
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000584 PyErr_SetString(PyExc_OverflowError,
Guido van Rossumfce26e72003-04-18 00:12:30 +0000585 "signed short integer is greater than maximum");
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000586 return converterr("integer<h>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000587 }
588 else
589 *p = (short) ival;
590 break;
591 }
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000592
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000593 case 'H': { /* short int sized bitfield, both signed and
594 unsigned allowed */
595 unsigned short *p = va_arg(*p_va, unsigned short *);
Neil Schemenauerb808e992003-01-24 22:15:21 +0000596 long ival;
Neil Schemenauer5042da62003-02-04 20:59:40 +0000597 if (float_argument_error(arg))
Michael W. Hudson34553382004-08-07 17:57:16 +0000598 return converterr("integer<H>", arg, msgbuf, bufsize);
Thomas Hellera4ea6032003-04-17 18:55:45 +0000599 ival = PyInt_AsUnsignedLongMask(arg);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000600 if (ival == -1 && PyErr_Occurred())
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000601 return converterr("integer<H>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000602 else
603 *p = (unsigned short) ival;
604 break;
605 }
Martin v. Löwis18e16552006-02-15 17:27:45 +0000606
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000607 case 'i': {/* signed int */
608 int *p = va_arg(*p_va, int *);
Neil Schemenauerb808e992003-01-24 22:15:21 +0000609 long ival;
Neil Schemenauer5042da62003-02-04 20:59:40 +0000610 if (float_argument_error(arg))
Michael W. Hudson34553382004-08-07 17:57:16 +0000611 return converterr("integer<i>", arg, msgbuf, bufsize);
Neil Schemenauerb808e992003-01-24 22:15:21 +0000612 ival = PyInt_AsLong(arg);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000613 if (ival == -1 && PyErr_Occurred())
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000614 return converterr("integer<i>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000615 else if (ival > INT_MAX) {
616 PyErr_SetString(PyExc_OverflowError,
617 "signed integer is greater than maximum");
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000618 return converterr("integer<i>", arg, msgbuf, bufsize);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000619 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000620 else if (ival < INT_MIN) {
621 PyErr_SetString(PyExc_OverflowError,
622 "signed integer is less than minimum");
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000623 return converterr("integer<i>", arg, msgbuf, bufsize);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000624 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000625 else
626 *p = ival;
627 break;
628 }
629
Thomas Hellera4ea6032003-04-17 18:55:45 +0000630 case 'I': { /* int sized bitfield, both signed and
631 unsigned allowed */
632 unsigned int *p = va_arg(*p_va, unsigned int *);
633 unsigned int ival;
634 if (float_argument_error(arg))
Michael W. Hudson34553382004-08-07 17:57:16 +0000635 return converterr("integer<I>", arg, msgbuf, bufsize);
Thomas Hellera4ea6032003-04-17 18:55:45 +0000636 ival = PyInt_AsUnsignedLongMask(arg);
637 if (ival == -1 && PyErr_Occurred())
638 return converterr("integer<I>", arg, msgbuf, bufsize);
639 else
640 *p = ival;
641 break;
642 }
643
Martin v. Löwis18e16552006-02-15 17:27:45 +0000644 case 'n': /* Py_ssize_t */
645#if SIZEOF_SIZE_T != SIZEOF_LONG
646 {
647 Py_ssize_t *p = va_arg(*p_va, Py_ssize_t *);
648 Py_ssize_t ival;
649 if (float_argument_error(arg))
Georg Brandl7f573f72006-04-13 07:59:30 +0000650 return converterr("integer<n>", arg, msgbuf, bufsize);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000651 ival = PyInt_AsSsize_t(arg);
652 if (ival == -1 && PyErr_Occurred())
Georg Brandl7f573f72006-04-13 07:59:30 +0000653 return converterr("integer<n>", arg, msgbuf, bufsize);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000654 *p = ival;
655 break;
656 }
657#endif
658 /* Fall through from 'n' to 'l' if Py_ssize_t is int */
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000659 case 'l': {/* long int */
660 long *p = va_arg(*p_va, long *);
Neil Schemenauerb808e992003-01-24 22:15:21 +0000661 long ival;
Neil Schemenauer5042da62003-02-04 20:59:40 +0000662 if (float_argument_error(arg))
Michael W. Hudson34553382004-08-07 17:57:16 +0000663 return converterr("integer<l>", arg, msgbuf, bufsize);
Neil Schemenauerb808e992003-01-24 22:15:21 +0000664 ival = PyInt_AsLong(arg);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000665 if (ival == -1 && PyErr_Occurred())
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000666 return converterr("integer<l>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000667 else
668 *p = ival;
669 break;
670 }
Thomas Hellera4ea6032003-04-17 18:55:45 +0000671
672 case 'k': { /* long sized bitfield */
673 unsigned long *p = va_arg(*p_va, unsigned long *);
674 unsigned long ival;
675 if (PyInt_Check(arg))
676 ival = PyInt_AsUnsignedLongMask(arg);
677 else if (PyLong_Check(arg))
678 ival = PyLong_AsUnsignedLongMask(arg);
679 else
680 return converterr("integer<k>", arg, msgbuf, bufsize);
681 *p = ival;
682 break;
683 }
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000684
Guido van Rossum3dbba6e1999-01-25 21:48:56 +0000685#ifdef HAVE_LONG_LONG
Martin v. Löwisb9a0f912003-03-29 10:06:18 +0000686 case 'L': {/* PY_LONG_LONG */
687 PY_LONG_LONG *p = va_arg( *p_va, PY_LONG_LONG * );
688 PY_LONG_LONG ival = PyLong_AsLongLong( arg );
689 if( ival == (PY_LONG_LONG)-1 && PyErr_Occurred() ) {
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000690 return converterr("long<L>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000691 } else {
692 *p = ival;
Guido van Rossum1a8791e1998-08-04 22:46:29 +0000693 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000694 break;
695 }
Thomas Hellera4ea6032003-04-17 18:55:45 +0000696
697 case 'K': { /* long long sized bitfield */
698 unsigned PY_LONG_LONG *p = va_arg(*p_va, unsigned PY_LONG_LONG *);
699 unsigned PY_LONG_LONG ival;
Thomas Hellera4ea6032003-04-17 18:55:45 +0000700 if (PyInt_Check(arg))
701 ival = PyInt_AsUnsignedLongMask(arg);
702 else if (PyLong_Check(arg))
703 ival = PyLong_AsUnsignedLongLongMask(arg);
704 else
705 return converterr("integer<K>", arg, msgbuf, bufsize);
706 *p = ival;
707 break;
708 }
Guido van Rossum1a8791e1998-08-04 22:46:29 +0000709#endif
710
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000711 case 'f': {/* float */
712 float *p = va_arg(*p_va, float *);
713 double dval = PyFloat_AsDouble(arg);
714 if (PyErr_Occurred())
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000715 return converterr("float<f>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000716 else
717 *p = (float) dval;
718 break;
719 }
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000720
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000721 case 'd': {/* double */
722 double *p = va_arg(*p_va, double *);
723 double dval = PyFloat_AsDouble(arg);
724 if (PyErr_Occurred())
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000725 return converterr("float<d>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000726 else
727 *p = dval;
728 break;
729 }
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000730
Guido van Rossum530956d1996-07-21 02:27:43 +0000731#ifndef WITHOUT_COMPLEX
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000732 case 'D': {/* complex double */
733 Py_complex *p = va_arg(*p_va, Py_complex *);
734 Py_complex cval;
735 cval = PyComplex_AsCComplex(arg);
736 if (PyErr_Occurred())
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000737 return converterr("complex<D>", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000738 else
739 *p = cval;
740 break;
741 }
Guido van Rossum530956d1996-07-21 02:27:43 +0000742#endif /* WITHOUT_COMPLEX */
Guido van Rossum8a5c5d21996-01-12 01:09:56 +0000743
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000744 case 'c': {/* char */
745 char *p = va_arg(*p_va, char *);
746 if (PyString_Check(arg) && PyString_Size(arg) == 1)
Jeremy Hylton0407aea2001-10-10 02:51:57 +0000747 *p = PyString_AS_STRING(arg)[0];
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000748 else
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000749 return converterr("char", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000750 break;
751 }
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000752
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000753 case 's': {/* string */
754 if (*format == '#') {
755 void **p = (void **)va_arg(*p_va, char **);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000756 FETCH_SIZE;
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000757
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000758 if (PyString_Check(arg)) {
759 *p = PyString_AS_STRING(arg);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000760 STORE_SIZE(PyString_GET_SIZE(arg));
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000761 }
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000762#ifdef Py_USING_UNICODE
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000763 else if (PyUnicode_Check(arg)) {
Jeremy Hylton77b8b672001-09-10 01:54:43 +0000764 uarg = UNICODE_DEFAULT_ENCODING(arg);
765 if (uarg == NULL)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000766 return converterr(CONV_UNICODE,
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000767 arg, msgbuf, bufsize);
Jeremy Hylton77b8b672001-09-10 01:54:43 +0000768 *p = PyString_AS_STRING(uarg);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000769 STORE_SIZE(PyString_GET_SIZE(uarg));
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000770 }
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000771#endif
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000772 else { /* any buffer-like object */
773 char *buf;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000774 Py_ssize_t count = convertbuffer(arg, p, &buf);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000775 if (count < 0)
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000776 return converterr(buf, arg, msgbuf, bufsize);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000777 STORE_SIZE(count);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000778 }
Guido van Rossumd8855fd2000-03-24 22:14:19 +0000779 format++;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000780 } else {
781 char **p = va_arg(*p_va, char **);
Guido van Rossumd8855fd2000-03-24 22:14:19 +0000782
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000783 if (PyString_Check(arg))
784 *p = PyString_AS_STRING(arg);
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000785#ifdef Py_USING_UNICODE
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000786 else if (PyUnicode_Check(arg)) {
Jeremy Hylton77b8b672001-09-10 01:54:43 +0000787 uarg = UNICODE_DEFAULT_ENCODING(arg);
788 if (uarg == NULL)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000789 return converterr(CONV_UNICODE,
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000790 arg, msgbuf, bufsize);
Jeremy Hylton77b8b672001-09-10 01:54:43 +0000791 *p = PyString_AS_STRING(uarg);
Marc-André Lemburg6f15e572001-05-02 17:16:16 +0000792 }
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000793#endif
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000794 else
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000795 return converterr("string", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000796 if ((int)strlen(*p) != PyString_Size(arg))
797 return converterr("string without null bytes",
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000798 arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000799 }
800 break;
801 }
802
803 case 'z': {/* string, may be NULL (None) */
804 if (*format == '#') { /* any buffer-like object */
805 void **p = (void **)va_arg(*p_va, char **);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000806 FETCH_SIZE;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000807
808 if (arg == Py_None) {
809 *p = 0;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000810 STORE_SIZE(0);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000811 }
812 else if (PyString_Check(arg)) {
813 *p = PyString_AS_STRING(arg);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000814 STORE_SIZE(PyString_GET_SIZE(arg));
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000815 }
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000816#ifdef Py_USING_UNICODE
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000817 else if (PyUnicode_Check(arg)) {
Jeremy Hylton77b8b672001-09-10 01:54:43 +0000818 uarg = UNICODE_DEFAULT_ENCODING(arg);
819 if (uarg == NULL)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000820 return converterr(CONV_UNICODE,
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000821 arg, msgbuf, bufsize);
Jeremy Hylton77b8b672001-09-10 01:54:43 +0000822 *p = PyString_AS_STRING(uarg);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000823 STORE_SIZE(PyString_GET_SIZE(uarg));
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000824 }
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000825#endif
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000826 else { /* any buffer-like object */
827 char *buf;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000828 Py_ssize_t count = convertbuffer(arg, p, &buf);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000829 if (count < 0)
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000830 return converterr(buf, arg, msgbuf, bufsize);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000831 STORE_SIZE(count);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000832 }
833 format++;
834 } else {
835 char **p = va_arg(*p_va, char **);
836
837 if (arg == Py_None)
838 *p = 0;
839 else if (PyString_Check(arg))
Jeremy Hyltona4c8cd72001-10-10 02:51:08 +0000840 *p = PyString_AS_STRING(arg);
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000841#ifdef Py_USING_UNICODE
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000842 else if (PyUnicode_Check(arg)) {
Jeremy Hylton77b8b672001-09-10 01:54:43 +0000843 uarg = UNICODE_DEFAULT_ENCODING(arg);
844 if (uarg == NULL)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000845 return converterr(CONV_UNICODE,
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000846 arg, msgbuf, bufsize);
Jeremy Hylton77b8b672001-09-10 01:54:43 +0000847 *p = PyString_AS_STRING(uarg);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000848 }
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000849#endif
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000850 else
851 return converterr("string or None",
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000852 arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000853 if (*format == '#') {
Martin v. Löwis18e16552006-02-15 17:27:45 +0000854 FETCH_SIZE;
Thomas Woutersc3547a32006-03-01 21:31:21 +0000855 assert(0); /* XXX redundant with if-case */
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000856 if (arg == Py_None)
857 *q = 0;
858 else
859 *q = PyString_Size(arg);
860 format++;
861 }
862 else if (*p != NULL &&
863 (int)strlen(*p) != PyString_Size(arg))
864 return converterr(
865 "string without null bytes or None",
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000866 arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000867 }
868 break;
869 }
870
871 case 'e': {/* encoded string */
872 char **buffer;
873 const char *encoding;
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000874 PyObject *s;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000875 int size, recode_strings;
876
877 /* Get 'e' parameter: the encoding name */
878 encoding = (const char *)va_arg(*p_va, const char *);
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000879#ifdef Py_USING_UNICODE
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000880 if (encoding == NULL)
881 encoding = PyUnicode_GetDefaultEncoding();
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000882#endif
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000883
884 /* Get output buffer parameter:
885 's' (recode all objects via Unicode) or
886 't' (only recode non-string objects)
887 */
888 if (*format == 's')
889 recode_strings = 1;
890 else if (*format == 't')
891 recode_strings = 0;
892 else
893 return converterr(
894 "(unknown parser marker combination)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000895 arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000896 buffer = (char **)va_arg(*p_va, char **);
897 format++;
898 if (buffer == NULL)
899 return converterr("(buffer is NULL)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000900 arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000901
902 /* Encode object */
903 if (!recode_strings && PyString_Check(arg)) {
904 s = arg;
905 Py_INCREF(s);
906 }
907 else {
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000908#ifdef Py_USING_UNICODE
909 PyObject *u;
910
Guido van Rossumd8855fd2000-03-24 22:14:19 +0000911 /* Convert object to Unicode */
912 u = PyUnicode_FromObject(arg);
913 if (u == NULL)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000914 return converterr(
915 "string or unicode or text buffer",
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000916 arg, msgbuf, bufsize);
Guido van Rossumd8855fd2000-03-24 22:14:19 +0000917
918 /* Encode object; use default error handling */
919 s = PyUnicode_AsEncodedString(u,
920 encoding,
921 NULL);
922 Py_DECREF(u);
923 if (s == NULL)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000924 return converterr("(encoding failed)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000925 arg, msgbuf, bufsize);
Guido van Rossumd8855fd2000-03-24 22:14:19 +0000926 if (!PyString_Check(s)) {
927 Py_DECREF(s);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000928 return converterr(
929 "(encoder failed to return a string)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000930 arg, msgbuf, bufsize);
Guido van Rossumd8855fd2000-03-24 22:14:19 +0000931 }
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000932#else
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000933 return converterr("string<e>", arg, msgbuf, bufsize);
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000934#endif
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000935 }
936 size = PyString_GET_SIZE(s);
Guido van Rossumd8855fd2000-03-24 22:14:19 +0000937
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000938 /* Write output; output is guaranteed to be 0-terminated */
939 if (*format == '#') {
940 /* Using buffer length parameter '#':
941
942 - if *buffer is NULL, a new buffer of the
943 needed size is allocated and the data
944 copied into it; *buffer is updated to point
945 to the new buffer; the caller is
946 responsible for PyMem_Free()ing it after
947 usage
Guido van Rossumd8855fd2000-03-24 22:14:19 +0000948
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000949 - if *buffer is not NULL, the data is
950 copied to *buffer; *buffer_len has to be
951 set to the size of the buffer on input;
952 buffer overflow is signalled with an error;
953 buffer has to provide enough room for the
954 encoded string plus the trailing 0-byte
955
956 - in both cases, *buffer_len is updated to
957 the size of the buffer /excluding/ the
958 trailing 0-byte
959
960 */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000961 FETCH_SIZE;
Guido van Rossumd8855fd2000-03-24 22:14:19 +0000962
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000963 format++;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000964 if (q == NULL && q2 == NULL) {
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000965 Py_DECREF(s);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000966 return converterr(
967 "(buffer_len is NULL)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000968 arg, msgbuf, bufsize);
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000969 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000970 if (*buffer == NULL) {
Guido van Rossumd8855fd2000-03-24 22:14:19 +0000971 *buffer = PyMem_NEW(char, size + 1);
972 if (*buffer == NULL) {
973 Py_DECREF(s);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000974 return converterr(
975 "(memory error)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000976 arg, msgbuf, bufsize);
Guido van Rossumd8855fd2000-03-24 22:14:19 +0000977 }
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000978 if(addcleanup(*buffer, freelist)) {
979 Py_DECREF(s);
980 return converterr(
981 "(cleanup problem)",
982 arg, msgbuf, bufsize);
983 }
Fred Drake25871c02000-05-03 15:17:02 +0000984 } else {
Martin v. Löwis18e16552006-02-15 17:27:45 +0000985 if (size + 1 > BUFFER_LEN) {
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000986 Py_DECREF(s);
987 return converterr(
988 "(buffer overflow)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +0000989 arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000990 }
Fred Drake25871c02000-05-03 15:17:02 +0000991 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000992 memcpy(*buffer,
993 PyString_AS_STRING(s),
994 size + 1);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000995 STORE_SIZE(size);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000996 } else {
997 /* Using a 0-terminated buffer:
998
999 - the encoded string has to be 0-terminated
1000 for this variant to work; if it is not, an
1001 error raised
Fred Drake25871c02000-05-03 15:17:02 +00001002
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001003 - a new buffer of the needed size is
1004 allocated and the data copied into it;
1005 *buffer is updated to point to the new
1006 buffer; the caller is responsible for
1007 PyMem_Free()ing it after usage
1008
1009 */
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001010 if ((int)strlen(PyString_AS_STRING(s)) != size) {
1011 Py_DECREF(s);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001012 return converterr(
1013 "(encoded string without NULL bytes)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001014 arg, msgbuf, bufsize);
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001015 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001016 *buffer = PyMem_NEW(char, size + 1);
1017 if (*buffer == NULL) {
1018 Py_DECREF(s);
1019 return converterr("(memory error)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001020 arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001021 }
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001022 if(addcleanup(*buffer, freelist)) {
1023 Py_DECREF(s);
1024 return converterr("(cleanup problem)",
1025 arg, msgbuf, bufsize);
1026 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001027 memcpy(*buffer,
1028 PyString_AS_STRING(s),
1029 size + 1);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +00001030 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001031 Py_DECREF(s);
1032 break;
1033 }
1034
Martin v. Löwis339d0f72001-08-17 18:39:25 +00001035#ifdef Py_USING_UNICODE
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001036 case 'u': {/* raw unicode buffer (Py_UNICODE *) */
1037 if (*format == '#') { /* any buffer-like object */
1038 void **p = (void **)va_arg(*p_va, char **);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001039 FETCH_SIZE;
Marc-André Lemburg3e3eacb2002-01-09 16:21:27 +00001040 if (PyUnicode_Check(arg)) {
1041 *p = PyUnicode_AS_UNICODE(arg);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001042 STORE_SIZE(PyUnicode_GET_SIZE(arg));
Marc-André Lemburg3e3eacb2002-01-09 16:21:27 +00001043 }
1044 else {
Neal Norwitz61546162006-04-14 05:20:28 +00001045 return converterr("cannot convert raw buffers",
1046 arg, msgbuf, bufsize);
Marc-André Lemburg3e3eacb2002-01-09 16:21:27 +00001047 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001048 format++;
1049 } else {
1050 Py_UNICODE **p = va_arg(*p_va, Py_UNICODE **);
Guido van Rossume826ef02000-03-10 23:02:17 +00001051 if (PyUnicode_Check(arg))
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001052 *p = PyUnicode_AS_UNICODE(arg);
1053 else
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001054 return converterr("unicode", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001055 }
1056 break;
1057 }
Martin v. Löwis339d0f72001-08-17 18:39:25 +00001058#endif
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001059
1060 case 'S': { /* string object */
1061 PyObject **p = va_arg(*p_va, PyObject **);
1062 if (PyString_Check(arg))
1063 *p = arg;
1064 else
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001065 return converterr("string", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001066 break;
1067 }
1068
Martin v. Löwis339d0f72001-08-17 18:39:25 +00001069#ifdef Py_USING_UNICODE
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001070 case 'U': { /* Unicode object */
1071 PyObject **p = va_arg(*p_va, PyObject **);
1072 if (PyUnicode_Check(arg))
1073 *p = arg;
1074 else
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001075 return converterr("unicode", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001076 break;
1077 }
Martin v. Löwis339d0f72001-08-17 18:39:25 +00001078#endif
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001079
1080 case 'O': { /* object */
1081 PyTypeObject *type;
1082 PyObject **p;
1083 if (*format == '!') {
1084 type = va_arg(*p_va, PyTypeObject*);
1085 p = va_arg(*p_va, PyObject **);
1086 format++;
Guido van Rossumcbfc8552001-08-28 16:37:51 +00001087 if (PyType_IsSubtype(arg->ob_type, type))
Guido van Rossume826ef02000-03-10 23:02:17 +00001088 *p = arg;
1089 else
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001090 return converterr(type->tp_name, arg, msgbuf, bufsize);
Guido van Rossumfccfe891998-05-15 22:04:07 +00001091
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001092 }
1093 else if (*format == '?') {
1094 inquiry pred = va_arg(*p_va, inquiry);
1095 p = va_arg(*p_va, PyObject **);
1096 format++;
1097 if ((*pred)(arg))
Guido van Rossumfe3f1a21994-09-29 09:42:55 +00001098 *p = arg;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001099 else
1100 return converterr("(unspecified)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001101 arg, msgbuf, bufsize);
Guido van Rossumfdf95dd1997-05-05 22:15:02 +00001102
Guido van Rossumfdf95dd1997-05-05 22:15:02 +00001103 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001104 else if (*format == '&') {
1105 typedef int (*converter)(PyObject *, void *);
1106 converter convert = va_arg(*p_va, converter);
1107 void *addr = va_arg(*p_va, void *);
1108 format++;
1109 if (! (*convert)(arg, addr))
1110 return converterr("(unspecified)",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001111 arg, msgbuf, bufsize);
Guido van Rossumb317f8a1998-10-08 02:21:21 +00001112 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001113 else {
1114 p = va_arg(*p_va, PyObject **);
1115 *p = arg;
1116 }
1117 break;
1118 }
Guido van Rossumb317f8a1998-10-08 02:21:21 +00001119
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001120
1121 case 'w': { /* memory buffer, read-write access */
1122 void **p = va_arg(*p_va, void **);
1123 PyBufferProcs *pb = arg->ob_type->tp_as_buffer;
1124 int count;
1125
1126 if (pb == NULL ||
1127 pb->bf_getwritebuffer == NULL ||
1128 pb->bf_getsegcount == NULL)
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001129 return converterr("read-write buffer", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001130 if ((*pb->bf_getsegcount)(arg, NULL) != 1)
1131 return converterr("single-segment read-write buffer",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001132 arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001133 if ((count = pb->bf_getwritebuffer(arg, 0, p)) < 0)
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001134 return converterr("(unspecified)", arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001135 if (*format == '#') {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001136 FETCH_SIZE;
1137 STORE_SIZE(count);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001138 format++;
1139 }
1140 break;
1141 }
1142
1143 case 't': { /* 8-bit character buffer, read-only access */
Martin v. Löwis15e62742006-02-27 16:46:16 +00001144 char **p = va_arg(*p_va, char **);
Jeremy Hylton4819e972001-10-11 14:40:37 +00001145 PyBufferProcs *pb = arg->ob_type->tp_as_buffer;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001146 int count;
1147
1148 if (*format++ != '#')
1149 return converterr(
1150 "invalid use of 't' format character",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001151 arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001152 if (!PyType_HasFeature(arg->ob_type,
Jeremy Hylton4819e972001-10-11 14:40:37 +00001153 Py_TPFLAGS_HAVE_GETCHARBUFFER) ||
1154 pb == NULL || pb->bf_getcharbuffer == NULL ||
1155 pb->bf_getsegcount == NULL)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001156 return converterr(
1157 "string or read-only character buffer",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001158 arg, msgbuf, bufsize);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001159
Jeremy Hylton4819e972001-10-11 14:40:37 +00001160 if (pb->bf_getsegcount(arg, NULL) != 1)
1161 return converterr(
1162 "string or single-segment read-only buffer",
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001163 arg, msgbuf, bufsize);
Jeremy Hylton4819e972001-10-11 14:40:37 +00001164
1165 count = pb->bf_getcharbuffer(arg, 0, p);
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001166 if (count < 0)
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001167 return converterr("(unspecified)", arg, msgbuf, bufsize);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001168 {
1169 FETCH_SIZE;
1170 STORE_SIZE(count);
1171 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001172 break;
1173 }
1174
Guido van Rossumfe3f1a21994-09-29 09:42:55 +00001175 default:
Jeremy Hyltonb048b262001-11-28 22:14:37 +00001176 return converterr("impossible<bad format char>", arg, msgbuf, bufsize);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +00001177
1178 }
1179
1180 *p_format = format;
1181 return NULL;
1182}
Guido van Rossumaa354651996-08-19 19:32:04 +00001183
Martin v. Löwis18e16552006-02-15 17:27:45 +00001184static Py_ssize_t
Fred Drake563dfc22001-10-23 14:41:08 +00001185convertbuffer(PyObject *arg, void **p, char **errmsg)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001186{
1187 PyBufferProcs *pb = arg->ob_type->tp_as_buffer;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001188 Py_ssize_t count;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001189 if (pb == NULL ||
1190 pb->bf_getreadbuffer == NULL ||
1191 pb->bf_getsegcount == NULL) {
1192 *errmsg = "string or read-only buffer";
1193 return -1;
1194 }
1195 if ((*pb->bf_getsegcount)(arg, NULL) != 1) {
1196 *errmsg = "string or single-segment read-only buffer";
1197 return -1;
1198 }
1199 if ((count = (*pb->bf_getreadbuffer)(arg, 0, p)) < 0) {
1200 *errmsg = "(unspecified)";
1201 }
1202 return count;
1203}
Guido van Rossumaa354651996-08-19 19:32:04 +00001204
1205/* Support for keyword arguments donated by
1206 Geoff Philbrick <philbric@delphi.hks.com> */
1207
Tim Petersf8cd3e82001-10-27 04:26:57 +00001208/* Return false (0) for error, else true. */
Fred Drake563dfc22001-10-23 14:41:08 +00001209int
1210PyArg_ParseTupleAndKeywords(PyObject *args,
1211 PyObject *keywords,
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001212 const char *format,
Martin v. Löwis15e62742006-02-27 16:46:16 +00001213 char **kwlist, ...)
Guido van Rossumaa354651996-08-19 19:32:04 +00001214{
1215 int retval;
1216 va_list va;
Tim Peters45772cd2001-10-27 03:58:40 +00001217
1218 if ((args == NULL || !PyTuple_Check(args)) ||
1219 (keywords != NULL && !PyDict_Check(keywords)) ||
1220 format == NULL ||
1221 kwlist == NULL)
1222 {
1223 PyErr_BadInternalCall();
Tim Petersf8cd3e82001-10-27 04:26:57 +00001224 return 0;
Tim Peters45772cd2001-10-27 03:58:40 +00001225 }
1226
Guido van Rossumaa354651996-08-19 19:32:04 +00001227 va_start(va, kwlist);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001228 retval = vgetargskeywords(args, keywords, format, kwlist, &va, 0);
1229 va_end(va);
1230 return retval;
1231}
1232
1233int
1234_PyArg_ParseTupleAndKeywords_SizeT(PyObject *args,
1235 PyObject *keywords,
1236 const char *format,
Martin v. Löwis15e62742006-02-27 16:46:16 +00001237 char **kwlist, ...)
Martin v. Löwis18e16552006-02-15 17:27:45 +00001238{
1239 int retval;
1240 va_list va;
1241
1242 if ((args == NULL || !PyTuple_Check(args)) ||
1243 (keywords != NULL && !PyDict_Check(keywords)) ||
1244 format == NULL ||
1245 kwlist == NULL)
1246 {
1247 PyErr_BadInternalCall();
1248 return 0;
1249 }
1250
1251 va_start(va, kwlist);
1252 retval = vgetargskeywords(args, keywords, format,
1253 kwlist, &va, FLAG_SIZE_T);
Guido van Rossumaa354651996-08-19 19:32:04 +00001254 va_end(va);
1255 return retval;
1256}
1257
1258
Brett Cannon711e7d92004-07-10 22:20:32 +00001259int
1260PyArg_VaParseTupleAndKeywords(PyObject *args,
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001261 PyObject *keywords,
1262 const char *format,
Martin v. Löwis15e62742006-02-27 16:46:16 +00001263 char **kwlist, va_list va)
Brett Cannon711e7d92004-07-10 22:20:32 +00001264{
1265 int retval;
1266 va_list lva;
1267
1268 if ((args == NULL || !PyTuple_Check(args)) ||
1269 (keywords != NULL && !PyDict_Check(keywords)) ||
1270 format == NULL ||
1271 kwlist == NULL)
1272 {
1273 PyErr_BadInternalCall();
1274 return 0;
1275 }
1276
1277#ifdef VA_LIST_IS_ARRAY
1278 memcpy(lva, va, sizeof(va_list));
1279#else
1280#ifdef __va_copy
1281 __va_copy(lva, va);
1282#else
1283 lva = va;
1284#endif
1285#endif
1286
Martin v. Löwis18e16552006-02-15 17:27:45 +00001287 retval = vgetargskeywords(args, keywords, format, kwlist, &lva, 0);
1288 return retval;
1289}
1290
1291int
1292_PyArg_VaParseTupleAndKeywords_SizeT(PyObject *args,
1293 PyObject *keywords,
1294 const char *format,
Martin v. Löwis15e62742006-02-27 16:46:16 +00001295 char **kwlist, va_list va)
Martin v. Löwis18e16552006-02-15 17:27:45 +00001296{
1297 int retval;
1298 va_list lva;
1299
1300 if ((args == NULL || !PyTuple_Check(args)) ||
1301 (keywords != NULL && !PyDict_Check(keywords)) ||
1302 format == NULL ||
1303 kwlist == NULL)
1304 {
1305 PyErr_BadInternalCall();
1306 return 0;
1307 }
1308
1309#ifdef VA_LIST_IS_ARRAY
1310 memcpy(lva, va, sizeof(va_list));
1311#else
1312#ifdef __va_copy
1313 __va_copy(lva, va);
1314#else
1315 lva = va;
1316#endif
1317#endif
1318
1319 retval = vgetargskeywords(args, keywords, format,
1320 kwlist, &lva, FLAG_SIZE_T);
Brett Cannon711e7d92004-07-10 22:20:32 +00001321 return retval;
1322}
1323
1324
Guido van Rossumaa354651996-08-19 19:32:04 +00001325static int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001326vgetargskeywords(PyObject *args, PyObject *keywords, const char *format,
Martin v. Löwis15e62742006-02-27 16:46:16 +00001327 char **kwlist, va_list *p_va, int flags)
Guido van Rossumaa354651996-08-19 19:32:04 +00001328{
Tim Petersdc5eff92001-10-27 06:53:00 +00001329 char msgbuf[512];
Guido van Rossumaa354651996-08-19 19:32:04 +00001330 int levels[32];
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001331 const char *fname, *message;
Tim Petersf8cd3e82001-10-27 04:26:57 +00001332 int min, max;
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001333 const char *formatsave;
Tim Petersb639d492001-10-27 07:00:56 +00001334 int i, len, nargs, nkeywords;
Martin v. Löwis15e62742006-02-27 16:46:16 +00001335 const char *msg;
1336 char **p;
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001337 PyObject *freelist = NULL;
Tim Petersf4331c12001-10-27 00:17:34 +00001338
Tim Peters45772cd2001-10-27 03:58:40 +00001339 assert(args != NULL && PyTuple_Check(args));
1340 assert(keywords == NULL || PyDict_Check(keywords));
1341 assert(format != NULL);
1342 assert(kwlist != NULL);
1343 assert(p_va != NULL);
1344
Tim Petersf8cd3e82001-10-27 04:26:57 +00001345 /* Search the format:
1346 message <- error msg, if any (else NULL).
Tim Peterscffed4b2001-11-29 03:26:37 +00001347 fname <- routine name, if any (else NULL).
Tim Petersf8cd3e82001-10-27 04:26:57 +00001348 min <- # of required arguments, or -1 if all are required.
1349 max <- most arguments (required + optional).
Tim Peters62d48e12001-10-27 06:42:16 +00001350 Check that kwlist has a non-NULL entry for each arg.
Tim Petersf8cd3e82001-10-27 04:26:57 +00001351 Raise error if a tuple arg spec is found.
1352 */
1353 fname = message = NULL;
Tim Peters6fb26352001-10-27 04:38:11 +00001354 formatsave = format;
Tim Peters62d48e12001-10-27 06:42:16 +00001355 p = kwlist;
Tim Petersf8cd3e82001-10-27 04:26:57 +00001356 min = -1;
1357 max = 0;
1358 while ((i = *format++) != '\0') {
Neal Norwitz30b5c5d2005-12-19 06:05:18 +00001359 if (isalpha(Py_CHARMASK(i)) && i != 'e') {
Tim Petersf8cd3e82001-10-27 04:26:57 +00001360 max++;
Tim Peters62d48e12001-10-27 06:42:16 +00001361 if (*p == NULL) {
Tim Peterscffed4b2001-11-29 03:26:37 +00001362 PyErr_SetString(PyExc_RuntimeError,
1363 "more argument specifiers than "
1364 "keyword list entries");
Tim Peters62d48e12001-10-27 06:42:16 +00001365 return 0;
1366 }
1367 p++;
1368 }
Tim Petersf8cd3e82001-10-27 04:26:57 +00001369 else if (i == '|')
1370 min = max;
1371 else if (i == ':') {
1372 fname = format;
1373 break;
1374 }
1375 else if (i == ';') {
1376 message = format;
1377 break;
1378 }
1379 else if (i == '(') {
Tim Peterscffed4b2001-11-29 03:26:37 +00001380 PyErr_SetString(PyExc_RuntimeError,
1381 "tuple found in format when using keyword "
1382 "arguments");
Guido van Rossumaa354651996-08-19 19:32:04 +00001383 return 0;
1384 }
Tim Peters62d48e12001-10-27 06:42:16 +00001385 }
1386 format = formatsave;
1387 if (*p != NULL) {
Tim Peterscffed4b2001-11-29 03:26:37 +00001388 PyErr_SetString(PyExc_RuntimeError,
1389 "more keyword list entries than "
1390 "argument specifiers");
Tim Peters62d48e12001-10-27 06:42:16 +00001391 return 0;
1392 }
Tim Petersf8cd3e82001-10-27 04:26:57 +00001393 if (min < 0) {
1394 /* All arguments are required. */
Guido van Rossumaa354651996-08-19 19:32:04 +00001395 min = max;
Tim Petersf8cd3e82001-10-27 04:26:57 +00001396 }
Tim Petersf8cd3e82001-10-27 04:26:57 +00001397
Tim Peters6fb26352001-10-27 04:38:11 +00001398 nargs = PyTuple_GET_SIZE(args);
Tim Petersb0872fc2001-10-27 04:45:34 +00001399 nkeywords = keywords == NULL ? 0 : PyDict_Size(keywords);
Tim Petersf8cd3e82001-10-27 04:26:57 +00001400
Guido van Rossumaa354651996-08-19 19:32:04 +00001401 /* make sure there are no duplicate values for an argument;
1402 its not clear when to use the term "keyword argument vs.
1403 keyword parameter in messages */
Tim Petersb054be42001-10-27 05:07:41 +00001404 if (nkeywords > 0) {
Tim Peters6fb26352001-10-27 04:38:11 +00001405 for (i = 0; i < nargs; i++) {
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001406 const char *thiskw = kwlist[i];
Tim Petersa9f47392001-10-27 00:46:09 +00001407 if (thiskw == NULL)
1408 break;
Tim Peters077f5742001-10-27 05:50:39 +00001409 if (PyDict_GetItemString(keywords, thiskw)) {
Tim Petersb054be42001-10-27 05:07:41 +00001410 PyErr_Format(PyExc_TypeError,
1411 "keyword parameter '%s' was given "
1412 "by position and by name",
Tim Petersa9f47392001-10-27 00:46:09 +00001413 thiskw);
Guido van Rossumaa354651996-08-19 19:32:04 +00001414 return 0;
1415 }
Tim Peters0af49162001-10-27 06:14:32 +00001416 else if (PyErr_Occurred())
1417 return 0;
Guido van Rossumaa354651996-08-19 19:32:04 +00001418 }
1419 }
Tim Peters61dde632001-10-27 05:30:17 +00001420
Guido van Rossumaa354651996-08-19 19:32:04 +00001421 /* required arguments missing from args can be supplied by keyword
Georg Brandld7048172006-01-20 17:53:27 +00001422 arguments; set len to the number of positional arguments, and,
Tim Peters62d48e12001-10-27 06:42:16 +00001423 if that's less than the minimum required, add in the number of
1424 required arguments that are supplied by keywords */
Tim Peters6fb26352001-10-27 04:38:11 +00001425 len = nargs;
Tim Peters62d48e12001-10-27 06:42:16 +00001426 if (nkeywords > 0 && nargs < min) {
Tim Peters6fb26352001-10-27 04:38:11 +00001427 for (i = nargs; i < min; i++) {
Tim Peters077f5742001-10-27 05:50:39 +00001428 if (PyDict_GetItemString(keywords, kwlist[i]))
Guido van Rossumaa354651996-08-19 19:32:04 +00001429 len++;
Tim Peters0af49162001-10-27 06:14:32 +00001430 else if (PyErr_Occurred())
1431 return 0;
Guido van Rossumaa354651996-08-19 19:32:04 +00001432 }
1433 }
Tim Peters0af49162001-10-27 06:14:32 +00001434
Guido van Rossumaa354651996-08-19 19:32:04 +00001435 /* make sure we got an acceptable number of arguments; the message
1436 is a little confusing with keywords since keyword arguments
1437 which are supplied, but don't match the required arguments
Michael W. Hudson5253c302005-03-30 16:41:55 +00001438 are not included in the "%d given" part of the message
1439 XXX and this isn't a bug!? */
Guido van Rossumaa354651996-08-19 19:32:04 +00001440 if (len < min || max < len) {
1441 if (message == NULL) {
Jeremy Hylton23ae9872001-11-28 20:29:22 +00001442 PyOS_snprintf(msgbuf, sizeof(msgbuf),
1443 "%.200s%s takes %s %d argument%s "
1444 "(%d given)",
1445 fname==NULL ? "function" : fname,
1446 fname==NULL ? "" : "()",
1447 min==max ? "exactly"
1448 : len < min ? "at least" : "at most",
1449 len < min ? min : max,
1450 (len < min ? min : max) == 1 ? "" : "s",
1451 len);
Guido van Rossumaa354651996-08-19 19:32:04 +00001452 message = msgbuf;
1453 }
1454 PyErr_SetString(PyExc_TypeError, message);
1455 return 0;
1456 }
Tim Petersc2f01122001-10-27 07:25:06 +00001457
1458 /* convert the positional arguments */
Tim Peters6fb26352001-10-27 04:38:11 +00001459 for (i = 0; i < nargs; i++) {
Guido van Rossumaa354651996-08-19 19:32:04 +00001460 if (*format == '|')
1461 format++;
Jeremy Hylton0f8117f2001-05-18 20:57:38 +00001462 msg = convertitem(PyTuple_GET_ITEM(args, i), &format, p_va,
Martin v. Löwis18e16552006-02-15 17:27:45 +00001463 flags, levels, msgbuf, sizeof(msgbuf),
1464 &freelist);
Guido van Rossumaa354651996-08-19 19:32:04 +00001465 if (msg) {
1466 seterror(i+1, msg, levels, fname, message);
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001467 return cleanreturn(0, freelist);
Guido van Rossumaa354651996-08-19 19:32:04 +00001468 }
1469 }
1470
Tim Petersc2f01122001-10-27 07:25:06 +00001471 /* handle no keyword parameters in call */
Tim Petersb054be42001-10-27 05:07:41 +00001472 if (nkeywords == 0)
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001473 return cleanreturn(1, freelist);
Tim Petersb054be42001-10-27 05:07:41 +00001474
Guido van Rossumaa354651996-08-19 19:32:04 +00001475 /* convert the keyword arguments; this uses the format
1476 string where it was left after processing args */
Tim Petersb639d492001-10-27 07:00:56 +00001477 for (i = nargs; i < max; i++) {
Guido van Rossum79f25d91997-04-29 20:08:16 +00001478 PyObject *item;
Guido van Rossumaa354651996-08-19 19:32:04 +00001479 if (*format == '|')
1480 format++;
Tim Peters077f5742001-10-27 05:50:39 +00001481 item = PyDict_GetItemString(keywords, kwlist[i]);
Guido van Rossum80bb9651996-12-05 23:27:02 +00001482 if (item != NULL) {
Tim Peters077f5742001-10-27 05:50:39 +00001483 Py_INCREF(item);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001484 msg = convertitem(item, &format, p_va, flags, levels,
1485 msgbuf, sizeof(msgbuf), &freelist);
Tim Peters077f5742001-10-27 05:50:39 +00001486 Py_DECREF(item);
Guido van Rossumaa354651996-08-19 19:32:04 +00001487 if (msg) {
1488 seterror(i+1, msg, levels, fname, message);
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001489 return cleanreturn(0, freelist);
Guido van Rossumaa354651996-08-19 19:32:04 +00001490 }
Tim Petersc2f01122001-10-27 07:25:06 +00001491 --nkeywords;
1492 if (nkeywords == 0)
1493 break;
Guido van Rossumaa354651996-08-19 19:32:04 +00001494 }
Tim Peters0af49162001-10-27 06:14:32 +00001495 else if (PyErr_Occurred())
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001496 return cleanreturn(0, freelist);
Guido van Rossumaa354651996-08-19 19:32:04 +00001497 else {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001498 msg = skipitem(&format, p_va, flags);
Guido van Rossumaa354651996-08-19 19:32:04 +00001499 if (msg) {
1500 seterror(i+1, msg, levels, fname, message);
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001501 return cleanreturn(0, freelist);
Guido van Rossumaa354651996-08-19 19:32:04 +00001502 }
1503 }
1504 }
Tim Petersb054be42001-10-27 05:07:41 +00001505
Guido van Rossumaa354651996-08-19 19:32:04 +00001506 /* make sure there are no extraneous keyword arguments */
Tim Petersc2f01122001-10-27 07:25:06 +00001507 if (nkeywords > 0) {
1508 PyObject *key, *value;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001509 Py_ssize_t pos = 0;
Guido van Rossumaa354651996-08-19 19:32:04 +00001510 while (PyDict_Next(keywords, &pos, &key, &value)) {
Tim Petersc2f01122001-10-27 07:25:06 +00001511 int match = 0;
Guido van Rossum55474762002-04-04 16:22:30 +00001512 char *ks;
1513 if (!PyString_Check(key)) {
1514 PyErr_SetString(PyExc_TypeError,
1515 "keywords must be strings");
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001516 return cleanreturn(0, freelist);
Guido van Rossum55474762002-04-04 16:22:30 +00001517 }
1518 ks = PyString_AsString(key);
Tim Petersb639d492001-10-27 07:00:56 +00001519 for (i = 0; i < max; i++) {
Guido van Rossumaa354651996-08-19 19:32:04 +00001520 if (!strcmp(ks, kwlist[i])) {
1521 match = 1;
1522 break;
1523 }
1524 }
1525 if (!match) {
Tim Petersc2f01122001-10-27 07:25:06 +00001526 PyErr_Format(PyExc_TypeError,
1527 "'%s' is an invalid keyword "
1528 "argument for this function",
1529 ks);
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001530 return cleanreturn(0, freelist);
Guido van Rossumaa354651996-08-19 19:32:04 +00001531 }
1532 }
1533 }
Tim Petersc2f01122001-10-27 07:25:06 +00001534
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +00001535 return cleanreturn(1, freelist);
Guido van Rossumaa354651996-08-19 19:32:04 +00001536}
1537
1538
1539static char *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001540skipitem(const char **p_format, va_list *p_va, int flags)
Guido van Rossumaa354651996-08-19 19:32:04 +00001541{
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001542 const char *format = *p_format;
Guido van Rossumaa354651996-08-19 19:32:04 +00001543 char c = *format++;
1544
1545 switch (c) {
Georg Brandl6dd14612005-09-14 19:29:53 +00001546
1547 /* simple codes
1548 * The individual types (second arg of va_arg) are irrelevant */
1549
Guido van Rossumaa354651996-08-19 19:32:04 +00001550 case 'b': /* byte -- very short int */
Jack Jansencc22fbe2000-08-05 21:29:58 +00001551 case 'B': /* byte as bitfield */
Guido van Rossumaa354651996-08-19 19:32:04 +00001552 case 'h': /* short int */
Jack Jansencc22fbe2000-08-05 21:29:58 +00001553 case 'H': /* short int as bitfield */
Guido van Rossumaa354651996-08-19 19:32:04 +00001554 case 'i': /* int */
Georg Brandl6dd14612005-09-14 19:29:53 +00001555 case 'I': /* int sized bitfield */
Guido van Rossumaa354651996-08-19 19:32:04 +00001556 case 'l': /* long int */
Georg Brandl6dd14612005-09-14 19:29:53 +00001557 case 'k': /* long int sized bitfield */
Guido van Rossum3dbba6e1999-01-25 21:48:56 +00001558#ifdef HAVE_LONG_LONG
Georg Brandl6dd14612005-09-14 19:29:53 +00001559 case 'L': /* PY_LONG_LONG */
1560 case 'K': /* PY_LONG_LONG sized bitfield */
Guido van Rossum1a8791e1998-08-04 22:46:29 +00001561#endif
Guido van Rossumaa354651996-08-19 19:32:04 +00001562 case 'f': /* float */
Guido van Rossumaa354651996-08-19 19:32:04 +00001563 case 'd': /* double */
Guido van Rossumaa354651996-08-19 19:32:04 +00001564#ifndef WITHOUT_COMPLEX
1565 case 'D': /* complex double */
Georg Brandl6dd14612005-09-14 19:29:53 +00001566#endif
Guido van Rossumaa354651996-08-19 19:32:04 +00001567 case 'c': /* char */
1568 {
Georg Brandl6dd14612005-09-14 19:29:53 +00001569 (void) va_arg(*p_va, void *);
Guido van Rossumaa354651996-08-19 19:32:04 +00001570 break;
1571 }
Martin v. Löwis18e16552006-02-15 17:27:45 +00001572
1573 case 'n': /* Py_ssize_t */
1574 {
1575 (void) va_arg(*p_va, Py_ssize_t *);
1576 break;
1577 }
Guido van Rossumaa354651996-08-19 19:32:04 +00001578
Georg Brandl6dd14612005-09-14 19:29:53 +00001579 /* string codes */
1580
1581 case 'e': /* string with encoding */
1582 {
1583 (void) va_arg(*p_va, const char *);
1584 if (!(*format == 's' || *format == 't'))
1585 /* after 'e', only 's' and 't' is allowed */
1586 goto err;
1587 format++;
1588 /* explicit fallthrough to string cases */
1589 }
1590
Guido van Rossumaa354651996-08-19 19:32:04 +00001591 case 's': /* string */
Georg Brandl6dd14612005-09-14 19:29:53 +00001592 case 'z': /* string or None */
1593#ifdef Py_USING_UNICODE
1594 case 'u': /* unicode string */
1595#endif
1596 case 't': /* buffer, read-only */
1597 case 'w': /* buffer, read-write */
Guido van Rossumaa354651996-08-19 19:32:04 +00001598 {
Guido van Rossum80bb9651996-12-05 23:27:02 +00001599 (void) va_arg(*p_va, char **);
Guido van Rossumaa354651996-08-19 19:32:04 +00001600 if (*format == '#') {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001601 if (flags & FLAG_SIZE_T)
1602 (void) va_arg(*p_va, Py_ssize_t *);
1603 else
1604 (void) va_arg(*p_va, int *);
Guido van Rossumaa354651996-08-19 19:32:04 +00001605 format++;
1606 }
1607 break;
1608 }
Georg Brandl6dd14612005-09-14 19:29:53 +00001609
1610 /* object codes */
1611
Guido van Rossumaa354651996-08-19 19:32:04 +00001612 case 'S': /* string object */
Georg Brandl6dd14612005-09-14 19:29:53 +00001613#ifdef Py_USING_UNICODE
1614 case 'U': /* unicode string object */
1615#endif
Guido van Rossumaa354651996-08-19 19:32:04 +00001616 {
Guido van Rossum79f25d91997-04-29 20:08:16 +00001617 (void) va_arg(*p_va, PyObject **);
Guido van Rossumaa354651996-08-19 19:32:04 +00001618 break;
1619 }
1620
1621 case 'O': /* object */
1622 {
Guido van Rossumaa354651996-08-19 19:32:04 +00001623 if (*format == '!') {
1624 format++;
Guido van Rossum79f25d91997-04-29 20:08:16 +00001625 (void) va_arg(*p_va, PyTypeObject*);
1626 (void) va_arg(*p_va, PyObject **);
Guido van Rossumaa354651996-08-19 19:32:04 +00001627 }
1628#if 0
1629/* I don't know what this is for */
1630 else if (*format == '?') {
1631 inquiry pred = va_arg(*p_va, inquiry);
1632 format++;
1633 if ((*pred)(arg)) {
Guido van Rossum79f25d91997-04-29 20:08:16 +00001634 (void) va_arg(*p_va, PyObject **);
Guido van Rossumaa354651996-08-19 19:32:04 +00001635 }
1636 }
1637#endif
1638 else if (*format == '&') {
Tim Petersdbd9ba62000-07-09 03:09:57 +00001639 typedef int (*converter)(PyObject *, void *);
Guido van Rossum80bb9651996-12-05 23:27:02 +00001640 (void) va_arg(*p_va, converter);
1641 (void) va_arg(*p_va, void *);
Guido van Rossumaa354651996-08-19 19:32:04 +00001642 format++;
1643 }
1644 else {
Guido van Rossum79f25d91997-04-29 20:08:16 +00001645 (void) va_arg(*p_va, PyObject **);
Guido van Rossumaa354651996-08-19 19:32:04 +00001646 }
1647 break;
1648 }
1649
1650 default:
Georg Brandl6dd14612005-09-14 19:29:53 +00001651err:
Guido van Rossumaa354651996-08-19 19:32:04 +00001652 return "impossible<bad format char>";
1653
1654 }
Georg Brandl6dd14612005-09-14 19:29:53 +00001655
1656 /* The "(...)" format code for tuples is not handled here because
1657 * it is not allowed with keyword args. */
Guido van Rossumaa354651996-08-19 19:32:04 +00001658
1659 *p_format = format;
1660 return NULL;
1661}
Fred Drakee4616e62001-10-23 21:09:29 +00001662
1663
1664int
Martin v. Löwis76246742006-03-01 04:06:10 +00001665PyArg_UnpackTuple(PyObject *args, const char *name, Py_ssize_t min, Py_ssize_t max, ...)
Fred Drakee4616e62001-10-23 21:09:29 +00001666{
Martin v. Löwis76246742006-03-01 04:06:10 +00001667 Py_ssize_t i, l;
Fred Drakee4616e62001-10-23 21:09:29 +00001668 PyObject **o;
1669 va_list vargs;
1670
1671#ifdef HAVE_STDARG_PROTOTYPES
1672 va_start(vargs, max);
1673#else
1674 va_start(vargs);
1675#endif
1676
1677 assert(min >= 0);
1678 assert(min <= max);
1679 if (!PyTuple_Check(args)) {
1680 PyErr_SetString(PyExc_SystemError,
1681 "PyArg_UnpackTuple() argument list is not a tuple");
1682 return 0;
1683 }
1684 l = PyTuple_GET_SIZE(args);
1685 if (l < min) {
1686 if (name != NULL)
1687 PyErr_Format(
1688 PyExc_TypeError,
Thomas Wouters572a9f32006-03-01 05:38:39 +00001689 "%s expected %s%zd arguments, got %zd",
Fred Drakee4616e62001-10-23 21:09:29 +00001690 name, (min == max ? "" : "at least "), min, l);
1691 else
1692 PyErr_Format(
1693 PyExc_TypeError,
Thomas Wouters572a9f32006-03-01 05:38:39 +00001694 "unpacked tuple should have %s%zd elements,"
1695 " but has %zd",
Fred Drakee4616e62001-10-23 21:09:29 +00001696 (min == max ? "" : "at least "), min, l);
1697 va_end(vargs);
1698 return 0;
1699 }
1700 if (l > max) {
1701 if (name != NULL)
1702 PyErr_Format(
1703 PyExc_TypeError,
Thomas Wouters572a9f32006-03-01 05:38:39 +00001704 "%s expected %s%zd arguments, got %zd",
Fred Drakee4616e62001-10-23 21:09:29 +00001705 name, (min == max ? "" : "at most "), max, l);
1706 else
1707 PyErr_Format(
1708 PyExc_TypeError,
Thomas Wouters572a9f32006-03-01 05:38:39 +00001709 "unpacked tuple should have %s%zd elements,"
1710 " but has %zd",
Fred Drakee4616e62001-10-23 21:09:29 +00001711 (min == max ? "" : "at most "), max, l);
1712 va_end(vargs);
1713 return 0;
1714 }
1715 for (i = 0; i < l; i++) {
1716 o = va_arg(vargs, PyObject **);
1717 *o = PyTuple_GET_ITEM(args, i);
1718 }
1719 va_end(vargs);
1720 return 1;
1721}
Georg Brandl02c42872005-08-26 06:42:30 +00001722
1723
1724/* For type constructors that don't take keyword args
1725 *
1726 * Sets a TypeError and returns 0 if the kwds dict is
1727 * not emtpy, returns 1 otherwise
1728 */
1729int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001730_PyArg_NoKeywords(const char *funcname, PyObject *kw)
Georg Brandl02c42872005-08-26 06:42:30 +00001731{
1732 if (kw == NULL)
1733 return 1;
1734 if (!PyDict_CheckExact(kw)) {
1735 PyErr_BadInternalCall();
1736 return 0;
1737 }
1738 if (PyDict_Size(kw) == 0)
1739 return 1;
1740
1741 PyErr_Format(PyExc_TypeError, "%s does not take keyword arguments",
1742 funcname);
1743 return 0;
1744}
Anthony Baxter97300382006-04-12 04:38:54 +00001745#ifdef __cplusplus
1746};
1747#endif