mop.c

   1 #include "mop.h"
   2
   3 void
   4 mop_call_xs (pTHX_ XSPROTO(subaddr), CV *cv, SV **mark)
   5 {
   6     dSP;
   7     PUSHMARK(mark);
   8     (*subaddr)(aTHX_ cv);
   9     PUTBACK;
  10 }
  11
  12 #if PERL_BCDVERSION >= 0x5010000
  13 UV
  14 mop_check_package_cache_flag (pTHX_ HV *stash)
  15 {
  16     assert(SvTYPE(stash) == SVt_PVHV);
  17
  18     /* here we're trying to implement a c version of mro::get_pkg_gen($stash),
  19      * however the perl core doesn't make it easy for us. It doesn't provide an
  20      * api that just does what we want.
  21      *
  22      * However, we know that the information we want is, inside the core,
  23      * available using HvMROMETA(stash)->pkg_gen. Unfortunately, although the
  24      * HvMROMETA macro is public, it is implemented using Perl_mro_meta_init,
  25      * which is not public and only available inside the core, as the mro
  26      * interface as well as the structure returned by mro_meta_init isn't
  27      * considered to be stable yet.
  28      *
  29      * Perl_mro_meta_init isn't declared static, so we could just define it
  30      * ourselfs if perls headers don't do that for us, except that won't work
  31      * on platforms where symbols need to be explicitly exported when linking
  32      * shared libraries.
  33      *
  34      * So our, hopefully temporary, solution is to be even more evil and
  35      * basically reimplement HvMROMETA in a very fragile way that'll blow up
  36      * when the relevant parts of the mro implementation in core change.
  37      *
  38      * :-(
  39      *
  40      */
  41
  42     return HvAUX(stash)->xhv_mro_meta
  43          ? HvAUX(stash)->xhv_mro_meta->pkg_gen
  44          : 0;
  45 }
  46
  47 #else /* pre 5.10.0 */
  48
  49 UV
  50 mop_check_package_cache_flag (pTHX_ HV *stash)
  51 {
  52     PERL_UNUSED_ARG(stash);
  53     assert(SvTYPE(stash) == SVt_PVHV);
  54
  55     return PL_sub_generation;
  56 }
  57 #endif
  58
  59 SV *
  60 mop_call0 (pTHX_ SV *const self, SV *const method)
  61 {
  62     dSP;
  63     SV *ret;
  64
  65     PUSHMARK(SP);
  66     XPUSHs(self);
  67     PUTBACK;
  68
  69     call_sv(method, G_SCALAR | G_METHOD);
  70
  71     SPAGAIN;
  72     ret = POPs;
  73     PUTBACK;
  74
  75     return ret;
  76 }
  77
  78 int
  79 mop_get_code_info (SV *coderef, char **pkg, char **name)
  80 {
  81     if (!SvOK(coderef) || !SvROK(coderef) || SvTYPE(SvRV(coderef)) != SVt_PVCV) {
  82         return 0;
  83     }
  84
  85     coderef = SvRV(coderef);
  86
  87     /* sub is still being compiled */
  88     if (!CvGV(coderef)) {
  89         return 0;
  90     }
  91
  92     /* I think this only gets triggered with a mangled coderef, but if
  93        we hit it without the guard, we segfault. The slightly odd return
  94        value strikes me as an improvement (mst)
  95     */
  96
  97     if ( isGV_with_GP(CvGV(coderef)) ) {
  98         GV *gv   = CvGV(coderef);
  99         *pkg     = HvNAME( GvSTASH(gv) ? GvSTASH(gv) : CvSTASH(coderef) );
 100         *name    = GvNAME( CvGV(coderef) );
 101     } else {
 102         *pkg     = "__UNKNOWN__";
 103         *name    = "__ANON__";
 104     }
 105
 106     return 1;
 107 }
 108
 109 void
 110 mop_get_package_symbols (HV *stash, type_filter_t filter, get_package_symbols_cb_t cb, void *ud)
 111 {
 112     HE *he;
 113
 114     (void)hv_iterinit(stash);
 115
 116     if (filter == TYPE_FILTER_NONE) {
 117         while ( (he = hv_iternext(stash)) ) {
 118             STRLEN keylen;
 119             const char *key = HePV(he, keylen);
 120             if (!cb(key, keylen, HeVAL(he), ud)) {
 121                 return;
 122             }
 123         }
 124         return;
 125     }
 126
 127     while ( (he = hv_iternext(stash)) ) {
 128         SV *const gv = HeVAL(he);
 129         SV *sv = NULL;
 130         char *key;
 131         STRLEN keylen;
 132         char *package;
 133
 134         switch( SvTYPE(gv) ) {
 135 #ifndef SVt_RV
 136             case SVt_RV:
 137 #endif
 138             case SVt_PV:
 139             case SVt_IV:
 140                 /* expand the gv into a real typeglob if it
 141                  * contains stub functions and we were asked to
 142                  * return CODE symbols */
 143                 if (filter == TYPE_FILTER_CODE) {
 144                     if (SvROK(gv)) {
 145                         SV* fq;
 146                         /* we don't really care about the length,
 147                            but that's the API */
 148                         key = HePV(he, keylen);
 149                         package = HvNAME(stash);
 150                         fq = sv_2mortal(newSVpvf("%s::%s", package, key));
 151                         sv = (SV *)get_cv(SvPV_nolen(fq), 0);
 152                         break;
 153                     }
 154
 155                     key = HePV(he, keylen);
 156                     gv_init((GV *)gv, stash, key, keylen, GV_ADDMULTI);
 157                 }
 158                 /* fall through */
 159             case SVt_PVGV:
 160                 switch (filter) {
 161                     case TYPE_FILTER_CODE:   sv = (SV *)GvCVu(gv); break;
 162                     case TYPE_FILTER_ARRAY:  sv = (SV *)GvAV(gv);  break;
 163                     case TYPE_FILTER_IO:     sv = (SV *)GvIO(gv);  break;
 164                     case TYPE_FILTER_HASH:   sv = (SV *)GvHV(gv);  break;
 165                     case TYPE_FILTER_SCALAR: sv = (SV *)GvSV(gv);  break;
 166                     default:
 167                         croak("Unknown type");
 168                 }
 169                 break;
 170             default:
 171                 continue;
 172         }
 173
 174         if (sv) {
 175             const char *key = HePV(he, keylen);
 176             if (!cb(key, keylen, sv, ud)) {
 177                 return;
 178             }
 179         }
 180     }
 181 }
 182
 183 static bool
 184 collect_all_symbols (const char *key, STRLEN keylen, SV *val, void *ud)
 185 {
 186     HV *hash = (HV *)ud;
 187
 188     if (!hv_store (hash, key, keylen, newRV_inc(val), 0)) {
 189         croak("failed to store symbol ref");
 190     }
 191
 192     return TRUE;
 193 }
 194
 195 HV *
 196 mop_get_all_package_symbols (HV *stash, type_filter_t filter)
 197 {
 198     HV *ret = newHV ();
 199     mop_get_package_symbols (stash, filter, collect_all_symbols, ret);
 200     return ret;
 201 }
 202
 203 static MGVTBL mop_accessor_vtbl; /* the MAGIC identity */
 204
 205 CV*
 206 mop_install_simple_accessor(pTHX_ const char* const fq_name, const char* const key, I32 const keylen, XSPROTO(accessor_impl)){
 207     CV* const xsub  = newXS((char*)fq_name, accessor_impl, __FILE__);
 208     SV* const keysv = newSVpvn_share(key, keylen, 0U);
 209
 210     sv_magicext((SV*)xsub, keysv, PERL_MAGIC_ext, &mop_accessor_vtbl, NULL, 0);
 211     SvREFCNT_dec(keysv); /* sv_magicext() increases refcnt in mg_obj */
 212     return xsub;
 213 }
 214
 215 static MAGIC*
 216 mop_mg_find_by_vtbl(pTHX_ SV* const sv, const MGVTBL* const vtbl){
 217     MAGIC* mg;
 218
 219     assert(sv != NULL);
 220     for(mg = SvMAGIC(sv); mg; mg = mg->mg_moremagic){
 221         if(mg->mg_virtual == vtbl){
 222             break;
 223         }
 224     }
 225     return mg;
 226 }
 227
 228 static SV*
 229 mop_fetch_attr(pTHX_ SV* const self, SV* const key, I32 const create, CV* const cv){
 230     HE* he;
 231     if (!SvROK(self)) {
 232         croak("can't call %s as a class method", GvNAME(CvGV(cv)));
 233     }
 234     if (SvTYPE(SvRV(self)) != SVt_PVHV) {
 235         croak("object is not a hashref");
 236     }
 237     if((he = hv_fetch_ent((HV*)SvRV(self), key, create, 0U))){
 238         return HeVAL(he);
 239     }
 240     return NULL;
 241 }
 242 static SV*
 243 mop_delete_attr(pTHX_ SV* const self, SV* const key, CV* const cv){
 244     SV* sv;
 245     if (!SvROK(self)) {
 246         croak("can't call %s as a class method", GvNAME(CvGV(cv)));
 247     }
 248     if (SvTYPE(SvRV(self)) != SVt_PVHV) {
 249         croak("object is not a hashref");
 250     }
 251     if((sv = hv_delete_ent((HV*)SvRV(self), key, 0, 0U))){
 252         return sv;
 253     }
 254     return NULL;
 255 }
 256
 257 XS(mop_xs_simple_accessor)
 258 {
 259     dVAR; dXSARGS;
 260     MAGIC* const mg = mop_mg_find_by_vtbl(aTHX_ (SV*)cv, &mop_accessor_vtbl);
 261     SV* const key   = mg->mg_obj;
 262     SV* attr;
 263     if(items == 1){ /* reader */
 264         attr = mop_fetch_attr(aTHX_ ST(0), key, FALSE, cv);
 265     }
 266     else if (items == 2){ /* writer */
 267         attr = mop_fetch_attr(aTHX_ ST(0), key, TRUE, cv);
 268         sv_setsv(attr, ST(1));
 269     }
 270     else{
 271         croak("expected exactly one or two argument");
 272     }
 273     ST(0) = attr ? attr : &PL_sv_undef;
 274     XSRETURN(1);
 275 }
 276
 277
 278 XS(mop_xs_simple_reader)
 279 {
 280     dVAR; dXSARGS;
 281     MAGIC* const mg = mop_mg_find_by_vtbl(aTHX_ (SV*)cv, &mop_accessor_vtbl);
 282     SV* const key   = mg->mg_obj;
 283     SV* attr;
 284
 285     if (items != 1) {
 286         croak("expected exactly one argument");
 287     }
 288
 289     attr = mop_fetch_attr(aTHX_ ST(0), key, FALSE, cv);
 290     ST(0) = attr ? attr : &PL_sv_undef;
 291     XSRETURN(1);
 292 }
 293
 294 XS(mop_xs_simple_writer)
 295 {
 296     dVAR; dXSARGS;
 297     MAGIC* const mg = mop_mg_find_by_vtbl(aTHX_ (SV*)cv, &mop_accessor_vtbl);
 298     SV* const key   = mg->mg_obj;
 299     SV* attr;
 300
 301     if (items != 2) {
 302         croak("expected exactly two argument");
 303     }
 304
 305     attr = mop_fetch_attr(aTHX_ ST(0), key, TRUE, cv);
 306     sv_setsv(attr, ST(1));
 307     ST(0) = attr;
 308     XSRETURN(1);
 309 }
 310
 311 XS(mop_xs_simple_clearer)
 312 {
 313     dVAR; dXSARGS;
 314     MAGIC* const mg = mop_mg_find_by_vtbl(aTHX_ (SV*)cv, &mop_accessor_vtbl);
 315     SV* const key   = mg->mg_obj;
 316     SV* attr;
 317
 318     if (items != 1) {
 319         croak("expected exactly one argument");
 320     }
 321
 322     attr = mop_delete_attr(aTHX_ ST(0), key, cv);
 323     ST(0) = attr ? attr : &PL_sv_undef;
 324     XSRETURN(1);
 325 }
 326
 327
 328 XS(mop_xs_simple_predicate)
 329 {
 330     dVAR; dXSARGS;
 331     MAGIC* const mg = mop_mg_find_by_vtbl(aTHX_ (SV*)cv, &mop_accessor_vtbl);
 332     SV* const key   = mg->mg_obj;
 333     SV* attr;
 334
 335     if (items != 1) {
 336         croak("expected exactly one argument");
 337     }
 338
 339     attr = mop_fetch_attr(aTHX_ ST(0), key, FALSE, cv);
 340     ST(0) = boolSV(attr); /* exists */
 341     XSRETURN(1);
 342 }
 343
 344
 345 XS(mop_xs_simple_predicate_for_metaclass)
 346 {
 347     dVAR; dXSARGS;
 348     MAGIC* const mg = mop_mg_find_by_vtbl(aTHX_ (SV*)cv, &mop_accessor_vtbl);
 349     SV* const key   = mg->mg_obj;
 350     SV* attr;
 351
 352     if (items != 1) {
 353         croak("expected exactly one argument");
 354     }
 355
 356     attr = mop_fetch_attr(aTHX_ ST(0), key, FALSE, cv);
 357     ST(0) = boolSV(attr && SvOK(attr)); /* defined */
 358     XSRETURN(1);
 359 }