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