Declare.xs

   1 #include "EXTERN.h"
   2 #include "perl.h"
   3 #include "XSUB.h"
   4 #include "hook_op_check.h"
   5 #undef printf
   6 #include "stolen_chunk_of_toke.c"
   7 #include <stdio.h>
   8 #include <string.h>
   9
  10 #ifndef Newx
  11 # define Newx(v,n,t) New(0,v,n,t)
  12 #endif /* !Newx */
  13
  14 static int dd_debug = 0;
  15
  16 #define LEX_NORMAL    10
  17 #define LEX_INTERPNORMAL   9
  18
  19 /* flag to trigger removal of temporary declaree sub */
  20
  21 static int in_declare = 0;
  22
  23 /* in 5.10, PL_parser will be NULL if we aren't parsing, and PL_lex_stuff
  24    is a lookup into it - so if anything else we can use to tell, so we
  25    need to be a bit more careful if PL_parser exists */
  26
  27 #define DD_AM_LEXING_CHECK (PL_lex_state == LEX_NORMAL || PL_lex_state == LEX_INTERPNORMAL)
  28
  29 #if defined(PL_parser) || defined(PERL_5_9_PLUS)
  30 #define DD_HAVE_PARSER PL_parser
  31 #define DD_HAVE_LEX_STUFF (PL_parser && PL_lex_stuff)
  32 #define DD_AM_LEXING (PL_parser && DD_AM_LEXING_CHECK)
  33 #else
  34 #define DD_HAVE_PARSER 1
  35 #define DD_HAVE_LEX_STUFF PL_lex_stuff
  36 #define DD_AM_LEXING DD_AM_LEXING_CHECK
  37 #endif
  38
  39 /* thing that decides whether we're dealing with a declarator */
  40
  41 int dd_is_declarator(pTHX_ char* name) {
  42   HV* is_declarator;
  43   SV** is_declarator_pack_ref;
  44   HV* is_declarator_pack_hash;
  45   SV** is_declarator_flag_ref;
  46   int dd_flags;
  47
  48   is_declarator = get_hv("Devel::Declare::declarators", FALSE);
  49
  50   if (!is_declarator)
  51     return -1;
  52
  53   /* $declarators{$current_package_name} */
  54
  55   if (!HvNAME(PL_curstash))
  56     return -1;
  57
  58   is_declarator_pack_ref = hv_fetch(is_declarator, HvNAME(PL_curstash),
  59                              strlen(HvNAME(PL_curstash)), FALSE);
  60
  61   if (!is_declarator_pack_ref || !SvROK(*is_declarator_pack_ref))
  62     return -1; /* not a hashref */
  63
  64   is_declarator_pack_hash = (HV*) SvRV(*is_declarator_pack_ref);
  65
  66   /* $declarators{$current_package_name}{$name} */
  67
  68   is_declarator_flag_ref = hv_fetch(
  69     is_declarator_pack_hash, name,
  70     strlen(name), FALSE
  71   );
  72
  73   /* requires SvIOK as well as TRUE since flags not being an int is useless */
  74
  75   if (!is_declarator_flag_ref
  76         || !SvIOK(*is_declarator_flag_ref)
  77         || !SvTRUE(*is_declarator_flag_ref))
  78     return -1;
  79
  80   dd_flags = SvIVX(*is_declarator_flag_ref);
  81
  82   return dd_flags;
  83 }
  84
  85 /* callback thingy */
  86
  87 void dd_linestr_callback (pTHX_ char* type, char* name) {
  88
  89   char* linestr = SvPVX(PL_linestr);
  90   int offset = PL_bufptr - linestr;
  91
  92   dSP;
  93
  94   ENTER;
  95   SAVETMPS;
  96
  97   PUSHMARK(SP);
  98   XPUSHs(sv_2mortal(newSVpv(type, 0)));
  99   XPUSHs(sv_2mortal(newSVpv(name, 0)));
 100   XPUSHs(sv_2mortal(newSViv(offset)));
 101   PUTBACK;
 102
 103   call_pv("Devel::Declare::linestr_callback", G_VOID|G_DISCARD);
 104
 105   FREETMPS;
 106   LEAVE;
 107 }
 108
 109 char* dd_get_linestr(pTHX) {
 110   if (!DD_HAVE_PARSER) {
 111     return NULL;
 112   }
 113   return SvPVX(PL_linestr);
 114 }
 115
 116 void dd_set_linestr(pTHX_ char* new_value) {
 117   unsigned int new_len = strlen(new_value);
 118
 119   if (SvLEN(PL_linestr) < new_len) {
 120     croak("forced to realloc PL_linestr for line %s, bailing out before we crash harder", SvPVX(PL_linestr));
 121   }
 122
 123   SvGROW(PL_linestr, new_len);
 124
 125   memcpy(SvPVX(PL_linestr), new_value, new_len+1);
 126
 127   SvCUR_set(PL_linestr, new_len);
 128
 129   PL_bufend = SvPVX(PL_linestr) + new_len;
 130 }
 131
 132 char* dd_get_lex_stuff(pTHX) {
 133   return (DD_HAVE_LEX_STUFF ? SvPVX(PL_lex_stuff) : "");
 134 }
 135
 136 void dd_clear_lex_stuff(pTHX) {
 137   if (DD_HAVE_PARSER)
 138     PL_lex_stuff = (SV*)NULL;
 139 }
 140
 141 char* dd_get_curstash_name(pTHX) {
 142   return HvNAME(PL_curstash);
 143 }
 144
 145 int dd_get_linestr_offset(pTHX) {
 146   char* linestr;
 147   if (!DD_HAVE_PARSER) {
 148     return -1;
 149   }
 150   linestr = SvPVX(PL_linestr);
 151   return PL_bufptr - linestr;
 152 }
 153
 154 char* dd_move_past_token (pTHX_ char* s) {
 155
 156   /*
 157    *   buffer will be at the beginning of the declarator, -unless- the
 158    *   declarator is at EOL in which case it'll be the next useful line
 159    *   so we don't short-circuit out if we don't find the declarator
 160    */
 161
 162   while (s < PL_bufend && isSPACE(*s)) s++;
 163   if (memEQ(s, PL_tokenbuf, strlen(PL_tokenbuf)))
 164     s += strlen(PL_tokenbuf);
 165   return s;
 166 }
 167
 168 int dd_toke_move_past_token (pTHX_ int offset) {
 169   char* base_s = SvPVX(PL_linestr) + offset;
 170   char* s = dd_move_past_token(aTHX_ base_s);
 171   return s - base_s;
 172 }
 173
 174 int dd_toke_scan_word(pTHX_ int offset, int handle_package) {
 175   char tmpbuf[sizeof PL_tokenbuf];
 176   char* base_s = SvPVX(PL_linestr) + offset;
 177   STRLEN len;
 178   char* s = scan_word(base_s, tmpbuf, sizeof tmpbuf, handle_package, &len);
 179   return s - base_s;
 180 }
 181
 182 int dd_toke_scan_ident(pTHX_ int offset) {
 183     char tmpbuf[sizeof PL_tokenbuf];
 184     char* base_s = SvPVX(PL_linestr) + offset;
 185     char* s = scan_ident(base_s, PL_bufend, tmpbuf, sizeof tmpbuf, 0);
 186     return s - base_s;
 187 }
 188
 189 int dd_toke_scan_str(pTHX_ int offset) {
 190   STRLEN remaining = sv_len(PL_linestr) - offset;
 191   SV* line_copy = newSVsv(PL_linestr);
 192   char* base_s = SvPVX(PL_linestr) + offset;
 193   char* s = scan_str(base_s, FALSE, FALSE);
 194   if (s != base_s && sv_len(PL_lex_stuff) > remaining) {
 195     int ret = (s - SvPVX(PL_linestr)) + remaining;
 196     sv_catsv(line_copy, PL_linestr);
 197     dd_set_linestr(aTHX_ SvPV_nolen(line_copy));
 198     SvREFCNT_dec(line_copy);
 199     return ret;
 200   }
 201   return s - base_s;
 202 }
 203
 204 int dd_toke_skipspace(pTHX_ int offset) {
 205   char* base_s = SvPVX(PL_linestr) + offset;
 206   char* s = skipspace(base_s);
 207   return s - base_s;
 208 }
 209
 210 /* replacement PL_check rv2cv entry */
 211
 212 STATIC OP *dd_ck_rv2cv(pTHX_ OP *o, void *user_data) {
 213   dSP;
 214   OP* kid;
 215   int dd_flags;
 216
 217   PERL_UNUSED_VAR(user_data);
 218
 219   if (in_declare) {
 220     if (dd_debug) {
 221       printf("Deconstructing declare\n");
 222       printf("PL_bufptr: %s\n", PL_bufptr);
 223       printf("bufend at: %i\n", PL_bufend - PL_bufptr);
 224       printf("linestr: %s\n", SvPVX(PL_linestr));
 225       printf("linestr len: %i\n", PL_bufend - SvPVX(PL_linestr));
 226     }
 227
 228     ENTER;
 229     SAVETMPS;
 230
 231     PUSHMARK(SP);
 232
 233     call_pv("Devel::Declare::done_declare", G_VOID|G_DISCARD);
 234
 235     FREETMPS;
 236     LEAVE;
 237
 238     if (dd_debug) {
 239       printf("PL_bufptr: %s\n", PL_bufptr);
 240       printf("bufend at: %i\n", PL_bufend - PL_bufptr);
 241       printf("linestr: %s\n", SvPVX(PL_linestr));
 242       printf("linestr len: %i\n", PL_bufend - SvPVX(PL_linestr));
 243       printf("actual len: %i\n", strlen(PL_bufptr));
 244     }
 245     return o;
 246   }
 247
 248   kid = cUNOPo->op_first;
 249
 250   if (kid->op_type != OP_GV) /* not a GV so ignore */
 251     return o;
 252
 253   if (!DD_AM_LEXING)
 254     return o; /* not lexing? */
 255
 256   if (dd_debug) {
 257     printf("Checking GV %s -> %s\n", HvNAME(GvSTASH(kGVOP_gv)), GvNAME(kGVOP_gv));
 258   }
 259
 260   dd_flags = dd_is_declarator(aTHX_ GvNAME(kGVOP_gv));
 261
 262   if (dd_flags == -1)
 263     return o;
 264
 265   if (dd_debug) {
 266     printf("dd_flags are: %i\n", dd_flags);
 267     printf("PL_tokenbuf: %s\n", PL_tokenbuf);
 268   }
 269
 270   dd_linestr_callback(aTHX_ "rv2cv", GvNAME(kGVOP_gv));
 271
 272   return o;
 273 }
 274
 275 OP* dd_pp_entereval(pTHX) {
 276   dSP;
 277   STRLEN len;
 278   const char* s;
 279   SV *sv;
 280 #ifdef PERL_5_9_PLUS
 281   SV *saved_hh;
 282   if (PL_op->op_private & OPpEVAL_HAS_HH) {
 283     saved_hh = POPs;
 284   }
 285 #endif
 286   sv = POPs;
 287   if (SvPOK(sv)) {
 288     if (dd_debug) {
 289       printf("mangling eval sv\n");
 290     }
 291     if (SvREADONLY(sv))
 292       sv = sv_2mortal(newSVsv(sv));
 293     s = SvPVX(sv);
 294     len = SvCUR(sv);
 295     if (!len || s[len-1] != ';') {
 296       if (!(SvFLAGS(sv) & SVs_TEMP))
 297         sv = sv_2mortal(newSVsv(sv));
 298       sv_catpvn(sv, "\n;", 2);
 299     }
 300     SvGROW(sv, 8192);
 301   }
 302   PUSHs(sv);
 303 #ifdef PERL_5_9_PLUS
 304   if (PL_op->op_private & OPpEVAL_HAS_HH) {
 305     PUSHs(saved_hh);
 306   }
 307 #endif
 308   return PL_ppaddr[OP_ENTEREVAL](aTHX);
 309 }
 310
 311 STATIC OP *dd_ck_entereval(pTHX_ OP *o, void *user_data) {
 312   PERL_UNUSED_VAR(user_data);
 313
 314   if (o->op_ppaddr == PL_ppaddr[OP_ENTEREVAL])
 315     o->op_ppaddr = dd_pp_entereval;
 316   return o;
 317 }
 318
 319 static I32 dd_filter_realloc(pTHX_ int idx, SV *sv, int maxlen)
 320 {
 321   const I32 count = FILTER_READ(idx+1, sv, maxlen);
 322   SvGROW(sv, 8192); /* please try not to have a line longer than this :) */
 323   /* filter_del(dd_filter_realloc); */
 324   return count;
 325 }
 326
 327 STATIC OP *dd_ck_const(pTHX_ OP *o, void *user_data) {
 328   int dd_flags;
 329   char* name;
 330
 331   PERL_UNUSED_VAR(user_data);
 332
 333   if (DD_HAVE_PARSER && PL_expect == XOPERATOR) {
 334     return o;
 335   }
 336
 337   /* if this is set, we just grabbed a delimited string or something,
 338      not a bareword, so NO TOUCHY */
 339
 340   if (DD_HAVE_LEX_STUFF)
 341     return o;
 342
 343   /* don't try and look this up if it's not a string const */
 344   if (!SvPOK(cSVOPo->op_sv))
 345     return o;
 346
 347   name = SvPVX(cSVOPo->op_sv);
 348
 349   dd_flags = dd_is_declarator(aTHX_ name);
 350
 351   if (dd_flags == -1)
 352     return o;
 353
 354   switch (PL_lex_inwhat) {
 355     case OP_QR:
 356     case OP_MATCH:
 357     case OP_SUBST:
 358     case OP_TRANS:
 359     case OP_BACKTICK:
 360     case OP_STRINGIFY:
 361       return o;
 362       break;
 363     default:
 364       break;
 365   }
 366
 367   dd_linestr_callback(aTHX_ "const", name);
 368
 369   return o;
 370 }
 371
 372 static int initialized = 0;
 373
 374 MODULE = Devel::Declare  PACKAGE = Devel::Declare
 375
 376 PROTOTYPES: DISABLE
 377
 378 void
 379 setup()
 380   CODE:
 381   if (!initialized++) {
 382     hook_op_check(OP_RV2CV, dd_ck_rv2cv, NULL);
 383     hook_op_check(OP_ENTEREVAL, dd_ck_entereval, NULL);
 384     hook_op_check(OP_CONST, dd_ck_const, NULL);
 385   }
 386   filter_add(dd_filter_realloc, NULL);
 387
 388 char*
 389 get_linestr()
 390   CODE:
 391     RETVAL = dd_get_linestr(aTHX);
 392   OUTPUT:
 393     RETVAL
 394
 395 void
 396 set_linestr(char* new_value)
 397   CODE:
 398     dd_set_linestr(aTHX_ new_value);
 399
 400 char*
 401 get_lex_stuff()
 402   CODE:
 403     RETVAL = dd_get_lex_stuff(aTHX);
 404   OUTPUT:
 405     RETVAL
 406
 407 void
 408 clear_lex_stuff()
 409   CODE:
 410     dd_clear_lex_stuff(aTHX);
 411
 412 char*
 413 get_curstash_name()
 414   CODE:
 415     RETVAL = dd_get_curstash_name(aTHX);
 416   OUTPUT:
 417     RETVAL
 418
 419 int
 420 get_linestr_offset()
 421   CODE:
 422     RETVAL = dd_get_linestr_offset(aTHX);
 423   OUTPUT:
 424     RETVAL
 425
 426 int
 427 toke_scan_word(int offset, int handle_package)
 428   CODE:
 429     RETVAL = dd_toke_scan_word(aTHX_ offset, handle_package);
 430   OUTPUT:
 431     RETVAL
 432
 433 int
 434 toke_move_past_token(int offset);
 435   CODE:
 436     RETVAL = dd_toke_move_past_token(aTHX_ offset);
 437   OUTPUT:
 438     RETVAL
 439
 440 int
 441 toke_scan_str(int offset);
 442   CODE:
 443     RETVAL = dd_toke_scan_str(aTHX_ offset);
 444   OUTPUT:
 445     RETVAL
 446
 447 int
 448 toke_scan_ident(int offset)
 449   CODE:
 450     RETVAL = dd_toke_scan_ident(aTHX_ offset);
 451   OUTPUT:
 452     RETVAL
 453
 454 int
 455 toke_skipspace(int offset)
 456   CODE:
 457     RETVAL = dd_toke_skipspace(aTHX_ offset);
 458   OUTPUT:
 459     RETVAL
 460
 461 int
 462 get_in_declare()
 463   CODE:
 464     RETVAL = in_declare;
 465   OUTPUT:
 466     RETVAL
 467
 468 void
 469 set_in_declare(int value)
 470   CODE:
 471     in_declare = value;
 472
 473 BOOT:
 474   if (getenv ("DD_DEBUG")) {
 475     dd_debug = 1;
 476   }