Declare.xs

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