This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
embed.fnc: Mark cx_dump as Core only
[perl5.git] / embed.fnc
index ce05127..3fd59fc 100644 (file)
--- a/embed.fnc
+++ b/embed.fnc
 :
 :      For example, the expansion of STR_WITH_LEN is a comma separated pair of
 :      values, so would have this flag; or some macros take preprocessor
-:      tokens, so would have this flag.  This flag is an indication to
-:      downstream tools, such as Devel::PPPort, that this requires special
-:      handling.
+:      tokens, so would have this flag.
+:
+:      This also is used for entries that require processing for use, such as
+:      being compiled by xsubpp.  This flag is an indication to downstream
+:      tools, such as Devel::PPPort, that this requires special handling.
 :
 :   U  autodoc.pl will not output a usage example
 :
@@ -572,7 +574,7 @@ ATod        |void   |perl_free      |NN PerlInterpreter *my_perl
 ATod   |int    |perl_run       |NN PerlInterpreter *my_perl
 ATod   |int    |perl_parse     |NN PerlInterpreter *my_perl|XSINIT_t xsinit \
                                |int argc|NULLOK char** argv|NULLOK char** env
-ATpR   |bool   |doing_taint    |int argc|NULLOK char** argv|NULLOK char** env
+CTpR   |bool   |doing_taint    |int argc|NULLOK char** argv|NULLOK char** env
 #if defined(USE_ITHREADS)
 ATod   |PerlInterpreter*|perl_clone|NN PerlInterpreter *proto_perl|UV flags
 #  if defined(PERL_IMPLICIT_SYS)
@@ -645,8 +647,8 @@ AmdR        |SSize_t|av_tindex      |NN AV *av
 Apd    |void   |av_undef       |NN AV *av
 Apdoex |SV**   |av_create_and_unshift_one|NN AV **const avp|NN SV *const val
 Apd    |void   |av_unshift     |NN AV *av|SSize_t num
-Apo    |SV**   |av_arylen_p    |NN AV *av
-Apo    |IV*    |av_iter_p      |NN AV *av
+Cpo    |SV**   |av_arylen_p    |NN AV *av
+Cpo    |IV*    |av_iter_p      |NN AV *av
 #if defined(PERL_IN_AV_C)
 S      |MAGIC* |get_aux_mg     |NN AV *av
 #endif
@@ -729,7 +731,7 @@ Apd |SV *   |cv_name        |NN CV *cv|NULLOK SV *sv|U32 flags
 Apd    |void   |cv_undef       |NN CV* cv
 p      |void   |cv_undef_flags |NN CV* cv|U32 flags
 pd     |void   |cv_forget_slab |NULLOK CV *cv
-Ap     |void   |cx_dump        |NN PERL_CONTEXT* cx
+Cp     |void   |cx_dump        |NN PERL_CONTEXT* cx
 AiMpd  |GV *   |CvGV           |NN CV *sv
 AiMTp  |I32 *  |CvDEPTH        |NN const CV * const sv
 Aphd   |SV*    |filter_add     |NULLOK filter_t funcp|NULLOK SV* datasv
@@ -743,7 +745,7 @@ pPR |const char*    |get_no_modify
 pPR    |U32*   |get_opargs
 ApPR   |PPADDR_t*|get_ppaddr
 : Used by CXINC, which appears to be in widespread use
-ApR    |I32    |cxinc
+CpR    |I32    |cxinc
 Afp    |void   |deb            |NN const char* pat|...
 Ap     |void   |vdeb           |NN const char* pat|NULLOK va_list* args
 Ap     |void   |debprofdump
@@ -995,7 +997,7 @@ Ap  |void   |gv_name_set    |NN GV* gv|NN const char *name|U32 len|U32 flags
 pe     |GV *   |gv_override    |NN const char * const name \
                                |const STRLEN len
 Xxpd   |void   |gv_try_downgrade|NN GV* gv
-p      |void   |gv_setref      |NN SV *const dstr|NN SV *const sstr
+p      |void   |gv_setref      |NN SV *const dsv|NN SV *const ssv
 Apd    |HV*    |gv_stashpv     |NN const char* name|I32 flags
 Apd    |HV*    |gv_stashpvn    |NN const char* name|U32 namelen|I32 flags
 #if defined(PERL_IN_GV_C) || defined(PERL_IN_UNIVERSAL_C)
@@ -1390,7 +1392,7 @@ S |void   |move_proto_attr|NN OP **proto|NN OP **attrs \
 #endif
 : Used in op.c and pp_sys.c
 p      |int    |mode_from_discipline|NULLOK const char* s|STRLEN len
-Ap     |const char*    |moreswitches   |NN const char* s
+Cp     |const char*    |moreswitches   |NN const char* s
 Apd    |NV     |my_atof        |NN const char *s
 ATdpR  |NV     |my_strtod      |NN const char * const s|NULLOK char ** e
 Aprd   |void   |my_exit        |U32 status
@@ -1399,7 +1401,7 @@ Ap        |I32    |my_fflush_all
 ATp    |Pid_t  |my_fork
 ATp    |void   |atfork_lock
 ATp    |void   |atfork_unlock
-ApMb   |I32    |my_lstat
+m      |I32    |my_lstat
 pX     |I32    |my_lstat_flags |NULLOK const U32 flags
 #if ! defined(HAS_MEMRCHR) && (defined(PERL_CORE) || defined(PERL_EXT))
 EeiT   |void * |my_memrchr     |NN const char * s|const char c|const STRLEN len
@@ -1410,7 +1412,7 @@ Ap        |PerlIO*|my_popen       |NN const char* cmd|NN const char* mode
 #endif
 Ap     |PerlIO*|my_popen_list  |NN const char* mode|int n|NN SV ** args
 Apd    |void   |my_setenv      |NULLOK const char* nam|NULLOK const char* val
-ApMb   |I32    |my_stat
+m      |I32    |my_stat
 pX     |I32    |my_stat_flags  |NULLOK const U32 flags
 Adfp   |char * |my_strftime    |NN const char *fmt|int sec|int min|int hour|int mday|int mon|int year|int wday|int yday|int isdst
 : Used in pp_ctl.c
@@ -1577,7 +1579,7 @@ ApdO      |I32    |call_argv      |NN const char* sub_name|I32 flags|NN char** argv
 ApdO   |I32    |call_method    |NN const char* methname|I32 flags
 ApdO   |I32    |call_pv        |NN const char* sub_name|I32 flags
 ApdO   |I32    |call_sv        |NN SV* sv|volatile I32 flags
-Ap     |void   |despatch_signals
+Cp     |void   |despatch_signals
 Ap     |OP *   |doref          |NN OP *o|I32 type|bool set_op_ref
 ApdO   |SV*    |eval_pv        |NN const char* p|I32 croak_on_error
 ApdO   |I32    |eval_sv        |NN SV* sv|I32 flags
@@ -1737,16 +1739,16 @@ Ap      |HEK*   |share_hek      |NN const char* str|SSize_t len|U32 hash
 #ifdef PERL_USE_3ARG_SIGHANDLER
 : Used in perl.c
 Tp     |Signal_t |sighandler   |int sig|NULLOK Siginfo_t *info|NULLOK void *uap
-ATp    |Signal_t |csighandler  |int sig|NULLOK Siginfo_t *info|NULLOK void *uap
+CTp    |Signal_t |csighandler  |int sig|NULLOK Siginfo_t *info|NULLOK void *uap
 #else
 Tp     |Signal_t |sighandler   |int sig
-ATp    |Signal_t |csighandler  |int sig
+CTp    |Signal_t |csighandler  |int sig
 #endif
 Tp     |Signal_t |sighandler1  |int sig
-ATp    |Signal_t |csighandler1 |int sig
+CTp    |Signal_t |csighandler1 |int sig
 Tp     |Signal_t |sighandler3  |int sig|NULLOK Siginfo_t *info|NULLOK void *uap
-ATp    |Signal_t |csighandler3 |int sig|NULLOK Siginfo_t *info|NULLOK void *uap
-ATp    |Signal_t |perly_sighandler     |int sig|NULLOK Siginfo_t *info|NULLOK void *uap|bool safe
+CTp    |Signal_t |csighandler3 |int sig|NULLOK Siginfo_t *info|NULLOK void *uap
+CTp    |Signal_t |perly_sighandler     |int sig|NULLOK Siginfo_t *info|NULLOK void *uap|bool safe
 Ap     |SV**   |stack_grow     |NN SV** sp|NN SV** p|SSize_t n
 Ap     |I32    |start_subparse |I32 is_format|U32 flags
 Xp     |void   |init_named_cv  |NN CV *cv|NN OP *nameop
@@ -1797,9 +1799,9 @@ S |void   |sv_buf_to_rw   |NN SV *sv
 Afpd   |void   |sv_catpvf      |NN SV *const sv|NN const char *const pat|...
 Apd    |void   |sv_vcatpvf     |NN SV *const sv|NN const char *const pat \
                                |NULLOK va_list *const args
-Apd    |void   |sv_catpv       |NN SV *const sv|NULLOK const char* ptr
+Apd    |void   |sv_catpv       |NN SV *const dsv|NULLOK const char* sstr
 ApMdb  |void   |sv_catpvn      |NN SV *dsv|NN const char *sstr|STRLEN len
-ApMdb  |void   |sv_catsv       |NN SV *dstr|NULLOK SV *sstr
+ApMdb  |void   |sv_catsv       |NN SV *dsv|NULLOK SV *sstr
 Apd    |void   |sv_chop        |NN SV *const sv|NULLOK const char *const ptr
 : Used only in perl.c
 pd     |I32    |sv_clean_all
@@ -1903,7 +1905,7 @@ Apd       |void   |sv_setpv       |NN SV *const sv|NULLOK const char *const ptr
 Apd    |void   |sv_setpvn      |NN SV *const sv|NULLOK const char *const ptr|const STRLEN len
 Apd    |char  *|sv_setpv_bufsize|NN SV *const sv|const STRLEN cur|const STRLEN len
 Xp     |void   |sv_sethek      |NN SV *const sv|NULLOK const HEK *const hek
-ApMdb  |void   |sv_setsv       |NN SV *dstr|NULLOK SV *sstr
+ApMdb  |void   |sv_setsv       |NN SV *dsv|NULLOK SV *ssv
 CpMdb  |void   |sv_taint       |NN SV* sv
 CpdR   |bool   |sv_tainted     |NN SV *const sv
 Apd    |int    |sv_unmagic     |NN SV *const sv|const int type
@@ -1959,7 +1961,7 @@ Cp        |I32    |regexec_flags  |NN REGEXP *const rx|NN char *stringarg \
                                |NN char *strend|NN char *strbeg \
                                |SSize_t minend|NN SV *sv \
                                |NULLOK void *data|U32 flags
-ApR    |regnode*|regnext       |NULLOK regnode* p
+CpR    |regnode*|regnext       |NULLOK regnode* p
 EXp    |SV*|reg_named_buff          |NN REGEXP * const rx|NULLOK SV * const key \
                                  |NULLOK SV * const value|const U32 flags
 EXp    |SV*|reg_named_buff_iter     |NN REGEXP * const rx|NULLOK const SV * const lastkey \
@@ -2341,7 +2343,7 @@ EXTp      |UV     |_to_fold_latin1|const U8 c|NN U8 *p|NN STRLEN *lenp|const unsigned int
 EpX    |SV*    |invlist_clone  |NN SV* const invlist|NULLOK SV* newlist
 #endif
 #if defined(PERL_IN_REGCOMP_C) || defined(PERL_IN_TOKE_C)
-EiRT   |bool   |regcurly       |NN const char *s
+EXpRT  |bool   |regcurly       |NN const char *s
 #endif
 #if defined(PERL_IN_REGEXEC_C)
 ERS    |bool   |isFOO_utf8_lc  |const U8 classnum|NN const U8* character|NN const U8* e
@@ -2651,14 +2653,14 @@ ATpa    |Malloc_t|safesyscalloc |MEM_SIZE elements|MEM_SIZE size
 ATpR   |Malloc_t|safesysrealloc|Malloc_t where|MEM_SIZE nbytes
 ATp    |Free_t |safesysfree    |Malloc_t where
 CrTp   |void   |croak_memory_wrap
-Ap     |int    |runops_standard
-Ap     |int    |runops_debug
+Cp     |int    |runops_standard
+Cp     |int    |runops_debug
 Afpd   |void   |sv_catpvf_mg   |NN SV *const sv|NN const char *const pat|...
 Apd    |void   |sv_vcatpvf_mg  |NN SV *const sv|NN const char *const pat \
                                |NULLOK va_list *const args
-Apd    |void   |sv_catpv_mg    |NN SV *const sv|NULLOK const char *const ptr
-ApdbM  |void   |sv_catpvn_mg   |NN SV *sv|NN const char *ptr|STRLEN len
-ApdbM  |void   |sv_catsv_mg    |NN SV *dsv|NULLOK SV *ssv
+Apd    |void   |sv_catpv_mg    |NN SV *const dsv|NULLOK const char *const sstr
+ApdbM  |void   |sv_catpvn_mg   |NN SV *dsv|NN const char *sstr|STRLEN len
+ApdbM  |void   |sv_catsv_mg    |NN SV *dsv|NULLOK SV *sstr
 Afpd   |void   |sv_setpvf_mg   |NN SV *const sv|NN const char *const pat|...
 Apd    |void   |sv_vsetpvf_mg  |NN SV *const sv|NN const char *const pat \
                                |NULLOK va_list *const args
@@ -2668,7 +2670,7 @@ Apd       |void   |sv_setuv_mg    |NN SV *const sv|const UV u
 Apd    |void   |sv_setnv_mg    |NN SV *const sv|const NV num
 Apd    |void   |sv_setpv_mg    |NN SV *const sv|NULLOK const char *const ptr
 Apd    |void   |sv_setpvn_mg   |NN SV *const sv|NN const char *const ptr|const STRLEN len
-Apd    |void   |sv_setsv_mg    |NN SV *const dstr|NULLOK SV *const sstr
+Apd    |void   |sv_setsv_mg    |NN SV *const dsv|NULLOK SV *const ssv
 ApdbM  |void   |sv_usepvn_mg   |NN SV *sv|NULLOK char *ptr|STRLEN len
 ApR    |MGVTBL*|get_vtbl       |int vtbl_id
 Apd    |char*  |pv_display     |NN SV *dsv|NN const char *pv|STRLEN cur|STRLEN len \
@@ -2698,7 +2700,7 @@ Ap        |void   |do_pmop_dump   |I32 level|NN PerlIO *file|NULLOK const PMOP *pm
 Ap     |void   |do_sv_dump     |I32 level|NN PerlIO *file|NULLOK SV *sv|I32 nest \
                                |I32 maxnest|bool dumpops|STRLEN pvlim
 Ap     |void   |magic_dump     |NULLOK const MAGIC *mg
-Ap     |void   |reginitcolors
+Cp     |void   |reginitcolors
 CpdRMb |char*  |sv_2pv_nolen   |NN SV* sv
 CpdRMb |char*  |sv_2pvutf8_nolen|NN SV* sv
 CpdRMb |char*  |sv_2pvbyte_nolen|NN SV* sv
@@ -2725,6 +2727,10 @@ AiMdp    |void   |SvREFCNT_dec   |NULLOK SV *sv
 AiMdp  |void   |SvREFCNT_dec_NN|NN SV *sv
 AiTp   |void   |SvAMAGIC_on    |NN SV *sv
 AiTp   |void   |SvAMAGIC_off   |NN SV *sv
+Aipd   |bool   |SvTRUE         |NULLOK SV *sv
+Aipd   |bool   |SvTRUE_nomg    |NULLOK SV *sv
+Aipd   |bool   |SvTRUE_NN      |NN SV *sv
+Cip    |bool   |SvTRUE_common  |NN SV *sv|const bool sv_2bool_is_fallback
 : This is indirectly referenced by globals.c. This is somewhat annoying.
 p      |int    |magic_killbackrefs|NN SV *sv|NN MAGIC *mg
 Ap     |OP*    |newANONATTRSUB |I32 floor|NULLOK OP *proto|NULLOK OP *attrs|NULLOK OP *block
@@ -2738,7 +2744,7 @@ p |CV*    |newSTUB        |NN GV *gv|bool fake
 : Used in perly.y
 p      |OP *   |my_attrs       |NN OP *o|NULLOK OP *attrs
 #if defined(USE_ITHREADS)
-ApR    |PERL_CONTEXT*|cx_dup   |NULLOK PERL_CONTEXT* cx|I32 ix|I32 max|NN CLONE_PARAMS* param
+CpR    |PERL_CONTEXT*|cx_dup   |NULLOK PERL_CONTEXT* cx|I32 ix|I32 max|NN CLONE_PARAMS* param
 ApR    |PERL_SI*|si_dup        |NULLOK PERL_SI* si|NN CLONE_PARAMS* param
 ApR    |ANY*   |ss_dup         |NN PerlInterpreter* proto_perl|NN CLONE_PARAMS* param
 ApR    |void*  |any_dup        |NULLOK void* v|NN const PerlInterpreter* proto_perl
@@ -2753,13 +2759,13 @@ ApR     |MAGIC* |mg_dup         |NULLOK MAGIC *mg|NN CLONE_PARAMS *const param
 #if defined(PERL_IN_SV_C)
 S      |SV **  |sv_dup_inc_multiple|NN SV *const *source|NN SV **dest \
                                |SSize_t items|NN CLONE_PARAMS *const param
-SR     |SV*    |sv_dup_common  |NN const SV *const sstr \
+SR     |SV*    |sv_dup_common  |NN const SV *const ssv \
                                |NN CLONE_PARAMS *const param
 #endif
-ApR    |SV*    |sv_dup         |NULLOK const SV *const sstr|NN CLONE_PARAMS *const param
-ApR    |SV*    |sv_dup_inc     |NULLOK const SV *const sstr \
+ApR    |SV*    |sv_dup         |NULLOK const SV *const ssv|NN CLONE_PARAMS *const param
+ApR    |SV*    |sv_dup_inc     |NULLOK const SV *const ssv \
                                |NN CLONE_PARAMS *const param
-Ap     |void   |rvpv_dup       |NN SV *const dstr|NN const SV *const sstr|NN CLONE_PARAMS *const param
+Ap     |void   |rvpv_dup       |NN SV *const dsv|NN const SV *const ssv|NN CLONE_PARAMS *const param
 Ap     |yy_parser*|parser_dup  |NULLOK const yy_parser *const proto|NN CLONE_PARAMS *const param
 #endif
 ApR    |PTR_TBL_t*|ptr_table_new
@@ -3100,7 +3106,7 @@ S |void   |assert_uft8_cache_coherent|NN const char *const func \
 ST     |char * |F0convert      |NV nv|NN char *const endbuf|NN STRLEN *const len
 S      |SV *   |more_sv
 S      |bool   |sv_2iuv_common |NN SV *const sv
-S      |void   |glob_assign_glob|NN SV *const dstr|NN SV *const sstr \
+S      |void   |glob_assign_glob|NN SV *const dsv|NN SV *const ssv \
                |const int dtype
 SRT    |PTR_TBL_ENT_t *|ptr_table_find|NN PTR_TBL_t *const tbl|NULLOK const void *const sv
 S      |void   |anonymise_cv_maybe     |NN GV *gv|NN CV *cv
@@ -3291,12 +3297,12 @@ iR      |bool   |is_utf8_common |NN const U8 *const p                       \
 EXiTp  |void   |append_utf8_from_native_byte|const U8 byte|NN U8** dest
 
 Apd    |void   |sv_set_undef   |NN SV *sv
-Apd    |void   |sv_setsv_flags |NN SV *dstr|NULLOK SV *sstr|const I32 flags
-Apd    |void   |sv_catpvn_flags|NN SV *const dstr|NN const char *sstr|const STRLEN len \
+Apd    |void   |sv_setsv_flags |NN SV *dsv|NULLOK SV *ssv|const I32 flags
+Apd    |void   |sv_catpvn_flags|NN SV *const dsv|NN const char *sstr|const STRLEN len \
                                |const I32 flags
-Apd    |void   |sv_catpv_flags |NN SV *dstr|NN const char *sstr \
+Apd    |void   |sv_catpv_flags |NN SV *dsv|NN const char *sstr \
                                |const I32 flags
-Apd    |void   |sv_catsv_flags |NN SV *const dsv|NULLOK SV *const ssv|const I32 flags
+Apd    |void   |sv_catsv_flags |NN SV *const dsv|NULLOK SV *const sstr|const I32 flags
 Amd    |STRLEN |sv_utf8_upgrade_flags|NN SV *const sv|const I32 flags
 Adp    |STRLEN |sv_utf8_upgrade_flags_grow|NN SV *const sv|const I32 flags|STRLEN extra
 Apd    |char*  |sv_pvn_force_flags|NN SV *const sv|NULLOK STRLEN *const lp|const U32 flags
@@ -3309,7 +3315,7 @@ ApT       |int    |my_socketpair  |int family|int type|int protocol|int fd[2]
 ApT    |int    |my_dirfd       |NULLOK DIR* dir
 #ifdef PERL_ANY_COW
 : Used in regexec.c
-pxXE   |SV*    |sv_setsv_cow   |NULLOK SV* dstr|NN SV* sstr
+pxXE   |SV*    |sv_setsv_cow   |NULLOK SV* dsv|NN SV* ssv
 #endif
 
 Aop    |const char *|PerlIO_context_layers|NULLOK const char *mode
@@ -3416,7 +3422,7 @@ Apd       |CV*    |cv_clone       |NN CV* proto
 p      |CV*    |cv_clone_into  |NN CV* proto|NN CV *target
 pd     |void   |pad_fixup_inner_anons|NN PADLIST *padlist|NN CV *old_cv|NN CV *new_cv
 pdX    |void   |pad_push       |NN PADLIST *padlist|int depth
-ApbdRM |HV*    |pad_compname_type|const PADOFFSET po
+ApbdDR |HV*    |pad_compname_type|const PADOFFSET po
 AxpdRT |PADNAME *|padnamelist_fetch|NN PADNAMELIST *pnl|SSize_t key
 Xop    |void   |padnamelist_free|NN PADNAMELIST *pnl
 Axpd   |PADNAME **|padnamelist_store|NN PADNAMELIST *pnl|SSize_t key \
@@ -3553,7 +3559,7 @@ XExop     |void   |emulate_cop_io |NN const COP *const c|NN SV *const sv
 : Used by SvRX and SvRXOK
 XExop  |REGEXP *|get_re_arg|NULLOK SV *sv
 
-Aopdh  |SV*    |mro_get_private_data|NN struct mro_meta *const smeta \
+Coph   |SV*    |mro_get_private_data|NN struct mro_meta *const smeta \
                                     |NN const struct mro_alg *const which
 Aopdh  |SV*    |mro_set_private_data|NN struct mro_meta *const smeta \
                                     |NN const struct mro_alg *const which \
@@ -3658,4 +3664,8 @@ XEop      |void   |dtrace_probe_phase|enum perl_phase phase
 
 XEop   |STRLEN*|dup_warnings   |NULLOK STRLEN* warnings
 
+#ifndef USE_ITHREADS
+Amd    |void   |CopFILEGV_set  |NN COP * c|NN GV * gv
+#endif
+
 : ex: set ts=8 sts=4 sw=4 noet: