libguile/srfi-4.c

   1 /* srfi-4.c --- Uniform numeric vector datatypes.
   2  *
   3  *      Copyright (C) 2001, 2004, 2006, 2009, 2010, 2011 Free Software Foundation, Inc.
   4  *
   5  * This library is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU Lesser General Public License
   7  * as published by the Free Software Foundation; either version 3 of
   8  * the License, or (at your option) any later version.
   9  *
  10  * This library is distributed in the hope that it will be useful, but
  11  * WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * Lesser General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU Lesser General Public
  16  * License along with this library; if not, write to the Free Software
  17  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  18  * 02110-1301 USA
  19  */
  20
  21 #ifdef HAVE_CONFIG_H
  22 #  include <config.h>
  23 #endif
  24
  25 #include "libguile/_scm.h"
  26 #include "libguile/__scm.h"
  27 #include "libguile/bdw-gc.h"
  28 #include "libguile/srfi-4.h"
  29 #include "libguile/bytevectors.h"
  30 #include "libguile/error.h"
  31 #include "libguile/eval.h"
  32 #include "libguile/extensions.h"
  33 #include "libguile/uniform.h"
  34 #include "libguile/validate.h"
  35
  36
  37 #define DEFINE_SCHEME_PROXY100(cname, modname, scmname)                   \
  38   SCM cname (SCM arg1)                                                  \
  39   {                                                                     \
  40     static SCM var = SCM_BOOL_F;                                        \
  41     if (scm_is_false (var))                                             \
  42       var = scm_c_module_lookup (scm_c_resolve_module (modname), scmname); \
  43     return scm_call_1 (SCM_VARIABLE_REF (var), arg1);                   \
  44   }
  45
  46 #define DEFINE_SCHEME_PROXY001(cname, modname, scmname)                 \
  47   SCM cname (SCM args)                                                  \
  48   {                                                                     \
  49     static SCM var = SCM_BOOL_F;                                        \
  50     if (scm_is_false (var))                                             \
  51       var = scm_c_module_lookup (scm_c_resolve_module (modname), scmname); \
  52     return scm_apply_0 (SCM_VARIABLE_REF (var), args);                  \
  53   }
  54
  55 #define DEFINE_SCHEME_PROXY110(cname, modname, scmname)                   \
  56   SCM cname (SCM arg1, SCM opt1)                                        \
  57   {                                                                     \
  58     static SCM var = SCM_BOOL_F;                                        \
  59     if (scm_is_false (var))                                             \
  60       var = scm_c_module_lookup (scm_c_resolve_module (modname), scmname); \
  61     if (SCM_UNBNDP (opt1))                                              \
  62       return scm_call_1 (SCM_VARIABLE_REF (var), arg1);                 \
  63     else                                                                \
  64       return scm_call_2 (SCM_VARIABLE_REF (var), arg1, opt1);           \
  65   }
  66
  67 #define DEFINE_SCHEME_PROXY200(cname, modname, scmname)                   \
  68   SCM cname (SCM arg1, SCM arg2)                                        \
  69   {                                                                     \
  70     static SCM var = SCM_BOOL_F;                                        \
  71     if (scm_is_false (var))                                             \
  72       var = scm_c_module_lookup (scm_c_resolve_module (modname), scmname); \
  73     return scm_call_2 (SCM_VARIABLE_REF (var), arg1, arg2);             \
  74   }
  75
  76 #define DEFINE_SCHEME_PROXY300(cname, modname, scmname)                   \
  77   SCM cname (SCM arg1, SCM arg2, SCM arg3)                              \
  78   {                                                                     \
  79     static SCM var = SCM_BOOL_F;                                        \
  80     if (scm_is_false (var))                                             \
  81       var = scm_c_module_lookup (scm_c_resolve_module (modname), scmname); \
  82     return scm_call_3 (SCM_VARIABLE_REF (var), arg1, arg2, arg3);       \
  83   }
  84
  85 #define DEFPROXY100(cname, scmname)               \
  86   DEFINE_SCHEME_PROXY100 (cname, MOD, scmname)
  87 #define DEFPROXY110(cname, scmname)               \
  88   DEFINE_SCHEME_PROXY110 (cname, MOD, scmname)
  89 #define DEFPROXY001(cname, scmname)               \
  90   DEFINE_SCHEME_PROXY001 (cname, MOD, scmname)
  91 #define DEFPROXY200(cname, scmname)               \
  92   DEFINE_SCHEME_PROXY200 (cname, MOD, scmname)
  93 #define DEFPROXY300(cname, scmname)               \
  94   DEFINE_SCHEME_PROXY300 (cname, MOD, scmname)
  95
  96 #define DEFVECT(sym, str, func)\
  97
  98 #define DEFINE_SRFI_4_PROXIES(tag)                                      \
  99   DEFPROXY100 (scm_##tag##vector_p, #tag "vector?");                    \
 100   DEFPROXY110 (scm_make_##tag##vector, "make-" #tag "vector");          \
 101   DEFPROXY001 (scm_##tag##vector, #tag "vector");                       \
 102   DEFPROXY100 (scm_##tag##vector_length, #tag "vector-length");         \
 103   DEFPROXY200 (scm_##tag##vector_ref, #tag "vector-ref");               \
 104   DEFPROXY300 (scm_##tag##vector_set_x, #tag "vector-set!");            \
 105   DEFPROXY100 (scm_list_to_##tag##vector, "list->"#tag "vector");       \
 106   DEFPROXY100 (scm_##tag##vector_to_list, #tag "vector->list");         \
 107
 108
 109 #define ETYPE(TAG) \
 110   SCM_ARRAY_ELEMENT_TYPE_##TAG
 111
 112 #define DEFINE_SRFI_4_C_FUNCS(TAG, tag, ctype, width)                   \
 113   SCM scm_take_##tag##vector (ctype *data, size_t n)                    \
 114   {                                                                     \
 115     return scm_c_take_typed_bytevector ((scm_t_int8*)data, n, ETYPE (TAG), \
 116                                         SCM_BOOL_F);                    \
 117   }                                                                     \
 118   const ctype* scm_array_handle_##tag##_elements (scm_t_array_handle *h) \
 119   {                                                                     \
 120     if (h->element_type != ETYPE (TAG))                                 \
 121       scm_wrong_type_arg_msg (NULL, 0, h->array, #tag "vector");        \
 122     return ((const ctype*) h->elements) + h->base*width;                \
 123   }                                                                     \
 124   ctype* scm_array_handle_##tag##_writable_elements (scm_t_array_handle *h) \
 125   {                                                                     \
 126     if (h->element_type != ETYPE (TAG))                                 \
 127       scm_wrong_type_arg_msg (NULL, 0, h->array, #tag "vector");        \
 128     return ((ctype*) h->writable_elements) + h->base*width;             \
 129   }                                                                     \
 130   const ctype *scm_##tag##vector_elements (SCM uvec,                    \
 131                                            scm_t_array_handle *h,       \
 132                                            size_t *lenp, ssize_t *incp) \
 133   {                                                                     \
 134     return scm_##tag##vector_writable_elements (uvec, h, lenp, incp);   \
 135   }                                                                     \
 136   ctype *scm_##tag##vector_writable_elements (SCM uvec,                 \
 137                                               scm_t_array_handle *h,    \
 138                                               size_t *lenp, ssize_t *incp) \
 139   {                                                                     \
 140     scm_uniform_vector_elements (uvec, h, lenp, incp);                  \
 141     if (h->element_type == ETYPE (TAG))                                 \
 142       return ((ctype*)h->writable_elements) + h->base*width;            \
 143     /* otherwise... */                                                  \
 144     else                                                                \
 145       {                                                                 \
 146         size_t sfrom, sto, lfrom, lto;                                  \
 147         if (h->dims != &h->dim0)                                        \
 148           {                                                             \
 149             h->dim0 = h->dims[0];                                       \
 150             h->dims = &h->dim0;                                         \
 151           }                                                             \
 152         sfrom = scm_i_array_element_type_sizes [h->element_type];       \
 153         sto = scm_i_array_element_type_sizes [ETYPE (TAG)];             \
 154         lfrom = h->dim0.ubnd - h->dim0.lbnd + 1;                        \
 155         lto = lfrom * sfrom / sto;                                      \
 156         if (lto * sto != lfrom * sfrom)                                 \
 157           {                                                             \
 158             scm_array_handle_release (h);                               \
 159             scm_wrong_type_arg (#tag"vector-elements", SCM_ARG1, uvec); \
 160           }                                                             \
 161         h->dim0.ubnd = h->dim0.lbnd + lto;                              \
 162         h->base = h->base * sto / sfrom;                                \
 163         h->element_type = ETYPE (TAG);                                  \
 164         return ((ctype*)h->writable_elements) + h->base*width;          \
 165       }                                                                 \
 166   }
 167
 168
 169 #define MOD "srfi srfi-4"
 170
 171 DEFINE_SRFI_4_PROXIES (u8);
 172 DEFINE_SRFI_4_C_FUNCS (U8, u8, scm_t_uint8, 1);
 173
 174 DEFINE_SRFI_4_PROXIES (s8);
 175 DEFINE_SRFI_4_C_FUNCS (S8, s8, scm_t_int8, 1);
 176
 177 DEFINE_SRFI_4_PROXIES (u16);
 178 DEFINE_SRFI_4_C_FUNCS (U16, u16, scm_t_uint16, 1);
 179
 180 DEFINE_SRFI_4_PROXIES (s16);
 181 DEFINE_SRFI_4_C_FUNCS (S16, s16, scm_t_int16, 1);
 182
 183 DEFINE_SRFI_4_PROXIES (u32);
 184 DEFINE_SRFI_4_C_FUNCS (U32, u32, scm_t_uint32, 1);
 185
 186 DEFINE_SRFI_4_PROXIES (s32);
 187 DEFINE_SRFI_4_C_FUNCS (S32, s32, scm_t_int32, 1);
 188
 189 DEFINE_SRFI_4_PROXIES (u64);
 190 DEFINE_SRFI_4_C_FUNCS (U64, u64, scm_t_uint64, 1);
 191
 192 DEFINE_SRFI_4_PROXIES (s64);
 193 DEFINE_SRFI_4_C_FUNCS (S64, s64, scm_t_int64, 1);
 194
 195 DEFINE_SRFI_4_PROXIES (f32);
 196 DEFINE_SRFI_4_C_FUNCS (F32, f32, float, 1);
 197
 198 DEFINE_SRFI_4_PROXIES (f64);
 199 DEFINE_SRFI_4_C_FUNCS (F64, f64, double, 1);
 200
 201 #undef MOD
 202 #define MOD "srfi srfi-4 gnu"
 203
 204 DEFINE_SRFI_4_PROXIES (c32);
 205 DEFINE_SRFI_4_C_FUNCS (C32, c32, float, 2);
 206
 207 DEFINE_SRFI_4_PROXIES (c64);
 208 DEFINE_SRFI_4_C_FUNCS (C64, c64, double, 2);
 209
 210 #define DEFINE_SRFI_4_GNU_PROXIES(tag)                              \
 211   DEFPROXY100 (scm_any_to_##tag##vector, "any->" #tag "vector")
 212
 213 #undef MOD
 214 #define MOD "srfi srfi-4 gnu"
 215 DEFINE_SRFI_4_GNU_PROXIES (u8);
 216 DEFINE_SRFI_4_GNU_PROXIES (s8);
 217 DEFINE_SRFI_4_GNU_PROXIES (u16);
 218 DEFINE_SRFI_4_GNU_PROXIES (s16);
 219 DEFINE_SRFI_4_GNU_PROXIES (u32);
 220 DEFINE_SRFI_4_GNU_PROXIES (s32);
 221 DEFINE_SRFI_4_GNU_PROXIES (u64);
 222 DEFINE_SRFI_4_GNU_PROXIES (s64);
 223 DEFINE_SRFI_4_GNU_PROXIES (f32);
 224 DEFINE_SRFI_4_GNU_PROXIES (f64);
 225 DEFINE_SRFI_4_GNU_PROXIES (c32);
 226 DEFINE_SRFI_4_GNU_PROXIES (c64);
 227
 228
 229 SCM_DEFINE (scm_make_srfi_4_vector, "make-srfi-4-vector", 2, 1, 0,
 230             (SCM type, SCM len, SCM fill),
 231             "Make a srfi-4 vector")
 232 #define FUNC_NAME s_scm_make_srfi_4_vector
 233 {
 234   int i;
 235   for (i = 0; i <= SCM_ARRAY_ELEMENT_TYPE_LAST; i++)
 236     if (scm_is_eq (type, scm_i_array_element_types[i]))
 237       break;
 238   if (i > SCM_ARRAY_ELEMENT_TYPE_LAST)
 239     scm_wrong_type_arg_msg (FUNC_NAME, SCM_ARG1, type, "vector type");
 240   switch (i)
 241     {
 242     case SCM_ARRAY_ELEMENT_TYPE_U8:
 243     case SCM_ARRAY_ELEMENT_TYPE_S8:
 244     case SCM_ARRAY_ELEMENT_TYPE_U16:
 245     case SCM_ARRAY_ELEMENT_TYPE_S16:
 246     case SCM_ARRAY_ELEMENT_TYPE_U32:
 247     case SCM_ARRAY_ELEMENT_TYPE_S32:
 248     case SCM_ARRAY_ELEMENT_TYPE_U64:
 249     case SCM_ARRAY_ELEMENT_TYPE_S64:
 250     case SCM_ARRAY_ELEMENT_TYPE_F32:
 251     case SCM_ARRAY_ELEMENT_TYPE_F64:
 252     case SCM_ARRAY_ELEMENT_TYPE_C32:
 253     case SCM_ARRAY_ELEMENT_TYPE_C64:
 254       {
 255         SCM ret = scm_i_make_typed_bytevector (scm_to_size_t (len), i);
 256
 257         if (SCM_UNBNDP (fill) || scm_is_eq (len, SCM_INUM0))
 258           ; /* pass */
 259         else if (scm_is_true (scm_zero_p (fill)))
 260           memset (SCM_BYTEVECTOR_CONTENTS (ret), 0,
 261                   SCM_BYTEVECTOR_LENGTH (ret));
 262         else
 263           {
 264             scm_t_array_handle h;
 265             size_t len;
 266             ssize_t pos, inc;
 267
 268             scm_uniform_vector_writable_elements (ret, &h, &len, &inc);
 269
 270             for (pos = 0; pos != h.dims[0].ubnd; pos += inc)
 271               scm_array_handle_set (&h, pos, fill);
 272
 273             /* Initialize the last element.  */
 274             scm_array_handle_set (&h, pos, fill);
 275
 276             scm_array_handle_release (&h);
 277           }
 278         return ret;
 279       }
 280     default:
 281       scm_wrong_type_arg_msg (FUNC_NAME, SCM_ARG1, type, "uniform vector type");
 282       return SCM_BOOL_F; /* not reached */
 283     }
 284 }
 285 #undef FUNC_NAME
 286
 287 void
 288 scm_init_srfi_4 (void)
 289 {
 290 #define REGISTER(tag, TAG)                                       \
 291   scm_i_register_vector_constructor                              \
 292     (scm_i_array_element_types[SCM_ARRAY_ELEMENT_TYPE_##TAG],    \
 293      scm_make_##tag##vector)
 294
 295   REGISTER (u8, U8);
 296   REGISTER (s8, S8);
 297   REGISTER (u16, U16);
 298   REGISTER (s16, S16);
 299   REGISTER (u32, U32);
 300   REGISTER (s32, S32);
 301   REGISTER (u64, U64);
 302   REGISTER (s64, S64);
 303   REGISTER (f32, F32);
 304   REGISTER (f64, F64);
 305   REGISTER (c32, C32);
 306   REGISTER (c64, C64);
 307
 308 #include "libguile/srfi-4.x"
 309 }
 310
 311 /* End of srfi-4.c.  */