1 #ifndef SCM_BYTEVECTORS_H
2 #define SCM_BYTEVECTORS_H
4 /* Copyright (C) 2009 Free Software Foundation, Inc.
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public License
8 * as published by the Free Software Foundation; either version 3 of
9 * the License, or (at your option) any later version.
11 * This library is distributed in the hope that it will be useful, but
12 * WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this library; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
24 #include "libguile/__scm.h"
27 /* R6RS bytevectors. */
29 #define SCM_BYTEVECTOR_LENGTH(_bv) \
30 ((size_t) SCM_SMOB_DATA (_bv))
31 #define SCM_BYTEVECTOR_CONTENTS(_bv) \
32 (SCM_BYTEVECTOR_INLINE_P (_bv) \
33 ? (signed char *) SCM_SMOB_OBJECT_2_LOC (_bv) \
34 : (signed char *) SCM_SMOB_DATA_2 (_bv))
37 SCM_API SCM scm_endianness_big
;
38 SCM_API SCM scm_endianness_little
;
40 SCM_API SCM
scm_c_make_bytevector (size_t);
41 SCM_API
int scm_is_bytevector (SCM
);
42 SCM_API
size_t scm_c_bytevector_length (SCM
);
43 SCM_API scm_t_uint8
scm_c_bytevector_ref (SCM
, size_t);
44 SCM_API
void scm_c_bytevector_set_x (SCM
, size_t, scm_t_uint8
);
46 SCM_API SCM
scm_make_bytevector (SCM
, SCM
);
47 SCM_API SCM
scm_native_endianness (void);
48 SCM_API SCM
scm_bytevector_p (SCM
);
49 SCM_API SCM
scm_bytevector_length (SCM
);
50 SCM_API SCM
scm_bytevector_eq_p (SCM
, SCM
);
51 SCM_API SCM
scm_bytevector_fill_x (SCM
, SCM
);
52 SCM_API SCM
scm_bytevector_copy_x (SCM
, SCM
, SCM
, SCM
, SCM
);
53 SCM_API SCM
scm_bytevector_copy (SCM
);
55 SCM_API SCM
scm_uniform_array_to_bytevector (SCM
);
57 SCM_API SCM
scm_bytevector_to_u8_list (SCM
);
58 SCM_API SCM
scm_u8_list_to_bytevector (SCM
);
59 SCM_API SCM
scm_uint_list_to_bytevector (SCM
, SCM
, SCM
);
60 SCM_API SCM
scm_bytevector_to_uint_list (SCM
, SCM
, SCM
);
61 SCM_API SCM
scm_sint_list_to_bytevector (SCM
, SCM
, SCM
);
62 SCM_API SCM
scm_bytevector_to_sint_list (SCM
, SCM
, SCM
);
64 SCM_API SCM
scm_bytevector_u16_native_ref (SCM
, SCM
);
65 SCM_API SCM
scm_bytevector_s16_native_ref (SCM
, SCM
);
66 SCM_API SCM
scm_bytevector_u32_native_ref (SCM
, SCM
);
67 SCM_API SCM
scm_bytevector_s32_native_ref (SCM
, SCM
);
68 SCM_API SCM
scm_bytevector_u64_native_ref (SCM
, SCM
);
69 SCM_API SCM
scm_bytevector_s64_native_ref (SCM
, SCM
);
70 SCM_API SCM
scm_bytevector_u8_ref (SCM
, SCM
);
71 SCM_API SCM
scm_bytevector_s8_ref (SCM
, SCM
);
72 SCM_API SCM
scm_bytevector_uint_ref (SCM
, SCM
, SCM
, SCM
);
73 SCM_API SCM
scm_bytevector_sint_ref (SCM
, SCM
, SCM
, SCM
);
74 SCM_API SCM
scm_bytevector_u16_ref (SCM
, SCM
, SCM
);
75 SCM_API SCM
scm_bytevector_s16_ref (SCM
, SCM
, SCM
);
76 SCM_API SCM
scm_bytevector_u32_ref (SCM
, SCM
, SCM
);
77 SCM_API SCM
scm_bytevector_s32_ref (SCM
, SCM
, SCM
);
78 SCM_API SCM
scm_bytevector_u64_ref (SCM
, SCM
, SCM
);
79 SCM_API SCM
scm_bytevector_s64_ref (SCM
, SCM
, SCM
);
80 SCM_API SCM
scm_bytevector_u16_native_set_x (SCM
, SCM
, SCM
);
81 SCM_API SCM
scm_bytevector_s16_native_set_x (SCM
, SCM
, SCM
);
82 SCM_API SCM
scm_bytevector_u32_native_set_x (SCM
, SCM
, SCM
);
83 SCM_API SCM
scm_bytevector_s32_native_set_x (SCM
, SCM
, SCM
);
84 SCM_API SCM
scm_bytevector_u64_native_set_x (SCM
, SCM
, SCM
);
85 SCM_API SCM
scm_bytevector_s64_native_set_x (SCM
, SCM
, SCM
);
86 SCM_API SCM
scm_bytevector_u8_set_x (SCM
, SCM
, SCM
);
87 SCM_API SCM
scm_bytevector_s8_set_x (SCM
, SCM
, SCM
);
88 SCM_API SCM
scm_bytevector_uint_set_x (SCM
, SCM
, SCM
, SCM
, SCM
);
89 SCM_API SCM
scm_bytevector_sint_set_x (SCM
, SCM
, SCM
, SCM
, SCM
);
90 SCM_API SCM
scm_bytevector_u16_set_x (SCM
, SCM
, SCM
, SCM
);
91 SCM_API SCM
scm_bytevector_s16_set_x (SCM
, SCM
, SCM
, SCM
);
92 SCM_API SCM
scm_bytevector_u32_set_x (SCM
, SCM
, SCM
, SCM
);
93 SCM_API SCM
scm_bytevector_s32_set_x (SCM
, SCM
, SCM
, SCM
);
94 SCM_API SCM
scm_bytevector_u64_set_x (SCM
, SCM
, SCM
, SCM
);
95 SCM_API SCM
scm_bytevector_s64_set_x (SCM
, SCM
, SCM
, SCM
);
96 SCM_API SCM
scm_bytevector_ieee_single_ref (SCM
, SCM
, SCM
);
97 SCM_API SCM
scm_bytevector_ieee_single_native_ref (SCM
, SCM
);
98 SCM_API SCM
scm_bytevector_ieee_single_set_x (SCM
, SCM
, SCM
, SCM
);
99 SCM_API SCM
scm_bytevector_ieee_single_native_set_x (SCM
, SCM
, SCM
);
100 SCM_API SCM
scm_bytevector_ieee_double_ref (SCM
, SCM
, SCM
);
101 SCM_API SCM
scm_bytevector_ieee_double_native_ref (SCM
, SCM
);
102 SCM_API SCM
scm_bytevector_ieee_double_set_x (SCM
, SCM
, SCM
, SCM
);
103 SCM_API SCM
scm_bytevector_ieee_double_native_set_x (SCM
, SCM
, SCM
);
104 SCM_API SCM
scm_string_to_utf8 (SCM
);
105 SCM_API SCM
scm_string_to_utf16 (SCM
, SCM
);
106 SCM_API SCM
scm_string_to_utf32 (SCM
, SCM
);
107 SCM_API SCM
scm_utf8_to_string (SCM
);
108 SCM_API SCM
scm_utf16_to_string (SCM
, SCM
);
109 SCM_API SCM
scm_utf32_to_string (SCM
, SCM
);
115 /* The threshold (in octets) under which bytevectors are stored "in-line",
116 i.e., without allocating memory beside the SMOB itself (a double cell).
117 This optimization is necessary since small bytevectors are expected to be
119 #define SCM_BYTEVECTOR_P(_bv) \
120 SCM_SMOB_PREDICATE (scm_tc16_bytevector, _bv)
121 #define SCM_BYTEVECTOR_INLINE_THRESHOLD (2 * sizeof (SCM))
122 #define SCM_BYTEVECTOR_INLINEABLE_SIZE_P(_size) \
123 ((_size) <= SCM_BYTEVECTOR_INLINE_THRESHOLD)
124 #define SCM_BYTEVECTOR_INLINE_P(_bv) \
125 (SCM_BYTEVECTOR_INLINEABLE_SIZE_P (SCM_BYTEVECTOR_LENGTH (_bv)))
127 /* Hint that is passed to `scm_gc_malloc ()' and friends. */
128 #define SCM_GC_BYTEVECTOR "bytevector"
130 SCM_INTERNAL
void scm_bootstrap_bytevectors (void);
131 SCM_INTERNAL
void scm_init_bytevectors (void);
133 SCM_INTERNAL scm_t_bits scm_tc16_bytevector
;
134 SCM_INTERNAL SCM scm_i_native_endianness
;
135 SCM_INTERNAL SCM
scm_c_take_bytevector (signed char *, size_t);
137 #define scm_c_shrink_bytevector(_bv, _len) \
138 (SCM_BYTEVECTOR_INLINE_P (_bv) \
140 : scm_i_shrink_bytevector ((_bv), (_len)))
142 SCM_INTERNAL SCM
scm_i_shrink_bytevector (SCM
, size_t);
143 SCM_INTERNAL
void scm_i_bytevector_generalized_set_x (SCM
, size_t, SCM
);
144 SCM_INTERNAL SCM scm_null_bytevector
;
146 #endif /* SCM_BYTEVECTORS_H */