This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Move api items to perlintern where macro should instead be used
authorKarl Williamson <khw@cpan.org>
Thu, 18 Jun 2020 00:54:06 +0000 (18:54 -0600)
committerKarl Williamson <khw@cpan.org>
Sat, 18 Jul 2020 03:44:08 +0000 (21:44 -0600)
There are some items in perlapi whose entries say "don't use this;
instead use the macro equivalent".  Such items really shouldn't be in
perlapi, but instead be in perlintern.

embed.fnc

index 589ab1a..2b03a94 100644 (file)
--- a/embed.fnc
+++ b/embed.fnc
@@ -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
 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
 #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
 : 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 \
 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
 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 \
 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
 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
 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
 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    |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\
 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\
@@ -2601,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
                                |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
 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
@@ -3293,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
                                |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
 Apd    |void   |pad_setsv      |PADOFFSET po|NN SV* sv
 #endif
 pd     |void   |pad_block_start|int full