summaryrefslogtreecommitdiff
path: root/utf8.h
diff options
context:
space:
mode:
authorKarl Williamson <khw@cpan.org>2016-08-26 13:35:28 -0600
committerKarl Williamson <khw@cpan.org>2016-08-31 20:32:35 -0600
commit8871a094916837597c6a703c2e1b2306314df4fa (patch)
tree4cb3c73457238950fee9f8472683b570934bd763 /utf8.h
parente950ecba8e797ce46fe4f568b0f08811002f3d95 (diff)
downloadperl-8871a094916837597c6a703c2e1b2306314df4fa.tar.gz
Add new synonym 'is_utf8_invariant_string'
This is clearer as to its meaning than the existing 'is_ascii_string' and 'is_invariant_string', which are retained for back compat. The thread context variable is removed as it is not used.
Diffstat (limited to 'utf8.h')
-rw-r--r--utf8.h13
1 files changed, 10 insertions, 3 deletions
diff --git a/utf8.h b/utf8.h
index ee2d97e543..f0ee2d23a7 100644
--- a/utf8.h
+++ b/utf8.h
@@ -50,14 +50,21 @@ Search for the string "utf8" in this document.
=for apidoc is_ascii_string
-This is a misleadingly-named synonym for L</is_invariant_string>.
+This is a misleadingly-named synonym for L</is_utf8_invariant_string>.
On ASCII-ish platforms, the name isn't misleading: the ASCII-range characters
are exactly the UTF-8 invariants. But EBCDIC machines have more invariants
-than just the ASCII characters, so C<is_invariant_string> is preferred.
+than just the ASCII characters, so C<is_utf8_invariant_string> is preferred.
+
+=for apidoc is_invariant_string
+
+This is a somewhat misleadingly-named synonym for L</is_utf8_invariant_string>.
+C<is_utf8_invariant_string> is preferred, as it indicates under what conditions
+the string is invariant.
=cut
*/
-#define is_ascii_string(s, len) is_invariant_string(s, len)
+#define is_ascii_string(s, len) is_utf8_invariant_string(s, len)
+#define is_invariant_string(s, len) is_utf8_invariant_string(s, len)
#define uvchr_to_utf8(a,b) uvchr_to_utf8_flags(a,b,0)
#define uvchr_to_utf8_flags(d,uv,flags) \