src/pmc/undef.pmc

   1 /*
   2 Copyright (C) 2004-2010, Parrot 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 "pmc/pmc_object.h"
  27 #define UNDEF_STRING_CLASS enum_class_String
  28
  29 /* HEADERIZER HFILE: none */
  30 /* HEADERIZER BEGIN: static */
  31 /* HEADERIZER END: static */
  32
  33 pmclass Undef no_ro {
  34
  35 /*
  36
  37 =item C<void set_pmc(PMC *other)>
  38
  39 Sets the current PMC to C<*other> by first changing the current PMC to the
  40 appropriate type.
  41
  42 =cut
  43
  44 */
  45
  46     VTABLE void set_pmc(PMC *other) {
  47         if (!PObj_is_object_TEST(other)) {
  48             Parrot_pmc_reuse(INTERP, SELF, other->vtable->base_type, 0);
  49             VTABLE_set_pmc(INTERP, SELF, other);
  50         }
  51         else {
  52             PMC * const class_  = PARROT_OBJECT(other)->_class;
  53             PMC        *clone   = VTABLE_clone(INTERP, other);
  54             void       *attrs   = PMC_data(clone);
  55             PMC        *meta    = PMC_metadata(clone);
  56
  57             /* now swap memory without leaking it */
  58             PMC_data(clone)     = PMC_data(SELF);
  59             PMC_data(SELF)      = attrs;
  60             SELF->vtable        = clone->vtable;
  61
  62             /* Restore metadata. */
  63             if (!PMC_IS_NULL(meta)) {
  64                 PMC * const iter = VTABLE_get_iter(INTERP, meta);
  65                 while (VTABLE_get_bool(INTERP, iter)) {
  66                     STRING * const key = VTABLE_shift_string(INTERP, iter);
  67                     PMC * const value  = VTABLE_get_pmc_keyed_str(INTERP, meta, key);
  68                     VTABLE_setprop(INTERP, SELF, key, value);
  69                 }
  70             }
  71             PMC_data(clone) = NULL;
  72
  73             PObj_is_object_SET(SELF);
  74         }
  75     }
  76
  77 /*
  78
  79 =item C<void assign_pmc(PMC *other)>
  80
  81 Assigns the PMC to the value of C<*other> by first changing the PMC to the
  82 appropriate type.
  83
  84 =cut
  85
  86 */
  87
  88     VTABLE void assign_pmc(PMC *other) {
  89         /* don't want to call set_pmc if we're assigning an Undef to an Undef */
  90         if (other->vtable->base_type != enum_class_Undef)
  91             VTABLE_set_pmc(INTERP, SELF, other);
  92     }
  93
  94
  95 /*
  96
  97 =item C<INTVAL get_integer()>
  98
  99 Returns 0.
 100
 101 =cut
 102
 103 */
 104
 105     VTABLE INTVAL get_integer() {
 106         return 0;
 107     }
 108
 109 /*
 110
 111 =item C<INTVAL defined()>
 112
 113 Returns 0.
 114
 115 =cut
 116
 117 */
 118
 119     VTABLE INTVAL defined() {
 120         return 0;
 121     }
 122
 123 /*
 124
 125 =item C<void set_integer_native(INTVAL value)>
 126
 127 Morphs the current PMC to an C<Integer> and sets the value from C<value>.
 128
 129 =cut
 130
 131 */
 132
 133     VTABLE void set_integer_native(INTVAL value) {
 134         Parrot_pmc_reuse(INTERP, SELF, enum_class_Integer, 0);
 135         VTABLE_set_integer_native(INTERP, SELF, value);
 136     }
 137
 138 /*
 139
 140 =item C<FLOATVAL get_number()>
 141
 142 Returns 0.0.
 143
 144 =cut
 145
 146 */
 147
 148     VTABLE FLOATVAL get_number() {
 149         return 0.0;
 150     }
 151
 152 /*
 153
 154 =item C<void set_number_native(FLOATVAL value)>
 155
 156 Morphs the current PMC to a C<Float> and sets the value from C<value>.
 157
 158 =cut
 159
 160 */
 161
 162     VTABLE void set_number_native(FLOATVAL value) {
 163         Parrot_pmc_reuse(INTERP, SELF, enum_class_Float, 0);
 164         VTABLE_set_number_native(INTERP, SELF, value);
 165     }
 166
 167 /*
 168
 169 =item C<STRING *get_string()>
 170
 171 Returns an empty string.
 172
 173 =cut
 174
 175 */
 176
 177     VTABLE STRING *get_string() {
 178         Parrot_warn(INTERP, PARROT_WARNINGS_UNDEF_FLAG,
 179             "Stringifying an Undef PMC");
 180
 181         return CONST_STRING(INTERP, "");
 182     }
 183
 184 /*
 185
 186 =item C<void set_string_native(STRING *value)>
 187
 188 Morphs the current PMC to a C<String> and sets the value from C<value>.
 189
 190 =cut
 191
 192 */
 193
 194     VTABLE void set_string_native(STRING *value) {
 195         Parrot_pmc_reuse(INTERP, SELF, enum_class_String, 0);
 196         VTABLE_set_string_native(INTERP, SELF, value);
 197     }
 198
 199 /*
 200
 201 =item C<INTVAL get_bool()>
 202
 203 Returns 0.
 204
 205 =cut
 206
 207 */
 208
 209     VTABLE INTVAL get_bool() {
 210         return 0;
 211     }
 212
 213 /*
 214
 215 =item C<void share()>
 216
 217 Unknown. (TODO)
 218
 219 =cut
 220
 221 */
 222
 223     VTABLE void share() {
 224         /* see src/pmc/integer.pmc */
 225     }
 226
 227 /*
 228
 229 =item C<PMC *share_ro()>
 230
 231 Unknown. (TODO)
 232
 233 =cut
 234
 235 */
 236
 237     VTABLE PMC *share_ro() {
 238         if (PObj_is_PMC_shared_TEST(SELF))
 239             return SELF;
 240         else
 241             return pt_shared_fixup(INTERP, SELF);
 242     }
 243
 244 /*
 245
 246 =item C<PMC *clone()>
 247
 248 Clones the current Undef PMC.
 249
 250 =cut
 251
 252 */
 253
 254     VTABLE PMC *clone() {
 255         return Parrot_pmc_new(INTERP, SELF->vtable->base_type);
 256     }
 257
 258 /*
 259
 260 =item C<INTVAL is_equal(PMC *value)>
 261
 262 Returns 1 if the C<*value> is an Undef PMC, 0 otherwise.
 263
 264 =cut
 265
 266 */
 267
 268     MULTI INTVAL is_equal(Undef value) {
 269         return 1;
 270     }
 271
 272     MULTI INTVAL is_equal(DEFAULT value) {
 273         return 0;
 274     }
 275 }
 276
 277 /*
 278
 279 =back
 280
 281 =cut
 282
 283 */
 284
 285
 286 /*
 287  * Local variables:
 288  *   c-file-style: "parrot"
 289  * End:
 290  * vim: expandtab shiftwidth=4:
 291  */