home *** CD-ROM | disk | FTP | other *** search
/ AmigActive 4 / AACD04.ISO / AACD / Programming / Python / Source / Modules / structmodule.c < prev    next >
Encoding:
C/C++ Source or Header  |  1999-04-25  |  26.0 KB  |  1,380 lines
  1. /***********************************************************
  2. Copyright 1991-1995 by Stichting Mathematisch Centrum, Amsterdam,
  3. The Netherlands.
  4.  
  5.                         All Rights Reserved
  6.  
  7. Permission to use, copy, modify, and distribute this software and its
  8. documentation for any purpose and without fee is hereby granted,
  9. provided that the above copyright notice appear in all copies and that
  10. both that copyright notice and this permission notice appear in
  11. supporting documentation, and that the names of Stichting Mathematisch
  12. Centrum or CWI or Corporation for National Research Initiatives or
  13. CNRI not be used in advertising or publicity pertaining to
  14. distribution of the software without specific, written prior
  15. permission.
  16.  
  17. While CWI is the initial source for this software, a modified version
  18. is made available by the Corporation for National Research Initiatives
  19. (CNRI) at the Internet address ftp://ftp.python.org.
  20.  
  21. STICHTING MATHEMATISCH CENTRUM AND CNRI DISCLAIM ALL WARRANTIES WITH
  22. REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF
  23. MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL STICHTING MATHEMATISCH
  24. CENTRUM OR CNRI BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL
  25. DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
  26. PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
  27. TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  28. PERFORMANCE OF THIS SOFTWARE.
  29.  
  30. ******************************************************************/
  31.  
  32. /* struct module -- pack values into and (out of) strings */
  33.  
  34. /* New version supporting byte order, alignment and size options,
  35.    character strings, and unsigned numbers */
  36.  
  37. static char struct__doc__[] = "\
  38. Functions to convert between Python values and C structs.\n\
  39. Python strings are used to hold the data representing the C struct\n\
  40. and also as format strings to describe the layout of data in the C struct.\n\
  41. \n\
  42. The optional first format char indicates byte ordering and alignment:\n\
  43.  @: native w/native alignment(default)\n\
  44.  =: native w/standard alignment\n\
  45.  <: little-endian, std. alignment\n\
  46.  >: big-endian, std. alignment\n\
  47.  !: network, std (same as >)\n\
  48. \n\
  49. The remaining chars indicate types of args and must match exactly;\n\
  50. these can be preceded by a decimal repeat count:\n\
  51.  x: pad byte (no data); c:char; b:signed byte; B:unsigned byte;\n\
  52.  h:short; H:unsigned short; i:int; I:unsigned int;\n\
  53.  l:long; L:unsigned long; f:float; d:double.\n\
  54. Special cases (preceding decimal count indicates length):\n\
  55.  s:string (array of char); p: pascal string (w. count byte).\n\
  56. Special case (only available in native format):\n\
  57.  P:an integer type that is wide enough to hold a pointer.\n\
  58. Whitespace between formats is ignored.\n\
  59. \n\
  60. The variable struct.error is an exception raised on errors.";
  61.  
  62. #include "Python.h"
  63. #include "mymath.h"
  64.  
  65. #include <limits.h>
  66. #include <ctype.h>
  67.  
  68. /* Exception */
  69.  
  70. static PyObject *StructError;
  71.  
  72.  
  73. /* Define various structs to figure out the alignments of types */
  74.  
  75. #ifdef __MWERKS__
  76. /*
  77. ** XXXX We have a problem here. There are no unique alignment rules
  78. ** on the PowerPC mac. 
  79. */
  80. #ifdef __powerc
  81. #pragma options align=mac68k
  82. #endif
  83. #endif /* __MWERKS__ */
  84.  
  85. typedef struct { char c; short x; } s_short;
  86. typedef struct { char c; int x; } s_int;
  87. typedef struct { char c; long x; } s_long;
  88. typedef struct { char c; float x; } s_float;
  89. typedef struct { char c; double x; } s_double;
  90. typedef struct { char c; void *x; } s_void_p;
  91.  
  92. #include "protos/structmodule.h"
  93.  
  94. #define SHORT_ALIGN (sizeof(s_short) - sizeof(short))
  95. #define INT_ALIGN (sizeof(s_int) - sizeof(int))
  96. #define LONG_ALIGN (sizeof(s_long) - sizeof(long))
  97. #define FLOAT_ALIGN (sizeof(s_float) - sizeof(float))
  98. #define DOUBLE_ALIGN (sizeof(s_double) - sizeof(double))
  99. #define VOID_P_ALIGN (sizeof(s_void_p) - sizeof(void *))
  100.  
  101. #ifdef __powerc
  102. #pragma options align=reset
  103. #endif
  104.  
  105. /* Helper routine to get a Python integer and raise the appropriate error
  106.    if it isn't one */
  107.  
  108. static int
  109. get_long(v, p)
  110.     PyObject *v;
  111.     long *p;
  112. {
  113.     long x = PyInt_AsLong(v);
  114.     if (x == -1 && PyErr_Occurred()) {
  115.         if (PyErr_ExceptionMatches(PyExc_TypeError))
  116.             PyErr_SetString(StructError,
  117.                     "required argument is not an integer");
  118.         return -1;
  119.     }
  120.     *p = x;
  121.     return 0;
  122. }
  123.  
  124.  
  125. /* Same, but handling unsigned long */
  126.  
  127. static int
  128. get_ulong(v, p)
  129.     PyObject *v;
  130.     unsigned long *p;
  131. {
  132.     if (PyLong_Check(v)) {
  133.         unsigned long x = PyLong_AsUnsignedLong(v);
  134.         if (x == (unsigned long)(-1) && PyErr_Occurred())
  135.             return -1;
  136.         *p = x;
  137.         return 0;
  138.     }
  139.     else {
  140.         return get_long(v, (long *)p);
  141.     }
  142. }
  143.  
  144.  
  145. /* Floating point helpers */
  146.  
  147. /* These use ANSI/IEEE Standard 754-1985 (Standard for Binary Floating
  148.    Point Arithmetic).  See the following URL:
  149.    http://www.psc.edu/general/software/packages/ieee/ieee.html */
  150.  
  151. /* XXX Inf/NaN are not handled quite right (but underflow is!) */
  152.  
  153. static int
  154. pack_float(x, p, incr)
  155.     double x; /* The number to pack */
  156.     char *p;  /* Where to pack the high order byte */
  157.     int incr; /* 1 for big-endian; -1 for little-endian */
  158. {
  159.     int s;
  160.     int e;
  161.     double f;
  162.     long fbits;
  163.  
  164.     if (x < 0) {
  165.         s = 1;
  166.         x = -x;
  167.     }
  168.     else
  169.         s = 0;
  170.  
  171.     f = frexp(x, &e);
  172.  
  173.     /* Normalize f to be in the range [1.0, 2.0) */
  174.     if (0.5 <= f && f < 1.0) {
  175.         f *= 2.0;
  176.         e--;
  177.     }
  178.     else if (f == 0.0) {
  179.         e = 0;
  180.     }
  181.     else {
  182.         PyErr_SetString(PyExc_SystemError,
  183.                 "frexp() result out of range");
  184.         return -1;
  185.     }
  186.  
  187.     if (e >= 128) {
  188.         /* XXX 128 itself is reserved for Inf/NaN */
  189.         PyErr_SetString(PyExc_OverflowError,
  190.                 "float too large to pack with f format");
  191.         return -1;
  192.     }
  193.     else if (e < -126) {
  194.         /* Gradual underflow */
  195.         f = ldexp(f, 126 + e);
  196.         e = 0;
  197.     }
  198.     else if (!(e == 0 && f == 0.0)) {
  199.         e += 127;
  200.         f -= 1.0; /* Get rid of leading 1 */
  201.     }
  202.  
  203.     f *= 8388608.0; /* 2**23 */
  204.     fbits = (long) floor(f + 0.5); /* Round */
  205.  
  206.     /* First byte */
  207.     *p = (s<<7) | (e>>1);
  208.     p += incr;
  209.  
  210.     /* Second byte */
  211.     *p = (char) (((e&1)<<7) | (fbits>>16));
  212.     p += incr;
  213.  
  214.     /* Third byte */
  215.     *p = (fbits>>8) & 0xFF;
  216.     p += incr;
  217.  
  218.     /* Fourth byte */
  219.     *p = fbits&0xFF;
  220.  
  221.     /* Done */
  222.     return 0;
  223. }
  224.  
  225. static int
  226. pack_double(x, p, incr)
  227.     double x; /* The number to pack */
  228.     char *p;  /* Where to pack the high order byte */
  229.     int incr; /* 1 for big-endian; -1 for little-endian */
  230. {
  231.     int s;
  232.     int e;
  233.     double f;
  234.     long fhi, flo;
  235.  
  236.     if (x < 0) {
  237.         s = 1;
  238.         x = -x;
  239.     }
  240.     else
  241.         s = 0;
  242.  
  243.     f = frexp(x, &e);
  244.  
  245.     /* Normalize f to be in the range [1.0, 2.0) */
  246.     if (0.5 <= f && f < 1.0) {
  247.         f *= 2.0;
  248.         e--;
  249.     }
  250.     else if (f == 0.0) {
  251.         e = 0;
  252.     }
  253.     else {
  254.         PyErr_SetString(PyExc_SystemError,
  255.                 "frexp() result out of range");
  256.         return -1;
  257.     }
  258.  
  259.     if (e >= 1024) {
  260.         /* XXX 1024 itself is reserved for Inf/NaN */
  261.         PyErr_SetString(PyExc_OverflowError,
  262.                 "float too large to pack with d format");
  263.         return -1;
  264.     }
  265.     else if (e < -1022) {
  266.         /* Gradual underflow */
  267.         f = ldexp(f, 1022 + e);
  268.         e = 0;
  269.     }
  270.     else if (!(e == 0 && f == 0.0)) {
  271.         e += 1023;
  272.         f -= 1.0; /* Get rid of leading 1 */
  273.     }
  274.  
  275.     /* fhi receives the high 28 bits; flo the low 24 bits (== 52 bits) */
  276.     f *= 268435456.0; /* 2**28 */
  277.     fhi = (long) floor(f); /* Truncate */
  278.     f -= (double)fhi;
  279.     f *= 16777216.0; /* 2**24 */
  280.     flo = (long) floor(f + 0.5); /* Round */
  281.  
  282.     /* First byte */
  283.     *p = (s<<7) | (e>>4);
  284.     p += incr;
  285.  
  286.     /* Second byte */
  287.     *p = (char) (((e&0xF)<<4) | (fhi>>24));
  288.     p += incr;
  289.  
  290.     /* Third byte */
  291.     *p = (fhi>>16) & 0xFF;
  292.     p += incr;
  293.  
  294.     /* Fourth byte */
  295.     *p = (fhi>>8) & 0xFF;
  296.     p += incr;
  297.  
  298.     /* Fifth byte */
  299.     *p = fhi & 0xFF;
  300.     p += incr;
  301.  
  302.     /* Sixth byte */
  303.     *p = (flo>>16) & 0xFF;
  304.     p += incr;
  305.  
  306.     /* Seventh byte */
  307.     *p = (flo>>8) & 0xFF;
  308.     p += incr;
  309.  
  310.     /* Eighth byte */
  311.     *p = flo & 0xFF;
  312.     p += incr;
  313.  
  314.     /* Done */
  315.     return 0;
  316. }
  317.  
  318. static PyObject *
  319. unpack_float(p, incr)
  320.     char *p;  /* Where the high order byte is */
  321.     int incr; /* 1 for big-endian; -1 for little-endian */
  322. {
  323.     int s;
  324.     int e;
  325.     long f;
  326.     double x;
  327.  
  328.     /* First byte */
  329.     s = (*p>>7) & 1;
  330.     e = (*p & 0x7F) << 1;
  331.     p += incr;
  332.  
  333.     /* Second byte */
  334.     e |= (*p>>7) & 1;
  335.     f = (*p & 0x7F) << 16;
  336.     p += incr;
  337.  
  338.     /* Third byte */
  339.     f |= (*p & 0xFF) << 8;
  340.     p += incr;
  341.  
  342.     /* Fourth byte */
  343.     f |= *p & 0xFF;
  344.  
  345.     x = (double)f / 8388608.0;
  346.  
  347.     /* XXX This sadly ignores Inf/NaN issues */
  348.     if (e == 0)
  349.         e = -126;
  350.     else {
  351.         x += 1.0;
  352.         e -= 127;
  353.     }
  354.     x = ldexp(x, e);
  355.  
  356.     if (s)
  357.         x = -x;
  358.  
  359.     return PyFloat_FromDouble(x);
  360. }
  361.  
  362. static PyObject *
  363. unpack_double(p, incr)
  364.     char *p;  /* Where the high order byte is */
  365.     int incr; /* 1 for big-endian; -1 for little-endian */
  366. {
  367.     int s;
  368.     int e;
  369.     long fhi, flo;
  370.     double x;
  371.  
  372.     /* First byte */
  373.     s = (*p>>7) & 1;
  374.     e = (*p & 0x7F) << 4;
  375.     p += incr;
  376.  
  377.     /* Second byte */
  378.     e |= (*p>>4) & 0xF;
  379.     fhi = (*p & 0xF) << 24;
  380.     p += incr;
  381.  
  382.     /* Third byte */
  383.     fhi |= (*p & 0xFF) << 16;
  384.     p += incr;
  385.  
  386.     /* Fourth byte */
  387.     fhi |= (*p & 0xFF) << 8;
  388.     p += incr;
  389.  
  390.     /* Fifth byte */
  391.     fhi |= *p & 0xFF;
  392.     p += incr;
  393.  
  394.     /* Sixth byte */
  395.     flo = (*p & 0xFF) << 16;
  396.     p += incr;
  397.  
  398.     /* Seventh byte */
  399.     flo |= (*p & 0xFF) << 8;
  400.     p += incr;
  401.  
  402.     /* Eighth byte */
  403.     flo |= *p & 0xFF;
  404.     p += incr;
  405.  
  406.     x = (double)fhi + (double)flo / 16777216.0; /* 2**24 */
  407.     x /= 268435456.0; /* 2**28 */
  408.  
  409.     /* XXX This sadly ignores Inf/NaN */
  410.     if (e == 0)
  411.         e = -1022;
  412.     else {
  413.         x += 1.0;
  414.         e -= 1023;
  415.     }
  416.     x = ldexp(x, e);
  417.  
  418.     if (s)
  419.         x = -x;
  420.  
  421.     return PyFloat_FromDouble(x);
  422. }
  423.  
  424.  
  425. /* The translation function for each format character is table driven */
  426.  
  427. typedef struct _formatdef {
  428.     char format;
  429.     int size;
  430.     int alignment;
  431.     PyObject* (*unpack) Py_PROTO((const char *,
  432.                       const struct _formatdef *));
  433.     int (*pack) Py_PROTO((char *,
  434.                   PyObject *,
  435.                   const struct _formatdef *));
  436. } formatdef;
  437.  
  438. #include "protos/structmodule2.h"
  439.  
  440. static PyObject *
  441. nu_char(p, f)
  442.     const char *p;
  443.     const formatdef *f;
  444. {
  445.     return PyString_FromStringAndSize(p, 1);
  446. }
  447.  
  448. static PyObject *
  449. nu_byte(p, f)
  450.     const char *p;
  451.     const formatdef *f;
  452. {
  453.     return PyInt_FromLong((long) *(signed char *)p);
  454. }
  455.  
  456. static PyObject *
  457. nu_ubyte(p, f)
  458.     const char *p;
  459.     const formatdef *f;
  460. {
  461.     return PyInt_FromLong((long) *(unsigned char *)p);
  462. }
  463.  
  464. static PyObject *
  465. nu_short(p, f)
  466.     const char *p;
  467.     const formatdef *f;
  468. {
  469.     return PyInt_FromLong((long) *(short *)p);
  470. }
  471.  
  472. static PyObject *
  473. nu_ushort(p, f)
  474.     const char *p;
  475.     const formatdef *f;
  476. {
  477.     return PyInt_FromLong((long) *(unsigned short *)p);
  478. }
  479.  
  480. static PyObject *
  481. nu_int(p, f)
  482.     const char *p;
  483.     const formatdef *f;
  484. {
  485.     return PyInt_FromLong((long) *(int *)p);
  486. }
  487.  
  488. static PyObject *
  489. nu_uint(p, f)
  490.     const char *p;
  491.     const formatdef *f;
  492. {
  493.     unsigned int x = *(unsigned int *)p;
  494.     return PyLong_FromUnsignedLong((unsigned long)x);
  495. }
  496.  
  497. static PyObject *
  498. nu_long(p, f)
  499.     const char *p;
  500.     const formatdef *f;
  501. {
  502.     return PyInt_FromLong(*(long *)p);
  503. }
  504.  
  505. static PyObject *
  506. nu_ulong(p, f)
  507.     const char *p;
  508.     const formatdef *f;
  509. {
  510.     return PyLong_FromUnsignedLong(*(unsigned long *)p);
  511. }
  512.  
  513. static PyObject *
  514. nu_float(p, f)
  515.     const char *p;
  516.     const formatdef *f;
  517. {
  518.     float x;
  519.     memcpy((char *)&x, p, sizeof(float));
  520.     return PyFloat_FromDouble((double)x);
  521. }
  522.  
  523. static PyObject *
  524. nu_double(p, f)
  525.     const char *p;
  526.     const formatdef *f;
  527. {
  528.     double x;
  529.     memcpy((char *)&x, p, sizeof(double));
  530.     return PyFloat_FromDouble(x);
  531. }
  532.  
  533. static PyObject *
  534. nu_void_p(p, f)
  535.     const char *p;
  536.     const formatdef *f;
  537. {
  538.     return PyLong_FromVoidPtr(*(void **)p);
  539. }
  540.  
  541. static int
  542. np_byte(p, v, f)
  543.     char *p;
  544.     PyObject *v;
  545.     const formatdef *f;
  546. {
  547.     long x;
  548.     if (get_long(v, &x) < 0)
  549.         return -1;
  550.     *p = (char)x;
  551.     return 0;
  552. }
  553.  
  554. static int
  555. np_char(p, v, f)
  556.     char *p;
  557.     PyObject *v;
  558.     const formatdef *f;
  559. {
  560.     if (!PyString_Check(v) || PyString_Size(v) != 1) {
  561.         PyErr_SetString(StructError,
  562.                 "char format require string of length 1");
  563.         return -1;
  564.     }
  565.     *p = *PyString_AsString(v);
  566.     return 0;
  567. }
  568.  
  569. static int
  570. np_short(p, v, f)
  571.     char *p;
  572.     PyObject *v;
  573.     const formatdef *f;
  574. {
  575.     long x;
  576.     if (get_long(v, &x) < 0)
  577.         return -1;
  578.     * (short *)p = (short)x;
  579.     return 0;
  580. }
  581.  
  582. static int
  583. np_int(p, v, f)
  584.     char *p;
  585.     PyObject *v;
  586.     const formatdef *f;
  587. {
  588.     long x;
  589.     if (get_long(v, &x) < 0)
  590.         return -1;
  591.     * (int *)p = x;
  592.     return 0;
  593. }
  594.  
  595. static int
  596. np_uint(p, v, f)
  597.     char *p;
  598.     PyObject *v;
  599.     const formatdef *f;
  600. {
  601.     unsigned long x;
  602.     if (get_ulong(v, &x) < 0)
  603.         return -1;
  604.     * (unsigned int *)p = x;
  605.     return 0;
  606. }
  607.  
  608. static int
  609. np_long(p, v, f)
  610.     char *p;
  611.     PyObject *v;
  612.     const formatdef *f;
  613. {
  614.     long x;
  615.     if (get_long(v, &x) < 0)
  616.         return -1;
  617.     * (long *)p = x;
  618.     return 0;
  619. }
  620.  
  621. static int
  622. np_ulong(p, v, f)
  623.     char *p;
  624.     PyObject *v;
  625.     const formatdef *f;
  626. {
  627.     unsigned long x;
  628.     if (get_ulong(v, &x) < 0)
  629.         return -1;
  630.     * (unsigned long *)p = x;
  631.     return 0;
  632. }
  633.  
  634. static int
  635. np_float(p, v, f)
  636.     char *p;
  637.     PyObject *v;
  638.     const formatdef *f;
  639. {
  640.     float x = (float)PyFloat_AsDouble(v);
  641.     if (x == -1 && PyErr_Occurred()) {
  642.         PyErr_SetString(StructError,
  643.                 "required argument is not a float");
  644.         return -1;
  645.     }
  646.     memcpy(p, (char *)&x, sizeof(float));
  647.     return 0;
  648. }
  649.  
  650. static int
  651. np_double(p, v, f)
  652.     char *p;
  653.     PyObject *v;
  654.     const formatdef *f;
  655. {
  656.     double x = PyFloat_AsDouble(v);
  657.     if (x == -1 && PyErr_Occurred()) {
  658.         PyErr_SetString(StructError,
  659.                 "required argument is not a float");
  660.         return -1;
  661.     }
  662.     memcpy(p, (char *)&x, sizeof(double));
  663.     return 0;
  664. }
  665.  
  666. static int
  667. np_void_p(p, v, f)
  668.     char *p;
  669.     PyObject *v;
  670.     const formatdef *f;
  671. {
  672.     void *x = PyLong_AsVoidPtr(v);
  673.     if (x == NULL && PyErr_Occurred()) {
  674.         /* ### hrm. PyLong_AsVoidPtr raises SystemError */
  675.         if (PyErr_ExceptionMatches(PyExc_TypeError))
  676.             PyErr_SetString(StructError,
  677.                     "required argument is not an integer");
  678.         return -1;
  679.     }
  680.     *(void **)p = x;
  681.     return 0;
  682. }
  683.  
  684. static formatdef native_table[] = {
  685.     {'x',    sizeof(char),    0,        NULL},
  686.     {'b',    sizeof(char),    0,        nu_byte,    np_byte},
  687.     {'B',    sizeof(char),    0,        nu_ubyte,    np_byte},
  688.     {'c',    sizeof(char),    0,        nu_char,    np_char},
  689.     {'s',    sizeof(char),    0,        NULL},
  690.     {'p',    sizeof(char),    0,        NULL},
  691.     {'h',    sizeof(short),    SHORT_ALIGN,    nu_short,    np_short},
  692.     {'H',    sizeof(short),    SHORT_ALIGN,    nu_ushort,    np_short},
  693.     {'i',    sizeof(int),    INT_ALIGN,    nu_int,        np_int},
  694.     {'I',    sizeof(int),    INT_ALIGN,    nu_uint,    np_uint},
  695.     {'l',    sizeof(long),    LONG_ALIGN,    nu_long,    np_long},
  696.     {'L',    sizeof(long),    LONG_ALIGN,    nu_ulong,    np_ulong},
  697.     {'f',    sizeof(float),    FLOAT_ALIGN,    nu_float,    np_float},
  698.     {'d',    sizeof(double),    DOUBLE_ALIGN,    nu_double,    np_double},
  699.     {'P',    sizeof(void *),    VOID_P_ALIGN,    nu_void_p,    np_void_p},
  700.     {0}
  701. };
  702.  
  703. static PyObject *
  704. bu_int(p, f)
  705.     const char *p;
  706.     const formatdef *f;
  707. {
  708.     long x = 0;
  709.     int i = f->size;
  710.     do {
  711.         x = (x<<8) | (*p++ & 0xFF);
  712.     } while (--i > 0);
  713.     i = 8*(sizeof(long) - f->size);
  714.     if (i) {
  715.         x <<= i;
  716.         x >>= i;
  717.     }
  718.     return PyInt_FromLong(x);
  719. }
  720.  
  721. static PyObject *
  722. bu_uint(p, f)
  723.     const char *p;
  724.     const formatdef *f;
  725. {
  726.     unsigned long x = 0;
  727.     int i = f->size;
  728.     do {
  729.         x = (x<<8) | (*p++ & 0xFF);
  730.     } while (--i > 0);
  731.     if (f->size >= 4)
  732.         return PyLong_FromUnsignedLong(x);
  733.     else
  734.         return PyInt_FromLong((long)x);
  735. }
  736.  
  737. static PyObject *
  738. bu_float(p, f)
  739.     const char *p;
  740.     const formatdef *f;
  741. {
  742.     return unpack_float(p, 1);
  743. }
  744.  
  745. static PyObject *
  746. bu_double(p, f)
  747.     const char *p;
  748.     const formatdef *f;
  749. {
  750.     return unpack_double(p, 1);
  751. }
  752.  
  753. static int
  754. bp_int(p, v, f)
  755.     char *p;
  756.     PyObject *v;
  757.     const formatdef *f;
  758. {
  759.     long x;
  760.     int i;
  761.     if (get_long(v, &x) < 0)
  762.         return -1;
  763.     i = f->size;
  764.     do {
  765.         p[--i] = (char)x;
  766.         x >>= 8;
  767.     } while (i > 0);
  768.     return 0;
  769. }
  770.  
  771. static int
  772. bp_uint(p, v, f)
  773.     char *p;
  774.     PyObject *v;
  775.     const formatdef *f;
  776. {
  777.     unsigned long x;
  778.     int i;
  779.     if (get_ulong(v, &x) < 0)
  780.         return -1;
  781.     i = f->size;
  782.     do {
  783.         p[--i] = (char)x;
  784.         x >>= 8;
  785.     } while (i > 0);
  786.     return 0;
  787. }
  788.  
  789. static int
  790. bp_float(p, v, f)
  791.     char *p;
  792.     PyObject *v;
  793.     const formatdef *f;
  794. {
  795.     double x = PyFloat_AsDouble(v);
  796.     if (x == -1 && PyErr_Occurred()) {
  797.         PyErr_SetString(StructError,
  798.                 "required argument is not a float");
  799.         return -1;
  800.     }
  801.     return pack_float(x, p, 1);
  802. }
  803.  
  804. static int
  805. bp_double(p, v, f)
  806.     char *p;
  807.     PyObject *v;
  808.     const formatdef *f;
  809. {
  810.     double x = PyFloat_AsDouble(v);
  811.     if (x == -1 && PyErr_Occurred()) {
  812.         PyErr_SetString(StructError,
  813.                 "required argument is not a float");
  814.         return -1;
  815.     }
  816.     return pack_double(x, p, 1);
  817. }
  818.  
  819. static formatdef bigendian_table[] = {
  820.     {'x',    1,        0,        NULL},
  821.     {'b',    1,        0,        bu_int,        bp_int},
  822.     {'B',    1,        0,        bu_uint,    bp_int},
  823.     {'c',    1,        0,        nu_char,    np_char},
  824.     {'s',    1,        0,        NULL},
  825.     {'p',    1,        0,        NULL},
  826.     {'h',    2,        0,        bu_int,        bp_int},
  827.     {'H',    2,        0,        bu_uint,    bp_uint},
  828.     {'i',    4,        0,        bu_int,        bp_int},
  829.     {'I',    4,        0,        bu_uint,    bp_uint},
  830.     {'l',    4,        0,        bu_int,        bp_int},
  831.     {'L',    4,        0,        bu_uint,    bp_uint},
  832.     {'f',    4,        0,        bu_float,    bp_float},
  833.     {'d',    8,        0,        bu_double,    bp_double},
  834.     {0}
  835. };
  836.  
  837. static PyObject *
  838. lu_int(p, f)
  839.     const char *p;
  840.     const formatdef *f;
  841. {
  842.     long x = 0;
  843.     int i = f->size;
  844.     do {
  845.         x = (x<<8) | (p[--i] & 0xFF);
  846.     } while (i > 0);
  847.     i = 8*(sizeof(long) - f->size);
  848.     if (i) {
  849.         x <<= i;
  850.         x >>= i;
  851.     }
  852.     return PyInt_FromLong(x);
  853. }
  854.  
  855. static PyObject *
  856. lu_uint(p, f)
  857.     const char *p;
  858.     const formatdef *f;
  859. {
  860.     unsigned long x = 0;
  861.     int i = f->size;
  862.     do {
  863.         x = (x<<8) | (p[--i] & 0xFF);
  864.     } while (i > 0);
  865.     if (f->size >= 4)
  866.         return PyLong_FromUnsignedLong(x);
  867.     else
  868.         return PyInt_FromLong((long)x);
  869. }
  870.  
  871. static PyObject *
  872. lu_float(p, f)
  873.     const char *p;
  874.     const formatdef *f;
  875. {
  876.     return unpack_float(p+3, -1);
  877. }
  878.  
  879. static PyObject *
  880. lu_double(p, f)
  881.     const char *p;
  882.     const formatdef *f;
  883. {
  884.     return unpack_double(p+7, -1);
  885. }
  886.  
  887. static int
  888. lp_int(p, v, f)
  889.     char *p;
  890.     PyObject *v;
  891.     const formatdef *f;
  892. {
  893.     long x;
  894.     int i;
  895.     if (get_long(v, &x) < 0)
  896.         return -1;
  897.     i = f->size;
  898.     do {
  899.         *p++ = (char)x;
  900.         x >>= 8;
  901.     } while (--i > 0);
  902.     return 0;
  903. }
  904.  
  905. static int
  906. lp_uint(p, v, f)
  907.     char *p;
  908.     PyObject *v;
  909.     const formatdef *f;
  910. {
  911.     unsigned long x;
  912.     int i;
  913.     if (get_ulong(v, &x) < 0)
  914.         return -1;
  915.     i = f->size;
  916.     do {
  917.         *p++ = (char)x;
  918.         x >>= 8;
  919.     } while (--i > 0);
  920.     return 0;
  921. }
  922.  
  923. static int
  924. lp_float(p, v, f)
  925.     char *p;
  926.     PyObject *v;
  927.     const formatdef *f;
  928. {
  929.     double x = PyFloat_AsDouble(v);
  930.     if (x == -1 && PyErr_Occurred()) {
  931.         PyErr_SetString(StructError,
  932.                 "required argument is not a float");
  933.         return -1;
  934.     }
  935.     return pack_float(x, p+3, -1);
  936. }
  937.  
  938. static int
  939. lp_double(p, v, f)
  940.     char *p;
  941.     PyObject *v;
  942.     const formatdef *f;
  943. {
  944.     double x = PyFloat_AsDouble(v);
  945.     if (x == -1 && PyErr_Occurred()) {
  946.         PyErr_SetString(StructError,
  947.                 "required argument is not a float");
  948.         return -1;
  949.     }
  950.     return pack_double(x, p+7, -1);
  951. }
  952.  
  953. static formatdef lilendian_table[] = {
  954.     {'x',    1,        0,        NULL},
  955.     {'b',    1,        0,        lu_int,        lp_int},
  956.     {'B',    1,        0,        lu_uint,    lp_int},
  957.     {'c',    1,        0,        nu_char,    np_char},
  958.     {'s',    1,        0,        NULL},
  959.     {'p',    1,        0,        NULL},
  960.     {'h',    2,        0,        lu_int,        lp_int},
  961.     {'H',    2,        0,        lu_uint,    lp_uint},
  962.     {'i',    4,        0,        lu_int,        lp_int},
  963.     {'I',    4,        0,        lu_uint,    lp_uint},
  964.     {'l',    4,        0,        lu_int,        lp_int},
  965.     {'L',    4,        0,        lu_uint,    lp_uint},
  966.     {'f',    4,        0,        lu_float,    lp_float},
  967.     {'d',    8,        0,        lu_double,    lp_double},
  968.     {0}
  969. };
  970.  
  971.  
  972. static const formatdef *
  973. whichtable(pfmt)
  974.     const char **pfmt;
  975. {
  976.     const char *fmt = (*pfmt)++; /* May be backed out of later */
  977.     switch (*fmt) {
  978.     case '<':
  979.         return lilendian_table;
  980.     case '>':
  981.     case '!': /* Network byte order is big-endian */
  982.         return bigendian_table;
  983.     case '=': { /* Host byte order -- different from native in aligment! */
  984.         int n = 1;
  985.         char *p = (char *) &n;
  986.         if (*p == 1)
  987.             return lilendian_table;
  988.         else
  989.             return bigendian_table;
  990.     }
  991.     default:
  992.         --*pfmt; /* Back out of pointer increment */
  993.         /* Fall through */
  994.     case '@':
  995.         return native_table;
  996.     }
  997. }
  998.  
  999.  
  1000. /* Get the table entry for a format code */
  1001.  
  1002. static const formatdef *
  1003. getentry(c, f)
  1004.     int c;
  1005.     const formatdef *f;
  1006. {
  1007.     for (; f->format != '\0'; f++) {
  1008.         if (f->format == c) {
  1009.             return f;
  1010.         }
  1011.     }
  1012.     PyErr_SetString(StructError, "bad char in struct format");
  1013.     return NULL;
  1014. }
  1015.  
  1016.  
  1017. /* Align a size according to a format code */
  1018.  
  1019. static int
  1020. align(size, c, e)
  1021.     int size;
  1022.     int c;
  1023.     const formatdef *e;
  1024. {
  1025.     if (e->format == c) {
  1026.         if (e->alignment) {
  1027.             size = ((size + e->alignment - 1)
  1028.                 / e->alignment)
  1029.                 * e->alignment;
  1030.         }
  1031.     }
  1032.     return size;
  1033. }
  1034.  
  1035.  
  1036. /* calculate the size of a format string */
  1037.  
  1038. static int
  1039. calcsize(fmt, f)
  1040.     const char *fmt;
  1041.     const formatdef *f;
  1042. {
  1043.     const formatdef *e;
  1044.     const char *s;
  1045.     char c;
  1046.     int size,  num, itemsize, x;
  1047.  
  1048.     s = fmt;
  1049.     size = 0;
  1050.     while ((c = *s++) != '\0') {
  1051.         if (isspace((int)c))
  1052.             continue;
  1053.         if ('0' <= c && c <= '9') {
  1054.             num = c - '0';
  1055.             while ('0' <= (c = *s++) && c <= '9') {
  1056.                 x = num*10 + (c - '0');
  1057.                 if (x/10 != num) {
  1058.                     PyErr_SetString(
  1059.                         StructError,
  1060.                         "overflow in item count");
  1061.                     return -1;
  1062.                 }
  1063.                 num = x;
  1064.             }
  1065.             if (c == '\0')
  1066.                 break;
  1067.         }
  1068.         else
  1069.             num = 1;
  1070.         
  1071.         e = getentry(c, f);
  1072.         if (e == NULL)
  1073.             return -1;
  1074.         itemsize = e->size;
  1075.         size = align(size, c, e);
  1076.         x = num * itemsize;
  1077.         size += x;
  1078.         if (x/itemsize != num || size < 0) {
  1079.             PyErr_SetString(StructError,
  1080.                                         "total struct size too long");
  1081.             return -1;
  1082.         }
  1083.     }
  1084.  
  1085.     return size;
  1086. }
  1087.  
  1088.  
  1089. static char calcsize__doc__[] = "\
  1090. calcsize(fmt) -> int\n\
  1091. Return size of C struct described by format string fmt.\n\
  1092. See struct.__doc__ for more on format strings.";
  1093.  
  1094. static PyObject *
  1095. struct_calcsize(self, args)
  1096.     PyObject *self; /* Not used */
  1097.     PyObject *args;
  1098. {
  1099.     char *fmt;
  1100.     const formatdef *f;
  1101.     int size;
  1102.  
  1103.     if (!PyArg_ParseTuple(args, "s", &fmt))
  1104.         return NULL;
  1105.     f = whichtable(&fmt);
  1106.     size = calcsize(fmt, f);
  1107.     if (size < 0)
  1108.         return NULL;
  1109.     return PyInt_FromLong((long)size);
  1110. }
  1111.  
  1112.  
  1113. static char pack__doc__[] = "\
  1114. pack(fmt, v1, v2, ...) -> string\n\
  1115. Return string containing values v1, v2, ... packed according to fmt.\n\
  1116. See struct.__doc__ for more on format strings.";
  1117.  
  1118. static PyObject *
  1119. struct_pack(self, args)
  1120.     PyObject *self; /* Not used */
  1121.     PyObject *args;
  1122. {
  1123.     const formatdef *f, *e;
  1124.     PyObject *format, *result, *v;
  1125.     char *fmt;
  1126.     int size, num;
  1127.     int i, n;
  1128.     char *s, *res, *restart, *nres;
  1129.     char c;
  1130.  
  1131.     if (args == NULL || !PyTuple_Check(args) ||
  1132.         (n = PyTuple_Size(args)) < 1)
  1133.         {
  1134.         PyErr_BadArgument();
  1135.         return NULL;
  1136.     }
  1137.     format = PyTuple_GetItem(args, 0);
  1138.     if (!PyArg_Parse(format, "s", &fmt))
  1139.         return NULL;
  1140.     f = whichtable(&fmt);
  1141.     size = calcsize(fmt, f);
  1142.     if (size < 0)
  1143.         return NULL;
  1144.     result = PyString_FromStringAndSize((char *)NULL, size);
  1145.     if (result == NULL)
  1146.         return NULL;
  1147.  
  1148.     s = fmt;
  1149.     i = 1;
  1150.     res = restart = PyString_AsString(result);
  1151.  
  1152.     while ((c = *s++) != '\0') {
  1153.         if (isspace((int)c))
  1154.             continue;
  1155.         if ('0' <= c && c <= '9') {
  1156.             num = c - '0';
  1157.             while ('0' <= (c = *s++) && c <= '9')
  1158.                    num = num*10 + (c - '0');
  1159.             if (c == '\0')
  1160.                 break;
  1161.         }
  1162.         else
  1163.             num = 1;
  1164.  
  1165.         e = getentry(c, f);
  1166.         if (e == NULL)
  1167.             goto fail;
  1168.         nres = restart + align((int)(res-restart), c, e);
  1169.         /* Fill padd bytes with zeros */
  1170.         while (res < nres)
  1171.             *res++ = '\0';
  1172.         if (num == 0 && c != 's')
  1173.             continue;
  1174.         do {
  1175.             if (c == 'x') {
  1176.                 /* doesn't consume arguments */
  1177.                 memset(res, '\0', num);
  1178.                 res += num;
  1179.                 break;
  1180.             }
  1181.             if (i >= n) {
  1182.                 PyErr_SetString(StructError,
  1183.                     "insufficient arguments to pack");
  1184.                 goto fail;
  1185.                 }
  1186.             v = PyTuple_GetItem(args, i++);
  1187.             if (v == NULL)
  1188.                 goto fail;
  1189.             if (c == 's') {
  1190.                 /* num is string size, not repeat count */
  1191.                 int n;
  1192.                 if (!PyString_Check(v)) {
  1193.                     PyErr_SetString(StructError,
  1194.                       "argument for 's' must be a string");
  1195.                     goto fail;
  1196.                 }
  1197.                 n = PyString_Size(v);
  1198.                 if (n > num)
  1199.                     n = num;
  1200.                 if (n > 0)
  1201.                     memcpy(res, PyString_AsString(v), n);
  1202.                 if (n < num)
  1203.                     memset(res+n, '\0', num-n);
  1204.                 res += num;
  1205.                 break;
  1206.             }
  1207.             else if (c == 'p') {
  1208.                 /* num is string size + 1,
  1209.                    to fit in the count byte */
  1210.                 int n;
  1211.                 num--; /* now num is max string size */
  1212.                 if (!PyString_Check(v)) {
  1213.                     PyErr_SetString(StructError,
  1214.                       "argument for 'p' must be a string");
  1215.                     goto fail;
  1216.                 }
  1217.                 n = PyString_Size(v);
  1218.                 if (n > num)
  1219.                     n = num;
  1220.                 if (n > 0)
  1221.                     memcpy(res+1, PyString_AsString(v), n);
  1222.                 if (n < num)
  1223.                     /* no real need, just to be nice */
  1224.                     memset(res+1+n, '\0', num-n);
  1225.                 *res++ = n; /* store the length byte */
  1226.                 res += num;
  1227.                 break;
  1228.             }
  1229.             else {
  1230.                 if (e->pack(res, v, e) < 0)
  1231.                     goto fail;
  1232.                 res += e->size;
  1233.             }
  1234.         } while (--num > 0);
  1235.     }
  1236.  
  1237.     if (i < n) {
  1238.         PyErr_SetString(StructError,
  1239.                 "too many arguments for pack format");
  1240.         goto fail;
  1241.     }
  1242.  
  1243.     return result;
  1244.  
  1245.  fail:
  1246.     Py_DECREF(result);
  1247.     return NULL;
  1248. }
  1249.  
  1250.  
  1251. static char unpack__doc__[] = "\
  1252. unpack(fmt, string) -> (v1, v2, ...)\n\
  1253. Unpack the string, containing packed C structure data, according\n\
  1254. to fmt.  Requires len(string)==calcsize(fmt).\n\
  1255. See struct.__doc__ for more on format strings.";
  1256.  
  1257. static PyObject *
  1258. struct_unpack(self, args)
  1259.     PyObject *self; /* Not used */
  1260.     PyObject *args;
  1261. {
  1262.     const formatdef *f, *e;
  1263.     char *str, *start, *fmt, *s;
  1264.     char c;
  1265.     int len, size, num;
  1266.     PyObject *res, *v;
  1267.  
  1268.     if (!PyArg_ParseTuple(args, "ss#", &fmt, &start, &len))
  1269.         return NULL;
  1270.     f = whichtable(&fmt);
  1271.     size = calcsize(fmt, f);
  1272.     if (size < 0)
  1273.         return NULL;
  1274.     if (size != len) {
  1275.         PyErr_SetString(StructError,
  1276.                 "unpack str size does not match format");
  1277.         return NULL;
  1278.     }
  1279.     res = PyList_New(0);
  1280.     if (res == NULL)
  1281.         return NULL;
  1282.     str = start;
  1283.     s = fmt;
  1284.     while ((c = *s++) != '\0') {
  1285.         if (isspace((int)c))
  1286.             continue;
  1287.         if ('0' <= c && c <= '9') {
  1288.             num = c - '0';
  1289.             while ('0' <= (c = *s++) && c <= '9')
  1290.                    num = num*10 + (c - '0');
  1291.             if (c == '\0')
  1292.                 break;
  1293.         }
  1294.         else
  1295.             num = 1;
  1296.  
  1297.         e = getentry(c, f);
  1298.         if (e == NULL)
  1299.             goto fail;
  1300.         str = start + align((int)(str-start), c, e);
  1301.         if (num == 0 && c != 's')
  1302.             continue;
  1303.  
  1304.         do {
  1305.             if (c == 'x') {
  1306.                 str += num;
  1307.                 break;
  1308.             }
  1309.             if (c == 's') {
  1310.                 /* num is string size, not repeat count */
  1311.                 v = PyString_FromStringAndSize(str, num);
  1312.                 if (v == NULL)
  1313.                     goto fail;
  1314.                 str += num;
  1315.                 num = 0;
  1316.             }
  1317.             else if (c == 'p') {
  1318.                 /* num is string buffer size,
  1319.                    not repeat count */
  1320.                 int n = *(unsigned char*)str;
  1321.                 /* first byte (unsigned) is string size */
  1322.                 if (n >= num)
  1323.                     n = num-1;
  1324.                 v = PyString_FromStringAndSize(str+1, n);
  1325.                 if (v == NULL)
  1326.                     goto fail;
  1327.                 str += num;
  1328.                 num = 0;
  1329.             }
  1330.             else {
  1331.                 v = e->unpack(str, e);
  1332.                 if (v == NULL)
  1333.                     goto fail;
  1334.                 str += e->size;
  1335.             }
  1336.             if (v == NULL || PyList_Append(res, v) < 0)
  1337.                 goto fail;
  1338.             Py_DECREF(v);
  1339.         } while (--num > 0);
  1340.     }
  1341.  
  1342.     v = PyList_AsTuple(res);
  1343.     Py_DECREF(res);
  1344.     return v;
  1345.  
  1346.  fail:
  1347.     Py_DECREF(res);
  1348.     return NULL;
  1349. }
  1350.  
  1351.  
  1352. /* List of functions */
  1353.  
  1354. static PyMethodDef struct_methods[] = {
  1355.     {"calcsize",    struct_calcsize,    METH_VARARGS, calcsize__doc__},
  1356.     {"pack",    struct_pack,        METH_VARARGS, pack__doc__},
  1357.     {"unpack",    struct_unpack,        METH_VARARGS, unpack__doc__},
  1358.     {NULL,        NULL}        /* sentinel */
  1359. };
  1360.  
  1361.  
  1362. /* Module initialization */
  1363.  
  1364. DL_EXPORT(void)
  1365. initstruct()
  1366. {
  1367.     PyObject *m, *d;
  1368.  
  1369.     /* Create the module and add the functions */
  1370.     m = Py_InitModule4("struct", struct_methods, struct__doc__,
  1371.                (PyObject*)NULL, PYTHON_API_VERSION);
  1372.  
  1373.     /* Add some symbolic constants to the module */
  1374.     d = PyModule_GetDict(m);
  1375.     StructError = PyErr_NewException("struct.error", NULL, NULL);
  1376.     if (StructError == NULL)
  1377.         return;
  1378.     PyDict_SetItemString(d, "error", StructError);
  1379. }
  1380.