annotate doc/lispref/text.texi @ 103458:29ff3f8b1e3b

(Dedicated Windows): Fix typo. (Resizing Windows): Replace @defun by @deffn.
author Martin Rudalics <rudalics@gmx.at>
date Wed, 17 Jun 2009 05:55:42 +0000
parents c32ec20d0ab5
children 9b3f664fc049
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
84103
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1 @c -*-texinfo-*-
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2 @c This is part of the GNU Emacs Lisp Reference Manual.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3 @c Copyright (C) 1990, 1991, 1992, 1993, 1994, 1995, 1998, 1999, 2000, 2001,
100974
cb5d2387102c Add 2009 to copyright years.
Glenn Morris <rgm@gnu.org>
parents: 98759
diff changeset
4 @c 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 Free Software Foundation, Inc.
84103
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5 @c See the file elisp.texi for copying conditions.
84116
0ba80d073e27 (setfilename): Go up one more level to ../../info.
Glenn Morris <rgm@gnu.org>
parents: 84103
diff changeset
6 @setfilename ../../info/text
84103
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7 @node Text, Non-ASCII Characters, Markers, Top
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8 @chapter Text
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9 @cindex text
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11 This chapter describes the functions that deal with the text in a
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12 buffer. Most examine, insert, or delete text in the current buffer,
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13 often operating at point or on text adjacent to point. Many are
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14 interactive. All the functions that change the text provide for undoing
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15 the changes (@pxref{Undo}).
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17 Many text-related functions operate on a region of text defined by two
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18 buffer positions passed in arguments named @var{start} and @var{end}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19 These arguments should be either markers (@pxref{Markers}) or numeric
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20 character positions (@pxref{Positions}). The order of these arguments
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21 does not matter; it is all right for @var{start} to be the end of the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22 region and @var{end} the beginning. For example, @code{(delete-region 1
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
23 10)} and @code{(delete-region 10 1)} are equivalent. An
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
24 @code{args-out-of-range} error is signaled if either @var{start} or
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
25 @var{end} is outside the accessible portion of the buffer. In an
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
26 interactive call, point and the mark are used for these arguments.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
27
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
28 @cindex buffer contents
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
29 Throughout this chapter, ``text'' refers to the characters in the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
30 buffer, together with their properties (when relevant). Keep in mind
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
31 that point is always between two characters, and the cursor appears on
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
32 the character after point.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
33
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
34 @menu
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
35 * Near Point:: Examining text in the vicinity of point.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
36 * Buffer Contents:: Examining text in a general fashion.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
37 * Comparing Text:: Comparing substrings of buffers.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
38 * Insertion:: Adding new text to a buffer.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
39 * Commands for Insertion:: User-level commands to insert text.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
40 * Deletion:: Removing text from a buffer.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
41 * User-Level Deletion:: User-level commands to delete text.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
42 * The Kill Ring:: Where removed text sometimes is saved for later use.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
43 * Undo:: Undoing changes to the text of a buffer.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
44 * Maintaining Undo:: How to enable and disable undo information.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
45 How to control how much information is kept.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
46 * Filling:: Functions for explicit filling.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
47 * Margins:: How to specify margins for filling commands.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
48 * Adaptive Fill:: Adaptive Fill mode chooses a fill prefix from context.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
49 * Auto Filling:: How auto-fill mode is implemented to break lines.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
50 * Sorting:: Functions for sorting parts of the buffer.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
51 * Columns:: Computing horizontal positions, and using them.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
52 * Indentation:: Functions to insert or adjust indentation.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
53 * Case Changes:: Case conversion of parts of the buffer.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
54 * Text Properties:: Assigning Lisp property lists to text characters.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
55 * Substitution:: Replacing a given character wherever it appears.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
56 * Transposition:: Swapping two portions of a buffer.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
57 * Registers:: How registers are implemented. Accessing the text or
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
58 position stored in a register.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
59 * Base 64:: Conversion to or from base 64 encoding.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
60 * MD5 Checksum:: Compute the MD5 "message digest"/"checksum".
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
61 * Atomic Changes:: Installing several buffer changes "atomically".
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
62 * Change Hooks:: Supplying functions to be run when text is changed.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
63 @end menu
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
64
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
65 @node Near Point
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
66 @section Examining Text Near Point
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
67 @cindex text near point
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
68
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
69 Many functions are provided to look at the characters around point.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
70 Several simple functions are described here. See also @code{looking-at}
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
71 in @ref{Regexp Search}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
72
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
73 In the following four functions, ``beginning'' or ``end'' of buffer
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
74 refers to the beginning or end of the accessible portion.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
75
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
76 @defun char-after &optional position
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
77 This function returns the character in the current buffer at (i.e.,
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
78 immediately after) position @var{position}. If @var{position} is out of
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
79 range for this purpose, either before the beginning of the buffer, or at
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
80 or beyond the end, then the value is @code{nil}. The default for
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
81 @var{position} is point.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
82
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
83 In the following example, assume that the first character in the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
84 buffer is @samp{@@}:
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
85
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
86 @example
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
87 @group
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
88 (char-to-string (char-after 1))
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
89 @result{} "@@"
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
90 @end group
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
91 @end example
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
92 @end defun
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
93
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
94 @defun char-before &optional position
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
95 This function returns the character in the current buffer immediately
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
96 before position @var{position}. If @var{position} is out of range for
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
97 this purpose, either at or before the beginning of the buffer, or beyond
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
98 the end, then the value is @code{nil}. The default for
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
99 @var{position} is point.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
100 @end defun
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
101
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
102 @defun following-char
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
103 This function returns the character following point in the current
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
104 buffer. This is similar to @code{(char-after (point))}. However, if
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
105 point is at the end of the buffer, then @code{following-char} returns 0.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
106
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
107 Remember that point is always between characters, and the cursor
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
108 normally appears over the character following point. Therefore, the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
109 character returned by @code{following-char} is the character the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
110 cursor is over.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
111
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
112 In this example, point is between the @samp{a} and the @samp{c}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
113
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
114 @example
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
115 @group
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
116 ---------- Buffer: foo ----------
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
117 Gentlemen may cry ``Pea@point{}ce! Peace!,''
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
118 but there is no peace.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
119 ---------- Buffer: foo ----------
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
120 @end group
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
121
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
122 @group
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
123 (char-to-string (preceding-char))
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
124 @result{} "a"
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
125 (char-to-string (following-char))
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
126 @result{} "c"
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
127 @end group
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
128 @end example
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
129 @end defun
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
130
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
131 @defun preceding-char
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
132 This function returns the character preceding point in the current
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
133 buffer. See above, under @code{following-char}, for an example. If
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
134 point is at the beginning of the buffer, @code{preceding-char} returns
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
135 0.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
136 @end defun
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
137
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
138 @defun bobp
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
139 This function returns @code{t} if point is at the beginning of the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
140 buffer. If narrowing is in effect, this means the beginning of the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
141 accessible portion of the text. See also @code{point-min} in
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
142 @ref{Point}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
143 @end defun
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
144
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
145 @defun eobp
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
146 This function returns @code{t} if point is at the end of the buffer.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
147 If narrowing is in effect, this means the end of accessible portion of
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
148 the text. See also @code{point-max} in @xref{Point}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
149 @end defun
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
150
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
151 @defun bolp
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
152 This function returns @code{t} if point is at the beginning of a line.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
153 @xref{Text Lines}. The beginning of the buffer (or of its accessible
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
154 portion) always counts as the beginning of a line.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
155 @end defun
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
156
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
157 @defun eolp
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
158 This function returns @code{t} if point is at the end of a line. The
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
159 end of the buffer (or of its accessible portion) is always considered
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
160 the end of a line.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
161 @end defun
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
162
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
163 @node Buffer Contents
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
164 @section Examining Buffer Contents
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
165
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
166 This section describes functions that allow a Lisp program to
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
167 convert any portion of the text in the buffer into a string.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
168
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
169 @defun buffer-substring start end
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
170 This function returns a string containing a copy of the text of the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
171 region defined by positions @var{start} and @var{end} in the current
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
172 buffer. If the arguments are not positions in the accessible portion of
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
173 the buffer, @code{buffer-substring} signals an @code{args-out-of-range}
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
174 error.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
175
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
176 It is not necessary for @var{start} to be less than @var{end}; the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
177 arguments can be given in either order. But most often the smaller
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
178 argument is written first.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
179
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
180 Here's an example which assumes Font-Lock mode is not enabled:
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
181
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
182 @example
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
183 @group
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
184 ---------- Buffer: foo ----------
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
185 This is the contents of buffer foo
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
186
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
187 ---------- Buffer: foo ----------
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
188 @end group
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
189
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
190 @group
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
191 (buffer-substring 1 10)
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
192 @result{} "This is t"
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
193 @end group
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
194 @group
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
195 (buffer-substring (point-max) 10)
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
196 @result{} "he contents of buffer foo\n"
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
197 @end group
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
198 @end example
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
199
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
200 If the text being copied has any text properties, these are copied into
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
201 the string along with the characters they belong to. @xref{Text
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
202 Properties}. However, overlays (@pxref{Overlays}) in the buffer and
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
203 their properties are ignored, not copied.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
204
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
205 For example, if Font-Lock mode is enabled, you might get results like
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
206 these:
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
207
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
208 @example
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
209 @group
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
210 (buffer-substring 1 10)
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
211 @result{} #("This is t" 0 1 (fontified t) 1 9 (fontified t))
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
212 @end group
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
213 @end example
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
214 @end defun
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
215
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
216 @defun buffer-substring-no-properties start end
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
217 This is like @code{buffer-substring}, except that it does not copy text
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
218 properties, just the characters themselves. @xref{Text Properties}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
219 @end defun
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
220
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
221 @defun filter-buffer-substring start end &optional delete noprops
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
222 This function passes the buffer text between @var{start} and @var{end}
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
223 through the filter functions specified by the variable
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
224 @code{buffer-substring-filters}, and returns the value from the last
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
225 filter function. If @code{buffer-substring-filters} is @code{nil},
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
226 the value is the unaltered text from the buffer, what
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
227 @code{buffer-substring} would return.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
228
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
229 If @var{delete} is non-@code{nil}, this function deletes the text
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
230 between @var{start} and @var{end} after copying it, like
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
231 @code{delete-and-extract-region}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
232
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
233 If @var{noprops} is non-@code{nil}, the final string returned does not
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
234 include text properties, while the string passed through the filters
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
235 still includes text properties from the buffer text.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
236
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
237 Lisp code should use this function instead of @code{buffer-substring},
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
238 @code{buffer-substring-no-properties},
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
239 or @code{delete-and-extract-region} when copying into user-accessible
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
240 data structures such as the kill-ring, X clipboard, and registers.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
241 Major and minor modes can add functions to
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
242 @code{buffer-substring-filters} to alter such text as it is copied out
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
243 of the buffer.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
244 @end defun
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
245
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
246 @defvar buffer-substring-filters
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
247 This variable should be a list of functions that accept a single
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
248 argument, a string, and return a string.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
249 @code{filter-buffer-substring} passes the buffer substring to the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
250 first function in this list, and the return value of each function is
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
251 passed to the next function. The return value of the last function is
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
252 used as the return value of @code{filter-buffer-substring}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
253
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
254 As a special convention, point is set to the start of the buffer text
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
255 being operated on (i.e., the @var{start} argument for
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
256 @code{filter-buffer-substring}) before these functions are called.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
257
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
258 If this variable is @code{nil}, no filtering is performed.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
259 @end defvar
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
260
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
261 @defun buffer-string
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
262 This function returns the contents of the entire accessible portion of
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
263 the current buffer as a string. It is equivalent to
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
264
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
265 @example
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
266 (buffer-substring (point-min) (point-max))
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
267 @end example
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
268
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
269 @example
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
270 @group
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
271 ---------- Buffer: foo ----------
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
272 This is the contents of buffer foo
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
273
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
274 ---------- Buffer: foo ----------
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
275
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
276 (buffer-string)
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
277 @result{} "This is the contents of buffer foo\n"
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
278 @end group
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
279 @end example
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
280 @end defun
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
281
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
282 @defun current-word &optional strict really-word
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
283 This function returns the symbol (or word) at or near point, as a string.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
284 The return value includes no text properties.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
285
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
286 If the optional argument @var{really-word} is non-@code{nil}, it finds a
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
287 word; otherwise, it finds a symbol (which includes both word
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
288 characters and symbol constituent characters).
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
289
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
290 If the optional argument @var{strict} is non-@code{nil}, then point
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
291 must be in or next to the symbol or word---if no symbol or word is
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
292 there, the function returns @code{nil}. Otherwise, a nearby symbol or
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
293 word on the same line is acceptable.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
294 @end defun
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
295
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
296 @defun thing-at-point thing
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
297 Return the @var{thing} around or next to point, as a string.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
298
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
299 The argument @var{thing} is a symbol which specifies a kind of syntactic
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
300 entity. Possibilities include @code{symbol}, @code{list}, @code{sexp},
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
301 @code{defun}, @code{filename}, @code{url}, @code{word}, @code{sentence},
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
302 @code{whitespace}, @code{line}, @code{page}, and others.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
303
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
304 @example
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
305 ---------- Buffer: foo ----------
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
306 Gentlemen may cry ``Pea@point{}ce! Peace!,''
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
307 but there is no peace.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
308 ---------- Buffer: foo ----------
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
309
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
310 (thing-at-point 'word)
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
311 @result{} "Peace"
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
312 (thing-at-point 'line)
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
313 @result{} "Gentlemen may cry ``Peace! Peace!,''\n"
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
314 (thing-at-point 'whitespace)
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
315 @result{} nil
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
316 @end example
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
317 @end defun
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
318
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
319 @node Comparing Text
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
320 @section Comparing Text
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
321 @cindex comparing buffer text
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
322
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
323 This function lets you compare portions of the text in a buffer, without
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
324 copying them into strings first.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
325
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
326 @defun compare-buffer-substrings buffer1 start1 end1 buffer2 start2 end2
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
327 This function lets you compare two substrings of the same buffer or two
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
328 different buffers. The first three arguments specify one substring,
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
329 giving a buffer (or a buffer name) and two positions within the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
330 buffer. The last three arguments specify the other substring in the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
331 same way. You can use @code{nil} for @var{buffer1}, @var{buffer2}, or
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
332 both to stand for the current buffer.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
333
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
334 The value is negative if the first substring is less, positive if the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
335 first is greater, and zero if they are equal. The absolute value of
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
336 the result is one plus the index of the first differing characters
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
337 within the substrings.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
338
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
339 This function ignores case when comparing characters
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
340 if @code{case-fold-search} is non-@code{nil}. It always ignores
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
341 text properties.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
342
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
343 Suppose the current buffer contains the text @samp{foobarbar
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
344 haha!rara!}; then in this example the two substrings are @samp{rbar }
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
345 and @samp{rara!}. The value is 2 because the first substring is greater
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
346 at the second character.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
347
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
348 @example
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
349 (compare-buffer-substrings nil 6 11 nil 16 21)
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
350 @result{} 2
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
351 @end example
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
352 @end defun
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
353
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
354 @node Insertion
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
355 @section Inserting Text
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
356 @cindex insertion of text
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
357 @cindex text insertion
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
358
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
359 @cindex insertion before point
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
360 @cindex before point, insertion
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
361 @dfn{Insertion} means adding new text to a buffer. The inserted text
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
362 goes at point---between the character before point and the character
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
363 after point. Some insertion functions leave point before the inserted
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
364 text, while other functions leave it after. We call the former
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
365 insertion @dfn{after point} and the latter insertion @dfn{before point}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
366
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
367 Insertion relocates markers that point at positions after the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
368 insertion point, so that they stay with the surrounding text
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
369 (@pxref{Markers}). When a marker points at the place of insertion,
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
370 insertion may or may not relocate the marker, depending on the marker's
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
371 insertion type (@pxref{Marker Insertion Types}). Certain special
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
372 functions such as @code{insert-before-markers} relocate all such markers
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
373 to point after the inserted text, regardless of the markers' insertion
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
374 type.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
375
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
376 Insertion functions signal an error if the current buffer is
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
377 read-only or if they insert within read-only text.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
378
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
379 These functions copy text characters from strings and buffers along
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
380 with their properties. The inserted characters have exactly the same
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
381 properties as the characters they were copied from. By contrast,
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
382 characters specified as separate arguments, not part of a string or
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
383 buffer, inherit their text properties from the neighboring text.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
384
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
385 The insertion functions convert text from unibyte to multibyte in
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
386 order to insert in a multibyte buffer, and vice versa---if the text
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
387 comes from a string or from a buffer. However, they do not convert
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
388 unibyte character codes 128 through 255 to multibyte characters, not
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
389 even if the current buffer is a multibyte buffer. @xref{Converting
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
390 Representations}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
391
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
392 @defun insert &rest args
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
393 This function inserts the strings and/or characters @var{args} into the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
394 current buffer, at point, moving point forward. In other words, it
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
395 inserts the text before point. An error is signaled unless all
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
396 @var{args} are either strings or characters. The value is @code{nil}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
397 @end defun
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
398
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
399 @defun insert-before-markers &rest args
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
400 This function inserts the strings and/or characters @var{args} into the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
401 current buffer, at point, moving point forward. An error is signaled
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
402 unless all @var{args} are either strings or characters. The value is
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
403 @code{nil}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
404
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
405 This function is unlike the other insertion functions in that it
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
406 relocates markers initially pointing at the insertion point, to point
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
407 after the inserted text. If an overlay begins at the insertion point,
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
408 the inserted text falls outside the overlay; if a nonempty overlay
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
409 ends at the insertion point, the inserted text falls inside that
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
410 overlay.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
411 @end defun
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
412
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
413 @defun insert-char character count &optional inherit
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
414 This function inserts @var{count} instances of @var{character} into the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
415 current buffer before point. The argument @var{count} should be an
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
416 integer, and @var{character} must be a character. The value is @code{nil}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
417
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
418 This function does not convert unibyte character codes 128 through 255
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
419 to multibyte characters, not even if the current buffer is a multibyte
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
420 buffer. @xref{Converting Representations}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
421
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
422 If @var{inherit} is non-@code{nil}, then the inserted characters inherit
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
423 sticky text properties from the two characters before and after the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
424 insertion point. @xref{Sticky Properties}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
425 @end defun
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
426
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
427 @defun insert-buffer-substring from-buffer-or-name &optional start end
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
428 This function inserts a portion of buffer @var{from-buffer-or-name}
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
429 (which must already exist) into the current buffer before point. The
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
430 text inserted is the region between @var{start} and @var{end}. (These
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
431 arguments default to the beginning and end of the accessible portion of
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
432 that buffer.) This function returns @code{nil}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
433
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
434 In this example, the form is executed with buffer @samp{bar} as the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
435 current buffer. We assume that buffer @samp{bar} is initially empty.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
436
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
437 @example
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
438 @group
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
439 ---------- Buffer: foo ----------
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
440 We hold these truths to be self-evident, that all
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
441 ---------- Buffer: foo ----------
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
442 @end group
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
443
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
444 @group
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
445 (insert-buffer-substring "foo" 1 20)
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
446 @result{} nil
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
447
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
448 ---------- Buffer: bar ----------
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
449 We hold these truth@point{}
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
450 ---------- Buffer: bar ----------
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
451 @end group
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
452 @end example
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
453 @end defun
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
454
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
455 @defun insert-buffer-substring-no-properties from-buffer-or-name &optional start end
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
456 This is like @code{insert-buffer-substring} except that it does not
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
457 copy any text properties.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
458 @end defun
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
459
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
460 @xref{Sticky Properties}, for other insertion functions that inherit
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
461 text properties from the nearby text in addition to inserting it.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
462 Whitespace inserted by indentation functions also inherits text
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
463 properties.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
464
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
465 @node Commands for Insertion
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
466 @section User-Level Insertion Commands
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
467
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
468 This section describes higher-level commands for inserting text,
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
469 commands intended primarily for the user but useful also in Lisp
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
470 programs.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
471
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
472 @deffn Command insert-buffer from-buffer-or-name
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
473 This command inserts the entire accessible contents of
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
474 @var{from-buffer-or-name} (which must exist) into the current buffer
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
475 after point. It leaves the mark after the inserted text. The value
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
476 is @code{nil}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
477 @end deffn
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
478
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
479 @deffn Command self-insert-command count
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
480 @cindex character insertion
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
481 @cindex self-insertion
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
482 This command inserts the last character typed; it does so @var{count}
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
483 times, before point, and returns @code{nil}. Most printing characters
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
484 are bound to this command. In routine use, @code{self-insert-command}
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
485 is the most frequently called function in Emacs, but programs rarely use
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
486 it except to install it on a keymap.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
487
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
488 In an interactive call, @var{count} is the numeric prefix argument.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
489
101863
2e2da354b49a (Commands for Insertion): Reinstate documentation of
Eli Zaretskii <eliz@gnu.org>
parents: 100974
diff changeset
490 Self-insertion translates the input character through
2e2da354b49a (Commands for Insertion): Reinstate documentation of
Eli Zaretskii <eliz@gnu.org>
parents: 100974
diff changeset
491 @code{translation-table-for-input}. @xref{Translation of Characters}.
2e2da354b49a (Commands for Insertion): Reinstate documentation of
Eli Zaretskii <eliz@gnu.org>
parents: 100974
diff changeset
492
84103
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
493 This command calls @code{auto-fill-function} whenever that is
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
494 non-@code{nil} and the character inserted is in the table
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
495 @code{auto-fill-chars} (@pxref{Auto Filling}).
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
496
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
497 @c Cross refs reworded to prevent overfull hbox. --rjc 15mar92
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
498 This command performs abbrev expansion if Abbrev mode is enabled and
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
499 the inserted character does not have word-constituent
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
500 syntax. (@xref{Abbrevs}, and @ref{Syntax Class Table}.) It is also
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
501 responsible for calling @code{blink-paren-function} when the inserted
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
502 character has close parenthesis syntax (@pxref{Blinking}).
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
503
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
504 Do not try substituting your own definition of
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
505 @code{self-insert-command} for the standard one. The editor command
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
506 loop handles this function specially.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
507 @end deffn
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
508
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
509 @deffn Command newline &optional number-of-newlines
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
510 This command inserts newlines into the current buffer before point.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
511 If @var{number-of-newlines} is supplied, that many newline characters
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
512 are inserted.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
513
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
514 @cindex newline and Auto Fill mode
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
515 This function calls @code{auto-fill-function} if the current column
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
516 number is greater than the value of @code{fill-column} and
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
517 @var{number-of-newlines} is @code{nil}. Typically what
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
518 @code{auto-fill-function} does is insert a newline; thus, the overall
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
519 result in this case is to insert two newlines at different places: one
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
520 at point, and another earlier in the line. @code{newline} does not
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
521 auto-fill if @var{number-of-newlines} is non-@code{nil}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
522
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
523 This command indents to the left margin if that is not zero.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
524 @xref{Margins}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
525
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
526 The value returned is @code{nil}. In an interactive call, @var{count}
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
527 is the numeric prefix argument.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
528 @end deffn
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
529
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
530 @defvar overwrite-mode
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
531 This variable controls whether overwrite mode is in effect. The value
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
532 should be @code{overwrite-mode-textual}, @code{overwrite-mode-binary},
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
533 or @code{nil}. @code{overwrite-mode-textual} specifies textual
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
534 overwrite mode (treats newlines and tabs specially), and
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
535 @code{overwrite-mode-binary} specifies binary overwrite mode (treats
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
536 newlines and tabs like any other characters).
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
537 @end defvar
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
538
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
539 @node Deletion
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
540 @section Deleting Text
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
541 @cindex text deletion
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
542
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
543 @cindex deleting text vs killing
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
544 Deletion means removing part of the text in a buffer, without saving
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
545 it in the kill ring (@pxref{The Kill Ring}). Deleted text can't be
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
546 yanked, but can be reinserted using the undo mechanism (@pxref{Undo}).
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
547 Some deletion functions do save text in the kill ring in some special
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
548 cases.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
549
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
550 All of the deletion functions operate on the current buffer.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
551
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
552 @deffn Command erase-buffer
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
553 This function deletes the entire text of the current buffer
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
554 (@emph{not} just the accessible portion), leaving it
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
555 empty. If the buffer is read-only, it signals a @code{buffer-read-only}
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
556 error; if some of the text in it is read-only, it signals a
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
557 @code{text-read-only} error. Otherwise, it deletes the text without
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
558 asking for any confirmation. It returns @code{nil}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
559
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
560 Normally, deleting a large amount of text from a buffer inhibits further
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
561 auto-saving of that buffer ``because it has shrunk.'' However,
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
562 @code{erase-buffer} does not do this, the idea being that the future
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
563 text is not really related to the former text, and its size should not
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
564 be compared with that of the former text.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
565 @end deffn
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
566
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
567 @deffn Command delete-region start end
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
568 This command deletes the text between positions @var{start} and
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
569 @var{end} in the current buffer, and returns @code{nil}. If point was
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
570 inside the deleted region, its value afterward is @var{start}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
571 Otherwise, point relocates with the surrounding text, as markers do.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
572 @end deffn
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
573
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
574 @defun delete-and-extract-region start end
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
575 This function deletes the text between positions @var{start} and
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
576 @var{end} in the current buffer, and returns a string containing the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
577 text just deleted.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
578
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
579 If point was inside the deleted region, its value afterward is
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
580 @var{start}. Otherwise, point relocates with the surrounding text, as
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
581 markers do.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
582 @end defun
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
583
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
584 @deffn Command delete-char count &optional killp
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
585 This command deletes @var{count} characters directly after point, or
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
586 before point if @var{count} is negative. If @var{killp} is
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
587 non-@code{nil}, then it saves the deleted characters in the kill ring.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
588
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
589 In an interactive call, @var{count} is the numeric prefix argument, and
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
590 @var{killp} is the unprocessed prefix argument. Therefore, if a prefix
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
591 argument is supplied, the text is saved in the kill ring. If no prefix
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
592 argument is supplied, then one character is deleted, but not saved in
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
593 the kill ring.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
594
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
595 The value returned is always @code{nil}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
596 @end deffn
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
597
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
598 @deffn Command delete-backward-char count &optional killp
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
599 @cindex deleting previous char
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
600 This command deletes @var{count} characters directly before point, or
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
601 after point if @var{count} is negative. If @var{killp} is
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
602 non-@code{nil}, then it saves the deleted characters in the kill ring.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
603
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
604 In an interactive call, @var{count} is the numeric prefix argument, and
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
605 @var{killp} is the unprocessed prefix argument. Therefore, if a prefix
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
606 argument is supplied, the text is saved in the kill ring. If no prefix
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
607 argument is supplied, then one character is deleted, but not saved in
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
608 the kill ring.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
609
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
610 The value returned is always @code{nil}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
611 @end deffn
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
612
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
613 @deffn Command backward-delete-char-untabify count &optional killp
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
614 @cindex tab deletion
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
615 This command deletes @var{count} characters backward, changing tabs
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
616 into spaces. When the next character to be deleted is a tab, it is
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
617 first replaced with the proper number of spaces to preserve alignment
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
618 and then one of those spaces is deleted instead of the tab. If
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
619 @var{killp} is non-@code{nil}, then the command saves the deleted
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
620 characters in the kill ring.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
621
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
622 Conversion of tabs to spaces happens only if @var{count} is positive.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
623 If it is negative, exactly @minus{}@var{count} characters after point
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
624 are deleted.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
625
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
626 In an interactive call, @var{count} is the numeric prefix argument, and
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
627 @var{killp} is the unprocessed prefix argument. Therefore, if a prefix
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
628 argument is supplied, the text is saved in the kill ring. If no prefix
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
629 argument is supplied, then one character is deleted, but not saved in
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
630 the kill ring.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
631
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
632 The value returned is always @code{nil}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
633 @end deffn
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
634
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
635 @defopt backward-delete-char-untabify-method
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
636 This option specifies how @code{backward-delete-char-untabify} should
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
637 deal with whitespace. Possible values include @code{untabify}, the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
638 default, meaning convert a tab to many spaces and delete one;
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
639 @code{hungry}, meaning delete all tabs and spaces before point with
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
640 one command; @code{all} meaning delete all tabs, spaces and newlines
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
641 before point, and @code{nil}, meaning do nothing special for
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
642 whitespace characters.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
643 @end defopt
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
644
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
645 @node User-Level Deletion
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
646 @section User-Level Deletion Commands
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
647
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
648 This section describes higher-level commands for deleting text,
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
649 commands intended primarily for the user but useful also in Lisp
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
650 programs.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
651
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
652 @deffn Command delete-horizontal-space &optional backward-only
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
653 @cindex deleting whitespace
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
654 This function deletes all spaces and tabs around point. It returns
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
655 @code{nil}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
656
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
657 If @var{backward-only} is non-@code{nil}, the function deletes
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
658 spaces and tabs before point, but not after point.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
659
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
660 In the following examples, we call @code{delete-horizontal-space} four
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
661 times, once on each line, with point between the second and third
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
662 characters on the line each time.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
663
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
664 @example
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
665 @group
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
666 ---------- Buffer: foo ----------
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
667 I @point{}thought
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
668 I @point{} thought
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
669 We@point{} thought
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
670 Yo@point{}u thought
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
671 ---------- Buffer: foo ----------
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
672 @end group
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
673
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
674 @group
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
675 (delete-horizontal-space) ; @r{Four times.}
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
676 @result{} nil
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
677
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
678 ---------- Buffer: foo ----------
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
679 Ithought
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
680 Ithought
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
681 Wethought
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
682 You thought
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
683 ---------- Buffer: foo ----------
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
684 @end group
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
685 @end example
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
686 @end deffn
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
687
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
688 @deffn Command delete-indentation &optional join-following-p
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
689 This function joins the line point is on to the previous line, deleting
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
690 any whitespace at the join and in some cases replacing it with one
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
691 space. If @var{join-following-p} is non-@code{nil},
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
692 @code{delete-indentation} joins this line to the following line
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
693 instead. The function returns @code{nil}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
694
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
695 If there is a fill prefix, and the second of the lines being joined
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
696 starts with the prefix, then @code{delete-indentation} deletes the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
697 fill prefix before joining the lines. @xref{Margins}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
698
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
699 In the example below, point is located on the line starting
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
700 @samp{events}, and it makes no difference if there are trailing spaces
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
701 in the preceding line.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
702
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
703 @smallexample
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
704 @group
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
705 ---------- Buffer: foo ----------
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
706 When in the course of human
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
707 @point{} events, it becomes necessary
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
708 ---------- Buffer: foo ----------
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
709 @end group
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
710
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
711 (delete-indentation)
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
712 @result{} nil
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
713
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
714 @group
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
715 ---------- Buffer: foo ----------
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
716 When in the course of human@point{} events, it becomes necessary
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
717 ---------- Buffer: foo ----------
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
718 @end group
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
719 @end smallexample
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
720
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
721 After the lines are joined, the function @code{fixup-whitespace} is
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
722 responsible for deciding whether to leave a space at the junction.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
723 @end deffn
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
724
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
725 @deffn Command fixup-whitespace
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
726 This function replaces all the horizontal whitespace surrounding point
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
727 with either one space or no space, according to the context. It
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
728 returns @code{nil}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
729
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
730 At the beginning or end of a line, the appropriate amount of space is
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
731 none. Before a character with close parenthesis syntax, or after a
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
732 character with open parenthesis or expression-prefix syntax, no space is
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
733 also appropriate. Otherwise, one space is appropriate. @xref{Syntax
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
734 Class Table}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
735
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
736 In the example below, @code{fixup-whitespace} is called the first time
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
737 with point before the word @samp{spaces} in the first line. For the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
738 second invocation, point is directly after the @samp{(}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
739
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
740 @smallexample
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
741 @group
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
742 ---------- Buffer: foo ----------
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
743 This has too many @point{}spaces
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
744 This has too many spaces at the start of (@point{} this list)
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
745 ---------- Buffer: foo ----------
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
746 @end group
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
747
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
748 @group
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
749 (fixup-whitespace)
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
750 @result{} nil
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
751 (fixup-whitespace)
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
752 @result{} nil
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
753 @end group
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
754
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
755 @group
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
756 ---------- Buffer: foo ----------
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
757 This has too many spaces
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
758 This has too many spaces at the start of (this list)
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
759 ---------- Buffer: foo ----------
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
760 @end group
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
761 @end smallexample
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
762 @end deffn
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
763
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
764 @deffn Command just-one-space &optional n
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
765 @comment !!SourceFile simple.el
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
766 This command replaces any spaces and tabs around point with a single
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
767 space, or @var{n} spaces if @var{n} is specified. It returns
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
768 @code{nil}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
769 @end deffn
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
770
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
771 @deffn Command delete-blank-lines
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
772 This function deletes blank lines surrounding point. If point is on a
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
773 blank line with one or more blank lines before or after it, then all but
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
774 one of them are deleted. If point is on an isolated blank line, then it
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
775 is deleted. If point is on a nonblank line, the command deletes all
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
776 blank lines immediately following it.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
777
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
778 A blank line is defined as a line containing only tabs and spaces.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
779
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
780 @code{delete-blank-lines} returns @code{nil}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
781 @end deffn
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
782
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
783 @node The Kill Ring
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
784 @section The Kill Ring
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
785 @cindex kill ring
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
786
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
787 @dfn{Kill functions} delete text like the deletion functions, but save
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
788 it so that the user can reinsert it by @dfn{yanking}. Most of these
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
789 functions have @samp{kill-} in their name. By contrast, the functions
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
790 whose names start with @samp{delete-} normally do not save text for
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
791 yanking (though they can still be undone); these are ``deletion''
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
792 functions.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
793
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
794 Most of the kill commands are primarily for interactive use, and are
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
795 not described here. What we do describe are the functions provided for
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
796 use in writing such commands. You can use these functions to write
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
797 commands for killing text. When you need to delete text for internal
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
798 purposes within a Lisp function, you should normally use deletion
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
799 functions, so as not to disturb the kill ring contents.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
800 @xref{Deletion}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
801
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
802 Killed text is saved for later yanking in the @dfn{kill ring}. This
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
803 is a list that holds a number of recent kills, not just the last text
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
804 kill. We call this a ``ring'' because yanking treats it as having
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
805 elements in a cyclic order. The list is kept in the variable
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
806 @code{kill-ring}, and can be operated on with the usual functions for
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
807 lists; there are also specialized functions, described in this section,
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
808 that treat it as a ring.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
809
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
810 Some people think this use of the word ``kill'' is unfortunate, since
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
811 it refers to operations that specifically @emph{do not} destroy the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
812 entities ``killed.'' This is in sharp contrast to ordinary life, in
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
813 which death is permanent and ``killed'' entities do not come back to
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
814 life. Therefore, other metaphors have been proposed. For example, the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
815 term ``cut ring'' makes sense to people who, in pre-computer days, used
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
816 scissors and paste to cut up and rearrange manuscripts. However, it
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
817 would be difficult to change the terminology now.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
818
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
819 @menu
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
820 * Kill Ring Concepts:: What text looks like in the kill ring.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
821 * Kill Functions:: Functions that kill text.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
822 * Yanking:: How yanking is done.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
823 * Yank Commands:: Commands that access the kill ring.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
824 * Low-Level Kill Ring:: Functions and variables for kill ring access.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
825 * Internals of Kill Ring:: Variables that hold kill ring data.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
826 @end menu
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
827
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
828 @node Kill Ring Concepts
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
829 @comment node-name, next, previous, up
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
830 @subsection Kill Ring Concepts
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
831
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
832 The kill ring records killed text as strings in a list, most recent
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
833 first. A short kill ring, for example, might look like this:
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
834
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
835 @example
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
836 ("some text" "a different piece of text" "even older text")
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
837 @end example
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
838
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
839 @noindent
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
840 When the list reaches @code{kill-ring-max} entries in length, adding a
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
841 new entry automatically deletes the last entry.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
842
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
843 When kill commands are interwoven with other commands, each kill
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
844 command makes a new entry in the kill ring. Multiple kill commands in
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
845 succession build up a single kill ring entry, which would be yanked as a
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
846 unit; the second and subsequent consecutive kill commands add text to
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
847 the entry made by the first one.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
848
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
849 For yanking, one entry in the kill ring is designated the ``front'' of
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
850 the ring. Some yank commands ``rotate'' the ring by designating a
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
851 different element as the ``front.'' But this virtual rotation doesn't
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
852 change the list itself---the most recent entry always comes first in the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
853 list.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
854
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
855 @node Kill Functions
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
856 @comment node-name, next, previous, up
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
857 @subsection Functions for Killing
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
858
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
859 @code{kill-region} is the usual subroutine for killing text. Any
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
860 command that calls this function is a ``kill command'' (and should
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
861 probably have @samp{kill} in its name). @code{kill-region} puts the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
862 newly killed text in a new element at the beginning of the kill ring or
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
863 adds it to the most recent element. It determines automatically (using
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
864 @code{last-command}) whether the previous command was a kill command,
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
865 and if so appends the killed text to the most recent entry.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
866
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
867 @deffn Command kill-region start end &optional yank-handler
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
868 This function kills the text in the region defined by @var{start} and
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
869 @var{end}. The text is deleted but saved in the kill ring, along with
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
870 its text properties. The value is always @code{nil}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
871
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
872 In an interactive call, @var{start} and @var{end} are point and
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
873 the mark.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
874
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
875 @c Emacs 19 feature
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
876 If the buffer or text is read-only, @code{kill-region} modifies the kill
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
877 ring just the same, then signals an error without modifying the buffer.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
878 This is convenient because it lets the user use a series of kill
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
879 commands to copy text from a read-only buffer into the kill ring.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
880
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
881 If @var{yank-handler} is non-@code{nil}, this puts that value onto
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
882 the string of killed text, as a @code{yank-handler} text property.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
883 @xref{Yanking}. Note that if @var{yank-handler} is @code{nil}, any
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
884 @code{yank-handler} properties present on the killed text are copied
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
885 onto the kill ring, like other text properties.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
886 @end deffn
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
887
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
888 @defopt kill-read-only-ok
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
889 If this option is non-@code{nil}, @code{kill-region} does not signal an
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
890 error if the buffer or text is read-only. Instead, it simply returns,
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
891 updating the kill ring but not changing the buffer.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
892 @end defopt
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
893
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
894 @deffn Command copy-region-as-kill start end
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
895 This command saves the region defined by @var{start} and @var{end} on
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
896 the kill ring (including text properties), but does not delete the text
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
897 from the buffer. It returns @code{nil}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
898
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
899 The command does not set @code{this-command} to @code{kill-region}, so a
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
900 subsequent kill command does not append to the same kill ring entry.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
901
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
902 Don't call @code{copy-region-as-kill} in Lisp programs unless you aim to
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
903 support Emacs 18. For newer Emacs versions, it is better to use
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
904 @code{kill-new} or @code{kill-append} instead. @xref{Low-Level Kill
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
905 Ring}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
906 @end deffn
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
907
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
908 @node Yanking
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
909 @subsection Yanking
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
910
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
911 Yanking means inserting text from the kill ring, but it does
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
912 not insert the text blindly. Yank commands and some other commands
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
913 use @code{insert-for-yank} to perform special processing on the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
914 text that they copy into the buffer.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
915
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
916 @defun insert-for-yank string
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
917 This function normally works like @code{insert} except that it doesn't
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
918 insert the text properties in the @code{yank-excluded-properties}
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
919 list. However, if any part of @var{string} has a non-@code{nil}
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
920 @code{yank-handler} text property, that property can do various
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
921 special processing on that part of the text being inserted.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
922 @end defun
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
923
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
924 @defun insert-buffer-substring-as-yank buf &optional start end
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
925 This function resembles @code{insert-buffer-substring} except that it
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
926 doesn't insert the text properties in the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
927 @code{yank-excluded-properties} list.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
928 @end defun
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
929
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
930 You can put a @code{yank-handler} text property on all or part of
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
931 the text to control how it will be inserted if it is yanked. The
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
932 @code{insert-for-yank} function looks for that property. The property
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
933 value must be a list of one to four elements, with the following
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
934 format (where elements after the first may be omitted):
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
935
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
936 @example
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
937 (@var{function} @var{param} @var{noexclude} @var{undo})
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
938 @end example
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
939
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
940 Here is what the elements do:
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
941
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
942 @table @var
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
943 @item function
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
944 When @var{function} is present and non-@code{nil}, it is called instead of
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
945 @code{insert} to insert the string. @var{function} takes one
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
946 argument---the string to insert.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
947
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
948 @item param
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
949 If @var{param} is present and non-@code{nil}, it replaces @var{string}
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
950 (or the part of @var{string} being processed) as the object passed to
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
951 @var{function} (or @code{insert}); for example, if @var{function} is
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
952 @code{yank-rectangle}, @var{param} should be a list of strings to
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
953 insert as a rectangle.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
954
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
955 @item noexclude
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
956 If @var{noexclude} is present and non-@code{nil}, the normal removal of the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
957 yank-excluded-properties is not performed; instead @var{function} is
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
958 responsible for removing those properties. This may be necessary
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
959 if @var{function} adjusts point before or after inserting the object.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
960
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
961 @item undo
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
962 If @var{undo} is present and non-@code{nil}, it is a function that will be
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
963 called by @code{yank-pop} to undo the insertion of the current object.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
964 It is called with two arguments, the start and end of the current
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
965 region. @var{function} can set @code{yank-undo-function} to override
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
966 the @var{undo} value.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
967 @end table
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
968
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
969 @node Yank Commands
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
970 @comment node-name, next, previous, up
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
971 @subsection Functions for Yanking
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
972
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
973 This section describes higher-level commands for yanking, which are
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
974 intended primarily for the user but useful also in Lisp programs.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
975 Both @code{yank} and @code{yank-pop} honor the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
976 @code{yank-excluded-properties} variable and @code{yank-handler} text
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
977 property (@pxref{Yanking}).
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
978
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
979 @deffn Command yank &optional arg
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
980 @cindex inserting killed text
102893
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 101863
diff changeset
981 This command inserts before point the text at the front of the kill
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 101863
diff changeset
982 ring. It sets the mark at the beginning of that text, using
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 101863
diff changeset
983 @code{push-mark} (@pxref{The Mark}), and puts point at the end.
84103
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
984
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
985 If @var{arg} is a non-@code{nil} list (which occurs interactively when
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
986 the user types @kbd{C-u} with no digits), then @code{yank} inserts the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
987 text as described above, but puts point before the yanked text and
102893
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 101863
diff changeset
988 sets the mark after it.
84103
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
989
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
990 If @var{arg} is a number, then @code{yank} inserts the @var{arg}th
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
991 most recently killed text---the @var{arg}th element of the kill ring
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
992 list, counted cyclically from the front, which is considered the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
993 first element for this purpose.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
994
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
995 @code{yank} does not alter the contents of the kill ring, unless it
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
996 used text provided by another program, in which case it pushes that text
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
997 onto the kill ring. However if @var{arg} is an integer different from
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
998 one, it rotates the kill ring to place the yanked string at the front.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
999
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1000 @code{yank} returns @code{nil}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1001 @end deffn
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1002
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1003 @deffn Command yank-pop &optional arg
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1004 This command replaces the just-yanked entry from the kill ring with a
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1005 different entry from the kill ring.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1006
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1007 This is allowed only immediately after a @code{yank} or another
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1008 @code{yank-pop}. At such a time, the region contains text that was just
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1009 inserted by yanking. @code{yank-pop} deletes that text and inserts in
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1010 its place a different piece of killed text. It does not add the deleted
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1011 text to the kill ring, since it is already in the kill ring somewhere.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1012 It does however rotate the kill ring to place the newly yanked string at
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1013 the front.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1014
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1015 If @var{arg} is @code{nil}, then the replacement text is the previous
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1016 element of the kill ring. If @var{arg} is numeric, the replacement is
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1017 the @var{arg}th previous kill. If @var{arg} is negative, a more recent
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1018 kill is the replacement.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1019
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1020 The sequence of kills in the kill ring wraps around, so that after the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1021 oldest one comes the newest one, and before the newest one goes the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1022 oldest.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1023
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1024 The return value is always @code{nil}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1025 @end deffn
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1026
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1027 @defvar yank-undo-function
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1028 If this variable is non-@code{nil}, the function @code{yank-pop} uses
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1029 its value instead of @code{delete-region} to delete the text
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1030 inserted by the previous @code{yank} or
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1031 @code{yank-pop} command. The value must be a function of two
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1032 arguments, the start and end of the current region.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1033
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1034 The function @code{insert-for-yank} automatically sets this variable
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1035 according to the @var{undo} element of the @code{yank-handler}
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1036 text property, if there is one.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1037 @end defvar
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1038
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1039 @node Low-Level Kill Ring
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1040 @subsection Low-Level Kill Ring
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1041
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1042 These functions and variables provide access to the kill ring at a
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1043 lower level, but still convenient for use in Lisp programs, because they
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1044 take care of interaction with window system selections
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1045 (@pxref{Window System Selections}).
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1046
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1047 @defun current-kill n &optional do-not-move
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1048 The function @code{current-kill} rotates the yanking pointer, which
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1049 designates the ``front'' of the kill ring, by @var{n} places (from newer
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1050 kills to older ones), and returns the text at that place in the ring.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1051
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1052 If the optional second argument @var{do-not-move} is non-@code{nil},
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1053 then @code{current-kill} doesn't alter the yanking pointer; it just
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1054 returns the @var{n}th kill, counting from the current yanking pointer.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1055
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1056 If @var{n} is zero, indicating a request for the latest kill,
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1057 @code{current-kill} calls the value of
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1058 @code{interprogram-paste-function} (documented below) before
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1059 consulting the kill ring. If that value is a function and calling it
98744
f92a9c4d4746 (Low-Level Kill Ring): interprogram-paste-function can now return a list
Eli Zaretskii <eliz@gnu.org>
parents: 96470
diff changeset
1060 returns a string or a list of several string, @code{current-kill}
f92a9c4d4746 (Low-Level Kill Ring): interprogram-paste-function can now return a list
Eli Zaretskii <eliz@gnu.org>
parents: 96470
diff changeset
1061 pushes the strings onto the kill ring and returns the first string.
98759
046a6bcd118b (Low-Level Kill Ring): Fix last change.
Eli Zaretskii <eliz@gnu.org>
parents: 98744
diff changeset
1062 It also sets the yanking pointer to point to the kill-ring entry of
046a6bcd118b (Low-Level Kill Ring): Fix last change.
Eli Zaretskii <eliz@gnu.org>
parents: 98744
diff changeset
1063 the first string returned by @code{interprogram-paste-function},
98744
f92a9c4d4746 (Low-Level Kill Ring): interprogram-paste-function can now return a list
Eli Zaretskii <eliz@gnu.org>
parents: 96470
diff changeset
1064 regardless of the value of @var{do-not-move}. Otherwise,
f92a9c4d4746 (Low-Level Kill Ring): interprogram-paste-function can now return a list
Eli Zaretskii <eliz@gnu.org>
parents: 96470
diff changeset
1065 @code{current-kill} does not treat a zero value for @var{n} specially:
f92a9c4d4746 (Low-Level Kill Ring): interprogram-paste-function can now return a list
Eli Zaretskii <eliz@gnu.org>
parents: 96470
diff changeset
1066 it returns the entry pointed at by the yanking pointer and does not
f92a9c4d4746 (Low-Level Kill Ring): interprogram-paste-function can now return a list
Eli Zaretskii <eliz@gnu.org>
parents: 96470
diff changeset
1067 move the yanking pointer.
84103
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1068 @end defun
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1069
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1070 @defun kill-new string &optional replace yank-handler
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1071 This function pushes the text @var{string} onto the kill ring and
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1072 makes the yanking pointer point to it. It discards the oldest entry
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1073 if appropriate. It also invokes the value of
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1074 @code{interprogram-cut-function} (see below).
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1075
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1076 If @var{replace} is non-@code{nil}, then @code{kill-new} replaces the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1077 first element of the kill ring with @var{string}, rather than pushing
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1078 @var{string} onto the kill ring.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1079
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1080 If @var{yank-handler} is non-@code{nil}, this puts that value onto
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1081 the string of killed text, as a @code{yank-handler} property.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1082 @xref{Yanking}. Note that if @var{yank-handler} is @code{nil}, then
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1083 @code{kill-new} copies any @code{yank-handler} properties present on
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1084 @var{string} onto the kill ring, as it does with other text properties.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1085 @end defun
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1086
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1087 @defun kill-append string before-p &optional yank-handler
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1088 This function appends the text @var{string} to the first entry in the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1089 kill ring and makes the yanking pointer point to the combined entry.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1090 Normally @var{string} goes at the end of the entry, but if
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1091 @var{before-p} is non-@code{nil}, it goes at the beginning. This
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1092 function also invokes the value of @code{interprogram-cut-function}
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1093 (see below). This handles @var{yank-handler} just like
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1094 @code{kill-new}, except that if @var{yank-handler} is different from
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1095 the @code{yank-handler} property of the first entry of the kill ring,
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1096 @code{kill-append} pushes the concatenated string onto the kill ring,
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1097 instead of replacing the original first entry with it.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1098 @end defun
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1099
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1100 @defvar interprogram-paste-function
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1101 This variable provides a way of transferring killed text from other
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1102 programs, when you are using a window system. Its value should be
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1103 @code{nil} or a function of no arguments.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1104
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1105 If the value is a function, @code{current-kill} calls it to get the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1106 ``most recent kill.'' If the function returns a non-@code{nil} value,
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1107 then that value is used as the ``most recent kill.'' If it returns
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1108 @code{nil}, then the front of the kill ring is used.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1109
98744
f92a9c4d4746 (Low-Level Kill Ring): interprogram-paste-function can now return a list
Eli Zaretskii <eliz@gnu.org>
parents: 96470
diff changeset
1110 To facilitate support for window systems that support multiple
f92a9c4d4746 (Low-Level Kill Ring): interprogram-paste-function can now return a list
Eli Zaretskii <eliz@gnu.org>
parents: 96470
diff changeset
1111 selections, this function may also return a list of strings. In that
f92a9c4d4746 (Low-Level Kill Ring): interprogram-paste-function can now return a list
Eli Zaretskii <eliz@gnu.org>
parents: 96470
diff changeset
1112 case, the first string is used as the ``most recent kill'', and all
f92a9c4d4746 (Low-Level Kill Ring): interprogram-paste-function can now return a list
Eli Zaretskii <eliz@gnu.org>
parents: 96470
diff changeset
1113 the other strings are pushed onto the kill ring, for easy access by
f92a9c4d4746 (Low-Level Kill Ring): interprogram-paste-function can now return a list
Eli Zaretskii <eliz@gnu.org>
parents: 96470
diff changeset
1114 @code{yank-pop}.
f92a9c4d4746 (Low-Level Kill Ring): interprogram-paste-function can now return a list
Eli Zaretskii <eliz@gnu.org>
parents: 96470
diff changeset
1115
f92a9c4d4746 (Low-Level Kill Ring): interprogram-paste-function can now return a list
Eli Zaretskii <eliz@gnu.org>
parents: 96470
diff changeset
1116 The normal use of this function is to get the window system's primary
84103
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1117 selection as the most recent kill, even if the selection belongs to
98744
f92a9c4d4746 (Low-Level Kill Ring): interprogram-paste-function can now return a list
Eli Zaretskii <eliz@gnu.org>
parents: 96470
diff changeset
1118 another application. @xref{Window System Selections}. However, if
f92a9c4d4746 (Low-Level Kill Ring): interprogram-paste-function can now return a list
Eli Zaretskii <eliz@gnu.org>
parents: 96470
diff changeset
1119 the selection was provided by the current Emacs session, this function
f92a9c4d4746 (Low-Level Kill Ring): interprogram-paste-function can now return a list
Eli Zaretskii <eliz@gnu.org>
parents: 96470
diff changeset
1120 should return @code{nil}. (If it is hard to tell whether Emacs or
f92a9c4d4746 (Low-Level Kill Ring): interprogram-paste-function can now return a list
Eli Zaretskii <eliz@gnu.org>
parents: 96470
diff changeset
1121 some other program provided the selection, it should be good enough to
f92a9c4d4746 (Low-Level Kill Ring): interprogram-paste-function can now return a list
Eli Zaretskii <eliz@gnu.org>
parents: 96470
diff changeset
1122 use @code{string=} to compare it with the last text Emacs provided.)
84103
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1123 @end defvar
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1124
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1125 @defvar interprogram-cut-function
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1126 This variable provides a way of communicating killed text to other
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1127 programs, when you are using a window system. Its value should be
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1128 @code{nil} or a function of one required and one optional argument.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1129
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1130 If the value is a function, @code{kill-new} and @code{kill-append} call
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1131 it with the new first element of the kill ring as the first argument.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1132 The second, optional, argument has the same meaning as the @var{push}
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1133 argument to @code{x-set-cut-buffer} (@pxref{Definition of
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1134 x-set-cut-buffer}) and only affects the second and later cut buffers.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1135
98744
f92a9c4d4746 (Low-Level Kill Ring): interprogram-paste-function can now return a list
Eli Zaretskii <eliz@gnu.org>
parents: 96470
diff changeset
1136 The normal use of this function is to set the window system's primary
84103
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1137 selection (and first cut buffer) from the newly killed text.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1138 @xref{Window System Selections}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1139 @end defvar
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1140
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1141 @node Internals of Kill Ring
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1142 @comment node-name, next, previous, up
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1143 @subsection Internals of the Kill Ring
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1144
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1145 The variable @code{kill-ring} holds the kill ring contents, in the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1146 form of a list of strings. The most recent kill is always at the front
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1147 of the list.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1148
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1149 The @code{kill-ring-yank-pointer} variable points to a link in the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1150 kill ring list, whose @sc{car} is the text to yank next. We say it
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1151 identifies the ``front'' of the ring. Moving
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1152 @code{kill-ring-yank-pointer} to a different link is called
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1153 @dfn{rotating the kill ring}. We call the kill ring a ``ring'' because
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1154 the functions that move the yank pointer wrap around from the end of the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1155 list to the beginning, or vice-versa. Rotation of the kill ring is
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1156 virtual; it does not change the value of @code{kill-ring}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1157
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1158 Both @code{kill-ring} and @code{kill-ring-yank-pointer} are Lisp
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1159 variables whose values are normally lists. The word ``pointer'' in the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1160 name of the @code{kill-ring-yank-pointer} indicates that the variable's
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1161 purpose is to identify one element of the list for use by the next yank
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1162 command.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1163
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1164 The value of @code{kill-ring-yank-pointer} is always @code{eq} to one
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1165 of the links in the kill ring list. The element it identifies is the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1166 @sc{car} of that link. Kill commands, which change the kill ring, also
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1167 set this variable to the value of @code{kill-ring}. The effect is to
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1168 rotate the ring so that the newly killed text is at the front.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1169
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1170 Here is a diagram that shows the variable @code{kill-ring-yank-pointer}
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1171 pointing to the second entry in the kill ring @code{("some text" "a
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1172 different piece of text" "yet older text")}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1173
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1174 @example
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1175 @group
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1176 kill-ring ---- kill-ring-yank-pointer
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1177 | |
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1178 | v
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1179 | --- --- --- --- --- ---
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1180 --> | | |------> | | |--> | | |--> nil
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1181 --- --- --- --- --- ---
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1182 | | |
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1183 | | |
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1184 | | -->"yet older text"
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1185 | |
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1186 | --> "a different piece of text"
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1187 |
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1188 --> "some text"
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1189 @end group
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1190 @end example
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1191
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1192 @noindent
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1193 This state of affairs might occur after @kbd{C-y} (@code{yank})
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1194 immediately followed by @kbd{M-y} (@code{yank-pop}).
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1195
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1196 @defvar kill-ring
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1197 This variable holds the list of killed text sequences, most recently
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1198 killed first.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1199 @end defvar
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1200
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1201 @defvar kill-ring-yank-pointer
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1202 This variable's value indicates which element of the kill ring is at the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1203 ``front'' of the ring for yanking. More precisely, the value is a tail
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1204 of the value of @code{kill-ring}, and its @sc{car} is the kill string
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1205 that @kbd{C-y} should yank.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1206 @end defvar
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1207
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1208 @defopt kill-ring-max
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1209 The value of this variable is the maximum length to which the kill
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1210 ring can grow, before elements are thrown away at the end. The default
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1211 value for @code{kill-ring-max} is 60.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1212 @end defopt
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1213
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1214 @node Undo
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1215 @comment node-name, next, previous, up
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1216 @section Undo
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1217 @cindex redo
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1218
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1219 Most buffers have an @dfn{undo list}, which records all changes made
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1220 to the buffer's text so that they can be undone. (The buffers that
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1221 don't have one are usually special-purpose buffers for which Emacs
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1222 assumes that undoing is not useful. In particular, any buffer whose
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1223 name begins with a space has its undo recording off by default;
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1224 see @ref{Buffer Names}.) All the primitives that modify the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1225 text in the buffer automatically add elements to the front of the undo
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1226 list, which is in the variable @code{buffer-undo-list}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1227
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1228 @defvar buffer-undo-list
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1229 This buffer-local variable's value is the undo list of the current
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1230 buffer. A value of @code{t} disables the recording of undo information.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1231 @end defvar
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1232
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1233 Here are the kinds of elements an undo list can have:
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1234
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1235 @table @code
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1236 @item @var{position}
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1237 This kind of element records a previous value of point; undoing this
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1238 element moves point to @var{position}. Ordinary cursor motion does not
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1239 make any sort of undo record, but deletion operations use these entries
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1240 to record where point was before the command.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1241
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1242 @item (@var{beg} . @var{end})
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1243 This kind of element indicates how to delete text that was inserted.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1244 Upon insertion, the text occupied the range @var{beg}--@var{end} in the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1245 buffer.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1246
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1247 @item (@var{text} . @var{position})
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1248 This kind of element indicates how to reinsert text that was deleted.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1249 The deleted text itself is the string @var{text}. The place to
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1250 reinsert it is @code{(abs @var{position})}. If @var{position} is
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1251 positive, point was at the beginning of the deleted text, otherwise it
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1252 was at the end.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1253
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1254 @item (t @var{high} . @var{low})
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1255 This kind of element indicates that an unmodified buffer became
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1256 modified. The elements @var{high} and @var{low} are two integers, each
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1257 recording 16 bits of the visited file's modification time as of when it
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1258 was previously visited or saved. @code{primitive-undo} uses those
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1259 values to determine whether to mark the buffer as unmodified once again;
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1260 it does so only if the file's modification time matches those numbers.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1261
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1262 @item (nil @var{property} @var{value} @var{beg} . @var{end})
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1263 This kind of element records a change in a text property.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1264 Here's how you might undo the change:
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1265
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1266 @example
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1267 (put-text-property @var{beg} @var{end} @var{property} @var{value})
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1268 @end example
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1269
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1270 @item (@var{marker} . @var{adjustment})
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1271 This kind of element records the fact that the marker @var{marker} was
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1272 relocated due to deletion of surrounding text, and that it moved
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1273 @var{adjustment} character positions. Undoing this element moves
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1274 @var{marker} @minus{} @var{adjustment} characters.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1275
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1276 @item (apply @var{funname} . @var{args})
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1277 This is an extensible undo item, which is undone by calling
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1278 @var{funname} with arguments @var{args}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1279
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1280 @item (apply @var{delta} @var{beg} @var{end} @var{funname} . @var{args})
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1281 This is an extensible undo item, which records a change limited to the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1282 range @var{beg} to @var{end}, which increased the size of the buffer
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1283 by @var{delta}. It is undone by calling @var{funname} with arguments
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1284 @var{args}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1285
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1286 This kind of element enables undo limited to a region to determine
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1287 whether the element pertains to that region.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1288
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1289 @item nil
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1290 This element is a boundary. The elements between two boundaries are
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1291 called a @dfn{change group}; normally, each change group corresponds to
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1292 one keyboard command, and undo commands normally undo an entire group as
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1293 a unit.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1294 @end table
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1295
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1296 @defun undo-boundary
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1297 This function places a boundary element in the undo list. The undo
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1298 command stops at such a boundary, and successive undo commands undo
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1299 to earlier and earlier boundaries. This function returns @code{nil}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1300
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1301 The editor command loop automatically creates an undo boundary before
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1302 each key sequence is executed. Thus, each undo normally undoes the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1303 effects of one command. Self-inserting input characters are an
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1304 exception. The command loop makes a boundary for the first such
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1305 character; the next 19 consecutive self-inserting input characters do
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1306 not make boundaries, and then the 20th does, and so on as long as
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1307 self-inserting characters continue.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1308
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1309 All buffer modifications add a boundary whenever the previous undoable
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1310 change was made in some other buffer. This is to ensure that
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1311 each command makes a boundary in each buffer where it makes changes.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1312
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1313 Calling this function explicitly is useful for splitting the effects of
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1314 a command into more than one unit. For example, @code{query-replace}
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1315 calls @code{undo-boundary} after each replacement, so that the user can
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1316 undo individual replacements one by one.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1317 @end defun
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1318
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1319 @defvar undo-in-progress
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1320 This variable is normally @code{nil}, but the undo commands bind it to
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1321 @code{t}. This is so that various kinds of change hooks can tell when
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1322 they're being called for the sake of undoing.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1323 @end defvar
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1324
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1325 @defun primitive-undo count list
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1326 This is the basic function for undoing elements of an undo list.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1327 It undoes the first @var{count} elements of @var{list}, returning
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1328 the rest of @var{list}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1329
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1330 @code{primitive-undo} adds elements to the buffer's undo list when it
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1331 changes the buffer. Undo commands avoid confusion by saving the undo
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1332 list value at the beginning of a sequence of undo operations. Then the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1333 undo operations use and update the saved value. The new elements added
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1334 by undoing are not part of this saved value, so they don't interfere with
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1335 continuing to undo.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1336
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1337 This function does not bind @code{undo-in-progress}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1338 @end defun
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1339
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1340 @node Maintaining Undo
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1341 @section Maintaining Undo Lists
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1342
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1343 This section describes how to enable and disable undo information for
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1344 a given buffer. It also explains how the undo list is truncated
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1345 automatically so it doesn't get too big.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1346
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1347 Recording of undo information in a newly created buffer is normally
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1348 enabled to start with; but if the buffer name starts with a space, the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1349 undo recording is initially disabled. You can explicitly enable or
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1350 disable undo recording with the following two functions, or by setting
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1351 @code{buffer-undo-list} yourself.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1352
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1353 @deffn Command buffer-enable-undo &optional buffer-or-name
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1354 This command enables recording undo information for buffer
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1355 @var{buffer-or-name}, so that subsequent changes can be undone. If no
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1356 argument is supplied, then the current buffer is used. This function
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1357 does nothing if undo recording is already enabled in the buffer. It
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1358 returns @code{nil}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1359
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1360 In an interactive call, @var{buffer-or-name} is the current buffer.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1361 You cannot specify any other buffer.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1362 @end deffn
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1363
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1364 @deffn Command buffer-disable-undo &optional buffer-or-name
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1365 @cindex disabling undo
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1366 This function discards the undo list of @var{buffer-or-name}, and disables
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1367 further recording of undo information. As a result, it is no longer
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1368 possible to undo either previous changes or any subsequent changes. If
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1369 the undo list of @var{buffer-or-name} is already disabled, this function
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1370 has no effect.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1371
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1372 This function returns @code{nil}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1373 @end deffn
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1374
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1375 As editing continues, undo lists get longer and longer. To prevent
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1376 them from using up all available memory space, garbage collection trims
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1377 them back to size limits you can set. (For this purpose, the ``size''
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1378 of an undo list measures the cons cells that make up the list, plus the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1379 strings of deleted text.) Three variables control the range of acceptable
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1380 sizes: @code{undo-limit}, @code{undo-strong-limit} and
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1381 @code{undo-outer-limit}. In these variables, size is counted as the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1382 number of bytes occupied, which includes both saved text and other
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1383 data.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1384
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1385 @defopt undo-limit
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1386 This is the soft limit for the acceptable size of an undo list. The
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1387 change group at which this size is exceeded is the last one kept.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1388 @end defopt
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1389
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1390 @defopt undo-strong-limit
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1391 This is the upper limit for the acceptable size of an undo list. The
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1392 change group at which this size is exceeded is discarded itself (along
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1393 with all older change groups). There is one exception: the very latest
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1394 change group is only discarded if it exceeds @code{undo-outer-limit}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1395 @end defopt
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1396
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1397 @defopt undo-outer-limit
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1398 If at garbage collection time the undo info for the current command
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1399 exceeds this limit, Emacs discards the info and displays a warning.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1400 This is a last ditch limit to prevent memory overflow.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1401 @end defopt
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1402
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1403 @defopt undo-ask-before-discard
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1404 If this variable is non-@code{nil}, when the undo info exceeds
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1405 @code{undo-outer-limit}, Emacs asks in the echo area whether to
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1406 discard the info. The default value is @code{nil}, which means to
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1407 discard it automatically.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1408
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1409 This option is mainly intended for debugging. Garbage collection is
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1410 inhibited while the question is asked, which means that Emacs might
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1411 leak memory if the user waits too long before answering the question.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1412 @end defopt
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1413
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1414 @node Filling
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1415 @comment node-name, next, previous, up
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1416 @section Filling
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1417 @cindex filling text
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1418
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1419 @dfn{Filling} means adjusting the lengths of lines (by moving the line
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1420 breaks) so that they are nearly (but no greater than) a specified
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1421 maximum width. Additionally, lines can be @dfn{justified}, which means
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1422 inserting spaces to make the left and/or right margins line up
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1423 precisely. The width is controlled by the variable @code{fill-column}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1424 For ease of reading, lines should be no longer than 70 or so columns.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1425
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1426 You can use Auto Fill mode (@pxref{Auto Filling}) to fill text
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1427 automatically as you insert it, but changes to existing text may leave
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1428 it improperly filled. Then you must fill the text explicitly.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1429
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1430 Most of the commands in this section return values that are not
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1431 meaningful. All the functions that do filling take note of the current
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1432 left margin, current right margin, and current justification style
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1433 (@pxref{Margins}). If the current justification style is
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1434 @code{none}, the filling functions don't actually do anything.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1435
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1436 Several of the filling functions have an argument @var{justify}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1437 If it is non-@code{nil}, that requests some kind of justification. It
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1438 can be @code{left}, @code{right}, @code{full}, or @code{center}, to
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1439 request a specific style of justification. If it is @code{t}, that
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1440 means to use the current justification style for this part of the text
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1441 (see @code{current-justification}, below). Any other value is treated
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1442 as @code{full}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1443
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1444 When you call the filling functions interactively, using a prefix
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1445 argument implies the value @code{full} for @var{justify}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1446
85384
e1e09392b118 (Filling): Update arguments of fill-paragraph.
Juri Linkov <juri@jurta.org>
parents: 85311
diff changeset
1447 @deffn Command fill-paragraph &optional justify region
84103
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1448 This command fills the paragraph at or after point. If
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1449 @var{justify} is non-@code{nil}, each line is justified as well.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1450 It uses the ordinary paragraph motion commands to find paragraph
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1451 boundaries. @xref{Paragraphs,,, emacs, The GNU Emacs Manual}.
102893
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 101863
diff changeset
1452
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 101863
diff changeset
1453 When @var{region} is non-@code{nil}, then if Transient Mark mode is
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 101863
diff changeset
1454 enabled and the mark is active, this command calls @code{fill-region}
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 101863
diff changeset
1455 to fill all the paragraphs in the region, instead of filling only the
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 101863
diff changeset
1456 current paragraph. When this command is called interactively,
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 101863
diff changeset
1457 @var{region} is @code{t}.
84103
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1458 @end deffn
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1459
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1460 @deffn Command fill-region start end &optional justify nosqueeze to-eop
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1461 This command fills each of the paragraphs in the region from @var{start}
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1462 to @var{end}. It justifies as well if @var{justify} is
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1463 non-@code{nil}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1464
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1465 If @var{nosqueeze} is non-@code{nil}, that means to leave whitespace
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1466 other than line breaks untouched. If @var{to-eop} is non-@code{nil},
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1467 that means to keep filling to the end of the paragraph---or the next hard
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1468 newline, if @code{use-hard-newlines} is enabled (see below).
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1469
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1470 The variable @code{paragraph-separate} controls how to distinguish
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1471 paragraphs. @xref{Standard Regexps}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1472 @end deffn
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1473
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1474 @deffn Command fill-individual-paragraphs start end &optional justify citation-regexp
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1475 This command fills each paragraph in the region according to its
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1476 individual fill prefix. Thus, if the lines of a paragraph were indented
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1477 with spaces, the filled paragraph will remain indented in the same
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1478 fashion.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1479
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1480 The first two arguments, @var{start} and @var{end}, are the beginning
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1481 and end of the region to be filled. The third and fourth arguments,
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1482 @var{justify} and @var{citation-regexp}, are optional. If
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1483 @var{justify} is non-@code{nil}, the paragraphs are justified as
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1484 well as filled. If @var{citation-regexp} is non-@code{nil}, it means the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1485 function is operating on a mail message and therefore should not fill
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1486 the header lines. If @var{citation-regexp} is a string, it is used as
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1487 a regular expression; if it matches the beginning of a line, that line
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1488 is treated as a citation marker.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1489
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1490 Ordinarily, @code{fill-individual-paragraphs} regards each change in
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1491 indentation as starting a new paragraph. If
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1492 @code{fill-individual-varying-indent} is non-@code{nil}, then only
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1493 separator lines separate paragraphs. That mode can handle indented
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1494 paragraphs with additional indentation on the first line.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1495 @end deffn
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1496
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1497 @defopt fill-individual-varying-indent
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1498 This variable alters the action of @code{fill-individual-paragraphs} as
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1499 described above.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1500 @end defopt
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1501
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1502 @deffn Command fill-region-as-paragraph start end &optional justify nosqueeze squeeze-after
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1503 This command considers a region of text as a single paragraph and fills
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1504 it. If the region was made up of many paragraphs, the blank lines
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1505 between paragraphs are removed. This function justifies as well as
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1506 filling when @var{justify} is non-@code{nil}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1507
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1508 If @var{nosqueeze} is non-@code{nil}, that means to leave whitespace
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1509 other than line breaks untouched. If @var{squeeze-after} is
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1510 non-@code{nil}, it specifies a position in the region, and means don't
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1511 canonicalize spaces before that position.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1512
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1513 In Adaptive Fill mode, this command calls @code{fill-context-prefix} to
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1514 choose a fill prefix by default. @xref{Adaptive Fill}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1515 @end deffn
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1516
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1517 @deffn Command justify-current-line &optional how eop nosqueeze
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1518 This command inserts spaces between the words of the current line so
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1519 that the line ends exactly at @code{fill-column}. It returns
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1520 @code{nil}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1521
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1522 The argument @var{how}, if non-@code{nil} specifies explicitly the style
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1523 of justification. It can be @code{left}, @code{right}, @code{full},
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1524 @code{center}, or @code{none}. If it is @code{t}, that means to do
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1525 follow specified justification style (see @code{current-justification},
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1526 below). @code{nil} means to do full justification.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1527
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1528 If @var{eop} is non-@code{nil}, that means do only left-justification
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1529 if @code{current-justification} specifies full justification. This is
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1530 used for the last line of a paragraph; even if the paragraph as a
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1531 whole is fully justified, the last line should not be.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1532
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1533 If @var{nosqueeze} is non-@code{nil}, that means do not change interior
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1534 whitespace.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1535 @end deffn
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1536
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1537 @defopt default-justification
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1538 This variable's value specifies the style of justification to use for
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1539 text that doesn't specify a style with a text property. The possible
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1540 values are @code{left}, @code{right}, @code{full}, @code{center}, or
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1541 @code{none}. The default value is @code{left}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1542 @end defopt
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1543
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1544 @defun current-justification
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1545 This function returns the proper justification style to use for filling
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1546 the text around point.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1547
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1548 This returns the value of the @code{justification} text property at
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1549 point, or the variable @var{default-justification} if there is no such
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1550 text property. However, it returns @code{nil} rather than @code{none}
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1551 to mean ``don't justify''.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1552 @end defun
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1553
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1554 @defopt sentence-end-double-space
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1555 @anchor{Definition of sentence-end-double-space}
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1556 If this variable is non-@code{nil}, a period followed by just one space
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1557 does not count as the end of a sentence, and the filling functions
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1558 avoid breaking the line at such a place.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1559 @end defopt
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1560
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1561 @defopt sentence-end-without-period
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1562 If this variable is non-@code{nil}, a sentence can end without a
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1563 period. This is used for languages like Thai, where sentences end
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1564 with a double space but without a period.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1565 @end defopt
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1566
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1567 @defopt sentence-end-without-space
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1568 If this variable is non-@code{nil}, it should be a string of
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1569 characters that can end a sentence without following spaces.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1570 @end defopt
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1571
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1572 @defvar fill-paragraph-function
102893
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 101863
diff changeset
1573 This variable provides a way to override the filling of paragraphs.
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 101863
diff changeset
1574 If its value is non-@code{nil}, @code{fill-paragraph} calls this
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 101863
diff changeset
1575 function to do the work. If the function returns a non-@code{nil}
84103
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1576 value, @code{fill-paragraph} assumes the job is done, and immediately
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1577 returns that value.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1578
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1579 The usual use of this feature is to fill comments in programming
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1580 language modes. If the function needs to fill a paragraph in the usual
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1581 way, it can do so as follows:
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1582
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1583 @example
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1584 (let ((fill-paragraph-function nil))
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1585 (fill-paragraph arg))
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1586 @end example
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1587 @end defvar
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1588
102893
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 101863
diff changeset
1589 @defvar fill-forward-paragraph-function
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 101863
diff changeset
1590 This variable provides a way to override how the filling functions,
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 101863
diff changeset
1591 such as @code{fill-region} and @code{fill-paragraph}, move forward to
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 101863
diff changeset
1592 the next paragraph. Its value should be a function, which is called
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 101863
diff changeset
1593 with a single argument @var{n}, the number of paragraphs to move, and
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 101863
diff changeset
1594 should return the difference between @var{n} and the number of
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 101863
diff changeset
1595 paragraphs actually moved. The default value of this variable is
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 101863
diff changeset
1596 @code{forward-paragraph}. @xref{Paragraphs,,, emacs, The GNU Emacs
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 101863
diff changeset
1597 Manual}.
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 101863
diff changeset
1598 @end defvar
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 101863
diff changeset
1599
84103
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1600 @defvar use-hard-newlines
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1601 If this variable is non-@code{nil}, the filling functions do not delete
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1602 newlines that have the @code{hard} text property. These ``hard
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1603 newlines'' act as paragraph separators.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1604 @end defvar
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1605
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1606 @node Margins
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1607 @section Margins for Filling
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1608
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1609 @defopt fill-prefix
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1610 This buffer-local variable, if non-@code{nil}, specifies a string of
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1611 text that appears at the beginning of normal text lines and should be
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1612 disregarded when filling them. Any line that fails to start with the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1613 fill prefix is considered the start of a paragraph; so is any line
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1614 that starts with the fill prefix followed by additional whitespace.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1615 Lines that start with the fill prefix but no additional whitespace are
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1616 ordinary text lines that can be filled together. The resulting filled
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1617 lines also start with the fill prefix.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1618
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1619 The fill prefix follows the left margin whitespace, if any.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1620 @end defopt
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1621
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1622 @defopt fill-column
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1623 This buffer-local variable specifies the maximum width of filled lines.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1624 Its value should be an integer, which is a number of columns. All the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1625 filling, justification, and centering commands are affected by this
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1626 variable, including Auto Fill mode (@pxref{Auto Filling}).
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1627
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1628 As a practical matter, if you are writing text for other people to
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1629 read, you should set @code{fill-column} to no more than 70. Otherwise
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1630 the line will be too long for people to read comfortably, and this can
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1631 make the text seem clumsy.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1632 @end defopt
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1633
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1634 @defvar default-fill-column
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1635 The value of this variable is the default value for @code{fill-column} in
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1636 buffers that do not override it. This is the same as
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1637 @code{(default-value 'fill-column)}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1638
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1639 The default value for @code{default-fill-column} is 70.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1640 @end defvar
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1641
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1642 @deffn Command set-left-margin from to margin
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1643 This sets the @code{left-margin} property on the text from @var{from} to
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1644 @var{to} to the value @var{margin}. If Auto Fill mode is enabled, this
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1645 command also refills the region to fit the new margin.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1646 @end deffn
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1647
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1648 @deffn Command set-right-margin from to margin
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1649 This sets the @code{right-margin} property on the text from @var{from}
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1650 to @var{to} to the value @var{margin}. If Auto Fill mode is enabled,
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1651 this command also refills the region to fit the new margin.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1652 @end deffn
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1653
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1654 @defun current-left-margin
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1655 This function returns the proper left margin value to use for filling
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1656 the text around point. The value is the sum of the @code{left-margin}
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1657 property of the character at the start of the current line (or zero if
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1658 none), and the value of the variable @code{left-margin}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1659 @end defun
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1660
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1661 @defun current-fill-column
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1662 This function returns the proper fill column value to use for filling
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1663 the text around point. The value is the value of the @code{fill-column}
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1664 variable, minus the value of the @code{right-margin} property of the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1665 character after point.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1666 @end defun
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1667
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1668 @deffn Command move-to-left-margin &optional n force
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1669 This function moves point to the left margin of the current line. The
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1670 column moved to is determined by calling the function
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1671 @code{current-left-margin}. If the argument @var{n} is non-@code{nil},
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1672 @code{move-to-left-margin} moves forward @var{n}@minus{}1 lines first.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1673
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1674 If @var{force} is non-@code{nil}, that says to fix the line's
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1675 indentation if that doesn't match the left margin value.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1676 @end deffn
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1677
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1678 @defun delete-to-left-margin &optional from to
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1679 This function removes left margin indentation from the text between
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1680 @var{from} and @var{to}. The amount of indentation to delete is
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1681 determined by calling @code{current-left-margin}. In no case does this
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1682 function delete non-whitespace. If @var{from} and @var{to} are omitted,
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1683 they default to the whole buffer.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1684 @end defun
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1685
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1686 @defun indent-to-left-margin
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1687 This function adjusts the indentation at the beginning of the current
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1688 line to the value specified by the variable @code{left-margin}. (That
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1689 may involve either inserting or deleting whitespace.) This function
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1690 is value of @code{indent-line-function} in Paragraph-Indent Text mode.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1691 @end defun
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1692
103273
c32ec20d0ab5 * abbrevs.texi (Abbrev Mode): abbrev-mode is an option.
Martin Rudalics <rudalics@gmx.at>
parents: 103264
diff changeset
1693 @defopt left-margin
84103
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1694 This variable specifies the base left margin column. In Fundamental
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1695 mode, @kbd{C-j} indents to this column. This variable automatically
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1696 becomes buffer-local when set in any fashion.
103273
c32ec20d0ab5 * abbrevs.texi (Abbrev Mode): abbrev-mode is an option.
Martin Rudalics <rudalics@gmx.at>
parents: 103264
diff changeset
1697 @end defopt
c32ec20d0ab5 * abbrevs.texi (Abbrev Mode): abbrev-mode is an option.
Martin Rudalics <rudalics@gmx.at>
parents: 103264
diff changeset
1698
c32ec20d0ab5 * abbrevs.texi (Abbrev Mode): abbrev-mode is an option.
Martin Rudalics <rudalics@gmx.at>
parents: 103264
diff changeset
1699 @defopt fill-nobreak-predicate
84103
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1700 This variable gives major modes a way to specify not to break a line
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1701 at certain places. Its value should be a list of functions. Whenever
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1702 filling considers breaking the line at a certain place in the buffer,
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1703 it calls each of these functions with no arguments and with point
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1704 located at that place. If any of the functions returns
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1705 non-@code{nil}, then the line won't be broken there.
103273
c32ec20d0ab5 * abbrevs.texi (Abbrev Mode): abbrev-mode is an option.
Martin Rudalics <rudalics@gmx.at>
parents: 103264
diff changeset
1706 @end defopt
84103
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1707
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1708 @node Adaptive Fill
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1709 @section Adaptive Fill Mode
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1710 @c @cindex Adaptive Fill mode "adaptive-fill-mode" is adjacent.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1711
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1712 When @dfn{Adaptive Fill Mode} is enabled, Emacs determines the fill
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1713 prefix automatically from the text in each paragraph being filled
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1714 rather than using a predetermined value. During filling, this fill
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1715 prefix gets inserted at the start of the second and subsequent lines
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1716 of the paragraph as described in @ref{Filling}, and in @ref{Auto
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1717 Filling}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1718
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1719 @defopt adaptive-fill-mode
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1720 Adaptive Fill mode is enabled when this variable is non-@code{nil}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1721 It is @code{t} by default.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1722 @end defopt
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1723
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1724 @defun fill-context-prefix from to
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1725 This function implements the heart of Adaptive Fill mode; it chooses a
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1726 fill prefix based on the text between @var{from} and @var{to},
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1727 typically the start and end of a paragraph. It does this by looking
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1728 at the first two lines of the paragraph, based on the variables
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1729 described below.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1730 @c The optional argument first-line-regexp is not documented
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1731 @c because it exists for internal purposes and might be eliminated
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1732 @c in the future.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1733
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1734 Usually, this function returns the fill prefix, a string. However,
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1735 before doing this, the function makes a final check (not specially
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1736 mentioned in the following) that a line starting with this prefix
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1737 wouldn't look like the start of a paragraph. Should this happen, the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1738 function signals the anomaly by returning @code{nil} instead.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1739
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1740 In detail, @code{fill-context-prefix} does this:
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1741
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1742 @enumerate
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1743 @item
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1744 It takes a candidate for the fill prefix from the first line---it
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1745 tries first the function in @code{adaptive-fill-function} (if any),
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1746 then the regular expression @code{adaptive-fill-regexp} (see below).
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1747 The first non-@code{nil} result of these, or the empty string if
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1748 they're both @code{nil}, becomes the first line's candidate.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1749 @item
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1750 If the paragraph has as yet only one line, the function tests the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1751 validity of the prefix candidate just found. The function then
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1752 returns the candidate if it's valid, or a string of spaces otherwise.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1753 (see the description of @code{adaptive-fill-first-line-regexp} below).
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1754 @item
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1755 When the paragraph already has two lines, the function next looks for
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1756 a prefix candidate on the second line, in just the same way it did for
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1757 the first line. If it doesn't find one, it returns @code{nil}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1758 @item
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1759 The function now compares the two candidate prefixes heuristically: if
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1760 the non-whitespace characters in the line 2 candidate occur in the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1761 same order in the line 1 candidate, the function returns the line 2
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1762 candidate. Otherwise, it returns the largest initial substring which
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1763 is common to both candidates (which might be the empty string).
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1764 @end enumerate
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1765 @end defun
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1766
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1767 @defopt adaptive-fill-regexp
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1768 Adaptive Fill mode matches this regular expression against the text
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1769 starting after the left margin whitespace (if any) on a line; the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1770 characters it matches are that line's candidate for the fill prefix.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1771
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1772 The default value matches whitespace with certain punctuation
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1773 characters intermingled.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1774 @end defopt
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1775
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1776 @defopt adaptive-fill-first-line-regexp
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1777 Used only in one-line paragraphs, this regular expression acts as an
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1778 additional check of the validity of the one available candidate fill
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1779 prefix: the candidate must match this regular expression, or match
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1780 @code{comment-start-skip}. If it doesn't, @code{fill-context-prefix}
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1781 replaces the candidate with a string of spaces ``of the same width''
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1782 as it.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1783
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1784 The default value of this variable is @w{@code{"\\`[ \t]*\\'"}}, which
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1785 matches only a string of whitespace. The effect of this default is to
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1786 force the fill prefixes found in one-line paragraphs always to be pure
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1787 whitespace.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1788 @end defopt
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1789
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1790 @defopt adaptive-fill-function
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1791 You can specify more complex ways of choosing a fill prefix
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1792 automatically by setting this variable to a function. The function is
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1793 called with point after the left margin (if any) of a line, and it
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1794 must preserve point. It should return either ``that line's'' fill
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1795 prefix or @code{nil}, meaning it has failed to determine a prefix.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1796 @end defopt
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1797
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1798 @node Auto Filling
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1799 @comment node-name, next, previous, up
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1800 @section Auto Filling
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1801 @cindex filling, automatic
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1802 @cindex Auto Fill mode
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1803
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1804 Auto Fill mode is a minor mode that fills lines automatically as text
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1805 is inserted. This section describes the hook used by Auto Fill mode.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1806 For a description of functions that you can call explicitly to fill and
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1807 justify existing text, see @ref{Filling}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1808
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1809 Auto Fill mode also enables the functions that change the margins and
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1810 justification style to refill portions of the text. @xref{Margins}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1811
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1812 @defvar auto-fill-function
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1813 The value of this buffer-local variable should be a function (of no
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1814 arguments) to be called after self-inserting a character from the table
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1815 @code{auto-fill-chars}. It may be @code{nil}, in which case nothing
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1816 special is done in that case.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1817
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1818 The value of @code{auto-fill-function} is @code{do-auto-fill} when
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1819 Auto-Fill mode is enabled. That is a function whose sole purpose is to
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1820 implement the usual strategy for breaking a line.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1821
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1822 @quotation
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1823 In older Emacs versions, this variable was named @code{auto-fill-hook},
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1824 but since it is not called with the standard convention for hooks, it
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1825 was renamed to @code{auto-fill-function} in version 19.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1826 @end quotation
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1827 @end defvar
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1828
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1829 @defvar normal-auto-fill-function
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1830 This variable specifies the function to use for
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1831 @code{auto-fill-function}, if and when Auto Fill is turned on. Major
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1832 modes can set buffer-local values for this variable to alter how Auto
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1833 Fill works.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1834 @end defvar
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1835
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1836 @defvar auto-fill-chars
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1837 A char table of characters which invoke @code{auto-fill-function} when
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1838 self-inserted---space and newline in most language environments. They
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1839 have an entry @code{t} in the table.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1840 @end defvar
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1841
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1842 @node Sorting
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1843 @section Sorting Text
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1844 @cindex sorting text
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1845
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1846 The sorting functions described in this section all rearrange text in
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1847 a buffer. This is in contrast to the function @code{sort}, which
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1848 rearranges the order of the elements of a list (@pxref{Rearrangement}).
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1849 The values returned by these functions are not meaningful.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1850
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1851 @defun sort-subr reverse nextrecfun endrecfun &optional startkeyfun endkeyfun predicate
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1852 This function is the general text-sorting routine that subdivides a
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1853 buffer into records and then sorts them. Most of the commands in this
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1854 section use this function.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1855
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1856 To understand how @code{sort-subr} works, consider the whole accessible
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1857 portion of the buffer as being divided into disjoint pieces called
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1858 @dfn{sort records}. The records may or may not be contiguous, but they
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1859 must not overlap. A portion of each sort record (perhaps all of it) is
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1860 designated as the sort key. Sorting rearranges the records in order by
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1861 their sort keys.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1862
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1863 Usually, the records are rearranged in order of ascending sort key.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1864 If the first argument to the @code{sort-subr} function, @var{reverse},
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1865 is non-@code{nil}, the sort records are rearranged in order of
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1866 descending sort key.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1867
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1868 The next four arguments to @code{sort-subr} are functions that are
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1869 called to move point across a sort record. They are called many times
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1870 from within @code{sort-subr}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1871
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1872 @enumerate
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1873 @item
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1874 @var{nextrecfun} is called with point at the end of a record. This
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1875 function moves point to the start of the next record. The first record
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1876 is assumed to start at the position of point when @code{sort-subr} is
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1877 called. Therefore, you should usually move point to the beginning of
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1878 the buffer before calling @code{sort-subr}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1879
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1880 This function can indicate there are no more sort records by leaving
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1881 point at the end of the buffer.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1882
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1883 @item
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1884 @var{endrecfun} is called with point within a record. It moves point to
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1885 the end of the record.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1886
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1887 @item
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1888 @var{startkeyfun} is called to move point from the start of a record to
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1889 the start of the sort key. This argument is optional; if it is omitted,
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1890 the whole record is the sort key. If supplied, the function should
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1891 either return a non-@code{nil} value to be used as the sort key, or
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1892 return @code{nil} to indicate that the sort key is in the buffer
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1893 starting at point. In the latter case, @var{endkeyfun} is called to
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1894 find the end of the sort key.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1895
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1896 @item
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1897 @var{endkeyfun} is called to move point from the start of the sort key
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1898 to the end of the sort key. This argument is optional. If
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1899 @var{startkeyfun} returns @code{nil} and this argument is omitted (or
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1900 @code{nil}), then the sort key extends to the end of the record. There
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1901 is no need for @var{endkeyfun} if @var{startkeyfun} returns a
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1902 non-@code{nil} value.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1903 @end enumerate
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1904
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1905 The argument @var{predicate} is the function to use to compare keys.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1906 If keys are numbers, it defaults to @code{<}; otherwise it defaults to
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1907 @code{string<}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1908
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1909 As an example of @code{sort-subr}, here is the complete function
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1910 definition for @code{sort-lines}:
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1911
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1912 @example
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1913 @group
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1914 ;; @r{Note that the first two lines of doc string}
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1915 ;; @r{are effectively one line when viewed by a user.}
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1916 (defun sort-lines (reverse beg end)
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1917 "Sort lines in region alphabetically;\
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1918 argument means descending order.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1919 Called from a program, there are three arguments:
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1920 @end group
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1921 @group
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1922 REVERSE (non-nil means reverse order),\
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1923 BEG and END (region to sort).
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1924 The variable `sort-fold-case' determines\
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1925 whether alphabetic case affects
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1926 the sort order."
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1927 @end group
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1928 @group
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1929 (interactive "P\nr")
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1930 (save-excursion
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1931 (save-restriction
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1932 (narrow-to-region beg end)
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1933 (goto-char (point-min))
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1934 (let ((inhibit-field-text-motion t))
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1935 (sort-subr reverse 'forward-line 'end-of-line)))))
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1936 @end group
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1937 @end example
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1938
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1939 Here @code{forward-line} moves point to the start of the next record,
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1940 and @code{end-of-line} moves point to the end of record. We do not pass
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1941 the arguments @var{startkeyfun} and @var{endkeyfun}, because the entire
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1942 record is used as the sort key.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1943
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1944 The @code{sort-paragraphs} function is very much the same, except that
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1945 its @code{sort-subr} call looks like this:
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1946
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1947 @example
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1948 @group
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1949 (sort-subr reverse
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1950 (function
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1951 (lambda ()
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1952 (while (and (not (eobp))
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1953 (looking-at paragraph-separate))
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1954 (forward-line 1))))
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1955 'forward-paragraph)
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1956 @end group
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1957 @end example
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1958
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1959 Markers pointing into any sort records are left with no useful
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1960 position after @code{sort-subr} returns.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1961 @end defun
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1962
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1963 @defopt sort-fold-case
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1964 If this variable is non-@code{nil}, @code{sort-subr} and the other
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1965 buffer sorting functions ignore case when comparing strings.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1966 @end defopt
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1967
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1968 @deffn Command sort-regexp-fields reverse record-regexp key-regexp start end
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1969 This command sorts the region between @var{start} and @var{end}
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1970 alphabetically as specified by @var{record-regexp} and @var{key-regexp}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1971 If @var{reverse} is a negative integer, then sorting is in reverse
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1972 order.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1973
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1974 Alphabetical sorting means that two sort keys are compared by
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1975 comparing the first characters of each, the second characters of each,
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1976 and so on. If a mismatch is found, it means that the sort keys are
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1977 unequal; the sort key whose character is less at the point of first
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1978 mismatch is the lesser sort key. The individual characters are compared
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1979 according to their numerical character codes in the Emacs character set.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1980
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1981 The value of the @var{record-regexp} argument specifies how to divide
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1982 the buffer into sort records. At the end of each record, a search is
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1983 done for this regular expression, and the text that matches it is taken
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1984 as the next record. For example, the regular expression @samp{^.+$},
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1985 which matches lines with at least one character besides a newline, would
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1986 make each such line into a sort record. @xref{Regular Expressions}, for
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1987 a description of the syntax and meaning of regular expressions.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1988
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1989 The value of the @var{key-regexp} argument specifies what part of each
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1990 record is the sort key. The @var{key-regexp} could match the whole
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1991 record, or only a part. In the latter case, the rest of the record has
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1992 no effect on the sorted order of records, but it is carried along when
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1993 the record moves to its new position.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1994
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1995 The @var{key-regexp} argument can refer to the text matched by a
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1996 subexpression of @var{record-regexp}, or it can be a regular expression
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1997 on its own.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1998
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1999 If @var{key-regexp} is:
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2000
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2001 @table @asis
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2002 @item @samp{\@var{digit}}
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2003 then the text matched by the @var{digit}th @samp{\(...\)} parenthesis
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2004 grouping in @var{record-regexp} is the sort key.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2005
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2006 @item @samp{\&}
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2007 then the whole record is the sort key.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2008
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2009 @item a regular expression
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2010 then @code{sort-regexp-fields} searches for a match for the regular
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2011 expression within the record. If such a match is found, it is the sort
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2012 key. If there is no match for @var{key-regexp} within a record then
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2013 that record is ignored, which means its position in the buffer is not
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2014 changed. (The other records may move around it.)
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2015 @end table
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2016
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2017 For example, if you plan to sort all the lines in the region by the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2018 first word on each line starting with the letter @samp{f}, you should
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2019 set @var{record-regexp} to @samp{^.*$} and set @var{key-regexp} to
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2020 @samp{\<f\w*\>}. The resulting expression looks like this:
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2021
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2022 @example
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2023 @group
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2024 (sort-regexp-fields nil "^.*$" "\\<f\\w*\\>"
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2025 (region-beginning)
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2026 (region-end))
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2027 @end group
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2028 @end example
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2029
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2030 If you call @code{sort-regexp-fields} interactively, it prompts for
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2031 @var{record-regexp} and @var{key-regexp} in the minibuffer.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2032 @end deffn
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2033
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2034 @deffn Command sort-lines reverse start end
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2035 This command alphabetically sorts lines in the region between
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2036 @var{start} and @var{end}. If @var{reverse} is non-@code{nil}, the sort
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2037 is in reverse order.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2038 @end deffn
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2039
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2040 @deffn Command sort-paragraphs reverse start end
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2041 This command alphabetically sorts paragraphs in the region between
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2042 @var{start} and @var{end}. If @var{reverse} is non-@code{nil}, the sort
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2043 is in reverse order.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2044 @end deffn
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2045
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2046 @deffn Command sort-pages reverse start end
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2047 This command alphabetically sorts pages in the region between
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2048 @var{start} and @var{end}. If @var{reverse} is non-@code{nil}, the sort
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2049 is in reverse order.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2050 @end deffn
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2051
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2052 @deffn Command sort-fields field start end
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2053 This command sorts lines in the region between @var{start} and
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2054 @var{end}, comparing them alphabetically by the @var{field}th field
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2055 of each line. Fields are separated by whitespace and numbered starting
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2056 from 1. If @var{field} is negative, sorting is by the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2057 @w{@minus{}@var{field}th} field from the end of the line. This command
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2058 is useful for sorting tables.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2059 @end deffn
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2060
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2061 @deffn Command sort-numeric-fields field start end
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2062 This command sorts lines in the region between @var{start} and
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2063 @var{end}, comparing them numerically by the @var{field}th field of
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2064 each line. Fields are separated by whitespace and numbered starting
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2065 from 1. The specified field must contain a number in each line of the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2066 region. Numbers starting with 0 are treated as octal, and numbers
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2067 starting with @samp{0x} are treated as hexadecimal.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2068
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2069 If @var{field} is negative, sorting is by the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2070 @w{@minus{}@var{field}th} field from the end of the line. This
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2071 command is useful for sorting tables.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2072 @end deffn
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2073
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2074 @defopt sort-numeric-base
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2075 This variable specifies the default radix for
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2076 @code{sort-numeric-fields} to parse numbers.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2077 @end defopt
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2078
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2079 @deffn Command sort-columns reverse &optional beg end
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2080 This command sorts the lines in the region between @var{beg} and
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2081 @var{end}, comparing them alphabetically by a certain range of
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2082 columns. The column positions of @var{beg} and @var{end} bound the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2083 range of columns to sort on.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2084
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2085 If @var{reverse} is non-@code{nil}, the sort is in reverse order.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2086
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2087 One unusual thing about this command is that the entire line
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2088 containing position @var{beg}, and the entire line containing position
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2089 @var{end}, are included in the region sorted.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2090
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2091 Note that @code{sort-columns} rejects text that contains tabs, because
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2092 tabs could be split across the specified columns. Use @kbd{M-x
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2093 untabify} to convert tabs to spaces before sorting.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2094
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2095 When possible, this command actually works by calling the @code{sort}
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2096 utility program.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2097 @end deffn
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2098
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2099 @node Columns
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2100 @comment node-name, next, previous, up
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2101 @section Counting Columns
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2102 @cindex columns
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2103 @cindex counting columns
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2104 @cindex horizontal position
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2105
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2106 The column functions convert between a character position (counting
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2107 characters from the beginning of the buffer) and a column position
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2108 (counting screen characters from the beginning of a line).
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2109
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2110 These functions count each character according to the number of
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2111 columns it occupies on the screen. This means control characters count
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2112 as occupying 2 or 4 columns, depending upon the value of
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2113 @code{ctl-arrow}, and tabs count as occupying a number of columns that
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2114 depends on the value of @code{tab-width} and on the column where the tab
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2115 begins. @xref{Usual Display}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2116
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2117 Column number computations ignore the width of the window and the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2118 amount of horizontal scrolling. Consequently, a column value can be
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2119 arbitrarily high. The first (or leftmost) column is numbered 0. They
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2120 also ignore overlays and text properties, aside from invisibility.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2121
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2122 @defun current-column
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2123 This function returns the horizontal position of point, measured in
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2124 columns, counting from 0 at the left margin. The column position is the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2125 sum of the widths of all the displayed representations of the characters
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2126 between the start of the current line and point.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2127
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2128 For an example of using @code{current-column}, see the description of
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2129 @code{count-lines} in @ref{Text Lines}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2130 @end defun
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2131
103264
b269cabac20c * syntax.texi (Position Parse): Document rationale for ignored
Chong Yidong <cyd@stupidchicken.com>
parents: 102893
diff changeset
2132 @deffn Command move-to-column column &optional force
84103
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2133 This function moves point to @var{column} in the current line. The
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2134 calculation of @var{column} takes into account the widths of the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2135 displayed representations of the characters between the start of the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2136 line and point.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2137
103264
b269cabac20c * syntax.texi (Position Parse): Document rationale for ignored
Chong Yidong <cyd@stupidchicken.com>
parents: 102893
diff changeset
2138 When called interactively, @var{column} is the value of prefix numeric
b269cabac20c * syntax.texi (Position Parse): Document rationale for ignored
Chong Yidong <cyd@stupidchicken.com>
parents: 102893
diff changeset
2139 argument. If @var{column} is not an integer, an error is signaled.
b269cabac20c * syntax.texi (Position Parse): Document rationale for ignored
Chong Yidong <cyd@stupidchicken.com>
parents: 102893
diff changeset
2140
b269cabac20c * syntax.texi (Position Parse): Document rationale for ignored
Chong Yidong <cyd@stupidchicken.com>
parents: 102893
diff changeset
2141 If column @var{column} is beyond the end of the line, point moves to
b269cabac20c * syntax.texi (Position Parse): Document rationale for ignored
Chong Yidong <cyd@stupidchicken.com>
parents: 102893
diff changeset
2142 the end of the line. If @var{column} is negative, point moves to the
84103
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2143 beginning of the line.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2144
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2145 If it is impossible to move to column @var{column} because that is in
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2146 the middle of a multicolumn character such as a tab, point moves to the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2147 end of that character. However, if @var{force} is non-@code{nil}, and
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2148 @var{column} is in the middle of a tab, then @code{move-to-column}
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2149 converts the tab into spaces so that it can move precisely to column
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2150 @var{column}. Other multicolumn characters can cause anomalies despite
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2151 @var{force}, since there is no way to split them.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2152
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2153 The argument @var{force} also has an effect if the line isn't long
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2154 enough to reach column @var{column}; if it is @code{t}, that means to
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2155 add whitespace at the end of the line to reach that column.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2156
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2157 The return value is the column number actually moved to.
103264
b269cabac20c * syntax.texi (Position Parse): Document rationale for ignored
Chong Yidong <cyd@stupidchicken.com>
parents: 102893
diff changeset
2158 @end deffn
84103
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2159
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2160 @node Indentation
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2161 @section Indentation
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2162 @cindex indentation
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2163
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2164 The indentation functions are used to examine, move to, and change
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2165 whitespace that is at the beginning of a line. Some of the functions
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2166 can also change whitespace elsewhere on a line. Columns and indentation
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2167 count from zero at the left margin.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2168
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2169 @menu
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2170 * Primitive Indent:: Functions used to count and insert indentation.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2171 * Mode-Specific Indent:: Customize indentation for different modes.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2172 * Region Indent:: Indent all the lines in a region.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2173 * Relative Indent:: Indent the current line based on previous lines.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2174 * Indent Tabs:: Adjustable, typewriter-like tab stops.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2175 * Motion by Indent:: Move to first non-blank character.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2176 @end menu
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2177
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2178 @node Primitive Indent
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2179 @subsection Indentation Primitives
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2180
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2181 This section describes the primitive functions used to count and
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2182 insert indentation. The functions in the following sections use these
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2183 primitives. @xref{Width}, for related functions.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2184
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2185 @defun current-indentation
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2186 @comment !!Type Primitive Function
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2187 @comment !!SourceFile indent.c
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2188 This function returns the indentation of the current line, which is
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2189 the horizontal position of the first nonblank character. If the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2190 contents are entirely blank, then this is the horizontal position of the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2191 end of the line.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2192 @end defun
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2193
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2194 @deffn Command indent-to column &optional minimum
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2195 @comment !!Type Primitive Function
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2196 @comment !!SourceFile indent.c
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2197 This function indents from point with tabs and spaces until @var{column}
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2198 is reached. If @var{minimum} is specified and non-@code{nil}, then at
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2199 least that many spaces are inserted even if this requires going beyond
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2200 @var{column}. Otherwise the function does nothing if point is already
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2201 beyond @var{column}. The value is the column at which the inserted
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2202 indentation ends.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2203
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2204 The inserted whitespace characters inherit text properties from the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2205 surrounding text (usually, from the preceding text only). @xref{Sticky
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2206 Properties}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2207 @end deffn
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2208
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2209 @defopt indent-tabs-mode
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2210 @comment !!SourceFile indent.c
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2211 If this variable is non-@code{nil}, indentation functions can insert
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2212 tabs as well as spaces. Otherwise, they insert only spaces. Setting
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2213 this variable automatically makes it buffer-local in the current buffer.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2214 @end defopt
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2215
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2216 @node Mode-Specific Indent
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2217 @subsection Indentation Controlled by Major Mode
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2218
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2219 An important function of each major mode is to customize the @key{TAB}
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2220 key to indent properly for the language being edited. This section
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2221 describes the mechanism of the @key{TAB} key and how to control it.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2222 The functions in this section return unpredictable values.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2223
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2224 @defvar indent-line-function
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2225 This variable's value is the function to be used by @key{TAB} (and
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2226 various commands) to indent the current line. The command
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2227 @code{indent-according-to-mode} does no more than call this function.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2228
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2229 In Lisp mode, the value is the symbol @code{lisp-indent-line}; in C
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2230 mode, @code{c-indent-line}; in Fortran mode, @code{fortran-indent-line}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2231 The default value is @code{indent-relative}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2232 @end defvar
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2233
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2234 @deffn Command indent-according-to-mode
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2235 This command calls the function in @code{indent-line-function} to
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2236 indent the current line in a way appropriate for the current major mode.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2237 @end deffn
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2238
103264
b269cabac20c * syntax.texi (Position Parse): Document rationale for ignored
Chong Yidong <cyd@stupidchicken.com>
parents: 102893
diff changeset
2239 @deffn Command indent-for-tab-command &optional rigid
b269cabac20c * syntax.texi (Position Parse): Document rationale for ignored
Chong Yidong <cyd@stupidchicken.com>
parents: 102893
diff changeset
2240 This command calls the function in @code{indent-line-function} to
b269cabac20c * syntax.texi (Position Parse): Document rationale for ignored
Chong Yidong <cyd@stupidchicken.com>
parents: 102893
diff changeset
2241 indent the current line; however, if that function is
b269cabac20c * syntax.texi (Position Parse): Document rationale for ignored
Chong Yidong <cyd@stupidchicken.com>
parents: 102893
diff changeset
2242 @code{indent-to-left-margin}, @code{insert-tab} is called instead.
b269cabac20c * syntax.texi (Position Parse): Document rationale for ignored
Chong Yidong <cyd@stupidchicken.com>
parents: 102893
diff changeset
2243 (That is a trivial command that inserts a tab character.) If
b269cabac20c * syntax.texi (Position Parse): Document rationale for ignored
Chong Yidong <cyd@stupidchicken.com>
parents: 102893
diff changeset
2244 @var{rigid} is non-@code{nil}, this function also rigidly indents the
b269cabac20c * syntax.texi (Position Parse): Document rationale for ignored
Chong Yidong <cyd@stupidchicken.com>
parents: 102893
diff changeset
2245 entire balanced expression that starts at the beginning of the current
b269cabac20c * syntax.texi (Position Parse): Document rationale for ignored
Chong Yidong <cyd@stupidchicken.com>
parents: 102893
diff changeset
2246 line, to reflect change in indentation of the current line.
84103
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2247 @end deffn
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2248
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2249 @deffn Command newline-and-indent
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2250 This function inserts a newline, then indents the new line (the one
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2251 following the newline just inserted) according to the major mode.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2252
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2253 It does indentation by calling the current @code{indent-line-function}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2254 In programming language modes, this is the same thing @key{TAB} does,
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2255 but in some text modes, where @key{TAB} inserts a tab,
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2256 @code{newline-and-indent} indents to the column specified by
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2257 @code{left-margin}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2258 @end deffn
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2259
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2260 @deffn Command reindent-then-newline-and-indent
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2261 @comment !!SourceFile simple.el
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2262 This command reindents the current line, inserts a newline at point,
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2263 and then indents the new line (the one following the newline just
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2264 inserted).
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2265
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2266 This command does indentation on both lines according to the current
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2267 major mode, by calling the current value of @code{indent-line-function}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2268 In programming language modes, this is the same thing @key{TAB} does,
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2269 but in some text modes, where @key{TAB} inserts a tab,
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2270 @code{reindent-then-newline-and-indent} indents to the column specified
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2271 by @code{left-margin}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2272 @end deffn
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2273
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2274 @node Region Indent
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2275 @subsection Indenting an Entire Region
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2276
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2277 This section describes commands that indent all the lines in the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2278 region. They return unpredictable values.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2279
103264
b269cabac20c * syntax.texi (Position Parse): Document rationale for ignored
Chong Yidong <cyd@stupidchicken.com>
parents: 102893
diff changeset
2280 @deffn Command indent-region start end &optional to-column
84103
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2281 This command indents each nonblank line starting between @var{start}
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2282 (inclusive) and @var{end} (exclusive). If @var{to-column} is
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2283 @code{nil}, @code{indent-region} indents each nonblank line by calling
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2284 the current mode's indentation function, the value of
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2285 @code{indent-line-function}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2286
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2287 If @var{to-column} is non-@code{nil}, it should be an integer
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2288 specifying the number of columns of indentation; then this function
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2289 gives each line exactly that much indentation, by either adding or
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2290 deleting whitespace.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2291
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2292 If there is a fill prefix, @code{indent-region} indents each line
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2293 by making it start with the fill prefix.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2294 @end deffn
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2295
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2296 @defvar indent-region-function
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2297 The value of this variable is a function that can be used by
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2298 @code{indent-region} as a short cut. It should take two arguments, the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2299 start and end of the region. You should design the function so
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2300 that it will produce the same results as indenting the lines of the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2301 region one by one, but presumably faster.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2302
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2303 If the value is @code{nil}, there is no short cut, and
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2304 @code{indent-region} actually works line by line.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2305
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2306 A short-cut function is useful in modes such as C mode and Lisp mode,
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2307 where the @code{indent-line-function} must scan from the beginning of
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2308 the function definition: applying it to each line would be quadratic in
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2309 time. The short cut can update the scan information as it moves through
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2310 the lines indenting them; this takes linear time. In a mode where
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2311 indenting a line individually is fast, there is no need for a short cut.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2312
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2313 @code{indent-region} with a non-@code{nil} argument @var{to-column} has
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2314 a different meaning and does not use this variable.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2315 @end defvar
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2316
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2317 @deffn Command indent-rigidly start end count
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2318 This command indents all lines starting between @var{start}
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2319 (inclusive) and @var{end} (exclusive) sideways by @var{count} columns.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2320 This ``preserves the shape'' of the affected region, moving it as a
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2321 rigid unit. Consequently, this command is useful not only for indenting
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2322 regions of unindented text, but also for indenting regions of formatted
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2323 code.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2324
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2325 For example, if @var{count} is 3, this command adds 3 columns of
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2326 indentation to each of the lines beginning in the region specified.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2327
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2328 In Mail mode, @kbd{C-c C-y} (@code{mail-yank-original}) uses
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2329 @code{indent-rigidly} to indent the text copied from the message being
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2330 replied to.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2331 @end deffn
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2332
103264
b269cabac20c * syntax.texi (Position Parse): Document rationale for ignored
Chong Yidong <cyd@stupidchicken.com>
parents: 102893
diff changeset
2333 @deffn Command indent-code-rigidly start end columns &optional nochange-regexp
84103
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2334 This is like @code{indent-rigidly}, except that it doesn't alter lines
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2335 that start within strings or comments.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2336
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2337 In addition, it doesn't alter a line if @var{nochange-regexp} matches at
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2338 the beginning of the line (if @var{nochange-regexp} is non-@code{nil}).
103264
b269cabac20c * syntax.texi (Position Parse): Document rationale for ignored
Chong Yidong <cyd@stupidchicken.com>
parents: 102893
diff changeset
2339 @end deffn
84103
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2340
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2341 @node Relative Indent
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2342 @subsection Indentation Relative to Previous Lines
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2343
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2344 This section describes two commands that indent the current line
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2345 based on the contents of previous lines.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2346
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2347 @deffn Command indent-relative &optional unindented-ok
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2348 This command inserts whitespace at point, extending to the same
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2349 column as the next @dfn{indent point} of the previous nonblank line. An
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2350 indent point is a non-whitespace character following whitespace. The
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2351 next indent point is the first one at a column greater than the current
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2352 column of point. For example, if point is underneath and to the left of
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2353 the first non-blank character of a line of text, it moves to that column
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2354 by inserting whitespace.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2355
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2356 If the previous nonblank line has no next indent point (i.e., none at a
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2357 great enough column position), @code{indent-relative} either does
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2358 nothing (if @var{unindented-ok} is non-@code{nil}) or calls
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2359 @code{tab-to-tab-stop}. Thus, if point is underneath and to the right
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2360 of the last column of a short line of text, this command ordinarily
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2361 moves point to the next tab stop by inserting whitespace.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2362
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2363 The return value of @code{indent-relative} is unpredictable.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2364
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2365 In the following example, point is at the beginning of the second
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2366 line:
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2367
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2368 @example
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2369 @group
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2370 This line is indented twelve spaces.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2371 @point{}The quick brown fox jumped.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2372 @end group
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2373 @end example
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2374
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2375 @noindent
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2376 Evaluation of the expression @code{(indent-relative nil)} produces the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2377 following:
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2378
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2379 @example
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2380 @group
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2381 This line is indented twelve spaces.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2382 @point{}The quick brown fox jumped.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2383 @end group
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2384 @end example
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2385
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2386 In this next example, point is between the @samp{m} and @samp{p} of
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2387 @samp{jumped}:
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2388
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2389 @example
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2390 @group
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2391 This line is indented twelve spaces.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2392 The quick brown fox jum@point{}ped.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2393 @end group
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2394 @end example
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2395
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2396 @noindent
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2397 Evaluation of the expression @code{(indent-relative nil)} produces the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2398 following:
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2399
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2400 @example
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2401 @group
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2402 This line is indented twelve spaces.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2403 The quick brown fox jum @point{}ped.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2404 @end group
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2405 @end example
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2406 @end deffn
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2407
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2408 @deffn Command indent-relative-maybe
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2409 @comment !!SourceFile indent.el
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2410 This command indents the current line like the previous nonblank line,
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2411 by calling @code{indent-relative} with @code{t} as the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2412 @var{unindented-ok} argument. The return value is unpredictable.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2413
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2414 If the previous nonblank line has no indent points beyond the current
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2415 column, this command does nothing.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2416 @end deffn
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2417
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2418 @node Indent Tabs
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2419 @comment node-name, next, previous, up
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2420 @subsection Adjustable ``Tab Stops''
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2421 @cindex tabs stops for indentation
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2422
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2423 This section explains the mechanism for user-specified ``tab stops''
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2424 and the mechanisms that use and set them. The name ``tab stops'' is
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2425 used because the feature is similar to that of the tab stops on a
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2426 typewriter. The feature works by inserting an appropriate number of
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2427 spaces and tab characters to reach the next tab stop column; it does not
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2428 affect the display of tab characters in the buffer (@pxref{Usual
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2429 Display}). Note that the @key{TAB} character as input uses this tab
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2430 stop feature only in a few major modes, such as Text mode.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2431 @xref{Tab Stops,,, emacs, The GNU Emacs Manual}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2432
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2433 @deffn Command tab-to-tab-stop
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2434 This command inserts spaces or tabs before point, up to the next tab
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2435 stop column defined by @code{tab-stop-list}. It searches the list for
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2436 an element greater than the current column number, and uses that element
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2437 as the column to indent to. It does nothing if no such element is
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2438 found.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2439 @end deffn
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2440
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2441 @defopt tab-stop-list
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2442 This variable is the list of tab stop columns used by
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2443 @code{tab-to-tab-stops}. The elements should be integers in increasing
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2444 order. The tab stop columns need not be evenly spaced.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2445
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2446 Use @kbd{M-x edit-tab-stops} to edit the location of tab stops
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2447 interactively.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2448 @end defopt
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2449
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2450 @node Motion by Indent
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2451 @subsection Indentation-Based Motion Commands
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2452
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2453 These commands, primarily for interactive use, act based on the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2454 indentation in the text.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2455
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2456 @deffn Command back-to-indentation
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2457 @comment !!SourceFile simple.el
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2458 This command moves point to the first non-whitespace character in the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2459 current line (which is the line in which point is located). It returns
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2460 @code{nil}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2461 @end deffn
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2462
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2463 @deffn Command backward-to-indentation &optional arg
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2464 @comment !!SourceFile simple.el
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2465 This command moves point backward @var{arg} lines and then to the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2466 first nonblank character on that line. It returns @code{nil}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2467 If @var{arg} is omitted or @code{nil}, it defaults to 1.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2468 @end deffn
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2469
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2470 @deffn Command forward-to-indentation &optional arg
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2471 @comment !!SourceFile simple.el
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2472 This command moves point forward @var{arg} lines and then to the first
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2473 nonblank character on that line. It returns @code{nil}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2474 If @var{arg} is omitted or @code{nil}, it defaults to 1.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2475 @end deffn
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2476
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2477 @node Case Changes
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2478 @comment node-name, next, previous, up
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2479 @section Case Changes
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2480 @cindex case conversion in buffers
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2481
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2482 The case change commands described here work on text in the current
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2483 buffer. @xref{Case Conversion}, for case conversion functions that work
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2484 on strings and characters. @xref{Case Tables}, for how to customize
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2485 which characters are upper or lower case and how to convert them.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2486
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2487 @deffn Command capitalize-region start end
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2488 This function capitalizes all words in the region defined by
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2489 @var{start} and @var{end}. To capitalize means to convert each word's
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2490 first character to upper case and convert the rest of each word to lower
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2491 case. The function returns @code{nil}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2492
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2493 If one end of the region is in the middle of a word, the part of the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2494 word within the region is treated as an entire word.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2495
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2496 When @code{capitalize-region} is called interactively, @var{start} and
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2497 @var{end} are point and the mark, with the smallest first.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2498
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2499 @example
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2500 @group
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2501 ---------- Buffer: foo ----------
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2502 This is the contents of the 5th foo.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2503 ---------- Buffer: foo ----------
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2504 @end group
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2505
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2506 @group
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2507 (capitalize-region 1 44)
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2508 @result{} nil
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2509
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2510 ---------- Buffer: foo ----------
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2511 This Is The Contents Of The 5th Foo.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2512 ---------- Buffer: foo ----------
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2513 @end group
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2514 @end example
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2515 @end deffn
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2516
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2517 @deffn Command downcase-region start end
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2518 This function converts all of the letters in the region defined by
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2519 @var{start} and @var{end} to lower case. The function returns
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2520 @code{nil}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2521
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2522 When @code{downcase-region} is called interactively, @var{start} and
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2523 @var{end} are point and the mark, with the smallest first.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2524 @end deffn
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2525
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2526 @deffn Command upcase-region start end
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2527 This function converts all of the letters in the region defined by
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2528 @var{start} and @var{end} to upper case. The function returns
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2529 @code{nil}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2530
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2531 When @code{upcase-region} is called interactively, @var{start} and
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2532 @var{end} are point and the mark, with the smallest first.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2533 @end deffn
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2534
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2535 @deffn Command capitalize-word count
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2536 This function capitalizes @var{count} words after point, moving point
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2537 over as it does. To capitalize means to convert each word's first
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2538 character to upper case and convert the rest of each word to lower case.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2539 If @var{count} is negative, the function capitalizes the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2540 @minus{}@var{count} previous words but does not move point. The value
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2541 is @code{nil}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2542
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2543 If point is in the middle of a word, the part of the word before point
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2544 is ignored when moving forward. The rest is treated as an entire word.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2545
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2546 When @code{capitalize-word} is called interactively, @var{count} is
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2547 set to the numeric prefix argument.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2548 @end deffn
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2549
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2550 @deffn Command downcase-word count
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2551 This function converts the @var{count} words after point to all lower
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2552 case, moving point over as it does. If @var{count} is negative, it
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2553 converts the @minus{}@var{count} previous words but does not move point.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2554 The value is @code{nil}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2555
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2556 When @code{downcase-word} is called interactively, @var{count} is set
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2557 to the numeric prefix argument.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2558 @end deffn
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2559
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2560 @deffn Command upcase-word count
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2561 This function converts the @var{count} words after point to all upper
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2562 case, moving point over as it does. If @var{count} is negative, it
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2563 converts the @minus{}@var{count} previous words but does not move point.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2564 The value is @code{nil}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2565
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2566 When @code{upcase-word} is called interactively, @var{count} is set to
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2567 the numeric prefix argument.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2568 @end deffn
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2569
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2570 @node Text Properties
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2571 @section Text Properties
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2572 @cindex text properties
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2573 @cindex attributes of text
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2574 @cindex properties of text
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2575
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2576 Each character position in a buffer or a string can have a @dfn{text
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2577 property list}, much like the property list of a symbol (@pxref{Property
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2578 Lists}). The properties belong to a particular character at a
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2579 particular place, such as, the letter @samp{T} at the beginning of this
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2580 sentence or the first @samp{o} in @samp{foo}---if the same character
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2581 occurs in two different places, the two occurrences in general have
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2582 different properties.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2583
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2584 Each property has a name and a value. Both of these can be any Lisp
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2585 object, but the name is normally a symbol. Typically each property
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2586 name symbol is used for a particular purpose; for instance, the text
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2587 property @code{face} specifies the faces for displaying the character
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2588 (@pxref{Special Properties}). The usual way to access the property
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2589 list is to specify a name and ask what value corresponds to it.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2590
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2591 If a character has a @code{category} property, we call it the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2592 @dfn{property category} of the character. It should be a symbol. The
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2593 properties of the symbol serve as defaults for the properties of the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2594 character.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2595
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2596 Copying text between strings and buffers preserves the properties
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2597 along with the characters; this includes such diverse functions as
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2598 @code{substring}, @code{insert}, and @code{buffer-substring}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2599
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2600 @menu
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2601 * Examining Properties:: Looking at the properties of one character.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2602 * Changing Properties:: Setting the properties of a range of text.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2603 * Property Search:: Searching for where a property changes value.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2604 * Special Properties:: Particular properties with special meanings.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2605 * Format Properties:: Properties for representing formatting of text.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2606 * Sticky Properties:: How inserted text gets properties from
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2607 neighboring text.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2608 * Lazy Properties:: Computing text properties in a lazy fashion
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2609 only when text is examined.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2610 * Clickable Text:: Using text properties to make regions of text
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2611 do something when you click on them.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2612 * Fields:: The @code{field} property defines
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2613 fields within the buffer.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2614 * Not Intervals:: Why text properties do not use
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2615 Lisp-visible text intervals.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2616 @end menu
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2617
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2618 @node Examining Properties
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2619 @subsection Examining Text Properties
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2620
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2621 The simplest way to examine text properties is to ask for the value of
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2622 a particular property of a particular character. For that, use
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2623 @code{get-text-property}. Use @code{text-properties-at} to get the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2624 entire property list of a character. @xref{Property Search}, for
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2625 functions to examine the properties of a number of characters at once.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2626
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2627 These functions handle both strings and buffers. Keep in mind that
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2628 positions in a string start from 0, whereas positions in a buffer start
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2629 from 1.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2630
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2631 @defun get-text-property pos prop &optional object
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2632 This function returns the value of the @var{prop} property of the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2633 character after position @var{pos} in @var{object} (a buffer or
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2634 string). The argument @var{object} is optional and defaults to the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2635 current buffer.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2636
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2637 If there is no @var{prop} property strictly speaking, but the character
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2638 has a property category that is a symbol, then @code{get-text-property} returns
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2639 the @var{prop} property of that symbol.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2640 @end defun
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2641
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2642 @defun get-char-property position prop &optional object
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2643 This function is like @code{get-text-property}, except that it checks
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2644 overlays first and then text properties. @xref{Overlays}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2645
85311
591c29778a30 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85079
diff changeset
2646 The argument @var{object} may be a string, a buffer, or a window. If
591c29778a30 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85079
diff changeset
2647 it is a window, then the buffer displayed in that window is used for
591c29778a30 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85079
diff changeset
2648 text properties and overlays, but only the overlays active for that
591c29778a30 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85079
diff changeset
2649 window are considered. If @var{object} is a buffer, then overlays in
591c29778a30 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85079
diff changeset
2650 that buffer are considered first, in order of decreasing priority,
591c29778a30 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85079
diff changeset
2651 followed by the text properties. If @var{object} is a string, only
591c29778a30 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85079
diff changeset
2652 text properties are considered, since strings never have overlays.
84103
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2653 @end defun
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2654
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2655 @defun get-char-property-and-overlay position prop &optional object
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2656 This is like @code{get-char-property}, but gives extra information
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2657 about the overlay that the property value comes from.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2658
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2659 Its value is a cons cell whose @sc{car} is the property value, the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2660 same value @code{get-char-property} would return with the same
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2661 arguments. Its @sc{cdr} is the overlay in which the property was
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2662 found, or @code{nil}, if it was found as a text property or not found
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2663 at all.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2664
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2665 If @var{position} is at the end of @var{object}, both the @sc{car} and
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2666 the @sc{cdr} of the value are @code{nil}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2667 @end defun
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2668
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2669 @defvar char-property-alias-alist
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2670 This variable holds an alist which maps property names to a list of
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2671 alternative property names. If a character does not specify a direct
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2672 value for a property, the alternative property names are consulted in
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2673 order; the first non-@code{nil} value is used. This variable takes
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2674 precedence over @code{default-text-properties}, and @code{category}
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2675 properties take precedence over this variable.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2676 @end defvar
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2677
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2678 @defun text-properties-at position &optional object
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2679 This function returns the entire property list of the character at
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2680 @var{position} in the string or buffer @var{object}. If @var{object} is
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2681 @code{nil}, it defaults to the current buffer.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2682 @end defun
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2683
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2684 @defvar default-text-properties
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2685 This variable holds a property list giving default values for text
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2686 properties. Whenever a character does not specify a value for a
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2687 property, neither directly, through a category symbol, or through
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2688 @code{char-property-alias-alist}, the value stored in this list is
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2689 used instead. Here is an example:
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2690
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2691 @example
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2692 (setq default-text-properties '(foo 69)
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2693 char-property-alias-alist nil)
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2694 ;; @r{Make sure character 1 has no properties of its own.}
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2695 (set-text-properties 1 2 nil)
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2696 ;; @r{What we get, when we ask, is the default value.}
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2697 (get-text-property 1 'foo)
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2698 @result{} 69
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2699 @end example
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2700 @end defvar
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2701
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2702 @node Changing Properties
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2703 @subsection Changing Text Properties
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2704
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2705 The primitives for changing properties apply to a specified range of
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2706 text in a buffer or string. The function @code{set-text-properties}
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2707 (see end of section) sets the entire property list of the text in that
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2708 range; more often, it is useful to add, change, or delete just certain
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2709 properties specified by name.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2710
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2711 Since text properties are considered part of the contents of the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2712 buffer (or string), and can affect how a buffer looks on the screen,
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2713 any change in buffer text properties marks the buffer as modified.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2714 Buffer text property changes are undoable also (@pxref{Undo}).
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2715 Positions in a string start from 0, whereas positions in a buffer
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2716 start from 1.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2717
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2718 @defun put-text-property start end prop value &optional object
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2719 This function sets the @var{prop} property to @var{value} for the text
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2720 between @var{start} and @var{end} in the string or buffer @var{object}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2721 If @var{object} is @code{nil}, it defaults to the current buffer.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2722 @end defun
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2723
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2724 @defun add-text-properties start end props &optional object
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2725 This function adds or overrides text properties for the text between
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2726 @var{start} and @var{end} in the string or buffer @var{object}. If
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2727 @var{object} is @code{nil}, it defaults to the current buffer.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2728
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2729 The argument @var{props} specifies which properties to add. It should
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2730 have the form of a property list (@pxref{Property Lists}): a list whose
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2731 elements include the property names followed alternately by the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2732 corresponding values.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2733
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2734 The return value is @code{t} if the function actually changed some
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2735 property's value; @code{nil} otherwise (if @var{props} is @code{nil} or
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2736 its values agree with those in the text).
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2737
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2738 For example, here is how to set the @code{comment} and @code{face}
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2739 properties of a range of text:
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2740
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2741 @example
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2742 (add-text-properties @var{start} @var{end}
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2743 '(comment t face highlight))
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2744 @end example
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2745 @end defun
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2746
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2747 @defun remove-text-properties start end props &optional object
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2748 This function deletes specified text properties from the text between
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2749 @var{start} and @var{end} in the string or buffer @var{object}. If
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2750 @var{object} is @code{nil}, it defaults to the current buffer.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2751
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2752 The argument @var{props} specifies which properties to delete. It
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2753 should have the form of a property list (@pxref{Property Lists}): a list
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2754 whose elements are property names alternating with corresponding values.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2755 But only the names matter---the values that accompany them are ignored.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2756 For example, here's how to remove the @code{face} property.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2757
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2758 @example
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2759 (remove-text-properties @var{start} @var{end} '(face nil))
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2760 @end example
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2761
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2762 The return value is @code{t} if the function actually changed some
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2763 property's value; @code{nil} otherwise (if @var{props} is @code{nil} or
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2764 if no character in the specified text had any of those properties).
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2765
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2766 To remove all text properties from certain text, use
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2767 @code{set-text-properties} and specify @code{nil} for the new property
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2768 list.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2769 @end defun
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2770
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2771 @defun remove-list-of-text-properties start end list-of-properties &optional object
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2772 Like @code{remove-text-properties} except that
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2773 @var{list-of-properties} is a list of property names only, not an
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2774 alternating list of property names and values.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2775 @end defun
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2776
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2777 @defun set-text-properties start end props &optional object
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2778 This function completely replaces the text property list for the text
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2779 between @var{start} and @var{end} in the string or buffer @var{object}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2780 If @var{object} is @code{nil}, it defaults to the current buffer.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2781
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2782 The argument @var{props} is the new property list. It should be a list
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2783 whose elements are property names alternating with corresponding values.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2784
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2785 After @code{set-text-properties} returns, all the characters in the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2786 specified range have identical properties.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2787
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2788 If @var{props} is @code{nil}, the effect is to get rid of all properties
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2789 from the specified range of text. Here's an example:
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2790
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2791 @example
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2792 (set-text-properties @var{start} @var{end} nil)
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2793 @end example
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2794
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2795 Do not rely on the return value of this function.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2796 @end defun
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2797
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2798 The easiest way to make a string with text properties
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2799 is with @code{propertize}:
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2800
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2801 @defun propertize string &rest properties
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2802 This function returns a copy of @var{string} which has the text
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2803 properties @var{properties}. These properties apply to all the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2804 characters in the string that is returned. Here is an example that
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2805 constructs a string with a @code{face} property and a @code{mouse-face}
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2806 property:
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2807
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2808 @smallexample
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2809 (propertize "foo" 'face 'italic
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2810 'mouse-face 'bold-italic)
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2811 @result{} #("foo" 0 3 (mouse-face bold-italic face italic))
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2812 @end smallexample
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2813
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2814 To put different properties on various parts of a string, you can
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2815 construct each part with @code{propertize} and then combine them with
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2816 @code{concat}:
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2817
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2818 @smallexample
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2819 (concat
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2820 (propertize "foo" 'face 'italic
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2821 'mouse-face 'bold-italic)
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2822 " and "
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2823 (propertize "bar" 'face 'italic
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2824 'mouse-face 'bold-italic))
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2825 @result{} #("foo and bar"
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2826 0 3 (face italic mouse-face bold-italic)
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2827 3 8 nil
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2828 8 11 (face italic mouse-face bold-italic))
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2829 @end smallexample
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2830 @end defun
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2831
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2832 See also the function @code{buffer-substring-no-properties}
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2833 (@pxref{Buffer Contents}) which copies text from the buffer
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2834 but does not copy its properties.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2835
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2836 @node Property Search
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2837 @subsection Text Property Search Functions
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2838
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2839 In typical use of text properties, most of the time several or many
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2840 consecutive characters have the same value for a property. Rather than
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2841 writing your programs to examine characters one by one, it is much
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2842 faster to process chunks of text that have the same property value.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2843
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2844 Here are functions you can use to do this. They use @code{eq} for
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2845 comparing property values. In all cases, @var{object} defaults to the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2846 current buffer.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2847
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2848 For high performance, it's very important to use the @var{limit}
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2849 argument to these functions, especially the ones that search for a
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2850 single property---otherwise, they may spend a long time scanning to the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2851 end of the buffer, if the property you are interested in does not change.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2852
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2853 These functions do not move point; instead, they return a position (or
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2854 @code{nil}). Remember that a position is always between two characters;
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2855 the position returned by these functions is between two characters with
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2856 different properties.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2857
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2858 @defun next-property-change pos &optional object limit
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2859 The function scans the text forward from position @var{pos} in the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2860 string or buffer @var{object} till it finds a change in some text
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2861 property, then returns the position of the change. In other words, it
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2862 returns the position of the first character beyond @var{pos} whose
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2863 properties are not identical to those of the character just after
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2864 @var{pos}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2865
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2866 If @var{limit} is non-@code{nil}, then the scan ends at position
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2867 @var{limit}. If there is no property change before that point,
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2868 @code{next-property-change} returns @var{limit}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2869
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2870 The value is @code{nil} if the properties remain unchanged all the way
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2871 to the end of @var{object} and @var{limit} is @code{nil}. If the value
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2872 is non-@code{nil}, it is a position greater than or equal to @var{pos}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2873 The value equals @var{pos} only when @var{limit} equals @var{pos}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2874
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2875 Here is an example of how to scan the buffer by chunks of text within
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2876 which all properties are constant:
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2877
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2878 @smallexample
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2879 (while (not (eobp))
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2880 (let ((plist (text-properties-at (point)))
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2881 (next-change
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2882 (or (next-property-change (point) (current-buffer))
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2883 (point-max))))
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2884 @r{Process text from point to @var{next-change}@dots{}}
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2885 (goto-char next-change)))
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2886 @end smallexample
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2887 @end defun
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2888
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2889 @defun previous-property-change pos &optional object limit
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2890 This is like @code{next-property-change}, but scans back from @var{pos}
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2891 instead of forward. If the value is non-@code{nil}, it is a position
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2892 less than or equal to @var{pos}; it equals @var{pos} only if @var{limit}
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2893 equals @var{pos}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2894 @end defun
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2895
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2896 @defun next-single-property-change pos prop &optional object limit
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2897 The function scans text for a change in the @var{prop} property, then
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2898 returns the position of the change. The scan goes forward from
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2899 position @var{pos} in the string or buffer @var{object}. In other
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2900 words, this function returns the position of the first character
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2901 beyond @var{pos} whose @var{prop} property differs from that of the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2902 character just after @var{pos}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2903
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2904 If @var{limit} is non-@code{nil}, then the scan ends at position
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2905 @var{limit}. If there is no property change before that point,
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2906 @code{next-single-property-change} returns @var{limit}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2907
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2908 The value is @code{nil} if the property remains unchanged all the way to
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2909 the end of @var{object} and @var{limit} is @code{nil}. If the value is
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2910 non-@code{nil}, it is a position greater than or equal to @var{pos}; it
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2911 equals @var{pos} only if @var{limit} equals @var{pos}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2912 @end defun
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2913
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2914 @defun previous-single-property-change pos prop &optional object limit
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2915 This is like @code{next-single-property-change}, but scans back from
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2916 @var{pos} instead of forward. If the value is non-@code{nil}, it is a
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2917 position less than or equal to @var{pos}; it equals @var{pos} only if
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2918 @var{limit} equals @var{pos}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2919 @end defun
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2920
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2921 @defun next-char-property-change pos &optional limit
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2922 This is like @code{next-property-change} except that it considers
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2923 overlay properties as well as text properties, and if no change is
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2924 found before the end of the buffer, it returns the maximum buffer
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2925 position rather than @code{nil} (in this sense, it resembles the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2926 corresponding overlay function @code{next-overlay-change}, rather than
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2927 @code{next-property-change}). There is no @var{object} operand
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2928 because this function operates only on the current buffer. It returns
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2929 the next address at which either kind of property changes.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2930 @end defun
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2931
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2932 @defun previous-char-property-change pos &optional limit
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2933 This is like @code{next-char-property-change}, but scans back from
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2934 @var{pos} instead of forward, and returns the minimum buffer
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2935 position if no change is found.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2936 @end defun
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2937
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2938 @defun next-single-char-property-change pos prop &optional object limit
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2939 This is like @code{next-single-property-change} except that it
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2940 considers overlay properties as well as text properties, and if no
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2941 change is found before the end of the @var{object}, it returns the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2942 maximum valid position in @var{object} rather than @code{nil}. Unlike
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2943 @code{next-char-property-change}, this function @emph{does} have an
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2944 @var{object} operand; if @var{object} is not a buffer, only
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2945 text-properties are considered.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2946 @end defun
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2947
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2948 @defun previous-single-char-property-change pos prop &optional object limit
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2949 This is like @code{next-single-char-property-change}, but scans back
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2950 from @var{pos} instead of forward, and returns the minimum valid
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2951 position in @var{object} if no change is found.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2952 @end defun
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2953
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2954 @defun text-property-any start end prop value &optional object
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2955 This function returns non-@code{nil} if at least one character between
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2956 @var{start} and @var{end} has a property @var{prop} whose value is
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2957 @var{value}. More precisely, it returns the position of the first such
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2958 character. Otherwise, it returns @code{nil}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2959
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2960 The optional fifth argument, @var{object}, specifies the string or
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2961 buffer to scan. Positions are relative to @var{object}. The default
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2962 for @var{object} is the current buffer.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2963 @end defun
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2964
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2965 @defun text-property-not-all start end prop value &optional object
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2966 This function returns non-@code{nil} if at least one character between
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2967 @var{start} and @var{end} does not have a property @var{prop} with value
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2968 @var{value}. More precisely, it returns the position of the first such
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2969 character. Otherwise, it returns @code{nil}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2970
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2971 The optional fifth argument, @var{object}, specifies the string or
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2972 buffer to scan. Positions are relative to @var{object}. The default
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2973 for @var{object} is the current buffer.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2974 @end defun
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2975
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2976 @node Special Properties
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2977 @subsection Properties with Special Meanings
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2978
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2979 Here is a table of text property names that have special built-in
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2980 meanings. The following sections list a few additional special property
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2981 names that control filling and property inheritance. All other names
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2982 have no standard meaning, and you can use them as you like.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2983
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2984 Note: the properties @code{composition}, @code{display},
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2985 @code{invisible} and @code{intangible} can also cause point to move to
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2986 an acceptable place, after each Emacs command. @xref{Adjusting
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2987 Point}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2988
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2989 @table @code
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2990 @cindex property category of text character
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2991 @kindex category @r{(text property)}
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2992 @item category
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2993 If a character has a @code{category} property, we call it the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2994 @dfn{property category} of the character. It should be a symbol. The
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2995 properties of this symbol serve as defaults for the properties of the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2996 character.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2997
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2998 @item face
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2999 @cindex face codes of text
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3000 @kindex face @r{(text property)}
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3001 You can use the property @code{face} to control the font and color of
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3002 text. @xref{Faces}, for more information.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3003
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3004 In the simplest case, the value is a face name. It can also be a list;
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3005 then each element can be any of these possibilities;
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3006
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3007 @itemize @bullet
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3008 @item
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3009 A face name (a symbol or string).
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3010
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3011 @item
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3012 A property list of face attributes. This has the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3013 form (@var{keyword} @var{value} @dots{}), where each @var{keyword} is a
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3014 face attribute name and @var{value} is a meaningful value for that
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3015 attribute. With this feature, you do not need to create a face each
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3016 time you want to specify a particular attribute for certain text.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3017 @xref{Face Attributes}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3018
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3019 @item
87649
107ccd98fa12 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85384
diff changeset
3020 A cons cell with the form @code{(foreground-color . @var{color-name})}
107ccd98fa12 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85384
diff changeset
3021 or @code{(background-color . @var{color-name})}. These are older,
107ccd98fa12 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85384
diff changeset
3022 deprecated equivalents for @code{(:foreground @var{color-name})} and
107ccd98fa12 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85384
diff changeset
3023 @code{(:background @var{color-name})}. Please convert code that uses
107ccd98fa12 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85384
diff changeset
3024 them.
84103
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3025 @end itemize
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3026
87649
107ccd98fa12 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85384
diff changeset
3027 It works to use the latter two forms directly as the value
107ccd98fa12 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85384
diff changeset
3028 of the @code{face} property.
107ccd98fa12 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85384
diff changeset
3029
107ccd98fa12 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85384
diff changeset
3030 Font Lock mode (@pxref{Font Lock Mode}) works in most buffers by
107ccd98fa12 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85384
diff changeset
3031 dynamically updating the @code{face} property of characters based on
107ccd98fa12 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85384
diff changeset
3032 the context.
84103
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3033
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3034 @item font-lock-face
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3035 @kindex font-lock-face @r{(text property)}
87649
107ccd98fa12 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85384
diff changeset
3036 The @code{font-lock-face} property is equivalent to the @code{face}
107ccd98fa12 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85384
diff changeset
3037 property when Font Lock mode is enabled. When Font Lock mode is disabled,
107ccd98fa12 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85384
diff changeset
3038 @code{font-lock-face} has no effect.
107ccd98fa12 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85384
diff changeset
3039
107ccd98fa12 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85384
diff changeset
3040 The @code{font-lock-mode} property is useful for special modes that
107ccd98fa12 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85384
diff changeset
3041 implement their own highlighting. @xref{Precalculated Fontification}.
84103
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3042
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3043 @item mouse-face
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3044 @kindex mouse-face @r{(text property)}
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3045 The property @code{mouse-face} is used instead of @code{face} when the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3046 mouse is on or near the character. For this purpose, ``near'' means
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3047 that all text between the character and where the mouse is have the same
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3048 @code{mouse-face} property value.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3049
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3050 @item fontified
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3051 @kindex fontified @r{(text property)}
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3052 This property says whether the text is ready for display. If
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3053 @code{nil}, Emacs's redisplay routine calls the functions in
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3054 @code{fontification-functions} (@pxref{Auto Faces}) to prepare this
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3055 part of the buffer before it is displayed. It is used internally by
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3056 the ``just in time'' font locking code.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3057
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3058 @item display
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3059 This property activates various features that change the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3060 way text is displayed. For example, it can make text appear taller
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3061 or shorter, higher or lower, wider or narrow, or replaced with an image.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3062 @xref{Display Property}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3063
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3064 @item help-echo
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3065 @kindex help-echo @r{(text property)}
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3066 @cindex tooltip
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3067 @anchor{Text help-echo}
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3068 If text has a string as its @code{help-echo} property, then when you
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3069 move the mouse onto that text, Emacs displays that string in the echo
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3070 area, or in the tooltip window (@pxref{Tooltips,,, emacs, The GNU Emacs
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3071 Manual}).
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3072
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3073 If the value of the @code{help-echo} property is a function, that
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3074 function is called with three arguments, @var{window}, @var{object} and
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3075 @var{pos} and should return a help string or @code{nil} for
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3076 none. The first argument, @var{window} is the window in which
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3077 the help was found. The second, @var{object}, is the buffer, overlay or
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3078 string which had the @code{help-echo} property. The @var{pos}
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3079 argument is as follows:
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3080
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3081 @itemize @bullet{}
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3082 @item
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3083 If @var{object} is a buffer, @var{pos} is the position in the buffer.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3084 @item
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3085 If @var{object} is an overlay, that overlay has a @code{help-echo}
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3086 property, and @var{pos} is the position in the overlay's buffer.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3087 @item
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3088 If @var{object} is a string (an overlay string or a string displayed
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3089 with the @code{display} property), @var{pos} is the position in that
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3090 string.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3091 @end itemize
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3092
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3093 If the value of the @code{help-echo} property is neither a function nor
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3094 a string, it is evaluated to obtain a help string.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3095
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3096 You can alter the way help text is displayed by setting the variable
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3097 @code{show-help-function} (@pxref{Help display}).
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3098
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3099 This feature is used in the mode line and for other active text.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3100
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3101 @item keymap
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3102 @cindex keymap of character
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3103 @kindex keymap @r{(text property)}
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3104 The @code{keymap} property specifies an additional keymap for
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3105 commands. When this keymap applies, it is used for key lookup before
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3106 the minor mode keymaps and before the buffer's local map.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3107 @xref{Active Keymaps}. If the property value is a symbol, the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3108 symbol's function definition is used as the keymap.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3109
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3110 The property's value for the character before point applies if it is
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3111 non-@code{nil} and rear-sticky, and the property's value for the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3112 character after point applies if it is non-@code{nil} and
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3113 front-sticky. (For mouse clicks, the position of the click is used
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3114 instead of the position of point.)
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3115
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3116 @item local-map
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3117 @kindex local-map @r{(text property)}
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3118 This property works like @code{keymap} except that it specifies a
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3119 keymap to use @emph{instead of} the buffer's local map. For most
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3120 purposes (perhaps all purposes), it is better to use the @code{keymap}
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3121 property.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3122
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3123 @item syntax-table
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3124 The @code{syntax-table} property overrides what the syntax table says
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3125 about this particular character. @xref{Syntax Properties}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3126
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3127 @item read-only
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3128 @cindex read-only character
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3129 @kindex read-only @r{(text property)}
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3130 If a character has the property @code{read-only}, then modifying that
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3131 character is not allowed. Any command that would do so gets an error,
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3132 @code{text-read-only}. If the property value is a string, that string
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3133 is used as the error message.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3134
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3135 Insertion next to a read-only character is an error if inserting
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3136 ordinary text there would inherit the @code{read-only} property due to
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3137 stickiness. Thus, you can control permission to insert next to
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3138 read-only text by controlling the stickiness. @xref{Sticky Properties}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3139
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3140 Since changing properties counts as modifying the buffer, it is not
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3141 possible to remove a @code{read-only} property unless you know the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3142 special trick: bind @code{inhibit-read-only} to a non-@code{nil} value
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3143 and then remove the property. @xref{Read Only Buffers}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3144
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3145 @item invisible
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3146 @kindex invisible @r{(text property)}
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3147 A non-@code{nil} @code{invisible} property can make a character invisible
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3148 on the screen. @xref{Invisible Text}, for details.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3149
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3150 @item intangible
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3151 @kindex intangible @r{(text property)}
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3152 If a group of consecutive characters have equal and non-@code{nil}
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3153 @code{intangible} properties, then you cannot place point between them.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3154 If you try to move point forward into the group, point actually moves to
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3155 the end of the group. If you try to move point backward into the group,
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3156 point actually moves to the start of the group.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3157
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3158 If consecutive characters have unequal non-@code{nil}
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3159 @code{intangible} properties, they belong to separate groups; each
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3160 group is separately treated as described above.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3161
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3162 When the variable @code{inhibit-point-motion-hooks} is non-@code{nil},
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3163 the @code{intangible} property is ignored.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3164
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3165 @item field
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3166 @kindex field @r{(text property)}
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3167 Consecutive characters with the same @code{field} property constitute a
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3168 @dfn{field}. Some motion functions including @code{forward-word} and
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3169 @code{beginning-of-line} stop moving at a field boundary.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3170 @xref{Fields}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3171
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3172 @item cursor
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3173 @kindex cursor @r{(text property)}
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3174 Normally, the cursor is displayed at the end of any overlay and text
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3175 property strings present at the current window position. You can
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3176 place the cursor on any desired character of these strings by giving
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3177 that character a non-@code{nil} @var{cursor} text property.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3178
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3179 @item pointer
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3180 @kindex pointer @r{(text property)}
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3181 This specifies a specific pointer shape when the mouse pointer is over
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3182 this text or image. @xref{Pointer Shape}, for possible pointer
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3183 shapes.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3184
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3185 @item line-spacing
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3186 @kindex line-spacing @r{(text property)}
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3187 A newline can have a @code{line-spacing} text or overlay property that
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3188 controls the height of the display line ending with that newline. The
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3189 property value overrides the default frame line spacing and the buffer
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3190 local @code{line-spacing} variable. @xref{Line Height}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3191
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3192 @item line-height
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3193 @kindex line-height @r{(text property)}
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3194 A newline can have a @code{line-height} text or overlay property that
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3195 controls the total height of the display line ending in that newline.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3196 @xref{Line Height}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3197
96470
2af6e85f13d5 Implement display-time wrap/line-prefix feature
Miles Bader <miles@gnu.org>
parents: 94331
diff changeset
3198 @item wrap-prefix
2af6e85f13d5 Implement display-time wrap/line-prefix feature
Miles Bader <miles@gnu.org>
parents: 94331
diff changeset
3199 If text has a @code{wrap-prefix} property, the prefix it defines will
2af6e85f13d5 Implement display-time wrap/line-prefix feature
Miles Bader <miles@gnu.org>
parents: 94331
diff changeset
3200 be added at display-time to the beginning of every continuation line
2af6e85f13d5 Implement display-time wrap/line-prefix feature
Miles Bader <miles@gnu.org>
parents: 94331
diff changeset
3201 due to text wrapping (so if lines are truncated, the wrap-prefix is
2af6e85f13d5 Implement display-time wrap/line-prefix feature
Miles Bader <miles@gnu.org>
parents: 94331
diff changeset
3202 never used). It may be a string, an image, or a stretch-glyph such as
2af6e85f13d5 Implement display-time wrap/line-prefix feature
Miles Bader <miles@gnu.org>
parents: 94331
diff changeset
3203 used by the @code{display} text-property. @xref{Display Property}.
2af6e85f13d5 Implement display-time wrap/line-prefix feature
Miles Bader <miles@gnu.org>
parents: 94331
diff changeset
3204
2af6e85f13d5 Implement display-time wrap/line-prefix feature
Miles Bader <miles@gnu.org>
parents: 94331
diff changeset
3205 A wrap-prefix may also be specified for an entire buffer using the
2af6e85f13d5 Implement display-time wrap/line-prefix feature
Miles Bader <miles@gnu.org>
parents: 94331
diff changeset
3206 @code{wrap-prefix} buffer-local variable (however, a
2af6e85f13d5 Implement display-time wrap/line-prefix feature
Miles Bader <miles@gnu.org>
parents: 94331
diff changeset
3207 @code{wrap-prefix} text-property takes precedence over the value of
2af6e85f13d5 Implement display-time wrap/line-prefix feature
Miles Bader <miles@gnu.org>
parents: 94331
diff changeset
3208 the @code{wrap-prefix} variable). @xref{Truncation}.
2af6e85f13d5 Implement display-time wrap/line-prefix feature
Miles Bader <miles@gnu.org>
parents: 94331
diff changeset
3209
2af6e85f13d5 Implement display-time wrap/line-prefix feature
Miles Bader <miles@gnu.org>
parents: 94331
diff changeset
3210 @item line-prefix
2af6e85f13d5 Implement display-time wrap/line-prefix feature
Miles Bader <miles@gnu.org>
parents: 94331
diff changeset
3211 If text has a @code{line-prefix} property, the prefix it defines will
2af6e85f13d5 Implement display-time wrap/line-prefix feature
Miles Bader <miles@gnu.org>
parents: 94331
diff changeset
3212 be added at display-time to the beginning of every non-continuation
2af6e85f13d5 Implement display-time wrap/line-prefix feature
Miles Bader <miles@gnu.org>
parents: 94331
diff changeset
3213 line. It may be a string, an image, or a stretch-glyph such as used
2af6e85f13d5 Implement display-time wrap/line-prefix feature
Miles Bader <miles@gnu.org>
parents: 94331
diff changeset
3214 by the @code{display} text-property. @xref{Display Property}.
2af6e85f13d5 Implement display-time wrap/line-prefix feature
Miles Bader <miles@gnu.org>
parents: 94331
diff changeset
3215
2af6e85f13d5 Implement display-time wrap/line-prefix feature
Miles Bader <miles@gnu.org>
parents: 94331
diff changeset
3216 A line-prefix may also be specified for an entire buffer using the
2af6e85f13d5 Implement display-time wrap/line-prefix feature
Miles Bader <miles@gnu.org>
parents: 94331
diff changeset
3217 @code{line-prefix} buffer-local variable (however, a
2af6e85f13d5 Implement display-time wrap/line-prefix feature
Miles Bader <miles@gnu.org>
parents: 94331
diff changeset
3218 @code{line-prefix} text-property takes precedence over the value of
2af6e85f13d5 Implement display-time wrap/line-prefix feature
Miles Bader <miles@gnu.org>
parents: 94331
diff changeset
3219 the @code{line-prefix} variable). @xref{Truncation}.
2af6e85f13d5 Implement display-time wrap/line-prefix feature
Miles Bader <miles@gnu.org>
parents: 94331
diff changeset
3220
84103
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3221 @item modification-hooks
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3222 @cindex change hooks for a character
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3223 @cindex hooks for changing a character
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3224 @kindex modification-hooks @r{(text property)}
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3225 If a character has the property @code{modification-hooks}, then its
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3226 value should be a list of functions; modifying that character calls all
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3227 of those functions. Each function receives two arguments: the beginning
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3228 and end of the part of the buffer being modified. Note that if a
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3229 particular modification hook function appears on several characters
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3230 being modified by a single primitive, you can't predict how many times
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3231 the function will be called.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3232
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3233 If these functions modify the buffer, they should bind
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3234 @code{inhibit-modification-hooks} to @code{t} around doing so, to
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3235 avoid confusing the internal mechanism that calls these hooks.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3236
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3237 Overlays also support the @code{modification-hooks} property, but the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3238 details are somewhat different (@pxref{Overlay Properties}).
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3239
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3240 @item insert-in-front-hooks
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3241 @itemx insert-behind-hooks
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3242 @kindex insert-in-front-hooks @r{(text property)}
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3243 @kindex insert-behind-hooks @r{(text property)}
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3244 The operation of inserting text in a buffer also calls the functions
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3245 listed in the @code{insert-in-front-hooks} property of the following
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3246 character and in the @code{insert-behind-hooks} property of the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3247 preceding character. These functions receive two arguments, the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3248 beginning and end of the inserted text. The functions are called
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3249 @emph{after} the actual insertion takes place.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3250
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3251 See also @ref{Change Hooks}, for other hooks that are called
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3252 when you change text in a buffer.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3253
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3254 @item point-entered
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3255 @itemx point-left
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3256 @cindex hooks for motion of point
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3257 @kindex point-entered @r{(text property)}
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3258 @kindex point-left @r{(text property)}
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3259 The special properties @code{point-entered} and @code{point-left}
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3260 record hook functions that report motion of point. Each time point
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3261 moves, Emacs compares these two property values:
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3262
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3263 @itemize @bullet
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3264 @item
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3265 the @code{point-left} property of the character after the old location,
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3266 and
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3267 @item
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3268 the @code{point-entered} property of the character after the new
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3269 location.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3270 @end itemize
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3271
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3272 @noindent
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3273 If these two values differ, each of them is called (if not @code{nil})
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3274 with two arguments: the old value of point, and the new one.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3275
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3276 The same comparison is made for the characters before the old and new
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3277 locations. The result may be to execute two @code{point-left} functions
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3278 (which may be the same function) and/or two @code{point-entered}
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3279 functions (which may be the same function). In any case, all the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3280 @code{point-left} functions are called first, followed by all the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3281 @code{point-entered} functions.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3282
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3283 It is possible with @code{char-after} to examine characters at various
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3284 buffer positions without moving point to those positions. Only an
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3285 actual change in the value of point runs these hook functions.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3286
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3287 @defvar inhibit-point-motion-hooks
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3288 When this variable is non-@code{nil}, @code{point-left} and
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3289 @code{point-entered} hooks are not run, and the @code{intangible}
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3290 property has no effect. Do not set this variable globally; bind it with
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3291 @code{let}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3292 @end defvar
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3293
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3294 @defvar show-help-function
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3295 @anchor{Help display} If this variable is non-@code{nil}, it specifies a
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3296 function called to display help strings. These may be @code{help-echo}
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3297 properties, menu help strings (@pxref{Simple Menu Items},
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3298 @pxref{Extended Menu Items}), or tool bar help strings (@pxref{Tool
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3299 Bar}). The specified function is called with one argument, the help
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3300 string to display. Tooltip mode (@pxref{Tooltips,,, emacs, The GNU Emacs
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3301 Manual}) provides an example.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3302 @end defvar
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3303
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3304 @item composition
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3305 @kindex composition @r{(text property)}
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3306 This text property is used to display a sequence of characters as a
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3307 single glyph composed from components. But the value of the property
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3308 itself is completely internal to Emacs and should not be manipulated
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3309 directly by, for instance, @code{put-text-property}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3310
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3311 @end table
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3312
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3313 @node Format Properties
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3314 @subsection Formatted Text Properties
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3315
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3316 These text properties affect the behavior of the fill commands. They
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3317 are used for representing formatted text. @xref{Filling}, and
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3318 @ref{Margins}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3319
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3320 @table @code
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3321 @item hard
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3322 If a newline character has this property, it is a ``hard'' newline.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3323 The fill commands do not alter hard newlines and do not move words
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3324 across them. However, this property takes effect only if the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3325 @code{use-hard-newlines} minor mode is enabled. @xref{Hard and Soft
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3326 Newlines,, Hard and Soft Newlines, emacs, The GNU Emacs Manual}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3327
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3328 @item right-margin
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3329 This property specifies an extra right margin for filling this part of the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3330 text.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3331
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3332 @item left-margin
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3333 This property specifies an extra left margin for filling this part of the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3334 text.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3335
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3336 @item justification
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3337 This property specifies the style of justification for filling this part
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3338 of the text.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3339 @end table
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3340
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3341 @node Sticky Properties
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3342 @subsection Stickiness of Text Properties
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3343 @cindex sticky text properties
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3344 @cindex inheritance of text properties
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3345
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3346 Self-inserting characters normally take on the same properties as the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3347 preceding character. This is called @dfn{inheritance} of properties.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3348
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3349 In a Lisp program, you can do insertion with inheritance or without,
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3350 depending on your choice of insertion primitive. The ordinary text
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3351 insertion functions such as @code{insert} do not inherit any properties.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3352 They insert text with precisely the properties of the string being
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3353 inserted, and no others. This is correct for programs that copy text
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3354 from one context to another---for example, into or out of the kill ring.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3355 To insert with inheritance, use the special primitives described in this
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3356 section. Self-inserting characters inherit properties because they work
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3357 using these primitives.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3358
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3359 When you do insertion with inheritance, @emph{which} properties are
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3360 inherited, and from where, depends on which properties are @dfn{sticky}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3361 Insertion after a character inherits those of its properties that are
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3362 @dfn{rear-sticky}. Insertion before a character inherits those of its
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3363 properties that are @dfn{front-sticky}. When both sides offer different
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3364 sticky values for the same property, the previous character's value
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3365 takes precedence.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3366
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3367 By default, a text property is rear-sticky but not front-sticky; thus,
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3368 the default is to inherit all the properties of the preceding character,
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3369 and nothing from the following character.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3370
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3371 You can control the stickiness of various text properties with two
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3372 specific text properties, @code{front-sticky} and @code{rear-nonsticky},
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3373 and with the variable @code{text-property-default-nonsticky}. You can
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3374 use the variable to specify a different default for a given property.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3375 You can use those two text properties to make any specific properties
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3376 sticky or nonsticky in any particular part of the text.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3377
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3378 If a character's @code{front-sticky} property is @code{t}, then all
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3379 its properties are front-sticky. If the @code{front-sticky} property is
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3380 a list, then the sticky properties of the character are those whose
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3381 names are in the list. For example, if a character has a
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3382 @code{front-sticky} property whose value is @code{(face read-only)},
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3383 then insertion before the character can inherit its @code{face} property
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3384 and its @code{read-only} property, but no others.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3385
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3386 The @code{rear-nonsticky} property works the opposite way. Most
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3387 properties are rear-sticky by default, so the @code{rear-nonsticky}
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3388 property says which properties are @emph{not} rear-sticky. If a
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3389 character's @code{rear-nonsticky} property is @code{t}, then none of its
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3390 properties are rear-sticky. If the @code{rear-nonsticky} property is a
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3391 list, properties are rear-sticky @emph{unless} their names are in the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3392 list.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3393
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3394 @defvar text-property-default-nonsticky
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3395 This variable holds an alist which defines the default rear-stickiness
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3396 of various text properties. Each element has the form
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3397 @code{(@var{property} . @var{nonstickiness})}, and it defines the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3398 stickiness of a particular text property, @var{property}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3399
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3400 If @var{nonstickiness} is non-@code{nil}, this means that the property
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3401 @var{property} is rear-nonsticky by default. Since all properties are
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3402 front-nonsticky by default, this makes @var{property} nonsticky in both
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3403 directions by default.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3404
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3405 The text properties @code{front-sticky} and @code{rear-nonsticky}, when
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3406 used, take precedence over the default @var{nonstickiness} specified in
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3407 @code{text-property-default-nonsticky}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3408 @end defvar
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3409
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3410 Here are the functions that insert text with inheritance of properties:
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3411
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3412 @defun insert-and-inherit &rest strings
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3413 Insert the strings @var{strings}, just like the function @code{insert},
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3414 but inherit any sticky properties from the adjoining text.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3415 @end defun
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3416
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3417 @defun insert-before-markers-and-inherit &rest strings
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3418 Insert the strings @var{strings}, just like the function
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3419 @code{insert-before-markers}, but inherit any sticky properties from the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3420 adjoining text.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3421 @end defun
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3422
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3423 @xref{Insertion}, for the ordinary insertion functions which do not
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3424 inherit.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3425
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3426 @node Lazy Properties
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3427 @subsection Lazy Computation of Text Properties
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3428
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3429 Instead of computing text properties for all the text in the buffer,
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3430 you can arrange to compute the text properties for parts of the text
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3431 when and if something depends on them.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3432
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3433 The primitive that extracts text from the buffer along with its
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3434 properties is @code{buffer-substring}. Before examining the properties,
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3435 this function runs the abnormal hook @code{buffer-access-fontify-functions}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3436
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3437 @defvar buffer-access-fontify-functions
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3438 This variable holds a list of functions for computing text properties.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3439 Before @code{buffer-substring} copies the text and text properties for a
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3440 portion of the buffer, it calls all the functions in this list. Each of
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3441 the functions receives two arguments that specify the range of the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3442 buffer being accessed. (The buffer itself is always the current
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3443 buffer.)
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3444 @end defvar
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3445
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3446 The function @code{buffer-substring-no-properties} does not call these
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3447 functions, since it ignores text properties anyway.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3448
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3449 In order to prevent the hook functions from being called more than
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3450 once for the same part of the buffer, you can use the variable
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3451 @code{buffer-access-fontified-property}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3452
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3453 @defvar buffer-access-fontified-property
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3454 If this variable's value is non-@code{nil}, it is a symbol which is used
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3455 as a text property name. A non-@code{nil} value for that text property
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3456 means, ``the other text properties for this character have already been
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3457 computed.''
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3458
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3459 If all the characters in the range specified for @code{buffer-substring}
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3460 have a non-@code{nil} value for this property, @code{buffer-substring}
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3461 does not call the @code{buffer-access-fontify-functions} functions. It
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3462 assumes these characters already have the right text properties, and
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3463 just copies the properties they already have.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3464
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3465 The normal way to use this feature is that the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3466 @code{buffer-access-fontify-functions} functions add this property, as
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3467 well as others, to the characters they operate on. That way, they avoid
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3468 being called over and over for the same text.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3469 @end defvar
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3470
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3471 @node Clickable Text
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3472 @subsection Defining Clickable Text
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3473 @cindex clickable text
102893
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 101863
diff changeset
3474 @cindex follow links
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 101863
diff changeset
3475 @cindex mouse-1
84103
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3476
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3477 @dfn{Clickable text} is text that can be clicked, with either the
102893
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 101863
diff changeset
3478 mouse or via a keyboard command, to produce some result. Many major
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 101863
diff changeset
3479 modes use clickable text to implement textual hyper-links, or
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 101863
diff changeset
3480 @dfn{links} for short.
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 101863
diff changeset
3481
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 101863
diff changeset
3482 The easiest way to insert and manipulate links is to use the
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 101863
diff changeset
3483 @code{button} package. @xref{Buttons}. In this section, we will
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 101863
diff changeset
3484 explain how to manually set up clickable text in a buffer, using text
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 101863
diff changeset
3485 properties. For simplicity, we will refer to the clickable text as a
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 101863
diff changeset
3486 @dfn{link}.
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 101863
diff changeset
3487
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 101863
diff changeset
3488 Implementing a link involves three separate steps: (1) indicating
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 101863
diff changeset
3489 clickability when the mouse moves over the link; (2) making @kbd{RET}
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 101863
diff changeset
3490 or @kbd{Mouse-2} on that link do something; and (3) setting up a
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 101863
diff changeset
3491 @code{follow-link} condition so that the link obeys
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 101863
diff changeset
3492 @code{mouse-1-click-follows-link}.
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 101863
diff changeset
3493
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 101863
diff changeset
3494 To indicate clickability, add the @code{mouse-face} text property to
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 101863
diff changeset
3495 the text of the link; then Emacs will highlight the link when the
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 101863
diff changeset
3496 mouse moves over it. In addition, you should define a tooltip or echo
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 101863
diff changeset
3497 area message, using the @code{help-echo} text property. @xref{Special
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 101863
diff changeset
3498 Properties}. For instance, here is how Dired indicates that file
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 101863
diff changeset
3499 names are clickable:
84103
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3500
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3501 @smallexample
102893
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 101863
diff changeset
3502 (if (dired-move-to-filename)
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 101863
diff changeset
3503 (add-text-properties
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 101863
diff changeset
3504 (point)
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 101863
diff changeset
3505 (save-excursion
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 101863
diff changeset
3506 (dired-move-to-end-of-filename)
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 101863
diff changeset
3507 (point))
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 101863
diff changeset
3508 '(mouse-face highlight
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 101863
diff changeset
3509 help-echo "mouse-2: visit this file in other window")))
84103
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3510 @end smallexample
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3511
102893
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 101863
diff changeset
3512 To make the link clickable, bind @key{RET} and @kbd{Mouse-2} to
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 101863
diff changeset
3513 commands that perform the desired action. Each command should check
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 101863
diff changeset
3514 to see whether it was called on a link, and act accordingly. For
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 101863
diff changeset
3515 instance, Dired's major mode keymap binds @kbd{Mouse-2} to the
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 101863
diff changeset
3516 following command:
84103
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3517
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3518 @smallexample
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3519 (defun dired-mouse-find-file-other-window (event)
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3520 "In Dired, visit the file or directory name you click on."
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3521 (interactive "e")
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3522 (let (window pos file)
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3523 (save-excursion
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3524 (setq window (posn-window (event-end event))
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3525 pos (posn-point (event-end event)))
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3526 (if (not (windowp window))
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3527 (error "No file chosen"))
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3528 (set-buffer (window-buffer window))
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3529 (goto-char pos)
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3530 (setq file (dired-get-file-for-visit)))
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3531 (if (file-directory-p file)
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3532 (or (and (cdr dired-subdir-alist)
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3533 (dired-goto-subdir file))
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3534 (progn
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3535 (select-window window)
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3536 (dired-other-window file)))
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3537 (select-window window)
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3538 (find-file-other-window (file-name-sans-versions file t)))))
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3539 @end smallexample
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3540
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3541 @noindent
102893
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 101863
diff changeset
3542 This command uses the functions @code{posn-window} and
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 101863
diff changeset
3543 @code{posn-point} to determine where the click occurred, and
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 101863
diff changeset
3544 @code{dired-get-file-for-visit} to determine which file to visit.
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 101863
diff changeset
3545
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 101863
diff changeset
3546 Instead of binding the mouse command in a major mode keymap, you can
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 101863
diff changeset
3547 bind it within the link text, using the @code{keymap} text property
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 101863
diff changeset
3548 (@pxref{Special Properties}). For instance:
84103
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3549
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3550 @example
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3551 (let ((map (make-sparse-keymap)))
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3552 (define-key map [mouse-2] 'operate-this-button)
102893
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 101863
diff changeset
3553 (put-text-property link-start link-end 'keymap map))
84103
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3554 @end example
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3555
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3556 @noindent
102893
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 101863
diff changeset
3557 With this method, you can easily define different commands for
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 101863
diff changeset
3558 different links. Furthermore, the global definition of @key{RET} and
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 101863
diff changeset
3559 @kbd{Mouse-2} remain available for the rest of the text in the buffer.
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 101863
diff changeset
3560
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 101863
diff changeset
3561 @vindex mouse-1-click-follows-link
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 101863
diff changeset
3562 The basic Emacs command for clicking on links is @kbd{Mouse-2}.
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 101863
diff changeset
3563 However, for compatibility with other graphical applications, Emacs
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 101863
diff changeset
3564 also recognizes @kbd{Mouse-1} clicks on links, provided the user
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 101863
diff changeset
3565 clicks on the link quickly without moving the mouse. This behavior is
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 101863
diff changeset
3566 controlled by the user option @code{mouse-1-click-follows-link}.
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 101863
diff changeset
3567 @xref{Mouse References,,, emacs, The GNU Emacs Manual}.
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 101863
diff changeset
3568
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 101863
diff changeset
3569 To set up the link so that it obeys
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 101863
diff changeset
3570 @code{mouse-1-click-follows-link}, you must either (1) apply a
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 101863
diff changeset
3571 @code{follow-link} text or overlay property to the link text, or (2)
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 101863
diff changeset
3572 bind the @code{follow-link} event to a keymap (which can be a major
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 101863
diff changeset
3573 mode keymap or a local keymap specified via the @code{keymap} text
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 101863
diff changeset
3574 property). The value of the @code{follow-link} property, or the
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 101863
diff changeset
3575 binding for the @code{follow-link} event, acts as a ``condition'' for
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 101863
diff changeset
3576 the link action. This condition tells Emacs two things: the
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 101863
diff changeset
3577 circumstances under which a @kbd{Mouse-1} click should be regarded as
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 101863
diff changeset
3578 occurring ``inside'' the link, and how to compute an ``action code''
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 101863
diff changeset
3579 that says what to translate the @kbd{Mouse-1} click into. The link
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 101863
diff changeset
3580 action condition can be one of the following:
84103
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3581
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3582 @table @asis
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3583 @item @code{mouse-face}
102893
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 101863
diff changeset
3584 If the condition is the symbol @code{mouse-face}, a position is inside
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 101863
diff changeset
3585 a link if there is a non-@code{nil} @code{mouse-face} property at that
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 101863
diff changeset
3586 position. The action code is always @code{t}.
84103
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3587
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3588 For example, here is how Info mode handles @key{Mouse-1}:
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3589
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3590 @smallexample
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3591 (define-key Info-mode-map [follow-link] 'mouse-face)
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3592 @end smallexample
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3593
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3594 @item a function
102893
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 101863
diff changeset
3595 If the condition is a function, @var{func}, then a position @var{pos}
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 101863
diff changeset
3596 is inside a link if @code{(@var{func} @var{pos})} evaluates to
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 101863
diff changeset
3597 non-@code{nil}. The value returned by @var{func} serves as the action
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 101863
diff changeset
3598 code.
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 101863
diff changeset
3599
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 101863
diff changeset
3600 For example, here is how pcvs enables @kbd{Mouse-1} to follow links on
84103
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3601 file names only:
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3602
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3603 @smallexample
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3604 (define-key map [follow-link]
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3605 (lambda (pos)
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3606 (eq (get-char-property pos 'face) 'cvs-filename-face)))
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3607 @end smallexample
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3608
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3609 @item anything else
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3610 If the condition value is anything else, then the position is inside a
102893
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 101863
diff changeset
3611 link and the condition itself is the action code. Clearly, you should
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 101863
diff changeset
3612 specify this kind of condition only when applying the condition via a
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 101863
diff changeset
3613 text or property overlay on the link text (so that it does not apply
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 101863
diff changeset
3614 to the entire buffer).
84103
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3615 @end table
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3616
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3617 @noindent
102893
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 101863
diff changeset
3618 The action code tells @kbd{Mouse-1} how to follow the link:
84103
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3619
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3620 @table @asis
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3621 @item a string or vector
102893
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 101863
diff changeset
3622 If the action code is a string or vector, the @kbd{Mouse-1} event is
84103
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3623 translated into the first element of the string or vector; i.e., the
102893
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 101863
diff changeset
3624 action of the @kbd{Mouse-1} click is the local or global binding of
84103
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3625 that character or symbol. Thus, if the action code is @code{"foo"},
102893
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 101863
diff changeset
3626 @kbd{Mouse-1} translates into @kbd{f}. If it is @code{[foo]},
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 101863
diff changeset
3627 @kbd{Mouse-1} translates into @key{foo}.
84103
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3628
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3629 @item anything else
102893
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 101863
diff changeset
3630 For any other non-@code{nil} action code, the @kbd{Mouse-1} event is
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 101863
diff changeset
3631 translated into a @kbd{Mouse-2} event at the same position.
84103
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3632 @end table
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3633
102893
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 101863
diff changeset
3634 To define @kbd{Mouse-1} to activate a button defined with
84103
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3635 @code{define-button-type}, give the button a @code{follow-link}
102893
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 101863
diff changeset
3636 property. The property value should be a link action condition, as
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 101863
diff changeset
3637 described above. @xref{Buttons}. For example, here is how Help mode
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 101863
diff changeset
3638 handles @kbd{Mouse-1}:
84103
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3639
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3640 @smallexample
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3641 (define-button-type 'help-xref
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3642 'follow-link t
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3643 'action #'help-button-action)
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3644 @end smallexample
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3645
102893
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 101863
diff changeset
3646 To define @kbd{Mouse-1} on a widget defined with
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 101863
diff changeset
3647 @code{define-widget}, give the widget a @code{:follow-link} property.
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 101863
diff changeset
3648 The property value should be a link action condition, as described
97aebffaf765 * text.texi (Yank Commands): Note that yank uses push-mark.
Chong Yidong <cyd@stupidchicken.com>
parents: 101863
diff changeset
3649 above. For example, here is how the @code{link} widget specifies that
84103
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3650 a @key{Mouse-1} click shall be translated to @key{RET}:
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3651
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3652 @smallexample
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3653 (define-widget 'link 'item
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3654 "An embedded link."
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3655 :button-prefix 'widget-link-prefix
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3656 :button-suffix 'widget-link-suffix
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3657 :follow-link "\C-m"
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3658 :help-echo "Follow the link."
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3659 :format "%[%t%]")
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3660 @end smallexample
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3661
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3662 @defun mouse-on-link-p pos
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3663 This function returns non-@code{nil} if position @var{pos} in the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3664 current buffer is on a link. @var{pos} can also be a mouse event
87649
107ccd98fa12 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85384
diff changeset
3665 location, as returned by @code{event-start} (@pxref{Accessing Mouse}).
84103
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3666 @end defun
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3667
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3668 @node Fields
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3669 @subsection Defining and Using Fields
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3670 @cindex fields
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3671
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3672 A field is a range of consecutive characters in the buffer that are
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3673 identified by having the same value (comparing with @code{eq}) of the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3674 @code{field} property (either a text-property or an overlay property).
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3675 This section describes special functions that are available for
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3676 operating on fields.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3677
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3678 You specify a field with a buffer position, @var{pos}. We think of
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3679 each field as containing a range of buffer positions, so the position
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3680 you specify stands for the field containing that position.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3681
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3682 When the characters before and after @var{pos} are part of the same
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3683 field, there is no doubt which field contains @var{pos}: the one those
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3684 characters both belong to. When @var{pos} is at a boundary between
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3685 fields, which field it belongs to depends on the stickiness of the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3686 @code{field} properties of the two surrounding characters (@pxref{Sticky
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3687 Properties}). The field whose property would be inherited by text
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3688 inserted at @var{pos} is the field that contains @var{pos}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3689
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3690 There is an anomalous case where newly inserted text at @var{pos}
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3691 would not inherit the @code{field} property from either side. This
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3692 happens if the previous character's @code{field} property is not
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3693 rear-sticky, and the following character's @code{field} property is not
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3694 front-sticky. In this case, @var{pos} belongs to neither the preceding
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3695 field nor the following field; the field functions treat it as belonging
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3696 to an empty field whose beginning and end are both at @var{pos}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3697
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3698 In all of these functions, if @var{pos} is omitted or @code{nil}, the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3699 value of point is used by default. If narrowing is in effect, then
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3700 @var{pos} should fall within the accessible portion. @xref{Narrowing}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3701
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3702 @defun field-beginning &optional pos escape-from-edge limit
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3703 This function returns the beginning of the field specified by @var{pos}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3704
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3705 If @var{pos} is at the beginning of its field, and
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3706 @var{escape-from-edge} is non-@code{nil}, then the return value is
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3707 always the beginning of the preceding field that @emph{ends} at @var{pos},
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3708 regardless of the stickiness of the @code{field} properties around
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3709 @var{pos}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3710
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3711 If @var{limit} is non-@code{nil}, it is a buffer position; if the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3712 beginning of the field is before @var{limit}, then @var{limit} will be
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3713 returned instead.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3714 @end defun
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3715
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3716 @defun field-end &optional pos escape-from-edge limit
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3717 This function returns the end of the field specified by @var{pos}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3718
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3719 If @var{pos} is at the end of its field, and @var{escape-from-edge} is
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3720 non-@code{nil}, then the return value is always the end of the following
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3721 field that @emph{begins} at @var{pos}, regardless of the stickiness of
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3722 the @code{field} properties around @var{pos}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3723
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3724 If @var{limit} is non-@code{nil}, it is a buffer position; if the end
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3725 of the field is after @var{limit}, then @var{limit} will be returned
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3726 instead.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3727 @end defun
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3728
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3729 @defun field-string &optional pos
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3730 This function returns the contents of the field specified by @var{pos},
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3731 as a string.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3732 @end defun
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3733
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3734 @defun field-string-no-properties &optional pos
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3735 This function returns the contents of the field specified by @var{pos},
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3736 as a string, discarding text properties.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3737 @end defun
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3738
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3739 @defun delete-field &optional pos
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3740 This function deletes the text of the field specified by @var{pos}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3741 @end defun
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3742
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3743 @defun constrain-to-field new-pos old-pos &optional escape-from-edge only-in-line inhibit-capture-property
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3744 This function ``constrains'' @var{new-pos} to the field that
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3745 @var{old-pos} belongs to---in other words, it returns the position
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3746 closest to @var{new-pos} that is in the same field as @var{old-pos}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3747
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3748 If @var{new-pos} is @code{nil}, then @code{constrain-to-field} uses
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3749 the value of point instead, and moves point to the resulting position
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3750 as well as returning it.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3751
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3752 If @var{old-pos} is at the boundary of two fields, then the acceptable
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3753 final positions depend on the argument @var{escape-from-edge}. If
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3754 @var{escape-from-edge} is @code{nil}, then @var{new-pos} must be in
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3755 the field whose @code{field} property equals what new characters
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3756 inserted at @var{old-pos} would inherit. (This depends on the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3757 stickiness of the @code{field} property for the characters before and
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3758 after @var{old-pos}.) If @var{escape-from-edge} is non-@code{nil},
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3759 @var{new-pos} can be anywhere in the two adjacent fields.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3760 Additionally, if two fields are separated by another field with the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3761 special value @code{boundary}, then any point within this special
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3762 field is also considered to be ``on the boundary.''
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3763
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3764 Commands like @kbd{C-a} with no argumemt, that normally move backward
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3765 to a specific kind of location and stay there once there, probably
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3766 should specify @code{nil} for @var{escape-from-edge}. Other motion
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3767 commands that check fields should probably pass @code{t}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3768
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3769 If the optional argument @var{only-in-line} is non-@code{nil}, and
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3770 constraining @var{new-pos} in the usual way would move it to a different
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3771 line, @var{new-pos} is returned unconstrained. This used in commands
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3772 that move by line, such as @code{next-line} and
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3773 @code{beginning-of-line}, so that they respect field boundaries only in
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3774 the case where they can still move to the right line.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3775
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3776 If the optional argument @var{inhibit-capture-property} is
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3777 non-@code{nil}, and @var{old-pos} has a non-@code{nil} property of that
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3778 name, then any field boundaries are ignored.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3779
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3780 You can cause @code{constrain-to-field} to ignore all field boundaries
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3781 (and so never constrain anything) by binding the variable
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3782 @code{inhibit-field-text-motion} to a non-@code{nil} value.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3783 @end defun
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3784
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3785 @node Not Intervals
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3786 @subsection Why Text Properties are not Intervals
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3787 @cindex intervals
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3788
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3789 Some editors that support adding attributes to text in the buffer do
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3790 so by letting the user specify ``intervals'' within the text, and adding
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3791 the properties to the intervals. Those editors permit the user or the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3792 programmer to determine where individual intervals start and end. We
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3793 deliberately provided a different sort of interface in Emacs Lisp to
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3794 avoid certain paradoxical behavior associated with text modification.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3795
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3796 If the actual subdivision into intervals is meaningful, that means you
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3797 can distinguish between a buffer that is just one interval with a
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3798 certain property, and a buffer containing the same text subdivided into
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3799 two intervals, both of which have that property.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3800
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3801 Suppose you take the buffer with just one interval and kill part of
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3802 the text. The text remaining in the buffer is one interval, and the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3803 copy in the kill ring (and the undo list) becomes a separate interval.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3804 Then if you yank back the killed text, you get two intervals with the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3805 same properties. Thus, editing does not preserve the distinction
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3806 between one interval and two.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3807
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3808 Suppose we ``fix'' this problem by coalescing the two intervals when
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3809 the text is inserted. That works fine if the buffer originally was a
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3810 single interval. But suppose instead that we have two adjacent
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3811 intervals with the same properties, and we kill the text of one interval
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3812 and yank it back. The same interval-coalescence feature that rescues
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3813 the other case causes trouble in this one: after yanking, we have just
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3814 one interval. One again, editing does not preserve the distinction
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3815 between one interval and two.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3816
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3817 Insertion of text at the border between intervals also raises
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3818 questions that have no satisfactory answer.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3819
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3820 However, it is easy to arrange for editing to behave consistently for
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3821 questions of the form, ``What are the properties of this character?''
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3822 So we have decided these are the only questions that make sense; we have
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3823 not implemented asking questions about where intervals start or end.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3824
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3825 In practice, you can usually use the text property search functions in
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3826 place of explicit interval boundaries. You can think of them as finding
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3827 the boundaries of intervals, assuming that intervals are always
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3828 coalesced whenever possible. @xref{Property Search}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3829
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3830 Emacs also provides explicit intervals as a presentation feature; see
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3831 @ref{Overlays}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3832
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3833 @node Substitution
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3834 @section Substituting for a Character Code
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3835
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3836 The following functions replace characters within a specified region
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3837 based on their character codes.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3838
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3839 @defun subst-char-in-region start end old-char new-char &optional noundo
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3840 @cindex replace characters
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3841 This function replaces all occurrences of the character @var{old-char}
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3842 with the character @var{new-char} in the region of the current buffer
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3843 defined by @var{start} and @var{end}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3844
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3845 @cindex undo avoidance
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3846 If @var{noundo} is non-@code{nil}, then @code{subst-char-in-region} does
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3847 not record the change for undo and does not mark the buffer as modified.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3848 This was useful for controlling the old selective display feature
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3849 (@pxref{Selective Display}).
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3850
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3851 @code{subst-char-in-region} does not move point and returns
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3852 @code{nil}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3853
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3854 @example
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3855 @group
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3856 ---------- Buffer: foo ----------
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3857 This is the contents of the buffer before.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3858 ---------- Buffer: foo ----------
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3859 @end group
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3860
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3861 @group
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3862 (subst-char-in-region 1 20 ?i ?X)
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3863 @result{} nil
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3864
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3865 ---------- Buffer: foo ----------
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3866 ThXs Xs the contents of the buffer before.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3867 ---------- Buffer: foo ----------
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3868 @end group
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3869 @end example
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3870 @end defun
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3871
103264
b269cabac20c * syntax.texi (Position Parse): Document rationale for ignored
Chong Yidong <cyd@stupidchicken.com>
parents: 102893
diff changeset
3872 @deffn Command translate-region start end table
84103
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3873 This function applies a translation table to the characters in the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3874 buffer between positions @var{start} and @var{end}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3875
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3876 The translation table @var{table} is a string or a char-table;
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3877 @code{(aref @var{table} @var{ochar})} gives the translated character
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3878 corresponding to @var{ochar}. If @var{table} is a string, any
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3879 characters with codes larger than the length of @var{table} are not
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3880 altered by the translation.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3881
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3882 The return value of @code{translate-region} is the number of
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3883 characters that were actually changed by the translation. This does
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3884 not count characters that were mapped into themselves in the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3885 translation table.
103264
b269cabac20c * syntax.texi (Position Parse): Document rationale for ignored
Chong Yidong <cyd@stupidchicken.com>
parents: 102893
diff changeset
3886 @end deffn
84103
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3887
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3888 @node Registers
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3889 @section Registers
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3890 @cindex registers
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3891
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3892 A register is a sort of variable used in Emacs editing that can hold a
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3893 variety of different kinds of values. Each register is named by a
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3894 single character. All @acronym{ASCII} characters and their meta variants
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3895 (but with the exception of @kbd{C-g}) can be used to name registers.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3896 Thus, there are 255 possible registers. A register is designated in
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3897 Emacs Lisp by the character that is its name.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3898
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3899 @defvar register-alist
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3900 This variable is an alist of elements of the form @code{(@var{name} .
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3901 @var{contents})}. Normally, there is one element for each Emacs
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3902 register that has been used.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3903
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3904 The object @var{name} is a character (an integer) identifying the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3905 register.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3906 @end defvar
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3907
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3908 The @var{contents} of a register can have several possible types:
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3909
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3910 @table @asis
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3911 @item a number
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3912 A number stands for itself. If @code{insert-register} finds a number
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3913 in the register, it converts the number to decimal.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3914
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3915 @item a marker
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3916 A marker represents a buffer position to jump to.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3917
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3918 @item a string
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3919 A string is text saved in the register.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3920
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3921 @item a rectangle
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3922 A rectangle is represented by a list of strings.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3923
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3924 @item @code{(@var{window-configuration} @var{position})}
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3925 This represents a window configuration to restore in one frame, and a
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3926 position to jump to in the current buffer.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3927
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3928 @item @code{(@var{frame-configuration} @var{position})}
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3929 This represents a frame configuration to restore, and a position
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3930 to jump to in the current buffer.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3931
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3932 @item (file @var{filename})
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3933 This represents a file to visit; jumping to this value visits file
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3934 @var{filename}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3935
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3936 @item (file-query @var{filename} @var{position})
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3937 This represents a file to visit and a position in it; jumping to this
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3938 value visits file @var{filename} and goes to buffer position
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3939 @var{position}. Restoring this type of position asks the user for
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3940 confirmation first.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3941 @end table
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3942
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3943 The functions in this section return unpredictable values unless
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3944 otherwise stated.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3945
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3946 @defun get-register reg
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3947 This function returns the contents of the register
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3948 @var{reg}, or @code{nil} if it has no contents.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3949 @end defun
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3950
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3951 @defun set-register reg value
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3952 This function sets the contents of register @var{reg} to @var{value}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3953 A register can be set to any value, but the other register functions
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3954 expect only certain data types. The return value is @var{value}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3955 @end defun
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3956
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3957 @deffn Command view-register reg
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3958 This command displays what is contained in register @var{reg}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3959 @end deffn
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3960
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3961 @deffn Command insert-register reg &optional beforep
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3962 This command inserts contents of register @var{reg} into the current
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3963 buffer.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3964
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3965 Normally, this command puts point before the inserted text, and the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3966 mark after it. However, if the optional second argument @var{beforep}
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3967 is non-@code{nil}, it puts the mark before and point after.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3968 You can pass a non-@code{nil} second argument @var{beforep} to this
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3969 function interactively by supplying any prefix argument.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3970
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3971 If the register contains a rectangle, then the rectangle is inserted
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3972 with its upper left corner at point. This means that text is inserted
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3973 in the current line and underneath it on successive lines.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3974
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3975 If the register contains something other than saved text (a string) or
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3976 a rectangle (a list), currently useless things happen. This may be
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3977 changed in the future.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3978 @end deffn
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3979
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3980 @node Transposition
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3981 @section Transposition of Text
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3982
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3983 This subroutine is used by the transposition commands.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3984
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3985 @defun transpose-regions start1 end1 start2 end2 &optional leave-markers
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3986 This function exchanges two nonoverlapping portions of the buffer.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3987 Arguments @var{start1} and @var{end1} specify the bounds of one portion
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3988 and arguments @var{start2} and @var{end2} specify the bounds of the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3989 other portion.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3990
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3991 Normally, @code{transpose-regions} relocates markers with the transposed
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3992 text; a marker previously positioned within one of the two transposed
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3993 portions moves along with that portion, thus remaining between the same
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3994 two characters in their new position. However, if @var{leave-markers}
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3995 is non-@code{nil}, @code{transpose-regions} does not do this---it leaves
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3996 all markers unrelocated.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3997 @end defun
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3998
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3999 @node Base 64
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4000 @section Base 64 Encoding
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4001 @cindex base 64 encoding
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4002
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4003 Base 64 code is used in email to encode a sequence of 8-bit bytes as
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4004 a longer sequence of @acronym{ASCII} graphic characters. It is defined in
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4005 Internet RFC@footnote{
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4006 An RFC, an acronym for @dfn{Request for Comments}, is a numbered
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4007 Internet informational document describing a standard. RFCs are
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4008 usually written by technical experts acting on their own initiative,
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4009 and are traditionally written in a pragmatic, experience-driven
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4010 manner.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4011 }2045. This section describes the functions for
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4012 converting to and from this code.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4013
103264
b269cabac20c * syntax.texi (Position Parse): Document rationale for ignored
Chong Yidong <cyd@stupidchicken.com>
parents: 102893
diff changeset
4014 @deffn Command base64-encode-region beg end &optional no-line-break
84103
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4015 This function converts the region from @var{beg} to @var{end} into base
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4016 64 code. It returns the length of the encoded text. An error is
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4017 signaled if a character in the region is multibyte, i.e.@: in a
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4018 multibyte buffer the region must contain only characters from the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4019 charsets @code{ascii}, @code{eight-bit-control} and
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4020 @code{eight-bit-graphic}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4021
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4022 Normally, this function inserts newline characters into the encoded
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4023 text, to avoid overlong lines. However, if the optional argument
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4024 @var{no-line-break} is non-@code{nil}, these newlines are not added, so
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4025 the output is just one long line.
103264
b269cabac20c * syntax.texi (Position Parse): Document rationale for ignored
Chong Yidong <cyd@stupidchicken.com>
parents: 102893
diff changeset
4026 @end deffn
b269cabac20c * syntax.texi (Position Parse): Document rationale for ignored
Chong Yidong <cyd@stupidchicken.com>
parents: 102893
diff changeset
4027
b269cabac20c * syntax.texi (Position Parse): Document rationale for ignored
Chong Yidong <cyd@stupidchicken.com>
parents: 102893
diff changeset
4028 @deffn Command base64-encode-string string &optional no-line-break
84103
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4029 This function converts the string @var{string} into base 64 code. It
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4030 returns a string containing the encoded text. As for
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4031 @code{base64-encode-region}, an error is signaled if a character in the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4032 string is multibyte.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4033
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4034 Normally, this function inserts newline characters into the encoded
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4035 text, to avoid overlong lines. However, if the optional argument
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4036 @var{no-line-break} is non-@code{nil}, these newlines are not added, so
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4037 the result string is just one long line.
103264
b269cabac20c * syntax.texi (Position Parse): Document rationale for ignored
Chong Yidong <cyd@stupidchicken.com>
parents: 102893
diff changeset
4038 @end deffn
84103
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4039
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4040 @defun base64-decode-region beg end
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4041 This function converts the region from @var{beg} to @var{end} from base
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4042 64 code into the corresponding decoded text. It returns the length of
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4043 the decoded text.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4044
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4045 The decoding functions ignore newline characters in the encoded text.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4046 @end defun
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4047
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4048 @defun base64-decode-string string
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4049 This function converts the string @var{string} from base 64 code into
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4050 the corresponding decoded text. It returns a unibyte string containing the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4051 decoded text.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4052
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4053 The decoding functions ignore newline characters in the encoded text.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4054 @end defun
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4055
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4056 @node MD5 Checksum
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4057 @section MD5 Checksum
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4058 @cindex MD5 checksum
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4059 @cindex message digest computation
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4060
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4061 MD5 cryptographic checksums, or @dfn{message digests}, are 128-bit
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4062 ``fingerprints'' of a document or program. They are used to verify
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4063 that you have an exact and unaltered copy of the data. The algorithm
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4064 to calculate the MD5 message digest is defined in Internet
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4065 RFC@footnote{
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4066 For an explanation of what is an RFC, see the footnote in @ref{Base
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4067 64}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4068 }1321. This section describes the Emacs facilities for computing
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4069 message digests.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4070
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4071 @defun md5 object &optional start end coding-system noerror
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4072 This function returns the MD5 message digest of @var{object}, which
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4073 should be a buffer or a string.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4074
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4075 The two optional arguments @var{start} and @var{end} are character
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4076 positions specifying the portion of @var{object} to compute the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4077 message digest for. If they are @code{nil} or omitted, the digest is
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4078 computed for the whole of @var{object}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4079
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4080 The function @code{md5} does not compute the message digest directly
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4081 from the internal Emacs representation of the text (@pxref{Text
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4082 Representations}). Instead, it encodes the text using a coding
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4083 system, and computes the message digest from the encoded text. The
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4084 optional fourth argument @var{coding-system} specifies which coding
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4085 system to use for encoding the text. It should be the same coding
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4086 system that you used to read the text, or that you used or will use
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4087 when saving or sending the text. @xref{Coding Systems}, for more
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4088 information about coding systems.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4089
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4090 If @var{coding-system} is @code{nil} or omitted, the default depends
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4091 on @var{object}. If @var{object} is a buffer, the default for
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4092 @var{coding-system} is whatever coding system would be chosen by
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4093 default for writing this text into a file. If @var{object} is a
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4094 string, the user's most preferred coding system (@pxref{Recognize
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4095 Coding, prefer-coding-system, the description of
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4096 @code{prefer-coding-system}, emacs, GNU Emacs Manual}) is used.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4097
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4098 Normally, @code{md5} signals an error if the text can't be encoded
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4099 using the specified or chosen coding system. However, if
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4100 @var{noerror} is non-@code{nil}, it silently uses @code{raw-text}
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4101 coding instead.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4102 @end defun
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4103
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4104 @node Atomic Changes
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4105 @section Atomic Change Groups
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4106 @cindex atomic changes
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4107
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4108 In data base terminology, an @dfn{atomic} change is an indivisible
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4109 change---it can succeed entirely or it can fail entirely, but it
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4110 cannot partly succeed. A Lisp program can make a series of changes to
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4111 one or several buffers as an @dfn{atomic change group}, meaning that
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4112 either the entire series of changes will be installed in their buffers
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4113 or, in case of an error, none of them will be.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4114
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4115 To do this for one buffer, the one already current, simply write a
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4116 call to @code{atomic-change-group} around the code that makes the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4117 changes, like this:
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4118
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4119 @example
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4120 (atomic-change-group
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4121 (insert foo)
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4122 (delete-region x y))
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4123 @end example
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4124
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4125 @noindent
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4126 If an error (or other nonlocal exit) occurs inside the body of
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4127 @code{atomic-change-group}, it unmakes all the changes in that buffer
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4128 that were during the execution of the body. This kind of change group
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4129 has no effect on any other buffers---any such changes remain.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4130
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4131 If you need something more sophisticated, such as to make changes in
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4132 various buffers constitute one atomic group, you must directly call
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4133 lower-level functions that @code{atomic-change-group} uses.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4134
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4135 @defun prepare-change-group &optional buffer
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4136 This function sets up a change group for buffer @var{buffer}, which
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4137 defaults to the current buffer. It returns a ``handle'' that
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4138 represents the change group. You must use this handle to activate the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4139 change group and subsequently to finish it.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4140 @end defun
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4141
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4142 To use the change group, you must @dfn{activate} it. You must do
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4143 this before making any changes in the text of @var{buffer}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4144
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4145 @defun activate-change-group handle
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4146 This function activates the change group that @var{handle} designates.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4147 @end defun
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4148
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4149 After you activate the change group, any changes you make in that
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4150 buffer become part of it. Once you have made all the desired changes
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4151 in the buffer, you must @dfn{finish} the change group. There are two
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4152 ways to do this: you can either accept (and finalize) all the changes,
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4153 or cancel them all.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4154
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4155 @defun accept-change-group handle
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4156 This function accepts all the changes in the change group specified by
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4157 @var{handle}, making them final.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4158 @end defun
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4159
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4160 @defun cancel-change-group handle
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4161 This function cancels and undoes all the changes in the change group
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4162 specified by @var{handle}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4163 @end defun
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4164
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4165 Your code should use @code{unwind-protect} to make sure the group is
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4166 always finished. The call to @code{activate-change-group} should be
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4167 inside the @code{unwind-protect}, in case the user types @kbd{C-g}
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4168 just after it runs. (This is one reason why
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4169 @code{prepare-change-group} and @code{activate-change-group} are
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4170 separate functions, because normally you would call
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4171 @code{prepare-change-group} before the start of that
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4172 @code{unwind-protect}.) Once you finish the group, don't use the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4173 handle again---in particular, don't try to finish the same group
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4174 twice.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4175
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4176 To make a multibuffer change group, call @code{prepare-change-group}
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4177 once for each buffer you want to cover, then use @code{nconc} to
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4178 combine the returned values, like this:
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4179
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4180 @example
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4181 (nconc (prepare-change-group buffer-1)
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4182 (prepare-change-group buffer-2))
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4183 @end example
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4184
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4185 You can then activate the multibuffer change group with a single call
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4186 to @code{activate-change-group}, and finish it with a single call to
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4187 @code{accept-change-group} or @code{cancel-change-group}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4188
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4189 Nested use of several change groups for the same buffer works as you
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4190 would expect. Non-nested use of change groups for the same buffer
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4191 will get Emacs confused, so don't let it happen; the first change
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4192 group you start for any given buffer should be the last one finished.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4193
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4194 @node Change Hooks
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4195 @section Change Hooks
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4196 @cindex change hooks
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4197 @cindex hooks for text changes
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4198
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4199 These hook variables let you arrange to take notice of all changes in
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4200 all buffers (or in a particular buffer, if you make them buffer-local).
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4201 See also @ref{Special Properties}, for how to detect changes to specific
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4202 parts of the text.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4203
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4204 The functions you use in these hooks should save and restore the match
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4205 data if they do anything that uses regular expressions; otherwise, they
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4206 will interfere in bizarre ways with the editing operations that call
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4207 them.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4208
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4209 @defvar before-change-functions
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4210 This variable holds a list of functions to call before any buffer
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4211 modification. Each function gets two arguments, the beginning and end
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4212 of the region that is about to change, represented as integers. The
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4213 buffer that is about to change is always the current buffer.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4214 @end defvar
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4215
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4216 @defvar after-change-functions
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4217 This variable holds a list of functions to call after any buffer
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4218 modification. Each function receives three arguments: the beginning and
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4219 end of the region just changed, and the length of the text that existed
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4220 before the change. All three arguments are integers. The buffer that's
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4221 about to change is always the current buffer.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4222
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4223 The length of the old text is the difference between the buffer positions
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4224 before and after that text as it was before the change. As for the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4225 changed text, its length is simply the difference between the first two
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4226 arguments.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4227 @end defvar
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4228
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4229 Output of messages into the @samp{*Messages*} buffer does not
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4230 call these functions.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4231
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4232 @defmac combine-after-change-calls body@dots{}
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4233 The macro executes @var{body} normally, but arranges to call the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4234 after-change functions just once for a series of several changes---if
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4235 that seems safe.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4236
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4237 If a program makes several text changes in the same area of the buffer,
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4238 using the macro @code{combine-after-change-calls} around that part of
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4239 the program can make it run considerably faster when after-change hooks
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4240 are in use. When the after-change hooks are ultimately called, the
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4241 arguments specify a portion of the buffer including all of the changes
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4242 made within the @code{combine-after-change-calls} body.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4243
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4244 @strong{Warning:} You must not alter the values of
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4245 @code{after-change-functions} within
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4246 the body of a @code{combine-after-change-calls} form.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4247
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4248 @strong{Warning:} if the changes you combine occur in widely scattered
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4249 parts of the buffer, this will still work, but it is not advisable,
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4250 because it may lead to inefficient behavior for some change hook
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4251 functions.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4252 @end defmac
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4253
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4254 @defvar first-change-hook
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4255 This variable is a normal hook that is run whenever a buffer is changed
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4256 that was previously in the unmodified state.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4257 @end defvar
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4258
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4259 @defvar inhibit-modification-hooks
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4260 If this variable is non-@code{nil}, all of the change hooks are
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4261 disabled; none of them run. This affects all the hook variables
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4262 described above in this section, as well as the hooks attached to
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4263 certain special text properties (@pxref{Special Properties}) and overlay
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4264 properties (@pxref{Overlay Properties}).
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4265
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4266 Also, this variable is bound to non-@code{nil} while running those
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4267 same hook variables, so that by default modifying the buffer from
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4268 a modification hook does not cause other modification hooks to be run.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4269 If you do want modification hooks to be run in a particular piece of
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4270 code that is itself run from a modification hook, then rebind locally
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4271 @code{inhibit-modification-hooks} to @code{nil}.
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4272 @end defvar
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4273
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4274 @ignore
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4275 arch-tag: 3721e738-a1cb-4085-bc1a-6cb8d8e1d32b
e7746a71b866 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4276 @end ignore