6 /* Copyright (C) 1995,1996,2000, 2006, 2008, 2009, 2010 Free Software Foundation, Inc.
8 * This library is free software; you can redistribute it and/or
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.
13 * This library is distributed in the hope that it will be useful, but
14 * 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.
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
26 #include "libguile/__scm.h"
30 /* Boolean Values. Obviously there are #t and #f, but there is also nil to deal
31 * with. We choose to treat nil as a false boolean. All options might silently
32 * break existing code, but this one seems most responsible.
37 * Use these macros if it's important (for correctness)
38 * that #nil MUST be considered true
40 #define scm_is_false_and_not_nil(x) (scm_is_eq ((x), SCM_BOOL_F))
41 #define scm_is_true_or_nil(x) (!scm_is_eq ((x), SCM_BOOL_F))
44 * Use these macros if #nil will never be tested,
45 * for increased efficiency.
47 #define scm_is_false_assume_not_nil(x) (scm_is_eq ((x), SCM_BOOL_F))
48 #define scm_is_true_assume_not_nil(x) (!scm_is_eq ((x), SCM_BOOL_F))
51 * See the comments preceeding the definitions of SCM_BOOL_F and
52 * SCM_MATCHES_BITS_IN_COMMON in tags.h for more information on
53 * how the following macro works.
55 #define scm_is_false_or_nil(x) \
56 (SCM_MATCHES_BITS_IN_COMMON ((x), SCM_ELISP_NIL, SCM_BOOL_F))
57 #define scm_is_true_and_not_nil(x) (!scm_is_false_or_nil (x))
61 #define scm_is_false(x) (scm_is_false_or_nil (x))
62 #define scm_is_true(x) (!scm_is_false (x))
65 * Since we know SCM_BOOL_F and SCM_BOOL_T differ by exactly one bit,
66 * and that SCM_BOOL_F and SCM_ELISP_NIL differ by exactly one bit,
67 * and that they of course can't be the same bit (or else SCM_BOOL_T
68 * and SCM_ELISP_NIL be would equal), it follows that SCM_BOOL_T and
69 * SCM_ELISP_NIL differ by exactly two bits, and these are the bits
70 * which will be ignored by SCM_MATCHES_BITS_IN_COMMON below.
72 * See the comments preceeding the definitions of SCM_BOOL_F and
73 * SCM_MATCHES_BITS_IN_COMMON in tags.h for more information.
75 * If SCM_ENABLE_ELISP is true, then scm_is_bool_or_nil(x)
76 * returns 1 if and only if x is one of the following: SCM_BOOL_F,
77 * SCM_BOOL_T, SCM_ELISP_NIL, or SCM_XXX_ANOTHER_BOOLEAN_DONT_USE_0.
78 * Otherwise, it returns 0.
80 #define scm_is_bool_or_nil(x) \
81 (SCM_MATCHES_BITS_IN_COMMON ((x), SCM_BOOL_T, SCM_ELISP_NIL))
82 #define scm_is_bool_and_not_nil(x) \
83 (SCM_MATCHES_BITS_IN_COMMON ((x), SCM_BOOL_F, SCM_BOOL_T))
85 SCM_API
int scm_is_bool (SCM
);
87 #define scm_is_bool(x) (scm_is_bool_or_nil (x))
89 #define scm_from_bool(x) ((x) ? SCM_BOOL_T : SCM_BOOL_F)
90 SCM_API
int scm_to_bool (SCM x
);
95 * The following macros efficiently implement boolean truth testing as
96 * expected by most lisps, which treat '() aka SCM_EOL as false.
98 * Since we know SCM_ELISP_NIL and SCM_BOOL_F differ by exactly one
99 * bit, and that SCM_ELISP_NIL and SCM_EOL differ by exactly one bit,
100 * and that they of course can't be the same bit (or else SCM_BOOL_F
101 * and SCM_EOL be would equal), it follows that SCM_BOOL_F and SCM_EOL
102 * differ by exactly two bits, and these are the bits which will be
103 * ignored by SCM_MATCHES_BITS_IN_COMMON below.
105 * See the comments preceeding the definitions of SCM_BOOL_F and
106 * SCM_MATCHES_BITS_IN_COMMON in tags.h for more information.
108 * scm_is_lisp_false(x) returns 1 if and only if x is one of the
109 * following: SCM_BOOL_F, SCM_ELISP_NIL, SCM_EOL or
110 * SCM_XXX_ANOTHER_LISP_FALSE_DONT_USE. Otherwise, it returns 0.
112 #define scm_is_lisp_false(x) \
113 (SCM_MATCHES_BITS_IN_COMMON ((x), SCM_BOOL_F, SCM_EOL))
117 SCM_API SCM
scm_not (SCM x
);
118 SCM_API SCM
scm_boolean_p (SCM obj
);
120 SCM_INTERNAL
void scm_init_boolean (void);
122 #endif /* SCM_BOOLEAN_H */