compile-elisp fn
[bpt/guile.git] / libguile / bytevectors.h
CommitLineData
1ee2c72e
LC
1#ifndef SCM_BYTEVECTORS_H
2#define SCM_BYTEVECTORS_H
3
059a588f 4/* Copyright (C) 2009, 2011 Free Software Foundation, Inc.
1ee2c72e
LC
5 *
6 * This library is free software; you can redistribute it and/or
53befeb7
NJ
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.
1ee2c72e 10 *
53befeb7
NJ
11 * This library is distributed in the hope that it will be useful, but
12 * WITHOUT ANY WARRANTY; without even the implied warranty of
1ee2c72e
LC
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
15 *
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
53befeb7
NJ
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
19 * 02110-1301 USA
1ee2c72e
LC
20 */
21
22\f
23
24#include "libguile/__scm.h"
25
26
27/* R6RS bytevectors. */
28
3fe87cf7
LC
29/* The size in words of the bytevector header (type tag and flags, length,
30 and pointer to the underlying buffer). */
059a588f 31#define SCM_BYTEVECTOR_HEADER_SIZE 4U
0665b3ff 32
1ee2c72e 33#define SCM_BYTEVECTOR_LENGTH(_bv) \
807e5a66 34 ((size_t) SCM_CELL_WORD_1 (_bv))
3fe87cf7
LC
35#define SCM_BYTEVECTOR_CONTENTS(_bv) \
36 ((signed char *) SCM_CELL_WORD_2 (_bv))
059a588f
AW
37#define SCM_BYTEVECTOR_PARENT(_bv) \
38 (SCM_CELL_OBJECT_3 (_bv))
1ee2c72e
LC
39
40
41SCM_API SCM scm_endianness_big;
42SCM_API SCM scm_endianness_little;
43
2d34e924 44SCM_API SCM scm_c_make_bytevector (size_t);
404bb5f8
LC
45SCM_API int scm_is_bytevector (SCM);
46SCM_API size_t scm_c_bytevector_length (SCM);
47SCM_API scm_t_uint8 scm_c_bytevector_ref (SCM, size_t);
48SCM_API void scm_c_bytevector_set_x (SCM, size_t, scm_t_uint8);
49
50SCM_API SCM scm_make_bytevector (SCM, SCM);
1ee2c72e
LC
51SCM_API SCM scm_native_endianness (void);
52SCM_API SCM scm_bytevector_p (SCM);
53SCM_API SCM scm_bytevector_length (SCM);
54SCM_API SCM scm_bytevector_eq_p (SCM, SCM);
55SCM_API SCM scm_bytevector_fill_x (SCM, SCM);
56SCM_API SCM scm_bytevector_copy_x (SCM, SCM, SCM, SCM, SCM);
57SCM_API SCM scm_bytevector_copy (SCM);
58
782a82ee
AW
59SCM_API SCM scm_uniform_array_to_bytevector (SCM);
60
1ee2c72e
LC
61SCM_API SCM scm_bytevector_to_u8_list (SCM);
62SCM_API SCM scm_u8_list_to_bytevector (SCM);
63SCM_API SCM scm_uint_list_to_bytevector (SCM, SCM, SCM);
64SCM_API SCM scm_bytevector_to_uint_list (SCM, SCM, SCM);
65SCM_API SCM scm_sint_list_to_bytevector (SCM, SCM, SCM);
66SCM_API SCM scm_bytevector_to_sint_list (SCM, SCM, SCM);
67
68SCM_API SCM scm_bytevector_u16_native_ref (SCM, SCM);
69SCM_API SCM scm_bytevector_s16_native_ref (SCM, SCM);
70SCM_API SCM scm_bytevector_u32_native_ref (SCM, SCM);
71SCM_API SCM scm_bytevector_s32_native_ref (SCM, SCM);
72SCM_API SCM scm_bytevector_u64_native_ref (SCM, SCM);
73SCM_API SCM scm_bytevector_s64_native_ref (SCM, SCM);
74SCM_API SCM scm_bytevector_u8_ref (SCM, SCM);
75SCM_API SCM scm_bytevector_s8_ref (SCM, SCM);
76SCM_API SCM scm_bytevector_uint_ref (SCM, SCM, SCM, SCM);
77SCM_API SCM scm_bytevector_sint_ref (SCM, SCM, SCM, SCM);
78SCM_API SCM scm_bytevector_u16_ref (SCM, SCM, SCM);
79SCM_API SCM scm_bytevector_s16_ref (SCM, SCM, SCM);
80SCM_API SCM scm_bytevector_u32_ref (SCM, SCM, SCM);
81SCM_API SCM scm_bytevector_s32_ref (SCM, SCM, SCM);
82SCM_API SCM scm_bytevector_u64_ref (SCM, SCM, SCM);
83SCM_API SCM scm_bytevector_s64_ref (SCM, SCM, SCM);
84SCM_API SCM scm_bytevector_u16_native_set_x (SCM, SCM, SCM);
85SCM_API SCM scm_bytevector_s16_native_set_x (SCM, SCM, SCM);
86SCM_API SCM scm_bytevector_u32_native_set_x (SCM, SCM, SCM);
87SCM_API SCM scm_bytevector_s32_native_set_x (SCM, SCM, SCM);
88SCM_API SCM scm_bytevector_u64_native_set_x (SCM, SCM, SCM);
89SCM_API SCM scm_bytevector_s64_native_set_x (SCM, SCM, SCM);
90SCM_API SCM scm_bytevector_u8_set_x (SCM, SCM, SCM);
91SCM_API SCM scm_bytevector_s8_set_x (SCM, SCM, SCM);
92SCM_API SCM scm_bytevector_uint_set_x (SCM, SCM, SCM, SCM, SCM);
93SCM_API SCM scm_bytevector_sint_set_x (SCM, SCM, SCM, SCM, SCM);
94SCM_API SCM scm_bytevector_u16_set_x (SCM, SCM, SCM, SCM);
95SCM_API SCM scm_bytevector_s16_set_x (SCM, SCM, SCM, SCM);
96SCM_API SCM scm_bytevector_u32_set_x (SCM, SCM, SCM, SCM);
97SCM_API SCM scm_bytevector_s32_set_x (SCM, SCM, SCM, SCM);
98SCM_API SCM scm_bytevector_u64_set_x (SCM, SCM, SCM, SCM);
99SCM_API SCM scm_bytevector_s64_set_x (SCM, SCM, SCM, SCM);
100SCM_API SCM scm_bytevector_ieee_single_ref (SCM, SCM, SCM);
101SCM_API SCM scm_bytevector_ieee_single_native_ref (SCM, SCM);
102SCM_API SCM scm_bytevector_ieee_single_set_x (SCM, SCM, SCM, SCM);
103SCM_API SCM scm_bytevector_ieee_single_native_set_x (SCM, SCM, SCM);
104SCM_API SCM scm_bytevector_ieee_double_ref (SCM, SCM, SCM);
105SCM_API SCM scm_bytevector_ieee_double_native_ref (SCM, SCM);
106SCM_API SCM scm_bytevector_ieee_double_set_x (SCM, SCM, SCM, SCM);
107SCM_API SCM scm_bytevector_ieee_double_native_set_x (SCM, SCM, SCM);
108SCM_API SCM scm_string_to_utf8 (SCM);
109SCM_API SCM scm_string_to_utf16 (SCM, SCM);
110SCM_API SCM scm_string_to_utf32 (SCM, SCM);
111SCM_API SCM scm_utf8_to_string (SCM);
112SCM_API SCM scm_utf16_to_string (SCM, SCM);
113SCM_API SCM scm_utf32_to_string (SCM, SCM);
114
115
116\f
117/* Internal API. */
118
807e5a66 119#define SCM_BYTEVECTOR_P(x) \
dc7da0be 120 (SCM_HAS_TYP7 (x, scm_tc7_bytevector))
807e5a66
LC
121#define SCM_BYTEVECTOR_FLAGS(_bv) \
122 (SCM_CELL_TYPE (_bv) >> 7UL)
0665b3ff
LC
123#define SCM_SET_BYTEVECTOR_FLAGS(_bv, _f) \
124 SCM_SET_CELL_TYPE ((_bv), \
125 scm_tc7_bytevector | ((scm_t_bits)(_f) << 7UL))
807e5a66 126
e286c973 127#define SCM_BYTEVECTOR_ELEMENT_TYPE(_bv) \
3fe87cf7
LC
128 (SCM_BYTEVECTOR_FLAGS (_bv) & 0xffUL)
129#define SCM_BYTEVECTOR_CONTIGUOUS_P(_bv) \
130 (SCM_BYTEVECTOR_FLAGS (_bv) >> 8UL)
1ee2c72e
LC
131
132/* Hint that is passed to `scm_gc_malloc ()' and friends. */
133#define SCM_GC_BYTEVECTOR "bytevector"
134
3dc2afe2
AW
135SCM_INTERNAL SCM scm_i_make_typed_bytevector (size_t, scm_t_array_element_type);
136SCM_INTERNAL SCM scm_c_take_typed_bytevector (signed char *, size_t,
059a588f 137 scm_t_array_element_type, SCM);
3dc2afe2 138
cfb4702f
LC
139SCM_INTERNAL void scm_bootstrap_bytevectors (void);
140SCM_INTERNAL void scm_init_bytevectors (void);
1ee2c72e 141
caa92f5e 142SCM_INTERNAL SCM scm_i_native_endianness;
8b66aa8f 143SCM_INTERNAL SCM scm_c_take_gc_bytevector (signed char *, size_t, SCM);
1ee2c72e 144
807e5a66
LC
145SCM_INTERNAL int scm_i_print_bytevector (SCM, SCM, scm_print_state *);
146
0665b3ff 147SCM_INTERNAL SCM scm_c_shrink_bytevector (SCM, size_t);
438974d0 148SCM_INTERNAL void scm_i_bytevector_generalized_set_x (SCM, size_t, SCM);
1ee2c72e
LC
149SCM_INTERNAL SCM scm_null_bytevector;
150
151#endif /* SCM_BYTEVECTORS_H */