src/pmc/lexinfo.pmc

   1 /*
   2 Copyright (C) 2008, The Perl Foundation.
   3 $Id$
   4
   5 =head1 NAME
   6
   7 src/pmc/lexinfo.pmc - LexInfo PMC
   8
   9 =head1 DESCRIPTION
  10
  11 These are the vtable functions for the lexinfo PMC.
  12
  13 =head2 Functions
  14
  15 =over 4
  16
  17 =cut
  18
  19 */
  20
  21 #include "parrot/parrot.h"
  22
  23 /* included manually to prevent breaking C++ builds -- see RT #56534*/
  24 #include "pmc_hash.h"
  25
  26 /*
  27  * LexInfo contains a constant Hash with constant string
  28  * keys and integer indices - no marking and no pmc_ext
  29  * needed (except for freeze/thaw
  30  */
  31
  32 pmclass LexInfo need_ext provides hash no_ro {
  33
  34 /*
  35
  36 =item C<void class_init()>
  37
  38 Manipulate vtable->flags so that constant PMCs are created.
  39 If your inherited LexInfo is not so constant, then don't
  40 do that and provide a mark() method and set the custom_mark flag.
  41
  42 =item C<init_pmc(PMC *sub)>
  43
  44 Initialize the LexInfo PMC and remember the associate
  45 subroutine.
  46
  47 =cut
  48
  49 */
  50
  51     void class_init() {
  52
  53         /* there is no pmclass const_pmc flag yet */
  54         if (pass == 1)
  55             interp->vtables[entry]->flags |= VTABLE_IS_CONST_PMC_FLAG;
  56
  57     }
  58
  59     VTABLE void init() {
  60         real_exception(INTERP, NULL, INVALID_OPERATION,
  61                 "Cannot create a LexInfo PMC without an initializer");
  62     }
  63
  64     VTABLE void init_pmc(PMC *sub) {
  65         PARROT_ASSERT(PObj_constant_TEST(SELF));
  66         PMC_pmc_val(SELF) = sub;
  67
  68         parrot_new_pmc_hash_x(SELF,
  69             (PARROT_DATA_TYPE)enum_hash_int,
  70             Hash_key_type_STRING,
  71             (hash_comp_fn)string_equal,     /* STRING compare */
  72             (hash_hash_key_fn)string_hash); /*        hash    */
  73
  74         PObj_active_destroy_SET(SELF);
  75     }
  76
  77 /*
  78
  79 =item C<void destroy()>
  80
  81 Frees any malloced memory held by this PMC.
  82
  83 =cut
  84
  85 */
  86
  87     void destroy() {
  88         if (PMC_struct_val(SELF))
  89             parrot_hash_destroy(INTERP, (Hash *)PMC_struct_val(SELF));
  90     }
  91
  92 /*
  93
  94 =item C<void declare_lex_preg(STRING *name, INTVAL preg)>
  95
  96 Declare a lexical variable that is an alias for a PMC register.  The PIR
  97 compiler calls this method in response to a ".lex STRING, PREG" directive.
  98
  99 =item C<INTVAL elements()>
 100
 101 Returns the number of elements in the LexInfo hash.
 102
 103 =cut
 104
 105 */
 106
 107     METHOD declare_lex_preg(STRING *name, INTVAL preg) {
 108         parrot_hash_put(INTERP, (Hash*)PMC_struct_val(SELF), name, (void*)preg);
 109     }
 110
 111     VTABLE INTVAL elements() {
 112         return parrot_hash_size(INTERP, (Hash *)PMC_struct_val(SELF));
 113     }
 114
 115 /*
 116
 117 =item C<void visit(visit_info *info)>
 118
 119 =item C<void freeze(visit_info *info)>
 120
 121 =item C<void thaw(visit_info *info)>
 122
 123 Freeze/thaw interface used during freeze/thaw of the Sub PMC.
 124 The implementation of the Hash PMC is called.
 125
 126 =cut
 127
 128 */
 129
 130     VTABLE void visit(visit_info *info) {
 131         Parrot_Hash_visit(INTERP, SELF, info);
 132     }
 133
 134     VTABLE void freeze(visit_info *info) {
 135         Parrot_Hash_freeze(INTERP, SELF, info);
 136     }
 137
 138     VTABLE void thaw(visit_info *info) {
 139         IMAGE_IO * const io = info->image_io;
 140
 141         if (info->extra_flags == EXTRA_IS_NULL) {
 142             const INTVAL elems  = VTABLE_shift_integer(INTERP, io);
 143             const INTVAL k_type = VTABLE_shift_integer(INTERP, io);
 144             const INTVAL v_type = VTABLE_shift_integer(INTERP, io);
 145             Hash        *hash;
 146
 147             UNUSED(k_type);
 148             UNUSED(v_type);
 149
 150             PARROT_ASSERT(v_type == enum_hash_int);
 151             /* TODO make a better interface for hash creation
 152              * TODO create hash with needed types in the first place
 153              */
 154
 155             SELF.init_pmc(NULL);
 156             hash          = (Hash *)PMC_struct_val(SELF);
 157             hash->entries = elems;
 158         }
 159         else {
 160             SUPER(info);
 161         }
 162     }
 163 }
 164
 165
 166 /*
 167
 168 =back
 169
 170 =head1 SEE ALSO
 171
 172 F<docs/pdds/pdd20_lexical_vars.pod>, F<src/classes/lexpad.pmc>.
 173
 174 =cut
 175
 176 */
 177
 178 /*
 179  * Local variables:
 180  *   c-file-style: "parrot"
 181  * End:
 182  * vim: expandtab shiftwidth=4:
 183  */