getargs.c 51.7 KB
Newer Older
1 2 3

/* New getargs implementation */

4
#include "Python.h"
5

6 7
#include <ctype.h>

8

9
#ifdef __cplusplus
10
extern "C" {
11
#endif
12 13 14
int PyArg_Parse(PyObject *, const char *, ...);
int PyArg_ParseTuple(PyObject *, const char *, ...);
int PyArg_VaParse(PyObject *, const char *, va_list);
15

16
int PyArg_ParseTupleAndKeywords(PyObject *, PyObject *,
17
                                const char *, char **, ...);
18
int PyArg_VaParseTupleAndKeywords(PyObject *, PyObject *,
19
                                const char *, char **, va_list);
20

21 22 23 24 25 26 27 28 29 30 31 32
#ifdef HAVE_DECLSPEC_DLL
/* Export functions */
PyAPI_FUNC(int) _PyArg_Parse_SizeT(PyObject *, char *, ...);
PyAPI_FUNC(int) _PyArg_ParseTuple_SizeT(PyObject *, char *, ...);
PyAPI_FUNC(int) _PyArg_ParseTupleAndKeywords_SizeT(PyObject *, PyObject *,
                                                  const char *, char **, ...);
PyAPI_FUNC(PyObject *) _Py_BuildValue_SizeT(const char *, ...);
PyAPI_FUNC(int) _PyArg_VaParse_SizeT(PyObject *, char *, va_list);
PyAPI_FUNC(int) _PyArg_VaParseTupleAndKeywords_SizeT(PyObject *, PyObject *,
                                              const char *, char **, va_list);
#endif

Martin v. Löwis's avatar
Martin v. Löwis committed
33 34 35
#define FLAG_COMPAT 1
#define FLAG_SIZE_T 2

36 37

/* Forward */
38 39
static int vgetargs1(PyObject *, const char *, va_list *, int);
static void seterror(int, const char *, int *, const char *, const char *);
40
static char *convertitem(PyObject *, const char **, va_list *, int, int *,
Martin v. Löwis's avatar
Martin v. Löwis committed
41 42
                         char *, size_t, PyObject **);
static char *converttuple(PyObject *, const char **, va_list *, int,
43
                          int *, char *, size_t, int, PyObject **);
Martin v. Löwis's avatar
Martin v. Löwis committed
44
static char *convertsimple(PyObject *, const char **, va_list *, int, char *,
45
                           size_t, PyObject **);
Martin v. Löwis's avatar
Martin v. Löwis committed
46
static Py_ssize_t convertbuffer(PyObject *, void **p, char **);
47
static int getbuffer(PyObject *, Py_buffer *, char**);
48 49

static int vgetargskeywords(PyObject *, PyObject *,
50
                            const char *, char **, va_list *, int);
Martin v. Löwis's avatar
Martin v. Löwis committed
51
static char *skipitem(const char **, va_list *, int);
52

53
int
54
PyArg_Parse(PyObject *args, const char *format, ...)
55
{
56 57
    int retval;
    va_list va;
58

59 60 61 62
    va_start(va, format);
    retval = vgetargs1(args, format, &va, FLAG_COMPAT);
    va_end(va);
    return retval;
Martin v. Löwis's avatar
Martin v. Löwis committed
63 64 65 66 67
}

int
_PyArg_Parse_SizeT(PyObject *args, char *format, ...)
{
68 69
    int retval;
    va_list va;
70

71 72 73 74
    va_start(va, format);
    retval = vgetargs1(args, format, &va, FLAG_COMPAT|FLAG_SIZE_T);
    va_end(va);
    return retval;
75 76 77
}


78
int
79
PyArg_ParseTuple(PyObject *args, const char *format, ...)
80
{
81 82
    int retval;
    va_list va;
83

84 85 86 87
    va_start(va, format);
    retval = vgetargs1(args, format, &va, 0);
    va_end(va);
    return retval;
88 89
}

Martin v. Löwis's avatar
Martin v. Löwis committed
90 91 92
int
_PyArg_ParseTuple_SizeT(PyObject *args, char *format, ...)
{
93 94
    int retval;
    va_list va;
95

96 97 98 99
    va_start(va, format);
    retval = vgetargs1(args, format, &va, FLAG_SIZE_T);
    va_end(va);
    return retval;
Martin v. Löwis's avatar
Martin v. Löwis committed
100 101
}

102 103

int
104
PyArg_VaParse(PyObject *args, const char *format, va_list va)
105
{
106
    va_list lva;
107

108
        Py_VA_COPY(lva, va);
109

110
    return vgetargs1(args, format, &lva, 0);
111 112
}

Martin v. Löwis's avatar
Martin v. Löwis committed
113 114 115
int
_PyArg_VaParse_SizeT(PyObject *args, char *format, va_list va)
{
116
    va_list lva;
Martin v. Löwis's avatar
Martin v. Löwis committed
117

118
        Py_VA_COPY(lva, va);
Martin v. Löwis's avatar
Martin v. Löwis committed
119

120
    return vgetargs1(args, format, &lva, FLAG_SIZE_T);
Martin v. Löwis's avatar
Martin v. Löwis committed
121 122
}

123

124 125
/* Handle cleanup of allocated memory in case of exception */

126 127
#define GETARGS_CAPSULE_NAME_CLEANUP_PTR "getargs.cleanup_ptr"
#define GETARGS_CAPSULE_NAME_CLEANUP_BUFFER "getargs.cleanup_buffer"
128
#define GETARGS_CAPSULE_NAME_CLEANUP_CONVERT "getargs.cleanup_convert"
129

130
static void
131
cleanup_ptr(PyObject *self)
132
{
133 134 135 136
    void *ptr = PyCapsule_GetPointer(self, GETARGS_CAPSULE_NAME_CLEANUP_PTR);
    if (ptr) {
        PyMem_FREE(ptr);
    }
137 138 139
}

static void
140
cleanup_buffer(PyObject *self)
141
{
142 143 144 145
    Py_buffer *ptr = (Py_buffer *)PyCapsule_GetPointer(self, GETARGS_CAPSULE_NAME_CLEANUP_BUFFER);
    if (ptr) {
        PyBuffer_Release(ptr);
    }
146 147
}

148
static int
149
addcleanup(void *ptr, PyObject **freelist, int is_buffer)
150
{
151 152
    PyObject *cobj;
    const char *name;
153 154 155 156 157 158 159 160 161
    PyCapsule_Destructor destr;

    if (is_buffer) {
        destr = cleanup_buffer;
        name = GETARGS_CAPSULE_NAME_CLEANUP_BUFFER;
    } else {
        destr = cleanup_ptr;
        name = GETARGS_CAPSULE_NAME_CLEANUP_PTR;
    }
162 163 164 165 166 167 168 169 170 171 172 173 174 175 176

    if (!*freelist) {
        *freelist = PyList_New(0);
        if (!*freelist) {
            destr(ptr);
            return -1;
        }
    }

    cobj = PyCapsule_New(ptr, name, destr);
    if (!cobj) {
        destr(ptr);
        return -1;
    }
    if (PyList_Append(*freelist, cobj)) {
177
        Py_DECREF(cobj);
178 179 180 181
        return -1;
    }
    Py_DECREF(cobj);
    return 0;
182 183
}

184 185 186
static void
cleanup_convert(PyObject *self)
{
187 188 189 190 191 192
    typedef int (*destr_t)(PyObject *, void *);
    destr_t destr = (destr_t)PyCapsule_GetContext(self);
    void *ptr = PyCapsule_GetPointer(self,
                                     GETARGS_CAPSULE_NAME_CLEANUP_CONVERT);
    if (ptr && destr)
        destr(NULL, ptr);
193 194 195 196 197
}

static int
addcleanup_convert(void *ptr, PyObject **freelist, int (*destr)(PyObject*,void*))
{
198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221
    PyObject *cobj;
    if (!*freelist) {
        *freelist = PyList_New(0);
        if (!*freelist) {
            destr(NULL, ptr);
            return -1;
        }
    }
    cobj = PyCapsule_New(ptr, GETARGS_CAPSULE_NAME_CLEANUP_CONVERT,
                         cleanup_convert);
    if (!cobj) {
        destr(NULL, ptr);
        return -1;
    }
    if (PyCapsule_SetContext(cobj, destr) == -1) {
        /* This really should not happen. */
        Py_FatalError("capsule refused setting of context.");
    }
    if (PyList_Append(*freelist, cobj)) {
        Py_DECREF(cobj); /* This will also call destr. */
        return -1;
    }
    Py_DECREF(cobj);
    return 0;
222 223
}

224 225 226
static int
cleanreturn(int retval, PyObject *freelist)
{
227 228 229 230 231 232 233 234 235
    if (freelist && retval != 0) {
        /* We were successful, reset the destructors so that they
           don't get called. */
        Py_ssize_t len = PyList_GET_SIZE(freelist), i;
        for (i = 0; i < len; i++)
            PyCapsule_SetDestructor(PyList_GET_ITEM(freelist, i), NULL);
    }
    Py_XDECREF(freelist);
    return retval;
236 237 238
}


239
static int
Martin v. Löwis's avatar
Martin v. Löwis committed
240
vgetargs1(PyObject *args, const char *format, va_list *p_va, int flags)
241
{
242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312
    char msgbuf[256];
    int levels[32];
    const char *fname = NULL;
    const char *message = NULL;
    int min = -1;
    int max = 0;
    int level = 0;
    int endfmt = 0;
    const char *formatsave = format;
    Py_ssize_t i, len;
    char *msg;
    PyObject *freelist = NULL;
    int compat = flags & FLAG_COMPAT;

    assert(compat || (args != (PyObject*)NULL));
    flags = flags & ~FLAG_COMPAT;

    while (endfmt == 0) {
        int c = *format++;
        switch (c) {
        case '(':
            if (level == 0)
                max++;
            level++;
            if (level >= 30)
                Py_FatalError("too many tuple nesting levels "
                              "in argument format string");
            break;
        case ')':
            if (level == 0)
                Py_FatalError("excess ')' in getargs format");
            else
                level--;
            break;
        case '\0':
            endfmt = 1;
            break;
        case ':':
            fname = format;
            endfmt = 1;
            break;
        case ';':
            message = format;
            endfmt = 1;
            break;
        default:
            if (level == 0) {
                if (c == 'O')
                    max++;
                else if (isalpha(Py_CHARMASK(c))) {
                    if (c != 'e') /* skip encoded */
                        max++;
                } else if (c == '|')
                    min = max;
            }
            break;
        }
    }

    if (level != 0)
        Py_FatalError(/* '(' */ "missing ')' in getargs format");

    if (min < 0)
        min = max;

    format = formatsave;

    if (compat) {
        if (max == 0) {
            if (args == NULL)
                return 1;
313 314 315 316
            PyErr_Format(PyExc_TypeError,
                         "%.200s%s takes no arguments",
                         fname==NULL ? "function" : fname,
                         fname==NULL ? "" : "()");
317 318 319 320
            return 0;
        }
        else if (min == 1 && max == 1) {
            if (args == NULL) {
321 322 323 324
                PyErr_Format(PyExc_TypeError,
                             "%.200s%s takes at least one argument",
                             fname==NULL ? "function" : fname,
                             fname==NULL ? "" : "()");
325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349
                return 0;
            }
            msg = convertitem(args, &format, p_va, flags, levels,
                              msgbuf, sizeof(msgbuf), &freelist);
            if (msg == NULL)
                return cleanreturn(1, freelist);
            seterror(levels[0], msg, levels+1, fname, message);
            return cleanreturn(0, freelist);
        }
        else {
            PyErr_SetString(PyExc_SystemError,
                "old style getargs format uses new features");
            return 0;
        }
    }

    if (!PyTuple_Check(args)) {
        PyErr_SetString(PyExc_SystemError,
            "new style getargs format but argument is not a tuple");
        return 0;
    }

    len = PyTuple_GET_SIZE(args);

    if (len < min || max < len) {
350 351 352 353 354 355 356 357 358 359 360 361
        if (message == NULL)
            PyErr_Format(PyExc_TypeError,
                         "%.150s%s takes %s %d argument%s (%ld given)",
                         fname==NULL ? "function" : fname,
                         fname==NULL ? "" : "()",
                         min==max ? "exactly"
                         : len < min ? "at least" : "at most",
                         len < min ? min : max,
                         (len < min ? min : max) == 1 ? "" : "s",
                         Py_SAFE_DOWNCAST(len, Py_ssize_t, long));
        else
            PyErr_SetString(PyExc_TypeError, message);
362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385
        return 0;
    }

    for (i = 0; i < len; i++) {
        if (*format == '|')
            format++;
        msg = convertitem(PyTuple_GET_ITEM(args, i), &format, p_va,
                          flags, levels, msgbuf,
                          sizeof(msgbuf), &freelist);
        if (msg) {
            seterror(i+1, msg, levels, fname, msg);
            return cleanreturn(0, freelist);
        }
    }

    if (*format != '\0' && !isalpha(Py_CHARMASK(*format)) &&
        *format != '(' &&
        *format != '|' && *format != ':' && *format != ';') {
        PyErr_Format(PyExc_SystemError,
                     "bad format string: %.200s", formatsave);
        return cleanreturn(0, freelist);
    }

    return cleanreturn(1, freelist);
386 387 388 389 390
}



static void
391 392
seterror(int iarg, const char *msg, int *levels, const char *fname,
         const char *message)
393
{
394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424
    char buf[512];
    int i;
    char *p = buf;

    if (PyErr_Occurred())
        return;
    else if (message == NULL) {
        if (fname != NULL) {
            PyOS_snprintf(p, sizeof(buf), "%.200s() ", fname);
            p += strlen(p);
        }
        if (iarg != 0) {
            PyOS_snprintf(p, sizeof(buf) - (p - buf),
                          "argument %d", iarg);
            i = 0;
            p += strlen(p);
            while (levels[i] > 0 && i < 32 && (int)(p-buf) < 220) {
                PyOS_snprintf(p, sizeof(buf) - (p - buf),
                              ", item %d", levels[i]-1);
                p += strlen(p);
                i++;
            }
        }
        else {
            PyOS_snprintf(p, sizeof(buf) - (p - buf), "argument");
            p += strlen(p);
        }
        PyOS_snprintf(p, sizeof(buf) - (p - buf), " %.256s", msg);
        message = buf;
    }
    PyErr_SetString(PyExc_TypeError, message);
425 426 427 428 429 430 431 432 433 434 435 436 437 438 439
}


/* Convert a tuple argument.
   On entry, *p_format points to the character _after_ the opening '('.
   On successful exit, *p_format points to the closing ')'.
   If successful:
      *p_format and *p_va are updated,
      *levels and *msgbuf are untouched,
      and NULL is returned.
   If the argument is invalid:
      *p_format is unchanged,
      *p_va is undefined,
      *levels is a 0-terminated list of item numbers,
      *msgbuf contains an error message, whose format is:
440 441 442
     "must be <typename1>, not <typename2>", where:
        <typename1> is the name of the expected type, and
        <typename2> is the name of the actual type,
443 444 445 446
      and msgbuf is returned.
*/

static char *
Martin v. Löwis's avatar
Martin v. Löwis committed
447
converttuple(PyObject *arg, const char **p_format, va_list *p_va, int flags,
448
             int *levels, char *msgbuf, size_t bufsize, int toplevel,
Martin v. Löwis's avatar
Martin v. Löwis committed
449
             PyObject **freelist)
450
{
451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516
    int level = 0;
    int n = 0;
    const char *format = *p_format;
    int i;

    for (;;) {
        int c = *format++;
        if (c == '(') {
            if (level == 0)
                n++;
            level++;
        }
        else if (c == ')') {
            if (level == 0)
                break;
            level--;
        }
        else if (c == ':' || c == ';' || c == '\0')
            break;
        else if (level == 0 && isalpha(Py_CHARMASK(c)))
            n++;
    }

    if (!PySequence_Check(arg) || PyBytes_Check(arg)) {
        levels[0] = 0;
        PyOS_snprintf(msgbuf, bufsize,
                      toplevel ? "expected %d arguments, not %.50s" :
                      "must be %d-item sequence, not %.50s",
                  n,
                  arg == Py_None ? "None" : arg->ob_type->tp_name);
        return msgbuf;
    }

    if ((i = PySequence_Size(arg)) != n) {
        levels[0] = 0;
        PyOS_snprintf(msgbuf, bufsize,
                      toplevel ? "expected %d arguments, not %d" :
                     "must be sequence of length %d, not %d",
                  n, i);
        return msgbuf;
    }

    format = *p_format;
    for (i = 0; i < n; i++) {
        char *msg;
        PyObject *item;
        item = PySequence_GetItem(arg, i);
        if (item == NULL) {
            PyErr_Clear();
            levels[0] = i+1;
            levels[1] = 0;
            strncpy(msgbuf, "is not retrievable", bufsize);
            return msgbuf;
        }
        msg = convertitem(item, &format, p_va, flags, levels+1,
                          msgbuf, bufsize, freelist);
        /* PySequence_GetItem calls tp->sq_item, which INCREFs */
        Py_XDECREF(item);
        if (msg != NULL) {
            levels[0] = i+1;
            return msg;
        }
    }

    *p_format = format;
    return NULL;
517 518 519 520 521 522
}


/* Convert a single item. */

static char *
Martin v. Löwis's avatar
Martin v. Löwis committed
523 524
convertitem(PyObject *arg, const char **p_format, va_list *p_va, int flags,
            int *levels, char *msgbuf, size_t bufsize, PyObject **freelist)
525
{
526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544
    char *msg;
    const char *format = *p_format;

    if (*format == '(' /* ')' */) {
        format++;
        msg = converttuple(arg, &format, p_va, flags, levels, msgbuf,
                           bufsize, 0, freelist);
        if (msg == NULL)
            format++;
    }
    else {
        msg = convertsimple(arg, &format, p_va, flags,
                            msgbuf, bufsize, freelist);
        if (msg != NULL)
            levels[0] = 0;
    }
    if (msg == NULL)
        *p_format = format;
    return msg;
545 546 547
}


548 549

#define UNICODE_DEFAULT_ENCODING(arg) \
550
    _PyUnicode_AsDefaultEncodedString(arg)
551 552

/* Format an error message generated by convertsimple(). */
553 554

static char *
555
converterr(const char *expected, PyObject *arg, char *msgbuf, size_t bufsize)
556
{
557 558 559 560 561 562
    assert(expected != NULL);
    assert(arg != NULL);
    PyOS_snprintf(msgbuf, bufsize,
                  "must be %.50s, not %.50s", expected,
                  arg == Py_None ? "None" : arg->ob_type->tp_name);
    return msgbuf;
563 564
}

565
#define CONV_UNICODE "(unicode conversion error)"
Guido van Rossum's avatar
Guido van Rossum committed
566

567 568
/* Explicitly check for float arguments when integers are expected.
   Return 1 for error, 0 if ok. */
569 570 571
static int
float_argument_error(PyObject *arg)
{
572 573 574 575 576 577 578
    if (PyFloat_Check(arg)) {
        PyErr_SetString(PyExc_TypeError,
                        "integer argument expected, got float" );
        return 1;
    }
    else
        return 0;
579 580
}

581
/* Convert a non-tuple argument.  Return NULL if conversion went OK,
582 583
   or a string with a message describing the failure.  The message is
   formatted as "must be <desired type>, not <actual type>".
584
   When failing, an exception may or may not have been raised.
585 586 587
   Don't call if a tuple is expected.

   When you add new format codes, please don't forget poor skipitem() below.
588
*/
589 590

static char *
Martin v. Löwis's avatar
Martin v. Löwis committed
591
convertsimple(PyObject *arg, const char **p_format, va_list *p_va, int flags,
592
              char *msgbuf, size_t bufsize, PyObject **freelist)
593
{
594 595 596 597
    /* For # codes */
#define FETCH_SIZE      int *q=NULL;Py_ssize_t *q2=NULL;\
    if (flags & FLAG_SIZE_T) q2=va_arg(*p_va, Py_ssize_t*); \
    else q=va_arg(*p_va, int*);
598 599 600 601 602 603 604 605 606 607 608
#define STORE_SIZE(s)   \
    if (flags & FLAG_SIZE_T) \
        *q2=s; \
    else { \
        if (INT_MAX < s) { \
            PyErr_SetString(PyExc_OverflowError, \
                "size does not fit in an int"); \
            return converterr("", arg, msgbuf, bufsize); \
        } \
        *q=s; \
    }
Martin v. Löwis's avatar
Martin v. Löwis committed
609
#define BUFFER_LEN      ((flags & FLAG_SIZE_T) ? *q2:*q)
610
#define RETURN_ERR_OCCURRED return msgbuf
Martin v. Löwis's avatar
Martin v. Löwis committed
611

612 613 614 615 616 617 618 619 620 621
    const char *format = *p_format;
    char c = *format++;
    PyObject *uarg;

    switch (c) {

    case 'b': { /* unsigned byte -- very short int */
        char *p = va_arg(*p_va, char *);
        long ival;
        if (float_argument_error(arg))
622
            RETURN_ERR_OCCURRED;
623 624
        ival = PyLong_AsLong(arg);
        if (ival == -1 && PyErr_Occurred())
625
            RETURN_ERR_OCCURRED;
626 627
        else if (ival < 0) {
            PyErr_SetString(PyExc_OverflowError,
628 629
                            "unsigned byte integer is less than minimum");
            RETURN_ERR_OCCURRED;
630 631 632
        }
        else if (ival > UCHAR_MAX) {
            PyErr_SetString(PyExc_OverflowError,
633 634
                            "unsigned byte integer is greater than maximum");
            RETURN_ERR_OCCURRED;
635 636 637 638 639 640 641 642 643 644 645
        }
        else
            *p = (unsigned char) ival;
        break;
    }

    case 'B': {/* byte sized bitfield - both signed and unsigned
                  values allowed */
        char *p = va_arg(*p_va, char *);
        long ival;
        if (float_argument_error(arg))
646
            RETURN_ERR_OCCURRED;
647 648
        ival = PyLong_AsUnsignedLongMask(arg);
        if (ival == -1 && PyErr_Occurred())
649
            RETURN_ERR_OCCURRED;
650 651 652 653 654 655 656 657 658
        else
            *p = (unsigned char) ival;
        break;
    }

    case 'h': {/* signed short int */
        short *p = va_arg(*p_va, short *);
        long ival;
        if (float_argument_error(arg))
659
            RETURN_ERR_OCCURRED;
660 661
        ival = PyLong_AsLong(arg);
        if (ival == -1 && PyErr_Occurred())
662
            RETURN_ERR_OCCURRED;
663 664
        else if (ival < SHRT_MIN) {
            PyErr_SetString(PyExc_OverflowError,
665 666
                            "signed short integer is less than minimum");
            RETURN_ERR_OCCURRED;
667 668 669
        }
        else if (ival > SHRT_MAX) {
            PyErr_SetString(PyExc_OverflowError,
670 671
                            "signed short integer is greater than maximum");
            RETURN_ERR_OCCURRED;
672 673 674 675 676 677 678 679 680 681 682
        }
        else
            *p = (short) ival;
        break;
    }

    case 'H': { /* short int sized bitfield, both signed and
                   unsigned allowed */
        unsigned short *p = va_arg(*p_va, unsigned short *);
        long ival;
        if (float_argument_error(arg))
683
            RETURN_ERR_OCCURRED;
684 685
        ival = PyLong_AsUnsignedLongMask(arg);
        if (ival == -1 && PyErr_Occurred())
686
            RETURN_ERR_OCCURRED;
687 688 689 690 691 692 693 694 695
        else
            *p = (unsigned short) ival;
        break;
    }

    case 'i': {/* signed int */
        int *p = va_arg(*p_va, int *);
        long ival;
        if (float_argument_error(arg))
696
            RETURN_ERR_OCCURRED;
697 698
        ival = PyLong_AsLong(arg);
        if (ival == -1 && PyErr_Occurred())
699
            RETURN_ERR_OCCURRED;
700 701
        else if (ival > INT_MAX) {
            PyErr_SetString(PyExc_OverflowError,
702 703
                            "signed integer is greater than maximum");
            RETURN_ERR_OCCURRED;
704 705 706
        }
        else if (ival < INT_MIN) {
            PyErr_SetString(PyExc_OverflowError,
707 708
                            "signed integer is less than minimum");
            RETURN_ERR_OCCURRED;
709 710 711 712 713 714 715 716 717 718 719
        }
        else
            *p = ival;
        break;
    }

    case 'I': { /* int sized bitfield, both signed and
                   unsigned allowed */
        unsigned int *p = va_arg(*p_va, unsigned int *);
        unsigned int ival;
        if (float_argument_error(arg))
720
            RETURN_ERR_OCCURRED;
721 722
        ival = (unsigned int)PyLong_AsUnsignedLongMask(arg);
        if (ival == (unsigned int)-1 && PyErr_Occurred())
723
            RETURN_ERR_OCCURRED;
724 725 726 727 728 729 730 731 732 733 734
        else
            *p = ival;
        break;
    }

    case 'n': /* Py_ssize_t */
    {
        PyObject *iobj;
        Py_ssize_t *p = va_arg(*p_va, Py_ssize_t *);
        Py_ssize_t ival = -1;
        if (float_argument_error(arg))
735
            RETURN_ERR_OCCURRED;
736 737 738 739 740 741
        iobj = PyNumber_Index(arg);
        if (iobj != NULL) {
            ival = PyLong_AsSsize_t(iobj);
            Py_DECREF(iobj);
        }
        if (ival == -1 && PyErr_Occurred())
742
            RETURN_ERR_OCCURRED;
743 744 745 746 747 748 749
        *p = ival;
        break;
    }
    case 'l': {/* long int */
        long *p = va_arg(*p_va, long *);
        long ival;
        if (float_argument_error(arg))
750
            RETURN_ERR_OCCURRED;
751 752
        ival = PyLong_AsLong(arg);
        if (ival == -1 && PyErr_Occurred())
753
            RETURN_ERR_OCCURRED;
754 755 756 757 758 759 760 761 762 763 764 765 766 767 768
        else
            *p = ival;
        break;
    }

    case 'k': { /* long sized bitfield */
        unsigned long *p = va_arg(*p_va, unsigned long *);
        unsigned long ival;
        if (PyLong_Check(arg))
            ival = PyLong_AsUnsignedLongMask(arg);
        else
            return converterr("integer<k>", arg, msgbuf, bufsize);
        *p = ival;
        break;
    }
769

770
#ifdef HAVE_LONG_LONG
771 772 773
    case 'L': {/* PY_LONG_LONG */
        PY_LONG_LONG *p = va_arg( *p_va, PY_LONG_LONG * );
        PY_LONG_LONG ival;
774
        if (float_argument_error(arg))
775
            RETURN_ERR_OCCURRED;
776
        ival = PyLong_AsLongLong(arg);
777
        if (ival == (PY_LONG_LONG)-1 && PyErr_Occurred())
778
            RETURN_ERR_OCCURRED;
779
        else
780 781 782 783 784 785 786 787 788 789 790 791 792 793
            *p = ival;
        break;
    }

    case 'K': { /* long long sized bitfield */
        unsigned PY_LONG_LONG *p = va_arg(*p_va, unsigned PY_LONG_LONG *);
        unsigned PY_LONG_LONG ival;
        if (PyLong_Check(arg))
            ival = PyLong_AsUnsignedLongLongMask(arg);
        else
            return converterr("integer<K>", arg, msgbuf, bufsize);
        *p = ival;
        break;
    }
794
#endif
795

796 797 798 799
    case 'f': {/* float */
        float *p = va_arg(*p_va, float *);
        double dval = PyFloat_AsDouble(arg);
        if (PyErr_Occurred())
800
            RETURN_ERR_OCCURRED;
801 802 803 804 805 806 807 808 809
        else
            *p = (float) dval;
        break;
    }

    case 'd': {/* double */
        double *p = va_arg(*p_va, double *);
        double dval = PyFloat_AsDouble(arg);
        if (PyErr_Occurred())
810
            RETURN_ERR_OCCURRED;
811 812 813 814 815 816 817 818 819 820
        else
            *p = dval;
        break;
    }

    case 'D': {/* complex double */
        Py_complex *p = va_arg(*p_va, Py_complex *);
        Py_complex cval;
        cval = PyComplex_AsCComplex(arg);
        if (PyErr_Occurred())
821
            RETURN_ERR_OCCURRED;
822 823 824 825 826 827 828 829 830
        else
            *p = cval;
        break;
    }

    case 'c': {/* char */
        char *p = va_arg(*p_va, char *);
        if (PyBytes_Check(arg) && PyBytes_Size(arg) == 1)
            *p = PyBytes_AS_STRING(arg)[0];
831 832
        else if (PyByteArray_Check(arg) && PyByteArray_Size(arg) == 1)
            *p = PyByteArray_AS_STRING(arg)[0];
833 834 835 836 837 838 839 840 841 842 843 844 845 846 847
        else
            return converterr("a byte string of length 1", arg, msgbuf, bufsize);
        break;
    }

    case 'C': {/* unicode char */
        int *p = va_arg(*p_va, int *);
        if (PyUnicode_Check(arg) &&
            PyUnicode_GET_SIZE(arg) == 1)
            *p = PyUnicode_AS_UNICODE(arg)[0];
        else
            return converterr("a unicode character", arg, msgbuf, bufsize);
        break;
    }

848
    /* XXX WAAAAH!  's', 'y', 'z', 'u', 'Z', 'e', 'w' codes all
849 850 851 852 853 854 855 856 857 858
       need to be cleaned up! */

    case 'y': {/* any buffer-like object, but not PyUnicode */
        void **p = (void **)va_arg(*p_va, char **);
        char *buf;
        Py_ssize_t count;
        if (*format == '*') {
            if (getbuffer(arg, (Py_buffer*)p, &buf) < 0)
                return converterr(buf, arg, msgbuf, bufsize);
            format++;
859
            if (addcleanup(p, freelist, 1)) {
860 861 862 863 864 865 866 867 868
                return converterr(
                    "(cleanup problem)",
                    arg, msgbuf, bufsize);
            }
            break;
        }
        count = convertbuffer(arg, p, &buf);
        if (count < 0)
            return converterr(buf, arg, msgbuf, bufsize);
869
        if (*format == '#') {
870 871 872
            FETCH_SIZE;
            STORE_SIZE(count);
            format++;
873 874 875 876 877
        } else {
            if (strlen(*p) != count)
                return converterr(
                    "bytes without null bytes",
                    arg, msgbuf, bufsize);
878 879 880 881
        }
        break;
    }

882 883 884
    case 's': /* text string */
    case 'z': /* text string or None */
    {
885
        if (*format == '*') {
886
            /* "s*" or "z*" */
887 888
            Py_buffer *p = (Py_buffer *)va_arg(*p_va, Py_buffer *);

889
            if (c == 'z' && arg == Py_None)
890 891 892 893 894 895 896 897 898 899 900 901 902 903 904
                PyBuffer_FillInfo(p, NULL, NULL, 0, 1, 0);
            else if (PyUnicode_Check(arg)) {
                uarg = UNICODE_DEFAULT_ENCODING(arg);
                if (uarg == NULL)
                    return converterr(CONV_UNICODE,
                                      arg, msgbuf, bufsize);
                PyBuffer_FillInfo(p, arg,
                                  PyBytes_AS_STRING(uarg), PyBytes_GET_SIZE(uarg),
                                  1, 0);
            }
            else { /* any buffer-like object */
                char *buf;
                if (getbuffer(arg, p, &buf) < 0)
                    return converterr(buf, arg, msgbuf, bufsize);
            }
905
            if (addcleanup(p, freelist, 1)) {
906 907 908 909 910 911
                return converterr(
                    "(cleanup problem)",
                    arg, msgbuf, bufsize);
            }
            format++;
        } else if (*format == '#') { /* any buffer-like object */
912
            /* "s#" or "z#" */
913 914 915
            void **p = (void **)va_arg(*p_va, char **);
            FETCH_SIZE;

916 917
            if (c == 'z' && arg == Py_None) {
                *p = NULL;
918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937
                STORE_SIZE(0);
            }
            else if (PyUnicode_Check(arg)) {
                uarg = UNICODE_DEFAULT_ENCODING(arg);
                if (uarg == NULL)
                    return converterr(CONV_UNICODE,
                                      arg, msgbuf, bufsize);
                *p = PyBytes_AS_STRING(uarg);
                STORE_SIZE(PyBytes_GET_SIZE(uarg));
            }
            else { /* any buffer-like object */
                /* XXX Really? */
                char *buf;
                Py_ssize_t count = convertbuffer(arg, p, &buf);
                if (count < 0)
                    return converterr(buf, arg, msgbuf, bufsize);
                STORE_SIZE(count);
            }
            format++;
        } else {
938
            /* "s" or "z" */
939 940 941
            char **p = va_arg(*p_va, char **);
            uarg = NULL;

942 943
            if (c == 'z' && arg == Py_None)
                *p = NULL;
944 945 946 947 948 949 950 951
            else if (PyUnicode_Check(arg)) {
                uarg = UNICODE_DEFAULT_ENCODING(arg);
                if (uarg == NULL)
                    return converterr(CONV_UNICODE,
                                      arg, msgbuf, bufsize);
                *p = PyBytes_AS_STRING(uarg);
            }
            else
952
                return converterr(c == 'z' ? "str or None" : "str",
953
                                  arg, msgbuf, bufsize);
Victor Stinner's avatar
Victor Stinner committed
954
            if (*p != NULL && uarg != NULL &&
955 956
                (Py_ssize_t) strlen(*p) != PyBytes_GET_SIZE(uarg))
                return converterr(
957 958
                    c == 'z' ? "str without null bytes or None"
                             : "str without null bytes",
959 960 961 962 963
                    arg, msgbuf, bufsize);
        }
        break;
    }

964 965 966
    case 'u': /* raw unicode buffer (Py_UNICODE *) */
    case 'Z': /* raw unicode buffer or None */
    {
967 968
        Py_UNICODE **p = va_arg(*p_va, Py_UNICODE **);

969
        if (*format == '#') { /* any buffer-like object */
970
            /* "s#" or "Z#" */
971 972
            FETCH_SIZE;

973 974
            if (c == 'Z' && arg == Py_None) {
                *p = NULL;
975 976 977 978 979 980
                STORE_SIZE(0);
            }
            else if (PyUnicode_Check(arg)) {
                *p = PyUnicode_AS_UNICODE(arg);
                STORE_SIZE(PyUnicode_GET_SIZE(arg));
            }
981 982
            else
                return converterr("str or None", arg, msgbuf, bufsize);
983 984
            format++;
        } else {
985 986 987
            /* "s" or "Z" */
            if (c == 'Z' && arg == Py_None)
                *p = NULL;
988
            else if (PyUnicode_Check(arg)) {
989
                *p = PyUnicode_AS_UNICODE(arg);
990 991 992 993 994
                if (Py_UNICODE_strlen(*p) != PyUnicode_GET_SIZE(arg))
                    return converterr(
                        "str without null character or None",
                        arg, msgbuf, bufsize);
            } else
995 996
                return converterr(c == 'Z' ? "str or None" : "str",
                                  arg, msgbuf, bufsize);
997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106
        }
        break;
    }

    case 'e': {/* encoded string */
        char **buffer;
        const char *encoding;
        PyObject *s;
        int recode_strings;
        Py_ssize_t size;
        const char *ptr;

        /* Get 'e' parameter: the encoding name */
        encoding = (const char *)va_arg(*p_va, const char *);
        if (encoding == NULL)
            encoding = PyUnicode_GetDefaultEncoding();

        /* Get output buffer parameter:
           's' (recode all objects via Unicode) or
           't' (only recode non-string objects)
        */
        if (*format == 's')
            recode_strings = 1;
        else if (*format == 't')
            recode_strings = 0;
        else
            return converterr(
                "(unknown parser marker combination)",
                arg, msgbuf, bufsize);
        buffer = (char **)va_arg(*p_va, char **);
        format++;
        if (buffer == NULL)
            return converterr("(buffer is NULL)",
                              arg, msgbuf, bufsize);

        /* Encode object */
        if (!recode_strings &&
            (PyBytes_Check(arg) || PyByteArray_Check(arg))) {
            s = arg;
            Py_INCREF(s);
            if (PyObject_AsCharBuffer(s, &ptr, &size) < 0)
                return converterr("(AsCharBuffer failed)",
                                  arg, msgbuf, bufsize);
        }
        else {
            PyObject *u;

            /* Convert object to Unicode */
            u = PyUnicode_FromObject(arg);
            if (u == NULL)
                return converterr(
                    "string or unicode or text buffer",
                    arg, msgbuf, bufsize);

            /* Encode object; use default error handling */
            s = PyUnicode_AsEncodedString(u,
                                          encoding,
                                          NULL);
            Py_DECREF(u);
            if (s == NULL)
                return converterr("(encoding failed)",
                                  arg, msgbuf, bufsize);
            if (!PyBytes_Check(s)) {
                Py_DECREF(s);
                return converterr(
                    "(encoder failed to return bytes)",
                    arg, msgbuf, bufsize);
            }
            size = PyBytes_GET_SIZE(s);
            ptr = PyBytes_AS_STRING(s);
            if (ptr == NULL)
                ptr = "";
        }

        /* Write output; output is guaranteed to be 0-terminated */
        if (*format == '#') {
            /* Using buffer length parameter '#':

               - if *buffer is NULL, a new buffer of the
               needed size is allocated and the data
               copied into it; *buffer is updated to point
               to the new buffer; the caller is
               responsible for PyMem_Free()ing it after
               usage

               - if *buffer is not NULL, the data is
               copied to *buffer; *buffer_len has to be
               set to the size of the buffer on input;
               buffer overflow is signalled with an error;
               buffer has to provide enough room for the
               encoded string plus the trailing 0-byte

               - in both cases, *buffer_len is updated to
               the size of the buffer /excluding/ the
               trailing 0-byte

            */
            FETCH_SIZE;

            format++;
            if (q == NULL && q2 == NULL) {
                Py_DECREF(s);
                return converterr(
                    "(buffer_len is NULL)",
                    arg, msgbuf, bufsize);
            }
            if (*buffer == NULL) {
                *buffer = PyMem_NEW(char, size + 1);
                if (*buffer == NULL) {
                    Py_DECREF(s);
1107
                    PyErr_NoMemory();
1108
                    RETURN_ERR_OCCURRED;
1109
                }
1110
                if (addcleanup(*buffer, freelist, 0)) {
1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148
                    Py_DECREF(s);
                    return converterr(
                        "(cleanup problem)",
                        arg, msgbuf, bufsize);
                }
            } else {
                if (size + 1 > BUFFER_LEN) {
                    Py_DECREF(s);
                    return converterr(
                        "(buffer overflow)",
                        arg, msgbuf, bufsize);
                }
            }
            memcpy(*buffer, ptr, size+1);
            STORE_SIZE(size);
        } else {
            /* Using a 0-terminated buffer:

               - the encoded string has to be 0-terminated
               for this variant to work; if it is not, an
               error raised

               - a new buffer of the needed size is
               allocated and the data copied into it;
               *buffer is updated to point to the new
               buffer; the caller is responsible for
               PyMem_Free()ing it after usage

            */
            if ((Py_ssize_t)strlen(ptr) != size) {
                Py_DECREF(s);
                return converterr(
                    "encoded string without NULL bytes",
                    arg, msgbuf, bufsize);
            }
            *buffer = PyMem_NEW(char, size + 1);
            if (*buffer == NULL) {
                Py_DECREF(s);
1149
                PyErr_NoMemory();
1150
                RETURN_ERR_OCCURRED;
1151
            }
1152
            if (addcleanup(*buffer, freelist, 0)) {
1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176
                Py_DECREF(s);
                return converterr("(cleanup problem)",
                                arg, msgbuf, bufsize);
            }
            memcpy(*buffer, ptr, size+1);
        }
        Py_DECREF(s);
        break;
    }

    case 'S': { /* PyBytes object */
        PyObject **p = va_arg(*p_va, PyObject **);
        if (PyBytes_Check(arg))
            *p = arg;
        else
            return converterr("bytes", arg, msgbuf, bufsize);
        break;
    }

    case 'Y': { /* PyByteArray object */
        PyObject **p = va_arg(*p_va, PyObject **);
        if (PyByteArray_Check(arg))
            *p = arg;
        else
1177
            return converterr("bytearray", arg, msgbuf, bufsize);
1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224
        break;
    }

    case 'U': { /* PyUnicode object */
        PyObject **p = va_arg(*p_va, PyObject **);
        if (PyUnicode_Check(arg))
            *p = arg;
        else
            return converterr("str", arg, msgbuf, bufsize);
        break;
    }

    case 'O': { /* object */
        PyTypeObject *type;
        PyObject **p;
        if (*format == '!') {
            type = va_arg(*p_va, PyTypeObject*);
            p = va_arg(*p_va, PyObject **);
            format++;
            if (PyType_IsSubtype(arg->ob_type, type))
                *p = arg;
            else
                return converterr(type->tp_name, arg, msgbuf, bufsize);

        }
        else if (*format == '&') {
            typedef int (*converter)(PyObject *, void *);
            converter convert = va_arg(*p_va, converter);
            void *addr = va_arg(*p_va, void *);
            int res;
            format++;
            if (! (res = (*convert)(arg, addr)))
                return converterr("(unspecified)",
                                  arg, msgbuf, bufsize);
            if (res == Py_CLEANUP_SUPPORTED &&
                addcleanup_convert(addr, freelist, convert) == -1)
                return converterr("(cleanup problem)",
                                arg, msgbuf, bufsize);
        }
        else {
            p = va_arg(*p_va, PyObject **);
            *p = arg;
        }
        break;
    }


1225
    case 'w': { /* "w*": memory buffer, read-write access */
1226 1227
        void **p = va_arg(*p_va, void **);

1228 1229 1230 1231 1232
        if (*format != '*')
            return converterr(
                "invalid use of 'w' format character",
                arg, msgbuf, bufsize);
        format++;
1233

1234 1235 1236 1237 1238
        /* Caller is interested in Py_buffer, and the object
           supports it directly. */
        if (PyObject_GetBuffer(arg, (Py_buffer*)p, PyBUF_WRITABLE) < 0) {
            PyErr_Clear();
            return converterr("read-write buffer", arg, msgbuf, bufsize);
1239
        }
1240 1241 1242 1243
        if (!PyBuffer_IsContiguous((Py_buffer*)p, 'C')) {
            PyBuffer_Release((Py_buffer*)p);
            return converterr("contiguous buffer", arg, msgbuf, bufsize);
        }
1244
        if (addcleanup(p, freelist, 1)) {
1245 1246 1247
            return converterr(
                "(cleanup problem)",
                arg, msgbuf, bufsize);
1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258
        }
        break;
    }

    default:
        return converterr("impossible<bad format char>", arg, msgbuf, bufsize);

    }

    *p_format = format;
    return NULL;
1259 1260 1261 1262 1263

#undef FETCH_SIZE
#undef STORE_SIZE
#undef BUFFER_LEN
#undef RETURN_ERR_OCCURRED
1264
}
1265

Martin v. Löwis's avatar
Martin v. Löwis committed
1266
static Py_ssize_t
1267
convertbuffer(PyObject *arg, void **p, char **errmsg)
1268
{
1269
    PyBufferProcs *pb = Py_TYPE(arg)->tp_as_buffer;
1270 1271 1272 1273 1274
    Py_ssize_t count;
    Py_buffer view;

    *errmsg = NULL;
    *p = NULL;
1275 1276
    if (pb != NULL && pb->bf_releasebuffer != NULL) {
        *errmsg = "read-only pinned buffer";
1277 1278 1279
        return -1;
    }

1280
    if (getbuffer(arg, &view, errmsg) < 0)
1281 1282 1283 1284 1285
        return -1;
    count = view.len;
    *p = view.buf;
    PyBuffer_Release(&view);
    return count;
1286
}
1287

1288
static int
1289
getbuffer(PyObject *arg, Py_buffer *view, char **errmsg)
1290
{
1291
    if (PyObject_GetBuffer(arg, view, PyBUF_SIMPLE) != 0) {
1292 1293 1294
        *errmsg = "bytes or buffer";
        return -1;
    }
1295
    if (!PyBuffer_IsContiguous(view, 'C')) {
1296
        PyBuffer_Release(view);
1297 1298
        *errmsg = "contiguous buffer";
        return -1;
1299 1300
    }
    return 0;
1301 1302
}

1303 1304 1305
/* Support for keyword arguments donated by
   Geoff Philbrick <philbric@delphi.hks.com> */

1306
/* Return false (0) for error, else true. */
1307 1308
int
PyArg_ParseTupleAndKeywords(PyObject *args,
1309 1310 1311
                            PyObject *keywords,
                            const char *format,
                            char **kwlist, ...)
1312
{
1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328
    int retval;
    va_list va;

    if ((args == NULL || !PyTuple_Check(args)) ||
        (keywords != NULL && !PyDict_Check(keywords)) ||
        format == NULL ||
        kwlist == NULL)
    {
        PyErr_BadInternalCall();
        return 0;
    }

    va_start(va, kwlist);
    retval = vgetargskeywords(args, keywords, format, kwlist, &va, 0);
    va_end(va);
    return retval;
Martin v. Löwis's avatar
Martin v. Löwis committed
1329 1330 1331 1332
}

int
_PyArg_ParseTupleAndKeywords_SizeT(PyObject *args,
1333 1334 1335
                                  PyObject *keywords,
                                  const char *format,
                                  char **kwlist, ...)
Martin v. Löwis's avatar
Martin v. Löwis committed
1336
{
1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353
    int retval;
    va_list va;

    if ((args == NULL || !PyTuple_Check(args)) ||
        (keywords != NULL && !PyDict_Check(keywords)) ||
        format == NULL ||
        kwlist == NULL)
    {
        PyErr_BadInternalCall();
        return 0;
    }

    va_start(va, kwlist);
    retval = vgetargskeywords(args, keywords, format,
                              kwlist, &va, FLAG_SIZE_T);
    va_end(va);
    return retval;
1354 1355 1356
}


1357 1358
int
PyArg_VaParseTupleAndKeywords(PyObject *args,
1359
                              PyObject *keywords,
1360
                              const char *format,
1361
                              char **kwlist, va_list va)
1362
{
1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373
    int retval;
    va_list lva;

    if ((args == NULL || !PyTuple_Check(args)) ||
        (keywords != NULL && !PyDict_Check(keywords)) ||
        format == NULL ||
        kwlist == NULL)
    {
        PyErr_BadInternalCall();
        return 0;
    }
1374

1375
        Py_VA_COPY(lva, va);
1376

1377 1378
    retval = vgetargskeywords(args, keywords, format, kwlist, &lva, 0);
    return retval;
Martin v. Löwis's avatar
Martin v. Löwis committed
1379 1380 1381 1382
}

int
_PyArg_VaParseTupleAndKeywords_SizeT(PyObject *args,
1383 1384 1385
                                    PyObject *keywords,
                                    const char *format,
                                    char **kwlist, va_list va)
Martin v. Löwis's avatar
Martin v. Löwis committed
1386
{
1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397
    int retval;
    va_list lva;

    if ((args == NULL || !PyTuple_Check(args)) ||
        (keywords != NULL && !PyDict_Check(keywords)) ||
        format == NULL ||
        kwlist == NULL)
    {
        PyErr_BadInternalCall();
        return 0;
    }
Martin v. Löwis's avatar
Martin v. Löwis committed
1398

1399
        Py_VA_COPY(lva, va);
Martin v. Löwis's avatar
Martin v. Löwis committed
1400

1401 1402 1403
    retval = vgetargskeywords(args, keywords, format,
                              kwlist, &lva, FLAG_SIZE_T);
    return retval;
1404 1405
}

1406 1407 1408
int
PyArg_ValidateKeywordArguments(PyObject *kwargs)
{
1409
    if (!PyDict_Check(kwargs)) {
1410 1411 1412 1413 1414 1415 1416 1417 1418
        PyErr_BadInternalCall();
        return 0;
    }
    if (!_PyDict_HasOnlyStringKeys(kwargs)) {
        PyErr_SetString(PyExc_TypeError,
                        "keyword arguments must be strings");
        return 0;
    }
    return 1;
1419 1420
}

Christian Heimes's avatar
Christian Heimes committed
1421
#define IS_END_OF_FORMAT(c) (c == '\0' || c == ';' || c == ':')
1422

1423
static int
1424
vgetargskeywords(PyObject *args, PyObject *keywords, const char *format,
1425
                 char **kwlist, va_list *p_va, int flags)
1426
{
1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458
    char msgbuf[512];
    int levels[32];
    const char *fname, *msg, *custom_msg, *keyword;
    int min = INT_MAX;
    int i, len, nargs, nkeywords;
    PyObject *freelist = NULL, *current_arg;

    assert(args != NULL && PyTuple_Check(args));
    assert(keywords == NULL || PyDict_Check(keywords));
    assert(format != NULL);
    assert(kwlist != NULL);
    assert(p_va != NULL);

    /* grab the function name or custom error msg first (mutually exclusive) */
    fname = strchr(format, ':');
    if (fname) {
        fname++;
        custom_msg = NULL;
    }
    else {
        custom_msg = strchr(format,';');
        if (custom_msg)
            custom_msg++;
    }

    /* scan kwlist and get greatest possible nbr of args */
    for (len=0; kwlist[len]; len++)
        continue;

    nargs = PyTuple_GET_SIZE(args);
    nkeywords = (keywords == NULL) ? 0 : PyDict_Size(keywords);
    if (nargs + nkeywords > len) {
1459 1460
        PyErr_Format(PyExc_TypeError,
                     "%s%s takes at most %d argument%s (%d given)",
1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553
                     (fname == NULL) ? "function" : fname,
                     (fname == NULL) ? "" : "()",
                     len,
                     (len == 1) ? "" : "s",
                     nargs + nkeywords);
        return 0;
    }

    /* convert tuple args and keyword args in same loop, using kwlist to drive process */
    for (i = 0; i < len; i++) {
        keyword = kwlist[i];
        if (*format == '|') {
            min = i;
            format++;
        }
        if (IS_END_OF_FORMAT(*format)) {
            PyErr_Format(PyExc_RuntimeError,
                         "More keyword list entries (%d) than "
                         "format specifiers (%d)", len, i);
            return cleanreturn(0, freelist);
        }
        current_arg = NULL;
        if (nkeywords) {
            current_arg = PyDict_GetItemString(keywords, keyword);
        }
        if (current_arg) {
            --nkeywords;
            if (i < nargs) {
                /* arg present in tuple and in dict */
                PyErr_Format(PyExc_TypeError,
                             "Argument given by name ('%s') "
                             "and position (%d)",
                             keyword, i+1);
                return cleanreturn(0, freelist);
            }
        }
        else if (nkeywords && PyErr_Occurred())
            return cleanreturn(0, freelist);
        else if (i < nargs)
            current_arg = PyTuple_GET_ITEM(args, i);

        if (current_arg) {
            msg = convertitem(current_arg, &format, p_va, flags,
                levels, msgbuf, sizeof(msgbuf), &freelist);
            if (msg) {
                seterror(i+1, msg, levels, fname, custom_msg);
                return cleanreturn(0, freelist);
            }
            continue;
        }

        if (i < min) {
            PyErr_Format(PyExc_TypeError, "Required argument "
                         "'%s' (pos %d) not found",
                         keyword, i+1);
            return cleanreturn(0, freelist);
        }
        /* current code reports success when all required args
         * fulfilled and no keyword args left, with no further
         * validation. XXX Maybe skip this in debug build ?
         */
        if (!nkeywords)
            return cleanreturn(1, freelist);

        /* We are into optional args, skip thru to any remaining
         * keyword args */
        msg = skipitem(&format, p_va, flags);
        if (msg) {
            PyErr_Format(PyExc_RuntimeError, "%s: '%s'", msg,
                         format);
            return cleanreturn(0, freelist);
        }
    }

    if (!IS_END_OF_FORMAT(*format) && *format != '|') {
        PyErr_Format(PyExc_RuntimeError,
            "more argument specifiers than keyword list entries "
            "(remaining format:'%s')", format);
        return cleanreturn(0, freelist);
    }

    /* make sure there are no extraneous keyword arguments */
    if (nkeywords > 0) {
        PyObject *key, *value;
        Py_ssize_t pos = 0;
        while (PyDict_Next(keywords, &pos, &key, &value)) {
            int match = 0;
            char *ks;
            if (!PyUnicode_Check(key)) {
                PyErr_SetString(PyExc_TypeError,
                                "keywords must be strings");
                return cleanreturn(0, freelist);
            }
1554
            /* check that _PyUnicode_AsString() result is not NULL */
1555
            ks = _PyUnicode_AsString(key);
1556 1557 1558 1559 1560 1561
            if (ks != NULL) {
                for (i = 0; i < len; i++) {
                    if (!strcmp(ks, kwlist[i])) {
                        match = 1;
                        break;
                    }
1562 1563 1564 1565
                }
            }
            if (!match) {
                PyErr_Format(PyExc_TypeError,
1566
                             "'%U' is an invalid keyword "
1567
                             "argument for this function",
1568
                             key);
1569 1570 1571 1572 1573 1574
                return cleanreturn(0, freelist);
            }
        }
    }

    return cleanreturn(1, freelist);
1575 1576 1577 1578
}


static char *
Martin v. Löwis's avatar
Martin v. Löwis committed
1579
skipitem(const char **p_format, va_list *p_va, int flags)
1580
{
1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596
    const char *format = *p_format;
    char c = *format++;

    switch (c) {

    /* simple codes
     * The individual types (second arg of va_arg) are irrelevant */

    case 'b': /* byte -- very short int */
    case 'B': /* byte as bitfield */
    case 'h': /* short int */
    case 'H': /* short int as bitfield */
    case 'i': /* int */
    case 'I': /* int sized bitfield */
    case 'l': /* long int */
    case 'k': /* long int sized bitfield */
1597
#ifdef HAVE_LONG_LONG
1598 1599
    case 'L': /* PY_LONG_LONG */
    case 'K': /* PY_LONG_LONG sized bitfield */
1600
#endif
1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697
    case 'f': /* float */
    case 'd': /* double */
    case 'D': /* complex double */
    case 'c': /* char */
    case 'C': /* unicode char */
        {
            (void) va_arg(*p_va, void *);
            break;
        }

    case 'n': /* Py_ssize_t */
        {
            (void) va_arg(*p_va, Py_ssize_t *);
            break;
        }

    /* string codes */

    case 'e': /* string with encoding */
        {
            (void) va_arg(*p_va, const char *);
            if (!(*format == 's' || *format == 't'))
                /* after 'e', only 's' and 't' is allowed */
                goto err;
            format++;
            /* explicit fallthrough to string cases */
        }

    case 's': /* string */
    case 'z': /* string or None */
    case 'y': /* bytes */
    case 'u': /* unicode string */
    case 'w': /* buffer, read-write */
        {
            (void) va_arg(*p_va, char **);
            if (*format == '#') {
                if (flags & FLAG_SIZE_T)
                    (void) va_arg(*p_va, Py_ssize_t *);
                else
                    (void) va_arg(*p_va, int *);
                format++;
            } else if ((c == 's' || c == 'z' || c == 'y') && *format == '*') {
                format++;
            }
            break;
        }

    /* object codes */

    case 'S': /* string object */
    case 'Y': /* string object */
    case 'U': /* unicode string object */
        {
            (void) va_arg(*p_va, PyObject **);
            break;
        }

    case 'O': /* object */
        {
            if (*format == '!') {
                format++;
                (void) va_arg(*p_va, PyTypeObject*);
                (void) va_arg(*p_va, PyObject **);
            }
            else if (*format == '&') {
                typedef int (*converter)(PyObject *, void *);
                (void) va_arg(*p_va, converter);
                (void) va_arg(*p_va, void *);
                format++;
            }
            else {
                (void) va_arg(*p_va, PyObject **);
            }
            break;
        }

    case '(':           /* bypass tuple, not handled at all previously */
        {
            char *msg;
            for (;;) {
                if (*format==')')
                    break;
                if (IS_END_OF_FORMAT(*format))
                    return "Unmatched left paren in format "
                           "string";
                msg = skipitem(&format, p_va, flags);
                if (msg)
                    return msg;
            }
            format++;
            break;
        }

    case ')':
        return "Unmatched right paren in format string";

    default:
1698
err:
1699
        return "impossible<bad format char>";
1700

1701
    }
1702

1703 1704
    *p_format = format;
    return NULL;
1705
}
1706 1707 1708


int
1709
PyArg_UnpackTuple(PyObject *args, const char *name, Py_ssize_t min, Py_ssize_t max, ...)
1710
{
1711 1712 1713
    Py_ssize_t i, l;
    PyObject **o;
    va_list vargs;
1714 1715

#ifdef HAVE_STDARG_PROTOTYPES
1716
    va_start(vargs, max);
1717
#else
1718
    va_start(vargs);
1719 1720
#endif

1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764
    assert(min >= 0);
    assert(min <= max);
    if (!PyTuple_Check(args)) {
        PyErr_SetString(PyExc_SystemError,
            "PyArg_UnpackTuple() argument list is not a tuple");
        return 0;
    }
    l = PyTuple_GET_SIZE(args);
    if (l < min) {
        if (name != NULL)
            PyErr_Format(
                PyExc_TypeError,
                "%s expected %s%zd arguments, got %zd",
                name, (min == max ? "" : "at least "), min, l);
        else
            PyErr_Format(
                PyExc_TypeError,
                "unpacked tuple should have %s%zd elements,"
                " but has %zd",
                (min == max ? "" : "at least "), min, l);
        va_end(vargs);
        return 0;
    }
    if (l > max) {
        if (name != NULL)
            PyErr_Format(
                PyExc_TypeError,
                "%s expected %s%zd arguments, got %zd",
                name, (min == max ? "" : "at most "), max, l);
        else
            PyErr_Format(
                PyExc_TypeError,
                "unpacked tuple should have %s%zd elements,"
                " but has %zd",
                (min == max ? "" : "at most "), max, l);
        va_end(vargs);
        return 0;
    }
    for (i = 0; i < l; i++) {
        o = va_arg(vargs, PyObject **);
        *o = PyTuple_GET_ITEM(args, i);
    }
    va_end(vargs);
    return 1;
1765
}
1766 1767 1768 1769


/* For type constructors that don't take keyword args
 *
1770
 * Sets a TypeError and returns 0 if the kwds dict is
1771
 * not empty, returns 1 otherwise
1772 1773
 */
int
1774
_PyArg_NoKeywords(const char *funcname, PyObject *kw)
1775
{
1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787
    if (kw == NULL)
        return 1;
    if (!PyDict_CheckExact(kw)) {
        PyErr_BadInternalCall();
        return 0;
    }
    if (PyDict_Size(kw) == 0)
        return 1;

    PyErr_Format(PyExc_TypeError, "%s does not take keyword arguments",
                    funcname);
    return 0;
1788
}
1789 1790 1791
#ifdef __cplusplus
};
#endif