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