This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
add -v to regen.pl and friends
[perl5.git] / scope.h
diff --git a/scope.h b/scope.h
index 7ebccf4..7f56460 100644 (file)
--- a/scope.h
+++ b/scope.h
@@ -1,3 +1,13 @@
+/*    scope.h
+ *
+ *    Copyright (C) 1993, 1994, 1996, 1997, 1998, 1999,
+ *    2000, 2001, 2002, 2004, 2005, 2006, 2007 by Larry Wall and others
+ *
+ *    You may distribute under the terms of either the GNU General Public
+ *    License or the Artistic License, as specified in the README file.
+ *
+ */
+
 #define SAVEt_ITEM             0
 #define SAVEt_SV               1
 #define SAVEt_AV               2
 #define SAVEt_HINTS            27
 #define SAVEt_ALLOC            28
 #define SAVEt_GENERIC_SVREF    29
+#define SAVEt_DESTRUCTOR_X     30
+#define SAVEt_VPTR             31
+#define SAVEt_I8               32
+#define SAVEt_COMPPAD          33
+#define SAVEt_GENERIC_PVREF    34
+#define SAVEt_PADSV_AND_MORTALIZE      35
+#define SAVEt_MORTALIZESV      36
+#define SAVEt_SHARED_PVREF     37
+#define SAVEt_BOOL             38
+#define SAVEt_SET_SVFLAGS      39
+#define SAVEt_SAVESWITCHSTACK  40
+#define SAVEt_COP_ARYBASE      41
+#define SAVEt_RE_STATE         42
+#define SAVEt_COMPILE_WARNINGS 43
+#define SAVEt_STACK_CXPOS      44
+#define SAVEt_PARSER           45
 
-#define SSCHECK(need) if (PL_savestack_ix + need > PL_savestack_max) savestack_grow()
+#ifndef SCOPE_SAVES_SIGNAL_MASK
+#define SCOPE_SAVES_SIGNAL_MASK 0
+#endif
+
+#define SSCHECK(need) if (PL_savestack_ix + (I32)(need) > PL_savestack_max) savestack_grow()
+#define SSGROW(need) if (PL_savestack_ix + (I32)(need) > PL_savestack_max) savestack_grow_cnt(need)
 #define SSPUSHINT(i) (PL_savestack[PL_savestack_ix++].any_i32 = (I32)(i))
 #define SSPUSHLONG(i) (PL_savestack[PL_savestack_ix++].any_long = (long)(i))
+#define SSPUSHBOOL(p) (PL_savestack[PL_savestack_ix++].any_bool = (p))
 #define SSPUSHIV(i) (PL_savestack[PL_savestack_ix++].any_iv = (IV)(i))
 #define SSPUSHPTR(p) (PL_savestack[PL_savestack_ix++].any_ptr = (void*)(p))
 #define SSPUSHDPTR(p) (PL_savestack[PL_savestack_ix++].any_dptr = (p))
+#define SSPUSHDXPTR(p) (PL_savestack[PL_savestack_ix++].any_dxptr = (p))
 #define SSPOPINT (PL_savestack[--PL_savestack_ix].any_i32)
 #define SSPOPLONG (PL_savestack[--PL_savestack_ix].any_long)
+#define SSPOPBOOL (PL_savestack[--PL_savestack_ix].any_bool)
 #define SSPOPIV (PL_savestack[--PL_savestack_ix].any_iv)
 #define SSPOPPTR (PL_savestack[--PL_savestack_ix].any_ptr)
 #define SSPOPDPTR (PL_savestack[--PL_savestack_ix].any_dptr)
+#define SSPOPDXPTR (PL_savestack[--PL_savestack_ix].any_dxptr)
+
+/*
+=head1 Callback Functions
+
+=for apidoc Ams||SAVETMPS
+Opening bracket for temporaries on a callback.  See C<FREETMPS> and
+L<perlcall>.
+
+=for apidoc Ams||FREETMPS
+Closing bracket for temporaries on a callback.  See C<SAVETMPS> and
+L<perlcall>.
+
+=for apidoc Ams||ENTER
+Opening bracket on a callback.  See C<LEAVE> and L<perlcall>.
+
+=for apidoc Ams||LEAVE
+Closing bracket on a callback.  See C<ENTER> and L<perlcall>.
+
+=cut
+*/
 
 #define SAVETMPS save_int((int*)&PL_tmps_floor), PL_tmps_floor = PL_tmps_ix
 #define FREETMPS if (PL_tmps_ix > PL_tmps_floor) free_tmps()
 #define ENTER                                                  \
     STMT_START {                                               \
        push_scope();                                           \
-       DEBUG_l(WITH_THR(Perl_deb(aTHX_ "ENTER scope %ld at %s:%d\n",   \
-                   PL_scopestack_ix, __FILE__, __LINE__)));    \
+       DEBUG_SCOPE("ENTER")                                    \
     } STMT_END
 #define LEAVE                                                  \
     STMT_START {                                               \
-       DEBUG_l(WITH_THR(Perl_deb(aTHX_ "LEAVE scope %ld at %s:%d\n",   \
-                   PL_scopestack_ix, __FILE__, __LINE__)));    \
+       DEBUG_SCOPE("LEAVE")                                    \
        pop_scope();                                            \
     } STMT_END
 #else
 #endif
 #define LEAVE_SCOPE(old) if (PL_savestack_ix > old) leave_scope(old)
 
-/*
- * Not using SOFT_CAST on SAVESPTR, SAVEGENERICSV and SAVEFREESV
- * because these are used for several kinds of pointer values
- */
-#define SAVEI16(i)     save_I16(SOFT_CAST(I16*)&(i))
-#define SAVEI32(i)     save_I32(SOFT_CAST(I32*)&(i))
-#define SAVEINT(i)     save_int(SOFT_CAST(int*)&(i))
-#define SAVEIV(i)      save_iv(SOFT_CAST(IV*)&(i))
-#define SAVELONG(l)    save_long(SOFT_CAST(long*)&(l))
+#define SAVEI8(i)      save_I8((I8*)&(i))
+#define SAVEI16(i)     save_I16((I16*)&(i))
+#define SAVEI32(i)     save_I32((I32*)&(i))
+#define SAVEINT(i)     save_int((int*)&(i))
+#define SAVEIV(i)      save_iv((IV*)&(i))
+#define SAVELONG(l)    save_long((long*)&(l))
+#define SAVEBOOL(b)    save_bool((bool*)&(b))
 #define SAVESPTR(s)    save_sptr((SV**)&(s))
-#define SAVEPPTR(s)    save_pptr(SOFT_CAST(char**)&(s))
+#define SAVEPPTR(s)    save_pptr((char**)&(s))
+#define SAVEVPTR(s)    save_vptr((void*)&(s))
+#define SAVEPADSVANDMORTALIZE(s)       save_padsv_and_mortalize(s)
 #define SAVEFREESV(s)  save_freesv((SV*)(s))
-#define SAVEFREEOP(o)  save_freeop(SOFT_CAST(OP*)(o))
-#define SAVEFREEPV(p)  save_freepv(SOFT_CAST(char*)(p))
-#define SAVECLEARSV(sv)        save_clearsv(SOFT_CAST(SV**)&(sv))
+#define SAVEMORTALIZESV(s)     save_mortalizesv((SV*)(s))
+#define SAVEFREEOP(o)  save_freeop((OP*)(o))
+#define SAVEFREEPV(p)  save_freepv((char*)(p))
+#define SAVECLEARSV(sv)        save_clearsv((SV**)&(sv))
 #define SAVEGENERICSV(s)       save_generic_svref((SV**)&(s))
+#define SAVEGENERICPV(s)       save_generic_pvref((char**)&(s))
+#define SAVESHAREDPV(s)                save_shared_pvref((char**)&(s))
+#define SAVESETSVFLAGS(sv,mask,val)    save_set_svflags(sv,mask,val)
 #define SAVEDELETE(h,k,l) \
-         save_delete(SOFT_CAST(HV*)(h), SOFT_CAST(char*)(k), (I32)(l))
-#ifdef PERL_OBJECT
-#define CALLDESTRUCTOR this->*SSPOPDPTR
-#else
-#define CALLDESTRUCTOR (*SSPOPDPTR)
-#endif
+         save_delete((HV*)(h), (char*)(k), (I32)(l))
 #define SAVEDESTRUCTOR(f,p) \
-         save_destructor((DESTRUCTORFUNC_t)(FUNC_NAME_TO_PTR(f)),      \
-                         SOFT_CAST(void*)(p))
+         save_destructor((DESTRUCTORFUNC_NOCONTEXT_t)(f), (void*)(p))
+
+#define SAVEDESTRUCTOR_X(f,p) \
+         save_destructor_x((DESTRUCTORFUNC_t)(f), (void*)(p))
 
 #define SAVESTACK_POS() \
     STMT_START {                               \
 #define SAVEOP()       save_op()
 
 #define SAVEHINTS() \
-    STMT_START {                               \
-       if (PL_hints & HINT_LOCALIZE_HH)        \
-           save_hints();                       \
-       else {                                  \
-           SSCHECK(2);                         \
-           SSPUSHINT(PL_hints);                \
-           SSPUSHINT(SAVEt_HINTS);             \
-       }                                       \
+    STMT_START {                                       \
+       SSCHECK(4);                                     \
+       if (PL_hints & HINT_LOCALIZE_HH) {              \
+           SSPUSHPTR(GvHV(PL_hintgv));                 \
+           GvHV(PL_hintgv) = Perl_hv_copy_hints_hv(aTHX_ GvHV(PL_hintgv)); \
+       }                                               \
+       if (PL_compiling.cop_hints_hash) {              \
+           HINTS_REFCNT_LOCK;                          \
+           PL_compiling.cop_hints_hash->refcounted_he_refcnt++;        \
+           HINTS_REFCNT_UNLOCK;                        \
+       }                                               \
+       SSPUSHPTR(PL_compiling.cop_hints_hash);         \
+       SSPUSHINT(PL_hints);                            \
+       SSPUSHINT(SAVEt_HINTS);                         \
     } STMT_END
 
-/* SSNEW() temporarily allocates a specified number of bytes of data on the
- * savestack.  It returns an integer index into the savestack, because a
- * pointer would get broken if the savestack is moved on reallocation.
- * SSNEWa() works like SSNEW(), but also aligns the data to the specified
- * number of bytes.  MEM_ALIGNBYTES is perhaps the most useful.  The
- * alignment will be preserved therough savestack reallocation *only* if
- * realloc returns data aligned to a size divisible by `align'!
- *
- * SSPTR() converts the index returned by SSNEW/SSNEWa() into a pointer.
- */
-
-#define SSNEW(size)             save_alloc(size, 0)
-#define SSNEWa(size,align)     save_alloc(size, \
-    (align - ((int)((caddr_t)&PL_savestack[PL_savestack_ix]) % align)) % align)
-
-#define SSPTR(off,type)         ((type) ((char*)PL_savestack + off))
-
-/* A jmpenv packages the state required to perform a proper non-local jump.
- * Note that there is a start_env initialized when perl starts, and top_env
- * points to this initially, so top_env should always be non-null.
- *
- * Existence of a non-null top_env->je_prev implies it is valid to call
- * longjmp() at that runlevel (we make sure start_env.je_prev is always
- * null to ensure this).
- *
- * je_mustcatch, when set at any runlevel to TRUE, means eval ops must
- * establish a local jmpenv to handle exception traps.  Care must be taken
- * to restore the previous value of je_mustcatch before exiting the
- * stack frame iff JMPENV_PUSH was not called in that stack frame.
- * GSAR 97-03-27
- */
-
-struct jmpenv {
-    struct jmpenv *    je_prev;
-    Sigjmp_buf         je_buf;         /* only for use if !je_throw */
-    int                        je_ret;         /* last exception thrown */
-    bool               je_mustcatch;   /* need to call longjmp()? */
-    void               (*je_throw)(int v); /* last for bincompat */
-};
-
-typedef struct jmpenv JMPENV;
-
-/*
- * Function that catches/throws, and its callback for the
- *  body of protected processing.
- */
-typedef void *(CPERLscope(*protect_body_t)) (pTHX_ va_list);
-typedef void *(CPERLscope(*protect_proc_t)) (pTHX_ int *, protect_body_t, ...);
-
-/*
- * How to build the first jmpenv.
- *
- * top_env needs to be non-zero. It points to an area
- * in which longjmp() stuff is stored, as C callstack
- * info there at least is thread specific this has to
- * be per-thread. Otherwise a 'die' in a thread gives
- * that thread the C stack of last thread to do an eval {}!
- */
-
-#define JMPENV_BOOTSTRAP \
-    STMT_START {                               \
-       PL_start_env.je_prev = NULL;            \
-       PL_start_env.je_throw = NULL;           \
-       PL_start_env.je_ret = -1;               \
-       PL_start_env.je_mustcatch = TRUE;       \
-       PL_top_env = &PL_start_env;             \
+#define SAVECOMPPAD() \
+    STMT_START {                                               \
+       SSCHECK(2);                                             \
+       SSPUSHPTR((SV*)PL_comppad);                             \
+       SSPUSHINT(SAVEt_COMPPAD);                               \
     } STMT_END
 
-#ifdef OP_IN_REGISTER
-#define OP_REG_TO_MEM  PL_opsave = op
-#define OP_MEM_TO_REG  op = PL_opsave
-#else
-#define OP_REG_TO_MEM  NOOP
-#define OP_MEM_TO_REG  NOOP
-#endif
-
-/*
- * These exception-handling macros are split up to
- * ease integration with C++ exceptions.
- *
- * To use C++ try+catch to catch Perl exceptions, an extension author
- * needs to first write an extern "C" function to throw an appropriate
- * exception object; typically it will be or contain an integer,
- * because Perl's internals use integers to track exception types:
- *    extern "C" { static void thrower(int i) { throw i; } }
- *
- * Then (as shown below) the author needs to use, not the simple
- * JMPENV_PUSH, but several of its constitutent macros, to arrange for
- * the Perl internals to call thrower() rather than longjmp() to
- * report exceptions:
- *
- *    dJMPENV;
- *    JMPENV_PUSH_INIT(thrower);
- *    try {
- *        ... stuff that may throw exceptions ...
- *    }
- *    catch (int why) {  // or whatever matches thrower()
- *        JMPENV_POST_CATCH;
- *        EXCEPT_SET(why);
- *        switch (why) {
- *          ... // handle various Perl exception codes
- *        }
- *    }
- *    JMPENV_POP;  // don't forget this!
- */
-
-#define dJMPENV                JMPENV cur_env
-
-#define JMPENV_PUSH_INIT_ENV(cur_env,THROWFUNC) \
+#define SAVESWITCHSTACK(f,t) \
     STMT_START {                                       \
-       cur_env.je_throw = (THROWFUNC);                 \
-       cur_env.je_ret = -1;                            \
-       cur_env.je_mustcatch = FALSE;                   \
-       cur_env.je_prev = PL_top_env;                   \
-       PL_top_env = &cur_env;                          \
-       OP_REG_TO_MEM;                                  \
+       SSCHECK(3);                                     \
+       SSPUSHPTR((SV*)(f));                            \
+       SSPUSHPTR((SV*)(t));                            \
+       SSPUSHINT(SAVEt_SAVESWITCHSTACK);               \
+       SWITCHSTACK((f),(t));                           \
+       PL_curstackinfo->si_stack = (t);                \
     } STMT_END
 
-#define JMPENV_PUSH_INIT(THROWFUNC) JMPENV_PUSH_INIT_ENV(cur_env,THROWFUNC) 
-
-#define JMPENV_POST_CATCH_ENV(cur_env) \
+#define SAVECOPARYBASE(c) \
     STMT_START {                                       \
-       OP_MEM_TO_REG;                                  \
-       PL_top_env = &cur_env;                          \
+       SSCHECK(3);                                     \
+       SSPUSHINT(CopARYBASE_get(c));                   \
+       SSPUSHPTR(c);                                   \
+       SSPUSHINT(SAVEt_COP_ARYBASE);                   \
     } STMT_END
 
-#define JMPENV_POST_CATCH JMPENV_POST_CATCH_ENV(cur_env)
+/* Need to do the cop warnings like this, rather than a "SAVEFREESHAREDPV",
+   because realloc() means that the value can actually change. Possibly
+   could have done savefreesharedpvREF, but this way actually seems cleaner,
+   as it simplifies the code that does the saves, and reduces the load on the
+   save stack.  */
+#define SAVECOMPILEWARNINGS() \
+    STMT_START {                                       \
+       SSCHECK(2);                                     \
+       SSPUSHPTR(PL_compiling.cop_warnings);           \
+       SSPUSHINT(SAVEt_COMPILE_WARNINGS);              \
+    } STMT_END
 
+#define SAVESTACK_CXPOS() \
+    STMT_START {                                  \
+        SSCHECK(3);                               \
+        SSPUSHINT(cxstack[cxstack_ix].blk_oldsp); \
+        SSPUSHINT(cxstack_ix);                    \
+        SSPUSHINT(SAVEt_STACK_CXPOS);             \
+    } STMT_END
 
-#define JMPENV_PUSH_ENV(cur_env,v) \
-    STMT_START {                                       \
-       JMPENV_PUSH_INIT_ENV(cur_env,NULL);                             \
-       EXCEPT_SET_ENV(cur_env,PerlProc_setjmp(cur_env.je_buf, 1));     \
-       JMPENV_POST_CATCH_ENV(cur_env);                         \
-       (v) = EXCEPT_GET_ENV(cur_env);                          \
+#define SAVEPARSER(p) \
+    STMT_START {                                  \
+        SSCHECK(2);                               \
+        SSPUSHPTR(p);                            \
+        SSPUSHINT(SAVEt_PARSER);                 \
     } STMT_END
 
-#define JMPENV_PUSH(v) JMPENV_PUSH_ENV(cur_env,v) 
+#ifdef USE_ITHREADS
+#  define SAVECOPSTASH(c)      SAVEPPTR(CopSTASHPV(c))
+#  define SAVECOPSTASH_FREE(c) SAVESHAREDPV(CopSTASHPV(c))
+#  define SAVECOPFILE(c)       SAVEPPTR(CopFILE(c))
+#  define SAVECOPFILE_FREE(c)  SAVESHAREDPV(CopFILE(c))
+#  define SAVECOPLABEL(c)      SAVEPPTR(CopLABEL(c))
+#  define SAVECOPLABEL_FREE(c) SAVESHAREDPV(CopLABEL(c))
+#else
+#  define SAVECOPSTASH(c)      SAVESPTR(CopSTASH(c))
+#  define SAVECOPSTASH_FREE(c) SAVECOPSTASH(c) /* XXX not refcounted */
+#  define SAVECOPFILE(c)       SAVESPTR(CopFILEGV(c))
+#  define SAVECOPFILE_FREE(c)  SAVEGENERICSV(CopFILEGV(c))
+#  define SAVECOPLABEL(c)      SAVEPPTR(CopLABEL(c))
+#  define SAVECOPLABEL_FREE(c) SAVEPPTR(CopLABEL(c))
+#endif
 
-#define JMPENV_POP_ENV(cur_env) \
-    STMT_START { PL_top_env = cur_env.je_prev; } STMT_END
+#define SAVECOPLINE(c)         SAVEI32(CopLINE(c))
 
-#define JMPENV_POP  JMPENV_POP_ENV(cur_env) 
+/* SSNEW() temporarily allocates a specified number of bytes of data on the
+ * savestack.  It returns an integer index into the savestack, because a
+ * pointer would get broken if the savestack is moved on reallocation.
+ * SSNEWa() works like SSNEW(), but also aligns the data to the specified
+ * number of bytes.  MEM_ALIGNBYTES is perhaps the most useful.  The
+ * alignment will be preserved therough savestack reallocation *only* if
+ * realloc returns data aligned to a size divisible by "align"!
+ *
+ * SSPTR() converts the index returned by SSNEW/SSNEWa() into a pointer.
+ */
 
-#define JMPENV_JUMP(v) \
-    STMT_START {                                               \
-       OP_REG_TO_MEM;                                          \
-       if (PL_top_env->je_prev) {                              \
-           if (PL_top_env->je_throw)                           \
-               PL_top_env->je_throw(v);                        \
-           else                                                \
-               PerlProc_longjmp(PL_top_env->je_buf, (v));      \
-       }                                                       \
-       if ((v) == 2)                                           \
-           PerlProc_exit(STATUS_NATIVE_EXPORT);                \
-       PerlIO_printf(PerlIO_stderr(), "panic: top_env\n");     \
-       PerlProc_exit(1);                                       \
-    } STMT_END
+#define SSNEW(size)             Perl_save_alloc(aTHX_ (size), 0)
+#define SSNEWt(n,t)             SSNEW((n)*sizeof(t))
+#define SSNEWa(size,align)     Perl_save_alloc(aTHX_ (size), \
+    (align - ((int)((caddr_t)&PL_savestack[PL_savestack_ix]) % align)) % align)
+#define SSNEWat(n,t,align)     SSNEWa((n)*sizeof(t), align)
 
-#define EXCEPT_GET_ENV(cur_env)        (cur_env.je_ret)
-#define EXCEPT_GET EXCEPT_GET_ENV(cur_env)
-#define EXCEPT_SET_ENV(cur_env,v)      (cur_env.je_ret = (v))
-#define EXCEPT_SET(v) EXCEPT_SET_ENV(cur_env,v)
+#define SSPTR(off,type)         ((type)  ((char*)PL_savestack + off))
+#define SSPTRt(off,type)        ((type*) ((char*)PL_savestack + off))
 
-#define CATCH_GET      (PL_top_env->je_mustcatch)
-#define CATCH_SET(v)   (PL_top_env->je_mustcatch = (v))
-   
+/*
+ * Local variables:
+ * c-indentation-style: bsd
+ * c-basic-offset: 4
+ * indent-tabs-mode: t
+ * End:
+ *
+ * ex: set ts=8 sts=4 sw=4 noet:
+ */