src/pmc/packfileannotation.pmc

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