Mercurial > emacs
changeset 97985:26069577e76b
(find-composition): Mention about the automatic
composition in the docstring.
| author | Kenichi Handa <handa@m17n.org> |
|---|---|
| date | Fri, 05 Sep 2008 00:53:00 +0000 |
| parents | 672009e514b4 |
| children | 64b0e68e3313 |
| files | lisp/composite.el |
| diffstat | 1 files changed, 10 insertions(+), 3 deletions(-) [+] |
line wrap: on
line diff
--- a/lisp/composite.el Fri Sep 05 00:50:27 2008 +0000 +++ b/lisp/composite.el Fri Sep 05 00:53:00 2008 +0000 @@ -294,7 +294,7 @@ of FROM, TO, and VALID-P. FROM and TO specify the range of text that has the same `composition' -property, VALID-P is non-nil if and only if this composition is valid. +property, VALID-P is t if this composition is valid, and nil if not. If there's no composition at POS, and the optional 2nd argument LIMIT is non-nil, search for a composition toward LIMIT. @@ -318,9 +318,16 @@ MOD-FUNC is a modification function of the composition. -WIDTH is a number of columns the composition occupies on the screen." +WIDTH is a number of columns the composition occupies on the screen. + +When Automatic Compostion mode is on, this function also finds a +chunk of text that is automatically composed. If such a chunk is +found closer to POS than the position that has `composition' +property, the value is a list of FROM, TO, and a glyph gstring +the specify how the chunk is composed. See the function +`composition-get-gstring' for the format of the glyph string." (let ((result (find-composition-internal pos limit string detail-p))) - (if (and detail-p result (nth 2 result) (not (nth 3 result))) + (if (and detail-p (> (length result) 3) (nth 2 result) (not (nth 3 result))) ;; This is a valid rule-base composition. (decode-composition-components (nth 2 result) 'nocopy)) result))