src/pmc/addrregistry.pmc

   1 /*
   2 Copyright (C) 2005-2009, Parrot Foundation.
   3 $Id$
   4
   5 =head1 NAME
   6
   7 src/pmc/addrregistry.pmc - A GC Registry PMC
   8
   9 =head1 DESCRIPTION
  10
  11 The AddrRegistry class provides the equivalence of reference counts
  12 mainly for extenders and embedders of Parrot. The hash keys are the
  13 addresses of the key PMC, values are reference counts, i.e. the
  14 difference of (set_pmc_keyed - delete_pmc_keyed). If the reference
  15 goes to zero, the entry is deleted physically.
  16
  17 Please note that you have to anchor an instance of AddrRegistry yourself with
  18 C<Parrot_register_pmc> if it isn't visible to Parrot.
  19
  20 =head2 Functions
  21
  22 =over 4
  23
  24 =cut
  25
  26 */
  27
  28 /* included manually to prevent breaking C++ builds -- see RT #56534 */
  29 #include "parrot/hash.h"
  30 #include "pmc_hash.h"
  31
  32 pmclass AddrRegistry extends Hash provides hash auto_attrs {
  33 /*
  34
  35 =item C<void init()>
  36
  37 Initializes the instance.
  38
  39 =cut
  40
  41 */
  42
  43     VTABLE void init() {
  44         Hash  *registry = parrot_create_hash(INTERP,
  45                 enum_type_int,
  46                 Hash_key_type_PMC,
  47                 int_compare,
  48                 key_hash_int);
  49
  50         Parrot_AddrRegistry_attributes *attrs =
  51             (Parrot_AddrRegistry_attributes *) PMC_data(SELF);
  52
  53         SELF.set_pointer(registry);
  54         PObj_custom_mark_destroy_SETALL(SELF);
  55
  56     }
  57
  58 /*
  59
  60 =item C<INTVAL get_integer_keyed(PMC *key)>
  61
  62 Returns the reference count for C<key> or 0 if the key doesn't exist.
  63
  64 =item C<INTVAL elements()>
  65
  66 Returns the number of elements in the hash.
  67
  68 =item C<INTVAL get_bool()>
  69
  70 Returns true if the hash size is not zero.
  71
  72 =cut
  73
  74 */
  75
  76     VTABLE INTVAL get_integer_keyed(PMC *key) {
  77         Hash   *hash  = (Hash *)SELF.get_pointer();
  78         void   *value = parrot_hash_get(INTERP, hash, key);
  79
  80         if (value)
  81             return (INTVAL)value;
  82
  83         return 0;
  84     }
  85
  86     VTABLE INTVAL elements() {
  87         return parrot_hash_size(INTERP, (Hash *)SELF.get_pointer());
  88     }
  89
  90     VTABLE INTVAL get_bool() {
  91         return parrot_hash_size(INTERP, (Hash *)SELF.get_pointer()) != 0;
  92     }
  93 /*
  94
  95 =item C<void set_pmc_keyed(PMC *key, PMC *value)>
  96
  97 Increment the reference count of C<key>. If the entry doesn't exist
  98 create it. The C<value> is always ignored.
  99
 100 =item C<void set_integer_keyed(PMC *key, INTVAL value)>
 101
 102 Set the given value.
 103
 104 =item C<void delete_keyed(PMC *key)>
 105
 106 Decrement the reference count of C<key>. If the reference count
 107 reaches 0, delete the entry.
 108
 109
 110 =cut
 111
 112 */
 113
 114     VTABLE void set_pmc_keyed(PMC *key, PMC *value) {
 115         Hash       * const hash = (Hash *)SELF.get_pointer();
 116         void       *oldval      = parrot_hash_get(INTERP, hash, key);
 117         long        newval      = 1;
 118         UNUSED(value);
 119
 120         if (oldval)
 121             newval += (long)oldval;
 122
 123         parrot_hash_put(INTERP, hash, key, (void *)newval);
 124     }
 125
 126     VTABLE void set_integer_keyed(PMC *key, INTVAL value) {
 127         Hash *hash = (Hash *)SELF.get_pointer();
 128         parrot_hash_put(INTERP, hash, key, (void *)value);
 129     }
 130
 131     VTABLE void delete_keyed(PMC *key) {
 132         Hash       * const hash  = (Hash *)SELF.get_pointer();
 133         void              *value = parrot_hash_get(INTERP, hash, key);
 134
 135         /* these casts look bad, but they avoid type punning warnings with -O */
 136         if (value) {
 137             long val = (long)value;
 138             if (val == 1L)
 139                 parrot_hash_delete(INTERP, hash, key);
 140             else {
 141                 value = (void *)(--val);
 142                 parrot_hash_put(INTERP, hash, key, value);
 143             }
 144         }
 145     }
 146
 147 }
 148
 149 /*
 150
 151 =back
 152
 153 =head1 SEE ALSO
 154
 155 F<src/pmc.c:gc_register_pmc()>
 156
 157 =cut
 158
 159 */
 160
 161 /*
 162  * Local variables:
 163  *   c-file-style: "parrot"
 164  * End:
 165  * vim: expandtab shiftwidth=4:
 166  */