mirrors/emacs
1
Fork 0
mirror of git://git.sv.gnu.org/emacs.git synced 2026-01-03 10:31:37 -08:00
Code Issues Projects Releases Wiki Activity

Make UCS compose/decompose functions more understandable

Browse source 
* lisp/international/ucs-normalize.el ()
(ucs-normalize-NFD-region, ucs-normalize-NFD-string)
(ucs-normalize-NFC-region, ucs-normalize-NFC-string)
(ucs-normalize-NFKD-region, ucs-normalize-NFKD-string)
(ucs-normalize-NFKC-region, ucs-normalize-NFKC-string): Make the
doc strings say what they actually do.
This commit is contained in:
Lars Ingebrigtsen 2021-11-19 07:42:12 +01:00
parent c6d5fccc92
commit 3f096eb340
2 changed files with 61 additions and 23 deletions
Download patch file Download diff file Expand all files Collapse all files

9
lisp/emacs-lisp/shortdoc.el
View file

@ -159,8 +159,6 @@ There can be any number of :example/:result elements."
:eval (split-string-and-unquote "foo \"bar zot\""))
(split-string-shell-command
:eval (split-string-shell-command "ls /tmp/'foo bar'"))
(string-glyph-split
:eval (string-glyph-split "Hello, 👼🏻🧑🏼‍🤝‍🧑🏻"))
(string-lines
:eval (string-lines "foo\n\nbar")
:eval (string-lines "foo\n\nbar" t))
@ -198,6 +196,13 @@ There can be any number of :example/:result elements."
:eval (substring-no-properties (propertize "foobar" 'face 'bold) 0 3))
(try-completion
:eval (try-completion "foo" '("foobar" "foozot" "gazonk")))
"Unicode Strings"
(string-glyph-split
:eval (string-glyph-split "Hello, 👼🏻🧑🏼‍🤝‍🧑🏻"))
(string-glyph-compose
:eval (string-glyph-compose "Å"))
(string-glyph-decompose
:eval (string-glyph-decompose "Å"))
"Predicates for Strings"
(string-equal
:eval (string-equal "foo" "foo"))

75
lisp/international/ucs-normalize.el
View file

@ -536,55 +536,88 @@ COMPOSITION-PREDICATE will be used to compose region."
(,ucs-normalize-region (point-min) (point-max))
(buffer-string)))
;;;###autoload
(defun ucs-normalize-NFD-region (from to)
"Normalize the current region by the Unicode NFD."
"Decompose the current region according to the Unicode NFD.
This is the canonical decomposed form."
(interactive "r")
(ucs-normalize-region from to
ucs-normalize-nfd-quick-check-regexp
'ucs-normalize-nfd-table nil))
;;;###autoload
(defun ucs-normalize-NFD-string (str)
"Normalize the string STR by the Unicode NFD."
"Decompose the string STR according to the Unicode NFD.
This is the canonical decomposed form. For instance:
(ucs-normalize-NFD-string \"Å\") => \"Å\""
(ucs-normalize-string ucs-normalize-NFD-region))
;;;###autoload
(defun ucs-normalize-NFC-region (from to)
"Normalize the current region by the Unicode NFC."
"Compose the current region according to the Unicode NFC.
This is the canonical composed form."
(interactive "r")
(ucs-normalize-region from to
ucs-normalize-nfc-quick-check-regexp
'ucs-normalize-nfd-table t))
;;;###autoload
(defun ucs-normalize-NFC-string (str)
"Normalize the string STR by the Unicode NFC."
(ucs-normalize-string ucs-normalize-NFC-region))
;;;###autoload
(defun string-glyph-compose (string)
"Compose the string STR by according to the Unicode NFC.
This is the canonical composed form. For instance:
(string-glyph-compose \"Å\") => \"Å\""
(ucs-normalize-NFC-string string))
;;;###autoload
(defun string-glyph-decompose (string)
"Decompose the string STR according to the Unicode NFD.
This is the canonical decomposed form. For instance:
(string-glyph-decompose \"Å\") => \"Å\""
(ucs-normalize-NFD-string string))
(defun ucs-normalize-NFC-string (str)
"Compose the string STR by according to the Unicode NFC.
This is the canonical composed form. For instance:
(ucs-normalize-NFC-string \"Å\") => \"Å\""
(ucs-normalize-string ucs-normalize-NFC-region))
(defun ucs-normalize-NFKD-region (from to)
"Normalize the current region by the Unicode NFKD."
"Decompose the current region according to the Unicode NFKD.
This is the compatibility decomposed form."
(interactive "r")
(ucs-normalize-region from to
ucs-normalize-nfkd-quick-check-regexp
'ucs-normalize-nfkd-table nil))
;;;###autoload
(defun ucs-normalize-NFKD-string (str)
"Normalize the string STR by the Unicode NFKD."
"Decompose the string STR according to the Unicode NFKD.
This is the compatibility decomposed form. This is much like the
NFD (canonical decomposed) form, but mainly differs in glyphs
with formatting distinctions. For instance:
(ucs-normalize-NFD-string \"fi\") => \"fi\"
(ucs-normalize-NFKD-string \"fi\") = \"fi\""
(ucs-normalize-string ucs-normalize-NFKD-region))
;;;###autoload
(defun ucs-normalize-NFKC-region (from to)
"Normalize the current region by the Unicode NFKC."
"Compose the current region according to the Unicode NFKC.
The is the compatibility composed form."
(interactive "r")
(ucs-normalize-region from to
ucs-normalize-nfkc-quick-check-regexp
'ucs-normalize-nfkd-table t))
;;;###autoload
(defun ucs-normalize-NFKC-string (str)
"Normalize the string STR by the Unicode NFKC."
"Compose the string STR according to the Unicode NFKC.
This is the compatibility composed form. This is much like the
NFC (canonical composed) form, but mainly differs in glyphs
with formatting distinctions. For instance:
(ucs-normalize-NFC-string \"fi\") => \"fi\"
(ucs-normalize-NFKC-string \"fi\") = \"fi\""
(ucs-normalize-string ucs-normalize-NFKC-region))
;;;###autoload
(defun ucs-normalize-HFS-NFD-region (from to)
"Normalize the current region by the Unicode NFD and Mac OS's HFS Plus."
(interactive "r")
@ -592,18 +625,18 @@ COMPOSITION-PREDICATE will be used to compose region."
ucs-normalize-hfs-nfd-quick-check-regexp
'ucs-normalize-hfs-nfd-table
'ucs-normalize-hfs-nfd-comp-p))
;;;###autoload
(defun ucs-normalize-HFS-NFD-string (str)
"Normalize the string STR by the Unicode NFD and Mac OS's HFS Plus."
(ucs-normalize-string ucs-normalize-HFS-NFD-region))
;;;###autoload
(defun ucs-normalize-HFS-NFC-region (from to)
"Normalize the current region by the Unicode NFC and Mac OS's HFS Plus."
(interactive "r")
(ucs-normalize-region from to
ucs-normalize-hfs-nfc-quick-check-regexp
'ucs-normalize-hfs-nfd-table t))
;;;###autoload
(defun ucs-normalize-HFS-NFC-string (str)
"Normalize the string STR by the Unicode NFC and Mac OS's HFS Plus."
(ucs-normalize-string ucs-normalize-HFS-NFC-region))