Prefixed each each exported symbol with SCM_API.
[bpt/guile.git] / 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 Free Software Foundation, Inc.
7 *
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2, or (at your option)
11 * any later version.
12 *
13 * This program 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
16 * GNU General Public License for more details.
17 *
18 * You should have received a copy of the GNU General Public License
19 * along with this software; see the file COPYING. If not, write to
20 * the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
21 * Boston, MA 02111-1307 USA
22 *
23 * As a special exception, the Free Software Foundation gives permission
24 * for additional uses of the text contained in its release of GUILE.
25 *
26 * The exception is that, if you link the GUILE library with other files
27 * to produce an executable, this does not by itself cause the
28 * resulting executable to be covered by the GNU General Public License.
29 * Your use of that executable is in no way restricted on account of
30 * linking the GUILE library code into it.
31 *
32 * This exception does not however invalidate any other reasons why
33 * the executable file might be covered by the GNU General Public License.
34 *
35 * This exception applies only to the code released by the
36 * Free Software Foundation under the name GUILE. If you copy
37 * code from other Free Software Foundation releases into a copy of
38 * GUILE, as the General Public License permits, the exception does
39 * not apply to the code that you add in this way. To avoid misleading
40 * anyone as to the status of such modified files, you must delete
41 * this exception notice from them.
42 *
43 * If you write modifications of your own for GUILE, it is your choice
44 * whether to permit this exception to apply to your modifications.
45 * If you do not wish that, delete this exception notice. */
46
47 \f
48
49 #include "libguile/__scm.h"
50
51 \f
52
53 #define SCM_VECTORP(x) (!SCM_IMP (x) && (SCM_TYP7S (x) == scm_tc7_vector))
54 #define SCM_VECTOR_BASE(x) ((scm_t_bits *) SCM_CELL_WORD_1 (x))
55 #define SCM_SET_VECTOR_BASE(v, b) (SCM_SET_CELL_WORD_1 ((v), (b)))
56 #define SCM_VECTOR_MAX_LENGTH ((1L << 24) - 1)
57 #define SCM_VECTOR_LENGTH(x) (((unsigned long) SCM_CELL_WORD_0 (x)) >> 8)
58 #define SCM_SET_VECTOR_LENGTH(v, l, t) (SCM_SET_CELL_WORD_0 ((v), ((l) << 8) + (t)))
59
60 #define SCM_VELTS(x) ((SCM *) SCM_CELL_WORD_1 (x))
61 #define SCM_VELTS_AS_STACKITEMS(x) ((SCM_STACKITEM *) SCM_CELL_WORD_1 (x))
62 #define SCM_SETVELTS(x,v) (SCM_SET_CELL_WORD_1 ((x), (v)))
63
64
65 \f
66 /*
67 bit vectors
68 */
69 #define SCM_BITVEC_REF(a, i) ((SCM_BITVECTOR_BASE (a) [(i) / SCM_LONG_BIT] & (1L << ((i) % SCM_LONG_BIT))) ? 1 : 0)
70 #define SCM_BITVEC_SET(a, i) SCM_BITVECTOR_BASE (a) [(i) / SCM_LONG_BIT] |= (1L << ((i) % SCM_LONG_BIT))
71 #define SCM_BITVEC_CLR(a, i) SCM_BITVECTOR_BASE (a) [(i) / SCM_LONG_BIT] &= ~(1L << ((i) % SCM_LONG_BIT))
72
73
74 \f
75
76 SCM_API SCM scm_c_make_vector (unsigned long int k, SCM fill);
77
78 SCM_API SCM scm_vector_p (SCM x);
79 SCM_API SCM scm_vector_length (SCM v);
80 SCM_API SCM scm_vector (SCM l);
81 SCM_API SCM scm_vector_ref (SCM v, SCM k);
82 SCM_API SCM scm_vector_set_x (SCM v, SCM k, SCM obj);
83 SCM_API SCM scm_make_vector (SCM k, SCM fill);
84 SCM_API SCM scm_vector_to_list (SCM v);
85 SCM_API SCM scm_vector_fill_x (SCM v, SCM fill_x);
86 SCM_API SCM scm_vector_equal_p (SCM x, SCM y);
87 SCM_API SCM scm_vector_move_left_x (SCM vec1, SCM start1, SCM end1,
88 SCM vec2, SCM start2);
89 SCM_API SCM scm_vector_move_right_x (SCM vec1, SCM start1, SCM end1,
90 SCM vec2, SCM start2);
91 SCM_API void scm_init_vectors (void);
92
93 #endif /* SCM_VECTORS_H */
94
95 /*
96 Local Variables:
97 c-file-style: "gnu"
98 End:
99 */