aboutsummaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorEli Zaretskii2008-09-27 13:10:56 +0000
committerEli Zaretskii2008-09-27 13:10:56 +0000
commit9d7518593c13889885373f824aafa678f49a9859 (patch)
tree68970a4bf6b163e0b59239a1307a9a3f735e6da2 /src
parent20200aaadacf3118270f092f81e3bc7c27b4024b (diff)
downloademacs-9d7518593c13889885373f824aafa678f49a9859.tar.gz
emacs-9d7518593c13889885373f824aafa678f49a9859.zip
(Fcomposition_get_gstring, Fcompose_region_internal, Fcompose_string_internal)
(Ffind_composition_internal): Doc fix. (syms_of_composite) <compose-chars-after-function>: Doc fix. (syms_of_composite) <auto-composition-function>: Doc fix. (syms_of_composite) <composition-function-table>: Doc fix.
Diffstat (limited to 'src')
-rw-r--r--src/ChangeLog9
-rw-r--r--src/composite.c38
2 files changed, 28 insertions, 19 deletions
diff --git a/src/ChangeLog b/src/ChangeLog
index 6e24106d080..7ceacd2d97b 100644
--- a/src/ChangeLog
+++ b/src/ChangeLog
@@ -1,3 +1,12 @@
12008-09-27 Eli Zaretskii <eliz@gnu.org>
2
3 * composite.c (Fcomposition_get_gstring)
4 (Fcompose_region_internal, Fcompose_string_internal)
5 (Ffind_composition_internal): Doc fix.
6 (syms_of_composite) <compose-chars-after-function>: Doc fix.
7 (syms_of_composite) <auto-composition-function>: Doc fix.
8 (syms_of_composite) <composition-function-table>: Doc fix.
9
12008-09-25 Chong Yidong <cyd@stupidchicken.com> 102008-09-25 Chong Yidong <cyd@stupidchicken.com>
2 11
3 * search.c (wordify): New argument for lax word-ends. 12 * search.c (wordify): New argument for lax word-ends.
diff --git a/src/composite.c b/src/composite.c
index 1ec6f71855f..9b3de0a615c 100644
--- a/src/composite.c
+++ b/src/composite.c
@@ -1452,15 +1452,15 @@ composition_adjust_point (last_pt)
1452DEFUN ("composition-get-gstring", Fcomposition_get_gstring, 1452DEFUN ("composition-get-gstring", Fcomposition_get_gstring,
1453 Scomposition_get_gstring, 4, 4, 0, 1453 Scomposition_get_gstring, 4, 4, 0,
1454 doc: /* Return a glyph-string for characters between FROM and TO. 1454 doc: /* Return a glyph-string for characters between FROM and TO.
1455If the glhph string is for graphic display, FONT-OBJECT must be 1455If the glyph string is for graphic display, FONT-OBJECT must be
1456a font-object to use for those characters. 1456a font-object to use for those characters.
1457Otherwise (for terminal display), FONT-OBJECT must be nil. 1457Otherwise (for terminal display), FONT-OBJECT must be nil.
1458 1458
1459If the optional 4th argument STRING is not nil, it is a string 1459If the optional 4th argument STRING is not nil, it is a string
1460containing the target characters between indices FROM and TO. 1460containing the target characters between indices FROM and TO.
1461 1461
1462A glhph-string is a vector containing information about how to display 1462A glyph-string is a vector containing information about how to display
1463specific character sequence. The format is: 1463a specific character sequence. The format is:
1464 [HEADER ID GLYPH ...] 1464 [HEADER ID GLYPH ...]
1465 1465
1466HEADER is a vector of this form: 1466HEADER is a vector of this form:
@@ -1473,7 +1473,7 @@ where
1473ID is an identification number of the glyph-string. It may be nil if 1473ID is an identification number of the glyph-string. It may be nil if
1474not yet shaped. 1474not yet shaped.
1475 1475
1476GLYPH is a vector whose elements has this form: 1476GLYPH is a vector whose elements have this form:
1477 [ FROM-IDX TO-IDX C CODE WIDTH LBEARING RBEARING ASCENT DESCENT 1477 [ FROM-IDX TO-IDX C CODE WIDTH LBEARING RBEARING ASCENT DESCENT
1478 [ [X-OFF Y-OFF WADJUST] | nil] ] 1478 [ [X-OFF Y-OFF WADJUST] | nil] ]
1479where 1479where
@@ -1481,11 +1481,11 @@ where
1481 C is the character of the glyph. 1481 C is the character of the glyph.
1482 CODE is the glyph-code of C in FONT-OBJECT. 1482 CODE is the glyph-code of C in FONT-OBJECT.
1483 WIDTH thru DESCENT are the metrics (in pixels) of the glyph. 1483 WIDTH thru DESCENT are the metrics (in pixels) of the glyph.
1484 X-OFF and Y-OFF are offests to the base position for the glyph. 1484 X-OFF and Y-OFF are offsets to the base position for the glyph.
1485 WADJUST is the adjustment to the normal width of the glyph. 1485 WADJUST is the adjustment to the normal width of the glyph.
1486 1486
1487If GLYPH is nil, the remaining elements of the glhph-string vector 1487If GLYPH is nil, the remaining elements of the glyph-string vector
1488must be ignore. */) 1488should be ignored. */)
1489 (from, to, font_object, string) 1489 (from, to, font_object, string)
1490 Lisp_Object font_object, from, to, string; 1490 Lisp_Object font_object, from, to, string;
1491{ 1491{
@@ -1520,7 +1520,7 @@ DEFUN ("compose-region-internal", Fcompose_region_internal,
1520 1520
1521Compose text in the region between START and END. 1521Compose text in the region between START and END.
1522Optional 3rd and 4th arguments are COMPONENTS and MODIFICATION-FUNC 1522Optional 3rd and 4th arguments are COMPONENTS and MODIFICATION-FUNC
1523for the composition. See `compose-region' for more detail. */) 1523for the composition. See `compose-region' for more details. */)
1524 (start, end, components, modification_func) 1524 (start, end, components, modification_func)
1525 Lisp_Object start, end, components, modification_func; 1525 Lisp_Object start, end, components, modification_func;
1526{ 1526{
@@ -1541,7 +1541,7 @@ DEFUN ("compose-string-internal", Fcompose_string_internal,
1541 1541
1542Compose text between indices START and END of STRING. 1542Compose text between indices START and END of STRING.
1543Optional 4th and 5th arguments are COMPONENTS and MODIFICATION-FUNC 1543Optional 4th and 5th arguments are COMPONENTS and MODIFICATION-FUNC
1544for the composition. See `compose-string' for more detail. */) 1544for the composition. See `compose-string' for more details. */)
1545 (string, start, end, components, modification_func) 1545 (string, start, end, components, modification_func)
1546 Lisp_Object string, start, end, components, modification_func; 1546 Lisp_Object string, start, end, components, modification_func;
1547{ 1547{
@@ -1563,7 +1563,7 @@ DEFUN ("find-composition-internal", Ffind_composition_internal,
1563 doc: /* Internal use only. 1563 doc: /* Internal use only.
1564 1564
1565Return information about composition at or nearest to position POS. 1565Return information about composition at or nearest to position POS.
1566See `find-composition' for more detail. */) 1566See `find-composition' for more details. */)
1567 (pos, limit, string, detail_p) 1567 (pos, limit, string, detail_p)
1568 Lisp_Object pos, limit, string, detail_p; 1568 Lisp_Object pos, limit, string, detail_p;
1569{ 1569{
@@ -1706,8 +1706,8 @@ syms_of_composite ()
1706 DEFVAR_LISP ("compose-chars-after-function", &Vcompose_chars_after_function, 1706 DEFVAR_LISP ("compose-chars-after-function", &Vcompose_chars_after_function,
1707 doc: /* Function to adjust composition of buffer text. 1707 doc: /* Function to adjust composition of buffer text.
1708 1708
1709The function is called with three arguments FROM, TO, and OBJECT. 1709This function is called with three arguments: FROM, TO, and OBJECT.
1710FROM and TO specify the range of text of which composition should be 1710FROM and TO specify the range of text whose composition should be
1711adjusted. OBJECT, if non-nil, is a string that contains the text. 1711adjusted. OBJECT, if non-nil, is a string that contains the text.
1712 1712
1713This function is called after a text with `composition' property is 1713This function is called after a text with `composition' property is
@@ -1725,7 +1725,7 @@ The default value is the function `compose-chars-after'. */);
1725 1725
1726 DEFVAR_LISP ("auto-composition-function", &Vauto_composition_function, 1726 DEFVAR_LISP ("auto-composition-function", &Vauto_composition_function,
1727 doc: /* Function to call to compose characters automatically. 1727 doc: /* Function to call to compose characters automatically.
1728The function is called from the display routine with four arguments, 1728This function is called from the display routine with four arguments:
1729FROM, TO, WINDOW, and STRING. 1729FROM, TO, WINDOW, and STRING.
1730 1730
1731If STRING is nil, the function must compose characters in the region 1731If STRING is nil, the function must compose characters in the region
@@ -1737,7 +1737,7 @@ string. */);
1737 Vauto_composition_function = Qnil; 1737 Vauto_composition_function = Qnil;
1738 1738
1739 DEFVAR_LISP ("composition-function-table", &Vcomposition_function_table, 1739 DEFVAR_LISP ("composition-function-table", &Vcomposition_function_table,
1740 doc: /* Char-able of functions for automatic character composition. 1740 doc: /* Char-table of functions for automatic character composition.
1741For each character that has to be composed automatically with 1741For each character that has to be composed automatically with
1742preceding and/or following characters, this char-table contains 1742preceding and/or following characters, this char-table contains
1743a function to call to compose that character. 1743a function to call to compose that character.
@@ -1745,25 +1745,25 @@ a function to call to compose that character.
1745The element at index C in the table, if non-nil, is a list of 1745The element at index C in the table, if non-nil, is a list of
1746this form: ([PATTERN PREV-CHARS FUNC] ...) 1746this form: ([PATTERN PREV-CHARS FUNC] ...)
1747 1747
1748PATTERN is a regular expression with which C and the surrounding 1748PATTERN is a regular expression which C and the surrounding
1749characters must match. 1749characters must match.
1750 1750
1751PREV-CHARS is a number of characters before C to check the 1751PREV-CHARS is a number of characters before C to check the
1752matching with PATTERN. If it is 0, PATTERN must match with C and 1752matching with PATTERN. If it is 0, PATTERN must match C and
1753the following characters. If it is 1, PATTERN must match with a 1753the following characters. If it is 1, PATTERN must match a
1754character before C and the following characters. 1754character before C and the following characters.
1755 1755
1756If PREV-CHARS is 0, PATTERN can be nil, which means that the 1756If PREV-CHARS is 0, PATTERN can be nil, which means that the
1757single character C should be composed. 1757single character C should be composed.
1758 1758
1759FUNC is a function to return a glyph-string representing a 1759FUNC is a function to return a glyph-string representing a
1760composition of the characters matching with PATTERN. It is 1760composition of the characters that match PATTERN. It is
1761called with one argument GSTRING. 1761called with one argument GSTRING.
1762 1762
1763GSTRING is a template of a glyph-string to return. It is already 1763GSTRING is a template of a glyph-string to return. It is already
1764filled with a proper header for the characters to compose, and 1764filled with a proper header for the characters to compose, and
1765glyphs corresponding to those characters one by one. The 1765glyphs corresponding to those characters one by one. The
1766function must return a new glyph-string of the same header as 1766function must return a new glyph-string with the same header as
1767GSTRING, or modify GSTRING itself and return it. 1767GSTRING, or modify GSTRING itself and return it.
1768 1768
1769See also the documentation of `auto-composition-mode'. */); 1769See also the documentation of `auto-composition-mode'. */);