src/pmc/undef.pmc

   1 /*
   2 Copyright (C) 2004 - 2008, The Perl Foundation.
   3 $Id$
   4
   5 =head1 NAME
   6
   7 src/pmc/undef.pmc - Generic undefined value
   8
   9 =head1 DESCRIPTION
  10
  11 This is Parrot's generic undef type. This PMC has no defined value.
  12 It returns a numeric value of 0, a boolean of false, and an empty string.
  13 When assigned a number, integer, or string it morphs to a Number,
  14 Integer, or String PMC respectively, and when assigned a generic PMC
  15 it morphs into a PMC of the passed-in type and does a same-type assignment
  16 from there.
  17
  18 =head2 Methods
  19
  20 =over 4
  21
  22 =cut
  23
  24 */
  25
  26 #include "parrot/parrot.h"
  27 #define UNDEF_STRING_CLASS enum_class_String
  28
  29 pmclass Undef extends default no_ro {
  30
  31 /*
  32
  33 =item C<void set_pmc(PMC *other)>
  34
  35 Sets the current PMC to C<*other> by first changing the current PMC to the
  36 appropriate type.
  37
  38 =cut
  39
  40 */
  41
  42     VTABLE void set_pmc(PMC *other) {
  43         VTABLE_morph(INTERP, SELF, enum_class_Ref);
  44         VTABLE_set_pmc(INTERP, SELF, other);
  45     }
  46
  47 /*
  48
  49 =item C<void assign_pmc(PMC *other)>
  50
  51 Assigns the PMC to the value of C<*other> by first changing the PMC to the
  52 appropriate type.
  53
  54 =cut
  55
  56 */
  57
  58     VTABLE void assign_pmc(PMC *other) {
  59         if (!PObj_is_object_TEST(other))
  60             VTABLE_morph(INTERP, SELF, other->vtable->base_type);
  61
  62         /* don't want to call set_pmc if we're assigning an Undef to an Undef */
  63         if (other->vtable->base_type != enum_class_Undef)
  64             VTABLE_set_pmc(INTERP, SELF, other);
  65     }
  66
  67
  68 /*
  69
  70 =item C<INTVAL get_integer()>
  71
  72 Returns 0.
  73
  74 =cut
  75
  76 */
  77
  78     VTABLE INTVAL get_integer() {
  79         return 0;
  80     }
  81
  82 /*
  83
  84 =item C<INTVAL defined()>
  85
  86 Returns 0.
  87
  88 =cut
  89
  90 */
  91
  92     VTABLE INTVAL defined() {
  93         return 0;
  94     }
  95
  96 /*
  97
  98 =item C<void set_integer_native(INTVAL value)>
  99
 100 Morphs the current PMC to an C<Integer> and sets the value from C<value>.
 101
 102 =cut
 103
 104 */
 105
 106     VTABLE void set_integer_native(INTVAL value) {
 107         VTABLE_morph(INTERP, SELF, enum_class_Integer);
 108         VTABLE_set_integer_native(INTERP, SELF, value);
 109     }
 110
 111 /*
 112
 113 =item C<FLOATVAL get_number()>
 114
 115 Returns 0.0.
 116
 117 =cut
 118
 119 */
 120
 121     VTABLE FLOATVAL get_number() {
 122         return 0.0;
 123     }
 124
 125 /*
 126
 127 =item C<void set_number_native(FLOATVAL value)>
 128
 129 Morphs the current PMC to a C<Float> and sets the value from C<value>.
 130
 131 =cut
 132
 133 */
 134
 135     VTABLE void set_number_native(FLOATVAL value) {
 136         VTABLE_morph(INTERP, SELF, enum_class_Float);
 137         VTABLE_set_number_native(INTERP, SELF, value);
 138     }
 139
 140 /*
 141
 142 =item C<STRING *get_string()>
 143
 144 Returns an empty string.
 145
 146 =cut
 147
 148 */
 149
 150     VTABLE STRING *get_string() {
 151         return string_make_empty(INTERP, enum_stringrep_one, 0);
 152     }
 153
 154 /*
 155
 156 =item C<void set_string_native(STRING *value)>
 157
 158 Morphs the current PMC to a C<String> and sets the value from C<value>.
 159
 160 =cut
 161
 162 */
 163
 164     VTABLE void set_string_native(STRING *value) {
 165         VTABLE_morph(INTERP, SELF, UNDEF_STRING_CLASS);
 166         VTABLE_set_string_native(INTERP, SELF, value);
 167     }
 168
 169 /*
 170
 171 =item C<INTVAL get_bool()>
 172
 173 Returns 0.
 174
 175 =cut
 176
 177 */
 178
 179     VTABLE INTVAL get_bool() {
 180         return 0;
 181     }
 182
 183 /*
 184
 185 =item C<void share()>
 186
 187 Unknown. (TODO)
 188
 189 =cut
 190
 191 */
 192
 193     VTABLE void share() {
 194         /* see src/pmc/integer.pmc */
 195     }
 196
 197 /*
 198
 199 =item C<PMC *share_ro()>
 200
 201 Unknown. (TODO)
 202
 203 =cut
 204
 205 */
 206
 207     VTABLE PMC *share_ro() {
 208         if (PObj_is_PMC_shared_TEST(SELF))
 209             return SELF;
 210         else
 211             return pt_shared_fixup(INTERP, SELF);
 212     }
 213
 214 /*
 215
 216 =item C<PMC *clone()>
 217
 218 Clones the current Undef PMC.
 219
 220 =cut
 221
 222 */
 223
 224     VTABLE PMC *clone() {
 225         return pmc_new(INTERP, SELF->vtable->base_type);
 226     }
 227
 228 /*
 229
 230 =item C<INTVAL is_equal(PMC *value)>
 231
 232 Returns 1 if the C<*value> is an Undef PMC, 0 otherwise.
 233
 234 =cut
 235
 236 */
 237
 238     VTABLE INTVAL is_equal(PMC *value) {
 239         MMD_Undef: {
 240             return 1;
 241         }
 242         MMD_DEFAULT: {
 243             return 0;
 244         }
 245     }
 246 }
 247
 248 /*
 249
 250 =back
 251
 252 =cut
 253
 254 */
 255
 256
 257 /*
 258  * Local variables:
 259  *   c-file-style: "parrot"
 260  * End:
 261  * vim: expandtab shiftwidth=4:
 262  */