diff options
author | Karl Williamson <khw@cpan.org> | 2020-09-06 11:04:52 -0600 |
---|---|---|
committer | Karl Williamson <khw@cpan.org> | 2020-12-06 09:04:10 -0700 |
commit | 574e093e57e1827b81a7bf2268758cd1af293649 (patch) | |
tree | e20ace9f7b90204b4ddae51d7d8f23d08949b039 | |
parent | 4eff5eb8fa96cf12671631ada42a7f7a00d51c5b (diff) | |
download | perl-574e093e57e1827b81a7bf2268758cd1af293649.tar.gz |
perlapi: Consolidate SvSET-ish entries
These should also be in the SV section instead of Magic
-rw-r--r-- | sv.h | 23 |
1 files changed, 13 insertions, 10 deletions
@@ -2094,7 +2094,7 @@ incremented. /* the following macros update any magic values this C<sv> is associated with */ /* -=for apidoc_section $magic +=for apidoc_section $SV =for apidoc Am|void|SvGETMAGIC|SV* sv Invokes C<L</mg_get>> on an SV if it has 'get' magic. For example, this @@ -2108,18 +2108,21 @@ or a tied variable (it calls C<STORE>). This macro evaluates its argument more than once. =for apidoc Am|void|SvSetSV|SV* dsv|SV* ssv -Calls C<sv_setsv> if C<dsv> is not the same as C<ssv>. May evaluate arguments -more than once. Does not handle 'set' magic on the destination SV. +=for apidoc_item SvSetMagicSV +=for apidoc_item SvSetSV_nosteal +=for apidoc_item SvSetMagicSV_nosteal + +if C<dsv> is the same as C<ssv>, these do nothing. Otherwise they all call +some form of C<L</sv_setsv>>. They may evaluate their arguments more than +once. -=for apidoc Am|void|SvSetSV_nosteal|SV* dsv|SV* ssv -Calls a non-destructive version of C<sv_setsv> if C<dsv> is not the same as -C<ssv>. May evaluate arguments more than once. +The only differences are: -=for apidoc Am|void|SvSetMagicSV|SV* dsv|SV* ssv -Like C<SvSetSV>, but does any set magic required afterwards. +C<SvSetMagicSV> and C<SvSetMagicSV_nosteal> perform any required 'set' magic +afterwards on the destination SV; C<SvSetSV> and C<SvSetSV_nosteal> do not. -=for apidoc Am|void|SvSetMagicSV_nosteal|SV* dsv|SV* ssv -Like C<SvSetSV_nosteal>, but does any set magic required afterwards. +C<SvSetSV_nosteal> C<SvSetMagicSV_nosteal> call a non-destructive version of +C<sv_setsv>. =for apidoc Am|void|SvSHARE|SV* sv Arranges for C<sv> to be shared between threads if a suitable module |