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