libguile/vectors.c

   1 /* Copyright (C) 1995,1996,1998,1999,2000,2001 Free Software Foundation, Inc.
   2  *
   3  * This program is free software; you can redistribute it and/or modify
   4  * it under the terms of the GNU General Public License as published by
   5  * the Free Software Foundation; either version 2, or (at your option)
   6  * any later version.
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11  * GNU General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License
  14  * along with this software; see the file COPYING.  If not, write to
  15  * the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
  16  * Boston, MA 02111-1307 USA
  17  *
  18  * As a special exception, the Free Software Foundation gives permission
  19  * for additional uses of the text contained in its release of GUILE.
  20  *
  21  * The exception is that, if you link the GUILE library with other files
  22  * to produce an executable, this does not by itself cause the
  23  * resulting executable to be covered by the GNU General Public License.
  24  * Your use of that executable is in no way restricted on account of
  25  * linking the GUILE library code into it.
  26  *
  27  * This exception does not however invalidate any other reasons why
  28  * the executable file might be covered by the GNU General Public License.
  29  *
  30  * This exception applies only to the code released by the
  31  * Free Software Foundation under the name GUILE.  If you copy
  32  * code from other Free Software Foundation releases into a copy of
  33  * GUILE, as the General Public License permits, the exception does
  34  * not apply to the code that you add in this way.  To avoid misleading
  35  * anyone as to the status of such modified files, you must delete
  36  * this exception notice from them.
  37  *
  38  * If you write modifications of your own for GUILE, it is your choice
  39  * whether to permit this exception to apply to your modifications.
  40  * If you do not wish that, delete this exception notice.  */
  41
  42 /* Software engineering face-lift by Greg J. Badros, 11-Dec-1999,
  43    gjb@cs.washington.edu, http://www.cs.washington.edu/homes/gjb */
  44
  45 \f
  46
  47 #include "libguile/_scm.h"
  48 #include "libguile/eq.h"
  49 #include "libguile/root.h"
  50 #include "libguile/strings.h"
  51
  52 #include "libguile/validate.h"
  53 #include "libguile/vectors.h"
  54 #include "libguile/unif.h"
  55 \f
  56
  57 #if (SCM_DEBUG_DEPRECATED == 0)
  58
  59 /* The function scm_vector_set_length_x will disappear in the next release of
  60  * guile.
  61  */
  62
  63 /*
  64  * This complicates things too much if allowed on any array.
  65  * C code can safely call it on arrays known to be used in a single
  66  * threaded manner.
  67  *
  68  * SCM_REGISTER_PROC(s_vector_set_length_x, "vector-set-length!", 2, 0, 0, scm_vector_set_length_x);
  69  */
  70 static char s_vector_set_length_x[] = "vector-set-length!";
  71
  72
  73 SCM
  74 scm_vector_set_length_x (SCM vect, SCM len)
  75 {
  76   long l;
  77   size_t siz;
  78   size_t sz;
  79   char *base;
  80
  81   l = SCM_INUM (len);
  82   SCM_ASRTGO (SCM_NIMP (vect), badarg1);
  83
  84 #ifdef HAVE_ARRAYS
  85   if (SCM_TYP7 (vect) == scm_tc7_bvect)
  86     {
  87       l = (l + SCM_LONG_BIT - 1) / SCM_LONG_BIT;
  88     }
  89   sz = scm_uniform_element_size (vect);
  90   if (sz != 0)
  91     base = SCM_UVECTOR_BASE (vect);
  92   else
  93 #endif
  94   switch (SCM_TYP7 (vect))
  95     {
  96     default:
  97     badarg1: scm_wta (vect, (char *) SCM_ARG1, s_vector_set_length_x);
  98     case scm_tc7_string:
  99       SCM_ASRTGO (!SCM_EQ_P (vect, scm_nullstr), badarg1);
 100       sz = sizeof (char);
 101       base = SCM_STRING_CHARS (vect);
 102       l++;
 103       break;
 104     case scm_tc7_vector:
 105     case scm_tc7_wvect:
 106       SCM_ASRTGO (!SCM_EQ_P (vect, scm_nullvect), badarg1);
 107       sz = sizeof (SCM);
 108       base = (char *) SCM_VECTOR_BASE (vect);
 109       break;
 110     }
 111   SCM_ASSERT (SCM_INUMP (len), len, SCM_ARG2, s_vector_set_length_x);
 112   if (!l)
 113     l = 1L;
 114   siz = l * sz;
 115   if (siz != l * sz)
 116     scm_memory_error (s_vector_set_length_x);
 117   SCM_REDEFER_INTS;
 118   SCM_SETCHARS (vect,
 119             ((char *)
 120              scm_must_realloc (base,
 121                                (size_t) SCM_LENGTH (vect) * sz,
 122                                (size_t) siz,
 123                                s_vector_set_length_x)));
 124   if (SCM_VECTORP (vect))
 125     {
 126       sz = SCM_LENGTH (vect);
 127       while (l > sz)
 128         SCM_VELTS (vect)[--l] = SCM_UNSPECIFIED;
 129     }
 130   else if (SCM_STRINGP (vect))
 131     SCM_STRING_CHARS (vect)[l - 1] = 0;
 132   SCM_SETLENGTH (vect, SCM_INUM (len), SCM_TYP7 (vect));
 133   SCM_REALLOW_INTS;
 134   return vect;
 135 }
 136
 137 #endif /* (SCM_DEBUG_DEPRECATED == 0) */
 138
 139 SCM_DEFINE (scm_vector_p, "vector?", 1, 0, 0,
 140             (SCM obj),
 141             "Return @code{#t} if @var{obj} is a vector, otherwise return\n"
 142             "@code{#f}.")
 143 #define FUNC_NAME s_scm_vector_p
 144 {
 145   if (SCM_IMP (obj))
 146     return SCM_BOOL_F;
 147   return SCM_BOOL (SCM_VECTORP (obj));
 148 }
 149 #undef FUNC_NAME
 150
 151 SCM_GPROC (s_vector_length, "vector-length", 1, 0, 0, scm_vector_length, g_vector_length);
 152 /* Returns the number of elements in @var{vector} as an exact integer.  */
 153 SCM
 154 scm_vector_length (SCM v)
 155 {
 156   SCM_GASSERT1 (SCM_VECTORP(v),
 157                 g_vector_length, v, SCM_ARG1, s_vector_length);
 158   return SCM_MAKINUM (SCM_VECTOR_LENGTH (v));
 159 }
 160
 161 SCM_REGISTER_PROC (s_list_to_vector, "list->vector", 1, 0, 0, scm_vector);
 162 /*
 163             "Return a newly created vector initialized to the elements of"
 164             "the list @var{list}.\n\n"
 165             "@lisp\n"
 166             "(vector->list '#(dah dah didah)) @result{} (dah dah didah)\n"
 167             "(list->vector '(dididit dah)) @result{}   #(dididit dah)\n"
 168             "@end lisp")
 169 */
 170 SCM_DEFINE (scm_vector, "vector", 0, 0, 1,
 171             (SCM l),
 172             "@deffnx primitive list->vector l\n"
 173             "Return a newly allocated vector whose elements contain the\n"
 174             "given arguments.  Analogous to @code{list}.\n"
 175             "\n"
 176             "@lisp\n"
 177             "(vector 'a 'b 'c) @result{} #(a b c)\n"
 178             "@end lisp")
 179 #define FUNC_NAME s_scm_vector
 180 {
 181   SCM res;
 182   SCM *data;
 183   long i;
 184
 185   /* Dirk:FIXME:: In case of multiple threads, the list might get corrupted
 186      while the vector is being created. */
 187   SCM_VALIDATE_LIST_COPYLEN (1, l, i);
 188   res = scm_c_make_vector (i, SCM_UNSPECIFIED);
 189   data = SCM_VELTS (res);
 190   while (!SCM_NULLP (l))
 191     {
 192       *data++ = SCM_CAR (l);
 193       l = SCM_CDR (l);
 194     }
 195
 196   return res;
 197 }
 198 #undef FUNC_NAME
 199
 200 SCM_GPROC (s_vector_ref, "vector-ref", 2, 0, 0, scm_vector_ref, g_vector_ref);
 201
 202 /*
 203            "@var{k} must be a valid index of @var{vector}.\n"
 204            "@samp{Vector-ref} returns the contents of element @var{k} of\n"
 205            "@var{vector}.\n\n"
 206            "@lisp\n"
 207            "(vector-ref '#(1 1 2 3 5 8 13 21) 5) @result{} 8\n"
 208            "(vector-ref '#(1 1 2 3 5 8 13 21)\n"
 209            "    (let ((i (round (* 2 (acos -1)))))\n"
 210            "      (if (inexact? i)\n"
 211            "        (inexact->exact i)\n"
 212            "           i))) @result{} 13\n"
 213            "@end lisp"
 214 */
 215
 216 SCM
 217 scm_vector_ref (SCM v, SCM k)
 218 #define FUNC_NAME s_vector_ref
 219 {
 220   SCM_GASSERT2 (SCM_VECTORP (v),
 221                 g_vector_ref, v, k, SCM_ARG1, s_vector_ref);
 222   SCM_GASSERT2 (SCM_INUMP (k),
 223                 g_vector_ref, v, k, SCM_ARG2, s_vector_ref);
 224   SCM_ASSERT_RANGE (2, k, SCM_INUM (k) < SCM_VECTOR_LENGTH (v) && SCM_INUM (k) >= 0);
 225   return SCM_VELTS (v)[(long) SCM_INUM (k)];
 226 }
 227 #undef FUNC_NAME
 228
 229 SCM_GPROC (s_vector_set_x, "vector-set!", 3, 0, 0, scm_vector_set_x, g_vector_set_x);
 230
 231 /* "@var{k} must be a valid index of @var{vector}.\n"
 232    "@code{Vector-set!} stores @var{obj} in element @var{k} of @var{vector}.\n"
 233    "The value returned by @samp{vector-set!} is unspecified.\n"
 234    "@lisp\n"
 235    "(let ((vec (vector 0 '(2 2 2 2) "Anna")))\n"
 236    "  (vector-set! vec 1 '("Sue" "Sue"))\n"
 237    "  vec) @result{}  #(0 ("Sue" "Sue") "Anna")\n"
 238    "(vector-set! '#(0 1 2) 1 "doe") @result{} @emph{error} ; constant vector\n"
 239    "@end lisp"
 240 */
 241
 242 SCM
 243 scm_vector_set_x (SCM v, SCM k, SCM obj)
 244 #define FUNC_NAME s_vector_set_x
 245 {
 246   SCM_GASSERTn (SCM_VECTORP (v),
 247                 g_vector_set_x, SCM_LIST3 (v, k, obj),
 248                 SCM_ARG1, s_vector_set_x);
 249   SCM_GASSERTn (SCM_INUMP (k),
 250                 g_vector_set_x, SCM_LIST3 (v, k, obj),
 251                 SCM_ARG2, s_vector_set_x);
 252   SCM_ASSERT_RANGE (2, k, SCM_INUM (k) < SCM_VECTOR_LENGTH (v) && SCM_INUM (k) >= 0);
 253   SCM_VELTS(v)[(long) SCM_INUM(k)] = obj;
 254   return SCM_UNSPECIFIED;
 255 }
 256 #undef FUNC_NAME
 257
 258
 259 SCM_DEFINE (scm_make_vector, "make-vector", 1, 1, 0,
 260             (SCM k, SCM fill),
 261             "Return a newly allocated vector of @var{k} elements.  If a\n"
 262             "second argument is given, then each element is initialized to\n"
 263             "@var{fill}.  Otherwise the initial contents of each element is\n"
 264             "unspecified.")
 265 #define FUNC_NAME s_scm_make_vector
 266 {
 267   if (SCM_UNBNDP (fill))
 268     fill = SCM_UNSPECIFIED;
 269
 270   if (SCM_INUMP (k))
 271     {
 272       SCM_ASSERT_RANGE (1, k, SCM_INUM (k) >= 0);
 273       return scm_c_make_vector (SCM_INUM (k), fill);
 274     }
 275   else if (SCM_BIGP (k))
 276     SCM_OUT_OF_RANGE (1, k);
 277   else
 278     SCM_WRONG_TYPE_ARG (1, k);
 279 }
 280 #undef FUNC_NAME
 281
 282
 283 SCM
 284 scm_c_make_vector (unsigned long int k, SCM fill)
 285 #define FUNC_NAME s_scm_make_vector
 286 {
 287   SCM v;
 288   scm_t_bits *base;
 289
 290   if (k > 0)
 291     {
 292       unsigned long int j;
 293
 294       SCM_ASSERT_RANGE (1, scm_ulong2num (k), k <= SCM_VECTOR_MAX_LENGTH);
 295
 296       base = scm_must_malloc (k * sizeof (scm_t_bits), FUNC_NAME);
 297       for (j = 0; j != k; ++j)
 298         base[j] = SCM_UNPACK (fill);
 299     }
 300   else
 301     base = NULL;
 302
 303   SCM_NEWCELL (v);
 304   SCM_SET_VECTOR_BASE (v, base);
 305   SCM_SET_VECTOR_LENGTH (v, k, scm_tc7_vector);
 306   scm_remember_upto_here_1 (fill);
 307
 308   return v;
 309 }
 310 #undef FUNC_NAME
 311
 312
 313 SCM_DEFINE (scm_vector_to_list, "vector->list", 1, 0, 0,
 314             (SCM v),
 315             "Return a newly allocated list of the objects contained in the\n"
 316             "elements of @var{vector}.\n"
 317             "\n"
 318             "@lisp\n"
 319             "(vector->list '#(dah dah didah)) @result{}  (dah dah didah)\n"
 320             "(list->vector '(dididit dah)) @result{}  #(dididit dah)\n"
 321             "@end lisp")
 322 #define FUNC_NAME s_scm_vector_to_list
 323 {
 324   SCM res = SCM_EOL;
 325   long i;
 326   SCM *data;
 327   SCM_VALIDATE_VECTOR (1,v);
 328   data = SCM_VELTS(v);
 329   for(i = SCM_VECTOR_LENGTH(v)-1;i >= 0;i--) res = scm_cons(data[i], res);
 330   return res;
 331 }
 332 #undef FUNC_NAME
 333
 334
 335 SCM_DEFINE (scm_vector_fill_x, "vector-fill!", 2, 0, 0,
 336             (SCM v, SCM fill),
 337             "Store @var{fill} in every element of @var{vector}.  The value\n"
 338             "returned by @code{vector-fill!} is unspecified.")
 339 #define FUNC_NAME s_scm_vector_fill_x
 340 {
 341   register long i;
 342   register SCM *data;
 343   SCM_VALIDATE_VECTOR (1, v);
 344   data = SCM_VELTS (v);
 345   for(i = SCM_VECTOR_LENGTH (v) - 1; i >= 0; i--)
 346     data[i] = fill;
 347   return SCM_UNSPECIFIED;
 348 }
 349 #undef FUNC_NAME
 350
 351
 352 SCM
 353 scm_vector_equal_p(SCM x, SCM y)
 354 {
 355   long i;
 356   for(i = SCM_VECTOR_LENGTH (x) - 1; i >= 0; i--)
 357     if (SCM_FALSEP (scm_equal_p (SCM_VELTS (x)[i], SCM_VELTS (y)[i])))
 358       return SCM_BOOL_F;
 359   return SCM_BOOL_T;
 360 }
 361
 362
 363 SCM_DEFINE (scm_vector_move_left_x, "vector-move-left!", 5, 0, 0,
 364             (SCM vec1, SCM start1, SCM end1, SCM vec2, SCM start2),
 365             "Vector version of @code{substring-move-left!}.")
 366 #define FUNC_NAME s_scm_vector_move_left_x
 367 {
 368   long i;
 369   long j;
 370   long e;
 371
 372   SCM_VALIDATE_VECTOR (1,vec1);
 373   SCM_VALIDATE_INUM_COPY (2,start1,i);
 374   SCM_VALIDATE_INUM_COPY (3,end1,e);
 375   SCM_VALIDATE_VECTOR (4,vec2);
 376   SCM_VALIDATE_INUM_COPY (5,start2,j);
 377   SCM_ASSERT_RANGE (2, start1, i <= SCM_VECTOR_LENGTH (vec1) && i >= 0);
 378   SCM_ASSERT_RANGE (5, start2, j <= SCM_VECTOR_LENGTH (vec2) && j >= 0);
 379   SCM_ASSERT_RANGE (3, end1, e <= SCM_VECTOR_LENGTH (vec1) && e >= 0);
 380   SCM_ASSERT_RANGE (5, start2, e-i+j <= SCM_VECTOR_LENGTH (vec2));
 381   while (i<e) SCM_VELTS (vec2)[j++] = SCM_VELTS (vec1)[i++];
 382   return SCM_UNSPECIFIED;
 383 }
 384 #undef FUNC_NAME
 385
 386 SCM_DEFINE (scm_vector_move_right_x, "vector-move-right!", 5, 0, 0,
 387             (SCM vec1, SCM start1, SCM end1, SCM vec2, SCM start2),
 388             "Vector version of @code{substring-move-right!}.")
 389 #define FUNC_NAME s_scm_vector_move_right_x
 390 {
 391   long i;
 392   long j;
 393   long e;
 394
 395   SCM_VALIDATE_VECTOR (1,vec1);
 396   SCM_VALIDATE_INUM_COPY (2,start1,i);
 397   SCM_VALIDATE_INUM_COPY (3,end1,e);
 398   SCM_VALIDATE_VECTOR (4,vec2);
 399   SCM_VALIDATE_INUM_COPY (5,start2,j);
 400   SCM_ASSERT_RANGE (2, start1, i <= SCM_VECTOR_LENGTH (vec1) && i >= 0);
 401   SCM_ASSERT_RANGE (5, start2, j <= SCM_VECTOR_LENGTH (vec2) && j >= 0);
 402   SCM_ASSERT_RANGE (3, end1, e <= SCM_VECTOR_LENGTH (vec1) && e >= 0);
 403   j = e - i + j;
 404   SCM_ASSERT_RANGE (5, start2, j <= SCM_VECTOR_LENGTH (vec2));
 405   while (i < e)
 406     SCM_VELTS (vec2)[--j] = SCM_VELTS (vec1)[--e];
 407   return SCM_UNSPECIFIED;
 408 }
 409 #undef FUNC_NAME
 410
 411
 412
 413 void
 414 scm_init_vectors ()
 415 {
 416   scm_nullvect = scm_c_make_vector (0, SCM_UNDEFINED);
 417
 418 #ifndef SCM_MAGIC_SNARFER
 419 #include "libguile/vectors.x"
 420 #endif
 421 }
 422
 423
 424 /*
 425   Local Variables:
 426   c-file-style: "gnu"
 427   End:
 428 */