nil is false, whee
[bpt/guile.git] / libguile / pairs.h
CommitLineData
0f2d19dd
JB
1/* classes: h_files */
2
e81d98ec
DH
3#ifndef SCM_PAIRS_H
4#define SCM_PAIRS_H
0527e687 5
45f4cbdf 6/* Copyright (C) 1995,1996,2000,2001, 2004, 2006, 2008, 2009 Free Software Foundation, Inc.
0527e687 7 *
73be1d9e 8 * This library is free software; you can redistribute it and/or
53befeb7
NJ
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.
0527e687 12 *
53befeb7
NJ
13 * This library is distributed in the hope that it will be useful, but
14 * WITHOUT ANY WARRANTY; without even the implied warranty of
73be1d9e
MV
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * Lesser General Public License for more details.
0527e687 17 *
73be1d9e
MV
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
53befeb7
NJ
20 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
21 * 02110-1301 USA
73be1d9e 22 */
1bbd0b84 23
0f2d19dd
JB
24\f
25
b4309c3c 26#include "libguile/__scm.h"
0f2d19dd
JB
27
28\f
29
e81d98ec 30#if (SCM_DEBUG_PAIR_ACCESSES == 1)
e81d98ec 31# define SCM_VALIDATE_PAIR(cell, expr) \
6fcc7d48 32 ((!scm_is_pair (cell) ? scm_error_pair_access (cell), 0 : 0), (expr))
e81d98ec
DH
33#else
34# define SCM_VALIDATE_PAIR(cell, expr) (expr)
35#endif
36
45f4cbdf
MW
37/*
38 * Use scm_is_null_and_not_nil if it's important (for correctness)
39 * that %nil must NOT be considered null.
40 */
41#define scm_is_null_and_not_nil(x) (scm_is_eq ((x), SCM_EOL))
42
43/*
44 * Use scm_is_null_assume_not_nil if %nil will never be tested,
45 * for increased efficiency.
46 */
47#define scm_is_null_assume_not_nil(x) (scm_is_eq ((x), SCM_EOL))
48
49/*
50 * See the comments preceeding the definitions of SCM_BOOL_F and
51 * SCM_MATCHES_BITS_IN_COMMON in tags.h for more information on
52 * how the following macro works.
53 */
54#if SCM_ENABLE_ELISP
55# define scm_is_null_or_nil(x) \
56 (SCM_MATCHES_BITS_IN_COMMON ((x), SCM_ELISP_NIL, SCM_EOL))
57#else
58# define scm_is_null_or_nil(x) (scm_is_null_assume_not_nil (x))
59#endif
60
61/* XXX Should scm_is_null treat %nil as null by default? */
62#define scm_is_null(x) (scm_is_null_and_not_nil(x))
0f2d19dd 63
e81d98ec
DH
64#define SCM_CAR(x) (SCM_VALIDATE_PAIR (x, SCM_CELL_OBJECT_0 (x)))
65#define SCM_CDR(x) (SCM_VALIDATE_PAIR (x, SCM_CELL_OBJECT_1 (x)))
76a369d9 66
e81d98ec
DH
67#define SCM_SETCAR(x, v) (SCM_VALIDATE_PAIR (x, SCM_SET_CELL_OBJECT_0 ((x), (v))))
68#define SCM_SETCDR(x, v) (SCM_VALIDATE_PAIR (x, SCM_SET_CELL_OBJECT_1 ((x), (v))))
24e68a57 69
0f2d19dd
JB
70#define SCM_CAAR(OBJ) SCM_CAR (SCM_CAR (OBJ))
71#define SCM_CDAR(OBJ) SCM_CDR (SCM_CAR (OBJ))
72#define SCM_CADR(OBJ) SCM_CAR (SCM_CDR (OBJ))
73#define SCM_CDDR(OBJ) SCM_CDR (SCM_CDR (OBJ))
74
75#define SCM_CAAAR(OBJ) SCM_CAR (SCM_CAR (SCM_CAR (OBJ)))
76#define SCM_CDAAR(OBJ) SCM_CDR (SCM_CAR (SCM_CAR (OBJ)))
77#define SCM_CADAR(OBJ) SCM_CAR (SCM_CDR (SCM_CAR (OBJ)))
78#define SCM_CDDAR(OBJ) SCM_CDR (SCM_CDR (SCM_CAR (OBJ)))
79#define SCM_CAADR(OBJ) SCM_CAR (SCM_CAR (SCM_CDR (OBJ)))
80#define SCM_CDADR(OBJ) SCM_CDR (SCM_CAR (SCM_CDR (OBJ)))
81#define SCM_CADDR(OBJ) SCM_CAR (SCM_CDR (SCM_CDR (OBJ)))
82#define SCM_CDDDR(OBJ) SCM_CDR (SCM_CDR (SCM_CDR (OBJ)))
83
84#define SCM_CAAAAR(OBJ) SCM_CAR (SCM_CAR (SCM_CAR (SCM_CAR (OBJ))))
85#define SCM_CDAAAR(OBJ) SCM_CDR (SCM_CAR (SCM_CAR (SCM_CAR (OBJ))))
86#define SCM_CADAAR(OBJ) SCM_CAR (SCM_CDR (SCM_CAR (SCM_CAR (OBJ))))
87#define SCM_CDDAAR(OBJ) SCM_CDR (SCM_CDR (SCM_CAR (SCM_CAR (OBJ))))
88#define SCM_CAADAR(OBJ) SCM_CAR (SCM_CAR (SCM_CDR (SCM_CAR (OBJ))))
89#define SCM_CDADAR(OBJ) SCM_CDR (SCM_CAR (SCM_CDR (SCM_CAR (OBJ))))
90#define SCM_CADDAR(OBJ) SCM_CAR (SCM_CDR (SCM_CDR (SCM_CAR (OBJ))))
91#define SCM_CDDDAR(OBJ) SCM_CDR (SCM_CDR (SCM_CDR (SCM_CAR (OBJ))))
92#define SCM_CAAADR(OBJ) SCM_CAR (SCM_CAR (SCM_CAR (SCM_CDR (OBJ))))
93#define SCM_CDAADR(OBJ) SCM_CDR (SCM_CAR (SCM_CAR (SCM_CDR (OBJ))))
94#define SCM_CADADR(OBJ) SCM_CAR (SCM_CDR (SCM_CAR (SCM_CDR (OBJ))))
95#define SCM_CDDADR(OBJ) SCM_CDR (SCM_CDR (SCM_CAR (SCM_CDR (OBJ))))
96#define SCM_CAADDR(OBJ) SCM_CAR (SCM_CAR (SCM_CDR (SCM_CDR (OBJ))))
97#define SCM_CDADDR(OBJ) SCM_CDR (SCM_CAR (SCM_CDR (SCM_CDR (OBJ))))
98#define SCM_CADDDR(OBJ) SCM_CAR (SCM_CDR (SCM_CDR (SCM_CDR (OBJ))))
99#define SCM_CDDDDR(OBJ) SCM_CDR (SCM_CDR (SCM_CDR (SCM_CDR (OBJ))))
100
0f2d19dd 101\f
1cc91f1b 102
e81d98ec 103#if (SCM_DEBUG_PAIR_ACCESSES == 1)
33b001fd 104SCM_API void scm_error_pair_access (SCM);
e81d98ec 105#endif
6fcc7d48 106
33b001fd
MV
107SCM_API SCM scm_cons (SCM x, SCM y);
108SCM_API SCM scm_cons2 (SCM w, SCM x, SCM y);
109SCM_API SCM scm_pair_p (SCM x);
ddda5e8f
MV
110SCM_API SCM scm_car (SCM x);
111SCM_API SCM scm_cdr (SCM x);
33b001fd
MV
112SCM_API SCM scm_set_car_x (SCM pair, SCM value);
113SCM_API SCM scm_set_cdr_x (SCM pair, SCM value);
ddda5e8f 114
f36878ba
AW
115SCM_API SCM scm_cddr (SCM x);
116SCM_API SCM scm_cdar (SCM x);
117SCM_API SCM scm_cadr (SCM x);
118SCM_API SCM scm_caar (SCM x);
119SCM_API SCM scm_cdddr (SCM x);
120SCM_API SCM scm_cddar (SCM x);
121SCM_API SCM scm_cdadr (SCM x);
122SCM_API SCM scm_cdaar (SCM x);
123SCM_API SCM scm_caddr (SCM x);
124SCM_API SCM scm_cadar (SCM x);
125SCM_API SCM scm_caadr (SCM x);
126SCM_API SCM scm_caaar (SCM x);
127SCM_API SCM scm_cddddr (SCM x);
128SCM_API SCM scm_cdddar (SCM x);
129SCM_API SCM scm_cddadr (SCM x);
130SCM_API SCM scm_cddaar (SCM x);
131SCM_API SCM scm_cdaddr (SCM x);
132SCM_API SCM scm_cdadar (SCM x);
133SCM_API SCM scm_cdaadr (SCM x);
134SCM_API SCM scm_cdaaar (SCM x);
135SCM_API SCM scm_cadddr (SCM x);
136SCM_API SCM scm_caddar (SCM x);
137SCM_API SCM scm_cadadr (SCM x);
138SCM_API SCM scm_cadaar (SCM x);
139SCM_API SCM scm_caaddr (SCM x);
140SCM_API SCM scm_caadar (SCM x);
141SCM_API SCM scm_caaadr (SCM x);
142SCM_API SCM scm_caaaar (SCM x);
ddda5e8f 143
102dbb6f 144SCM_INTERNAL void scm_init_pairs (void);
1cc91f1b 145
e81d98ec 146#endif /* SCM_PAIRS_H */
89e00824
ML
147
148/*
149 Local Variables:
150 c-file-style: "gnu"
151 End:
152*/