]> git.vpit.fr Git - perl/modules/Scope-Upper.git/blob - Upper.xs
8814d9dd831bba9384865f2a38f35ca045cf8ea9
[perl/modules/Scope-Upper.git] / Upper.xs
1 /* This file is part of the Scope::Upper Perl module.
2  * See http://search.cpan.org/dist/Scope-Upper/ */
3
4 #define PERL_NO_GET_CONTEXT
5 #include "EXTERN.h"
6 #include "perl.h" 
7 #include "XSUB.h"
8
9 #ifndef SU_DEBUG
10 # define SU_DEBUG 0
11 #endif
12
13 /* --- Compatibility ------------------------------------------------------- */
14
15 #ifndef STMT_START
16 # define STMT_START do
17 #endif
18
19 #ifndef STMT_END
20 # define STMT_END while (0)
21 #endif
22
23 #if SU_DEBUG
24 # define SU_D(X) STMT_START X STMT_END
25 #else
26 # define SU_D(X)
27 #endif
28
29 #ifndef Newx
30 # define Newx(v, n, c) New(0, v, n, c)
31 #endif
32
33 #ifndef SvPV_const
34 # define SvPV_const(S, L) SvPV(S, L)
35 #endif
36
37 #ifndef SvPV_nolen_const
38 # define SvPV_nolen_const(S) SvPV_nolen(S)
39 #endif
40
41 #ifndef HvNAME_get
42 # define HvNAME_get(H) HvNAME(H)
43 #endif
44
45 #ifndef gv_fetchpvn_flags
46 # define gv_fetchpvn_flags(A, B, C, D) gv_fetchpv((A), (C), (D))
47 #endif
48
49 #ifndef PERL_MAGIC_tied
50 # define PERL_MAGIC_tied 'P'
51 #endif
52
53 #ifndef PERL_MAGIC_env
54 # define PERL_MAGIC_env 'E'
55 #endif
56
57 #define SU_HAS_PERL(R, V, S) (PERL_REVISION > (R) || (PERL_REVISION == (R) && (PERL_VERSION > (V) || (PERL_VERSION == (V) && (PERL_SUBVERSION >= (S))))))
58
59 /* --- Stack manipulations ------------------------------------------------- */
60
61 #ifndef SvCANEXISTDELETE
62 # define SvCANEXISTDELETE(sv) \
63   (!SvRMAGICAL(sv)            \
64    || ((mg = mg_find((SV *) sv, PERL_MAGIC_tied))            \
65        && (stash = SvSTASH(SvRV(SvTIED_obj((SV *) sv, mg)))) \
66        && gv_fetchmethod_autoload(stash, "EXISTS", TRUE)     \
67        && gv_fetchmethod_autoload(stash, "DELETE", TRUE)     \
68       )                       \
69    )
70 #endif
71
72 /* ... Saving array elements ............................................... */
73
74 STATIC I32 su_av_preeminent(pTHX_ AV *av, I32 key) {
75 #define su_av_preeminent(A, K) su_av_preeminent(aTHX_ (A), (K))
76  MAGIC *mg;
77  HV *stash;
78
79  if (!av)
80   return 0;
81  if (SvCANEXISTDELETE(av))
82   return av_exists(av, key);
83
84  return 1;
85 }
86
87 #ifndef SAVEADELETE
88
89 typedef struct {
90  AV *av;
91  I32 key;
92 } su_ud_adelete;
93
94 STATIC void su_adelete(pTHX_ void *ud_) {
95  su_ud_adelete *ud = ud_;
96
97  av_delete(ud->av, ud->key, G_DISCARD);
98  SvREFCNT_dec(ud->av);
99
100  Safefree(ud);
101 }
102
103 STATIC void su_save_adelete(pTHX_ AV *av, I32 key) {
104 #define su_save_adelete(A, K) su_save_adelete(aTHX_ (A), (K))
105  su_ud_adelete *ud;
106
107  Newx(ud, 1, su_ud_adelete);
108  ud->av  = av;
109  ud->key = key;
110  SvREFCNT_inc(av);
111
112  SAVEDESTRUCTOR_X(su_adelete, ud);
113 }
114
115 #define SAVEADELETE(A, K) su_save_adelete((A), (K))
116
117 #endif /* SAVEADELETE */
118
119 STATIC void su_save_aelem(pTHX_ AV *av, I32 key, SV **svp, I32 preeminent) {
120 #define su_save_aelem(A, K, S, P) su_save_aelem(aTHX_ (A), (K), (S), (P))
121  if (preeminent)
122   save_aelem(av, key, svp);
123  else
124   SAVEADELETE(av, key);
125 }
126
127 /* ... Saving hash elements ................................................ */
128
129 STATIC I32 su_hv_preeminent(pTHX_ HV *hv, SV *keysv) {
130 #define su_hv_preeminent(H, K) su_hv_preeminent(aTHX_ (H), (K))
131  MAGIC *mg;
132  HV *stash;
133
134  if (!hv)
135   return 0;
136  if (SvCANEXISTDELETE(hv) || mg_find((SV *) hv, PERL_MAGIC_env))
137   return hv_exists_ent(hv, keysv, 0);
138
139  return 1;
140 }
141
142 STATIC void su_save_helem(pTHX_ HV *hv, SV *keysv, SV **svp, I32 preeminent) {
143 #define su_save_helem(H, K, S, P) su_save_helem(aTHX_ (H), (K), (S), (P))
144  if (HvNAME_get(hv) && isGV(*svp)) {
145   save_gp((GV *) *svp, 0);
146   return;
147  }
148  if (preeminent)
149   save_helem(hv, keysv, svp);
150  else {
151   STRLEN keylen;
152   const char * const key = SvPV_const(keysv, keylen);
153   SAVEDELETE(hv, savepvn(key, keylen),
154                  SvUTF8(keysv) ? -(I32)keylen : (I32)keylen);
155  }
156 }
157
158 /* --- Actions ------------------------------------------------------------- */
159
160 typedef struct {
161  I32 depth;
162  I32 *origin;
163  void (*handler)(pTHX_ void *);
164 } su_ud_common;
165
166 #define SU_UD_DEPTH(U)   (((su_ud_common *) (U))->depth)
167 #define SU_UD_ORIGIN(U)  (((su_ud_common *) (U))->origin)
168 #define SU_UD_HANDLER(U) (((su_ud_common *) (U))->handler)
169
170 #define SU_UD_FREE(U) do { \
171  if (SU_UD_ORIGIN(U)) Safefree(SU_UD_ORIGIN(U)); \
172  Safefree(U); \
173 } while (0)
174
175 /* ... Reap ................................................................ */
176
177 typedef struct {
178  su_ud_common ci;
179  SV *cb;
180 } su_ud_reap;
181
182 STATIC void su_call(pTHX_ void *ud_) {
183  su_ud_reap *ud = (su_ud_reap *) ud_;
184 #if SU_HAS_PERL(5, 10, 0)
185  I32 dieing = PL_op->op_type == OP_DIE;
186 #endif
187
188  dSP;
189
190  SU_D(PerlIO_printf(Perl_debug_log, "%p: @@@ call at %d (save is %d)\n",
191                                      ud, PL_scopestack_ix, PL_savestack_ix));
192  ENTER;
193  SAVETMPS;
194
195  PUSHMARK(SP);
196  PUTBACK;
197
198  /* If cxstack_ix isn't incremented there, the eval context will be overwritten
199   * when the new sub scope will be created in call_sv. */
200
201 #if SU_HAS_PERL(5, 10, 0)
202  if (dieing)
203   if (cxstack_ix < cxstack_max)
204    ++cxstack_ix;
205   else
206    cxstack_ix = Perl_cxinc(aTHX);
207 #endif
208
209  call_sv(ud->cb, G_VOID);
210
211 #if SU_HAS_PERL(5, 10, 0)
212  if (dieing && cxstack_ix > 0)
213   --cxstack_ix;
214 #endif
215
216  SPAGAIN;
217  PUTBACK;
218
219  FREETMPS;
220  LEAVE;
221
222  SvREFCNT_dec(ud->cb);
223  SU_UD_FREE(ud);
224 }
225
226 STATIC void su_reap(pTHX_ void *ud) {
227 #define su_reap(U) su_reap(aTHX_ (U))
228  SU_D(PerlIO_printf(Perl_debug_log, "%p: === reap at %d (save is %d)\n",
229                                      ud, PL_scopestack_ix, PL_savestack_ix));
230  SAVEDESTRUCTOR_X(su_call, ud);
231  SU_D(PerlIO_printf(Perl_debug_log, "%p: savestack is now at %d, base at %d\n",
232                                      ud, PL_savestack_ix,
233                                          PL_scopestack[PL_scopestack_ix]));
234 }
235
236 /* ... Localize & localize array/hash element .............................. */
237
238 typedef struct {
239  su_ud_common ci;
240  SV *sv;
241  SV *val;
242  SV *elem;
243 } su_ud_localize;
244
245 STATIC void su_localize(pTHX_ void *ud_) {
246 #define su_localize(U) su_localize(aTHX_ (U))
247  su_ud_localize *ud = (su_ud_localize *) ud_;
248  SV *sv   = ud->sv;
249  SV *val  = ud->val;
250  SV *elem = ud->elem;
251  GV *gv;
252  UV deref = 0;
253  svtype t = SVt_NULL;
254
255  if (SvTYPE(sv) >= SVt_PVGV) {
256   gv = (GV *) sv;
257   if (!SvROK(val))
258    goto assign;
259   t = SvTYPE(SvRV(val));
260   deref = 1;
261  } else {
262   STRLEN len, l;
263   const char *p = SvPV_const(sv, len), *s;
264   for (s = p, l = len; l > 0 && isSPACE(*s); ++s, --l) { }
265   if (!l) {
266    l = len;
267    s = p;
268   }
269   switch (*s) {
270    case '$': t = SVt_PV;   break;
271    case '@': t = SVt_PVAV; break;
272    case '%': t = SVt_PVHV; break;
273    case '&': t = SVt_PVCV; break;
274    case '*': t = SVt_PVGV; break;
275   }
276   if (t == SVt_NULL) {
277    if (SvROK(val) && !sv_isobject(val)) {
278     t = SvTYPE(SvRV(val));
279     deref = 1;
280    } else {
281     t = SvTYPE(val);
282    }
283   } else {
284    ++s;
285    --l;
286   }
287   gv = gv_fetchpvn_flags(s, l, GV_ADDMULTI, SVt_PVGV);
288  }
289
290  SU_D({
291   SV *z = newSV_type(t);
292   PerlIO_printf(Perl_debug_log, "%p: === localize a %s at %d (save is %d)\n",
293                                  ud, sv_reftype(z, 0),
294                                      PL_scopestack_ix, PL_savestack_ix);
295   SvREFCNT_dec(z);
296  });
297
298  /* Inspired from Alias.pm */
299  switch (t) {
300   case SVt_PVAV:
301    if (elem) {
302     I32 idx  = SvIV(elem);
303     AV *av   = GvAV(gv);
304     I32 preeminent = su_av_preeminent(av, idx);
305     SV **svp = av_fetch(av, idx, 1);
306     if (!*svp || *svp == &PL_sv_undef) croak(PL_no_aelem, idx);
307     su_save_aelem(av, idx, svp, preeminent);
308     gv = (GV *) *svp;
309     goto maybe_deref;
310    } else
311     save_ary(gv);
312    break;
313   case SVt_PVHV:
314    if (elem) {
315     HV *hv   = GvHV(gv);
316     I32 preeminent = su_hv_preeminent(hv, elem);
317     HE *he   = hv_fetch_ent(hv, elem, 1, 0);
318     SV **svp = he ? &HeVAL(he) : NULL;
319     if (!svp || *svp == &PL_sv_undef) croak("Modification of non-creatable hash value attempted, subscript \"%s\"", SvPV_nolen_const(*svp));
320     su_save_helem(hv, elem, svp, preeminent);
321     gv = (GV *) *svp;
322     goto maybe_deref;
323    } else
324     save_hash(gv);
325    break;
326   case SVt_PVGV:
327    save_gp(gv, 1); /* hide previous entry in symtab */
328    break;
329   case SVt_PVCV:
330    SAVESPTR(GvCV(gv));
331    GvCV(gv) = NULL;
332    break;
333   default:
334    gv = (GV *) save_scalar(gv);
335 maybe_deref:
336    if (deref)
337     val = SvRV(val);
338    break;
339  }
340
341  SU_D(PerlIO_printf(Perl_debug_log, "%p: savestack is now at %d, base at %d\n",
342                                      ud, PL_savestack_ix,
343                                          PL_scopestack[PL_scopestack_ix]));
344
345 assign:
346  SvSetMagicSV((SV *) gv, val);
347
348  SvREFCNT_dec(ud->elem);
349  SvREFCNT_dec(ud->val);
350  SvREFCNT_dec(ud->sv);
351  SU_UD_FREE(ud);
352 }
353
354 /* --- Pop a context back -------------------------------------------------- */
355
356 #if SU_DEBUG
357 # ifdef DEBUGGING
358 #  define SU_CXNAME PL_block_type[CxTYPE(&cxstack[cxstack_ix])]
359 # else
360 #  define SU_CXNAME "XXX"
361 # endif
362 #endif
363
364 STATIC void su_pop(pTHX_ void *ud) {
365 #define su_pop(U) su_pop(aTHX_ (U))
366  I32 depth, base, mark, *origin;
367  depth = SU_UD_DEPTH(ud);
368
369  SU_D(PerlIO_printf(Perl_debug_log, "%p: --- pop %s at %d from %d to %d [%d]\n",
370                                      ud, SU_CXNAME,
371                                          PL_scopestack_ix, PL_savestack_ix,
372                                          PL_scopestack[PL_scopestack_ix],
373                                          depth));
374
375  origin = SU_UD_ORIGIN(ud);
376  mark   = origin[depth];
377  base   = origin[depth - 1];
378
379  SU_D(PerlIO_printf(Perl_debug_log, "%p: clean from %d down to %d\n",
380                                      ud, mark, base));
381
382  if (base < mark) {
383   PL_savestack_ix = mark;
384   leave_scope(base);
385  }
386  PL_savestack_ix = base;
387  if (--depth > 0) {
388   SU_UD_DEPTH(ud) = depth;
389   SU_D(PerlIO_printf(Perl_debug_log, "%p: save new destructor at %d [%d]\n",
390                                       ud, PL_savestack_ix, depth));
391   SAVEDESTRUCTOR_X(su_pop, ud);
392   SU_D(PerlIO_printf(Perl_debug_log, "%p: pop end at at %d [%d]\n",
393                                       ud, PL_savestack_ix, depth));
394  } else {
395   SU_UD_HANDLER(ud)(aTHX_ ud);
396  }
397 }
398
399 /* --- Initialize the stack and the action userdata ------------------------ */
400
401 STATIC I32 su_init(pTHX_ I32 level, void *ud, I32 size) {
402 #define su_init(L, U, S) su_init(aTHX_ (L), (U), (S))
403  I32 i, depth = 0, *origin;
404  I32 cur, last, step;
405
406  SU_D(PerlIO_printf(Perl_debug_log, "%p: ### init for level %d\n", ud, level));
407
408  for (i = 0; i < level; ++i) {
409   PERL_CONTEXT *cx = &cxstack[cxstack_ix - i];
410   switch (CxTYPE(cx)) {
411 #if SU_HAS_PERL(5, 11, 0)
412    case CXt_LOOP_FOR:
413    case CXt_LOOP_PLAIN:
414    case CXt_LOOP_LAZYSV:
415    case CXt_LOOP_LAZYIV:
416 #else
417    case CXt_LOOP:
418 #endif
419     SU_D(PerlIO_printf(Perl_debug_log, "%p: cx %d is loop\n", ud, i));
420     depth += 2;
421     break;
422    default:
423     SU_D(PerlIO_printf(Perl_debug_log, "%p: cx %d is normal\n", ud, i));
424     depth++;
425     break;
426   }
427  }
428  SU_D(PerlIO_printf(Perl_debug_log, "%p: depth is %d\n", ud, depth));
429
430  Newx(origin, depth + 1, I32);
431  origin[0] = PL_scopestack[PL_scopestack_ix - depth];
432  PL_scopestack[PL_scopestack_ix - depth] += size;
433  for (i = depth - 1; i >= 1; --i) {
434   I32 j = PL_scopestack_ix - i;
435   origin[depth - i] = PL_scopestack[j];
436   PL_scopestack[j] += 3;
437  }
438  origin[depth] = PL_savestack_ix;
439
440  SU_D({
441   PerlIO_printf(Perl_debug_log, "%p: d=%d s=%d x=%d c=%d o=%d\n", ud,
442                 depth, 0, PL_scopestack_ix - 1, PL_savestack_ix, origin[depth]);
443   for (i = depth - 1; i >= 0; --i) {
444    I32 x = PL_scopestack_ix  - depth + i;
445    PerlIO_printf(Perl_debug_log, "%p: d=%d s=%d x=%d c=%d o=%d\n", ud,
446                                   i, depth - i, x, PL_scopestack[x], origin[i]);
447   }
448  });
449
450  SU_UD_ORIGIN(ud) = origin;
451  SU_UD_DEPTH(ud)  = depth;
452  return depth;
453 }
454
455 #define SU_GET_LEVEL(A)  \
456  if (items > A) {        \
457   SV *lsv = ST(A);       \
458   if (SvOK(lsv))         \
459    level = SvUV(lsv);    \
460   if (level < 0)         \
461    XSRETURN(0);          \
462  }                       \
463  if (level > cxstack_ix) \
464   level = cxstack_ix;
465
466 /* --- XS ------------------------------------------------------------------ */
467
468 MODULE = Scope::Upper            PACKAGE = Scope::Upper
469
470 PROTOTYPES: ENABLE
471
472 SV *
473 TOPLEVEL()
474 PROTOTYPE:
475 CODE:
476  RETVAL = newSViv(cxstack_ix);
477 OUTPUT:
478  RETVAL
479
480 void
481 reap(SV *hook, ...)
482 PROTOTYPE: &;$
483 PREINIT:
484  I32 level = 0;
485  su_ud_reap *ud;
486 CODE:
487  SU_GET_LEVEL(1);
488  Newx(ud, 1, su_ud_reap);
489  SU_UD_ORIGIN(ud)  = NULL;
490  SU_UD_HANDLER(ud) = su_reap;
491  ud->cb = newSVsv(hook);
492  LEAVE;
493  if (level) {
494   I32 depth = su_init(level, ud, 3);
495   SU_D(PerlIO_printf(Perl_debug_log, "%p: set original destructor at %d [%d]\n",
496                                       ud, PL_savestack_ix, depth));
497   SAVEDESTRUCTOR_X(su_pop, ud);
498  } else
499   su_reap(ud);
500  ENTER;
501
502 void
503 localize(SV *sv, SV *val, ...)
504 PROTOTYPE: $$;$
505 PREINIT:
506  I32 level = 0;
507  su_ud_localize *ud;
508 CODE:
509  SU_GET_LEVEL(2);
510  Newx(ud, 1, su_ud_localize);
511  SU_UD_ORIGIN(ud)  = NULL;
512  SU_UD_HANDLER(ud) = su_localize;
513  SvREFCNT_inc(sv);
514  ud->sv   = sv;
515  ud->val  = newSVsv(val);
516  ud->elem = NULL;
517  LEAVE;
518  if (level) {
519   I32 depth = su_init(level, ud, 3);
520   SU_D(PerlIO_printf(Perl_debug_log, "%p: set original destructor at %d [%d]\n",
521                                       ud, PL_savestack_ix, depth));
522   SAVEDESTRUCTOR_X(su_pop, ud);
523  } else
524   su_localize(ud);
525  ENTER;
526
527 void
528 localize_elem(SV *sv, SV *elem, SV *val, ...)
529 PROTOTYPE: $$$;$
530 PREINIT:
531  I32 level = 0;
532  su_ud_localize *ud;
533 CODE:
534  SU_GET_LEVEL(3);
535  Newx(ud, 1, su_ud_localize);
536  SU_UD_ORIGIN(ud)  = NULL;
537  SU_UD_HANDLER(ud) = su_localize;
538  SvREFCNT_inc(sv);
539  ud->sv   = sv;
540  ud->val  = newSVsv(val);
541  SvREFCNT_inc(elem);
542  ud->elem = elem;
543  LEAVE;
544  if (level) {
545   I32 depth = su_init(level, ud, 4);
546   SU_D(PerlIO_printf(Perl_debug_log, "%p: set original destructor at %d [%d]\n",
547                                       ud, PL_savestack_ix, depth));
548   SAVEDESTRUCTOR_X(su_pop, ud);
549  } else
550   su_localize(ud);
551  ENTER;
552