embed.fnc: Add some comments

[perl5.git] / embed.fnc

diff --git a/embed.fnc b/embed.fnc
index c259414..fd59c72 100644 (file)
--- a/embed.fnc
+++ b/embed.fnc
@@ -124,6 +124,12 @@
 :
 :   o  Has no Perl_foo or S_foo compatibility macro:
 :
+:      This can be used when you define a macro with this entry's name that
+:      doesn't call the function specified by this entry.  This is typically
+:      done for a function that effectively just wraps another one, and where
+:      the macro form calls the underlying function directly.  For these, also
+:      specify the 'm' flag.  Legacy-only functions should instead use 'b'.
+:
 :         embed.h: suppress "#define foo Perl_foo"
 :
 :   P  Pure function:
@@ -766,7 +772,11 @@ ADMpR      |bool   |is_uni_lower_lc|UV c
 ADMpR  |bool   |is_uni_print_lc|UV c
 ADMpR  |bool   |is_uni_punct_lc|UV c
 ADMpPR |bool   |is_uni_xdigit_lc|UV c
-AnidR  |bool   |is_utf8_invariant_string|NN const U8* const s|STRLEN const len
+AndmoR |bool   |is_utf8_invariant_string|NN const U8* const s              \
+               |STRLEN const len
+AnidR  |bool   |is_utf8_invariant_string_loc|NN const U8* const s          \
+               |STRLEN const len                                           \
+               |NULLOK const U8 ** ep
 AmnpdRP        |bool   |is_ascii_string|NN const U8* const s|const STRLEN len
 AmnpdRP        |bool   |is_invariant_string|NN const U8* const s|const STRLEN len
 AnpdD  |STRLEN |is_utf8_char   |NN const U8 *s
@@ -1785,11 +1795,11 @@ AipdRn  |U8*    |utf8_hop       |NN const U8 *s|SSize_t off
 AipdRn |U8*    |utf8_hop_back|NN const U8 *s|SSize_t off|NN const U8 *start
 AipdRn |U8*    |utf8_hop_forward|NN const U8 *s|SSize_t off|NN const U8 *end
 AipdRn |U8*    |utf8_hop_safe  |NN const U8 *s|SSize_t off|NN const U8 *start|NN const U8 *end
-ApMd   |U8*    |utf8_to_bytes  |NN U8 *s|NN STRLEN *len
+ApMd   |U8*    |utf8_to_bytes  |NN U8 *s|NN STRLEN *lenp
 Apd    |int    |bytes_cmp_utf8 |NN const U8 *b|STRLEN blen|NN const U8 *u \
                                |STRLEN ulen
-ApMd   |U8*    |bytes_from_utf8|NN const U8 *s|NN STRLEN *len|NULLOK bool *is_utf8
-ApMd   |U8*    |bytes_to_utf8  |NN const U8 *s|NN STRLEN *len
+ApMd   |U8*    |bytes_from_utf8|NN const U8 *s|NN STRLEN *lenp|NN bool *is_utf8p
+ApMd   |U8*    |bytes_to_utf8  |NN const U8 *s|NN STRLEN *lenp
 ApdD   |UV     |utf8_to_uvchr  |NN const U8 *s|NULLOK STRLEN *retlen
 ApdD   |UV     |utf8_to_uvuni  |NN const U8 *s|NULLOK STRLEN *retlen
 ApMD   |UV     |valid_utf8_to_uvuni    |NN const U8 *s|NULLOK STRLEN *retlen