[bpt/guile.git] / libguile / bytevectors.h

#ifndef SCM_BYTEVECTORS_H
#define SCM_BYTEVECTORS_H

/* Copyright (C) 2009 Free Software Foundation, Inc.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public License
 * as published by the Free Software Foundation; either version 3 of
 * the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
 * 02110-1301 USA
 */

\f

#include "libguile/__scm.h"


/* R6RS bytevectors.  */

#define SCM_BYTEVECTOR_LENGTH(_bv)		\
  ((unsigned) SCM_SMOB_DATA (_bv))
#define SCM_BYTEVECTOR_CONTENTS(_bv)		\
  (SCM_BYTEVECTOR_INLINE_P (_bv)			\
   ? (signed char *) SCM_SMOB_OBJECT_2_LOC (_bv)	\
   : (signed char *) SCM_SMOB_DATA_2 (_bv))


SCM_API SCM scm_endianness_big;
SCM_API SCM scm_endianness_little;

SCM_API SCM scm_make_bytevector (SCM, SCM);
SCM_API SCM scm_c_make_bytevector (unsigned);
SCM_API SCM scm_native_endianness (void);
SCM_API SCM scm_bytevector_p (SCM);
SCM_API SCM scm_bytevector_length (SCM);
SCM_API SCM scm_bytevector_eq_p (SCM, SCM);
SCM_API SCM scm_bytevector_fill_x (SCM, SCM);
SCM_API SCM scm_bytevector_copy_x (SCM, SCM, SCM, SCM, SCM);
SCM_API SCM scm_bytevector_copy (SCM);

SCM_API SCM scm_uniform_array_to_bytevector (SCM);

SCM_API SCM scm_bytevector_to_u8_list (SCM);
SCM_API SCM scm_u8_list_to_bytevector (SCM);
SCM_API SCM scm_uint_list_to_bytevector (SCM, SCM, SCM);
SCM_API SCM scm_bytevector_to_uint_list (SCM, SCM, SCM);
SCM_API SCM scm_sint_list_to_bytevector (SCM, SCM, SCM);
SCM_API SCM scm_bytevector_to_sint_list (SCM, SCM, SCM);

SCM_API SCM scm_bytevector_u16_native_ref (SCM, SCM);
SCM_API SCM scm_bytevector_s16_native_ref (SCM, SCM);
SCM_API SCM scm_bytevector_u32_native_ref (SCM, SCM);
SCM_API SCM scm_bytevector_s32_native_ref (SCM, SCM);
SCM_API SCM scm_bytevector_u64_native_ref (SCM, SCM);
SCM_API SCM scm_bytevector_s64_native_ref (SCM, SCM);
SCM_API SCM scm_bytevector_u8_ref (SCM, SCM);
SCM_API SCM scm_bytevector_s8_ref (SCM, SCM);
SCM_API SCM scm_bytevector_uint_ref (SCM, SCM, SCM, SCM);
SCM_API SCM scm_bytevector_sint_ref (SCM, SCM, SCM, SCM);
SCM_API SCM scm_bytevector_u16_ref (SCM, SCM, SCM);
SCM_API SCM scm_bytevector_s16_ref (SCM, SCM, SCM);
SCM_API SCM scm_bytevector_u32_ref (SCM, SCM, SCM);
SCM_API SCM scm_bytevector_s32_ref (SCM, SCM, SCM);
SCM_API SCM scm_bytevector_u64_ref (SCM, SCM, SCM);
SCM_API SCM scm_bytevector_s64_ref (SCM, SCM, SCM);
SCM_API SCM scm_bytevector_u16_native_set_x (SCM, SCM, SCM);
SCM_API SCM scm_bytevector_s16_native_set_x (SCM, SCM, SCM);
SCM_API SCM scm_bytevector_u32_native_set_x (SCM, SCM, SCM);
SCM_API SCM scm_bytevector_s32_native_set_x (SCM, SCM, SCM);
SCM_API SCM scm_bytevector_u64_native_set_x (SCM, SCM, SCM);
SCM_API SCM scm_bytevector_s64_native_set_x (SCM, SCM, SCM);
SCM_API SCM scm_bytevector_u8_set_x (SCM, SCM, SCM);
SCM_API SCM scm_bytevector_s8_set_x (SCM, SCM, SCM);
SCM_API SCM scm_bytevector_uint_set_x (SCM, SCM, SCM, SCM, SCM);
SCM_API SCM scm_bytevector_sint_set_x (SCM, SCM, SCM, SCM, SCM);
SCM_API SCM scm_bytevector_u16_set_x (SCM, SCM, SCM, SCM);
SCM_API SCM scm_bytevector_s16_set_x (SCM, SCM, SCM, SCM);
SCM_API SCM scm_bytevector_u32_set_x (SCM, SCM, SCM, SCM);
SCM_API SCM scm_bytevector_s32_set_x (SCM, SCM, SCM, SCM);
SCM_API SCM scm_bytevector_u64_set_x (SCM, SCM, SCM, SCM);
SCM_API SCM scm_bytevector_s64_set_x (SCM, SCM, SCM, SCM);
SCM_API SCM scm_bytevector_ieee_single_ref (SCM, SCM, SCM);
SCM_API SCM scm_bytevector_ieee_single_native_ref (SCM, SCM);
SCM_API SCM scm_bytevector_ieee_single_set_x (SCM, SCM, SCM, SCM);
SCM_API SCM scm_bytevector_ieee_single_native_set_x (SCM, SCM, SCM);
SCM_API SCM scm_bytevector_ieee_double_ref (SCM, SCM, SCM);
SCM_API SCM scm_bytevector_ieee_double_native_ref (SCM, SCM);
SCM_API SCM scm_bytevector_ieee_double_set_x (SCM, SCM, SCM, SCM);
SCM_API SCM scm_bytevector_ieee_double_native_set_x (SCM, SCM, SCM);
SCM_API SCM scm_string_to_utf8 (SCM);
SCM_API SCM scm_string_to_utf16 (SCM, SCM);
SCM_API SCM scm_string_to_utf32 (SCM, SCM);
SCM_API SCM scm_utf8_to_string (SCM);
SCM_API SCM scm_utf16_to_string (SCM, SCM);
SCM_API SCM scm_utf32_to_string (SCM, SCM);


\f
/* Internal API.  */

/* The threshold (in octets) under which bytevectors are stored "in-line",
   i.e., without allocating memory beside the SMOB itself (a double cell).
   This optimization is necessary since small bytevectors are expected to be
   common.  */
#define SCM_BYTEVECTOR_INLINE_THRESHOLD  (2 * sizeof (SCM))
#define SCM_BYTEVECTOR_INLINEABLE_SIZE_P(_size)	\
  ((_size) <= SCM_BYTEVECTOR_INLINE_THRESHOLD)
#define SCM_BYTEVECTOR_INLINE_P(_bv)				     \
  (SCM_BYTEVECTOR_INLINEABLE_SIZE_P (SCM_BYTEVECTOR_LENGTH (_bv)))

/* Hint that is passed to `scm_gc_malloc ()' and friends.  */
#define SCM_GC_BYTEVECTOR "bytevector"

SCM_API void scm_init_bytevectors (void);

SCM_INTERNAL scm_t_bits scm_tc16_bytevector;
SCM_INTERNAL SCM scm_c_take_bytevector (signed char *, unsigned);

#define scm_c_shrink_bytevector(_bv, _len)		\
  (SCM_BYTEVECTOR_INLINE_P (_bv)			\
   ? (_bv)						\
   : scm_i_shrink_bytevector ((_bv), (_len)))

SCM_INTERNAL SCM scm_i_shrink_bytevector (SCM, unsigned);
SCM_INTERNAL SCM scm_null_bytevector;

#endif /* SCM_BYTEVECTORS_H */
Commit	Line	Data
1ee2c72e LC	1	#ifndef SCM_BYTEVECTORS_H
	2	#define SCM_BYTEVECTORS_H
	3
	4	/* Copyright (C) 2009 Free Software Foundation, Inc.
	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
53befeb7 NJ	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
53befeb7 NJ	19	* 02110-1301 USA
1ee2c72e LC	20	*/
	21
	22	\f
	23
	24	#include "libguile/__scm.h"
	25
	26
	27	/* R6RS bytevectors. */
	28
	29	#define SCM_BYTEVECTOR_LENGTH(_bv) \
	30	((unsigned) 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))
	35
	36
	37	SCM_API SCM scm_endianness_big;
	38	SCM_API SCM scm_endianness_little;
	39
	40	SCM_API SCM scm_make_bytevector (SCM, SCM);
	41	SCM_API SCM scm_c_make_bytevector (unsigned);
	42	SCM_API SCM scm_native_endianness (void);
	43	SCM_API SCM scm_bytevector_p (SCM);
	44	SCM_API SCM scm_bytevector_length (SCM);
	45	SCM_API SCM scm_bytevector_eq_p (SCM, SCM);
	46	SCM_API SCM scm_bytevector_fill_x (SCM, SCM);
	47	SCM_API SCM scm_bytevector_copy_x (SCM, SCM, SCM, SCM, SCM);
	48	SCM_API SCM scm_bytevector_copy (SCM);
	49
782a82ee AW	50	SCM_API SCM scm_uniform_array_to_bytevector (SCM);
782a82ee AW	51
1ee2c72e LC	52	SCM_API SCM scm_bytevector_to_u8_list (SCM);
	53	SCM_API SCM scm_u8_list_to_bytevector (SCM);
	54	SCM_API SCM scm_uint_list_to_bytevector (SCM, SCM, SCM);
	55	SCM_API SCM scm_bytevector_to_uint_list (SCM, SCM, SCM);
	56	SCM_API SCM scm_sint_list_to_bytevector (SCM, SCM, SCM);
	57	SCM_API SCM scm_bytevector_to_sint_list (SCM, SCM, SCM);
	58
	59	SCM_API SCM scm_bytevector_u16_native_ref (SCM, SCM);
	60	SCM_API SCM scm_bytevector_s16_native_ref (SCM, SCM);
	61	SCM_API SCM scm_bytevector_u32_native_ref (SCM, SCM);
	62	SCM_API SCM scm_bytevector_s32_native_ref (SCM, SCM);
	63	SCM_API SCM scm_bytevector_u64_native_ref (SCM, SCM);
	64	SCM_API SCM scm_bytevector_s64_native_ref (SCM, SCM);
	65	SCM_API SCM scm_bytevector_u8_ref (SCM, SCM);
	66	SCM_API SCM scm_bytevector_s8_ref (SCM, SCM);
	67	SCM_API SCM scm_bytevector_uint_ref (SCM, SCM, SCM, SCM);
	68	SCM_API SCM scm_bytevector_sint_ref (SCM, SCM, SCM, SCM);
	69	SCM_API SCM scm_bytevector_u16_ref (SCM, SCM, SCM);
	70	SCM_API SCM scm_bytevector_s16_ref (SCM, SCM, SCM);
	71	SCM_API SCM scm_bytevector_u32_ref (SCM, SCM, SCM);
	72	SCM_API SCM scm_bytevector_s32_ref (SCM, SCM, SCM);
	73	SCM_API SCM scm_bytevector_u64_ref (SCM, SCM, SCM);
	74	SCM_API SCM scm_bytevector_s64_ref (SCM, SCM, SCM);
	75	SCM_API SCM scm_bytevector_u16_native_set_x (SCM, SCM, SCM);
	76	SCM_API SCM scm_bytevector_s16_native_set_x (SCM, SCM, SCM);
	77	SCM_API SCM scm_bytevector_u32_native_set_x (SCM, SCM, SCM);
	78	SCM_API SCM scm_bytevector_s32_native_set_x (SCM, SCM, SCM);
	79	SCM_API SCM scm_bytevector_u64_native_set_x (SCM, SCM, SCM);
	80	SCM_API SCM scm_bytevector_s64_native_set_x (SCM, SCM, SCM);
	81	SCM_API SCM scm_bytevector_u8_set_x (SCM, SCM, SCM);
	82	SCM_API SCM scm_bytevector_s8_set_x (SCM, SCM, SCM);
	83	SCM_API SCM scm_bytevector_uint_set_x (SCM, SCM, SCM, SCM, SCM);
	84	SCM_API SCM scm_bytevector_sint_set_x (SCM, SCM, SCM, SCM, SCM);
	85	SCM_API SCM scm_bytevector_u16_set_x (SCM, SCM, SCM, SCM);
	86	SCM_API SCM scm_bytevector_s16_set_x (SCM, SCM, SCM, SCM);
	87	SCM_API SCM scm_bytevector_u32_set_x (SCM, SCM, SCM, SCM);
	88	SCM_API SCM scm_bytevector_s32_set_x (SCM, SCM, SCM, SCM);
	89	SCM_API SCM scm_bytevector_u64_set_x (SCM, SCM, SCM, SCM);
	90	SCM_API SCM scm_bytevector_s64_set_x (SCM, SCM, SCM, SCM);
	91	SCM_API SCM scm_bytevector_ieee_single_ref (SCM, SCM, SCM);
	92	SCM_API SCM scm_bytevector_ieee_single_native_ref (SCM, SCM);
	93	SCM_API SCM scm_bytevector_ieee_single_set_x (SCM, SCM, SCM, SCM);
	94	SCM_API SCM scm_bytevector_ieee_single_native_set_x (SCM, SCM, SCM);
	95	SCM_API SCM scm_bytevector_ieee_double_ref (SCM, SCM, SCM);
	96	SCM_API SCM scm_bytevector_ieee_double_native_ref (SCM, SCM);
	97	SCM_API SCM scm_bytevector_ieee_double_set_x (SCM, SCM, SCM, SCM);
	98	SCM_API SCM scm_bytevector_ieee_double_native_set_x (SCM, SCM, SCM);
	99	SCM_API SCM scm_string_to_utf8 (SCM);
	100	SCM_API SCM scm_string_to_utf16 (SCM, SCM);
	101	SCM_API SCM scm_string_to_utf32 (SCM, SCM);
	102	SCM_API SCM scm_utf8_to_string (SCM);
	103	SCM_API SCM scm_utf16_to_string (SCM, SCM);
	104	SCM_API SCM scm_utf32_to_string (SCM, SCM);
	105
	106
	107	\f
	108	/* Internal API. */
	109
	110	/* The threshold (in octets) under which bytevectors are stored "in-line",
	111	i.e., without allocating memory beside the SMOB itself (a double cell).
	112	This optimization is necessary since small bytevectors are expected to be
	113	common. */
	114	#define SCM_BYTEVECTOR_INLINE_THRESHOLD (2 * sizeof (SCM))
	115	#define SCM_BYTEVECTOR_INLINEABLE_SIZE_P(_size) \
116	((_size) <= SCM_BYTEVECTOR_INLINE_THRESHOLD)
117	#define SCM_BYTEVECTOR_INLINE_P(_bv) \
118	(SCM_BYTEVECTOR_INLINEABLE_SIZE_P (SCM_BYTEVECTOR_LENGTH (_bv)))
119
120	/* Hint that is passed to `scm_gc_malloc ()' and friends. */
121	#define SCM_GC_BYTEVECTOR "bytevector"
122
123	SCM_API void scm_init_bytevectors (void);
124
125	SCM_INTERNAL scm_t_bits scm_tc16_bytevector;
126	SCM_INTERNAL SCM scm_c_take_bytevector (signed char *, unsigned);
127
128	#define scm_c_shrink_bytevector(_bv, _len) \
129	(SCM_BYTEVECTOR_INLINE_P (_bv) \
130	? (_bv) \
131	: scm_i_shrink_bytevector ((_bv), (_len)))
132
133	SCM_INTERNAL SCM scm_i_shrink_bytevector (SCM, unsigned);
134	SCM_INTERNAL SCM scm_null_bytevector;
135
136	#endif /* SCM_BYTEVECTORS_H */