src/pmc/boolean.pmc

   1 /*
   2 Copyright (C) 2001-2010, Parrot Foundation.
   3 $Id$
   4
   5 =head1 NAME
   6
   7 src/pmc/boolean.pmc - Boolean PMC
   8
   9 =head1 DESCRIPTION
  10
  11 This PMC implements a Boolean type with a single true/false value.
  12 A C<Boolean> does not morph to other types when its value is set; it simply
  13 changes its value.
  14
  15 This implementation of C<Boolean> inherits from the C<Scalar> PMC.
  16 Unlike the previous implementation, it does I<not> inherit
  17 from C<Integer>.
  18
  19 =head2 Functions
  20
  21 =over
  22
  23 =cut
  24
  25 */
  26
  27 /* HEADERIZER HFILE: none */
  28 /* HEADERIZER BEGIN: static */
  29 /* HEADERIZER END: static */
  30
  31 /* This new Boolean PMC stores its boolean value in a private PObj flag. */
  32
  33 #define boolean_FLAG PObj_private0_FLAG
  34
  35 #define get_boolean_FLAG(pmc) \
  36     ((PObj_get_FLAGS(pmc) & boolean_FLAG) != 0)
  37
  38 #define set_boolean_FLAG(pmc, val) \
  39      if (val) \
  40          PObj_get_FLAGS(pmc) |= boolean_FLAG; \
  41      else \
  42          PObj_get_FLAGS(pmc) &= ~boolean_FLAG;
  43
  44 #define flip_boolean_FLAG(pmc) \
  45      PObj_get_FLAGS(pmc) ^= boolean_FLAG
  46
  47
  48 pmclass Boolean extends scalar provides boolean provides scalar manual_attrs {
  49
  50 /*
  51
  52 =item C<void init()>
  53
  54 Create a new C<Boolean> with initial value C<FALSE>.
  55
  56 =item C<void init_pmc(PMC *value)>
  57
  58 Create a new C<Boolean> with the given initial value interpreted
  59 as a Boolean.
  60
  61 =item C<void init_int(INTVAL value)>
  62
  63 Create a new C<Boolean> with the given initial value interpreted
  64 as a Boolean.
  65
  66 =cut
  67
  68 */
  69
  70     /* These init functions set the boolean flag directly. */
  71
  72     VTABLE void init() {
  73         set_boolean_FLAG(SELF, 0);
  74     }
  75
  76     VTABLE void init_pmc(PMC *value) {
  77         INTVAL v = PMC_IS_NULL(value) ? 0 : VTABLE_get_bool(INTERP, value);
  78         set_boolean_FLAG(SELF, v);
  79     }
  80
  81     VTABLE void init_int(INTVAL value) {
  82         set_boolean_FLAG(SELF, value);
  83     }
  84
  85 /*
  86
  87 =item C<INTVAL get_bool()>
  88
  89 Obtain the value of the C<Boolean> as an integer: 1 = C<TRUE>, 0 = C<FALSE>.
  90
  91 =item C<INTVAL get_integer()>
  92
  93 Same as C<get_bool()>.
  94
  95 =item C<FLOATVAL get_number()>
  96
  97 Obtain the value of the C<Boolean> as a float: 1.0 = C<TRUE>, 0.0 = C<FALSE>.
  98
  99 =item C<STRING *get_string()>
 100
 101 Obtain the value of the C<Boolean> as a string: "1" = C<TRUE>, "0" = C<FALSE>.
 102
 103 =cut
 104
 105 */
 106
 107     VTABLE INTVAL get_bool() {
 108         return get_boolean_FLAG(SELF);
 109     }
 110
 111     VTABLE INTVAL get_integer() {
 112         return SELF.get_bool();
 113     }
 114
 115     VTABLE FLOATVAL get_number() {
 116         INTVAL value = SELF.get_bool();
 117         return (FLOATVAL)value;
 118     }
 119
 120     VTABLE STRING *get_string() {
 121         return Parrot_str_from_int(INTERP, SELF.get_integer());
 122     }
 123
 124 /*
 125
 126 =item C<void set_bool(INTVAL value)>
 127
 128 Sets the value of the Boolean to the specified integer value: 0 = C<FALSE>, non-0 =
 129 C<TRUE>.
 130
 131 =item C<void set_integer_native(INTVAL value)>
 132
 133 Same as C<set_bool()>.
 134
 135 =item C<void set_number_native(FLOATVAL value)>
 136
 137 Sets the value of the Boolean to the specified float value: 0.0 = C<FALSE>, non-0.0 =
 138 C<TRUE>.
 139
 140 =item C<void set_string_native(STRING *value)>
 141
 142 Sets the Boolean to the value represented by the specified string. All values are
 143 considered C<TRUE> except for C<""> and C<"0>", which are considered
 144 C<FALSE>.
 145
 146 =cut
 147
 148 */
 149
 150     VTABLE void set_bool(INTVAL value) {
 151         set_boolean_FLAG(SELF, value);
 152     }
 153
 154     VTABLE void set_integer_native(INTVAL value) {
 155         SELF.set_bool(value);
 156     }
 157
 158     VTABLE void set_number_native(FLOATVAL value) {
 159         SELF.set_bool(!FLOAT_IS_ZERO(value));
 160     }
 161
 162     VTABLE void set_string_native(STRING *value) {
 163         SELF.set_bool(Parrot_str_boolean(INTERP, value));
 164     }
 165
 166 /*
 167
 168 =item C<void freeze(PMC *info)>
 169
 170 Used to archive the C<Boolean>.
 171
 172 =item C<void thaw(PMC *info)>
 173
 174 Used to unarchive the C<Boolean>.
 175
 176 =cut
 177
 178 */
 179
 180     VTABLE void freeze(PMC *info) {
 181         SUPER(info);
 182         VTABLE_push_integer(INTERP, info, SELF.get_bool());
 183     }
 184
 185     VTABLE void thaw(PMC *info) {
 186         SUPER(info);
 187         SELF.set_bool(VTABLE_shift_integer(INTERP, info));
 188     }
 189
 190 }
 191
 192 /*
 193
 194 =back
 195
 196 See also the C<Scalar> PMC.
 197
 198 =cut
 199
 200 */
 201
 202 /*
 203  * Local variables:
 204  *   c-file-style: "parrot"
 205  * End:
 206  * vim: expandtab shiftwidth=4:
 207  */