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 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
  10  * License as published by the Free Software Foundation; either
  11  * version 2.1 of the License, or (at your option) any later version.
  12  *
  13  * This library is distributed in the hope that it will be useful,
  14  * but 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 02110-1301 USA
  21  */
  22
  23 \f
  24
  25 #include "libguile/__scm.h"
  26 #include "libguile/unif.h"
  27
  28 \f
  29
  30 SCM_API SCM scm_vector_p (SCM x);
  31 SCM_API SCM scm_vector_length (SCM v);
  32 SCM_API SCM scm_vector (SCM l);
  33 SCM_API SCM scm_vector_ref (SCM v, SCM k);
  34 SCM_API SCM scm_vector_set_x (SCM v, SCM k, SCM obj);
  35 SCM_API SCM scm_make_vector (SCM k, SCM fill);
  36 SCM_API SCM scm_vector_to_list (SCM v);
  37 SCM_API SCM scm_vector_fill_x (SCM v, SCM fill_x);
  38 SCM_API SCM scm_vector_move_left_x (SCM vec1, SCM start1, SCM end1,
  39                                     SCM vec2, SCM start2);
  40 SCM_API SCM scm_vector_move_right_x (SCM vec1, SCM start1, SCM end1,
  41                                      SCM vec2, SCM start2);
  42 SCM_API SCM scm_vector_copy (SCM vec);
  43
  44 SCM_API int scm_is_vector (SCM obj);
  45 SCM_API int scm_is_simple_vector (SCM obj);
  46 SCM_API SCM scm_c_make_vector (size_t len, SCM fill);
  47 SCM_API size_t scm_c_vector_length (SCM vec);
  48 SCM_API SCM scm_c_vector_ref (SCM vec, size_t k);
  49 SCM_API void scm_c_vector_set_x (SCM vec, size_t k, SCM obj);
  50 SCM_API const SCM *scm_vector_elements (SCM vec,
  51                                         scm_t_array_handle *h,
  52                                         size_t *lenp, ssize_t *incp);
  53 SCM_API SCM *scm_vector_writable_elements (SCM vec,
  54                                            scm_t_array_handle *h,
  55                                            size_t *lenp, ssize_t *incp);
  56
  57 /* Fast, non-checking accessors for simple vectors.
  58  */
  59 #define SCM_SIMPLE_VECTOR_LENGTH(x)      SCM_I_VECTOR_LENGTH(x)
  60 #define SCM_SIMPLE_VECTOR_REF(x,idx)     ((SCM_I_VECTOR_ELTS(x))[idx])
  61 #define SCM_SIMPLE_VECTOR_SET(x,idx,val) ((SCM_I_VECTOR_WELTS(x))[idx]=(val))
  62
  63 /* Generalized vectors */
  64
  65 SCM_API SCM scm_generalized_vector_p (SCM v);
  66 SCM_API SCM scm_generalized_vector_length (SCM v);
  67 SCM_API SCM scm_generalized_vector_ref (SCM v, SCM idx);
  68 SCM_API SCM scm_generalized_vector_set_x (SCM v, SCM idx, SCM val);
  69 SCM_API SCM scm_generalized_vector_to_list (SCM v);
  70
  71 SCM_API int scm_is_generalized_vector (SCM obj);
  72 SCM_API size_t scm_c_generalized_vector_length (SCM v);
  73 SCM_API SCM scm_c_generalized_vector_ref (SCM v, size_t idx);
  74 SCM_API void scm_c_generalized_vector_set_x (SCM v, size_t idx, SCM val);
  75 SCM_API void scm_generalized_vector_get_handle (SCM vec,
  76                                                 scm_t_array_handle *h);
  77
  78 /* Internals */
  79
  80 #define SCM_I_IS_VECTOR(x)     (!SCM_IMP(x) && (SCM_TYP7S(x)==scm_tc7_vector))
  81 #define SCM_I_VECTOR_ELTS(x)   ((const SCM *) SCM_CELL_WORD_1 (x))
  82 #define SCM_I_VECTOR_WELTS(x)  ((SCM *) SCM_CELL_WORD_1 (x))
  83 #define SCM_I_VECTOR_LENGTH(x) (((size_t) SCM_CELL_WORD_0 (x)) >> 8)
  84
  85 SCM_API void scm_i_vector_free (SCM vec);
  86 SCM_API SCM  scm_i_vector_equal_p (SCM x, SCM y);
  87
  88 /* Weak vectors share implementation details with ordinary vectors,
  89    but no one else should.
  90  */
  91
  92 #define SCM_I_WVECTP(x)                 (!SCM_IMP (x) && \
  93                                          SCM_TYP7 (x) == scm_tc7_wvect)
  94 #define SCM_I_WVECT_LENGTH              SCM_I_VECTOR_LENGTH
  95 #define SCM_I_WVECT_VELTS               SCM_I_VECTOR_ELTS
  96 #define SCM_I_WVECT_GC_WVELTS           SCM_I_VECTOR_WELTS
  97 #define SCM_I_WVECT_TYPE(x)             (SCM_CELL_WORD_2 (x))
  98 #define SCM_I_SET_WVECT_TYPE(x, t)      (SCM_SET_CELL_WORD_2 ((x),(t)))
  99 #define SCM_I_WVECT_GC_CHAIN(x)         (SCM_CELL_OBJECT_3 (x))
 100 #define SCM_I_SET_WVECT_GC_CHAIN(x, o)  (SCM_SET_CELL_OBJECT_3 ((x), (o)))
 101
 102 SCM_API SCM scm_i_allocate_weak_vector (scm_t_bits type, SCM size, SCM fill);
 103
 104 SCM_API void scm_init_vectors (void);
 105
 106 #endif  /* SCM_VECTORS_H */
 107
 108 /*
 109   Local Variables:
 110   c-file-style: "gnu"
 111   End:
 112 */