diff options
author | Kenichi Handa <handa@m17n.org> | 2008-09-05 00:53:00 +0000 |
---|---|---|
committer | Kenichi Handa <handa@m17n.org> | 2008-09-05 00:53:00 +0000 |
commit | 8b1c87bf324961e9690ea10871a8411f2bc26524 (patch) | |
tree | a7f262c65d78aa97043ed2c7cc3ba6da04dcae7f /lisp/composite.el | |
parent | f5a60b433b824c9bc3abed62a9884423be1a6f94 (diff) | |
download | emacs-8b1c87bf324961e9690ea10871a8411f2bc26524.tar.gz |
(find-composition): Mention about the automatic
composition in the docstring.
Diffstat (limited to 'lisp/composite.el')
-rw-r--r-- | lisp/composite.el | 13 |
1 files changed, 10 insertions, 3 deletions
diff --git a/lisp/composite.el b/lisp/composite.el index 14d55c3c8f2..c47ee190319 100644 --- a/lisp/composite.el +++ b/lisp/composite.el @@ -294,7 +294,7 @@ If the character at POS has `composition' property, the value is a list 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 @@ and composition rules as described in `compose-region'. 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)) |