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