Declare.xs

   1 #define PERL_CORE
   2 #define PERL_NO_GET_CONTEXT
   3 #include "EXTERN.h"
   4 #include "perl.h"
   5 #include "XSUB.h"
   6 #include "hook_op_check.h"
   7 #undef printf
   8 #include "stolen_chunk_of_toke.c"
   9 #include <stdio.h>
  10 #include <string.h>
  11
  12 #ifndef Newx
  13 # define Newx(v,n,t) New(0,v,n,t)
  14 #endif /* !Newx */
  15
  16 #if 0
  17 #define DD_DEBUG
  18 #endif
  19
  20 #ifdef DD_DEBUG
  21 #define DD_DEBUG_S printf("Buffer: %s\n", s);
  22 #else
  23 #define DD_DEBUG_S
  24 #endif
  25
  26 #define LEX_NORMAL    10
  27 #define LEX_INTERPNORMAL   9
  28
  29 /* flag to trigger removal of temporary declaree sub */
  30
  31 static int in_declare = 0;
  32
  33 /* in 5.10, PL_parser will be NULL if we aren't parsing, and PL_lex_stuff
  34    is a lookup into it - so if anything else we can use to tell, so we
  35    need to be a bit more careful if PL_parser exists */
  36
  37 #define DD_AM_LEXING_CHECK (PL_lex_state == LEX_NORMAL || PL_lex_state == LEX_INTERPNORMAL)
  38
  39 #ifdef PL_parser
  40 #define DD_HAVE_PARSER PL_parser
  41 #define DD_HAVE_LEX_STUFF (PL_parser && PL_lex_stuff)
  42 #define DD_AM_LEXING (PL_parser && DD_AM_LEXING_CHECK)
  43 #else
  44 #define DD_HAVE_PARSER 1
  45 #define DD_HAVE_LEX_STUFF PL_lex_stuff
  46 #define DD_AM_LEXING DD_AM_LEXING_CHECK
  47 #endif
  48
  49 /* thing that decides whether we're dealing with a declarator */
  50
  51 int dd_is_declarator(pTHX_ char* name) {
  52   HV* is_declarator;
  53   SV** is_declarator_pack_ref;
  54   HV* is_declarator_pack_hash;
  55   SV** is_declarator_flag_ref;
  56   int dd_flags;
  57
  58   is_declarator = get_hv("Devel::Declare::declarators", FALSE);
  59
  60   if (!is_declarator)
  61     return -1;
  62
  63   /* $declarators{$current_package_name} */
  64
  65   is_declarator_pack_ref = hv_fetch(is_declarator, HvNAME(PL_curstash),
  66                              strlen(HvNAME(PL_curstash)), FALSE);
  67
  68   if (!is_declarator_pack_ref || !SvROK(*is_declarator_pack_ref))
  69     return -1; /* not a hashref */
  70
  71   is_declarator_pack_hash = (HV*) SvRV(*is_declarator_pack_ref);
  72
  73   /* $declarators{$current_package_name}{$name} */
  74
  75   is_declarator_flag_ref = hv_fetch(
  76     is_declarator_pack_hash, name,
  77     strlen(name), FALSE
  78   );
  79
  80   /* requires SvIOK as well as TRUE since flags not being an int is useless */
  81
  82   if (!is_declarator_flag_ref
  83         || !SvIOK(*is_declarator_flag_ref)
  84         || !SvTRUE(*is_declarator_flag_ref))
  85     return -1;
  86
  87   dd_flags = SvIVX(*is_declarator_flag_ref);
  88
  89   return dd_flags;
  90 }
  91
  92 /* callback thingy */
  93
  94 void dd_linestr_callback (pTHX_ char* type, char* name) {
  95
  96   char* linestr = SvPVX(PL_linestr);
  97   int offset = PL_bufptr - linestr;
  98
  99   dSP;
 100
 101   ENTER;
 102   SAVETMPS;
 103
 104   PUSHMARK(SP);
 105   XPUSHs(sv_2mortal(newSVpv(type, 0)));
 106   XPUSHs(sv_2mortal(newSVpv(name, 0)));
 107   XPUSHs(sv_2mortal(newSViv(offset)));
 108   PUTBACK;
 109
 110   call_pv("Devel::Declare::linestr_callback", G_VOID|G_DISCARD);
 111
 112   FREETMPS;
 113   LEAVE;
 114 }
 115
 116 char* dd_get_linestr(pTHX) {
 117   return SvPVX(PL_linestr);
 118 }
 119
 120 void dd_set_linestr(pTHX_ char* new_value) {
 121   int new_len = strlen(new_value);
 122   char* old_linestr = SvPVX(PL_linestr);
 123
 124   SvGROW(PL_linestr, strlen(new_value));
 125
 126   if (SvPVX(PL_linestr) != old_linestr)
 127     Perl_croak(aTHX_ "forced to realloc PL_linestr for line %s, bailing out before we crash harder", SvPVX(PL_linestr));
 128
 129   memcpy(SvPVX(PL_linestr), new_value, new_len+1);
 130
 131   SvCUR_set(PL_linestr, new_len);
 132
 133   PL_bufend = SvPVX(PL_linestr) + new_len;
 134 }
 135
 136 char* dd_get_lex_stuff(pTHX) {
 137   return (DD_HAVE_LEX_STUFF ? SvPVX(PL_lex_stuff) : "");
 138 }
 139
 140 char* dd_clear_lex_stuff(pTHX) {
 141   if (DD_HAVE_PARSER)
 142     PL_lex_stuff = Nullsv;
 143 }
 144
 145 char* dd_get_curstash_name(pTHX) {
 146   return HvNAME(PL_curstash);
 147 }
 148
 149 int dd_get_linestr_offset(pTHX) {
 150   char* 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) {
 197   OP* kid;
 198   int dd_flags;
 199   char* cb_args[6];
 200
 201   if (in_declare) {
 202     cb_args[0] = NULL;
 203 #ifdef DD_DEBUG
 204     printf("Deconstructing declare\n");
 205     printf("PL_bufptr: %s\n", PL_bufptr);
 206     printf("bufend at: %i\n", PL_bufend - PL_bufptr);
 207     printf("linestr: %s\n", SvPVX(PL_linestr));
 208     printf("linestr len: %i\n", PL_bufend - SvPVX(PL_linestr));
 209 #endif
 210     call_argv("Devel::Declare::done_declare", G_VOID|G_DISCARD, cb_args);
 211 #ifdef DD_DEBUG
 212     printf("PL_bufptr: %s\n", PL_bufptr);
 213     printf("bufend at: %i\n", PL_bufend - PL_bufptr);
 214     printf("linestr: %s\n", SvPVX(PL_linestr));
 215     printf("linestr len: %i\n", PL_bufend - SvPVX(PL_linestr));
 216     printf("actual len: %i\n", strlen(PL_bufptr));
 217 #endif
 218     return o;
 219   }
 220
 221   kid = cUNOPo->op_first;
 222
 223   if (kid->op_type != OP_GV) /* not a GV so ignore */
 224     return o;
 225
 226   if (!DD_AM_LEXING)
 227     return o; /* not lexing? */
 228
 229 #ifdef DD_DEBUG
 230   printf("Checking GV %s -> %s\n", HvNAME(GvSTASH(kGVOP_gv)), GvNAME(kGVOP_gv));
 231 #endif
 232
 233   dd_flags = dd_is_declarator(aTHX_ GvNAME(kGVOP_gv));
 234
 235   if (dd_flags == -1)
 236     return o;
 237
 238 #ifdef DD_DEBUG
 239   printf("dd_flags are: %i\n", dd_flags);
 240 #endif
 241
 242 #ifdef DD_DEBUG
 243   printf("PL_tokenbuf: %s\n", PL_tokenbuf);
 244 #endif
 245
 246   dd_linestr_callback(aTHX_ "rv2cv", GvNAME(kGVOP_gv));
 247
 248   return o;
 249 }
 250
 251 OP* dd_pp_entereval(pTHX) {
 252   dSP;
 253   dPOPss;
 254   STRLEN len;
 255   const char* s;
 256   if (SvPOK(sv)) {
 257 #ifdef DD_DEBUG
 258     printf("mangling eval sv\n");
 259 #endif
 260     if (SvREADONLY(sv))
 261       sv = sv_2mortal(newSVsv(sv));
 262     s = SvPVX(sv);
 263     len = SvCUR(sv);
 264     if (!len || s[len-1] != ';') {
 265       if (!(SvFLAGS(sv) & SVs_TEMP))
 266         sv = sv_2mortal(newSVsv(sv));
 267       sv_catpvn(sv, "\n;", 2);
 268     }
 269     SvGROW(sv, 8192);
 270   }
 271   PUSHs(sv);
 272   return PL_ppaddr[OP_ENTEREVAL](aTHX);
 273 }
 274
 275 STATIC OP *dd_ck_entereval(pTHX_ OP *o) {
 276   if (o->op_ppaddr == PL_ppaddr[OP_ENTEREVAL])
 277     o->op_ppaddr = dd_pp_entereval;
 278   return o;
 279 }
 280
 281 static I32 dd_filter_realloc(pTHX_ int idx, SV *sv, int maxlen)
 282 {
 283   const I32 count = FILTER_READ(idx+1, sv, maxlen);
 284   SvGROW(sv, 8192); /* please try not to have a line longer than this :) */
 285   /* filter_del(dd_filter_realloc); */
 286   return count;
 287 }
 288
 289 STATIC OP *dd_ck_const(pTHX_ OP *o) {
 290   int dd_flags;
 291   char* s;
 292   char* name;
 293
 294   /* if this is set, we just grabbed a delimited string or something,
 295      not a bareword, so NO TOUCHY */
 296
 297   if (DD_HAVE_LEX_STUFF)
 298     return o;
 299
 300   /* don't try and look this up if it's not a string const */
 301   if (!SvPOK(cSVOPo->op_sv))
 302     return o;
 303
 304   name = SvPVX(cSVOPo->op_sv);
 305
 306   dd_flags = dd_is_declarator(aTHX_ name);
 307
 308   if (dd_flags == -1)
 309     return o;
 310
 311   dd_linestr_callback(aTHX_ "const", name);
 312
 313   return o;
 314 }
 315
 316 static int initialized = 0;
 317
 318 MODULE = Devel::Declare  PACKAGE = Devel::Declare
 319
 320 PROTOTYPES: DISABLE
 321
 322 void
 323 setup()
 324   CODE:
 325   if (!initialized++) {
 326     hook_op_check(OP_RV2CV, dd_ck_rv2cv);
 327     hook_op_check(OP_ENTEREVAL, dd_ck_entereval);
 328     hook_op_check(OP_CONST, dd_ck_const);
 329   }
 330   filter_add(dd_filter_realloc, NULL);
 331
 332 char*
 333 get_linestr()
 334   CODE:
 335     RETVAL = dd_get_linestr(aTHX);
 336   OUTPUT:
 337     RETVAL
 338
 339 void
 340 set_linestr(char* new_value)
 341   CODE:
 342     dd_set_linestr(aTHX_ new_value);
 343
 344 char*
 345 get_lex_stuff()
 346   CODE:
 347     RETVAL = dd_get_lex_stuff(aTHX);
 348   OUTPUT:
 349     RETVAL
 350
 351 void
 352 clear_lex_stuff()
 353   CODE:
 354     dd_clear_lex_stuff(aTHX);
 355
 356 char*
 357 get_curstash_name()
 358   CODE:
 359     RETVAL = dd_get_curstash_name(aTHX);
 360   OUTPUT:
 361     RETVAL
 362
 363 int
 364 get_linestr_offset()
 365   CODE:
 366     RETVAL = dd_get_linestr_offset(aTHX);
 367   OUTPUT:
 368     RETVAL
 369
 370 int
 371 toke_scan_word(int offset, int handle_package)
 372   CODE:
 373     RETVAL = dd_toke_scan_word(aTHX_ offset, handle_package);
 374   OUTPUT:
 375     RETVAL
 376
 377 int
 378 toke_move_past_token(int offset);
 379   CODE:
 380     RETVAL = dd_toke_move_past_token(aTHX_ offset);
 381   OUTPUT:
 382     RETVAL
 383
 384 int
 385 toke_scan_str(int offset);
 386   CODE:
 387     RETVAL = dd_toke_scan_str(aTHX_ offset);
 388   OUTPUT:
 389     RETVAL
 390
 391 int
 392 toke_skipspace(int offset)
 393   CODE:
 394     RETVAL = dd_toke_skipspace(aTHX_ offset);
 395   OUTPUT:
 396     RETVAL
 397
 398 int
 399 get_in_declare()
 400   CODE:
 401     RETVAL = in_declare;
 402   OUTPUT:
 403     RETVAL
 404
 405 void
 406 set_in_declare(int value)
 407   CODE:
 408     in_declare = value;