Portability fixes for popen.test (for when /bin/sh is not bash)
[bpt/guile.git] / libguile / bytevectors.c
CommitLineData
4a655e50 1/* Copyright (C) 2009, 2010, 2011 Free Software Foundation, Inc.
1ee2c72e
LC
2 *
3 * This library is free software; you can redistribute it and/or
53befeb7
NJ
4 * modify it under the terms of the GNU Lesser General Public License
5 * as published by the Free Software Foundation; either version 3 of
6 * the License, or (at your option) any later version.
1ee2c72e 7 *
53befeb7
NJ
8 * This library is distributed in the hope that it will be useful, but
9 * WITHOUT ANY WARRANTY; without even the implied warranty of
1ee2c72e
LC
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 * Lesser General Public License for more details.
12 *
13 * You should have received a copy of the GNU Lesser General Public
14 * License along with this library; if not, write to the Free Software
53befeb7
NJ
15 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
16 * 02110-1301 USA
1ee2c72e
LC
17 */
18
19
20#ifdef HAVE_CONFIG_H
21# include <config.h>
22#endif
23
24#include <alloca.h>
f5a51cae 25#include <assert.h>
1ee2c72e
LC
26
27#include <gmp.h>
28
29#include "libguile/_scm.h"
cfb4702f 30#include "libguile/extensions.h"
1ee2c72e
LC
31#include "libguile/bytevectors.h"
32#include "libguile/strings.h"
33#include "libguile/validate.h"
34#include "libguile/ieee-754.h"
2fa901a5 35#include "libguile/arrays.h"
2a610be5 36#include "libguile/array-handle.h"
476b894c 37#include "libguile/uniform.h"
782a82ee 38#include "libguile/srfi-4.h"
1ee2c72e
LC
39
40#include <byteswap.h>
41#include <striconveh.h>
42#include <uniconv.h>
3a5bc4fa 43#include <unistr.h>
1ee2c72e
LC
44
45#ifdef HAVE_LIMITS_H
46# include <limits.h>
47#else
48/* Assuming 32-bit longs. */
49# define ULONG_MAX 4294967295UL
50#endif
51
52#include <string.h>
53
54
55\f
56/* Utilities. */
57
58/* Convenience macros. These are used by the various templates (macros) that
59 are parameterized by integer signedness. */
60#define INT8_T_signed scm_t_int8
61#define INT8_T_unsigned scm_t_uint8
62#define INT16_T_signed scm_t_int16
63#define INT16_T_unsigned scm_t_uint16
64#define INT32_T_signed scm_t_int32
65#define INT32_T_unsigned scm_t_uint32
66#define is_signed_int8(_x) (((_x) >= -128L) && ((_x) <= 127L))
67#define is_unsigned_int8(_x) ((_x) <= 255UL)
68#define is_signed_int16(_x) (((_x) >= -32768L) && ((_x) <= 32767L))
69#define is_unsigned_int16(_x) ((_x) <= 65535UL)
70#define is_signed_int32(_x) (((_x) >= -2147483648L) && ((_x) <= 2147483647L))
71#define is_unsigned_int32(_x) ((_x) <= 4294967295UL)
72#define SIGNEDNESS_signed 1
73#define SIGNEDNESS_unsigned 0
74
75#define INT_TYPE(_size, _sign) INT ## _size ## _T_ ## _sign
76#define INT_SWAP(_size) bswap_ ## _size
77#define INT_VALID_P(_size, _sign) is_ ## _sign ## _int ## _size
78#define SIGNEDNESS(_sign) SIGNEDNESS_ ## _sign
79
80
81#define INTEGER_ACCESSOR_PROLOGUE(_len, _sign) \
2d34e924 82 size_t c_len, c_index; \
1ee2c72e
LC
83 _sign char *c_bv; \
84 \
85 SCM_VALIDATE_BYTEVECTOR (1, bv); \
86 c_index = scm_to_uint (index); \
87 \
88 c_len = SCM_BYTEVECTOR_LENGTH (bv); \
89 c_bv = (_sign char *) SCM_BYTEVECTOR_CONTENTS (bv); \
90 \
91 if (SCM_UNLIKELY (c_index + ((_len) >> 3UL) - 1 >= c_len)) \
92 scm_out_of_range (FUNC_NAME, index);
93
94/* Template for fixed-size integer access (only 8, 16 or 32-bit). */
caa92f5e
AW
95#define INTEGER_REF(_len, _sign) \
96 SCM result; \
97 \
98 INTEGER_ACCESSOR_PROLOGUE (_len, _sign); \
99 SCM_VALIDATE_SYMBOL (3, endianness); \
100 \
101 { \
102 INT_TYPE (_len, _sign) c_result; \
103 \
104 memcpy (&c_result, &c_bv[c_index], (_len) / 8); \
105 if (!scm_is_eq (endianness, scm_i_native_endianness)) \
106 c_result = INT_SWAP (_len) (c_result); \
107 \
108 result = SCM_I_MAKINUM (c_result); \
109 } \
110 \
1ee2c72e
LC
111 return result;
112
113/* Template for fixed-size integer access using the native endianness. */
114#define INTEGER_NATIVE_REF(_len, _sign) \
115 SCM result; \
116 \
117 INTEGER_ACCESSOR_PROLOGUE (_len, _sign); \
118 \
119 { \
120 INT_TYPE (_len, _sign) c_result; \
121 \
122 memcpy (&c_result, &c_bv[c_index], (_len) / 8); \
123 result = SCM_I_MAKINUM (c_result); \
124 } \
125 \
126 return result;
127
128/* Template for fixed-size integer modification (only 8, 16 or 32-bit). */
129#define INTEGER_SET(_len, _sign) \
130 INTEGER_ACCESSOR_PROLOGUE (_len, _sign); \
131 SCM_VALIDATE_SYMBOL (3, endianness); \
132 \
133 { \
e25f3727 134 scm_t_signed_bits c_value; \
1ee2c72e
LC
135 INT_TYPE (_len, _sign) c_value_short; \
136 \
137 if (SCM_UNLIKELY (!SCM_I_INUMP (value))) \
138 scm_wrong_type_arg (FUNC_NAME, 3, value); \
139 \
140 c_value = SCM_I_INUM (value); \
141 if (SCM_UNLIKELY (!INT_VALID_P (_len, _sign) (c_value))) \
142 scm_out_of_range (FUNC_NAME, value); \
143 \
144 c_value_short = (INT_TYPE (_len, _sign)) c_value; \
caa92f5e 145 if (!scm_is_eq (endianness, scm_i_native_endianness)) \
1ee2c72e
LC
146 c_value_short = INT_SWAP (_len) (c_value_short); \
147 \
148 memcpy (&c_bv[c_index], &c_value_short, (_len) / 8); \
149 } \
150 \
151 return SCM_UNSPECIFIED;
152
153/* Template for fixed-size integer modification using the native
154 endianness. */
155#define INTEGER_NATIVE_SET(_len, _sign) \
156 INTEGER_ACCESSOR_PROLOGUE (_len, _sign); \
157 \
158 { \
e25f3727 159 scm_t_signed_bits c_value; \
1ee2c72e
LC
160 INT_TYPE (_len, _sign) c_value_short; \
161 \
162 if (SCM_UNLIKELY (!SCM_I_INUMP (value))) \
163 scm_wrong_type_arg (FUNC_NAME, 3, value); \
164 \
165 c_value = SCM_I_INUM (value); \
166 if (SCM_UNLIKELY (!INT_VALID_P (_len, _sign) (c_value))) \
167 scm_out_of_range (FUNC_NAME, value); \
168 \
169 c_value_short = (INT_TYPE (_len, _sign)) c_value; \
170 \
171 memcpy (&c_bv[c_index], &c_value_short, (_len) / 8); \
172 } \
173 \
174 return SCM_UNSPECIFIED;
175
176
177\f
178/* Bytevector type. */
179
0665b3ff
LC
180#define SCM_BYTEVECTOR_HEADER_BYTES \
181 (SCM_BYTEVECTOR_HEADER_SIZE * sizeof (SCM))
182
f332089e 183#define SCM_BYTEVECTOR_SET_LENGTH(_bv, _len) \
807e5a66 184 SCM_SET_CELL_WORD_1 ((_bv), (scm_t_bits) (_len))
3fe87cf7
LC
185#define SCM_BYTEVECTOR_SET_CONTENTS(_bv, _contents) \
186 SCM_SET_CELL_WORD_2 ((_bv), (scm_t_bits) (_contents))
187#define SCM_BYTEVECTOR_SET_CONTIGUOUS_P(bv, contiguous_p) \
188 SCM_SET_BYTEVECTOR_FLAGS ((bv), \
189 SCM_BYTEVECTOR_ELEMENT_TYPE (bv) \
190 | ((contiguous_p) << 8UL))
191
192#define SCM_BYTEVECTOR_SET_ELEMENT_TYPE(bv, hint) \
193 SCM_SET_BYTEVECTOR_FLAGS ((bv), \
194 (hint) \
195 | (SCM_BYTEVECTOR_CONTIGUOUS_P (bv) << 8UL))
e286c973
AW
196#define SCM_BYTEVECTOR_TYPE_SIZE(var) \
197 (scm_i_array_element_type_sizes[SCM_BYTEVECTOR_ELEMENT_TYPE (var)]/8)
198#define SCM_BYTEVECTOR_TYPED_LENGTH(var) \
3fe87cf7 199 (SCM_BYTEVECTOR_LENGTH (var) / SCM_BYTEVECTOR_TYPE_SIZE (var))
1ee2c72e
LC
200
201/* The empty bytevector. */
202SCM scm_null_bytevector = SCM_UNSPECIFIED;
203
204
205static inline SCM
0665b3ff 206make_bytevector (size_t len, scm_t_array_element_type element_type)
1ee2c72e 207{
f332089e 208 SCM ret;
e286c973 209 size_t c_len;
0665b3ff 210
e286c973
AW
211 if (SCM_UNLIKELY (element_type > SCM_ARRAY_ELEMENT_TYPE_LAST
212 || scm_i_array_element_type_sizes[element_type] < 8
213 || len >= (SCM_I_SIZE_MAX
214 / (scm_i_array_element_type_sizes[element_type]/8))))
215 /* This would be an internal Guile programming error */
216 abort ();
0665b3ff
LC
217
218 if (SCM_UNLIKELY (len == 0 && element_type == SCM_ARRAY_ELEMENT_TYPE_VU8
219 && SCM_BYTEVECTOR_P (scm_null_bytevector)))
220 ret = scm_null_bytevector;
f332089e
AW
221 else
222 {
3fe87cf7
LC
223 signed char *contents;
224
0665b3ff
LC
225 c_len = len * (scm_i_array_element_type_sizes[element_type] / 8);
226
3fe87cf7
LC
227 contents = scm_gc_malloc_pointerless (SCM_BYTEVECTOR_HEADER_BYTES + c_len,
228 SCM_GC_BYTEVECTOR);
229 ret = PTR2SCM (contents);
230 contents += SCM_BYTEVECTOR_HEADER_BYTES;
0665b3ff 231
0665b3ff 232 SCM_BYTEVECTOR_SET_LENGTH (ret, c_len);
3fe87cf7
LC
233 SCM_BYTEVECTOR_SET_CONTENTS (ret, contents);
234 SCM_BYTEVECTOR_SET_CONTIGUOUS_P (ret, 1);
0665b3ff 235 SCM_BYTEVECTOR_SET_ELEMENT_TYPE (ret, element_type);
f332089e 236 }
0665b3ff 237
f332089e 238 return ret;
1ee2c72e
LC
239}
240
0665b3ff 241/* Return a bytevector of LEN elements of type ELEMENT_TYPE, with element
3fe87cf7
LC
242 values taken from CONTENTS. Assume that the storage for CONTENTS will be
243 automatically reclaimed when it becomes unreachable. */
1ee2c72e 244static inline SCM
0665b3ff
LC
245make_bytevector_from_buffer (size_t len, void *contents,
246 scm_t_array_element_type element_type)
1ee2c72e 247{
0665b3ff 248 SCM ret;
1ee2c72e 249
3fe87cf7
LC
250 if (SCM_UNLIKELY (len == 0))
251 ret = make_bytevector (len, element_type);
252 else
1ee2c72e 253 {
0665b3ff
LC
254 size_t c_len;
255
3fe87cf7
LC
256 ret = PTR2SCM (scm_gc_malloc (SCM_BYTEVECTOR_HEADER_BYTES,
257 SCM_GC_BYTEVECTOR));
258
0665b3ff 259 c_len = len * (scm_i_array_element_type_sizes[element_type] / 8);
0665b3ff 260
3fe87cf7
LC
261 SCM_BYTEVECTOR_SET_LENGTH (ret, c_len);
262 SCM_BYTEVECTOR_SET_CONTENTS (ret, contents);
263 SCM_BYTEVECTOR_SET_CONTIGUOUS_P (ret, 0);
264 SCM_BYTEVECTOR_SET_ELEMENT_TYPE (ret, element_type);
1ee2c72e 265 }
0665b3ff
LC
266
267 return ret;
1ee2c72e
LC
268}
269
0665b3ff 270
1ee2c72e
LC
271/* Return a new bytevector of size LEN octets. */
272SCM
2d34e924 273scm_c_make_bytevector (size_t len)
1ee2c72e 274{
e286c973
AW
275 return make_bytevector (len, SCM_ARRAY_ELEMENT_TYPE_VU8);
276}
277
3dc2afe2
AW
278/* Return a new bytevector of size LEN elements. */
279SCM
280scm_i_make_typed_bytevector (size_t len, scm_t_array_element_type element_type)
281{
282 return make_bytevector (len, element_type);
283}
284
1ee2c72e
LC
285/* Return a bytevector of size LEN made up of CONTENTS. The area pointed to
286 by CONTENTS must have been allocated using `scm_gc_malloc ()'. */
287SCM
2d34e924 288scm_c_take_bytevector (signed char *contents, size_t len)
1ee2c72e 289{
e286c973
AW
290 return make_bytevector_from_buffer (len, contents, SCM_ARRAY_ELEMENT_TYPE_VU8);
291}
1ee2c72e 292
3dc2afe2
AW
293SCM
294scm_c_take_typed_bytevector (signed char *contents, size_t len,
295 scm_t_array_element_type element_type)
296{
297 return make_bytevector_from_buffer (len, contents, element_type);
298}
299
1ee2c72e 300/* Shrink BV to C_NEW_LEN (which is assumed to be smaller than its current
0665b3ff 301 size) and return the new bytevector (possibly different from BV). */
1ee2c72e 302SCM
0665b3ff 303scm_c_shrink_bytevector (SCM bv, size_t c_new_len)
1ee2c72e 304{
0665b3ff
LC
305 SCM new_bv;
306 size_t c_len;
307
e286c973
AW
308 if (SCM_UNLIKELY (c_new_len % SCM_BYTEVECTOR_TYPE_SIZE (bv)))
309 /* This would be an internal Guile programming error */
310 abort ();
311
0665b3ff
LC
312 c_len = SCM_BYTEVECTOR_LENGTH (bv);
313 if (SCM_UNLIKELY (c_new_len > c_len))
314 abort ();
1ee2c72e 315
0665b3ff 316 SCM_BYTEVECTOR_SET_LENGTH (bv, c_new_len);
1ee2c72e 317
3fe87cf7
LC
318 if (SCM_BYTEVECTOR_CONTIGUOUS_P (bv))
319 new_bv = PTR2SCM (scm_gc_realloc (SCM2PTR (bv),
320 c_len + SCM_BYTEVECTOR_HEADER_BYTES,
321 c_new_len + SCM_BYTEVECTOR_HEADER_BYTES,
322 SCM_GC_BYTEVECTOR));
323 else
324 {
325 signed char *c_bv;
326
327 c_bv = scm_gc_realloc (SCM_BYTEVECTOR_CONTENTS (bv),
328 c_len, c_new_len, SCM_GC_BYTEVECTOR);
329 SCM_BYTEVECTOR_SET_CONTENTS (bv, c_bv);
330
331 new_bv = bv;
332 }
1ee2c72e 333
0665b3ff 334 return new_bv;
1ee2c72e
LC
335}
336
404bb5f8
LC
337int
338scm_is_bytevector (SCM obj)
339{
807e5a66 340 return SCM_BYTEVECTOR_P (obj);
404bb5f8
LC
341}
342
343size_t
344scm_c_bytevector_length (SCM bv)
345#define FUNC_NAME "scm_c_bytevector_length"
346{
347 SCM_VALIDATE_BYTEVECTOR (1, bv);
348
349 return SCM_BYTEVECTOR_LENGTH (bv);
350}
351#undef FUNC_NAME
352
353scm_t_uint8
354scm_c_bytevector_ref (SCM bv, size_t index)
355#define FUNC_NAME "scm_c_bytevector_ref"
356{
357 size_t c_len;
358 const scm_t_uint8 *c_bv;
359
360 SCM_VALIDATE_BYTEVECTOR (1, bv);
361
362 c_len = SCM_BYTEVECTOR_LENGTH (bv);
363 c_bv = (scm_t_uint8 *) SCM_BYTEVECTOR_CONTENTS (bv);
364
365 if (SCM_UNLIKELY (index >= c_len))
366 scm_out_of_range (FUNC_NAME, scm_from_size_t (index));
367
368 return c_bv[index];
369}
370#undef FUNC_NAME
371
372void
373scm_c_bytevector_set_x (SCM bv, size_t index, scm_t_uint8 value)
374#define FUNC_NAME "scm_c_bytevector_set_x"
375{
376 size_t c_len;
377 scm_t_uint8 *c_bv;
378
379 SCM_VALIDATE_BYTEVECTOR (1, bv);
380
381 c_len = SCM_BYTEVECTOR_LENGTH (bv);
382 c_bv = (scm_t_uint8 *) SCM_BYTEVECTOR_CONTENTS (bv);
383
384 if (SCM_UNLIKELY (index >= c_len))
385 scm_out_of_range (FUNC_NAME, scm_from_size_t (index));
386
387 c_bv[index] = value;
388}
389#undef FUNC_NAME
390
e286c973
AW
391
392\f
807e5a66
LC
393int
394scm_i_print_bytevector (SCM bv, SCM port, scm_print_state *pstate SCM_UNUSED)
1ee2c72e 395{
e286c973
AW
396 ssize_t ubnd, inc, i;
397 scm_t_array_handle h;
398
399 scm_array_get_handle (bv, &h);
1ee2c72e 400
e286c973
AW
401 scm_putc ('#', port);
402 scm_write (scm_array_handle_element_type (&h), port);
403 scm_putc ('(', port);
404 for (i = h.dims[0].lbnd, ubnd = h.dims[0].ubnd, inc = h.dims[0].inc;
405 i <= ubnd; i += inc)
1ee2c72e
LC
406 {
407 if (i > 0)
408 scm_putc (' ', port);
e286c973 409 scm_write (scm_array_handle_ref (&h, i), port);
1ee2c72e 410 }
1ee2c72e
LC
411 scm_putc (')', port);
412
1ee2c72e
LC
413 return 1;
414}
415
1ee2c72e
LC
416\f
417/* General operations. */
418
419SCM_SYMBOL (scm_sym_big, "big");
420SCM_SYMBOL (scm_sym_little, "little");
421
422SCM scm_endianness_big, scm_endianness_little;
423
424/* Host endianness (a symbol). */
caa92f5e 425SCM scm_i_native_endianness = SCM_UNSPECIFIED;
1ee2c72e
LC
426
427/* Byte-swapping. */
428#ifndef bswap_24
429# define bswap_24(_x) \
430 ((((_x) & 0xff0000) >> 16) | \
431 (((_x) & 0x00ff00)) | \
432 (((_x) & 0x0000ff) << 16))
433#endif
434
435
436SCM_DEFINE (scm_native_endianness, "native-endianness", 0, 0, 0,
437 (void),
438 "Return a symbol denoting the machine's native endianness.")
439#define FUNC_NAME s_scm_native_endianness
440{
caa92f5e 441 return scm_i_native_endianness;
1ee2c72e
LC
442}
443#undef FUNC_NAME
444
445SCM_DEFINE (scm_bytevector_p, "bytevector?", 1, 0, 0,
446 (SCM obj),
447 "Return true if @var{obj} is a bytevector.")
448#define FUNC_NAME s_scm_bytevector_p
449{
404bb5f8 450 return scm_from_bool (scm_is_bytevector (obj));
1ee2c72e
LC
451}
452#undef FUNC_NAME
453
454SCM_DEFINE (scm_make_bytevector, "make-bytevector", 1, 1, 0,
455 (SCM len, SCM fill),
456 "Return a newly allocated bytevector of @var{len} bytes, "
457 "optionally filled with @var{fill}.")
458#define FUNC_NAME s_scm_make_bytevector
459{
460 SCM bv;
461 unsigned c_len;
462 signed char c_fill = '\0';
463
464 SCM_VALIDATE_UINT_COPY (1, len, c_len);
465 if (fill != SCM_UNDEFINED)
466 {
467 int value;
468
469 value = scm_to_int (fill);
470 if (SCM_UNLIKELY ((value < -128) || (value > 255)))
471 scm_out_of_range (FUNC_NAME, fill);
472 c_fill = (signed char) value;
473 }
474
e286c973 475 bv = make_bytevector (c_len, SCM_ARRAY_ELEMENT_TYPE_VU8);
1ee2c72e
LC
476 if (fill != SCM_UNDEFINED)
477 {
478 unsigned i;
479 signed char *contents;
480
481 contents = SCM_BYTEVECTOR_CONTENTS (bv);
482 for (i = 0; i < c_len; i++)
483 contents[i] = c_fill;
484 }
3ef6650d
AW
485 else
486 memset (SCM_BYTEVECTOR_CONTENTS (bv), 0, c_len);
1ee2c72e
LC
487
488 return bv;
489}
490#undef FUNC_NAME
491
492SCM_DEFINE (scm_bytevector_length, "bytevector-length", 1, 0, 0,
493 (SCM bv),
494 "Return the length (in bytes) of @var{bv}.")
495#define FUNC_NAME s_scm_bytevector_length
496{
404bb5f8 497 return scm_from_uint (scm_c_bytevector_length (bv));
1ee2c72e
LC
498}
499#undef FUNC_NAME
500
501SCM_DEFINE (scm_bytevector_eq_p, "bytevector=?", 2, 0, 0,
502 (SCM bv1, SCM bv2),
503 "Return is @var{bv1} equals to @var{bv2}---i.e., if they "
504 "have the same length and contents.")
505#define FUNC_NAME s_scm_bytevector_eq_p
506{
507 SCM result = SCM_BOOL_F;
508 unsigned c_len1, c_len2;
509
510 SCM_VALIDATE_BYTEVECTOR (1, bv1);
511 SCM_VALIDATE_BYTEVECTOR (2, bv2);
512
513 c_len1 = SCM_BYTEVECTOR_LENGTH (bv1);
514 c_len2 = SCM_BYTEVECTOR_LENGTH (bv2);
515
a587d6a9
AW
516 if (c_len1 == c_len2 && (SCM_BYTEVECTOR_ELEMENT_TYPE (bv1)
517 == SCM_BYTEVECTOR_ELEMENT_TYPE (bv2)))
1ee2c72e
LC
518 {
519 signed char *c_bv1, *c_bv2;
520
521 c_bv1 = SCM_BYTEVECTOR_CONTENTS (bv1);
522 c_bv2 = SCM_BYTEVECTOR_CONTENTS (bv2);
523
524 result = scm_from_bool (!memcmp (c_bv1, c_bv2, c_len1));
525 }
526
527 return result;
528}
529#undef FUNC_NAME
530
531SCM_DEFINE (scm_bytevector_fill_x, "bytevector-fill!", 2, 0, 0,
532 (SCM bv, SCM fill),
533 "Fill bytevector @var{bv} with @var{fill}, a byte.")
534#define FUNC_NAME s_scm_bytevector_fill_x
535{
536 unsigned c_len, i;
537 signed char *c_bv, c_fill;
538
539 SCM_VALIDATE_BYTEVECTOR (1, bv);
540 c_fill = scm_to_int8 (fill);
541
542 c_len = SCM_BYTEVECTOR_LENGTH (bv);
543 c_bv = SCM_BYTEVECTOR_CONTENTS (bv);
544
545 for (i = 0; i < c_len; i++)
546 c_bv[i] = c_fill;
547
548 return SCM_UNSPECIFIED;
549}
550#undef FUNC_NAME
551
552SCM_DEFINE (scm_bytevector_copy_x, "bytevector-copy!", 5, 0, 0,
553 (SCM source, SCM source_start, SCM target, SCM target_start,
554 SCM len),
555 "Copy @var{len} bytes from @var{source} into @var{target}, "
556 "starting reading from @var{source_start} (a positive index "
557 "within @var{source}) and start writing at "
558 "@var{target_start}.")
559#define FUNC_NAME s_scm_bytevector_copy_x
560{
561 unsigned c_len, c_source_len, c_target_len;
562 unsigned c_source_start, c_target_start;
563 signed char *c_source, *c_target;
564
565 SCM_VALIDATE_BYTEVECTOR (1, source);
566 SCM_VALIDATE_BYTEVECTOR (3, target);
567
568 c_len = scm_to_uint (len);
569 c_source_start = scm_to_uint (source_start);
570 c_target_start = scm_to_uint (target_start);
571
572 c_source = SCM_BYTEVECTOR_CONTENTS (source);
573 c_target = SCM_BYTEVECTOR_CONTENTS (target);
574 c_source_len = SCM_BYTEVECTOR_LENGTH (source);
575 c_target_len = SCM_BYTEVECTOR_LENGTH (target);
576
577 if (SCM_UNLIKELY (c_source_start + c_len > c_source_len))
578 scm_out_of_range (FUNC_NAME, source_start);
579 if (SCM_UNLIKELY (c_target_start + c_len > c_target_len))
580 scm_out_of_range (FUNC_NAME, target_start);
581
582 memcpy (c_target + c_target_start,
583 c_source + c_source_start,
584 c_len);
585
586 return SCM_UNSPECIFIED;
587}
588#undef FUNC_NAME
589
590SCM_DEFINE (scm_bytevector_copy, "bytevector-copy", 1, 0, 0,
591 (SCM bv),
592 "Return a newly allocated copy of @var{bv}.")
593#define FUNC_NAME s_scm_bytevector_copy
594{
595 SCM copy;
596 unsigned c_len;
597 signed char *c_bv, *c_copy;
598
599 SCM_VALIDATE_BYTEVECTOR (1, bv);
600
601 c_len = SCM_BYTEVECTOR_LENGTH (bv);
602 c_bv = SCM_BYTEVECTOR_CONTENTS (bv);
603
e286c973 604 copy = make_bytevector (c_len, SCM_BYTEVECTOR_ELEMENT_TYPE (bv));
1ee2c72e
LC
605 c_copy = SCM_BYTEVECTOR_CONTENTS (copy);
606 memcpy (c_copy, c_bv, c_len);
607
608 return copy;
609}
610#undef FUNC_NAME
611
782a82ee
AW
612SCM_DEFINE (scm_uniform_array_to_bytevector, "uniform-array->bytevector",
613 1, 0, 0, (SCM array),
614 "Return a newly allocated bytevector whose contents\n"
615 "will be copied from the uniform array @var{array}.")
616#define FUNC_NAME s_scm_uniform_array_to_bytevector
617{
618 SCM contents, ret;
f5a51cae 619 size_t len, sz, byte_len;
782a82ee 620 scm_t_array_handle h;
f5a51cae 621 const void *elts;
782a82ee
AW
622
623 contents = scm_array_contents (array, SCM_BOOL_T);
624 if (scm_is_false (contents))
625 scm_wrong_type_arg_msg (FUNC_NAME, 0, array, "uniform contiguous array");
626
627 scm_array_get_handle (contents, &h);
f5a51cae 628 assert (h.base == 0);
782a82ee 629
f5a51cae 630 elts = h.elements;
782a82ee 631 len = h.dims->inc * (h.dims->ubnd - h.dims->lbnd + 1);
f5a51cae
AW
632 sz = scm_array_handle_uniform_element_bit_size (&h);
633 if (sz >= 8 && ((sz % 8) == 0))
634 byte_len = len * (sz / 8);
b0fae4ec 635 else if (sz < 8)
29553c54
LC
636 /* byte_len = ceil (len * sz / 8) */
637 byte_len = (len * sz + 7) / 8;
b0fae4ec
AW
638 else
639 /* an internal guile error, really */
640 SCM_MISC_ERROR ("uniform elements larger than 8 bits must fill whole bytes", SCM_EOL);
782a82ee 641
f5a51cae
AW
642 ret = make_bytevector (byte_len, SCM_ARRAY_ELEMENT_TYPE_VU8);
643 memcpy (SCM_BYTEVECTOR_CONTENTS (ret), elts, byte_len);
782a82ee
AW
644
645 scm_array_handle_release (&h);
646
647 return ret;
648}
649#undef FUNC_NAME
650
1ee2c72e
LC
651\f
652/* Operations on bytes and octets. */
653
654SCM_DEFINE (scm_bytevector_u8_ref, "bytevector-u8-ref", 2, 0, 0,
655 (SCM bv, SCM index),
656 "Return the octet located at @var{index} in @var{bv}.")
657#define FUNC_NAME s_scm_bytevector_u8_ref
658{
659 INTEGER_NATIVE_REF (8, unsigned);
660}
661#undef FUNC_NAME
662
663SCM_DEFINE (scm_bytevector_s8_ref, "bytevector-s8-ref", 2, 0, 0,
664 (SCM bv, SCM index),
665 "Return the byte located at @var{index} in @var{bv}.")
666#define FUNC_NAME s_scm_bytevector_s8_ref
667{
668 INTEGER_NATIVE_REF (8, signed);
669}
670#undef FUNC_NAME
671
672SCM_DEFINE (scm_bytevector_u8_set_x, "bytevector-u8-set!", 3, 0, 0,
673 (SCM bv, SCM index, SCM value),
674 "Return the octet located at @var{index} in @var{bv}.")
675#define FUNC_NAME s_scm_bytevector_u8_set_x
676{
677 INTEGER_NATIVE_SET (8, unsigned);
678}
679#undef FUNC_NAME
680
681SCM_DEFINE (scm_bytevector_s8_set_x, "bytevector-s8-set!", 3, 0, 0,
682 (SCM bv, SCM index, SCM value),
683 "Return the octet located at @var{index} in @var{bv}.")
cabf1b31 684#define FUNC_NAME s_scm_bytevector_s8_set_x
1ee2c72e
LC
685{
686 INTEGER_NATIVE_SET (8, signed);
687}
688#undef FUNC_NAME
689
690#undef OCTET_ACCESSOR_PROLOGUE
691
692
693SCM_DEFINE (scm_bytevector_to_u8_list, "bytevector->u8-list", 1, 0, 0,
694 (SCM bv),
695 "Return a newly allocated list of octets containing the "
696 "contents of @var{bv}.")
697#define FUNC_NAME s_scm_bytevector_to_u8_list
698{
699 SCM lst, pair;
700 unsigned c_len, i;
701 unsigned char *c_bv;
702
703 SCM_VALIDATE_BYTEVECTOR (1, bv);
704
705 c_len = SCM_BYTEVECTOR_LENGTH (bv);
706 c_bv = (unsigned char *) SCM_BYTEVECTOR_CONTENTS (bv);
707
708 lst = scm_make_list (scm_from_uint (c_len), SCM_UNSPECIFIED);
709 for (i = 0, pair = lst;
710 i < c_len;
711 i++, pair = SCM_CDR (pair))
712 {
713 SCM_SETCAR (pair, SCM_I_MAKINUM (c_bv[i]));
714 }
715
716 return lst;
717}
718#undef FUNC_NAME
719
720SCM_DEFINE (scm_u8_list_to_bytevector, "u8-list->bytevector", 1, 0, 0,
721 (SCM lst),
722 "Turn @var{lst}, a list of octets, into a bytevector.")
723#define FUNC_NAME s_scm_u8_list_to_bytevector
724{
725 SCM bv, item;
726 long c_len, i;
727 unsigned char *c_bv;
728
729 SCM_VALIDATE_LIST_COPYLEN (1, lst, c_len);
730
e286c973 731 bv = make_bytevector (c_len, SCM_ARRAY_ELEMENT_TYPE_VU8);
1ee2c72e
LC
732 c_bv = (unsigned char *) SCM_BYTEVECTOR_CONTENTS (bv);
733
734 for (i = 0; i < c_len; lst = SCM_CDR (lst), i++)
735 {
736 item = SCM_CAR (lst);
737
738 if (SCM_LIKELY (SCM_I_INUMP (item)))
739 {
e25f3727 740 scm_t_signed_bits c_item;
1ee2c72e
LC
741
742 c_item = SCM_I_INUM (item);
743 if (SCM_LIKELY ((c_item >= 0) && (c_item < 256)))
744 c_bv[i] = (unsigned char) c_item;
745 else
746 goto type_error;
747 }
748 else
749 goto type_error;
750 }
751
752 return bv;
753
754 type_error:
755 scm_wrong_type_arg (FUNC_NAME, 1, item);
756
757 return SCM_BOOL_F;
758}
759#undef FUNC_NAME
760
761/* Compute the two's complement of VALUE (a positive integer) on SIZE octets
762 using (2^(SIZE * 8) - VALUE). */
763static inline void
764twos_complement (mpz_t value, size_t size)
765{
766 unsigned long bit_count;
767
768 /* We expect BIT_COUNT to fit in a unsigned long thanks to the range
769 checking on SIZE performed earlier. */
770 bit_count = (unsigned long) size << 3UL;
771
772 if (SCM_LIKELY (bit_count < sizeof (unsigned long)))
773 mpz_ui_sub (value, 1UL << bit_count, value);
774 else
775 {
776 mpz_t max;
777
778 mpz_init (max);
779 mpz_ui_pow_ui (max, 2, bit_count);
780 mpz_sub (value, max, value);
781 mpz_clear (max);
782 }
783}
784
785static inline SCM
786bytevector_large_ref (const char *c_bv, size_t c_size, int signed_p,
787 SCM endianness)
788{
789 SCM result;
790 mpz_t c_mpz;
791 int c_endianness, negative_p = 0;
792
793 if (signed_p)
794 {
795 if (scm_is_eq (endianness, scm_sym_big))
796 negative_p = c_bv[0] & 0x80;
797 else
798 negative_p = c_bv[c_size - 1] & 0x80;
799 }
800
801 c_endianness = scm_is_eq (endianness, scm_sym_big) ? 1 : -1;
802
803 mpz_init (c_mpz);
804 mpz_import (c_mpz, 1 /* 1 word */, 1 /* word order doesn't matter */,
805 c_size /* word is C_SIZE-byte long */,
806 c_endianness,
807 0 /* nails */, c_bv);
808
809 if (signed_p && negative_p)
810 {
811 twos_complement (c_mpz, c_size);
812 mpz_neg (c_mpz, c_mpz);
813 }
814
815 result = scm_from_mpz (c_mpz);
816 mpz_clear (c_mpz); /* FIXME: Needed? */
817
818 return result;
819}
820
821static inline int
822bytevector_large_set (char *c_bv, size_t c_size, int signed_p,
823 SCM value, SCM endianness)
824{
825 mpz_t c_mpz;
826 int c_endianness, c_sign, err = 0;
827
828 c_endianness = scm_is_eq (endianness, scm_sym_big) ? 1 : -1;
829
830 mpz_init (c_mpz);
831 scm_to_mpz (value, c_mpz);
832
833 c_sign = mpz_sgn (c_mpz);
834 if (c_sign < 0)
835 {
836 if (SCM_LIKELY (signed_p))
837 {
838 mpz_neg (c_mpz, c_mpz);
839 twos_complement (c_mpz, c_size);
840 }
841 else
842 {
843 err = -1;
844 goto finish;
845 }
846 }
847
848 if (c_sign == 0)
849 /* Zero. */
850 memset (c_bv, 0, c_size);
851 else
852 {
853 size_t word_count, value_size;
854
855 value_size = (mpz_sizeinbase (c_mpz, 2) + (8 * c_size)) / (8 * c_size);
856 if (SCM_UNLIKELY (value_size > c_size))
857 {
858 err = -2;
859 goto finish;
860 }
861
862
863 mpz_export (c_bv, &word_count, 1 /* word order doesn't matter */,
864 c_size, c_endianness,
865 0 /* nails */, c_mpz);
866 if (SCM_UNLIKELY (word_count != 1))
867 /* Shouldn't happen since we already checked with VALUE_SIZE. */
868 abort ();
869 }
870
871 finish:
872 mpz_clear (c_mpz);
873
874 return err;
875}
876
877#define GENERIC_INTEGER_ACCESSOR_PROLOGUE(_sign) \
878 unsigned long c_len, c_index, c_size; \
879 char *c_bv; \
880 \
881 SCM_VALIDATE_BYTEVECTOR (1, bv); \
882 c_index = scm_to_ulong (index); \
883 c_size = scm_to_ulong (size); \
884 \
885 c_len = SCM_BYTEVECTOR_LENGTH (bv); \
886 c_bv = (char *) SCM_BYTEVECTOR_CONTENTS (bv); \
887 \
888 /* C_SIZE must have its 3 higher bits set to zero so that \
889 multiplying it by 8 yields a number that fits in an \
890 unsigned long. */ \
891 if (SCM_UNLIKELY ((c_size == 0) || (c_size >= (ULONG_MAX >> 3L)))) \
892 scm_out_of_range (FUNC_NAME, size); \
893 if (SCM_UNLIKELY (c_index + c_size > c_len)) \
894 scm_out_of_range (FUNC_NAME, index);
895
896
897/* Template of an integer reference function. */
898#define GENERIC_INTEGER_REF(_sign) \
899 SCM result; \
900 \
901 if (c_size < 3) \
902 { \
903 int swap; \
904 _sign int value; \
905 \
caa92f5e 906 swap = !scm_is_eq (endianness, scm_i_native_endianness); \
1ee2c72e
LC
907 switch (c_size) \
908 { \
909 case 1: \
910 { \
911 _sign char c_value8; \
912 memcpy (&c_value8, c_bv, 1); \
913 value = c_value8; \
914 } \
915 break; \
916 case 2: \
917 { \
918 INT_TYPE (16, _sign) c_value16; \
919 memcpy (&c_value16, c_bv, 2); \
920 if (swap) \
921 value = (INT_TYPE (16, _sign)) bswap_16 (c_value16); \
922 else \
923 value = c_value16; \
924 } \
925 break; \
926 default: \
927 abort (); \
928 } \
929 \
930 result = SCM_I_MAKINUM ((_sign int) value); \
931 } \
932 else \
933 result = bytevector_large_ref ((char *) c_bv, \
934 c_size, SIGNEDNESS (_sign), \
935 endianness); \
936 \
937 return result;
938
939static inline SCM
940bytevector_signed_ref (const char *c_bv, size_t c_size, SCM endianness)
941{
942 GENERIC_INTEGER_REF (signed);
943}
944
945static inline SCM
946bytevector_unsigned_ref (const char *c_bv, size_t c_size, SCM endianness)
947{
948 GENERIC_INTEGER_REF (unsigned);
949}
950
951
952/* Template of an integer assignment function. */
953#define GENERIC_INTEGER_SET(_sign) \
954 if (c_size < 3) \
955 { \
e25f3727 956 scm_t_signed_bits c_value; \
1ee2c72e
LC
957 \
958 if (SCM_UNLIKELY (!SCM_I_INUMP (value))) \
959 goto range_error; \
960 \
961 c_value = SCM_I_INUM (value); \
962 switch (c_size) \
963 { \
964 case 1: \
965 if (SCM_LIKELY (INT_VALID_P (8, _sign) (c_value))) \
966 { \
967 _sign char c_value8; \
968 c_value8 = (_sign char) c_value; \
969 memcpy (c_bv, &c_value8, 1); \
970 } \
971 else \
972 goto range_error; \
973 break; \
974 \
975 case 2: \
976 if (SCM_LIKELY (INT_VALID_P (16, _sign) (c_value))) \
977 { \
978 int swap; \
979 INT_TYPE (16, _sign) c_value16; \
980 \
caa92f5e 981 swap = !scm_is_eq (endianness, scm_i_native_endianness); \
1ee2c72e
LC
982 \
983 if (swap) \
984 c_value16 = (INT_TYPE (16, _sign)) bswap_16 (c_value); \
985 else \
986 c_value16 = c_value; \
987 \
988 memcpy (c_bv, &c_value16, 2); \
989 } \
990 else \
991 goto range_error; \
992 break; \
993 \
994 default: \
995 abort (); \
996 } \
997 } \
998 else \
999 { \
1000 int err; \
1001 \
1002 err = bytevector_large_set (c_bv, c_size, \
1003 SIGNEDNESS (_sign), \
1004 value, endianness); \
1005 if (err) \
1006 goto range_error; \
1007 } \
1008 \
1009 return; \
1010 \
1011 range_error: \
1012 scm_out_of_range (FUNC_NAME, value); \
1013 return;
1014
1015static inline void
1016bytevector_signed_set (char *c_bv, size_t c_size,
1017 SCM value, SCM endianness,
1018 const char *func_name)
1019#define FUNC_NAME func_name
1020{
1021 GENERIC_INTEGER_SET (signed);
1022}
1023#undef FUNC_NAME
1024
1025static inline void
1026bytevector_unsigned_set (char *c_bv, size_t c_size,
1027 SCM value, SCM endianness,
1028 const char *func_name)
1029#define FUNC_NAME func_name
1030{
1031 GENERIC_INTEGER_SET (unsigned);
1032}
1033#undef FUNC_NAME
1034
1035#undef GENERIC_INTEGER_SET
1036#undef GENERIC_INTEGER_REF
1037
1038
1039SCM_DEFINE (scm_bytevector_uint_ref, "bytevector-uint-ref", 4, 0, 0,
1040 (SCM bv, SCM index, SCM endianness, SCM size),
1041 "Return the @var{size}-octet long unsigned integer at index "
1042 "@var{index} in @var{bv}.")
1043#define FUNC_NAME s_scm_bytevector_uint_ref
1044{
1045 GENERIC_INTEGER_ACCESSOR_PROLOGUE (unsigned);
1046
1047 return (bytevector_unsigned_ref (&c_bv[c_index], c_size, endianness));
1048}
1049#undef FUNC_NAME
1050
1051SCM_DEFINE (scm_bytevector_sint_ref, "bytevector-sint-ref", 4, 0, 0,
1052 (SCM bv, SCM index, SCM endianness, SCM size),
1053 "Return the @var{size}-octet long unsigned integer at index "
1054 "@var{index} in @var{bv}.")
1055#define FUNC_NAME s_scm_bytevector_sint_ref
1056{
1057 GENERIC_INTEGER_ACCESSOR_PROLOGUE (signed);
1058
1059 return (bytevector_signed_ref (&c_bv[c_index], c_size, endianness));
1060}
1061#undef FUNC_NAME
1062
1063SCM_DEFINE (scm_bytevector_uint_set_x, "bytevector-uint-set!", 5, 0, 0,
1064 (SCM bv, SCM index, SCM value, SCM endianness, SCM size),
1065 "Set the @var{size}-octet long unsigned integer at @var{index} "
1066 "to @var{value}.")
1067#define FUNC_NAME s_scm_bytevector_uint_set_x
1068{
1069 GENERIC_INTEGER_ACCESSOR_PROLOGUE (unsigned);
1070
1071 bytevector_unsigned_set (&c_bv[c_index], c_size, value, endianness,
1072 FUNC_NAME);
1073
1074 return SCM_UNSPECIFIED;
1075}
1076#undef FUNC_NAME
1077
1078SCM_DEFINE (scm_bytevector_sint_set_x, "bytevector-sint-set!", 5, 0, 0,
1079 (SCM bv, SCM index, SCM value, SCM endianness, SCM size),
1080 "Set the @var{size}-octet long signed integer at @var{index} "
1081 "to @var{value}.")
1082#define FUNC_NAME s_scm_bytevector_sint_set_x
1083{
1084 GENERIC_INTEGER_ACCESSOR_PROLOGUE (signed);
1085
1086 bytevector_signed_set (&c_bv[c_index], c_size, value, endianness,
1087 FUNC_NAME);
1088
1089 return SCM_UNSPECIFIED;
1090}
1091#undef FUNC_NAME
1092
1093
1094\f
1095/* Operations on integers of arbitrary size. */
1096
1097#define INTEGERS_TO_LIST(_sign) \
1098 SCM lst, pair; \
1099 size_t i, c_len, c_size; \
1100 \
1101 SCM_VALIDATE_BYTEVECTOR (1, bv); \
1102 SCM_VALIDATE_SYMBOL (2, endianness); \
1103 c_size = scm_to_uint (size); \
1104 \
1105 c_len = SCM_BYTEVECTOR_LENGTH (bv); \
1106 if (SCM_UNLIKELY (c_len == 0)) \
1107 lst = SCM_EOL; \
1108 else if (SCM_UNLIKELY (c_len < c_size)) \
1109 scm_out_of_range (FUNC_NAME, size); \
1110 else \
1111 { \
1112 const char *c_bv; \
1113 \
1114 c_bv = (char *) SCM_BYTEVECTOR_CONTENTS (bv); \
1115 \
1116 lst = scm_make_list (scm_from_uint (c_len / c_size), \
1117 SCM_UNSPECIFIED); \
1118 for (i = 0, pair = lst; \
1119 i <= c_len - c_size; \
1120 i += c_size, c_bv += c_size, pair = SCM_CDR (pair)) \
1121 { \
1122 SCM_SETCAR (pair, \
1123 bytevector_ ## _sign ## _ref (c_bv, c_size, \
1124 endianness)); \
1125 } \
1126 } \
1127 \
1128 return lst;
1129
1130SCM_DEFINE (scm_bytevector_to_sint_list, "bytevector->sint-list",
1131 3, 0, 0,
1132 (SCM bv, SCM endianness, SCM size),
1133 "Return a list of signed integers of @var{size} octets "
1134 "representing the contents of @var{bv}.")
1135#define FUNC_NAME s_scm_bytevector_to_sint_list
1136{
1137 INTEGERS_TO_LIST (signed);
1138}
1139#undef FUNC_NAME
1140
1141SCM_DEFINE (scm_bytevector_to_uint_list, "bytevector->uint-list",
1142 3, 0, 0,
1143 (SCM bv, SCM endianness, SCM size),
1144 "Return a list of unsigned integers of @var{size} octets "
1145 "representing the contents of @var{bv}.")
1146#define FUNC_NAME s_scm_bytevector_to_uint_list
1147{
1148 INTEGERS_TO_LIST (unsigned);
1149}
1150#undef FUNC_NAME
1151
1152#undef INTEGER_TO_LIST
1153
1154
1155#define INTEGER_LIST_TO_BYTEVECTOR(_sign) \
1156 SCM bv; \
1157 long c_len; \
1158 size_t c_size; \
1159 char *c_bv, *c_bv_ptr; \
1160 \
1161 SCM_VALIDATE_LIST_COPYLEN (1, lst, c_len); \
1162 SCM_VALIDATE_SYMBOL (2, endianness); \
1163 c_size = scm_to_uint (size); \
1164 \
1165 if (SCM_UNLIKELY ((c_size == 0) || (c_size >= (ULONG_MAX >> 3L)))) \
1166 scm_out_of_range (FUNC_NAME, size); \
1167 \
e286c973 1168 bv = make_bytevector (c_len * c_size, SCM_ARRAY_ELEMENT_TYPE_VU8); \
1ee2c72e
LC
1169 c_bv = (char *) SCM_BYTEVECTOR_CONTENTS (bv); \
1170 \
1171 for (c_bv_ptr = c_bv; \
1172 !scm_is_null (lst); \
1173 lst = SCM_CDR (lst), c_bv_ptr += c_size) \
1174 { \
1175 bytevector_ ## _sign ## _set (c_bv_ptr, c_size, \
1176 SCM_CAR (lst), endianness, \
1177 FUNC_NAME); \
1178 } \
1179 \
1180 return bv;
1181
1182
1183SCM_DEFINE (scm_uint_list_to_bytevector, "uint-list->bytevector",
1184 3, 0, 0,
1185 (SCM lst, SCM endianness, SCM size),
1186 "Return a bytevector containing the unsigned integers "
1187 "listed in @var{lst} and encoded on @var{size} octets "
1188 "according to @var{endianness}.")
1189#define FUNC_NAME s_scm_uint_list_to_bytevector
1190{
1191 INTEGER_LIST_TO_BYTEVECTOR (unsigned);
1192}
1193#undef FUNC_NAME
1194
1195SCM_DEFINE (scm_sint_list_to_bytevector, "sint-list->bytevector",
1196 3, 0, 0,
1197 (SCM lst, SCM endianness, SCM size),
1198 "Return a bytevector containing the signed integers "
1199 "listed in @var{lst} and encoded on @var{size} octets "
1200 "according to @var{endianness}.")
1201#define FUNC_NAME s_scm_sint_list_to_bytevector
1202{
1203 INTEGER_LIST_TO_BYTEVECTOR (signed);
1204}
1205#undef FUNC_NAME
1206
1207#undef INTEGER_LIST_TO_BYTEVECTOR
1208
1209
1210\f
1211/* Operations on 16-bit integers. */
1212
1213SCM_DEFINE (scm_bytevector_u16_ref, "bytevector-u16-ref",
1214 3, 0, 0,
1215 (SCM bv, SCM index, SCM endianness),
1216 "Return the unsigned 16-bit integer from @var{bv} at "
1217 "@var{index}.")
1218#define FUNC_NAME s_scm_bytevector_u16_ref
1219{
1220 INTEGER_REF (16, unsigned);
1221}
1222#undef FUNC_NAME
1223
1224SCM_DEFINE (scm_bytevector_s16_ref, "bytevector-s16-ref",
1225 3, 0, 0,
1226 (SCM bv, SCM index, SCM endianness),
1227 "Return the signed 16-bit integer from @var{bv} at "
1228 "@var{index}.")
1229#define FUNC_NAME s_scm_bytevector_s16_ref
1230{
1231 INTEGER_REF (16, signed);
1232}
1233#undef FUNC_NAME
1234
1235SCM_DEFINE (scm_bytevector_u16_native_ref, "bytevector-u16-native-ref",
1236 2, 0, 0,
1237 (SCM bv, SCM index),
1238 "Return the unsigned 16-bit integer from @var{bv} at "
1239 "@var{index} using the native endianness.")
1240#define FUNC_NAME s_scm_bytevector_u16_native_ref
1241{
1242 INTEGER_NATIVE_REF (16, unsigned);
1243}
1244#undef FUNC_NAME
1245
1246SCM_DEFINE (scm_bytevector_s16_native_ref, "bytevector-s16-native-ref",
1247 2, 0, 0,
1248 (SCM bv, SCM index),
1249 "Return the unsigned 16-bit integer from @var{bv} at "
1250 "@var{index} using the native endianness.")
1251#define FUNC_NAME s_scm_bytevector_s16_native_ref
1252{
1253 INTEGER_NATIVE_REF (16, signed);
1254}
1255#undef FUNC_NAME
1256
1257SCM_DEFINE (scm_bytevector_u16_set_x, "bytevector-u16-set!",
1258 4, 0, 0,
1259 (SCM bv, SCM index, SCM value, SCM endianness),
1260 "Store @var{value} in @var{bv} at @var{index} according to "
1261 "@var{endianness}.")
1262#define FUNC_NAME s_scm_bytevector_u16_set_x
1263{
1264 INTEGER_SET (16, unsigned);
1265}
1266#undef FUNC_NAME
1267
1268SCM_DEFINE (scm_bytevector_s16_set_x, "bytevector-s16-set!",
1269 4, 0, 0,
1270 (SCM bv, SCM index, SCM value, SCM endianness),
1271 "Store @var{value} in @var{bv} at @var{index} according to "
1272 "@var{endianness}.")
1273#define FUNC_NAME s_scm_bytevector_s16_set_x
1274{
1275 INTEGER_SET (16, signed);
1276}
1277#undef FUNC_NAME
1278
1279SCM_DEFINE (scm_bytevector_u16_native_set_x, "bytevector-u16-native-set!",
1280 3, 0, 0,
1281 (SCM bv, SCM index, SCM value),
1282 "Store the unsigned integer @var{value} at index @var{index} "
1283 "of @var{bv} using the native endianness.")
1284#define FUNC_NAME s_scm_bytevector_u16_native_set_x
1285{
1286 INTEGER_NATIVE_SET (16, unsigned);
1287}
1288#undef FUNC_NAME
1289
1290SCM_DEFINE (scm_bytevector_s16_native_set_x, "bytevector-s16-native-set!",
1291 3, 0, 0,
1292 (SCM bv, SCM index, SCM value),
1293 "Store the signed integer @var{value} at index @var{index} "
1294 "of @var{bv} using the native endianness.")
1295#define FUNC_NAME s_scm_bytevector_s16_native_set_x
1296{
1297 INTEGER_NATIVE_SET (16, signed);
1298}
1299#undef FUNC_NAME
1300
1301
1302\f
1303/* Operations on 32-bit integers. */
1304
1305/* Unfortunately, on 32-bit machines `SCM' is not large enough to hold
1306 arbitrary 32-bit integers. Thus we fall back to using the
1307 `large_{ref,set}' variants on 32-bit machines. */
1308
1309#define LARGE_INTEGER_REF(_len, _sign) \
1310 INTEGER_ACCESSOR_PROLOGUE(_len, _sign); \
1311 SCM_VALIDATE_SYMBOL (3, endianness); \
1312 \
1313 return (bytevector_large_ref ((char *) c_bv + c_index, _len / 8, \
1314 SIGNEDNESS (_sign), endianness));
1315
1316#define LARGE_INTEGER_SET(_len, _sign) \
1317 int err; \
1318 INTEGER_ACCESSOR_PROLOGUE (_len, _sign); \
1319 SCM_VALIDATE_SYMBOL (4, endianness); \
1320 \
1321 err = bytevector_large_set ((char *) c_bv + c_index, _len / 8, \
1322 SIGNEDNESS (_sign), value, endianness); \
1323 if (SCM_UNLIKELY (err)) \
1324 scm_out_of_range (FUNC_NAME, value); \
1325 \
1326 return SCM_UNSPECIFIED;
1327
1328#define LARGE_INTEGER_NATIVE_REF(_len, _sign) \
1329 INTEGER_ACCESSOR_PROLOGUE(_len, _sign); \
1330 return (bytevector_large_ref ((char *) c_bv + c_index, _len / 8, \
caa92f5e 1331 SIGNEDNESS (_sign), scm_i_native_endianness));
1ee2c72e
LC
1332
1333#define LARGE_INTEGER_NATIVE_SET(_len, _sign) \
1334 int err; \
1335 INTEGER_ACCESSOR_PROLOGUE (_len, _sign); \
1336 \
1337 err = bytevector_large_set ((char *) c_bv + c_index, _len / 8, \
1338 SIGNEDNESS (_sign), value, \
caa92f5e 1339 scm_i_native_endianness); \
1ee2c72e
LC
1340 if (SCM_UNLIKELY (err)) \
1341 scm_out_of_range (FUNC_NAME, value); \
1342 \
1343 return SCM_UNSPECIFIED;
1344
1345
1346SCM_DEFINE (scm_bytevector_u32_ref, "bytevector-u32-ref",
1347 3, 0, 0,
1348 (SCM bv, SCM index, SCM endianness),
1349 "Return the unsigned 32-bit integer from @var{bv} at "
1350 "@var{index}.")
1351#define FUNC_NAME s_scm_bytevector_u32_ref
1352{
1353#if SIZEOF_VOID_P > 4
1354 INTEGER_REF (32, unsigned);
1355#else
1356 LARGE_INTEGER_REF (32, unsigned);
1357#endif
1358}
1359#undef FUNC_NAME
1360
1361SCM_DEFINE (scm_bytevector_s32_ref, "bytevector-s32-ref",
1362 3, 0, 0,
1363 (SCM bv, SCM index, SCM endianness),
1364 "Return the signed 32-bit integer from @var{bv} at "
1365 "@var{index}.")
1366#define FUNC_NAME s_scm_bytevector_s32_ref
1367{
1368#if SIZEOF_VOID_P > 4
1369 INTEGER_REF (32, signed);
1370#else
1371 LARGE_INTEGER_REF (32, signed);
1372#endif
1373}
1374#undef FUNC_NAME
1375
1376SCM_DEFINE (scm_bytevector_u32_native_ref, "bytevector-u32-native-ref",
1377 2, 0, 0,
1378 (SCM bv, SCM index),
1379 "Return the unsigned 32-bit integer from @var{bv} at "
1380 "@var{index} using the native endianness.")
1381#define FUNC_NAME s_scm_bytevector_u32_native_ref
1382{
1383#if SIZEOF_VOID_P > 4
1384 INTEGER_NATIVE_REF (32, unsigned);
1385#else
1386 LARGE_INTEGER_NATIVE_REF (32, unsigned);
1387#endif
1388}
1389#undef FUNC_NAME
1390
1391SCM_DEFINE (scm_bytevector_s32_native_ref, "bytevector-s32-native-ref",
1392 2, 0, 0,
1393 (SCM bv, SCM index),
1394 "Return the unsigned 32-bit integer from @var{bv} at "
1395 "@var{index} using the native endianness.")
1396#define FUNC_NAME s_scm_bytevector_s32_native_ref
1397{
1398#if SIZEOF_VOID_P > 4
1399 INTEGER_NATIVE_REF (32, signed);
1400#else
1401 LARGE_INTEGER_NATIVE_REF (32, signed);
1402#endif
1403}
1404#undef FUNC_NAME
1405
1406SCM_DEFINE (scm_bytevector_u32_set_x, "bytevector-u32-set!",
1407 4, 0, 0,
1408 (SCM bv, SCM index, SCM value, SCM endianness),
1409 "Store @var{value} in @var{bv} at @var{index} according to "
1410 "@var{endianness}.")
1411#define FUNC_NAME s_scm_bytevector_u32_set_x
1412{
1413#if SIZEOF_VOID_P > 4
1414 INTEGER_SET (32, unsigned);
1415#else
1416 LARGE_INTEGER_SET (32, unsigned);
1417#endif
1418}
1419#undef FUNC_NAME
1420
1421SCM_DEFINE (scm_bytevector_s32_set_x, "bytevector-s32-set!",
1422 4, 0, 0,
1423 (SCM bv, SCM index, SCM value, SCM endianness),
1424 "Store @var{value} in @var{bv} at @var{index} according to "
1425 "@var{endianness}.")
1426#define FUNC_NAME s_scm_bytevector_s32_set_x
1427{
1428#if SIZEOF_VOID_P > 4
1429 INTEGER_SET (32, signed);
1430#else
1431 LARGE_INTEGER_SET (32, signed);
1432#endif
1433}
1434#undef FUNC_NAME
1435
1436SCM_DEFINE (scm_bytevector_u32_native_set_x, "bytevector-u32-native-set!",
1437 3, 0, 0,
1438 (SCM bv, SCM index, SCM value),
1439 "Store the unsigned integer @var{value} at index @var{index} "
1440 "of @var{bv} using the native endianness.")
1441#define FUNC_NAME s_scm_bytevector_u32_native_set_x
1442{
1443#if SIZEOF_VOID_P > 4
1444 INTEGER_NATIVE_SET (32, unsigned);
1445#else
1446 LARGE_INTEGER_NATIVE_SET (32, unsigned);
1447#endif
1448}
1449#undef FUNC_NAME
1450
1451SCM_DEFINE (scm_bytevector_s32_native_set_x, "bytevector-s32-native-set!",
1452 3, 0, 0,
1453 (SCM bv, SCM index, SCM value),
1454 "Store the signed integer @var{value} at index @var{index} "
1455 "of @var{bv} using the native endianness.")
1456#define FUNC_NAME s_scm_bytevector_s32_native_set_x
1457{
1458#if SIZEOF_VOID_P > 4
1459 INTEGER_NATIVE_SET (32, signed);
1460#else
1461 LARGE_INTEGER_NATIVE_SET (32, signed);
1462#endif
1463}
1464#undef FUNC_NAME
1465
1466
1467\f
1468/* Operations on 64-bit integers. */
1469
1470/* For 64-bit integers, we use only the `large_{ref,set}' variant. */
1471
1472SCM_DEFINE (scm_bytevector_u64_ref, "bytevector-u64-ref",
1473 3, 0, 0,
1474 (SCM bv, SCM index, SCM endianness),
1475 "Return the unsigned 64-bit integer from @var{bv} at "
1476 "@var{index}.")
1477#define FUNC_NAME s_scm_bytevector_u64_ref
1478{
1479 LARGE_INTEGER_REF (64, unsigned);
1480}
1481#undef FUNC_NAME
1482
1483SCM_DEFINE (scm_bytevector_s64_ref, "bytevector-s64-ref",
1484 3, 0, 0,
1485 (SCM bv, SCM index, SCM endianness),
1486 "Return the signed 64-bit integer from @var{bv} at "
1487 "@var{index}.")
1488#define FUNC_NAME s_scm_bytevector_s64_ref
1489{
1490 LARGE_INTEGER_REF (64, signed);
1491}
1492#undef FUNC_NAME
1493
1494SCM_DEFINE (scm_bytevector_u64_native_ref, "bytevector-u64-native-ref",
1495 2, 0, 0,
1496 (SCM bv, SCM index),
1497 "Return the unsigned 64-bit integer from @var{bv} at "
1498 "@var{index} using the native endianness.")
1499#define FUNC_NAME s_scm_bytevector_u64_native_ref
1500{
1501 LARGE_INTEGER_NATIVE_REF (64, unsigned);
1502}
1503#undef FUNC_NAME
1504
1505SCM_DEFINE (scm_bytevector_s64_native_ref, "bytevector-s64-native-ref",
1506 2, 0, 0,
1507 (SCM bv, SCM index),
1508 "Return the unsigned 64-bit integer from @var{bv} at "
1509 "@var{index} using the native endianness.")
1510#define FUNC_NAME s_scm_bytevector_s64_native_ref
1511{
1512 LARGE_INTEGER_NATIVE_REF (64, signed);
1513}
1514#undef FUNC_NAME
1515
1516SCM_DEFINE (scm_bytevector_u64_set_x, "bytevector-u64-set!",
1517 4, 0, 0,
1518 (SCM bv, SCM index, SCM value, SCM endianness),
1519 "Store @var{value} in @var{bv} at @var{index} according to "
1520 "@var{endianness}.")
1521#define FUNC_NAME s_scm_bytevector_u64_set_x
1522{
1523 LARGE_INTEGER_SET (64, unsigned);
1524}
1525#undef FUNC_NAME
1526
1527SCM_DEFINE (scm_bytevector_s64_set_x, "bytevector-s64-set!",
1528 4, 0, 0,
1529 (SCM bv, SCM index, SCM value, SCM endianness),
1530 "Store @var{value} in @var{bv} at @var{index} according to "
1531 "@var{endianness}.")
1532#define FUNC_NAME s_scm_bytevector_s64_set_x
1533{
1534 LARGE_INTEGER_SET (64, signed);
1535}
1536#undef FUNC_NAME
1537
1538SCM_DEFINE (scm_bytevector_u64_native_set_x, "bytevector-u64-native-set!",
1539 3, 0, 0,
1540 (SCM bv, SCM index, SCM value),
1541 "Store the unsigned integer @var{value} at index @var{index} "
1542 "of @var{bv} using the native endianness.")
1543#define FUNC_NAME s_scm_bytevector_u64_native_set_x
1544{
1545 LARGE_INTEGER_NATIVE_SET (64, unsigned);
1546}
1547#undef FUNC_NAME
1548
1549SCM_DEFINE (scm_bytevector_s64_native_set_x, "bytevector-s64-native-set!",
1550 3, 0, 0,
1551 (SCM bv, SCM index, SCM value),
1552 "Store the signed integer @var{value} at index @var{index} "
1553 "of @var{bv} using the native endianness.")
1554#define FUNC_NAME s_scm_bytevector_s64_native_set_x
1555{
1556 LARGE_INTEGER_NATIVE_SET (64, signed);
1557}
1558#undef FUNC_NAME
1559
1560
1561\f
1562/* Operations on IEEE-754 numbers. */
1563
1564/* There are two possible word endians, visible in glibc's <ieee754.h>.
1565 However, in R6RS, when the endianness is `little', little endian is
1566 assumed for both the byte order and the word order. This is clear from
1567 Section 2.1 of R6RS-lib (in response to
1568 http://www.r6rs.org/formal-comments/comment-187.txt). */
1569
1570
1571/* Convert to/from a floating-point number with different endianness. This
1572 method is probably not the most efficient but it should be portable. */
1573
1574static inline void
1575float_to_foreign_endianness (union scm_ieee754_float *target,
1576 float source)
1577{
1578 union scm_ieee754_float src;
1579
1580 src.f = source;
1581
1582#ifdef WORDS_BIGENDIAN
1583 /* Assuming little endian for both byte and word order. */
1584 target->little_endian.negative = src.big_endian.negative;
1585 target->little_endian.exponent = src.big_endian.exponent;
1586 target->little_endian.mantissa = src.big_endian.mantissa;
1587#else
1588 target->big_endian.negative = src.little_endian.negative;
1589 target->big_endian.exponent = src.little_endian.exponent;
1590 target->big_endian.mantissa = src.little_endian.mantissa;
1591#endif
1592}
1593
1594static inline float
1595float_from_foreign_endianness (const union scm_ieee754_float *source)
1596{
1597 union scm_ieee754_float result;
1598
1599#ifdef WORDS_BIGENDIAN
1600 /* Assuming little endian for both byte and word order. */
1601 result.big_endian.negative = source->little_endian.negative;
1602 result.big_endian.exponent = source->little_endian.exponent;
1603 result.big_endian.mantissa = source->little_endian.mantissa;
1604#else
1605 result.little_endian.negative = source->big_endian.negative;
1606 result.little_endian.exponent = source->big_endian.exponent;
1607 result.little_endian.mantissa = source->big_endian.mantissa;
1608#endif
1609
1610 return (result.f);
1611}
1612
1613static inline void
1614double_to_foreign_endianness (union scm_ieee754_double *target,
1615 double source)
1616{
1617 union scm_ieee754_double src;
1618
1619 src.d = source;
1620
1621#ifdef WORDS_BIGENDIAN
1622 /* Assuming little endian for both byte and word order. */
1623 target->little_little_endian.negative = src.big_endian.negative;
1624 target->little_little_endian.exponent = src.big_endian.exponent;
1625 target->little_little_endian.mantissa0 = src.big_endian.mantissa0;
1626 target->little_little_endian.mantissa1 = src.big_endian.mantissa1;
1627#else
1628 target->big_endian.negative = src.little_little_endian.negative;
1629 target->big_endian.exponent = src.little_little_endian.exponent;
1630 target->big_endian.mantissa0 = src.little_little_endian.mantissa0;
1631 target->big_endian.mantissa1 = src.little_little_endian.mantissa1;
1632#endif
1633}
1634
1635static inline double
1636double_from_foreign_endianness (const union scm_ieee754_double *source)
1637{
1638 union scm_ieee754_double result;
1639
1640#ifdef WORDS_BIGENDIAN
1641 /* Assuming little endian for both byte and word order. */
1642 result.big_endian.negative = source->little_little_endian.negative;
1643 result.big_endian.exponent = source->little_little_endian.exponent;
1644 result.big_endian.mantissa0 = source->little_little_endian.mantissa0;
1645 result.big_endian.mantissa1 = source->little_little_endian.mantissa1;
1646#else
1647 result.little_little_endian.negative = source->big_endian.negative;
1648 result.little_little_endian.exponent = source->big_endian.exponent;
1649 result.little_little_endian.mantissa0 = source->big_endian.mantissa0;
1650 result.little_little_endian.mantissa1 = source->big_endian.mantissa1;
1651#endif
1652
1653 return (result.d);
1654}
1655
1656/* Template macros to abstract over doubles and floats.
1657 XXX: Guile can only convert to/from doubles. */
1658#define IEEE754_UNION(_c_type) union scm_ieee754_ ## _c_type
1659#define IEEE754_TO_SCM(_c_type) scm_from_double
1660#define IEEE754_FROM_SCM(_c_type) scm_to_double
1661#define IEEE754_FROM_FOREIGN_ENDIANNESS(_c_type) \
1662 _c_type ## _from_foreign_endianness
1663#define IEEE754_TO_FOREIGN_ENDIANNESS(_c_type) \
1664 _c_type ## _to_foreign_endianness
1665
1666
cd43fdc5
AW
1667/* FIXME: SCM_VALIDATE_REAL rejects integers, etc. grrr */
1668#define VALIDATE_REAL(pos, v) \
1669 do { \
1670 SCM_ASSERT_TYPE (scm_is_true (scm_rational_p (v)), v, pos, FUNC_NAME, "real"); \
1671 } while (0)
1672
1ee2c72e
LC
1673/* Templace getters and setters. */
1674
1675#define IEEE754_ACCESSOR_PROLOGUE(_type) \
1676 INTEGER_ACCESSOR_PROLOGUE (sizeof (_type) << 3UL, signed);
1677
1678#define IEEE754_REF(_type) \
1679 _type c_result; \
1680 \
1681 IEEE754_ACCESSOR_PROLOGUE (_type); \
1682 SCM_VALIDATE_SYMBOL (3, endianness); \
1683 \
caa92f5e 1684 if (scm_is_eq (endianness, scm_i_native_endianness)) \
1ee2c72e
LC
1685 memcpy (&c_result, &c_bv[c_index], sizeof (c_result)); \
1686 else \
1687 { \
1688 IEEE754_UNION (_type) c_raw; \
1689 \
1690 memcpy (&c_raw, &c_bv[c_index], sizeof (c_raw)); \
1691 c_result = \
1692 IEEE754_FROM_FOREIGN_ENDIANNESS (_type) (&c_raw); \
1693 } \
1694 \
1695 return (IEEE754_TO_SCM (_type) (c_result));
1696
1697#define IEEE754_NATIVE_REF(_type) \
1698 _type c_result; \
1699 \
1700 IEEE754_ACCESSOR_PROLOGUE (_type); \
1701 \
1702 memcpy (&c_result, &c_bv[c_index], sizeof (c_result)); \
1703 return (IEEE754_TO_SCM (_type) (c_result));
1704
1705#define IEEE754_SET(_type) \
1706 _type c_value; \
1707 \
1708 IEEE754_ACCESSOR_PROLOGUE (_type); \
cd43fdc5 1709 VALIDATE_REAL (3, value); \
1ee2c72e
LC
1710 SCM_VALIDATE_SYMBOL (4, endianness); \
1711 c_value = IEEE754_FROM_SCM (_type) (value); \
1712 \
caa92f5e 1713 if (scm_is_eq (endianness, scm_i_native_endianness)) \
1ee2c72e
LC
1714 memcpy (&c_bv[c_index], &c_value, sizeof (c_value)); \
1715 else \
1716 { \
1717 IEEE754_UNION (_type) c_raw; \
1718 \
1719 IEEE754_TO_FOREIGN_ENDIANNESS (_type) (&c_raw, c_value); \
1720 memcpy (&c_bv[c_index], &c_raw, sizeof (c_raw)); \
1721 } \
1722 \
1723 return SCM_UNSPECIFIED;
1724
1725#define IEEE754_NATIVE_SET(_type) \
1726 _type c_value; \
1727 \
1728 IEEE754_ACCESSOR_PROLOGUE (_type); \
cd43fdc5 1729 VALIDATE_REAL (3, value); \
1ee2c72e
LC
1730 c_value = IEEE754_FROM_SCM (_type) (value); \
1731 \
1732 memcpy (&c_bv[c_index], &c_value, sizeof (c_value)); \
1733 return SCM_UNSPECIFIED;
1734
1735
1736/* Single precision. */
1737
1738SCM_DEFINE (scm_bytevector_ieee_single_ref,
1739 "bytevector-ieee-single-ref",
1740 3, 0, 0,
1741 (SCM bv, SCM index, SCM endianness),
1742 "Return the IEEE-754 single from @var{bv} at "
1743 "@var{index}.")
1744#define FUNC_NAME s_scm_bytevector_ieee_single_ref
1745{
1746 IEEE754_REF (float);
1747}
1748#undef FUNC_NAME
1749
1750SCM_DEFINE (scm_bytevector_ieee_single_native_ref,
1751 "bytevector-ieee-single-native-ref",
1752 2, 0, 0,
1753 (SCM bv, SCM index),
1754 "Return the IEEE-754 single from @var{bv} at "
1755 "@var{index} using the native endianness.")
1756#define FUNC_NAME s_scm_bytevector_ieee_single_native_ref
1757{
1758 IEEE754_NATIVE_REF (float);
1759}
1760#undef FUNC_NAME
1761
1762SCM_DEFINE (scm_bytevector_ieee_single_set_x,
1763 "bytevector-ieee-single-set!",
1764 4, 0, 0,
1765 (SCM bv, SCM index, SCM value, SCM endianness),
1766 "Store real @var{value} in @var{bv} at @var{index} according to "
1767 "@var{endianness}.")
1768#define FUNC_NAME s_scm_bytevector_ieee_single_set_x
1769{
1770 IEEE754_SET (float);
1771}
1772#undef FUNC_NAME
1773
1774SCM_DEFINE (scm_bytevector_ieee_single_native_set_x,
1775 "bytevector-ieee-single-native-set!",
1776 3, 0, 0,
1777 (SCM bv, SCM index, SCM value),
1778 "Store the real @var{value} at index @var{index} "
1779 "of @var{bv} using the native endianness.")
1780#define FUNC_NAME s_scm_bytevector_ieee_single_native_set_x
1781{
1782 IEEE754_NATIVE_SET (float);
1783}
1784#undef FUNC_NAME
1785
1786
1787/* Double precision. */
1788
1789SCM_DEFINE (scm_bytevector_ieee_double_ref,
1790 "bytevector-ieee-double-ref",
1791 3, 0, 0,
1792 (SCM bv, SCM index, SCM endianness),
1793 "Return the IEEE-754 double from @var{bv} at "
1794 "@var{index}.")
1795#define FUNC_NAME s_scm_bytevector_ieee_double_ref
1796{
1797 IEEE754_REF (double);
1798}
1799#undef FUNC_NAME
1800
1801SCM_DEFINE (scm_bytevector_ieee_double_native_ref,
1802 "bytevector-ieee-double-native-ref",
1803 2, 0, 0,
1804 (SCM bv, SCM index),
1805 "Return the IEEE-754 double from @var{bv} at "
1806 "@var{index} using the native endianness.")
1807#define FUNC_NAME s_scm_bytevector_ieee_double_native_ref
1808{
1809 IEEE754_NATIVE_REF (double);
1810}
1811#undef FUNC_NAME
1812
1813SCM_DEFINE (scm_bytevector_ieee_double_set_x,
1814 "bytevector-ieee-double-set!",
1815 4, 0, 0,
1816 (SCM bv, SCM index, SCM value, SCM endianness),
1817 "Store real @var{value} in @var{bv} at @var{index} according to "
1818 "@var{endianness}.")
1819#define FUNC_NAME s_scm_bytevector_ieee_double_set_x
1820{
1821 IEEE754_SET (double);
1822}
1823#undef FUNC_NAME
1824
1825SCM_DEFINE (scm_bytevector_ieee_double_native_set_x,
1826 "bytevector-ieee-double-native-set!",
1827 3, 0, 0,
1828 (SCM bv, SCM index, SCM value),
1829 "Store the real @var{value} at index @var{index} "
1830 "of @var{bv} using the native endianness.")
1831#define FUNC_NAME s_scm_bytevector_ieee_double_native_set_x
1832{
1833 IEEE754_NATIVE_SET (double);
1834}
1835#undef FUNC_NAME
1836
1837
1838#undef IEEE754_UNION
1839#undef IEEE754_TO_SCM
1840#undef IEEE754_FROM_SCM
1841#undef IEEE754_FROM_FOREIGN_ENDIANNESS
1842#undef IEEE754_TO_FOREIGN_ENDIANNESS
1843#undef IEEE754_REF
1844#undef IEEE754_NATIVE_REF
1845#undef IEEE754_SET
1846#undef IEEE754_NATIVE_SET
1847
1848\f
1849/* Operations on strings. */
1850
1851
1852/* Produce a function that returns the length of a UTF-encoded string. */
1853#define UTF_STRLEN_FUNCTION(_utf_width) \
1854static inline size_t \
1855utf ## _utf_width ## _strlen (const uint ## _utf_width ## _t *str) \
1856{ \
1857 size_t len = 0; \
1858 const uint ## _utf_width ## _t *ptr; \
1859 for (ptr = str; \
1860 *ptr != 0; \
1861 ptr++) \
1862 { \
1863 len++; \
1864 } \
1865 \
1866 return (len * ((_utf_width) / 8)); \
1867}
1868
1869UTF_STRLEN_FUNCTION (8)
1870
1871
1872/* Return the length (in bytes) of STR, a UTF-(UTF_WIDTH) encoded string. */
1873#define UTF_STRLEN(_utf_width, _str) \
1874 utf ## _utf_width ## _strlen (_str)
1875
1876/* Return the "portable" name of the UTF encoding of size UTF_WIDTH and
1877 ENDIANNESS (Gnulib's `iconv_open' module guarantees the portability of the
1878 encoding name). */
1879static inline void
1880utf_encoding_name (char *name, size_t utf_width, SCM endianness)
1881{
1882 strcpy (name, "UTF-");
1883 strcat (name, ((utf_width == 8)
1884 ? "8"
1885 : ((utf_width == 16)
1886 ? "16"
1887 : ((utf_width == 32)
1888 ? "32"
1889 : "??"))));
1890 strcat (name,
1891 ((scm_is_eq (endianness, scm_sym_big))
1892 ? "BE"
1893 : ((scm_is_eq (endianness, scm_sym_little))
1894 ? "LE"
1895 : "unknown")));
1896}
1897
1898/* Maximum length of a UTF encoding name. */
1899#define MAX_UTF_ENCODING_NAME_LEN 16
1900
1901/* Produce the body of a `string->utf' function. */
3a5bc4fa
MG
1902#define STRING_TO_UTF(_utf_width) \
1903 SCM utf; \
1904 int err; \
1905 char c_utf_name[MAX_UTF_ENCODING_NAME_LEN]; \
1906 char *c_utf = NULL; \
1907 size_t c_strlen, c_utf_len = 0; \
1908 \
1909 SCM_VALIDATE_STRING (1, str); \
1910 if (endianness == SCM_UNDEFINED) \
1911 endianness = scm_sym_big; \
1912 else \
1913 SCM_VALIDATE_SYMBOL (2, endianness); \
1914 \
1915 utf_encoding_name (c_utf_name, (_utf_width), endianness); \
1916 \
1917 c_strlen = scm_i_string_length (str); \
1918 if (scm_i_is_narrow_string (str)) \
1919 { \
1920 err = mem_iconveh (scm_i_string_chars (str), c_strlen, \
1921 "ISO-8859-1", c_utf_name, \
1922 iconveh_question_mark, NULL, \
1923 &c_utf, &c_utf_len); \
1924 if (SCM_UNLIKELY (err)) \
1925 scm_syserror_msg (FUNC_NAME, "failed to convert string: ~A", \
1926 scm_list_1 (str), err); \
1927 } \
1928 else \
1929 { \
1930 const scm_t_wchar *wbuf = scm_i_string_wide_chars (str); \
1931 c_utf = u32_conv_to_encoding (c_utf_name, \
1932 iconveh_question_mark, \
1933 (scm_t_uint32 *) wbuf, \
1934 c_strlen, NULL, NULL, &c_utf_len); \
1935 if (SCM_UNLIKELY (c_utf == NULL)) \
1936 scm_syserror_msg (FUNC_NAME, "failed to convert string: ~A", \
1937 scm_list_1 (str), errno); \
1938 } \
1939 scm_dynwind_begin (0); \
1940 scm_dynwind_free (c_utf); \
1941 utf = make_bytevector (c_utf_len, SCM_ARRAY_ELEMENT_TYPE_VU8); \
1942 memcpy (SCM_BYTEVECTOR_CONTENTS (utf), c_utf, c_utf_len); \
1943 scm_dynwind_end (); \
1944 \
1945 return (utf);
1ee2c72e
LC
1946
1947
1948
1949SCM_DEFINE (scm_string_to_utf8, "string->utf8",
1950 1, 0, 0,
1951 (SCM str),
1952 "Return a newly allocated bytevector that contains the UTF-8 "
1953 "encoding of @var{str}.")
1954#define FUNC_NAME s_scm_string_to_utf8
1955{
1956 SCM utf;
1ee2c72e 1957 uint8_t *c_utf;
3a5bc4fa 1958 size_t c_strlen, c_utf_len = 0;
1ee2c72e
LC
1959
1960 SCM_VALIDATE_STRING (1, str);
1961
3a5bc4fa
MG
1962 c_strlen = scm_i_string_length (str);
1963 if (scm_i_is_narrow_string (str))
1964 c_utf = u8_conv_from_encoding ("ISO-8859-1", iconveh_question_mark,
1965 scm_i_string_chars (str), c_strlen,
1966 NULL, NULL, &c_utf_len);
1967 else
1ee2c72e 1968 {
3a5bc4fa
MG
1969 const scm_t_wchar *wbuf = scm_i_string_wide_chars (str);
1970 c_utf = u32_to_u8 ((const uint32_t *) wbuf, c_strlen, NULL, &c_utf_len);
1ee2c72e 1971 }
1ee2c72e
LC
1972 if (SCM_UNLIKELY (c_utf == NULL))
1973 scm_syserror (FUNC_NAME);
1974 else
1ac8a47f 1975 {
1ac8a47f
LC
1976 scm_dynwind_begin (0);
1977 scm_dynwind_free (c_utf);
1978
3a5bc4fa
MG
1979 utf = make_bytevector (c_utf_len, SCM_ARRAY_ELEMENT_TYPE_VU8);
1980 memcpy (SCM_BYTEVECTOR_CONTENTS (utf), c_utf, c_utf_len);
1ac8a47f
LC
1981
1982 scm_dynwind_end ();
1983 }
1ee2c72e
LC
1984
1985 return (utf);
1986}
1987#undef FUNC_NAME
1988
1989SCM_DEFINE (scm_string_to_utf16, "string->utf16",
1990 1, 1, 0,
1991 (SCM str, SCM endianness),
1992 "Return a newly allocated bytevector that contains the UTF-16 "
1993 "encoding of @var{str}.")
1994#define FUNC_NAME s_scm_string_to_utf16
1995{
1996 STRING_TO_UTF (16);
1997}
1998#undef FUNC_NAME
1999
2000SCM_DEFINE (scm_string_to_utf32, "string->utf32",
2001 1, 1, 0,
2002 (SCM str, SCM endianness),
2003 "Return a newly allocated bytevector that contains the UTF-32 "
2004 "encoding of @var{str}.")
2005#define FUNC_NAME s_scm_string_to_utf32
2006{
2007 STRING_TO_UTF (32);
2008}
2009#undef FUNC_NAME
2010
2011
2012/* Produce the body of a function that converts a UTF-encoded bytevector to a
2013 string. */
2014#define UTF_TO_STRING(_utf_width) \
2015 SCM str = SCM_BOOL_F; \
2016 int err; \
3a5bc4fa 2017 char *c_str = NULL; \
1ee2c72e 2018 char c_utf_name[MAX_UTF_ENCODING_NAME_LEN]; \
3a5bc4fa
MG
2019 char *c_utf; \
2020 size_t c_strlen = 0, c_utf_len = 0; \
1ee2c72e
LC
2021 \
2022 SCM_VALIDATE_BYTEVECTOR (1, utf); \
2023 if (endianness == SCM_UNDEFINED) \
2024 endianness = scm_sym_big; \
2025 else \
2026 SCM_VALIDATE_SYMBOL (2, endianness); \
2027 \
2028 c_utf_len = SCM_BYTEVECTOR_LENGTH (utf); \
2029 c_utf = (char *) SCM_BYTEVECTOR_CONTENTS (utf); \
2030 utf_encoding_name (c_utf_name, (_utf_width), endianness); \
2031 \
1ee2c72e 2032 err = mem_iconveh (c_utf, c_utf_len, \
3a5bc4fa 2033 c_utf_name, "UTF-8", \
1ee2c72e
LC
2034 iconveh_question_mark, NULL, \
2035 &c_str, &c_strlen); \
2036 if (SCM_UNLIKELY (err)) \
2037 scm_syserror_msg (FUNC_NAME, "failed to convert to string: ~A", \
2038 scm_list_1 (utf), err); \
2039 else \
3a5bc4fa
MG
2040 { \
2041 str = scm_from_stringn (c_str, c_strlen, "UTF-8", \
2042 SCM_FAILED_CONVERSION_ERROR); \
2043 free (c_str); \
2044 } \
1ee2c72e
LC
2045 return (str);
2046
2047
2048SCM_DEFINE (scm_utf8_to_string, "utf8->string",
2049 1, 0, 0,
2050 (SCM utf),
2051 "Return a newly allocate string that contains from the UTF-8-"
2052 "encoded contents of bytevector @var{utf}.")
2053#define FUNC_NAME s_scm_utf8_to_string
2054{
2055 SCM str;
1ee2c72e 2056 const char *c_utf;
3a5bc4fa 2057 size_t c_utf_len = 0;
1ee2c72e
LC
2058
2059 SCM_VALIDATE_BYTEVECTOR (1, utf);
2060
2061 c_utf_len = SCM_BYTEVECTOR_LENGTH (utf);
1ee2c72e 2062 c_utf = (char *) SCM_BYTEVECTOR_CONTENTS (utf);
3a5bc4fa
MG
2063 str = scm_from_stringn (c_utf, c_utf_len, "UTF-8",
2064 SCM_FAILED_CONVERSION_ERROR);
1ee2c72e
LC
2065
2066 return (str);
2067}
2068#undef FUNC_NAME
2069
2070SCM_DEFINE (scm_utf16_to_string, "utf16->string",
2071 1, 1, 0,
2072 (SCM utf, SCM endianness),
2073 "Return a newly allocate string that contains from the UTF-16-"
2074 "encoded contents of bytevector @var{utf}.")
2075#define FUNC_NAME s_scm_utf16_to_string
2076{
2077 UTF_TO_STRING (16);
2078}
2079#undef FUNC_NAME
2080
2081SCM_DEFINE (scm_utf32_to_string, "utf32->string",
2082 1, 1, 0,
2083 (SCM utf, SCM endianness),
2084 "Return a newly allocate string that contains from the UTF-32-"
2085 "encoded contents of bytevector @var{utf}.")
2086#define FUNC_NAME s_scm_utf32_to_string
2087{
2088 UTF_TO_STRING (32);
2089}
2090#undef FUNC_NAME
2091
1ee2c72e 2092\f
2a610be5
AW
2093/* Bytevectors as generalized vectors & arrays. */
2094
e286c973
AW
2095
2096static SCM
2097bytevector_ref_c32 (SCM bv, SCM idx)
2098{ /* FIXME add some checks */
2099 const float *contents = (const float*)SCM_BYTEVECTOR_CONTENTS (bv);
2100 size_t i = scm_to_size_t (idx);
a2689737 2101 return scm_c_make_rectangular (contents[i/4], contents[i/4 + 1]);
e286c973
AW
2102}
2103
2104static SCM
2105bytevector_ref_c64 (SCM bv, SCM idx)
2106{ /* FIXME add some checks */
2107 const double *contents = (const double*)SCM_BYTEVECTOR_CONTENTS (bv);
2108 size_t i = scm_to_size_t (idx);
a2689737 2109 return scm_c_make_rectangular (contents[i/8], contents[i/8 + 1]);
e286c973
AW
2110}
2111
2112typedef SCM (*scm_t_bytevector_ref_fn)(SCM, SCM);
2113
2114const scm_t_bytevector_ref_fn bytevector_ref_fns[SCM_ARRAY_ELEMENT_TYPE_LAST + 1] =
2115{
2116 NULL, /* SCM */
2117 NULL, /* CHAR */
2118 NULL, /* BIT */
2119 scm_bytevector_u8_ref, /* VU8 */
2120 scm_bytevector_u8_ref, /* U8 */
2121 scm_bytevector_s8_ref,
2122 scm_bytevector_u16_native_ref,
2123 scm_bytevector_s16_native_ref,
2124 scm_bytevector_u32_native_ref,
2125 scm_bytevector_s32_native_ref,
2126 scm_bytevector_u64_native_ref,
2127 scm_bytevector_s64_native_ref,
2128 scm_bytevector_ieee_single_native_ref,
2129 scm_bytevector_ieee_double_native_ref,
2130 bytevector_ref_c32,
2131 bytevector_ref_c64
2132};
2133
2a610be5
AW
2134static SCM
2135bv_handle_ref (scm_t_array_handle *h, size_t index)
2136{
e286c973
AW
2137 SCM byte_index;
2138 scm_t_bytevector_ref_fn ref_fn;
2139
2140 ref_fn = bytevector_ref_fns[h->element_type];
2141 byte_index =
2142 scm_from_size_t (index * scm_array_handle_uniform_element_size (h));
2143 return ref_fn (h->array, byte_index);
2144}
2145
a2689737 2146/* FIXME add checks!!! */
e286c973
AW
2147static SCM
2148bytevector_set_c32 (SCM bv, SCM idx, SCM val)
a2689737 2149{ float *contents = (float*)SCM_BYTEVECTOR_CONTENTS (bv);
e286c973 2150 size_t i = scm_to_size_t (idx);
a2689737
AW
2151 contents[i/4] = scm_c_real_part (val);
2152 contents[i/4 + 1] = scm_c_imag_part (val);
e286c973 2153 return SCM_UNSPECIFIED;
2a610be5
AW
2154}
2155
e286c973
AW
2156static SCM
2157bytevector_set_c64 (SCM bv, SCM idx, SCM val)
a2689737 2158{ double *contents = (double*)SCM_BYTEVECTOR_CONTENTS (bv);
e286c973 2159 size_t i = scm_to_size_t (idx);
a2689737
AW
2160 contents[i/8] = scm_c_real_part (val);
2161 contents[i/8 + 1] = scm_c_imag_part (val);
e286c973
AW
2162 return SCM_UNSPECIFIED;
2163}
2164
2165typedef SCM (*scm_t_bytevector_set_fn)(SCM, SCM, SCM);
2166
2167const scm_t_bytevector_set_fn bytevector_set_fns[SCM_ARRAY_ELEMENT_TYPE_LAST + 1] =
2168{
2169 NULL, /* SCM */
2170 NULL, /* CHAR */
2171 NULL, /* BIT */
2172 scm_bytevector_u8_set_x, /* VU8 */
2173 scm_bytevector_u8_set_x, /* U8 */
2174 scm_bytevector_s8_set_x,
2175 scm_bytevector_u16_native_set_x,
2176 scm_bytevector_s16_native_set_x,
2177 scm_bytevector_u32_native_set_x,
2178 scm_bytevector_s32_native_set_x,
2179 scm_bytevector_u64_native_set_x,
2180 scm_bytevector_s64_native_set_x,
2181 scm_bytevector_ieee_single_native_set_x,
2182 scm_bytevector_ieee_double_native_set_x,
2183 bytevector_set_c32,
2184 bytevector_set_c64
2185};
2186
2a610be5
AW
2187static void
2188bv_handle_set_x (scm_t_array_handle *h, size_t index, SCM val)
2189{
e286c973
AW
2190 SCM byte_index;
2191 scm_t_bytevector_set_fn set_fn;
2192
2193 set_fn = bytevector_set_fns[h->element_type];
2194 byte_index =
2195 scm_from_size_t (index * scm_array_handle_uniform_element_size (h));
2196 set_fn (h->array, byte_index, val);
2a610be5
AW
2197}
2198
2199static void
2200bytevector_get_handle (SCM v, scm_t_array_handle *h)
2201{
2202 h->array = v;
2203 h->ndims = 1;
2204 h->dims = &h->dim0;
2205 h->dim0.lbnd = 0;
e286c973 2206 h->dim0.ubnd = SCM_BYTEVECTOR_TYPED_LENGTH (v) - 1;
2a610be5 2207 h->dim0.inc = 1;
e286c973 2208 h->element_type = SCM_BYTEVECTOR_ELEMENT_TYPE (v);
2a610be5
AW
2209 h->elements = h->writable_elements = SCM_BYTEVECTOR_CONTENTS (v);
2210}
2211
2212\f
1ee2c72e
LC
2213/* Initialization. */
2214
cfb4702f
LC
2215void
2216scm_bootstrap_bytevectors (void)
2217{
807e5a66 2218 /* This must be instantiated here because the generalized-vector API may
07d22c02 2219 want to access bytevectors even though `(rnrs bytevectors)' hasn't been
807e5a66 2220 loaded. */
562cd1b8 2221 scm_null_bytevector = make_bytevector (0, SCM_ARRAY_ELEMENT_TYPE_VU8);
cfb4702f 2222
caa92f5e 2223#ifdef WORDS_BIGENDIAN
4a655e50 2224 scm_i_native_endianness = scm_from_latin1_symbol ("big");
caa92f5e 2225#else
4a655e50 2226 scm_i_native_endianness = scm_from_latin1_symbol ("little");
caa92f5e
AW
2227#endif
2228
44602b08
AW
2229 scm_c_register_extension ("libguile-" SCM_EFFECTIVE_VERSION,
2230 "scm_init_bytevectors",
cfb4702f
LC
2231 (scm_t_extension_init_func) scm_init_bytevectors,
2232 NULL);
2a610be5
AW
2233
2234 {
2235 scm_t_array_implementation impl;
807e5a66
LC
2236
2237 impl.tag = scm_tc7_bytevector;
2238 impl.mask = 0x7f;
2a610be5
AW
2239 impl.vref = bv_handle_ref;
2240 impl.vset = bv_handle_set_x;
2241 impl.get_handle = bytevector_get_handle;
2242 scm_i_register_array_implementation (&impl);
f45eccff
AW
2243 scm_i_register_vector_constructor
2244 (scm_i_array_element_types[SCM_ARRAY_ELEMENT_TYPE_VU8],
2245 scm_make_bytevector);
2a610be5 2246 }
cfb4702f
LC
2247}
2248
1ee2c72e
LC
2249void
2250scm_init_bytevectors (void)
2251{
2252#include "libguile/bytevectors.x"
2253
1ee2c72e
LC
2254 scm_endianness_big = scm_sym_big;
2255 scm_endianness_little = scm_sym_little;
1ee2c72e 2256}