Changed license terms to the plain LGPL thru-out.
[bpt/guile.git] / libguile / vectors.c
index 36ffda3..efcd984 100644 (file)
@@ -1,43 +1,19 @@
 /* Copyright (C) 1995,1996,1998,1999,2000,2001 Free Software Foundation, Inc.
  * 
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2, or (at your option)
- * any later version.
- * 
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
- * 
- * You should have received a copy of the GNU General Public License
- * along with this software; see the file COPYING.  If not, write to
- * the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
- * Boston, MA 02111-1307 USA
- *
- * As a special exception, the Free Software Foundation gives permission
- * for additional uses of the text contained in its release of GUILE.
- *
- * The exception is that, if you link the GUILE library with other files
- * to produce an executable, this does not by itself cause the
- * resulting executable to be covered by the GNU General Public License.
- * Your use of that executable is in no way restricted on account of
- * linking the GUILE library code into it.
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
  *
- * This exception does not however invalidate any other reasons why
- * the executable file might be covered by the GNU General Public License.
- *
- * This exception applies only to the code released by the
- * Free Software Foundation under the name GUILE.  If you copy
- * code from other Free Software Foundation releases into a copy of
- * GUILE, as the General Public License permits, the exception does
- * not apply to the code that you add in this way.  To avoid misleading
- * anyone as to the status of such modified files, you must delete
- * this exception notice from them.
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
  *
- * If you write modifications of your own for GUILE, it is your choice
- * whether to permit this exception to apply to your modifications.
- * If you do not wish that, delete this exception notice.  */
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+ */
 
 
 \f
@@ -46,6 +22,7 @@
 #include "libguile/eq.h"
 #include "libguile/root.h"
 #include "libguile/strings.h"
+#include "libguile/lang.h"
 
 #include "libguile/validate.h"
 #include "libguile/vectors.h"
@@ -100,8 +77,12 @@ SCM_DEFINE (scm_vector, "vector", 0, 0, 1,
      while the vector is being created. */
   SCM_VALIDATE_LIST_COPYLEN (1, l, i);
   res = scm_c_make_vector (i, SCM_UNSPECIFIED);
-  data = SCM_VELTS (res);
-  while (!SCM_NULLP (l)) 
+
+  /*
+    this code doesn't alloc. -- accessing RES is safe. 
+  */
+  data = SCM_WRITABLE_VELTS (res);
+  while (!SCM_NULL_OR_NIL_P (l)) 
     {
       *data++ = SCM_CAR (l);
       l = SCM_CDR (l);
@@ -164,7 +145,7 @@ scm_vector_set_x (SCM v, SCM k, SCM obj)
                g_vector_set_x, scm_list_3 (v, k, obj),
                SCM_ARG2, s_vector_set_x);
   SCM_ASSERT_RANGE (2, k, SCM_INUM (k) < SCM_VECTOR_LENGTH (v) && SCM_INUM (k) >= 0);
-  SCM_VELTS(v)[(long) SCM_INUM(k)] = obj;
+  SCM_VECTOR_SET (v, (long) SCM_INUM(k), obj);
   return SCM_UNSPECIFIED;
 }
 #undef FUNC_NAME
@@ -207,16 +188,14 @@ scm_c_make_vector (unsigned long int k, SCM fill)
 
       SCM_ASSERT_RANGE (1, scm_ulong2num (k), k <= SCM_VECTOR_MAX_LENGTH);
 
-      base = scm_must_malloc (k * sizeof (scm_t_bits), FUNC_NAME);
+      base = scm_gc_malloc (k * sizeof (scm_t_bits), "vector");
       for (j = 0; j != k; ++j)
        base[j] = SCM_UNPACK (fill);
     }
   else
     base = NULL;
 
-  SCM_NEWCELL (v);
-  SCM_SET_VECTOR_BASE (v, base);
-  SCM_SET_VECTOR_LENGTH (v, k, scm_tc7_vector);
+  v = scm_cell (SCM_MAKE_VECTOR_TAG (k, scm_tc7_vector), (scm_t_bits) base);
   scm_remember_upto_here_1 (fill);
 
   return v;
@@ -236,8 +215,8 @@ SCM_DEFINE (scm_vector_to_list, "vector->list", 1, 0, 0,
 {
   SCM res = SCM_EOL;
   long i;
-  SCM *data;
-  SCM_VALIDATE_VECTOR (1,v);
+  SCM const *data;
+  SCM_VALIDATE_VECTOR (1, v);
   data = SCM_VELTS(v);
   for(i = SCM_VECTOR_LENGTH(v)-1;i >= 0;i--) res = scm_cons(data[i], res);
   return res;
@@ -252,11 +231,10 @@ SCM_DEFINE (scm_vector_fill_x, "vector-fill!", 2, 0, 0,
 #define FUNC_NAME s_scm_vector_fill_x
 {
   register long i;
-  register SCM *data;
   SCM_VALIDATE_VECTOR (1, v);
-  data = SCM_VELTS (v);
+
   for(i = SCM_VECTOR_LENGTH (v) - 1; i >= 0; i--)
-    data[i] = fill;
+    SCM_VECTOR_SET(v, i, fill);
   return SCM_UNSPECIFIED;
 }
 #undef FUNC_NAME
@@ -275,48 +253,72 @@ scm_vector_equal_p(SCM x, SCM y)
 
 SCM_DEFINE (scm_vector_move_left_x, "vector-move-left!", 5, 0, 0, 
             (SCM vec1, SCM start1, SCM end1, SCM vec2, SCM start2),
-           "Vector version of @code{substring-move-left!}.")
+           "Copy elements from @var{vec1}, positions @var{start1} to @var{end1},\n"
+           "to @var{vec2} starting at position @var{start2}.  @var{start1} and\n"
+           "@var{start2} are inclusive indices; @var{end1} is exclusive.\n\n"
+           "@code{vector-move-left!} copies elements in leftmost order.\n"
+           "Therefore, in the case where @var{vec1} and @var{vec2} refer to the\n"
+           "same vector, @code{vector-move-left!} is usually appropriate when\n"
+           "@var{start1} is greater than @var{start2}.")
 #define FUNC_NAME s_scm_vector_move_left_x
 {
   long i;
   long j;
   long e;
   
-  SCM_VALIDATE_VECTOR (1,vec1);
-  SCM_VALIDATE_INUM_COPY (2,start1,i);
-  SCM_VALIDATE_INUM_COPY (3,end1,e);
-  SCM_VALIDATE_VECTOR (4,vec2);
-  SCM_VALIDATE_INUM_COPY (5,start2,j);
+  SCM_VALIDATE_VECTOR (1, vec1);
+  SCM_VALIDATE_INUM_COPY (2, start1, i);
+  SCM_VALIDATE_INUM_COPY (3, end1, e);
+  SCM_VALIDATE_VECTOR (4, vec2);
+  SCM_VALIDATE_INUM_COPY (5, start2, j);
   SCM_ASSERT_RANGE (2, start1, i <= SCM_VECTOR_LENGTH (vec1) && i >= 0);
   SCM_ASSERT_RANGE (5, start2, j <= SCM_VECTOR_LENGTH (vec2) && j >= 0);
   SCM_ASSERT_RANGE (3, end1, e <= SCM_VECTOR_LENGTH (vec1) && e >= 0);
   SCM_ASSERT_RANGE (5, start2, e-i+j <= SCM_VECTOR_LENGTH (vec2));
-  while (i<e) SCM_VELTS (vec2)[j++] = SCM_VELTS (vec1)[i++];
+
+  while (i<e)
+    {
+      SCM_VECTOR_SET (vec2, j, SCM_VELTS (vec1)[i]);
+      i++;
+      j++;
+    }
+  
   return SCM_UNSPECIFIED;
 }
 #undef FUNC_NAME
 
 SCM_DEFINE (scm_vector_move_right_x, "vector-move-right!", 5, 0, 0, 
             (SCM vec1, SCM start1, SCM end1, SCM vec2, SCM start2),
-           "Vector version of @code{substring-move-right!}.")
+           "Copy elements from @var{vec1}, positions @var{start1} to @var{end1},\n"
+           "to @var{vec2} starting at position @var{start2}.  @var{start1} and\n"
+           "@var{start2} are inclusive indices; @var{end1} is exclusive.\n\n"
+           "@code{vector-move-right!} copies elements in rightmost order.\n"
+           "Therefore, in the case where @var{vec1} and @var{vec2} refer to the\n"
+           "same vector, @code{vector-move-right!} is usually appropriate when\n"
+           "@var{start1} is less than @var{start2}.")
 #define FUNC_NAME s_scm_vector_move_right_x
 {
   long i;
   long j;
   long e;
 
-  SCM_VALIDATE_VECTOR (1,vec1);
-  SCM_VALIDATE_INUM_COPY (2,start1,i);
-  SCM_VALIDATE_INUM_COPY (3,end1,e);
-  SCM_VALIDATE_VECTOR (4,vec2);
-  SCM_VALIDATE_INUM_COPY (5,start2,j);
+  SCM_VALIDATE_VECTOR (1, vec1);
+  SCM_VALIDATE_INUM_COPY (2, start1, i);
+  SCM_VALIDATE_INUM_COPY (3, end1, e);
+  SCM_VALIDATE_VECTOR (4, vec2);
+  SCM_VALIDATE_INUM_COPY (5, start2, j);
   SCM_ASSERT_RANGE (2, start1, i <= SCM_VECTOR_LENGTH (vec1) && i >= 0);
   SCM_ASSERT_RANGE (5, start2, j <= SCM_VECTOR_LENGTH (vec2) && j >= 0);
   SCM_ASSERT_RANGE (3, end1, e <= SCM_VECTOR_LENGTH (vec1) && e >= 0);
   j = e - i + j;
   SCM_ASSERT_RANGE (5, start2, j <= SCM_VECTOR_LENGTH (vec2));
   while (i < e)
-    SCM_VELTS (vec2)[--j] = SCM_VELTS (vec1)[--e];
+    {
+      j--;
+      e--;
+      SCM_VECTOR_SET (vec2, j, SCM_VELTS (vec1)[e]);
+    }
+  
   return SCM_UNSPECIFIED;
 }
 #undef FUNC_NAME
@@ -328,9 +330,7 @@ scm_init_vectors ()
 {
   scm_nullvect = scm_c_make_vector (0, SCM_UNDEFINED);
 
-#ifndef SCM_MAGIC_SNARFER
 #include "libguile/vectors.x"
-#endif
 }