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