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   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_str(pTHX_ int offset) {
 183   char* base_s = SvPVX(PL_linestr) + offset;
 184   char* s = scan_str(base_s, FALSE, FALSE);
 185   return s - base_s;
 186 }
 187
 188 int dd_toke_skipspace(pTHX_ int offset) {
 189   char* base_s = SvPVX(PL_linestr) + offset;
 190   char* s = skipspace(base_s);
 191   return s - base_s;
 192 }
 193
 194 /* replacement PL_check rv2cv entry */
 195
 196 STATIC OP *dd_ck_rv2cv(pTHX_ OP *o, void *user_data) {
 197   dSP;
 198   OP* kid;
 199   int dd_flags;
 200
 201   if (in_declare) {
 202     if (dd_debug) {
 203       printf("Deconstructing declare\n");
 204       printf("PL_bufptr: %s\n", PL_bufptr);
 205       printf("bufend at: %i\n", PL_bufend - PL_bufptr);
 206       printf("linestr: %s\n", SvPVX(PL_linestr));
 207       printf("linestr len: %i\n", PL_bufend - SvPVX(PL_linestr));
 208     }
 209
 210     ENTER;
 211     SAVETMPS;
 212
 213     PUSHMARK(SP);
 214
 215     call_pv("Devel::Declare::done_declare", G_VOID|G_DISCARD);
 216
 217     FREETMPS;
 218     LEAVE;
 219
 220     if (dd_debug) {
 221       printf("PL_bufptr: %s\n", PL_bufptr);
 222       printf("bufend at: %i\n", PL_bufend - PL_bufptr);
 223       printf("linestr: %s\n", SvPVX(PL_linestr));
 224       printf("linestr len: %i\n", PL_bufend - SvPVX(PL_linestr));
 225       printf("actual len: %i\n", strlen(PL_bufptr));
 226     }
 227     return o;
 228   }
 229
 230   kid = cUNOPo->op_first;
 231
 232   if (kid->op_type != OP_GV) /* not a GV so ignore */
 233     return o;
 234
 235   if (!DD_AM_LEXING)
 236     return o; /* not lexing? */
 237
 238   if (dd_debug) {
 239     printf("Checking GV %s -> %s\n", HvNAME(GvSTASH(kGVOP_gv)), GvNAME(kGVOP_gv));
 240   }
 241
 242   dd_flags = dd_is_declarator(aTHX_ GvNAME(kGVOP_gv));
 243
 244   if (dd_flags == -1)
 245     return o;
 246
 247   if (dd_debug) {
 248     printf("dd_flags are: %i\n", dd_flags);
 249     printf("PL_tokenbuf: %s\n", PL_tokenbuf);
 250   }
 251
 252   dd_linestr_callback(aTHX_ "rv2cv", GvNAME(kGVOP_gv));
 253
 254   return o;
 255 }
 256
 257 OP* dd_pp_entereval(pTHX) {
 258   dSP;
 259   dPOPss;
 260   STRLEN len;
 261   const char* s;
 262   if (SvPOK(sv)) {
 263     if (dd_debug) {
 264       printf("mangling eval sv\n");
 265     }
 266     if (SvREADONLY(sv))
 267       sv = sv_2mortal(newSVsv(sv));
 268     s = SvPVX(sv);
 269     len = SvCUR(sv);
 270     if (!len || s[len-1] != ';') {
 271       if (!(SvFLAGS(sv) & SVs_TEMP))
 272         sv = sv_2mortal(newSVsv(sv));
 273       sv_catpvn(sv, "\n;", 2);
 274     }
 275     SvGROW(sv, 8192);
 276   }
 277   PUSHs(sv);
 278   return PL_ppaddr[OP_ENTEREVAL](aTHX);
 279 }
 280
 281 STATIC OP *dd_ck_entereval(pTHX_ OP *o, void *user_data) {
 282   if (o->op_ppaddr == PL_ppaddr[OP_ENTEREVAL])
 283     o->op_ppaddr = dd_pp_entereval;
 284   return o;
 285 }
 286
 287 static I32 dd_filter_realloc(pTHX_ int idx, SV *sv, int maxlen)
 288 {
 289   const I32 count = FILTER_READ(idx+1, sv, maxlen);
 290   SvGROW(sv, 8192); /* please try not to have a line longer than this :) */
 291   /* filter_del(dd_filter_realloc); */
 292   return count;
 293 }
 294
 295 STATIC OP *dd_ck_const(pTHX_ OP *o, void *user_data) {
 296   int dd_flags;
 297   char* name;
 298
 299   /* if this is set, we just grabbed a delimited string or something,
 300      not a bareword, so NO TOUCHY */
 301
 302   if (DD_HAVE_LEX_STUFF)
 303     return o;
 304
 305   /* don't try and look this up if it's not a string const */
 306   if (!SvPOK(cSVOPo->op_sv))
 307     return o;
 308
 309   name = SvPVX(cSVOPo->op_sv);
 310
 311   dd_flags = dd_is_declarator(aTHX_ name);
 312
 313   if (dd_flags == -1)
 314     return o;
 315
 316   dd_linestr_callback(aTHX_ "const", name);
 317
 318   return o;
 319 }
 320
 321 static int initialized = 0;
 322
 323 MODULE = Devel::Declare  PACKAGE = Devel::Declare
 324
 325 PROTOTYPES: DISABLE
 326
 327 void
 328 setup()
 329   CODE:
 330   if (!initialized++) {
 331     hook_op_check(OP_RV2CV, dd_ck_rv2cv, NULL);
 332     hook_op_check(OP_ENTEREVAL, dd_ck_entereval, NULL);
 333     hook_op_check(OP_CONST, dd_ck_const, NULL);
 334   }
 335   filter_add(dd_filter_realloc, NULL);
 336
 337 char*
 338 get_linestr()
 339   CODE:
 340     RETVAL = dd_get_linestr(aTHX);
 341   OUTPUT:
 342     RETVAL
 343
 344 void
 345 set_linestr(char* new_value)
 346   CODE:
 347     dd_set_linestr(aTHX_ new_value);
 348
 349 char*
 350 get_lex_stuff()
 351   CODE:
 352     RETVAL = dd_get_lex_stuff(aTHX);
 353   OUTPUT:
 354     RETVAL
 355
 356 void
 357 clear_lex_stuff()
 358   CODE:
 359     dd_clear_lex_stuff(aTHX);
 360
 361 char*
 362 get_curstash_name()
 363   CODE:
 364     RETVAL = dd_get_curstash_name(aTHX);
 365   OUTPUT:
 366     RETVAL
 367
 368 int
 369 get_linestr_offset()
 370   CODE:
 371     RETVAL = dd_get_linestr_offset(aTHX);
 372   OUTPUT:
 373     RETVAL
 374
 375 int
 376 toke_scan_word(int offset, int handle_package)
 377   CODE:
 378     RETVAL = dd_toke_scan_word(aTHX_ offset, handle_package);
 379   OUTPUT:
 380     RETVAL
 381
 382 int
 383 toke_move_past_token(int offset);
 384   CODE:
 385     RETVAL = dd_toke_move_past_token(aTHX_ offset);
 386   OUTPUT:
 387     RETVAL
 388
 389 int
 390 toke_scan_str(int offset);
 391   CODE:
 392     RETVAL = dd_toke_scan_str(aTHX_ offset);
 393   OUTPUT:
 394     RETVAL
 395
 396 int
 397 toke_skipspace(int offset)
 398   CODE:
 399     RETVAL = dd_toke_skipspace(aTHX_ offset);
 400   OUTPUT:
 401     RETVAL
 402
 403 int
 404 get_in_declare()
 405   CODE:
 406     RETVAL = in_declare;
 407   OUTPUT:
 408     RETVAL
 409
 410 void
 411 set_in_declare(int value)
 412   CODE:
 413     in_declare = value;
 414
 415 BOOT:
 416   if (getenv ("DD_DEBUG")) {
 417     dd_debug = 1;
 418   }