summaryrefslogtreecommitdiff
path: root/ipl/cfuncs/pack.c
blob: 60160cc9720b58c18f9e7d941dc3037fe17763c9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
/*
############################################################################
#
#	File:     pack.c
#
#	Subject:  Functions to pack and unpack binary data
#
#	Author:   Gregg M. Townsend
#
#	Date:     November 17, 1997
#
############################################################################
#
#   This file is in the public domain.
#
############################################################################
#
#  s := pack(value, flags, width)
#  x := unpack(string, flags)
#
#  Flag characters are as follows:
#
#     l -- little-endian [default]
#     b -- big-endian
#     n -- host platform's native packing order
#
#     i -- integer [default]
#     u -- unsigned integer
#     r -- real (host platform's native float or double format)
#
#  The default width is 4.
#
#  Integer values must fit in a standard Icon integer (not large integer).
#  Consequently, a word-sized value cannot have the high bit set if unsigned.
#  Floating values can only be converted to/from a string width matching
#  sizeof(float) or sizeof(double).
#
#  Size/type combinations that can't be handled produce errors.
#  Valid combinations produce failure if the value overflows.
#
#  Some of this code assumes a twos-complement architecture with 8-bit bytes.
#
############################################################################
#
#  Requires:  Dynamic loading
#
############################################################################
*/

#include "icall.h"
#include <string.h>

#define F_LTL 0x100	/* little-endian */
#define F_BIG 0x200	/* big-endian */
#define F_REV 0x400	/* internal flag: reversal needed */

#define F_INT 1		/* integer */
#define F_UNS 2		/* unsigned integer */
#define F_REAL 4	/* real */

#define DEF_WIDTH 4	/* default width */
#define MAX_WIDTH 256	/* maximum width */

static unsigned long testval = 1;
#define LNATIVE (*(char*)&testval)	/* true if machine is little-endian */

static int flags(char *s, int n);
static void *memrev(void *s1, void *s2, size_t n);

/*
 * pack(value, flags, width)
 */
int pack(int argc, descriptor argv[])	/*: pack integer into bytes */
   {
   int f, i, n, x;
   long v;
   unsigned char *s, obuf[MAX_WIDTH];
   union { float f; double d; unsigned char buf[MAX_WIDTH]; } u;

   /*
    * check arguments
    */
   if (argc == 0)
      Error(102);			/* no value given */

   if (argc > 1) {
      ArgString(2);
      if ((f = flags(StringAddr(argv[2]), StringLen(argv[2]))) == 0)
         ArgError(2, 205);		/* illegal flag string */
      }
   else
      f = flags("", 0);

   if (argc > 2) {
      ArgInteger(3);
      n = IntegerVal(argv[3]);
      if (n < 0 || n > MAX_WIDTH)
         ArgError(3, 205);		/* too long to handle */
      }
   else
      n = DEF_WIDTH;

   if (f & F_REAL) {

      /*
       * pack real value
       */
      ArgReal(1);
      if (n == sizeof(double))
         u.d = RealVal(argv[1]);
      else if (n == sizeof(float))
         u.f = RealVal(argv[1]);
      else
         ArgError(3, 205);		/* illegal length for real value */

      if (f & F_REV)
         RetStringN(memrev(obuf, u.buf, n), n);
      else
         RetStringN((char *)u.buf, n);
      }

   /*
    * pack integer value
    */
   ArgInteger(1);
   v = IntegerVal(argv[1]);		/* value */

   if (v >= 0)
      x = 0;				/* sign extension byte */
   else if (f & F_UNS)
      Fail;				/* invalid unsigned value */
   else
      x = (unsigned char) -1;

   for (s = obuf, i = 0; i < sizeof(long); i++)  {
      *s++ = v & 0xFF;			/* save in little-endian fashion */
      v = ((unsigned long)v) >> 8;
      }
   while (i++ < n)
      *s++ = x;				/* extend if > sizeof(long) */

   for (i = n; i < sizeof(long); i++)	/* check that all bits did fit */
      if (obuf[i] != x)
         Fail;				/* overflow */

   if (f & F_BIG)
      RetStringN(memrev(u.buf, obuf, n), n);
   else
      RetStringN((char *)obuf, n);
   }

/*
 * unpack(string, flags)
 */
int unpack(int argc, descriptor argv[])	/*: unpack integer from bytes */
   {
   int f, i, n, x;
   long v;
   unsigned char *s;
   union { float f; double d; unsigned char buf[MAX_WIDTH]; } u;

   /*
    * check arguments
    */
   ArgString(1);
   s = (unsigned char *)StringAddr(argv[1]);
   n = StringLen(argv[1]);
   if (n > MAX_WIDTH)
      ArgError(1, 205);			/* too long to handle */

   if (argc > 1) {
      ArgString(2);
      if ((f = flags(StringAddr(argv[2]), StringLen(argv[2]))) == 0)
         ArgError(2, 205);		/* illegal flag string */
      }
   else
      f = flags("", 0);

   if (f & F_REAL) {
      /*
       * unpack real value
       */
      if (f & F_REV)
         memrev(u.buf, s, n);
      else
         memcpy(u.buf, s, n);

      if (n == sizeof(double))
         RetReal(u.d);
      else if (n == sizeof(float))
         RetReal(u.f);
      else
         ArgError(1, 205);		/* illegal length for real value */
      }

   /*
    * unpack integer value
    */
   if (f & F_BIG)
      s = memrev(u.buf, s, n);		/* put in little-endian order */
   for (v = i = 0; i < n && i < sizeof(long); i++)
      v |= *s++ << (8 * i);		/* pack into a long */

   if (v >= 0)
      x = 0;				/* sign extension byte */
   else if (f & F_UNS)
      Fail;				/* value overflows as unsigned */
   else
      x = (unsigned char) -1;

   for (; i < n; i++)			/* check bytes beyond sizeof(long) */
      if (*s++ != x)
         Fail;				/* value overflows a long */

   RetInteger(v);			/* return value */
   }


/*
 * flags(addr, len) -- interpret flag string, return 0 if error
 */
static int flags(char *s, int n)
   {
   int f = 0;

   while (n--) switch(*s++) {
      case 'l':  f |= F_LTL;				break;
      case 'b':  f |= F_BIG;				break;
      case 'n':  f |= (LNATIVE ? F_LTL : F_BIG);	break;
      case 'i':  f |= F_INT;				break;
      case 'u':  f |= F_UNS + F_INT;			break;
      case 'r':  f |= F_REAL;				break;
      default:	 return 0;
      }

   if (((f & F_LTL) && (f & F_BIG)) | ((f & F_INT) && (f & F_REAL)))
      return 0;				/* illegal conflict */

   if (!(f & F_BIG))
      f |= F_LTL;			/* default packing is little-endian */
   if (!(f & F_REAL))
      f |= F_INT;			/* default type is integer */

   if (f & (LNATIVE ? F_BIG : F_LTL))
      f |= F_REV;			/* set flag if non-native mode */

   return f;
   }


/*
 * memrev(s1, s2, n) -- copy reversal of s2 into s1, returning s1
 */
static void *memrev(void *s1, void *s2, size_t n)
   {
   unsigned char *c1 = s1;
   unsigned char *c2 = (unsigned char *)s2 + n;
   while (n-- > 0)
      *c1++ = *--c2;
   return s1;
   }