src/bytevector.h

   1 /* Guile-R6RS-Libs --- Implementation of R6RS standard libraries.
   2    Copyright (C) 2007, 2009  Ludovic Courtès <ludo@gnu.org>
   3
   4    Guile-R6RS-Libs is free software; you can redistribute it and/or
   5    modify it under the terms of the GNU Lesser General Public
   6    License as published by the Free Software Foundation; either
   7    version 2.1 of the License, or (at your option) any later version.
   8
   9    Guile-R6RS-Libs is distributed in the hope that it will be useful,
  10    but WITHOUT ANY WARRANTY; without even the implied warranty of
  11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12    Lesser General Public License for more details.
  13
  14    You should have received a copy of the GNU Lesser General Public
  15    License along with Guile-R6RS-Libs; if not, write to the Free Software
  16    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA  */
  17
  18 #ifndef GUILE_R6RS_BYTEVECTOR
  19 #define GUILE_R6RS_BYTEVECTOR
  20
  21 /* R6RS bytevectors.  */
  22
  23 #include <libguile.h>
  24
  25 SCM_API void scm_init_r6rs_bytevector (void);
  26
  27 #define SCM_VALIDATE_R6RS_BYTEVECTOR(_pos, _obj)                \
  28   SCM_VALIDATE_SMOB ((_pos), (_obj), r6rs_bytevector);
  29
  30 #define SCM_R6RS_BYTEVECTOR_LENGTH(_bv)         \
  31   ((unsigned) SCM_SMOB_DATA (_bv))
  32 #define SCM_R6RS_BYTEVECTOR_CONTENTS(_bv)               \
  33   (SCM_R6RS_BYTEVECTOR_INLINE_P (_bv)                   \
  34    ? (signed char *) SCM_SMOB_OBJECT_2_LOC (_bv)        \
  35    : (signed char *) SCM_SMOB_DATA_2 (_bv))
  36
  37
  38 SCM_API SCM scm_r6rs_endianness_big;
  39 SCM_API SCM scm_r6rs_endianness_little;
  40
  41 SCM_API SCM scm_r6rs_make_bytevector (SCM, SCM);
  42 SCM_API SCM scm_r6rs_c_make_bytevector (unsigned);
  43 SCM_API SCM scm_r6rs_native_endianness (void);
  44 SCM_API SCM scm_r6rs_bytevector_p (SCM);
  45 SCM_API SCM scm_r6rs_bytevector_length (SCM);
  46 SCM_API SCM scm_r6rs_bytevector_eq_p (SCM, SCM);
  47 SCM_API SCM scm_r6rs_bytevector_fill_x (SCM, SCM);
  48 SCM_API SCM scm_r6rs_bytevector_copy_x (SCM, SCM, SCM, SCM, SCM);
  49 SCM_API SCM scm_r6rs_bytevector_copy (SCM);
  50
  51 SCM_API SCM scm_r6rs_bytevector_to_u8_list (SCM);
  52 SCM_API SCM scm_r6rs_u8_list_to_bytevector (SCM);
  53 SCM_API SCM scm_r6rs_uint_list_to_bytevector (SCM, SCM, SCM);
  54 SCM_API SCM scm_r6rs_bytevector_to_uint_list (SCM, SCM, SCM);
  55 SCM_API SCM scm_r6rs_sint_list_to_bytevector (SCM, SCM, SCM);
  56 SCM_API SCM scm_r6rs_bytevector_to_sint_list (SCM, SCM, SCM);
  57
  58 SCM_API SCM scm_r6rs_bytevector_u16_native_ref (SCM, SCM);
  59 SCM_API SCM scm_r6rs_bytevector_s16_native_ref (SCM, SCM);
  60 SCM_API SCM scm_r6rs_bytevector_u32_native_ref (SCM, SCM);
  61 SCM_API SCM scm_r6rs_bytevector_s32_native_ref (SCM, SCM);
  62 SCM_API SCM scm_r6rs_bytevector_u64_native_ref (SCM, SCM);
  63 SCM_API SCM scm_r6rs_bytevector_s64_native_ref (SCM, SCM);
  64 SCM_API SCM scm_r6rs_bytevector_u8_ref (SCM, SCM);
  65 SCM_API SCM scm_r6rs_bytevector_s8_ref (SCM, SCM);
  66 SCM_API SCM scm_r6rs_bytevector_uint_ref (SCM, SCM, SCM, SCM);
  67 SCM_API SCM scm_r6rs_bytevector_sint_ref (SCM, SCM, SCM, SCM);
  68 SCM_API SCM scm_r6rs_bytevector_u16_ref (SCM, SCM, SCM);
  69 SCM_API SCM scm_r6rs_bytevector_s16_ref (SCM, SCM, SCM);
  70 SCM_API SCM scm_r6rs_bytevector_u32_ref (SCM, SCM, SCM);
  71 SCM_API SCM scm_r6rs_bytevector_s32_ref (SCM, SCM, SCM);
  72 SCM_API SCM scm_r6rs_bytevector_u64_ref (SCM, SCM, SCM);
  73 SCM_API SCM scm_r6rs_bytevector_s64_ref (SCM, SCM, SCM);
  74 SCM_API SCM scm_r6rs_bytevector_u16_native_set_x (SCM, SCM, SCM);
  75 SCM_API SCM scm_r6rs_bytevector_s16_native_set_x (SCM, SCM, SCM);
  76 SCM_API SCM scm_r6rs_bytevector_u32_native_set_x (SCM, SCM, SCM);
  77 SCM_API SCM scm_r6rs_bytevector_s32_native_set_x (SCM, SCM, SCM);
  78 SCM_API SCM scm_r6rs_bytevector_u64_native_set_x (SCM, SCM, SCM);
  79 SCM_API SCM scm_r6rs_bytevector_s64_native_set_x (SCM, SCM, SCM);
  80 SCM_API SCM scm_r6rs_bytevector_u8_set_x (SCM, SCM, SCM);
  81 SCM_API SCM scm_r6rs_bytevector_s8_set_x (SCM, SCM, SCM);
  82 SCM_API SCM scm_r6rs_bytevector_uint_set_x (SCM, SCM, SCM, SCM, SCM);
  83 SCM_API SCM scm_r6rs_bytevector_sint_set_x (SCM, SCM, SCM, SCM, SCM);
  84 SCM_API SCM scm_r6rs_bytevector_u16_set_x (SCM, SCM, SCM, SCM);
  85 SCM_API SCM scm_r6rs_bytevector_s16_set_x (SCM, SCM, SCM, SCM);
  86 SCM_API SCM scm_r6rs_bytevector_u32_set_x (SCM, SCM, SCM, SCM);
  87 SCM_API SCM scm_r6rs_bytevector_s32_set_x (SCM, SCM, SCM, SCM);
  88 SCM_API SCM scm_r6rs_bytevector_u64_set_x (SCM, SCM, SCM, SCM);
  89 SCM_API SCM scm_r6rs_bytevector_s64_set_x (SCM, SCM, SCM, SCM);
  90 SCM_API SCM scm_r6rs_bytevector_ieee_single_ref (SCM, SCM, SCM);
  91 SCM_API SCM scm_r6rs_bytevector_ieee_single_native_ref (SCM, SCM);
  92 SCM_API SCM scm_r6rs_bytevector_ieee_single_set_x (SCM, SCM, SCM, SCM);
  93 SCM_API SCM scm_r6rs_bytevector_ieee_single_native_set_x (SCM, SCM, SCM);
  94 SCM_API SCM scm_r6rs_bytevector_ieee_double_ref (SCM, SCM, SCM);
  95 SCM_API SCM scm_r6rs_bytevector_ieee_double_native_ref (SCM, SCM);
  96 SCM_API SCM scm_r6rs_bytevector_ieee_double_set_x (SCM, SCM, SCM, SCM);
  97 SCM_API SCM scm_r6rs_bytevector_ieee_double_native_set_x (SCM, SCM, SCM);
  98 SCM_API SCM scm_r6rs_string_to_utf8 (SCM);
  99 SCM_API SCM scm_r6rs_string_to_utf16 (SCM, SCM);
 100 SCM_API SCM scm_r6rs_string_to_utf32 (SCM, SCM);
 101 SCM_API SCM scm_r6rs_utf8_to_string (SCM);
 102 SCM_API SCM scm_r6rs_utf16_to_string (SCM, SCM);
 103 SCM_API SCM scm_r6rs_utf32_to_string (SCM, SCM);
 104
 105
 106 \f
 107 /* Internal API.  */
 108
 109 /* The threshold (in octets) under which bytevectors are stored "in-line",
 110    i.e., without allocating memory beside the SMOB itself (a double cell).
 111    This optimization is necessary since small bytevectors are expected to be
 112    common.  */
 113 #define SCM_R6RS_BYTEVECTOR_INLINE_THRESHOLD  (2 * sizeof (SCM))
 114 #define SCM_R6RS_BYTEVECTOR_INLINEABLE_SIZE_P(_size)    \
 115   ((_size) <= SCM_R6RS_BYTEVECTOR_INLINE_THRESHOLD)
 116 #define SCM_R6RS_BYTEVECTOR_INLINE_P(_bv)                                    \
 117   (SCM_R6RS_BYTEVECTOR_INLINEABLE_SIZE_P (SCM_R6RS_BYTEVECTOR_LENGTH (_bv)))
 118
 119 /* Hint that is passed to `scm_gc_malloc ()' and friends.  */
 120 #define SCM_GC_BYTEVECTOR "r6rs-bytevector"
 121
 122 SCM_API scm_t_bits scm_tc16_r6rs_bytevector;
 123 SCM_API SCM scm_r6rs_c_take_bytevector (signed char *, unsigned);
 124
 125 #define scm_r6rs_c_shrink_bytevector(_bv, _len)         \
 126   (SCM_R6RS_BYTEVECTOR_INLINE_P (_bv)                   \
 127    ? (_bv)                                              \
 128    : scm_r6rs_i_shrink_bytevector ((_bv), (_len)))
 129
 130 SCM_API SCM scm_r6rs_i_shrink_bytevector (SCM, unsigned);
 131 SCM_API SCM scm_r6rs_null_bytevector;
 132
 133 #endif
 134
 135 /* arch-tag: b727a1e1-ed81-4c92-8152-538928090c84
 136  */