src/pmc/pointer.pmc

   1 /*
   2 Copyright (C) 2001-2007, Parrot Foundation.
   3 $Id$
   4
   5 =head1 NAME
   6
   7 src/pmc/pointer.pmc - Pointer
   8
   9 =head1 DESCRIPTION
  10
  11 These are the vtable functions for the Pointer base class.
  12
  13 The actual pointer is in C<PMC_data>.
  14
  15 =head2 Methods
  16
  17 =over 4
  18
  19 =cut
  20
  21 */
  22
  23 /* HEADERIZER HFILE: none */
  24 /* HEADERIZER BEGIN: static */
  25 /* HEADERIZER END: static */
  26
  27 pmclass Pointer auto_attrs {
  28     ATTR void * mark_function;
  29     ATTR void * pointer;
  30
  31 /*
  32
  33 =item C<void init()>
  34
  35 Initializes the pointer.
  36
  37 =cut
  38
  39 */
  40
  41     VTABLE void init() {
  42         PObj_custom_mark_SET(SELF);
  43     }
  44
  45 /*
  46
  47 =item C<void mark()>
  48
  49 Marks the pointer as live.
  50
  51 =cut
  52
  53 */
  54
  55     VTABLE void mark() {
  56         void (*mark_function)(Interp *, void *) =
  57             (void (*)(Interp *, void *))D2FPTR(PARROT_POINTER(SELF)->mark_function);
  58         void * data = PARROT_POINTER(SELF)->pointer;
  59         if (data && mark_function)
  60             (*mark_function)(INTERP, data);
  61     }
  62
  63 /*
  64
  65 =item C<PMC *clone()>
  66
  67 Creates and returns a clone of the pointer.
  68
  69 =cut
  70
  71 */
  72
  73     VTABLE PMC *clone() {
  74         PMC * const dest = Parrot_pmc_new_noinit(INTERP, SELF->vtable->base_type);
  75         PObj_custom_mark_SET(dest);
  76         PMC_data(dest) = PMC_data(SELF);
  77         return dest;
  78     }
  79
  80 /*
  81
  82 =item C<void set_pointer(void *)>
  83
  84 Sets the pointer value.
  85
  86 =cut
  87
  88 */
  89
  90     VTABLE void set_pointer(void *ptr) {
  91         PARROT_POINTER(SELF)->pointer = ptr;
  92     }
  93
  94 /*
  95
  96 =item C<void *get_pointer()>
  97
  98 Returns the pointer value.
  99
 100 =cut
 101
 102 */
 103
 104     VTABLE void *get_pointer() {
 105         return PARROT_POINTER(SELF)->pointer;
 106     }
 107
 108 /*
 109
 110 =item C<INTVAL get_integer()>
 111
 112 Returns the pointer value as an integer.
 113
 114 =cut
 115
 116 */
 117
 118     VTABLE INTVAL get_integer() {
 119         return (INTVAL)(PARROT_POINTER(SELF)->pointer);
 120     }
 121
 122 /*
 123
 124 =item C<FLOATVAL get_number()>
 125
 126 Returns the pointer value as a floating-point number.
 127
 128 =cut
 129
 130 */
 131
 132     VTABLE FLOATVAL get_number() {
 133         return (FLOATVAL)(INTVAL)(PARROT_POINTER(SELF)->pointer);
 134     }
 135
 136 /*
 137
 138 =item C<STRING *get_repr()>
 139
 140 Returns the pointer value as a Parrot string.
 141
 142 =cut
 143
 144 */
 145
 146     VTABLE STRING *get_repr() {
 147         return Parrot_sprintf_c(INTERP, "Pointer = 0x%p", PARROT_POINTER(SELF)->pointer);
 148     }
 149
 150
 151 /*
 152
 153 =item C<STRING *get_string()>
 154
 155 Returns the pointer value as a Parrot string.
 156
 157 =cut
 158
 159 */
 160
 161     VTABLE STRING *get_string() {
 162         return Parrot_sprintf_c(INTERP, "%s", PARROT_POINTER(SELF)->pointer);
 163     }
 164
 165 /*
 166
 167 =item C<INTVAL get_bool()>
 168
 169 Returns whether the pointer is not C<NULL>.
 170
 171 =cut
 172
 173 */
 174
 175     VTABLE INTVAL get_bool() {
 176         return (INTVAL)(PMC_data(SELF) != NULL);
 177     }
 178
 179 /*
 180
 181 =item C<INTVAL is_same(PMC *pmc2)>
 182
 183 Returns whether the pointer has the same value as C<*pmc2>.
 184
 185 =cut
 186
 187 */
 188
 189     VTABLE INTVAL is_same(PMC *pmc2) {
 190         return (INTVAL)(SELF->vtable   == pmc2->vtable &&
 191                         PARROT_POINTER(SELF)->pointer == PARROT_POINTER(pmc2)->pointer);
 192     }
 193 }
 194
 195 /*
 196
 197 =back
 198
 199 =cut
 200
 201 */
 202
 203 /*
 204  * Local variables:
 205  *   c-file-style: "parrot"
 206  * End:
 207  * vim: expandtab shiftwidth=4:
 208  */