diff options
| -rw-r--r-- | cop.h | 22 | ||||
| -rw-r--r-- | gv.c | 8 | ||||
| -rw-r--r-- | handy.h | 203 | ||||
| -rw-r--r-- | perl.c | 4 | ||||
| -rw-r--r-- | perl.h | 14 | ||||
| -rw-r--r-- | pod/perlguts.pod | 10 | ||||
| -rw-r--r-- | pod/perlreapi.pod | 24 | ||||
| -rw-r--r-- | scope.h | 2 | ||||
| -rw-r--r-- | sv.c | 24 | ||||
| -rw-r--r-- | sv.h | 114 | ||||
| -rw-r--r-- | sv_inline.h | 12 |
11 files changed, 219 insertions, 218 deletions
@@ -175,8 +175,8 @@ typedef struct refcounted_he COPHH; #define COPHH_EXISTS REFCOUNTED_HE_EXISTS /* -=for apidoc Amx|SV *|cophh_fetch_pvn|const COPHH *cophh|const char *key|STRLEN keylen|U32 hash|U32 flags -=for apidoc_item|SV *|cophh_fetch_pv |const COPHH *cophh|const char *key |U32 hash|U32 flags +=for apidoc Amx|SV *|cophh_fetch_pv |const COPHH *cophh|const char *key |U32 hash|U32 flags +=for apidoc_item|SV *|cophh_fetch_pvn|const COPHH *cophh|const char *key|STRLEN keylen|U32 hash|U32 flags =for apidoc_item|SV *|cophh_fetch_pvs|const COPHH *cophh| "key" |U32 flags =for apidoc_item|SV *|cophh_fetch_sv |const COPHH *cophh| SV *key |U32 hash|U32 flags @@ -310,8 +310,8 @@ Generate and return a fresh cop hints hash containing no entries. #define cophh_new_empty() ((COPHH *)NULL) /* -=for apidoc Amx|COPHH *|cophh_store_pvn|COPHH *cophh|const char *key|STRLEN keylen|U32 hash|SV *value|U32 flags -=for apidoc_item|COPHH *|cophh_store_pv |COPHH *cophh|const char *key |U32 hash|SV *value|U32 flags +=for apidoc Amx|COPHH *|cophh_store_pv |COPHH *cophh|const char *key |U32 hash|SV *value|U32 flags +=for apidoc_item|COPHH *|cophh_store_pvn|COPHH *cophh|const char *key|STRLEN keylen|U32 hash|SV *value|U32 flags =for apidoc_item|COPHH *|cophh_store_pvs|COPHH *cophh| "key" |SV *value|U32 flags =for apidoc_item|COPHH *|cophh_store_sv |COPHH *cophh| SV *key |U32 hash|SV *value|U32 flags @@ -362,8 +362,8 @@ the octets. Perl_refcounted_he_new_sv(aTHX_ cophh, key, hash, value, flags) /* -=for apidoc Amx|COPHH *|cophh_delete_pvn|COPHH *cophh|const char *key|STRLEN keylen|U32 hash|U32 flags -=for apidoc_item|COPHH *|cophh_delete_pv |COPHH *cophh|const char *key |U32 hash|U32 flags +=for apidoc Amx|COPHH *|cophh_delete_pv |COPHH *cophh|const char *key |U32 hash|U32 flags +=for apidoc_item|COPHH *|cophh_delete_pvn|COPHH *cophh|const char *key|STRLEN keylen|U32 hash|U32 flags =for apidoc_item|COPHH *|cophh_delete_pvs|COPHH *cophh| "key" |U32 flags =for apidoc_item|COPHH *|cophh_delete_sv |COPHH *cophh| SV *key |U32 hash|U32 flags @@ -540,9 +540,9 @@ string C<p>, creating the package if necessary. #define CopHINTHASH_set(c,h) ((c)->cop_hints_hash = (h)) /* -=for apidoc Am|SV *|cop_hints_fetch_pvn|const COP *cop|const char *key|STRLEN keylen|U32 hash|U32 flags -=for apidoc_item|SV *|cop_hints_fetch_pv |const COP *cop|const char *key |U32 hash|U32 flags -=for apidoc_item|SV *|cop_hints_fetch_pvs|const COP *cop| "key" |U32 flags +=for apidoc Am|SV *|cop_hints_fetch_pv |const COP *cop|const char *key |U32 hash|U32 flags +=for apidoc_item|SV *|cop_hints_fetch_pvn|const COP *cop|const char *key|STRLEN keylen|U32 hash|U32 flags +=for apidoc_item|SV *|cop_hints_fetch_pvs|const COP *cop| "key" |U32 flags =for apidoc_item|SV *|cop_hints_fetch_sv |const COP *cop| SV *key |U32 hash|U32 flags These look up the hint entry in the cop C<cop> with the key specified by @@ -584,8 +584,8 @@ the octets. cophh_fetch_sv(CopHINTHASH_get(cop), key, hash, flags) /* -=for apidoc Am|bool|cop_hints_exists_pvn|const COP *cop|const char *key|STRLEN keylen|U32 hash|U32 flags -=for apidoc_item|bool|cop_hints_exists_pv |const COP *cop|const char *key |U32 hash|U32 flags +=for apidoc Am|bool|cop_hints_exists_pv |const COP *cop|const char *key|U32 hash |U32 flags +=for apidoc_item|bool|cop_hints_exists_pvn|const COP *cop|const char *key|STRLEN keylen|U32 hash|U32 flags =for apidoc_item|bool|cop_hints_exists_pvs|const COP *cop| "key" |U32 flags =for apidoc_item|bool|cop_hints_exists_sv |const COP *cop| SV *key |U32 hash|U32 flags @@ -2563,8 +2563,8 @@ to C<gv_fetchsv> makes it behave identically to C<gv_fetchsv_nomg>. =for apidoc Amnh||GV_ADDMG =for apidoc Amnh||GV_ADDMULTI =for apidoc Amnh||GV_ADDWARN -=for apidoc Amnh||GV_NOADD_NOINIT =for apidoc Amnh||GV_NOINIT +=for apidoc Amnh||GV_NOADD_NOINIT =for apidoc Amnh||GV_NOTQUAL =for apidoc Amnh||GV_NO_SVGMAGIC =for apidoc Amnh||SVf_UTF8 @@ -2708,10 +2708,10 @@ Perl_gv_fetchpvn_flags(pTHX_ const char *nambeg, STRLEN full_len, I32 flags, } /* -=for apidoc gv_fullname3 -=for apidoc_item gv_fullname4 -=for apidoc_item gv_efullname3 +=for apidoc gv_efullname3 =for apidoc_item gv_efullname4 +=for apidoc_item gv_fullname3 +=for apidoc_item gv_fullname4 Place the full package name of C<gv> into C<sv>. The C<gv_e*> forms return instead the effective package name (see L</HvENAME>). @@ -70,13 +70,13 @@ from it, and are very unlikely to change /* =for apidoc_section $SV -=for apidoc Am|void *|MUTABLE_PTR|void * p -=for apidoc_item |AV *|MUTABLE_AV|AV * p -=for apidoc_item |CV *|MUTABLE_CV|CV * p -=for apidoc_item |GV *|MUTABLE_GV|GV * p -=for apidoc_item |HV *|MUTABLE_HV|HV * p -=for apidoc_item |IO *|MUTABLE_IO|IO * p -=for apidoc_item |SV *|MUTABLE_SV|SV * p +=for apidoc Am |AV * |MUTABLE_AV |AV * p +=for apidoc_item |CV * |MUTABLE_CV |CV * p +=for apidoc_item |GV * |MUTABLE_GV |GV * p +=for apidoc_item |HV * |MUTABLE_HV |HV * p +=for apidoc_item |IO * |MUTABLE_IO |IO * p +=for apidoc_item |void *|MUTABLE_PTR|void * p +=for apidoc_item |SV * |MUTABLE_SV |SV * p The C<MUTABLE_I<*>>() macros cast pointers to the types shown, in such a way (compiler permitting) that casting away const-ness will give a warning; @@ -485,11 +485,11 @@ Perl_xxx(aTHX_ ...) form for any API calls where it's used. /* =for apidoc_section $versioning =for apidoc AmR|bool|PERL_VERSION_EQ|const U8 major|const U8 minor|const U8 patch -=for apidoc_item PERL_VERSION_NE -=for apidoc_item PERL_VERSION_LT -=for apidoc_item PERL_VERSION_LE -=for apidoc_item PERL_VERSION_GT =for apidoc_item PERL_VERSION_GE +=for apidoc_item PERL_VERSION_GT +=for apidoc_item PERL_VERSION_LE +=for apidoc_item PERL_VERSION_LT +=for apidoc_item PERL_VERSION_NE Returns whether or not the perl currently being compiled has the specified relationship to the perl given by the parameters. For example, @@ -808,13 +808,13 @@ future releases. =for apidoc Am|bool|isALPHA|UV ch =for apidoc_item ||isALPHA_A|UV ch -=for apidoc_item ||isALPHA_L1|UV ch -=for apidoc_item ||isALPHA_uvchr|UV ch -=for apidoc_item ||isALPHA_utf8_safe|U8 * s|U8 * end -=for apidoc_item ||isALPHA_utf8|U8 * s|U8 * end =for apidoc_item ||isALPHA_LC|UV ch -=for apidoc_item ||isALPHA_LC_uvchr|UV ch =for apidoc_item ||isALPHA_LC_utf8_safe|U8 * s| U8 *end +=for apidoc_item ||isALPHA_LC_uvchr|UV ch +=for apidoc_item ||isALPHA_L1|UV ch +=for apidoc_item ||isALPHA_utf8|U8 * s|U8 * end +=for apidoc_item ||isALPHA_utf8_safe|U8 * s|U8 * end +=for apidoc_item ||isALPHA_uvchr|UV ch Returns a boolean indicating whether the specified input is one of C<[A-Za-z]>, analogous to C<m/[[:alpha:]]/>. See the L<top of this section|/Character classification> for an explanation of @@ -827,13 +827,13 @@ that would be interested in them, such as Devel::PPPort =for apidoc Am|bool|isALPHANUMERIC|UV ch =for apidoc_item ||isALPHANUMERIC_A|UV ch -=for apidoc_item ||isALPHANUMERIC_L1|UV ch -=for apidoc_item ||isALPHANUMERIC_uvchr|UV ch -=for apidoc_item ||isALPHANUMERIC_utf8_safe|U8 * s|U8 * end -=for apidoc_item ||isALPHANUMERIC_utf8|U8 * s|U8 * end =for apidoc_item ||isALPHANUMERIC_LC|UV ch -=for apidoc_item ||isALPHANUMERIC_LC_uvchr|UV ch =for apidoc_item ||isALPHANUMERIC_LC_utf8_safe|U8 * s| U8 *end +=for apidoc_item ||isALPHANUMERIC_LC_uvchr|UV ch +=for apidoc_item ||isALPHANUMERIC_L1|UV ch +=for apidoc_item ||isALPHANUMERIC_utf8|U8 * s|U8 * end +=for apidoc_item ||isALPHANUMERIC_utf8_safe|U8 * s|U8 * end +=for apidoc_item ||isALPHANUMERIC_uvchr|UV ch Returns a boolean indicating whether the specified character is one of C<[A-Za-z0-9]>, analogous to C<m/[[:alnum:]]/>. See the L<top of this section|/Character classification> for an explanation of @@ -853,13 +853,13 @@ C language L<C<isalnum(3)>>. =for apidoc Am|bool|isASCII|UV ch =for apidoc_item ||isASCII_A|UV ch -=for apidoc_item ||isASCII_L1|UV ch -=for apidoc_item ||isASCII_uvchr|UV ch -=for apidoc_item ||isASCII_utf8_safe|U8 * s|U8 * end -=for apidoc_item ||isASCII_utf8|U8 * s|U8 * end =for apidoc_item ||isASCII_LC|UV ch -=for apidoc_item ||isASCII_LC_uvchr|UV ch =for apidoc_item ||isASCII_LC_utf8_safe|U8 * s| U8 *end +=for apidoc_item ||isASCII_LC_uvchr|UV ch +=for apidoc_item ||isASCII_L1|UV ch +=for apidoc_item ||isASCII_utf8|U8 * s|U8 * end +=for apidoc_item ||isASCII_utf8_safe|U8 * s|U8 * end +=for apidoc_item ||isASCII_uvchr|UV ch Returns a boolean indicating whether the specified character is one of the 128 characters in the ASCII character set, analogous to C<m/[[:ascii:]]/>. On non-ASCII platforms, it returns TRUE iff this @@ -879,13 +879,13 @@ C<isASCII_utf8_safe> will work properly on any string encoded or not in UTF-8. =for apidoc Am|bool|isBLANK|UV ch =for apidoc_item ||isBLANK_A|UV ch -=for apidoc_item ||isBLANK_L1|UV ch -=for apidoc_item ||isBLANK_uvchr|UV ch -=for apidoc_item ||isBLANK_utf8_safe|U8 * s|U8 * end -=for apidoc_item ||isBLANK_utf8|U8 * s|U8 * end =for apidoc_item ||isBLANK_LC|UV ch -=for apidoc_item ||isBLANK_LC_uvchr|UV ch =for apidoc_item ||isBLANK_LC_utf8_safe|U8 * s| U8 *end +=for apidoc_item ||isBLANK_LC_uvchr|UV ch +=for apidoc_item ||isBLANK_L1|UV ch +=for apidoc_item ||isBLANK_utf8|U8 * s|U8 * end +=for apidoc_item ||isBLANK_utf8_safe|U8 * s|U8 * end +=for apidoc_item ||isBLANK_uvchr|UV ch Returns a boolean indicating whether the specified character is a character considered to be a blank, analogous to C<m/[[:blank:]]/>. See the L<top of this section|/Character classification> for an explanation of @@ -897,13 +897,13 @@ the same as the corresponding ones without. =for apidoc Am|bool|isCNTRL|UV ch =for apidoc_item ||isCNTRL_A|UV ch -=for apidoc_item ||isCNTRL_L1|UV ch -=for apidoc_item ||isCNTRL_uvchr|UV ch -=for apidoc_item ||isCNTRL_utf8_safe|U8 * s|U8 * end -=for apidoc_item ||isCNTRL_utf8|U8 * s|U8 * end =for apidoc_item ||isCNTRL_LC|UV ch -=for apidoc_item ||isCNTRL_LC_uvchr|UV ch =for apidoc_item ||isCNTRL_LC_utf8_safe|U8 * s| U8 *end +=for apidoc_item ||isCNTRL_LC_uvchr|UV ch +=for apidoc_item ||isCNTRL_L1|UV ch +=for apidoc_item ||isCNTRL_utf8|U8 * s|U8 * end +=for apidoc_item ||isCNTRL_utf8_safe|U8 * s|U8 * end +=for apidoc_item ||isCNTRL_uvchr|UV ch Returns a boolean indicating whether the specified character is a control character, analogous to C<m/[[:cntrl:]]/>. @@ -913,13 +913,13 @@ On EBCDIC platforms, you almost always want to use the C<isCNTRL_L1> variant. =for apidoc Am|bool|isDIGIT|UV ch =for apidoc_item ||isDIGIT_A|UV ch -=for apidoc_item ||isDIGIT_L1|UV ch -=for apidoc_item ||isDIGIT_uvchr|UV ch -=for apidoc_item ||isDIGIT_utf8_safe|U8 * s|U8 * end -=for apidoc_item ||isDIGIT_utf8|U8 * s|U8 * end =for apidoc_item ||isDIGIT_LC|UV ch -=for apidoc_item ||isDIGIT_LC_uvchr|UV ch =for apidoc_item ||isDIGIT_LC_utf8_safe|U8 * s| U8 *end +=for apidoc_item ||isDIGIT_LC_uvchr|UV ch +=for apidoc_item ||isDIGIT_L1|UV ch +=for apidoc_item ||isDIGIT_utf8|U8 * s|U8 * end +=for apidoc_item ||isDIGIT_utf8_safe|U8 * s|U8 * end +=for apidoc_item ||isDIGIT_uvchr|UV ch Returns a boolean indicating whether the specified character is a digit, analogous to C<m/[[:digit:]]/>. @@ -929,13 +929,13 @@ the variants. =for apidoc Am|bool|isGRAPH|UV ch =for apidoc_item ||isGRAPH_A|UV ch -=for apidoc_item ||isGRAPH_L1|UV ch -=for apidoc_item ||isGRAPH_uvchr|UV ch -=for apidoc_item ||isGRAPH_utf8_safe|U8 * s|U8 * end -=for apidoc_item ||isGRAPH_utf8|U8 * s|U8 * end =for apidoc_item ||isGRAPH_LC|UV ch -=for apidoc_item ||isGRAPH_LC_uvchr|UV ch =for apidoc_item ||isGRAPH_LC_utf8_safe|U8 * s| U8 *end +=for apidoc_item ||isGRAPH_LC_uvchr|UV ch +=for apidoc_item ||isGRAPH_L1|UV ch +=for apidoc_item ||isGRAPH_utf8|U8 * s|U8 * end +=for apidoc_item ||isGRAPH_utf8_safe|U8 * s|U8 * end +=for apidoc_item ||isGRAPH_uvchr|UV ch Returns a boolean indicating whether the specified character is a graphic character, analogous to C<m/[[:graph:]]/>. See the L<top of this section|/Character classification> for an explanation of @@ -943,13 +943,13 @@ the variants. =for apidoc Am|bool|isLOWER|UV ch =for apidoc_item ||isLOWER_A|UV ch -=for apidoc_item ||isLOWER_L1|UV ch -=for apidoc_item ||isLOWER_uvchr|UV ch -=for apidoc_item ||isLOWER_utf8_safe|U8 * s|U8 * end -=for apidoc_item ||isLOWER_utf8|U8 * s|U8 * end =for apidoc_item ||isLOWER_LC|UV ch -=for apidoc_item ||isLOWER_LC_uvchr|UV ch =for apidoc_item ||isLOWER_LC_utf8_safe|U8 * s| U8 *end +=for apidoc_item ||isLOWER_LC_uvchr|UV ch +=for apidoc_item ||isLOWER_L1|UV ch +=for apidoc_item ||isLOWER_utf8|U8 * s|U8 * end +=for apidoc_item ||isLOWER_utf8_safe|U8 * s|U8 * end +=for apidoc_item ||isLOWER_uvchr|UV ch Returns a boolean indicating whether the specified character is a lowercase character, analogous to C<m/[[:lower:]]/>. See the L<top of this section|/Character classification> for an explanation of @@ -965,13 +965,13 @@ C<isOCTAL>. =for apidoc Am|bool|isPUNCT|UV ch =for apidoc_item ||isPUNCT_A|UV ch -=for apidoc_item ||isPUNCT_L1|UV ch -=for apidoc_item ||isPUNCT_uvchr|UV ch -=for apidoc_item ||isPUNCT_utf8_safe|U8 * s|U8 * end -=for apidoc_item ||isPUNCT_utf8|U8 * s|U8 * end =for apidoc_item ||isPUNCT_LC|UV ch -=for apidoc_item ||isPUNCT_LC_uvchr|UV ch =for apidoc_item ||isPUNCT_LC_utf8_safe|U8 * s| U8 *end +=for apidoc_item ||isPUNCT_LC_uvchr|UV ch +=for apidoc_item ||isPUNCT_L1|UV ch +=for apidoc_item ||isPUNCT_utf8|U8 * s|U8 * end +=for apidoc_item ||isPUNCT_utf8_safe|U8 * s|U8 * end +=for apidoc_item ||isPUNCT_uvchr|UV ch Returns a boolean indicating whether the specified character is a punctuation character, analogous to C<m/[[:punct:]]/>. Note that the definition of what is punctuation isn't as @@ -982,13 +982,13 @@ the variants. =for apidoc Am|bool|isSPACE|UV ch =for apidoc_item ||isSPACE_A|UV ch -=for apidoc_item ||isSPACE_L1|UV ch -=for apidoc_item ||isSPACE_uvchr|UV ch -=for apidoc_item ||isSPACE_utf8_safe|U8 * s|U8 * end -=for apidoc_item ||isSPACE_utf8|U8 * s|U8 * end =for apidoc_item ||isSPACE_LC|UV ch -=for apidoc_item ||isSPACE_LC_uvchr|UV ch =for apidoc_item ||isSPACE_LC_utf8_safe|U8 * s| U8 *end +=for apidoc_item ||isSPACE_LC_uvchr|UV ch +=for apidoc_item ||isSPACE_L1|UV ch +=for apidoc_item ||isSPACE_utf8|U8 * s|U8 * end +=for apidoc_item ||isSPACE_utf8_safe|U8 * s|U8 * end +=for apidoc_item ||isSPACE_uvchr|UV ch Returns a boolean indicating whether the specified character is a whitespace character. This is analogous to what C<m/\s/> matches in a regular expression. Starting in Perl 5.18 @@ -1002,13 +1002,13 @@ the variants. =for apidoc Am|bool|isPSXSPC|UV ch =for apidoc_item ||isPSXSPC_A|UV ch -=for apidoc_item ||isPSXSPC_L1|UV ch -=for apidoc_item ||isPSXSPC_uvchr|UV ch -=for apidoc_item ||isPSXSPC_utf8_safe|U8 * s|U8 * end -=for apidoc_item ||isPSXSPC_utf8|U8 * s|U8 * end =for apidoc_item ||isPSXSPC_LC|UV ch -=for apidoc_item ||isPSXSPC_LC_uvchr|UV ch =for apidoc_item ||isPSXSPC_LC_utf8_safe|U8 * s| U8 *end +=for apidoc_item ||isPSXSPC_LC_uvchr|UV ch +=for apidoc_item ||isPSXSPC_L1|UV ch +=for apidoc_item ||isPSXSPC_utf8|U8 * s|U8 * end +=for apidoc_item ||isPSXSPC_utf8_safe|U8 * s|U8 * end +=for apidoc_item ||isPSXSPC_uvchr|UV ch (short for Posix Space) Starting in 5.18, this is identical in all its forms to the corresponding C<isSPACE()> macros. @@ -1023,13 +1023,13 @@ the variants. =for apidoc Am|bool|isUPPER|UV ch =for apidoc_item ||isUPPER_A|UV ch -=for apidoc_item ||isUPPER_L1|UV ch -=for apidoc_item ||isUPPER_uvchr|UV ch -=for apidoc_item ||isUPPER_utf8_safe|U8 * s|U8 * end -=for apidoc_item ||isUPPER_utf8|U8 * s|U8 * end =for apidoc_item ||isUPPER_LC|UV ch -=for apidoc_item ||isUPPER_LC_uvchr|UV ch =for apidoc_item ||isUPPER_LC_utf8_safe|U8 * s| U8 *end +=for apidoc_item ||isUPPER_LC_uvchr|UV ch +=for apidoc_item ||isUPPER_L1|UV ch +=for apidoc_item ||isUPPER_utf8|U8 * s|U8 * end +=for apidoc_item ||isUPPER_utf8_safe|U8 * s|U8 * end +=for apidoc_item ||isUPPER_uvchr|UV ch Returns a boolean indicating whether the specified character is an uppercase character, analogous to C<m/[[:upper:]]/>. See the L<top of this section|/Character classification> for an explanation of @@ -1037,13 +1037,13 @@ the variants. =for apidoc Am|bool|isPRINT|UV ch =for apidoc_item ||isPRINT_A|UV ch -=for apidoc_item ||isPRINT_L1|UV ch -=for apidoc_item ||isPRINT_uvchr|UV ch -=for apidoc_item ||isPRINT_utf8_safe|U8 * s|U8 * end -=for apidoc_item ||isPRINT_utf8|U8 * s|U8 * end =for apidoc_item ||isPRINT_LC|UV ch -=for apidoc_item ||isPRINT_LC_uvchr|UV ch =for apidoc_item ||isPRINT_LC_utf8_safe|U8 * s| U8 *end +=for apidoc_item ||isPRINT_LC_uvchr|UV ch +=for apidoc_item ||isPRINT_L1|UV ch +=for apidoc_item ||isPRINT_utf8|U8 * s|U8 * end +=for apidoc_item ||isPRINT_utf8_safe|U8 * s|U8 * end +=for apidoc_item ||isPRINT_uvchr|UV ch Returns a boolean indicating whether the specified character is a printable character, analogous to C<m/[[:print:]]/>. See the L<top of this section|/Character classification> for an explanation of @@ -1051,13 +1051,13 @@ the variants. =for apidoc Am|bool|isWORDCHAR|UV ch =for apidoc_item ||isWORDCHAR_A|UV ch -=for apidoc_item ||isWORDCHAR_L1|UV ch -=for apidoc_item ||isWORDCHAR_uvchr|UV ch -=for apidoc_item ||isWORDCHAR_utf8_safe|U8 * s|U8 * end -=for apidoc_item ||isWORDCHAR_utf8|U8 * s|U8 * end =for apidoc_item ||isWORDCHAR_LC|UV ch -=for apidoc_item ||isWORDCHAR_LC_uvchr|UV ch =for apidoc_item ||isWORDCHAR_LC_utf8_safe|U8 * s| U8 *end +=for apidoc_item ||isWORDCHAR_LC_uvchr|UV ch +=for apidoc_item ||isWORDCHAR_L1|UV ch +=for apidoc_item ||isWORDCHAR_utf8|U8 * s|U8 * end +=for apidoc_item ||isWORDCHAR_utf8_safe|U8 * s|U8 * end +=for apidoc_item ||isWORDCHAR_uvchr|UV ch Returns a boolean indicating whether the specified character is a character that is a word character, analogous to what C<m/\w/> and C<m/[[:word:]]/> match in a regular expression. A word character is an alphabetic character, a @@ -1066,6 +1066,7 @@ a "mark" character that attaches to one of those (like some sort of accent). See the L<top of this section|/Character classification> for an explanation of the variants. + C<isWORDCHAR_A>, C<isWORDCHAR_L1>, C<isWORDCHAR_uvchr>, C<isWORDCHAR_LC>, C<isWORDCHAR_LC_uvchr>, C<isWORDCHAR_LC_utf8>, and C<isWORDCHAR_LC_utf8_safe> are also as described there, but additionally @@ -1085,13 +1086,13 @@ variant. =for apidoc Am|bool|isXDIGIT|UV ch =for apidoc_item ||isXDIGIT_A|UV ch -=for apidoc_item ||isXDIGIT_L1|UV ch -=for apidoc_item ||isXDIGIT_uvchr|UV ch -=for apidoc_item ||isXDIGIT_utf8_safe|U8 * s|U8 * end -=for apidoc_item ||isXDIGIT_utf8|U8 * s|U8 * end =for apidoc_item ||isXDIGIT_LC|UV ch -=for apidoc_item ||isXDIGIT_LC_uvchr|UV ch =for apidoc_item ||isXDIGIT_LC_utf8_safe|U8 * s| U8 *end +=for apidoc_item ||isXDIGIT_LC_uvchr|UV ch +=for apidoc_item ||isXDIGIT_L1|UV ch +=for apidoc_item ||isXDIGIT_utf8|U8 * s|U8 * end +=for apidoc_item ||isXDIGIT_utf8_safe|U8 * s|U8 * end +=for apidoc_item ||isXDIGIT_uvchr|UV ch Returns a boolean indicating whether the specified character is a hexadecimal digit. In the ASCII range these are C<[0-9A-Fa-f]>. Variants C<isXDIGIT_A()> and C<isXDIGIT_L1()> are identical to C<isXDIGIT()>. @@ -1100,13 +1101,13 @@ the variants. =for apidoc Am|bool|isIDFIRST|UV ch =for apidoc_item ||isIDFIRST_A|UV ch -=for apidoc_item ||isIDFIRST_L1|UV ch -=for apidoc_item ||isIDFIRST_uvchr|UV ch -=for apidoc_item ||isIDFIRST_utf8_safe|U8 * s|U8 * end -=for apidoc_item ||isIDFIRST_utf8|U8 * s|U8 * end =for apidoc_item ||isIDFIRST_LC|UV ch -=for apidoc_item ||isIDFIRST_LC_uvchr|UV ch =for apidoc_item ||isIDFIRST_LC_utf8_safe|U8 * s| U8 *end +=for apidoc_item ||isIDFIRST_LC_uvchr|UV ch +=for apidoc_item ||isIDFIRST_L1|UV ch +=for apidoc_item ||isIDFIRST_utf8|U8 * s|U8 * end +=for apidoc_item ||isIDFIRST_utf8_safe|U8 * s|U8 * end +=for apidoc_item ||isIDFIRST_uvchr|UV ch Returns a boolean indicating whether the specified character can be the first character of an identifier. This is very close to, but not quite the same as the official Unicode property C<XID_Start>. The difference is that this @@ -1116,13 +1117,13 @@ the variants. =for apidoc Am|bool|isIDCONT|UV ch =for apidoc_item ||isIDCONT_A|UV ch -=for apidoc_item ||isIDCONT_L1|UV ch -=for apidoc_item ||isIDCONT_uvchr|UV ch -=for apidoc_item ||isIDCONT_utf8_safe|U8 * s|U8 * end -=for apidoc_item ||isIDCONT_utf8|U8 * s|U8 * end =for apidoc_item ||isIDCONT_LC|UV ch -=for apidoc_item ||isIDCONT_LC_uvchr|UV ch =for apidoc_item ||isIDCONT_LC_utf8_safe|U8 * s| U8 *end +=for apidoc_item ||isIDCONT_LC_uvchr|UV ch +=for apidoc_item ||isIDCONT_L1|UV ch +=for apidoc_item ||isIDCONT_utf8|U8 * s|U8 * end +=for apidoc_item ||isIDCONT_utf8_safe|U8 * s|U8 * end +=for apidoc_item ||isIDCONT_uvchr|UV ch Returns a boolean indicating whether the specified character can be the second or succeeding character of an identifier. This is very close to, but not quite the same as the official Unicode property C<XID_Continue>. The @@ -1150,9 +1151,9 @@ results for the full range of possible inputs has been implemented here. =for apidoc Am|UV|toUPPER|UV cp =for apidoc_item |UV|toUPPER_A|UV cp -=for apidoc_item |UV|toUPPER_uvchr|UV cp|U8* s|STRLEN* lenp =for apidoc_item |UV|toUPPER_utf8|U8* p|U8* e|U8* s|STRLEN* lenp =for apidoc_item |UV|toUPPER_utf8_safe|U8* p|U8* e|U8* s|STRLEN* lenp +=for apidoc_item |UV|toUPPER_uvchr|UV cp|U8* s|STRLEN* lenp These all return the uppercase of a character. The differences are what domain they operate on, and whether the input is specified as a code point (those @@ -1199,9 +1200,9 @@ change in future releases. =for apidoc Am|UV|toFOLD|UV cp =for apidoc_item |UV|toFOLD_A|UV cp -=for apidoc_item |UV|toFOLD_uvchr|UV cp|U8* s|STRLEN* lenp =for apidoc_item |UV|toFOLD_utf8|U8* p|U8* e|U8* s|STRLEN* lenp =for apidoc_item |UV|toFOLD_utf8_safe|U8* p|U8* e|U8* s|STRLEN* lenp +=for apidoc_item |UV|toFOLD_uvchr|UV cp|U8* s|STRLEN* lenp These all return the foldcase of a character. "foldcase" is an internal case for C</i> pattern matching. If the foldcase of character A and the foldcase of @@ -1253,12 +1254,12 @@ change in future releases. =for apidoc Am|UV|toLOWER|UV cp =for apidoc_item |UV|toLOWER_A|UV cp -=for apidoc_item |UV|toLOWER_L1|UV cp =for apidoc_item |UV|toLOWER_LATIN1|UV cp =for apidoc_item |UV|toLOWER_LC|UV cp -=for apidoc_item |UV|toLOWER_uvchr|UV cp|U8* s|STRLEN* lenp +=for apidoc_item |UV|toLOWER_L1|UV cp =for apidoc_item |UV|toLOWER_utf8|U8* p|U8* e|U8* s|STRLEN* lenp =for apidoc_item |UV|toLOWER_utf8_safe|U8* p|U8* e|U8* s|STRLEN* lenp +=for apidoc_item |UV|toLOWER_uvchr|UV cp|U8* s|STRLEN* lenp These all return the lowercase of a character. The differences are what domain they operate on, and whether the input is specified as a code point (those @@ -1310,9 +1311,9 @@ change in future releases. =for apidoc Am|UV|toTITLE|UV cp =for apidoc_item |UV|toTITLE_A|UV cp -=for apidoc_item |UV|toTITLE_uvchr|UV cp|U8* s|STRLEN* lenp =for apidoc_item |UV|toTITLE_utf8|U8* p|U8* e|U8* s|STRLEN* lenp =for apidoc_item |UV|toTITLE_utf8_safe|U8* p|U8* e|U8* s|STRLEN* lenp +=for apidoc_item |UV|toTITLE_uvchr|UV cp|U8* s|STRLEN* lenp These all return the titlecase of a character. The differences are what domain they operate on, and whether the input is specified as a code point (those @@ -2830,9 +2830,9 @@ Perl_get_hv(pTHX_ const char *name, I32 flags) /* =for apidoc_section $CV -=for apidoc get_cv +=for apidoc get_cv +=for apidoc_item get_cvn_flags =for apidoc_item |CV *|get_cvs|"string"|I32 flags -=for apidoc_item get_cvn_flags These return the CV of the specified Perl subroutine. C<flags> are passed to C<gv_fetchpvn_flags>. If C<GV_ADD> is set and the Perl subroutine does not @@ -727,8 +727,8 @@ Now a placeholder that declares nothing /* =for apidoc_section $directives -=for apidoc AmnUu|void|STMT_START -=for apidoc_item ||STMT_END +=for apidoc AmnUu|void|STMT_END +=for apidoc_item | |STMT_START These allow a series of statements in a macro to be used as a single statement, as in @@ -3092,10 +3092,12 @@ the highest precision one available is used. /* =for apidoc_section $integer -=for apidoc AmnU||PERL_INT_MAX +=for apidoc AmnU ||PERL_INT_MAX =for apidoc_item ||PERL_INT_MIN =for apidoc_item ||PERL_LONG_MAX =for apidoc_item ||PERL_LONG_MIN +=for apidoc_item ||PERL_QUAD_MAX +=for apidoc_item ||PERL_QUAD_MIN =for apidoc_item ||PERL_SHORT_MAX =for apidoc_item ||PERL_SHORT_MIN =for apidoc_item ||PERL_UCHAR_MAX @@ -3104,12 +3106,10 @@ the highest precision one available is used. =for apidoc_item ||PERL_UINT_MIN =for apidoc_item ||PERL_ULONG_MAX =for apidoc_item ||PERL_ULONG_MIN -=for apidoc_item ||PERL_USHORT_MAX -=for apidoc_item ||PERL_USHORT_MIN -=for apidoc_item ||PERL_QUAD_MAX -=for apidoc_item ||PERL_QUAD_MIN =for apidoc_item ||PERL_UQUAD_MAX =for apidoc_item ||PERL_UQUAD_MIN +=for apidoc_item ||PERL_USHORT_MAX +=for apidoc_item ||PERL_USHORT_MIN These give the largest and smallest number representable in the current platform in variables of the corresponding types. diff --git a/pod/perlguts.pod b/pod/perlguts.pod index 16e16723b0..df78dea3ed 100644 --- a/pod/perlguts.pod +++ b/pod/perlguts.pod @@ -61,17 +61,17 @@ A numeric constant can be specified with L<perlapi/C<INT16_C>>, L<perlapi/C<UINTMAX_C>>, and similar. =for apidoc_section $integer -=for apidoc Ayh||I8 +=for apidoc Ayh ||IV +=for apidoc_item ||I8 =for apidoc_item ||I16 =for apidoc_item ||I32 =for apidoc_item ||I64 -=for apidoc_item ||IV -=for apidoc Ayh||U8 +=for apidoc Ayh ||UV +=for apidoc_item ||U8 =for apidoc_item ||U16 =for apidoc_item ||U32 =for apidoc_item ||U64 -=for apidoc_item ||UV =head2 Working with SVs @@ -3627,12 +3627,12 @@ the only core C<PVOP>, C<OP_TRANS>, can sometimes be a C<SVOP> instead. =for apidoc_item OA_COP =for apidoc_item OA_LISTOP =for apidoc_item OA_LOGOP +=for apidoc_item OA_LOOP =for apidoc_item OA_PADOP =for apidoc_item OA_PMOP =for apidoc_item OA_PVOP_OR_SVOP =for apidoc_item OA_SVOP =for apidoc_item OA_UNOP -=for apidoc_item OA_LOOP =back diff --git a/pod/perlreapi.pod b/pod/perlreapi.pod index 9f59461ff1..51c0ba7eed 100644 --- a/pod/perlreapi.pod +++ b/pod/perlreapi.pod @@ -129,11 +129,11 @@ If this is in C<< rx->extflags >> it will be passed to C<Perl_fbm_instr> by C<pp_split> which will treat the subject string as a multi-line string. -=for apidoc Amnh||RXf_PMf_MULTILINE -=for apidoc_item RXf_PMf_SINGLELINE +=for apidoc Amnh||RXf_PMf_EXTENDED =for apidoc_item RXf_PMf_FOLD -=for apidoc_item RXf_PMf_EXTENDED =for apidoc_item RXf_PMf_KEEPCOPY +=for apidoc_item RXf_PMf_MULTILINE +=for apidoc_item RXf_PMf_SINGLELINE =item C</s> - RXf_PMf_SINGLELINE @@ -192,12 +192,12 @@ SKIPWHITE and WHITE extflags. To do this, the Perl engine does: These flags can be set during compilation to enable optimizations in the C<split> operator. -=for apidoc Amnh||RXf_SPLIT +=for apidoc Amnh||RXf_NO_INPLACE_SUBST +=for apidoc_item RXf_NULL =for apidoc_item RXf_SKIPWHITE +=for apidoc_item RXf_SPLIT =for apidoc_item RXf_START_ONLY =for apidoc_item RXf_WHITE -=for apidoc_item RXf_NULL -=for apidoc_item RXf_NO_INPLACE_SUBST =over 4 @@ -507,19 +507,19 @@ C<%+> or C<%+>, if any: RXapif_FIRSTKEY RXapif_NEXTKEY -=for apidoc Amnh ||RXapif_CLEAR +=for apidoc Amnh ||RXapif_ALL +=for apidoc_item RXapif_CLEAR =for apidoc_item RXapif_DELETE =for apidoc_item RXapif_EXISTS =for apidoc_item RXapif_FETCH =for apidoc_item RXapif_FIRSTKEY =for apidoc_item RXapif_NEXTKEY -=for apidoc_item RXapif_SCALAR -=for apidoc_item RXapif_STORE -=for apidoc_item RXapif_ALL =for apidoc_item RXapif_ONE =for apidoc_item RXapif_REGNAME =for apidoc_item RXapif_REGNAMES =for apidoc_item RXapif_REGNAMES_COUNT +=for apidoc_item RXapif_SCALAR +=for apidoc_item RXapif_STORE If C<%+> or C<%-> is being operated on, if any. @@ -844,9 +844,9 @@ number of bytes from the logical start of the buffer to the physical start characters in the offset. The latter is needed to support C<@-> and C<@+> which work in characters, not bytes. -=for apidoc Amnh||REXEC_COPY_STR +=for apidoc Amnh ||REXEC_COPY_SKIP_POST =for apidoc_item ||REXEC_COPY_SKIP_PRE -=for apidoc_item ||REXEC_COPY_SKIP_POST +=for apidoc_item ||REXEC_COPY_STR =head2 C<wrapped> C<wraplen> @@ -309,8 +309,8 @@ scope has the given name. C<name> must be a literal string. =for apidoc_section $stack =for apidoc Am|I32|SSNEW |Size_t size =for apidoc_item | |SSNEWa |Size_t_size|Size_t align -=for apidoc_item | |SSNEWt |Size_t size|type =for apidoc_item | |SSNEWat|Size_t_size|type|Size_t align +=for apidoc_item | |SSNEWt |Size_t size|type These temporarily allocates data on the savestack, returning an I32 index into the savestack, because a pointer would get broken if the savestack is moved on @@ -3114,8 +3114,8 @@ Perl_sv_2pv_flags(pTHX_ SV *const sv, STRLEN *const lp, const U32 flags) /* =for apidoc sv_copypv -=for apidoc_item sv_copypv_nomg =for apidoc_item sv_copypv_flags +=for apidoc_item sv_copypv_nomg These copy a stringified representation of the source SV into the destination SV. They automatically perform coercion of numeric values into @@ -3292,9 +3292,9 @@ Perl_sv_2bool_flags(pTHX_ SV *sv, I32 flags) /* =for apidoc sv_utf8_upgrade -=for apidoc_item sv_utf8_upgrade_nomg =for apidoc_item sv_utf8_upgrade_flags =for apidoc_item sv_utf8_upgrade_flags_grow +=for apidoc_item sv_utf8_upgrade_nomg These convert the PV of an SV to its UTF-8-encoded form. The SV is forced to string form if it is not already. @@ -4866,11 +4866,11 @@ Perl_sv_setpv_bufsize(pTHX_ SV *const sv, const STRLEN cur, const STRLEN len) } /* -=for apidoc sv_setpv -=for apidoc_item sv_setpv_mg -=for apidoc_item sv_setpvn -=for apidoc_item sv_setpvn_fresh -=for apidoc_item sv_setpvn_mg +=for apidoc sv_setpv +=for apidoc_item sv_setpv_mg +=for apidoc_item sv_setpvn +=for apidoc_item sv_setpvn_fresh +=for apidoc_item sv_setpvn_mg =for apidoc_item |void|sv_setpvs|SV* sv|"literal string" =for apidoc_item |void|sv_setpvs_mg|SV* sv|"literal string" @@ -5048,8 +5048,8 @@ Perl_sv_sethek(pTHX_ SV *const sv, const HEK *const hek) /* =for apidoc sv_usepvn -=for apidoc_item sv_usepvn_mg =for apidoc_item sv_usepvn_flags +=for apidoc_item sv_usepvn_mg These tell an SV to use C<ptr> for its string value. Normally SVs have their string stored inside the SV, but these tell the SV to use an @@ -9926,8 +9926,8 @@ Perl_newRV(pTHX_ SV *const sv) /* =for apidoc newSVsv -=for apidoc_item newSVsv_nomg =for apidoc_item newSVsv_flags +=for apidoc_item newSVsv_nomg These create a new SV which is an exact duplicate of the original SV (using C<sv_setsv>.) @@ -10892,10 +10892,10 @@ Perl_sv_setpvf_mg_nocontext(SV *const sv, const char *const pat, ...) #endif /* -=for apidoc sv_setpvf -=for apidoc_item sv_setpvf_nocontext +=for apidoc sv_setpvf =for apidoc_item sv_setpvf_mg =for apidoc_item sv_setpvf_mg_nocontext +=for apidoc_item sv_setpvf_nocontext These work like C<L</sv_catpvf>> but copy the text into the SV instead of appending it. @@ -11011,9 +11011,9 @@ Perl_sv_catpvf_mg_nocontext(SV *const sv, const char *const pat, ...) /* =for apidoc sv_catpvf -=for apidoc_item sv_catpvf_nocontext =for apidoc_item sv_catpvf_mg =for apidoc_item sv_catpvf_mg_nocontext +=for apidoc_item sv_catpvf_nocontext These process their arguments like C<sprintf>, and append the formatted output to an SV. As with C<sv_vcatpvfn>, argument reordering is not supporte @@ -283,14 +283,14 @@ struct invlist { Returns the value of the object's reference count. Exposed to perl code via Internals::SvREFCNT(). -=for apidoc SvREFCNT_inc -=for apidoc_item SvREFCNT_inc_NN -=for apidoc_item SvREFCNT_inc_void -=for apidoc_item |void|SvREFCNT_inc_void_NN|SV* sv -=for apidoc_item |SV*|SvREFCNT_inc_simple|SV* sv -=for apidoc_item |SV*|SvREFCNT_inc_simple_NN|SV* sv +=for apidoc SvREFCNT_inc +=for apidoc_item SvREFCNT_inc_NN +=for apidoc_item |SV* |SvREFCNT_inc_simple|SV* sv +=for apidoc_item |SV* |SvREFCNT_inc_simple_NN|SV* sv =for apidoc_item |void|SvREFCNT_inc_simple_void|SV* sv =for apidoc_item |void|SvREFCNT_inc_simple_void_NN|SV* sv +=for apidoc_item SvREFCNT_inc_void +=for apidoc_item |void|SvREFCNT_inc_void_NN|SV* sv These all increment the reference count of the given SV. The ones without C<void> in their names return the SV. @@ -839,10 +839,10 @@ This is an unnecessary synonym for L</SvUVX> Returns the raw value in the SV's NV slot, without checks or conversions. Only use when you are sure C<SvNOK> is true. See also C<L</SvNV>>. -=for apidoc Am|char*|SvPVX|SV* sv -=for apidoc_item |char*|SvPVXx|SV* sv +=for apidoc Am |char* |SvPVX|SV* sv =for apidoc_item |const char*|SvPVX_const|SV* sv -=for apidoc_item |char*|SvPVX_mutable|SV* sv +=for apidoc_item |char* |SvPVX_mutable|SV* sv +=for apidoc_item |char* |SvPVXx|SV* sv These return a pointer to the physical string in the SV. The SV must contain a string. Prior to 5.9.3 it is not safe to execute these unless the SV's @@ -1681,19 +1681,19 @@ attention to precisely which outputs are influenced by which inputs. /* =for apidoc_section $SV -=for apidoc Am|char*|SvPV_force|SV* sv|STRLEN len -=for apidoc_item ||SvPV_force_nolen|SV* sv -=for apidoc_item ||SvPVx_force|SV* sv|STRLEN len -=for apidoc_item ||SvPV_force_nomg|SV* sv|STRLEN len -=for apidoc_item ||SvPV_force_nomg_nolen|SV * sv -=for apidoc_item ||SvPV_force_mutable|SV * sv|STRLEN len -=for apidoc_item ||SvPV_force_flags|SV * sv|STRLEN len|U32 flags -=for apidoc_item ||SvPV_force_flags_nolen|SV * sv|U32 flags -=for apidoc_item ||SvPV_force_flags_mutable|SV * sv|STRLEN len|U32 flags -=for apidoc_item ||SvPVbyte_force -=for apidoc_item ||SvPVbytex_force -=for apidoc_item ||SvPVutf8_force -=for apidoc_item ||SvPVutf8x_force +=for apidoc Am|char*|SvPV_force |SV* sv|STRLEN len +=for apidoc_item ||SvPV_force_flags |SV * sv|STRLEN len|U32 flags +=for apidoc_item ||SvPV_force_flags_mutable|SV * sv|STRLEN len|U32 flags +=for apidoc_item ||SvPV_force_flags_nolen |SV * sv |U32 flags +=for apidoc_item ||SvPV_force_mutable |SV * sv|STRLEN len +=for apidoc_item ||SvPV_force_nolen |SV* sv +=for apidoc_item ||SvPV_force_nomg |SV* sv|STRLEN len +=for apidoc_item ||SvPV_force_nomg_nolen |SV * sv +=for apidoc_item ||SvPVbyte_force |SV * sv|STRLEN len +=for apidoc_item ||SvPVbytex_force |SV * sv|STRLEN len +=for apidoc_item ||SvPVutf8_force |SV * sv|STRLEN len +=for apidoc_item ||SvPVutf8x_force |SV * sv|STRLEN len +=for apidoc_item ||SvPVx_force |SV* sv|STRLEN len These are like C<L</SvPV>>, returning the string in the SV, but will force the SV into containing a string (C<L</SvPOK>>), and only a string @@ -1738,35 +1738,35 @@ downgraded from UTF-8, this croaks. C<SvPVbytex_force> is like C<SvPVbyte_force>, but guarantees to evaluate C<sv> only once; use the more efficient C<SvPVbyte_force> otherwise. -=for apidoc Am|char*|SvPV|SV* sv|STRLEN len -=for apidoc_item |char*|SvPVx|SV* sv|STRLEN len -=for apidoc_item |char*|SvPV_nomg|SV* sv|STRLEN len -=for apidoc_item |char*|SvPV_nolen|SV* sv -=for apidoc_item |char*|SvPVx_nolen|SV* sv -=for apidoc_item |char*|SvPV_nomg_nolen|SV* sv -=for apidoc_item |char*|SvPV_mutable|SV* sv|STRLEN len -=for apidoc_item |const char*|SvPV_const|SV* sv|STRLEN len -=for apidoc_item |const char*|SvPVx_const|SV* sv|STRLEN len -=for apidoc_item |const char*|SvPV_nolen_const|SV* sv -=for apidoc_item |const char*|SvPVx_nolen_const|SV* sv -=for apidoc_item |const char*|SvPV_nomg_const|SV* sv|STRLEN len +=for apidoc Am | char*|SvPV |SV* sv|STRLEN len +=for apidoc_item |const char*|SvPV_const |SV* sv|STRLEN len +=for apidoc_item | char*|SvPV_flags |SV* sv|STRLEN len|U32 flags +=for apidoc_item |const char*|SvPV_flags_const |SV* sv|STRLEN len|U32 flags +=for apidoc_item | char*|SvPV_flags_mutable |SV* sv|STRLEN len|U32 flags +=for apidoc_item | char*|SvPV_mutable |SV* sv|STRLEN len +=for apidoc_item | char*|SvPV_nolen |SV* sv +=for apidoc_item |const char*|SvPV_nolen_const |SV* sv +=for apidoc_item | char*|SvPV_nomg |SV* sv|STRLEN len +=for apidoc_item |const char*|SvPV_nomg_const |SV* sv|STRLEN len =for apidoc_item |const char*|SvPV_nomg_const_nolen|SV* sv -=for apidoc_item |char *|SvPV_flags|SV * sv|STRLEN len|U32 flags -=for apidoc_item |const char *|SvPV_flags_const|SV * sv|STRLEN len|U32 flags -=for apidoc_item |char *|SvPV_flags_mutable|SV * sv|STRLEN len|U32 flags -=for apidoc_item |char*|SvPVbyte|SV* sv|STRLEN len -=for apidoc_item |char*|SvPVbyte_nomg|SV* sv|STRLEN len -=for apidoc_item |char*|SvPVbyte_nolen|SV* sv -=for apidoc_item |char*|SvPVbytex_nolen|SV* sv -=for apidoc_item |char*|SvPVbytex|SV* sv|STRLEN len -=for apidoc_item |char*|SvPVbyte_or_null|SV* sv|STRLEN len -=for apidoc_item |char*|SvPVbyte_or_null_nomg|SV* sv|STRLEN len -=for apidoc_item |char*|SvPVutf8|SV* sv|STRLEN len -=for apidoc_item |char*|SvPVutf8x|SV* sv|STRLEN len -=for apidoc_item |char*|SvPVutf8_nomg|SV* sv|STRLEN len -=for apidoc_item |char*|SvPVutf8_nolen|SV* sv -=for apidoc_item |char*|SvPVutf8_or_null|SV* sv|STRLEN len -=for apidoc_item |char*|SvPVutf8_or_null_nomg|SV* sv|STRLEN len +=for apidoc_item | char*|SvPV_nomg_nolen |SV* sv +=for apidoc_item | char*|SvPVbyte |SV* sv|STRLEN len +=for apidoc_item | char*|SvPVbyte_nolen |SV* sv +=for apidoc_item | char*|SvPVbyte_nomg |SV* sv|STRLEN len +=for apidoc_item | char*|SvPVbyte_or_null |SV* sv|STRLEN len +=for apidoc_item | char*|SvPVbyte_or_null_nomg|SV* sv|STRLEN len +=for apidoc_item | char*|SvPVbytex |SV* sv|STRLEN len +=for apidoc_item | char*|SvPVbytex_nolen |SV* sv +=for apidoc_item | char*|SvPVutf8 |SV* sv|STRLEN len +=for apidoc_item | char*|SvPVutf8_nolen |SV* sv +=for apidoc_item | char*|SvPVutf8_nomg |SV* sv|STRLEN len +=for apidoc_item | char*|SvPVutf8_or_null |SV* sv|STRLEN len +=for apidoc_item | char*|SvPVutf8_or_null_nomg|SV* sv|STRLEN len +=for apidoc_item | char*|SvPVutf8x |SV* sv|STRLEN len +=for apidoc_item | char*|SvPVx |SV* sv|STRLEN len +=for apidoc_item |const char*|SvPVx_const |SV* sv|STRLEN len +=for apidoc_item | char*|SvPVx_nolen |SV* sv +=for apidoc_item |const char*|SvPVx_nolen_const |SV* sv All these return a pointer to the string in C<sv>, or a stringified form of C<sv> if it does not contain a string. The SV may cache the stringified @@ -1835,11 +1835,11 @@ their respective forms without. C<SvPVbyte_or_null> doesn't have a corresponding non-C<byte> form. Instead it is like C<SvPVbyte>, but when C<sv> is undef, it returns C<NULL>. -=for apidoc SvTRUE -=for apidoc_item SvTRUEx -=for apidoc_item SvTRUE_nomg +=for apidoc SvTRUE =for apidoc_item SvTRUE_NN +=for apidoc_item SvTRUE_nomg =for apidoc_item SvTRUE_nomg_NN +=for apidoc_item SvTRUEx These return a boolean indicating whether Perl would evaluate the SV as true or false. See C<L</SvOK>> for a defined/undefined test. @@ -2254,10 +2254,10 @@ after modifying a scalar, in case it is a magical variable like C<$|> 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 -=for apidoc_item SvSetMagicSV -=for apidoc_item SvSetSV_nosteal -=for apidoc_item SvSetMagicSV_nosteal +=for apidoc Am|void|SvSetMagicSV|SV* dsv|SV* ssv +=for apidoc_item SvSetMagicSV_nosteal +=for apidoc_item SvSetSV +=for apidoc_item SvSetSV_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 diff --git a/sv_inline.h b/sv_inline.h index 2c2eff27df..116823c435 100644 --- a/sv_inline.h +++ b/sv_inline.h @@ -735,9 +735,9 @@ Perl_SvPADSTALE_off(SV *sv) /* =for apidoc_section $SV -=for apidoc SvIV -=for apidoc_item SvIVx +=for apidoc SvIV =for apidoc_item SvIV_nomg +=for apidoc_item SvIVx These each coerce the given SV to IV and return it. The returned value in many circumstances will get stored in C<sv>'s IV slot, but not in all cases. (Use @@ -750,9 +750,9 @@ guaranteed to evaluate C<sv> only once. C<SvIV_nomg> is the same as C<SvIV>, but does not perform 'get' magic. -=for apidoc SvNV -=for apidoc_item SvNVx +=for apidoc SvNV =for apidoc_item SvNV_nomg +=for apidoc_item SvNVx These each coerce the given SV to NV and return it. The returned value in many circumstances will get stored in C<sv>'s NV slot, but not in all cases. (Use @@ -765,9 +765,9 @@ guaranteed to evaluate C<sv> only once. C<SvNV_nomg> is the same as C<SvNV>, but does not perform 'get' magic. -=for apidoc SvUV -=for apidoc_item SvUVx +=for apidoc SvUV =for apidoc_item SvUV_nomg +=for apidoc_item SvUVx These each coerce the given SV to UV and return it. The returned value in many circumstances will get stored in C<sv>'s UV slot, but not in all cases. (Use |