src/pmc/packfileannotation.pmc

   1 /*
   2 Copyright (C) 2001-2008, Parrot Foundation.
   3 $Id$
   4
   5 =head1 NAME
   6
   7 src/pmc/packfileannotation.pmc - PackfileAnnotation PMC
   8
   9 =head1 DESCRIPTION
  10
  11 This class implements a PackfileAnnotation object.  It is an element in the
  12 PackfileAnnotations segment of the .pbc file.  See PDD13 for a design spec.
  13
  14 =head2 Methods
  15
  16 =over 4
  17
  18 =cut
  19
  20 */
  21
  22 pmclass PackfileAnnotation auto_attrs {
  23     ATTR STRING    *name;
  24     ATTR INTVAL     offset;
  25     ATTR INTVAL     value_type;
  26     /* This 3 attributes should be in single union. But Pmc2c isn't smart enough to handle it */
  27     ATTR INTVAL     int_value;
  28     ATTR FLOATVAL   num_value;
  29     ATTR STRING    *str_value;
  30
  31 /*
  32
  33 =item C<init>
  34
  35 Create empty PackfileAnnotation.
  36
  37 =cut
  38
  39 */
  40
  41     VTABLE void init() {
  42         Parrot_PackfileAnnotation_attributes * attrs =
  43                 PMC_data_typed(SELF, Parrot_PackfileAnnotation_attributes*);
  44
  45         PObj_custom_mark_SET(SELF);
  46         PMC_data(SELF) = attrs;
  47     }
  48
  49 /*
  50
  51 =item C<void mark()>
  52
  53 Marks the object as live.
  54
  55 =cut
  56
  57 */
  58
  59     VTABLE void mark() {
  60         Parrot_PackfileAnnotation_attributes * attrs =
  61                 PARROT_PACKFILEANNOTATION(SELF);
  62
  63         Parrot_gc_mark_STRING_alive(interp, attrs->name);
  64         Parrot_gc_mark_STRING_alive(interp, attrs->str_value);
  65     }
  66
  67
  68 /*
  69
  70 =item C<INTVAL get_offset()>
  71
  72 Fetch the offset into the bytecode of the instruction that is being annotated.
  73
  74 =cut
  75
  76 */
  77     METHOD get_offset() {
  78         INTVAL offset = PARROT_PACKFILEANNOTATION(SELF)->offset;
  79         RETURN(INTVAL offset);
  80     }
  81
  82
  83 /*
  84
  85 =item C<void set_offset(INTVAL offset)>
  86
  87 Set the offset into the bytecode of the instruction that is being annotated.
  88
  89 =cut
  90
  91 */
  92     METHOD set_offset(INTVAL offset) {
  93         PARROT_PACKFILEANNOTATION(SELF)->offset = offset;
  94     }
  95
  96
  97 /*
  98
  99 =item C<STRING* get_name()>
 100
 101 Fetch the name of the annotation.
 102
 103 =cut
 104
 105 */
 106     METHOD get_name() {
 107         STRING * name = PARROT_PACKFILEANNOTATION(SELF)->name;
 108         RETURN(STRING * name);
 109     }
 110
 111
 112 /*
 113
 114 =item C<void set_name(STRING* name)>
 115
 116 Set the name of the annotation.
 117
 118 =cut
 119
 120 */
 121     METHOD set_name(STRING * name) {
 122         PARROT_PACKFILEANNOTATION(SELF)->name = name;
 123     }
 124
 125
 126 /*
 127
 128 =item C<INTVAL get_integer()>
 129
 130 Fetch the integer value of the annotation.
 131
 132 =cut
 133
 134 */
 135     VTABLE INTVAL get_integer() {
 136         Parrot_PackfileAnnotation_attributes * attrs = PARROT_PACKFILEANNOTATION(SELF);
 137         if (attrs->value_type != PF_ANNOTATION_KEY_TYPE_INT)
 138             Parrot_ex_throw_from_c_args(interp, NULL, EXCEPTION_INVALID_OPERATION,
 139                 "Trying to fetch wrong type of value from annotation");
 140         return attrs->int_value;
 141     }
 142
 143
 144 /*
 145
 146 =item C<void set_integer_native(INTVAL value)>
 147
 148 Set the integer value of the annotation.
 149
 150 =cut
 151
 152 */
 153     VTABLE void set_integer_native(INTVAL value) {
 154         Parrot_PackfileAnnotation_attributes * attrs = PARROT_PACKFILEANNOTATION(SELF);
 155         attrs->value_type = PF_ANNOTATION_KEY_TYPE_INT;
 156         attrs->int_value  = value;
 157     }
 158
 159 /*
 160
 161 =item C<STRING * get_string()>
 162
 163 Fetch the string value of the annotation.
 164
 165 =cut
 166
 167 */
 168     VTABLE STRING * get_string() {
 169         Parrot_PackfileAnnotation_attributes * attrs = PARROT_PACKFILEANNOTATION(SELF);
 170         if (attrs->value_type != PF_ANNOTATION_KEY_TYPE_STR)
 171             Parrot_ex_throw_from_c_args(interp, NULL, EXCEPTION_INVALID_OPERATION,
 172                 "Trying to fetch wrong type of value from annotation");
 173         return attrs->str_value;
 174     }
 175
 176
 177 /*
 178
 179 =item C<void set_string_native(STRING * value)>
 180
 181 Set the string value of the annotation.
 182
 183 =cut
 184
 185 */
 186     VTABLE void set_string_native(STRING * value) {
 187         Parrot_PackfileAnnotation_attributes * attrs = PARROT_PACKFILEANNOTATION(SELF);
 188         attrs->value_type = PF_ANNOTATION_KEY_TYPE_STR;
 189         attrs->str_value  = value;
 190     }
 191
 192 /*
 193
 194 =item C<INTVAL get_number()>
 195
 196 Fetch the float value of the annotation.
 197
 198 =cut
 199
 200 */
 201     VTABLE FLOATVAL get_number() {
 202         Parrot_PackfileAnnotation_attributes * attrs = PARROT_PACKFILEANNOTATION(SELF);
 203         if (attrs->value_type != PF_ANNOTATION_KEY_TYPE_NUM)
 204             Parrot_ex_throw_from_c_args(interp, NULL, EXCEPTION_INVALID_OPERATION,
 205                 "Trying to fetch wrong type of value from annotation");
 206         return attrs->num_value;
 207     }
 208
 209
 210 /*
 211
 212 =item C<void set_number_native(INTVAL value)>
 213
 214 Set the float value of the annotation.
 215
 216 =cut
 217
 218 */
 219     VTABLE void set_number_native(FLOATVAL value) {
 220         Parrot_PackfileAnnotation_attributes * attrs = PARROT_PACKFILEANNOTATION(SELF);
 221         attrs->value_type = PF_ANNOTATION_KEY_TYPE_NUM;
 222         attrs->num_value  = value;
 223     }
 224
 225 }
 226 /*
 227
 228 =back
 229
 230 =cut
 231
 232 */
 233
 234 /*
 235  * Local variables:
 236  *   c-file-style: "parrot"
 237  * End:
 238  * vim: expandtab shiftwidth=4:
 239  */