This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
embed.fnc: Reorder some comments
[perl5.git] / embed.fnc
index 09fce2a..31fb827 100644 (file)
--- a/embed.fnc
+++ b/embed.fnc
 :      pod, such as perlguts or warnings.h.  This flag is useful for downstream
 :      programs, such as Devel::PPPort.
 :
-:   I  This flag works exactly the same as 'i' but it also adds
-:      __attribute__((always_inline)) or __forceinline if either of them is
-:      supported by the compiler.
-:
-:         proto.h: function is declared as PERL_STATIC_FORCE_INLINE and
-:                  __attribute__always_inline__ is added
-:
 :   i  inline static.  This is used for functions that the compiler is being
 :      requested to inline.  If the function is in a header file its
 :      definition will be visible (unless guarded by #if..#endif) to all
 :
 :         proto.h: function is declared as PERL_STATIC_INLINE
 :
+:   I  This flag works exactly the same as 'i' but it also adds
+:      __attribute__((always_inline)) or __forceinline if either of them is
+:      supported by the compiler.
+:
+:         proto.h: function is declared as PERL_STATIC_FORCE_INLINE and
+:                  __attribute__always_inline__ is added
+:
 :   m  Implemented as a macro; there is no function associated with this name,
 :      and hence no long Perl_ or S_ name.  However, if the macro name itself
 :      begins with 'Perl_', autodoc.pl will show a thread context parameter
@@ -1649,8 +1649,8 @@ Ap        |I32    |start_subparse |I32 is_format|U32 flags
 Xp     |void   |init_named_cv  |NN CV *cv|NN OP *nameop
 : Used in pp_ctl.c
 p      |void   |sub_crush_depth|NN CV* cv
-ApbMd  |bool   |sv_2bool       |NN SV *const sv
-Apd    |bool   |sv_2bool_flags |NN SV *sv|I32 flags
+CpbMd  |bool   |sv_2bool       |NN SV *const sv
+Cpd    |bool   |sv_2bool_flags |NN SV *sv|I32 flags
 Apd    |CV*    |sv_2cv         |NULLOK SV* sv|NN HV **const st|NN GV **const gvp \
                                |const I32 lref
 Apd    |IO*    |sv_2io         |NN SV *const sv
@@ -1672,13 +1672,13 @@ Ap      |char*  |sv_2pvbyte_flags       |NN SV *sv|NULLOK STRLEN *const lp|const U32 flags
 AbpD   |char*  |sv_pvn_nomg    |NN SV* sv|NULLOK STRLEN* lp
 ApMb   |UV     |sv_2uv         |NN SV *sv
 Apd    |UV     |sv_2uv_flags   |NN SV *const sv|const I32 flags
-AbpdD  |IV     |sv_iv          |NN SV* sv
-AbpdD  |UV     |sv_uv          |NN SV* sv
-AbpdD  |NV     |sv_nv          |NN SV* sv
-AbpdD  |char*  |sv_pvn         |NN SV *sv|NN STRLEN *lp
-AbpdD  |char*  |sv_pvutf8n     |NN SV *sv|NN STRLEN *lp
-AbpdD  |char*  |sv_pvbyten     |NN SV *sv|NN STRLEN *lp
-Apd    |I32    |sv_true        |NULLOK SV *const sv
+CbpdD  |IV     |sv_iv          |NN SV* sv
+CbpdD  |UV     |sv_uv          |NN SV* sv
+CbpdD  |NV     |sv_nv          |NN SV* sv
+CbpdD  |char*  |sv_pvn         |NN SV *sv|NN STRLEN *lp
+CbpdD  |char*  |sv_pvutf8n     |NN SV *sv|NN STRLEN *lp
+CbpdD  |char*  |sv_pvbyten     |NN SV *sv|NN STRLEN *lp
+Cpd    |I32    |sv_true        |NULLOK SV *const sv
 #if defined(PERL_IN_SV_C)
 Sd     |void   |sv_add_arena   |NN char *const ptr|const U32 size \
                                |const U32 flags
@@ -1738,7 +1738,7 @@ poxX      |void   |sv_free2       |NN SV *const sv|const U32 refcnt
 : Used only in perl.c
 pd     |void   |sv_free_arenas
 Apd    |char*  |sv_gets        |NN SV *const sv|NN PerlIO *const fp|I32 append
-Apd    |char*  |sv_grow        |NN SV *const sv|STRLEN newlen
+Cpd    |char*  |sv_grow        |NN SV *const sv|STRLEN newlen
 Apd    |void   |sv_inc         |NULLOK SV *const sv
 Apd    |void   |sv_inc_nomg    |NULLOK SV *const sv
 ApMdb  |void   |sv_insert      |NN SV *const bigstr|const STRLEN offset \
@@ -1762,7 +1762,7 @@ EXp       |MAGIC *|sv_magicext_mglob|NN SV *sv
 ApdbMR |SV*    |sv_mortalcopy  |NULLOK SV *const oldsv
 ApdR   |SV*    |sv_mortalcopy_flags|NULLOK SV *const oldsv|U32 flags
 ApdR   |SV*    |sv_newmortal
-Apd    |SV*    |sv_newref      |NULLOK SV *const sv
+Cpd    |SV*    |sv_newref      |NULLOK SV *const sv
 Ap     |char*  |sv_peek        |NULLOK SV* sv
 Apd    |void   |sv_pos_u2b     |NULLOK SV *const sv|NN I32 *const offsetp|NULLOK I32 *const lenp
 Apd    |STRLEN |sv_pos_u2b_flags|NN SV *const sv|STRLEN uoffset \
@@ -1770,9 +1770,9 @@ Apd       |STRLEN |sv_pos_u2b_flags|NN SV *const sv|STRLEN uoffset \
 Apd    |void   |sv_pos_b2u     |NULLOK SV *const sv|NN I32 *const offsetp
 Apd    |STRLEN |sv_pos_b2u_flags|NN SV *const sv|STRLEN const offset \
                                 |U32 flags
-ApMdb  |char*  |sv_pvn_force   |NN SV* sv|NULLOK STRLEN* lp
-Apd    |char*  |sv_pvutf8n_force|NN SV *const sv|NULLOK STRLEN *const lp
-Apd    |char*  |sv_pvbyten_force|NN SV *const sv|NULLOK STRLEN *const lp
+CpMdb  |char*  |sv_pvn_force   |NN SV* sv|NULLOK STRLEN* lp
+Cpd    |char*  |sv_pvutf8n_force|NN SV *const sv|NULLOK STRLEN *const lp
+Cpd    |char*  |sv_pvbyten_force|NN SV *const sv|NULLOK STRLEN *const lp
 Apd    |char*  |sv_recode_to_utf8      |NN SV* sv|NN SV *encoding
 Apd    |bool   |sv_cat_decode  |NN SV* dsv|NN SV *encoding|NN SV *ssv|NN int *offset \
                                |NN char* tstr|int tlen
@@ -1801,13 +1801,13 @@ Apd     |void   |sv_setpvn      |NN SV *const sv|NULLOK const char *const ptr|const STRLEN
 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_taint       |NN SV* sv
-ApdR   |bool   |sv_tainted     |NN SV *const sv
+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
 Apd    |int    |sv_unmagicext  |NN SV *const sv|const int type|NULLOK MGVTBL *vtbl
 ApdMb  |void   |sv_unref       |NN SV* sv
 Apd    |void   |sv_unref_flags |NN SV *const ref|const U32 flags
-Apd    |void   |sv_untaint     |NN SV *const sv
+Cpd    |void   |sv_untaint     |NN SV *const sv
 Apd    |void   |sv_upgrade     |NN SV *const sv|svtype new_type
 ApdMb  |void   |sv_usepvn      |NN SV* sv|NULLOK char* ptr|STRLEN len
 Apd    |void   |sv_usepvn_flags|NN SV *const sv|NULLOK char* ptr|const STRLEN len\
@@ -1899,7 +1899,7 @@ ES        |void   |change_engine_size|NN RExC_state_t *pRExC_state|const Ptrdiff_t size
 ES     |regnode_offset|reganode|NN RExC_state_t *pRExC_state|U8 op \
                                |U32 arg
 ES     |regnode_offset|regpnode|NN RExC_state_t *pRExC_state|U8 op \
-                               |NN void * arg
+                               |NN SV * arg
 ES     |regnode_offset|reg2Lanode|NN RExC_state_t *pRExC_state            \
                                |const U8 op                               \
                                |const U32 arg1                            \
@@ -1933,6 +1933,7 @@ ES        |SV *   |parse_uniprop_string|NN const char * const name            \
                                     |const bool to_fold                    \
                                     |const bool runtime                    \
                                     |const bool deferrable                 \
+                                    |NULLOK AV ** strings                  \
                                     |NN bool * user_defined_ptr            \
                                     |NN SV * msg                           \
                                     |const STRLEN level
@@ -1954,7 +1955,8 @@ ES        |I32    |execute_wildcard|NN REGEXP * const prog|NN char* stringarg \
 ES     |bool   |handle_names_wildcard                                      \
                                |NN const char * wname                      \
                                |const STRLEN wname_len                     \
-                               |NN SV ** prop_definition
+                               |NN SV ** prop_definition                   \
+                               |NN AV ** strings
 ES     |void|add_above_Latin1_folds|NN RExC_state_t *pRExC_state|const U8 cp \
                                |NN SV** invlist
 ES     |regnode_offset|handle_named_backref|NN RExC_state_t *pRExC_state   \
@@ -2043,7 +2045,8 @@ ES        |SSize_t|study_chunk    |NN RExC_state_t *pRExC_state \
                                |NULLOK struct scan_data_t *data \
                                 |I32 stopparen|U32 recursed_depth \
                                |NULLOK regnode_ssc *and_withp \
-                               |U32 flags|U32 depth
+                               |U32 flags|U32 depth|bool was_mutate_ok
+ES     |void   |rck_elide_nothing|NN regnode *node
 ESR    |SV *   |get_ANYOFM_contents|NN const regnode * n
 ESRT   |U32    |add_data       |NN RExC_state_t* const pRExC_state \
                                |NN const char* const s|const U32 n
@@ -2598,12 +2601,12 @@ 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
-ApdRMb |char*  |sv_2pv_nolen   |NN SV* sv
-ApdRMb |char*  |sv_2pvutf8_nolen|NN SV* sv
-ApdRMb |char*  |sv_2pvbyte_nolen|NN SV* sv
-ApMdbR |char*  |sv_pv          |NN SV *sv
-ApMdbR |char*  |sv_pvutf8      |NN SV *sv
-ApMdbR |char*  |sv_pvbyte      |NN SV *sv
+CpdRMb |char*  |sv_2pv_nolen   |NN SV* sv
+CpdRMb |char*  |sv_2pvutf8_nolen|NN SV* sv
+CpdRMb |char*  |sv_2pvbyte_nolen|NN SV* sv
+CpMdbR |char*  |sv_pv          |NN SV *sv
+CpMdbR |char*  |sv_pvutf8      |NN SV *sv
+CpMdbR |char*  |sv_pvbyte      |NN SV *sv
 ApMdb  |STRLEN |sv_utf8_upgrade|NN SV *sv
 Amd    |STRLEN |sv_utf8_upgrade_nomg|NN SV *sv
 ApdMb  |bool   |sv_utf8_downgrade|NN SV *const sv|const bool fail_ok
@@ -3290,7 +3293,7 @@ Sd        |PADOFFSET|pad_findlex  |NN const char *namepv|STRLEN namelen|U32 flags \
                                |NN PADNAME** out_name|NN int *out_flags
 #endif
 #ifdef DEBUGGING
-Apd    |SV*    |pad_sv         |PADOFFSET po
+Cpd    |SV*    |pad_sv         |PADOFFSET po
 Apd    |void   |pad_setsv      |PADOFFSET po|NN SV* sv
 #endif
 pd     |void   |pad_block_start|int full