1 /* Copyright (C) 2009-2014 Free Software Foundation, Inc.
3 * This library is free software; you can redistribute it and/or
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.
8 * This library is distributed in the hope that it will be useful, but
9 * WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 * Lesser General Public License for more details.
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
15 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
29 #include "libguile/_scm.h"
30 #include "libguile/extensions.h"
31 #include "libguile/bytevectors.h"
32 #include "libguile/strings.h"
33 #include "libguile/validate.h"
34 #include "libguile/arrays.h"
35 #include "libguile/array-handle.h"
36 #include "libguile/uniform.h"
37 #include "libguile/srfi-4.h"
40 #include <striconveh.h>
47 /* Assuming 32-bit longs. */
48 # define ULONG_MAX 4294967295UL
57 /* Convenience macros. These are used by the various templates (macros) that
58 are parameterized by integer signedness. */
59 #define INT8_T_signed scm_t_int8
60 #define INT8_T_unsigned scm_t_uint8
61 #define INT16_T_signed scm_t_int16
62 #define INT16_T_unsigned scm_t_uint16
63 #define INT32_T_signed scm_t_int32
64 #define INT32_T_unsigned scm_t_uint32
65 #define is_signed_int8(_x) (((_x) >= -128L) && ((_x) <= 127L))
66 #define is_unsigned_int8(_x) ((_x) <= 255UL)
67 #define is_signed_int16(_x) (((_x) >= -32768L) && ((_x) <= 32767L))
68 #define is_unsigned_int16(_x) ((_x) <= 65535UL)
69 #define is_signed_int32(_x) (((_x) >= -2147483648L) && ((_x) <= 2147483647L))
70 #define is_unsigned_int32(_x) ((_x) <= 4294967295UL)
71 #define SIGNEDNESS_signed 1
72 #define SIGNEDNESS_unsigned 0
74 #define INT_TYPE(_size, _sign) INT ## _size ## _T_ ## _sign
75 #define INT_SWAP(_size) bswap_ ## _size
76 #define INT_VALID_P(_size, _sign) is_ ## _sign ## _int ## _size
77 #define SIGNEDNESS(_sign) SIGNEDNESS_ ## _sign
80 #define INTEGER_ACCESSOR_PROLOGUE(_len, _sign) \
81 size_t c_len, c_index; \
84 SCM_VALIDATE_BYTEVECTOR (1, bv); \
85 c_index = scm_to_uint (index); \
87 c_len = SCM_BYTEVECTOR_LENGTH (bv); \
88 c_bv = (_sign char *) SCM_BYTEVECTOR_CONTENTS (bv); \
90 if (SCM_UNLIKELY (c_index + ((_len) >> 3UL) - 1 >= c_len)) \
91 scm_out_of_range (FUNC_NAME, index);
93 /* Template for fixed-size integer access (only 8, 16 or 32-bit). */
94 #define INTEGER_REF(_len, _sign) \
97 INTEGER_ACCESSOR_PROLOGUE (_len, _sign); \
98 SCM_VALIDATE_SYMBOL (3, endianness); \
101 INT_TYPE (_len, _sign) c_result; \
103 memcpy (&c_result, &c_bv[c_index], (_len) / 8); \
104 if (!scm_is_eq (endianness, scm_i_native_endianness)) \
105 c_result = INT_SWAP (_len) (c_result); \
107 result = SCM_I_MAKINUM (c_result); \
112 /* Template for fixed-size integer access using the native endianness. */
113 #define INTEGER_NATIVE_REF(_len, _sign) \
116 INTEGER_ACCESSOR_PROLOGUE (_len, _sign); \
119 INT_TYPE (_len, _sign) c_result; \
121 memcpy (&c_result, &c_bv[c_index], (_len) / 8); \
122 result = SCM_I_MAKINUM (c_result); \
127 /* Template for fixed-size integer modification (only 8, 16 or 32-bit). */
128 #define INTEGER_SET(_len, _sign) \
129 INTEGER_ACCESSOR_PROLOGUE (_len, _sign); \
130 SCM_VALIDATE_SYMBOL (3, endianness); \
133 scm_t_signed_bits c_value; \
134 INT_TYPE (_len, _sign) c_value_short; \
136 if (SCM_UNLIKELY (!SCM_I_INUMP (value))) \
137 scm_wrong_type_arg (FUNC_NAME, 3, value); \
139 c_value = SCM_I_INUM (value); \
140 if (SCM_UNLIKELY (!INT_VALID_P (_len, _sign) (c_value))) \
141 scm_out_of_range (FUNC_NAME, value); \
143 c_value_short = (INT_TYPE (_len, _sign)) c_value; \
144 if (!scm_is_eq (endianness, scm_i_native_endianness)) \
145 c_value_short = INT_SWAP (_len) (c_value_short); \
147 memcpy (&c_bv[c_index], &c_value_short, (_len) / 8); \
150 return SCM_UNSPECIFIED;
152 /* Template for fixed-size integer modification using the native
154 #define INTEGER_NATIVE_SET(_len, _sign) \
155 INTEGER_ACCESSOR_PROLOGUE (_len, _sign); \
158 scm_t_signed_bits c_value; \
159 INT_TYPE (_len, _sign) c_value_short; \
161 if (SCM_UNLIKELY (!SCM_I_INUMP (value))) \
162 scm_wrong_type_arg (FUNC_NAME, 3, value); \
164 c_value = SCM_I_INUM (value); \
165 if (SCM_UNLIKELY (!INT_VALID_P (_len, _sign) (c_value))) \
166 scm_out_of_range (FUNC_NAME, value); \
168 c_value_short = (INT_TYPE (_len, _sign)) c_value; \
170 memcpy (&c_bv[c_index], &c_value_short, (_len) / 8); \
173 return SCM_UNSPECIFIED;
177 /* Bytevector type. */
179 #define SCM_BYTEVECTOR_HEADER_BYTES \
180 (SCM_BYTEVECTOR_HEADER_SIZE * sizeof (scm_t_bits))
182 #define SCM_BYTEVECTOR_SET_LENGTH(_bv, _len) \
183 SCM_SET_CELL_WORD_1 ((_bv), (scm_t_bits) (_len))
184 #define SCM_BYTEVECTOR_SET_CONTENTS(_bv, _contents) \
185 SCM_SET_CELL_WORD_2 ((_bv), (scm_t_bits) (_contents))
186 #define SCM_BYTEVECTOR_SET_CONTIGUOUS_P(bv, contiguous_p) \
187 SCM_SET_BYTEVECTOR_FLAGS ((bv), \
188 SCM_BYTEVECTOR_ELEMENT_TYPE (bv) \
189 | ((contiguous_p) << 8UL))
191 #define SCM_BYTEVECTOR_SET_ELEMENT_TYPE(bv, hint) \
192 SCM_SET_BYTEVECTOR_FLAGS ((bv), \
194 | (SCM_BYTEVECTOR_CONTIGUOUS_P (bv) << 8UL))
195 #define SCM_BYTEVECTOR_SET_PARENT(_bv, _parent) \
196 SCM_SET_CELL_OBJECT_3 ((_bv), (_parent))
198 #define SCM_BYTEVECTOR_TYPE_SIZE(var) \
199 (scm_i_array_element_type_sizes[SCM_BYTEVECTOR_ELEMENT_TYPE (var)]/8)
200 #define SCM_BYTEVECTOR_TYPED_LENGTH(var) \
201 (SCM_BYTEVECTOR_LENGTH (var) / SCM_BYTEVECTOR_TYPE_SIZE (var))
203 /* The empty bytevector. */
204 SCM scm_null_bytevector
= SCM_UNSPECIFIED
;
208 make_bytevector (size_t len
, scm_t_array_element_type element_type
)
213 if (SCM_UNLIKELY (element_type
> SCM_ARRAY_ELEMENT_TYPE_LAST
214 || scm_i_array_element_type_sizes
[element_type
] < 8
215 || len
>= (((size_t) -1)
216 / (scm_i_array_element_type_sizes
[element_type
]/8))))
217 /* This would be an internal Guile programming error */
220 if (SCM_UNLIKELY (len
== 0 && element_type
== SCM_ARRAY_ELEMENT_TYPE_VU8
221 && SCM_BYTEVECTOR_P (scm_null_bytevector
)))
222 ret
= scm_null_bytevector
;
225 signed char *contents
;
227 c_len
= len
* (scm_i_array_element_type_sizes
[element_type
] / 8);
229 contents
= scm_gc_malloc_pointerless (SCM_BYTEVECTOR_HEADER_BYTES
+ c_len
,
231 ret
= SCM_PACK_POINTER (contents
);
232 contents
+= SCM_BYTEVECTOR_HEADER_BYTES
;
234 SCM_BYTEVECTOR_SET_LENGTH (ret
, c_len
);
235 SCM_BYTEVECTOR_SET_CONTENTS (ret
, contents
);
236 SCM_BYTEVECTOR_SET_CONTIGUOUS_P (ret
, 1);
237 SCM_BYTEVECTOR_SET_ELEMENT_TYPE (ret
, element_type
);
238 SCM_BYTEVECTOR_SET_PARENT (ret
, SCM_BOOL_F
);
244 /* Return a bytevector of LEN elements of type ELEMENT_TYPE, with element
245 values taken from CONTENTS. Assume that the storage for CONTENTS will be
246 automatically reclaimed when it becomes unreachable. */
248 make_bytevector_from_buffer (size_t len
, void *contents
,
249 scm_t_array_element_type element_type
)
253 if (SCM_UNLIKELY (len
== 0))
254 ret
= make_bytevector (len
, element_type
);
259 ret
= SCM_PACK_POINTER (scm_gc_malloc (SCM_BYTEVECTOR_HEADER_BYTES
,
262 c_len
= len
* (scm_i_array_element_type_sizes
[element_type
] / 8);
264 SCM_BYTEVECTOR_SET_LENGTH (ret
, c_len
);
265 SCM_BYTEVECTOR_SET_CONTENTS (ret
, contents
);
266 SCM_BYTEVECTOR_SET_CONTIGUOUS_P (ret
, 0);
267 SCM_BYTEVECTOR_SET_ELEMENT_TYPE (ret
, element_type
);
268 SCM_BYTEVECTOR_SET_PARENT (ret
, SCM_BOOL_F
);
275 /* Return a new bytevector of size LEN octets. */
277 scm_c_make_bytevector (size_t len
)
279 return make_bytevector (len
, SCM_ARRAY_ELEMENT_TYPE_VU8
);
282 /* Return a new bytevector of size LEN elements. */
284 scm_i_make_typed_bytevector (size_t len
, scm_t_array_element_type element_type
)
286 return make_bytevector (len
, element_type
);
289 /* Return a bytevector of size LEN made up of CONTENTS. The area
290 pointed to by CONTENTS must be protected from GC somehow: either
291 because it was allocated using `scm_gc_malloc ()', or because it is
294 scm_c_take_gc_bytevector (signed char *contents
, size_t len
, SCM parent
)
298 ret
= make_bytevector_from_buffer (len
, contents
, SCM_ARRAY_ELEMENT_TYPE_VU8
);
299 SCM_BYTEVECTOR_SET_PARENT (ret
, parent
);
305 scm_c_take_typed_bytevector (signed char *contents
, size_t len
,
306 scm_t_array_element_type element_type
, SCM parent
)
310 ret
= make_bytevector_from_buffer (len
, contents
, element_type
);
311 SCM_BYTEVECTOR_SET_PARENT (ret
, parent
);
316 /* Shrink BV to C_NEW_LEN (which is assumed to be smaller than its current
317 size) and return the new bytevector (possibly different from BV). */
319 scm_c_shrink_bytevector (SCM bv
, size_t c_new_len
)
324 if (SCM_UNLIKELY (c_new_len
% SCM_BYTEVECTOR_TYPE_SIZE (bv
)))
325 /* This would be an internal Guile programming error */
328 c_len
= SCM_BYTEVECTOR_LENGTH (bv
);
329 if (SCM_UNLIKELY (c_new_len
> c_len
))
332 SCM_BYTEVECTOR_SET_LENGTH (bv
, c_new_len
);
334 if (SCM_BYTEVECTOR_CONTIGUOUS_P (bv
))
338 c_bv
= scm_gc_realloc (SCM2PTR (bv
),
339 c_len
+ SCM_BYTEVECTOR_HEADER_BYTES
,
340 c_new_len
+ SCM_BYTEVECTOR_HEADER_BYTES
,
342 new_bv
= PTR2SCM (c_bv
);
343 SCM_BYTEVECTOR_SET_CONTENTS (new_bv
, c_bv
+ SCM_BYTEVECTOR_HEADER_BYTES
);
349 c_bv
= scm_gc_realloc (SCM_BYTEVECTOR_CONTENTS (bv
),
350 c_len
, c_new_len
, SCM_GC_BYTEVECTOR
);
351 SCM_BYTEVECTOR_SET_CONTENTS (bv
, c_bv
);
360 scm_is_bytevector (SCM obj
)
362 return SCM_BYTEVECTOR_P (obj
);
366 scm_c_bytevector_length (SCM bv
)
367 #define FUNC_NAME "scm_c_bytevector_length"
369 SCM_VALIDATE_BYTEVECTOR (1, bv
);
371 return SCM_BYTEVECTOR_LENGTH (bv
);
376 scm_c_bytevector_ref (SCM bv
, size_t index
)
377 #define FUNC_NAME "scm_c_bytevector_ref"
380 const scm_t_uint8
*c_bv
;
382 SCM_VALIDATE_BYTEVECTOR (1, bv
);
384 c_len
= SCM_BYTEVECTOR_LENGTH (bv
);
385 c_bv
= (scm_t_uint8
*) SCM_BYTEVECTOR_CONTENTS (bv
);
387 if (SCM_UNLIKELY (index
>= c_len
))
388 scm_out_of_range (FUNC_NAME
, scm_from_size_t (index
));
395 scm_c_bytevector_set_x (SCM bv
, size_t index
, scm_t_uint8 value
)
396 #define FUNC_NAME "scm_c_bytevector_set_x"
401 SCM_VALIDATE_BYTEVECTOR (1, bv
);
403 c_len
= SCM_BYTEVECTOR_LENGTH (bv
);
404 c_bv
= (scm_t_uint8
*) SCM_BYTEVECTOR_CONTENTS (bv
);
406 if (SCM_UNLIKELY (index
>= c_len
))
407 scm_out_of_range (FUNC_NAME
, scm_from_size_t (index
));
416 scm_i_print_bytevector (SCM bv
, SCM port
, scm_print_state
*pstate SCM_UNUSED
)
418 ssize_t ubnd
, inc
, i
;
419 scm_t_array_handle h
;
421 scm_array_get_handle (bv
, &h
);
423 scm_putc_unlocked ('#', port
);
424 scm_write (scm_array_handle_element_type (&h
), port
);
425 scm_putc_unlocked ('(', port
);
426 for (i
= h
.dims
[0].lbnd
, ubnd
= h
.dims
[0].ubnd
, inc
= h
.dims
[0].inc
;
430 scm_putc_unlocked (' ', port
);
431 scm_write (scm_array_handle_ref (&h
, i
), port
);
433 scm_putc_unlocked (')', port
);
439 /* General operations. */
441 SCM_SYMBOL (scm_sym_big
, "big");
442 SCM_SYMBOL (scm_sym_little
, "little");
444 SCM scm_endianness_big
, scm_endianness_little
;
446 /* Host endianness (a symbol). */
447 SCM scm_i_native_endianness
= SCM_UNSPECIFIED
;
451 # define bswap_24(_x) \
452 ((((_x) & 0xff0000) >> 16) | \
453 (((_x) & 0x00ff00)) | \
454 (((_x) & 0x0000ff) << 16))
458 SCM_DEFINE (scm_native_endianness
, "native-endianness", 0, 0, 0,
460 "Return a symbol denoting the machine's native endianness.")
461 #define FUNC_NAME s_scm_native_endianness
463 return scm_i_native_endianness
;
467 SCM_DEFINE (scm_bytevector_p
, "bytevector?", 1, 0, 0,
469 "Return true if @var{obj} is a bytevector.")
470 #define FUNC_NAME s_scm_bytevector_p
472 return scm_from_bool (scm_is_bytevector (obj
));
476 SCM_DEFINE (scm_make_bytevector
, "make-bytevector", 1, 1, 0,
478 "Return a newly allocated bytevector of @var{len} bytes, "
479 "optionally filled with @var{fill}.")
480 #define FUNC_NAME s_scm_make_bytevector
484 signed char c_fill
= '\0';
486 SCM_VALIDATE_UINT_COPY (1, len
, c_len
);
487 if (!scm_is_eq (fill
, SCM_UNDEFINED
))
491 value
= scm_to_int (fill
);
492 if (SCM_UNLIKELY ((value
< -128) || (value
> 255)))
493 scm_out_of_range (FUNC_NAME
, fill
);
494 c_fill
= (signed char) value
;
497 bv
= make_bytevector (c_len
, SCM_ARRAY_ELEMENT_TYPE_VU8
);
498 if (!scm_is_eq (fill
, SCM_UNDEFINED
))
501 signed char *contents
;
503 contents
= SCM_BYTEVECTOR_CONTENTS (bv
);
504 for (i
= 0; i
< c_len
; i
++)
505 contents
[i
] = c_fill
;
508 memset (SCM_BYTEVECTOR_CONTENTS (bv
), 0, c_len
);
514 SCM_DEFINE (scm_bytevector_length
, "bytevector-length", 1, 0, 0,
516 "Return the length (in bytes) of @var{bv}.")
517 #define FUNC_NAME s_scm_bytevector_length
519 return scm_from_uint (scm_c_bytevector_length (bv
));
523 SCM_DEFINE (scm_bytevector_eq_p
, "bytevector=?", 2, 0, 0,
525 "Return is @var{bv1} equals to @var{bv2}---i.e., if they "
526 "have the same length and contents.")
527 #define FUNC_NAME s_scm_bytevector_eq_p
529 SCM result
= SCM_BOOL_F
;
530 unsigned c_len1
, c_len2
;
532 SCM_VALIDATE_BYTEVECTOR (1, bv1
);
533 SCM_VALIDATE_BYTEVECTOR (2, bv2
);
535 c_len1
= SCM_BYTEVECTOR_LENGTH (bv1
);
536 c_len2
= SCM_BYTEVECTOR_LENGTH (bv2
);
538 if (c_len1
== c_len2
&& (SCM_BYTEVECTOR_ELEMENT_TYPE (bv1
)
539 == SCM_BYTEVECTOR_ELEMENT_TYPE (bv2
)))
541 signed char *c_bv1
, *c_bv2
;
543 c_bv1
= SCM_BYTEVECTOR_CONTENTS (bv1
);
544 c_bv2
= SCM_BYTEVECTOR_CONTENTS (bv2
);
546 result
= scm_from_bool (!memcmp (c_bv1
, c_bv2
, c_len1
));
553 SCM_DEFINE (scm_bytevector_fill_x
, "bytevector-fill!", 2, 0, 0,
555 "Fill bytevector @var{bv} with @var{fill}, a byte.")
556 #define FUNC_NAME s_scm_bytevector_fill_x
559 signed char *c_bv
, c_fill
;
561 SCM_VALIDATE_BYTEVECTOR (1, bv
);
562 c_fill
= scm_to_int8 (fill
);
564 c_len
= SCM_BYTEVECTOR_LENGTH (bv
);
565 c_bv
= SCM_BYTEVECTOR_CONTENTS (bv
);
567 for (i
= 0; i
< c_len
; i
++)
570 return SCM_UNSPECIFIED
;
574 SCM_DEFINE (scm_bytevector_copy_x
, "bytevector-copy!", 5, 0, 0,
575 (SCM source
, SCM source_start
, SCM target
, SCM target_start
,
577 "Copy @var{len} bytes from @var{source} into @var{target}, "
578 "starting reading from @var{source_start} (a positive index "
579 "within @var{source}) and start writing at "
580 "@var{target_start}.")
581 #define FUNC_NAME s_scm_bytevector_copy_x
583 unsigned c_len
, c_source_len
, c_target_len
;
584 unsigned c_source_start
, c_target_start
;
585 signed char *c_source
, *c_target
;
587 SCM_VALIDATE_BYTEVECTOR (1, source
);
588 SCM_VALIDATE_BYTEVECTOR (3, target
);
590 c_len
= scm_to_uint (len
);
591 c_source_start
= scm_to_uint (source_start
);
592 c_target_start
= scm_to_uint (target_start
);
594 c_source
= SCM_BYTEVECTOR_CONTENTS (source
);
595 c_target
= SCM_BYTEVECTOR_CONTENTS (target
);
596 c_source_len
= SCM_BYTEVECTOR_LENGTH (source
);
597 c_target_len
= SCM_BYTEVECTOR_LENGTH (target
);
599 if (SCM_UNLIKELY (c_source_start
+ c_len
> c_source_len
))
600 scm_out_of_range (FUNC_NAME
, source_start
);
601 if (SCM_UNLIKELY (c_target_start
+ c_len
> c_target_len
))
602 scm_out_of_range (FUNC_NAME
, target_start
);
604 memmove (c_target
+ c_target_start
,
605 c_source
+ c_source_start
,
608 return SCM_UNSPECIFIED
;
612 SCM_DEFINE (scm_bytevector_copy
, "bytevector-copy", 1, 0, 0,
614 "Return a newly allocated copy of @var{bv}.")
615 #define FUNC_NAME s_scm_bytevector_copy
619 signed char *c_bv
, *c_copy
;
621 SCM_VALIDATE_BYTEVECTOR (1, bv
);
623 c_len
= SCM_BYTEVECTOR_LENGTH (bv
);
624 c_bv
= SCM_BYTEVECTOR_CONTENTS (bv
);
626 copy
= make_bytevector (c_len
, SCM_BYTEVECTOR_ELEMENT_TYPE (bv
));
627 c_copy
= SCM_BYTEVECTOR_CONTENTS (copy
);
628 memcpy (c_copy
, c_bv
, c_len
);
634 SCM_DEFINE (scm_uniform_array_to_bytevector
, "uniform-array->bytevector",
635 1, 0, 0, (SCM array
),
636 "Return a newly allocated bytevector whose contents\n"
637 "will be copied from the uniform array @var{array}.")
638 #define FUNC_NAME s_scm_uniform_array_to_bytevector
641 size_t len
, sz
, byte_len
;
642 scm_t_array_handle h
;
645 contents
= scm_array_contents (array
, SCM_BOOL_T
);
646 if (scm_is_false (contents
))
647 scm_wrong_type_arg_msg (FUNC_NAME
, 0, array
, "uniform contiguous array");
649 scm_array_get_handle (contents
, &h
);
650 assert (h
.base
== 0);
653 len
= h
.dims
->inc
* (h
.dims
->ubnd
- h
.dims
->lbnd
+ 1);
654 sz
= scm_array_handle_uniform_element_bit_size (&h
);
655 if (sz
>= 8 && ((sz
% 8) == 0))
656 byte_len
= len
* (sz
/ 8);
658 /* Elements of sub-byte size (bitvectors) are addressed in 32-bit
660 byte_len
= ((len
* sz
+ 31) / 32) * 4;
662 /* an internal guile error, really */
663 SCM_MISC_ERROR ("uniform elements larger than 8 bits must fill whole bytes", SCM_EOL
);
665 ret
= make_bytevector (byte_len
, SCM_ARRAY_ELEMENT_TYPE_VU8
);
666 memcpy (SCM_BYTEVECTOR_CONTENTS (ret
), elts
, byte_len
);
668 scm_array_handle_release (&h
);
675 /* Operations on bytes and octets. */
677 SCM_DEFINE (scm_bytevector_u8_ref
, "bytevector-u8-ref", 2, 0, 0,
679 "Return the octet located at @var{index} in @var{bv}.")
680 #define FUNC_NAME s_scm_bytevector_u8_ref
682 INTEGER_NATIVE_REF (8, unsigned);
686 SCM_DEFINE (scm_bytevector_s8_ref
, "bytevector-s8-ref", 2, 0, 0,
688 "Return the byte located at @var{index} in @var{bv}.")
689 #define FUNC_NAME s_scm_bytevector_s8_ref
691 INTEGER_NATIVE_REF (8, signed);
695 SCM_DEFINE (scm_bytevector_u8_set_x
, "bytevector-u8-set!", 3, 0, 0,
696 (SCM bv
, SCM index
, SCM value
),
697 "Return the octet located at @var{index} in @var{bv}.")
698 #define FUNC_NAME s_scm_bytevector_u8_set_x
700 INTEGER_NATIVE_SET (8, unsigned);
704 SCM_DEFINE (scm_bytevector_s8_set_x
, "bytevector-s8-set!", 3, 0, 0,
705 (SCM bv
, SCM index
, SCM value
),
706 "Return the octet located at @var{index} in @var{bv}.")
707 #define FUNC_NAME s_scm_bytevector_s8_set_x
709 INTEGER_NATIVE_SET (8, signed);
713 #undef OCTET_ACCESSOR_PROLOGUE
716 SCM_DEFINE (scm_bytevector_to_u8_list
, "bytevector->u8-list", 1, 0, 0,
718 "Return a newly allocated list of octets containing the "
719 "contents of @var{bv}.")
720 #define FUNC_NAME s_scm_bytevector_to_u8_list
726 SCM_VALIDATE_BYTEVECTOR (1, bv
);
728 c_len
= SCM_BYTEVECTOR_LENGTH (bv
);
729 c_bv
= (unsigned char *) SCM_BYTEVECTOR_CONTENTS (bv
);
731 lst
= scm_make_list (scm_from_uint (c_len
), SCM_UNSPECIFIED
);
732 for (i
= 0, pair
= lst
;
734 i
++, pair
= SCM_CDR (pair
))
736 SCM_SETCAR (pair
, SCM_I_MAKINUM (c_bv
[i
]));
743 SCM_DEFINE (scm_u8_list_to_bytevector
, "u8-list->bytevector", 1, 0, 0,
745 "Turn @var{lst}, a list of octets, into a bytevector.")
746 #define FUNC_NAME s_scm_u8_list_to_bytevector
752 SCM_VALIDATE_LIST_COPYLEN (1, lst
, c_len
);
754 bv
= make_bytevector (c_len
, SCM_ARRAY_ELEMENT_TYPE_VU8
);
755 c_bv
= (unsigned char *) SCM_BYTEVECTOR_CONTENTS (bv
);
757 for (i
= 0; i
< c_len
; lst
= SCM_CDR (lst
), i
++)
759 item
= SCM_CAR (lst
);
761 if (SCM_LIKELY (SCM_I_INUMP (item
)))
763 scm_t_signed_bits c_item
;
765 c_item
= SCM_I_INUM (item
);
766 if (SCM_LIKELY ((c_item
>= 0) && (c_item
< 256)))
767 c_bv
[i
] = (unsigned char) c_item
;
778 scm_wrong_type_arg (FUNC_NAME
, 1, item
);
784 /* Compute the two's complement of VALUE (a positive integer) on SIZE octets
785 using (2^(SIZE * 8) - VALUE). */
787 twos_complement (mpz_t value
, size_t size
)
789 unsigned long bit_count
;
791 /* We expect BIT_COUNT to fit in a unsigned long thanks to the range
792 checking on SIZE performed earlier. */
793 bit_count
= (unsigned long) size
<< 3UL;
795 if (SCM_LIKELY (bit_count
< sizeof (unsigned long)))
796 mpz_ui_sub (value
, 1UL << bit_count
, value
);
802 mpz_ui_pow_ui (max
, 2, bit_count
);
803 mpz_sub (value
, max
, value
);
809 bytevector_large_ref (const char *c_bv
, size_t c_size
, int signed_p
,
814 int c_endianness
, negative_p
= 0;
818 if (scm_is_eq (endianness
, scm_sym_big
))
819 negative_p
= c_bv
[0] & 0x80;
821 negative_p
= c_bv
[c_size
- 1] & 0x80;
824 c_endianness
= scm_is_eq (endianness
, scm_sym_big
) ? 1 : -1;
827 mpz_import (c_mpz
, 1 /* 1 word */, 1 /* word order doesn't matter */,
828 c_size
/* word is C_SIZE-byte long */,
830 0 /* nails */, c_bv
);
832 if (signed_p
&& negative_p
)
834 twos_complement (c_mpz
, c_size
);
835 mpz_neg (c_mpz
, c_mpz
);
838 result
= scm_from_mpz (c_mpz
);
839 mpz_clear (c_mpz
); /* FIXME: Needed? */
845 bytevector_large_set (char *c_bv
, size_t c_size
, int signed_p
,
846 SCM value
, SCM endianness
)
849 int c_endianness
, c_sign
, err
= 0;
851 c_endianness
= scm_is_eq (endianness
, scm_sym_big
) ? 1 : -1;
854 scm_to_mpz (value
, c_mpz
);
856 c_sign
= mpz_sgn (c_mpz
);
859 if (SCM_LIKELY (signed_p
))
861 mpz_neg (c_mpz
, c_mpz
);
862 twos_complement (c_mpz
, c_size
);
873 memset (c_bv
, 0, c_size
);
876 size_t word_count
, value_size
;
878 value_size
= (mpz_sizeinbase (c_mpz
, 2) + (8 * c_size
)) / (8 * c_size
);
879 if (SCM_UNLIKELY (value_size
> c_size
))
886 mpz_export (c_bv
, &word_count
, 1 /* word order doesn't matter */,
887 c_size
, c_endianness
,
888 0 /* nails */, c_mpz
);
889 if (SCM_UNLIKELY (word_count
!= 1))
890 /* Shouldn't happen since we already checked with VALUE_SIZE. */
900 #define GENERIC_INTEGER_ACCESSOR_PROLOGUE(_sign) \
901 unsigned long c_len, c_index, c_size; \
904 SCM_VALIDATE_BYTEVECTOR (1, bv); \
905 c_index = scm_to_ulong (index); \
906 c_size = scm_to_ulong (size); \
908 c_len = SCM_BYTEVECTOR_LENGTH (bv); \
909 c_bv = (char *) SCM_BYTEVECTOR_CONTENTS (bv); \
911 /* C_SIZE must have its 3 higher bits set to zero so that \
912 multiplying it by 8 yields a number that fits in an \
914 if (SCM_UNLIKELY ((c_size == 0) || (c_size >= (ULONG_MAX >> 3L)))) \
915 scm_out_of_range (FUNC_NAME, size); \
916 if (SCM_UNLIKELY (c_index + c_size > c_len)) \
917 scm_out_of_range (FUNC_NAME, index);
920 /* Template of an integer reference function. */
921 #define GENERIC_INTEGER_REF(_sign) \
929 swap = !scm_is_eq (endianness, scm_i_native_endianness); \
934 _sign char c_value8; \
935 memcpy (&c_value8, c_bv, 1); \
941 INT_TYPE (16, _sign) c_value16; \
942 memcpy (&c_value16, c_bv, 2); \
944 value = (INT_TYPE (16, _sign)) bswap_16 (c_value16); \
953 result = SCM_I_MAKINUM ((_sign int) value); \
956 result = bytevector_large_ref ((char *) c_bv, \
957 c_size, SIGNEDNESS (_sign), \
963 bytevector_signed_ref (const char *c_bv
, size_t c_size
, SCM endianness
)
965 GENERIC_INTEGER_REF (signed);
969 bytevector_unsigned_ref (const char *c_bv
, size_t c_size
, SCM endianness
)
971 GENERIC_INTEGER_REF (unsigned);
975 /* Template of an integer assignment function. */
976 #define GENERIC_INTEGER_SET(_sign) \
979 scm_t_signed_bits c_value; \
981 if (SCM_UNLIKELY (!SCM_I_INUMP (value))) \
984 c_value = SCM_I_INUM (value); \
988 if (SCM_LIKELY (INT_VALID_P (8, _sign) (c_value))) \
990 _sign char c_value8; \
991 c_value8 = (_sign char) c_value; \
992 memcpy (c_bv, &c_value8, 1); \
999 if (SCM_LIKELY (INT_VALID_P (16, _sign) (c_value))) \
1002 INT_TYPE (16, _sign) c_value16; \
1004 swap = !scm_is_eq (endianness, scm_i_native_endianness); \
1007 c_value16 = (INT_TYPE (16, _sign)) bswap_16 (c_value); \
1009 c_value16 = c_value; \
1011 memcpy (c_bv, &c_value16, 2); \
1025 err = bytevector_large_set (c_bv, c_size, \
1026 SIGNEDNESS (_sign), \
1027 value, endianness); \
1035 scm_out_of_range (FUNC_NAME, value); \
1039 bytevector_signed_set (char *c_bv
, size_t c_size
,
1040 SCM value
, SCM endianness
,
1041 const char *func_name
)
1042 #define FUNC_NAME func_name
1044 GENERIC_INTEGER_SET (signed);
1049 bytevector_unsigned_set (char *c_bv
, size_t c_size
,
1050 SCM value
, SCM endianness
,
1051 const char *func_name
)
1052 #define FUNC_NAME func_name
1054 GENERIC_INTEGER_SET (unsigned);
1058 #undef GENERIC_INTEGER_SET
1059 #undef GENERIC_INTEGER_REF
1062 SCM_DEFINE (scm_bytevector_uint_ref
, "bytevector-uint-ref", 4, 0, 0,
1063 (SCM bv
, SCM index
, SCM endianness
, SCM size
),
1064 "Return the @var{size}-octet long unsigned integer at index "
1065 "@var{index} in @var{bv}.")
1066 #define FUNC_NAME s_scm_bytevector_uint_ref
1068 GENERIC_INTEGER_ACCESSOR_PROLOGUE (unsigned);
1070 return (bytevector_unsigned_ref (&c_bv
[c_index
], c_size
, endianness
));
1074 SCM_DEFINE (scm_bytevector_sint_ref
, "bytevector-sint-ref", 4, 0, 0,
1075 (SCM bv
, SCM index
, SCM endianness
, SCM size
),
1076 "Return the @var{size}-octet long unsigned integer at index "
1077 "@var{index} in @var{bv}.")
1078 #define FUNC_NAME s_scm_bytevector_sint_ref
1080 GENERIC_INTEGER_ACCESSOR_PROLOGUE (signed);
1082 return (bytevector_signed_ref (&c_bv
[c_index
], c_size
, endianness
));
1086 SCM_DEFINE (scm_bytevector_uint_set_x
, "bytevector-uint-set!", 5, 0, 0,
1087 (SCM bv
, SCM index
, SCM value
, SCM endianness
, SCM size
),
1088 "Set the @var{size}-octet long unsigned integer at @var{index} "
1090 #define FUNC_NAME s_scm_bytevector_uint_set_x
1092 GENERIC_INTEGER_ACCESSOR_PROLOGUE (unsigned);
1094 bytevector_unsigned_set (&c_bv
[c_index
], c_size
, value
, endianness
,
1097 return SCM_UNSPECIFIED
;
1101 SCM_DEFINE (scm_bytevector_sint_set_x
, "bytevector-sint-set!", 5, 0, 0,
1102 (SCM bv
, SCM index
, SCM value
, SCM endianness
, SCM size
),
1103 "Set the @var{size}-octet long signed integer at @var{index} "
1105 #define FUNC_NAME s_scm_bytevector_sint_set_x
1107 GENERIC_INTEGER_ACCESSOR_PROLOGUE (signed);
1109 bytevector_signed_set (&c_bv
[c_index
], c_size
, value
, endianness
,
1112 return SCM_UNSPECIFIED
;
1118 /* Operations on integers of arbitrary size. */
1120 #define INTEGERS_TO_LIST(_sign) \
1122 size_t i, c_len, c_size; \
1124 SCM_VALIDATE_BYTEVECTOR (1, bv); \
1125 SCM_VALIDATE_SYMBOL (2, endianness); \
1126 c_size = scm_to_unsigned_integer (size, 1, (size_t) -1); \
1128 c_len = SCM_BYTEVECTOR_LENGTH (bv); \
1129 if (SCM_UNLIKELY (c_len % c_size != 0)) \
1130 scm_wrong_type_arg_msg \
1131 (FUNC_NAME, 0, size, \
1132 "an exact positive integer that divides the bytevector length"); \
1133 else if (SCM_UNLIKELY (c_len == 0)) \
1139 c_bv = (char *) SCM_BYTEVECTOR_CONTENTS (bv); \
1141 lst = scm_make_list (scm_from_size_t (c_len / c_size), \
1143 for (i = 0, pair = lst; \
1144 i <= c_len - c_size; \
1145 i += c_size, c_bv += c_size, pair = SCM_CDR (pair)) \
1148 bytevector_ ## _sign ## _ref (c_bv, c_size, \
1155 SCM_DEFINE (scm_bytevector_to_sint_list
, "bytevector->sint-list",
1157 (SCM bv
, SCM endianness
, SCM size
),
1158 "Return a list of signed integers of @var{size} octets "
1159 "representing the contents of @var{bv}.")
1160 #define FUNC_NAME s_scm_bytevector_to_sint_list
1162 INTEGERS_TO_LIST (signed);
1166 SCM_DEFINE (scm_bytevector_to_uint_list
, "bytevector->uint-list",
1168 (SCM bv
, SCM endianness
, SCM size
),
1169 "Return a list of unsigned integers of @var{size} octets "
1170 "representing the contents of @var{bv}.")
1171 #define FUNC_NAME s_scm_bytevector_to_uint_list
1173 INTEGERS_TO_LIST (unsigned);
1177 #undef INTEGER_TO_LIST
1180 #define INTEGER_LIST_TO_BYTEVECTOR(_sign) \
1184 char *c_bv, *c_bv_ptr; \
1186 SCM_VALIDATE_LIST_COPYLEN (1, lst, c_len); \
1187 SCM_VALIDATE_SYMBOL (2, endianness); \
1188 c_size = scm_to_uint (size); \
1190 if (SCM_UNLIKELY ((c_size == 0) || (c_size >= (ULONG_MAX >> 3L)))) \
1191 scm_out_of_range (FUNC_NAME, size); \
1193 bv = make_bytevector (c_len * c_size, SCM_ARRAY_ELEMENT_TYPE_VU8); \
1194 c_bv = (char *) SCM_BYTEVECTOR_CONTENTS (bv); \
1196 for (c_bv_ptr = c_bv; \
1197 !scm_is_null (lst); \
1198 lst = SCM_CDR (lst), c_bv_ptr += c_size) \
1200 bytevector_ ## _sign ## _set (c_bv_ptr, c_size, \
1201 SCM_CAR (lst), endianness, \
1208 SCM_DEFINE (scm_uint_list_to_bytevector
, "uint-list->bytevector",
1210 (SCM lst
, SCM endianness
, SCM size
),
1211 "Return a bytevector containing the unsigned integers "
1212 "listed in @var{lst} and encoded on @var{size} octets "
1213 "according to @var{endianness}.")
1214 #define FUNC_NAME s_scm_uint_list_to_bytevector
1216 INTEGER_LIST_TO_BYTEVECTOR (unsigned);
1220 SCM_DEFINE (scm_sint_list_to_bytevector
, "sint-list->bytevector",
1222 (SCM lst
, SCM endianness
, SCM size
),
1223 "Return a bytevector containing the signed integers "
1224 "listed in @var{lst} and encoded on @var{size} octets "
1225 "according to @var{endianness}.")
1226 #define FUNC_NAME s_scm_sint_list_to_bytevector
1228 INTEGER_LIST_TO_BYTEVECTOR (signed);
1232 #undef INTEGER_LIST_TO_BYTEVECTOR
1236 /* Operations on 16-bit integers. */
1238 SCM_DEFINE (scm_bytevector_u16_ref
, "bytevector-u16-ref",
1240 (SCM bv
, SCM index
, SCM endianness
),
1241 "Return the unsigned 16-bit integer from @var{bv} at "
1243 #define FUNC_NAME s_scm_bytevector_u16_ref
1245 INTEGER_REF (16, unsigned);
1249 SCM_DEFINE (scm_bytevector_s16_ref
, "bytevector-s16-ref",
1251 (SCM bv
, SCM index
, SCM endianness
),
1252 "Return the signed 16-bit integer from @var{bv} at "
1254 #define FUNC_NAME s_scm_bytevector_s16_ref
1256 INTEGER_REF (16, signed);
1260 SCM_DEFINE (scm_bytevector_u16_native_ref
, "bytevector-u16-native-ref",
1262 (SCM bv
, SCM index
),
1263 "Return the unsigned 16-bit integer from @var{bv} at "
1264 "@var{index} using the native endianness.")
1265 #define FUNC_NAME s_scm_bytevector_u16_native_ref
1267 INTEGER_NATIVE_REF (16, unsigned);
1271 SCM_DEFINE (scm_bytevector_s16_native_ref
, "bytevector-s16-native-ref",
1273 (SCM bv
, SCM index
),
1274 "Return the unsigned 16-bit integer from @var{bv} at "
1275 "@var{index} using the native endianness.")
1276 #define FUNC_NAME s_scm_bytevector_s16_native_ref
1278 INTEGER_NATIVE_REF (16, signed);
1282 SCM_DEFINE (scm_bytevector_u16_set_x
, "bytevector-u16-set!",
1284 (SCM bv
, SCM index
, SCM value
, SCM endianness
),
1285 "Store @var{value} in @var{bv} at @var{index} according to "
1286 "@var{endianness}.")
1287 #define FUNC_NAME s_scm_bytevector_u16_set_x
1289 INTEGER_SET (16, unsigned);
1293 SCM_DEFINE (scm_bytevector_s16_set_x
, "bytevector-s16-set!",
1295 (SCM bv
, SCM index
, SCM value
, SCM endianness
),
1296 "Store @var{value} in @var{bv} at @var{index} according to "
1297 "@var{endianness}.")
1298 #define FUNC_NAME s_scm_bytevector_s16_set_x
1300 INTEGER_SET (16, signed);
1304 SCM_DEFINE (scm_bytevector_u16_native_set_x
, "bytevector-u16-native-set!",
1306 (SCM bv
, SCM index
, SCM value
),
1307 "Store the unsigned integer @var{value} at index @var{index} "
1308 "of @var{bv} using the native endianness.")
1309 #define FUNC_NAME s_scm_bytevector_u16_native_set_x
1311 INTEGER_NATIVE_SET (16, unsigned);
1315 SCM_DEFINE (scm_bytevector_s16_native_set_x
, "bytevector-s16-native-set!",
1317 (SCM bv
, SCM index
, SCM value
),
1318 "Store the signed integer @var{value} at index @var{index} "
1319 "of @var{bv} using the native endianness.")
1320 #define FUNC_NAME s_scm_bytevector_s16_native_set_x
1322 INTEGER_NATIVE_SET (16, signed);
1328 /* Operations on 32-bit integers. */
1330 /* Unfortunately, on 32-bit machines `SCM' is not large enough to hold
1331 arbitrary 32-bit integers. Thus we fall back to using the
1332 `large_{ref,set}' variants on 32-bit machines. */
1334 #define LARGE_INTEGER_REF(_len, _sign) \
1335 INTEGER_ACCESSOR_PROLOGUE(_len, _sign); \
1336 SCM_VALIDATE_SYMBOL (3, endianness); \
1338 return (bytevector_large_ref ((char *) c_bv + c_index, _len / 8, \
1339 SIGNEDNESS (_sign), endianness));
1341 #define LARGE_INTEGER_SET(_len, _sign) \
1343 INTEGER_ACCESSOR_PROLOGUE (_len, _sign); \
1344 SCM_VALIDATE_SYMBOL (4, endianness); \
1346 err = bytevector_large_set ((char *) c_bv + c_index, _len / 8, \
1347 SIGNEDNESS (_sign), value, endianness); \
1348 if (SCM_UNLIKELY (err)) \
1349 scm_out_of_range (FUNC_NAME, value); \
1351 return SCM_UNSPECIFIED;
1353 #define LARGE_INTEGER_NATIVE_REF(_len, _sign) \
1354 INTEGER_ACCESSOR_PROLOGUE(_len, _sign); \
1355 return (bytevector_large_ref ((char *) c_bv + c_index, _len / 8, \
1356 SIGNEDNESS (_sign), scm_i_native_endianness));
1358 #define LARGE_INTEGER_NATIVE_SET(_len, _sign) \
1360 INTEGER_ACCESSOR_PROLOGUE (_len, _sign); \
1362 err = bytevector_large_set ((char *) c_bv + c_index, _len / 8, \
1363 SIGNEDNESS (_sign), value, \
1364 scm_i_native_endianness); \
1365 if (SCM_UNLIKELY (err)) \
1366 scm_out_of_range (FUNC_NAME, value); \
1368 return SCM_UNSPECIFIED;
1371 SCM_DEFINE (scm_bytevector_u32_ref
, "bytevector-u32-ref",
1373 (SCM bv
, SCM index
, SCM endianness
),
1374 "Return the unsigned 32-bit integer from @var{bv} at "
1376 #define FUNC_NAME s_scm_bytevector_u32_ref
1378 #if SIZEOF_VOID_P > 4
1379 INTEGER_REF (32, unsigned);
1381 LARGE_INTEGER_REF (32, unsigned);
1386 SCM_DEFINE (scm_bytevector_s32_ref
, "bytevector-s32-ref",
1388 (SCM bv
, SCM index
, SCM endianness
),
1389 "Return the signed 32-bit integer from @var{bv} at "
1391 #define FUNC_NAME s_scm_bytevector_s32_ref
1393 #if SIZEOF_VOID_P > 4
1394 INTEGER_REF (32, signed);
1396 LARGE_INTEGER_REF (32, signed);
1401 SCM_DEFINE (scm_bytevector_u32_native_ref
, "bytevector-u32-native-ref",
1403 (SCM bv
, SCM index
),
1404 "Return the unsigned 32-bit integer from @var{bv} at "
1405 "@var{index} using the native endianness.")
1406 #define FUNC_NAME s_scm_bytevector_u32_native_ref
1408 #if SIZEOF_VOID_P > 4
1409 INTEGER_NATIVE_REF (32, unsigned);
1411 LARGE_INTEGER_NATIVE_REF (32, unsigned);
1416 SCM_DEFINE (scm_bytevector_s32_native_ref
, "bytevector-s32-native-ref",
1418 (SCM bv
, SCM index
),
1419 "Return the unsigned 32-bit integer from @var{bv} at "
1420 "@var{index} using the native endianness.")
1421 #define FUNC_NAME s_scm_bytevector_s32_native_ref
1423 #if SIZEOF_VOID_P > 4
1424 INTEGER_NATIVE_REF (32, signed);
1426 LARGE_INTEGER_NATIVE_REF (32, signed);
1431 SCM_DEFINE (scm_bytevector_u32_set_x
, "bytevector-u32-set!",
1433 (SCM bv
, SCM index
, SCM value
, SCM endianness
),
1434 "Store @var{value} in @var{bv} at @var{index} according to "
1435 "@var{endianness}.")
1436 #define FUNC_NAME s_scm_bytevector_u32_set_x
1438 #if SIZEOF_VOID_P > 4
1439 INTEGER_SET (32, unsigned);
1441 LARGE_INTEGER_SET (32, unsigned);
1446 SCM_DEFINE (scm_bytevector_s32_set_x
, "bytevector-s32-set!",
1448 (SCM bv
, SCM index
, SCM value
, SCM endianness
),
1449 "Store @var{value} in @var{bv} at @var{index} according to "
1450 "@var{endianness}.")
1451 #define FUNC_NAME s_scm_bytevector_s32_set_x
1453 #if SIZEOF_VOID_P > 4
1454 INTEGER_SET (32, signed);
1456 LARGE_INTEGER_SET (32, signed);
1461 SCM_DEFINE (scm_bytevector_u32_native_set_x
, "bytevector-u32-native-set!",
1463 (SCM bv
, SCM index
, SCM value
),
1464 "Store the unsigned integer @var{value} at index @var{index} "
1465 "of @var{bv} using the native endianness.")
1466 #define FUNC_NAME s_scm_bytevector_u32_native_set_x
1468 #if SIZEOF_VOID_P > 4
1469 INTEGER_NATIVE_SET (32, unsigned);
1471 LARGE_INTEGER_NATIVE_SET (32, unsigned);
1476 SCM_DEFINE (scm_bytevector_s32_native_set_x
, "bytevector-s32-native-set!",
1478 (SCM bv
, SCM index
, SCM value
),
1479 "Store the signed integer @var{value} at index @var{index} "
1480 "of @var{bv} using the native endianness.")
1481 #define FUNC_NAME s_scm_bytevector_s32_native_set_x
1483 #if SIZEOF_VOID_P > 4
1484 INTEGER_NATIVE_SET (32, signed);
1486 LARGE_INTEGER_NATIVE_SET (32, signed);
1493 /* Operations on 64-bit integers. */
1495 /* For 64-bit integers, we use only the `large_{ref,set}' variant. */
1497 SCM_DEFINE (scm_bytevector_u64_ref
, "bytevector-u64-ref",
1499 (SCM bv
, SCM index
, SCM endianness
),
1500 "Return the unsigned 64-bit integer from @var{bv} at "
1502 #define FUNC_NAME s_scm_bytevector_u64_ref
1504 LARGE_INTEGER_REF (64, unsigned);
1508 SCM_DEFINE (scm_bytevector_s64_ref
, "bytevector-s64-ref",
1510 (SCM bv
, SCM index
, SCM endianness
),
1511 "Return the signed 64-bit integer from @var{bv} at "
1513 #define FUNC_NAME s_scm_bytevector_s64_ref
1515 LARGE_INTEGER_REF (64, signed);
1519 SCM_DEFINE (scm_bytevector_u64_native_ref
, "bytevector-u64-native-ref",
1521 (SCM bv
, SCM index
),
1522 "Return the unsigned 64-bit integer from @var{bv} at "
1523 "@var{index} using the native endianness.")
1524 #define FUNC_NAME s_scm_bytevector_u64_native_ref
1526 LARGE_INTEGER_NATIVE_REF (64, unsigned);
1530 SCM_DEFINE (scm_bytevector_s64_native_ref
, "bytevector-s64-native-ref",
1532 (SCM bv
, SCM index
),
1533 "Return the unsigned 64-bit integer from @var{bv} at "
1534 "@var{index} using the native endianness.")
1535 #define FUNC_NAME s_scm_bytevector_s64_native_ref
1537 LARGE_INTEGER_NATIVE_REF (64, signed);
1541 SCM_DEFINE (scm_bytevector_u64_set_x
, "bytevector-u64-set!",
1543 (SCM bv
, SCM index
, SCM value
, SCM endianness
),
1544 "Store @var{value} in @var{bv} at @var{index} according to "
1545 "@var{endianness}.")
1546 #define FUNC_NAME s_scm_bytevector_u64_set_x
1548 LARGE_INTEGER_SET (64, unsigned);
1552 SCM_DEFINE (scm_bytevector_s64_set_x
, "bytevector-s64-set!",
1554 (SCM bv
, SCM index
, SCM value
, SCM endianness
),
1555 "Store @var{value} in @var{bv} at @var{index} according to "
1556 "@var{endianness}.")
1557 #define FUNC_NAME s_scm_bytevector_s64_set_x
1559 LARGE_INTEGER_SET (64, signed);
1563 SCM_DEFINE (scm_bytevector_u64_native_set_x
, "bytevector-u64-native-set!",
1565 (SCM bv
, SCM index
, SCM value
),
1566 "Store the unsigned integer @var{value} at index @var{index} "
1567 "of @var{bv} using the native endianness.")
1568 #define FUNC_NAME s_scm_bytevector_u64_native_set_x
1570 LARGE_INTEGER_NATIVE_SET (64, unsigned);
1574 SCM_DEFINE (scm_bytevector_s64_native_set_x
, "bytevector-s64-native-set!",
1576 (SCM bv
, SCM index
, SCM value
),
1577 "Store the signed integer @var{value} at index @var{index} "
1578 "of @var{bv} using the native endianness.")
1579 #define FUNC_NAME s_scm_bytevector_s64_native_set_x
1581 LARGE_INTEGER_NATIVE_SET (64, signed);
1587 /* Operations on IEEE-754 numbers. */
1589 /* There are two possible word endians, visible in glibc's <ieee754.h>.
1590 However, in R6RS, when the endianness is `little', little endian is
1591 assumed for both the byte order and the word order. This is clear from
1592 Section 2.1 of R6RS-lib (in response to
1593 http://www.r6rs.org/formal-comments/comment-187.txt). */
1595 union scm_ieee754_float
1601 union scm_ieee754_double
1608 /* Convert to/from a floating-point number with different endianness. This
1609 method is probably not the most efficient but it should be portable. */
1612 float_to_foreign_endianness (union scm_ieee754_float
*target
,
1615 union scm_ieee754_float input
;
1618 target
->i
= bswap_32 (input
.i
);
1622 float_from_foreign_endianness (const union scm_ieee754_float
*source
)
1624 union scm_ieee754_float result
;
1626 result
.i
= bswap_32 (source
->i
);
1632 double_to_foreign_endianness (union scm_ieee754_double
*target
,
1635 union scm_ieee754_double input
;
1638 target
->i
= bswap_64 (input
.i
);
1641 static inline double
1642 double_from_foreign_endianness (const union scm_ieee754_double
*source
)
1644 union scm_ieee754_double result
;
1646 result
.i
= bswap_64 (source
->i
);
1651 /* Template macros to abstract over doubles and floats.
1652 XXX: Guile can only convert to/from doubles. */
1653 #define IEEE754_UNION(_c_type) union scm_ieee754_ ## _c_type
1654 #define IEEE754_TO_SCM(_c_type) scm_from_double
1655 #define IEEE754_FROM_SCM(_c_type) scm_to_double
1656 #define IEEE754_FROM_FOREIGN_ENDIANNESS(_c_type) \
1657 _c_type ## _from_foreign_endianness
1658 #define IEEE754_TO_FOREIGN_ENDIANNESS(_c_type) \
1659 _c_type ## _to_foreign_endianness
1662 /* FIXME: SCM_VALIDATE_REAL rejects integers, etc. grrr */
1663 #define VALIDATE_REAL(pos, v) \
1665 SCM_ASSERT_TYPE (scm_is_real (v), v, pos, FUNC_NAME, "real"); \
1668 /* Templace getters and setters. */
1670 #define IEEE754_ACCESSOR_PROLOGUE(_type) \
1671 INTEGER_ACCESSOR_PROLOGUE (sizeof (_type) << 3UL, signed);
1673 #define IEEE754_REF(_type) \
1676 IEEE754_ACCESSOR_PROLOGUE (_type); \
1677 SCM_VALIDATE_SYMBOL (3, endianness); \
1679 if (scm_is_eq (endianness, scm_i_native_endianness)) \
1680 memcpy (&c_result, &c_bv[c_index], sizeof (c_result)); \
1683 IEEE754_UNION (_type) c_raw; \
1685 memcpy (&c_raw, &c_bv[c_index], sizeof (c_raw)); \
1687 IEEE754_FROM_FOREIGN_ENDIANNESS (_type) (&c_raw); \
1690 return (IEEE754_TO_SCM (_type) (c_result));
1692 #define IEEE754_NATIVE_REF(_type) \
1695 IEEE754_ACCESSOR_PROLOGUE (_type); \
1697 memcpy (&c_result, &c_bv[c_index], sizeof (c_result)); \
1698 return (IEEE754_TO_SCM (_type) (c_result));
1700 #define IEEE754_SET(_type) \
1703 IEEE754_ACCESSOR_PROLOGUE (_type); \
1704 VALIDATE_REAL (3, value); \
1705 SCM_VALIDATE_SYMBOL (4, endianness); \
1706 c_value = IEEE754_FROM_SCM (_type) (value); \
1708 if (scm_is_eq (endianness, scm_i_native_endianness)) \
1709 memcpy (&c_bv[c_index], &c_value, sizeof (c_value)); \
1712 IEEE754_UNION (_type) c_raw; \
1714 IEEE754_TO_FOREIGN_ENDIANNESS (_type) (&c_raw, c_value); \
1715 memcpy (&c_bv[c_index], &c_raw, sizeof (c_raw)); \
1718 return SCM_UNSPECIFIED;
1720 #define IEEE754_NATIVE_SET(_type) \
1723 IEEE754_ACCESSOR_PROLOGUE (_type); \
1724 VALIDATE_REAL (3, value); \
1725 c_value = IEEE754_FROM_SCM (_type) (value); \
1727 memcpy (&c_bv[c_index], &c_value, sizeof (c_value)); \
1728 return SCM_UNSPECIFIED;
1731 /* Single precision. */
1733 SCM_DEFINE (scm_bytevector_ieee_single_ref
,
1734 "bytevector-ieee-single-ref",
1736 (SCM bv
, SCM index
, SCM endianness
),
1737 "Return the IEEE-754 single from @var{bv} at "
1739 #define FUNC_NAME s_scm_bytevector_ieee_single_ref
1741 IEEE754_REF (float);
1745 SCM_DEFINE (scm_bytevector_ieee_single_native_ref
,
1746 "bytevector-ieee-single-native-ref",
1748 (SCM bv
, SCM index
),
1749 "Return the IEEE-754 single from @var{bv} at "
1750 "@var{index} using the native endianness.")
1751 #define FUNC_NAME s_scm_bytevector_ieee_single_native_ref
1753 IEEE754_NATIVE_REF (float);
1757 SCM_DEFINE (scm_bytevector_ieee_single_set_x
,
1758 "bytevector-ieee-single-set!",
1760 (SCM bv
, SCM index
, SCM value
, SCM endianness
),
1761 "Store real @var{value} in @var{bv} at @var{index} according to "
1762 "@var{endianness}.")
1763 #define FUNC_NAME s_scm_bytevector_ieee_single_set_x
1765 IEEE754_SET (float);
1769 SCM_DEFINE (scm_bytevector_ieee_single_native_set_x
,
1770 "bytevector-ieee-single-native-set!",
1772 (SCM bv
, SCM index
, SCM value
),
1773 "Store the real @var{value} at index @var{index} "
1774 "of @var{bv} using the native endianness.")
1775 #define FUNC_NAME s_scm_bytevector_ieee_single_native_set_x
1777 IEEE754_NATIVE_SET (float);
1782 /* Double precision. */
1784 SCM_DEFINE (scm_bytevector_ieee_double_ref
,
1785 "bytevector-ieee-double-ref",
1787 (SCM bv
, SCM index
, SCM endianness
),
1788 "Return the IEEE-754 double from @var{bv} at "
1790 #define FUNC_NAME s_scm_bytevector_ieee_double_ref
1792 IEEE754_REF (double);
1796 SCM_DEFINE (scm_bytevector_ieee_double_native_ref
,
1797 "bytevector-ieee-double-native-ref",
1799 (SCM bv
, SCM index
),
1800 "Return the IEEE-754 double from @var{bv} at "
1801 "@var{index} using the native endianness.")
1802 #define FUNC_NAME s_scm_bytevector_ieee_double_native_ref
1804 IEEE754_NATIVE_REF (double);
1808 SCM_DEFINE (scm_bytevector_ieee_double_set_x
,
1809 "bytevector-ieee-double-set!",
1811 (SCM bv
, SCM index
, SCM value
, SCM endianness
),
1812 "Store real @var{value} in @var{bv} at @var{index} according to "
1813 "@var{endianness}.")
1814 #define FUNC_NAME s_scm_bytevector_ieee_double_set_x
1816 IEEE754_SET (double);
1820 SCM_DEFINE (scm_bytevector_ieee_double_native_set_x
,
1821 "bytevector-ieee-double-native-set!",
1823 (SCM bv
, SCM index
, SCM value
),
1824 "Store the real @var{value} at index @var{index} "
1825 "of @var{bv} using the native endianness.")
1826 #define FUNC_NAME s_scm_bytevector_ieee_double_native_set_x
1828 IEEE754_NATIVE_SET (double);
1833 #undef IEEE754_UNION
1834 #undef IEEE754_TO_SCM
1835 #undef IEEE754_FROM_SCM
1836 #undef IEEE754_FROM_FOREIGN_ENDIANNESS
1837 #undef IEEE754_TO_FOREIGN_ENDIANNESS
1839 #undef IEEE754_NATIVE_REF
1841 #undef IEEE754_NATIVE_SET
1844 /* Operations on strings. */
1847 /* Produce a function that returns the length of a UTF-encoded string. */
1848 #define UTF_STRLEN_FUNCTION(_utf_width) \
1849 static inline size_t \
1850 utf ## _utf_width ## _strlen (const uint ## _utf_width ## _t *str) \
1853 const uint ## _utf_width ## _t *ptr; \
1861 return (len * ((_utf_width) / 8)); \
1864 UTF_STRLEN_FUNCTION (8)
1867 /* Return the length (in bytes) of STR, a UTF-(UTF_WIDTH) encoded string. */
1868 #define UTF_STRLEN(_utf_width, _str) \
1869 utf ## _utf_width ## _strlen (_str)
1871 /* Return the "portable" name of the UTF encoding of size UTF_WIDTH and
1872 ENDIANNESS (Gnulib's `iconv_open' module guarantees the portability of the
1875 utf_encoding_name (char *name
, size_t utf_width
, SCM endianness
)
1877 strcpy (name
, "UTF-");
1878 strcat (name
, ((utf_width
== 8)
1880 : ((utf_width
== 16)
1882 : ((utf_width
== 32)
1886 ((scm_is_eq (endianness
, scm_sym_big
))
1888 : ((scm_is_eq (endianness
, scm_sym_little
))
1893 /* Maximum length of a UTF encoding name. */
1894 #define MAX_UTF_ENCODING_NAME_LEN 16
1896 /* Produce the body of a `string->utf' function. */
1897 #define STRING_TO_UTF(_utf_width) \
1900 char c_utf_name[MAX_UTF_ENCODING_NAME_LEN]; \
1901 char *c_utf = NULL; \
1902 size_t c_strlen, c_utf_len = 0; \
1904 SCM_VALIDATE_STRING (1, str); \
1905 if (scm_is_eq (endianness, SCM_UNDEFINED)) \
1906 endianness = scm_sym_big; \
1908 SCM_VALIDATE_SYMBOL (2, endianness); \
1910 utf_encoding_name (c_utf_name, (_utf_width), endianness); \
1912 c_strlen = scm_i_string_length (str); \
1913 if (scm_i_is_narrow_string (str)) \
1915 err = mem_iconveh (scm_i_string_chars (str), c_strlen, \
1916 "ISO-8859-1", c_utf_name, \
1917 iconveh_question_mark, NULL, \
1918 &c_utf, &c_utf_len); \
1919 if (SCM_UNLIKELY (err)) \
1920 scm_syserror_msg (FUNC_NAME, "failed to convert string: ~A", \
1921 scm_list_1 (str), err); \
1925 const scm_t_wchar *wbuf = scm_i_string_wide_chars (str); \
1926 c_utf = u32_conv_to_encoding (c_utf_name, \
1927 iconveh_question_mark, \
1928 (scm_t_uint32 *) wbuf, \
1929 c_strlen, NULL, NULL, &c_utf_len); \
1930 if (SCM_UNLIKELY (c_utf == NULL)) \
1931 scm_syserror_msg (FUNC_NAME, "failed to convert string: ~A", \
1932 scm_list_1 (str), errno); \
1934 scm_dynwind_begin (0); \
1935 scm_dynwind_free (c_utf); \
1936 utf = make_bytevector (c_utf_len, SCM_ARRAY_ELEMENT_TYPE_VU8); \
1937 memcpy (SCM_BYTEVECTOR_CONTENTS (utf), c_utf, c_utf_len); \
1938 scm_dynwind_end (); \
1944 SCM_DEFINE (scm_string_to_utf8
, "string->utf8",
1947 "Return a newly allocated bytevector that contains the UTF-8 "
1948 "encoding of @var{str}.")
1949 #define FUNC_NAME s_scm_string_to_utf8
1953 size_t c_utf_len
= 0;
1955 SCM_VALIDATE_STRING (1, str
);
1957 c_utf
= (scm_t_uint8
*) scm_to_utf8_stringn (str
, &c_utf_len
);
1958 utf
= make_bytevector (c_utf_len
, SCM_ARRAY_ELEMENT_TYPE_VU8
);
1959 memcpy (SCM_BYTEVECTOR_CONTENTS (utf
), c_utf
, c_utf_len
);
1966 SCM_DEFINE (scm_string_to_utf16
, "string->utf16",
1968 (SCM str
, SCM endianness
),
1969 "Return a newly allocated bytevector that contains the UTF-16 "
1970 "encoding of @var{str}.")
1971 #define FUNC_NAME s_scm_string_to_utf16
1978 swap_u32 (scm_t_wchar
*vals
, size_t len
)
1981 for (n
= 0; n
< len
; n
++)
1982 vals
[n
] = bswap_32 (vals
[n
]);
1985 SCM_DEFINE (scm_string_to_utf32
, "string->utf32",
1987 (SCM str
, SCM endianness
),
1988 "Return a newly allocated bytevector that contains the UTF-32 "
1989 "encoding of @var{str}.")
1990 #define FUNC_NAME s_scm_string_to_utf32
1993 scm_t_wchar
*wchars
;
1994 size_t wchar_len
, bytes_len
;
1996 wchars
= scm_to_utf32_stringn (str
, &wchar_len
);
1997 bytes_len
= wchar_len
* sizeof (scm_t_wchar
);
1998 if (!scm_is_eq (SCM_UNBNDP (endianness
) ? scm_endianness_big
: endianness
,
1999 scm_i_native_endianness
))
2000 swap_u32 (wchars
, wchar_len
);
2002 bv
= make_bytevector (bytes_len
, SCM_ARRAY_ELEMENT_TYPE_VU8
);
2003 memcpy (SCM_BYTEVECTOR_CONTENTS (bv
), wchars
, bytes_len
);
2011 /* Produce the body of a function that converts a UTF-encoded bytevector to a
2013 #define UTF_TO_STRING(_utf_width) \
2014 SCM str = SCM_BOOL_F; \
2016 char *c_str = NULL; \
2017 char c_utf_name[MAX_UTF_ENCODING_NAME_LEN]; \
2019 size_t c_strlen = 0, c_utf_len = 0; \
2021 SCM_VALIDATE_BYTEVECTOR (1, utf); \
2022 if (scm_is_eq (endianness, SCM_UNDEFINED)) \
2023 endianness = scm_sym_big; \
2025 SCM_VALIDATE_SYMBOL (2, endianness); \
2027 c_utf_len = SCM_BYTEVECTOR_LENGTH (utf); \
2028 c_utf = (char *) SCM_BYTEVECTOR_CONTENTS (utf); \
2029 utf_encoding_name (c_utf_name, (_utf_width), endianness); \
2031 err = mem_iconveh (c_utf, c_utf_len, \
2032 c_utf_name, "UTF-8", \
2033 iconveh_question_mark, NULL, \
2034 &c_str, &c_strlen); \
2035 if (SCM_UNLIKELY (err)) \
2036 scm_syserror_msg (FUNC_NAME, "failed to convert to string: ~A", \
2037 scm_list_1 (utf), err); \
2040 str = scm_from_utf8_stringn (c_str, c_strlen); \
2046 SCM_DEFINE (scm_utf8_to_string
, "utf8->string",
2049 "Return a newly allocate string that contains from the UTF-8-"
2050 "encoded contents of bytevector @var{utf}.")
2051 #define FUNC_NAME s_scm_utf8_to_string
2055 size_t c_utf_len
= 0;
2057 SCM_VALIDATE_BYTEVECTOR (1, utf
);
2059 c_utf_len
= SCM_BYTEVECTOR_LENGTH (utf
);
2060 c_utf
= (char *) SCM_BYTEVECTOR_CONTENTS (utf
);
2061 str
= scm_from_utf8_stringn (c_utf
, c_utf_len
);
2067 SCM_DEFINE (scm_utf16_to_string
, "utf16->string",
2069 (SCM utf
, SCM endianness
),
2070 "Return a newly allocate string that contains from the UTF-16-"
2071 "encoded contents of bytevector @var{utf}.")
2072 #define FUNC_NAME s_scm_utf16_to_string
2078 SCM_DEFINE (scm_utf32_to_string
, "utf32->string",
2080 (SCM utf
, SCM endianness
),
2081 "Return a newly allocate string that contains from the UTF-32-"
2082 "encoded contents of bytevector @var{utf}.")
2083 #define FUNC_NAME s_scm_utf32_to_string
2090 /* Initialization. */
2093 scm_bootstrap_bytevectors (void)
2095 /* This must be instantiated here because the generalized-vector API may
2096 want to access bytevectors even though `(rnrs bytevectors)' hasn't been
2098 scm_null_bytevector
= make_bytevector (0, SCM_ARRAY_ELEMENT_TYPE_VU8
);
2100 #ifdef WORDS_BIGENDIAN
2101 scm_i_native_endianness
= scm_from_latin1_symbol ("big");
2103 scm_i_native_endianness
= scm_from_latin1_symbol ("little");
2106 scm_c_register_extension ("libguile-" SCM_EFFECTIVE_VERSION
,
2107 "scm_init_bytevectors",
2108 (scm_t_extension_init_func
) scm_init_bytevectors
,
2111 scm_i_register_vector_constructor
2112 (scm_i_array_element_types
[SCM_ARRAY_ELEMENT_TYPE_VU8
],
2113 scm_make_bytevector
);
2117 scm_init_bytevectors (void)
2119 #include "libguile/bytevectors.x"
2121 scm_endianness_big
= scm_sym_big
;
2122 scm_endianness_little
= scm_sym_little
;