libguile/vectors.h

   1 /* classes: h_files */
   2
   3 #ifndef SCM_VECTORS_H
   4 #define SCM_VECTORS_H
   5
   6 /* Copyright (C) 1995,1996,1998,2000,2001,2002,2004,2005, 2006, 2008 Free Software Foundation, Inc.
   7  *
   8  * This library is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU Lesser General Public License
  10  * as published by the Free Software Foundation; either version 3 of
  11  * the License, or (at your option) any later version.
  12  *
  13  * This library is distributed in the hope that it will be useful, but
  14  * WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * Lesser General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU Lesser General Public
  19  * License along with this library; if not, write to the Free Software
  20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  21  * 02110-1301 USA
  22  */
  23
  24 \f
  25
  26 #include "libguile/__scm.h"
  27 #include "libguile/arrays.h"
  28
  29 \f
  30
  31 SCM_API SCM scm_vector_p (SCM x);
  32 SCM_API SCM scm_vector_length (SCM v);
  33 SCM_API SCM scm_vector (SCM l);
  34 SCM_API SCM scm_vector_ref (SCM v, SCM k);
  35 SCM_API SCM scm_vector_set_x (SCM v, SCM k, SCM obj);
  36 SCM_API SCM scm_make_vector (SCM k, SCM fill);
  37 SCM_API SCM scm_vector_to_list (SCM v);
  38 SCM_API SCM scm_vector_fill_x (SCM v, SCM fill_x);
  39 SCM_API SCM scm_vector_move_left_x (SCM vec1, SCM start1, SCM end1,
  40                                     SCM vec2, SCM start2);
  41 SCM_API SCM scm_vector_move_right_x (SCM vec1, SCM start1, SCM end1,
  42                                      SCM vec2, SCM start2);
  43 SCM_API SCM scm_vector_copy (SCM vec);
  44
  45 SCM_API int scm_is_vector (SCM obj);
  46 SCM_API int scm_is_simple_vector (SCM obj);
  47 SCM_API SCM scm_c_make_vector (size_t len, SCM fill);
  48 SCM_API size_t scm_c_vector_length (SCM vec);
  49 SCM_API SCM scm_c_vector_ref (SCM vec, size_t k);
  50 SCM_API void scm_c_vector_set_x (SCM vec, size_t k, SCM obj);
  51 SCM_API const SCM *scm_vector_elements (SCM vec,
  52                                         scm_t_array_handle *h,
  53                                         size_t *lenp, ssize_t *incp);
  54 SCM_API SCM *scm_vector_writable_elements (SCM vec,
  55                                            scm_t_array_handle *h,
  56                                            size_t *lenp, ssize_t *incp);
  57
  58 /* Fast, non-checking accessors for simple vectors.
  59  */
  60 #define SCM_SIMPLE_VECTOR_LENGTH(x)      SCM_I_VECTOR_LENGTH(x)
  61 #define SCM_SIMPLE_VECTOR_REF(x,idx)     ((SCM_I_VECTOR_ELTS(x))[idx])
  62 #define SCM_SIMPLE_VECTOR_SET(x,idx,val) ((SCM_I_VECTOR_WELTS(x))[idx]=(val))
  63
  64 /* Internals */
  65
  66 #define SCM_I_IS_VECTOR(x)     (!SCM_IMP(x) && (SCM_TYP7S(x)==scm_tc7_vector))
  67 #define SCM_I_VECTOR_ELTS(x)   ((const SCM *) SCM_CELL_WORD_1 (x))
  68 #define SCM_I_VECTOR_WELTS(x)  ((SCM *) SCM_CELL_WORD_1 (x))
  69 #define SCM_I_VECTOR_LENGTH(x) (((size_t) SCM_CELL_WORD_0 (x)) >> 8)
  70
  71 SCM_INTERNAL void scm_i_vector_free (SCM vec);
  72 SCM_INTERNAL SCM  scm_i_vector_equal_p (SCM x, SCM y);
  73
  74 /* Weak vectors share implementation details with ordinary vectors,
  75    but no one else should.
  76  */
  77
  78 #define SCM_I_WVECTP(x)                 (!SCM_IMP (x) && \
  79                                          SCM_TYP7 (x) == scm_tc7_wvect)
  80 #define SCM_I_WVECT_LENGTH              SCM_I_VECTOR_LENGTH
  81 #define SCM_I_WVECT_VELTS               SCM_I_VECTOR_ELTS
  82 #define SCM_I_WVECT_GC_WVELTS           SCM_I_VECTOR_WELTS
  83 #define SCM_I_WVECT_EXTRA(x)            (SCM_CELL_WORD_2 (x))
  84 #define SCM_I_SET_WVECT_EXTRA(x, t)     (SCM_SET_CELL_WORD_2 ((x),(t)))
  85 #define SCM_I_WVECT_GC_CHAIN(x)         (SCM_CELL_OBJECT_3 (x))
  86 #define SCM_I_SET_WVECT_GC_CHAIN(x, o)  (SCM_SET_CELL_OBJECT_3 ((x), (o)))
  87
  88 SCM_INTERNAL SCM scm_i_allocate_weak_vector (scm_t_bits type, SCM size, SCM fill);
  89
  90 SCM_INTERNAL void scm_init_vectors (void);
  91
  92 #endif  /* SCM_VECTORS_H */
  93
  94 /*
  95   Local Variables:
  96   c-file-style: "gnu"
  97   End:
  98 */