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