annotate doc/lispref/syntax.texi @ 110866:4b97fee97310

Add doc/ dependencies on emacsver.texi. * doc/misc/Makefile.in ($(infodir)/efaq): Depend on emacsver.texi. * doc/lispref/Makefile.in (srcs): Add emacsver.texi. * doc/emacs/Makefile.in (EMACSSOURCES): Add emacsver.texi.
author Glenn Morris <rgm@gnu.org>
date Fri, 08 Oct 2010 19:09:46 -0700
parents 9b5623e06689
children 417b1e4d63cd
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
84102
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1 @c -*-texinfo-*-
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2 @c This is part of the GNU Emacs Lisp Reference Manual.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3 @c Copyright (C) 1990, 1991, 1992, 1993, 1994, 1995, 1998, 1999, 2001,
109267
71353caf35e3 Untabify doc/lispref/*.texi.
Glenn Morris <rgm@gnu.org>
parents: 106815
diff changeset
4 @c 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010
71353caf35e3 Untabify doc/lispref/*.texi.
Glenn Morris <rgm@gnu.org>
parents: 106815
diff changeset
5 @c Free Software Foundation, Inc.
84102
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6 @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: 84102
diff changeset
7 @setfilename ../../info/syntax
84102
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8 @node Syntax Tables, Abbrevs, Searching and Matching, Top
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9 @chapter Syntax Tables
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10 @cindex parsing buffer text
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11 @cindex syntax table
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12 @cindex text parsing
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14 A @dfn{syntax table} specifies the syntactic textual function of each
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15 character. This information is used by the @dfn{parsing functions}, the
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16 complex movement commands, and others to determine where words, symbols,
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17 and other syntactic constructs begin and end. The current syntax table
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18 controls the meaning of the word motion functions (@pxref{Word Motion})
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19 and the list motion functions (@pxref{List Motion}), as well as the
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20 functions in this chapter.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22 @menu
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
23 * Basics: Syntax Basics. Basic concepts of syntax tables.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
24 * Desc: Syntax Descriptors. How characters are classified.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
25 * Syntax Table Functions:: How to create, examine and alter syntax tables.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
26 * Syntax Properties:: Overriding syntax with text properties.
109267
71353caf35e3 Untabify doc/lispref/*.texi.
Glenn Morris <rgm@gnu.org>
parents: 106815
diff changeset
27 * Motion and Syntax:: Moving over characters with certain syntaxes.
84102
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
28 * Parsing Expressions:: Parsing balanced expressions
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
29 using the syntax table.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
30 * Standard Syntax Tables:: Syntax tables used by various major modes.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
31 * Syntax Table Internals:: How syntax table information is stored.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
32 * Categories:: Another way of classifying character syntax.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
33 @end menu
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
34
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
35 @node Syntax Basics
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
36 @section Syntax Table Concepts
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
37
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
38 @ifnottex
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
39 A @dfn{syntax table} provides Emacs with the information that
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
40 determines the syntactic use of each character in a buffer. This
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
41 information is used by the parsing commands, the complex movement
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
42 commands, and others to determine where words, symbols, and other
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
43 syntactic constructs begin and end. The current syntax table controls
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
44 the meaning of the word motion functions (@pxref{Word Motion}) and the
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
45 list motion functions (@pxref{List Motion}) as well as the functions in
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
46 this chapter.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
47 @end ifnottex
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
48
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
49 A syntax table is a char-table (@pxref{Char-Tables}). The element at
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
50 index @var{c} describes the character with code @var{c}. The element's
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
51 value should be a list that encodes the syntax of the character in
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
52 question.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
53
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
54 Syntax tables are used only for moving across text, not for the Emacs
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
55 Lisp reader. Emacs Lisp uses built-in syntactic rules when reading Lisp
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
56 expressions, and these rules cannot be changed. (Some Lisp systems
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
57 provide ways to redefine the read syntax, but we decided to leave this
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
58 feature out of Emacs Lisp for simplicity.)
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
59
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
60 Each buffer has its own major mode, and each major mode has its own
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
61 idea of the syntactic class of various characters. For example, in Lisp
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
62 mode, the character @samp{;} begins a comment, but in C mode, it
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
63 terminates a statement. To support these variations, Emacs makes the
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
64 choice of syntax table local to each buffer. Typically, each major
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
65 mode has its own syntax table and installs that table in each buffer
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
66 that uses that mode. Changing this table alters the syntax in all
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
67 those buffers as well as in any buffers subsequently put in that mode.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
68 Occasionally several similar modes share one syntax table.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
69 @xref{Example Major Modes}, for an example of how to set up a syntax
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
70 table.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
71
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
72 A syntax table can inherit the data for some characters from the
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
73 standard syntax table, while specifying other characters itself. The
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
74 ``inherit'' syntax class means ``inherit this character's syntax from
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
75 the standard syntax table.'' Just changing the standard syntax for a
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
76 character affects all syntax tables that inherit from it.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
77
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
78 @defun syntax-table-p object
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
79 This function returns @code{t} if @var{object} is a syntax table.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
80 @end defun
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
81
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
82 @node Syntax Descriptors
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
83 @section Syntax Descriptors
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
84 @cindex syntax class
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
85
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
86 This section describes the syntax classes and flags that denote the
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
87 syntax of a character, and how they are represented as a @dfn{syntax
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
88 descriptor}, which is a Lisp string that you pass to
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
89 @code{modify-syntax-entry} to specify the syntax you want.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
90
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
91 The syntax table specifies a syntax class for each character. There
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
92 is no necessary relationship between the class of a character in one
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
93 syntax table and its class in any other table.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
94
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
95 Each class is designated by a mnemonic character, which serves as the
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
96 name of the class when you need to specify a class. Usually the
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
97 designator character is one that is often assigned that class; however,
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
98 its meaning as a designator is unvarying and independent of what syntax
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
99 that character currently has. Thus, @samp{\} as a designator character
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
100 always gives ``escape character'' syntax, regardless of what syntax
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
101 @samp{\} currently has.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
102
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
103 @cindex syntax descriptor
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
104 A syntax descriptor is a Lisp string that specifies a syntax class, a
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
105 matching character (used only for the parenthesis classes) and flags.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
106 The first character is the designator for a syntax class. The second
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
107 character is the character to match; if it is unused, put a space there.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
108 Then come the characters for any desired flags. If no matching
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
109 character or flags are needed, one character is sufficient.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
110
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
111 For example, the syntax descriptor for the character @samp{*} in C
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
112 mode is @samp{@w{. 23}} (i.e., punctuation, matching character slot
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
113 unused, second character of a comment-starter, first character of a
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
114 comment-ender), and the entry for @samp{/} is @samp{@w{. 14}} (i.e.,
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
115 punctuation, matching character slot unused, first character of a
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
116 comment-starter, second character of a comment-ender).
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
117
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
118 @menu
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
119 * Syntax Class Table:: Table of syntax classes.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
120 * Syntax Flags:: Additional flags each character can have.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
121 @end menu
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
122
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
123 @node Syntax Class Table
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
124 @subsection Table of Syntax Classes
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
125
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
126 Here is a table of syntax classes, the characters that stand for them,
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
127 their meanings, and examples of their use.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
128
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
129 @deffn {Syntax class} @w{whitespace character}
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
130 @dfn{Whitespace characters} (designated by @w{@samp{@ }} or @samp{-})
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
131 separate symbols and words from each other. Typically, whitespace
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
132 characters have no other syntactic significance, and multiple whitespace
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
133 characters are syntactically equivalent to a single one. Space, tab,
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
134 newline and formfeed are classified as whitespace in almost all major
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
135 modes.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
136 @end deffn
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
137
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
138 @deffn {Syntax class} @w{word constituent}
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
139 @dfn{Word constituents} (designated by @samp{w}) are parts of words in
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
140 human languages, and are typically used in variable and command names
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
141 in programs. All upper- and lower-case letters, and the digits, are
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
142 typically word constituents.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
143 @end deffn
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
144
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
145 @deffn {Syntax class} @w{symbol constituent}
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
146 @dfn{Symbol constituents} (designated by @samp{_}) are the extra
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
147 characters that are used in variable and command names along with word
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
148 constituents. For example, the symbol constituents class is used in
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
149 Lisp mode to indicate that certain characters may be part of symbol
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
150 names even though they are not part of English words. These characters
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
151 are @samp{$&*+-_<>}. In standard C, the only non-word-constituent
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
152 character that is valid in symbols is underscore (@samp{_}).
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
153 @end deffn
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
154
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
155 @deffn {Syntax class} @w{punctuation character}
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
156 @dfn{Punctuation characters} (designated by @samp{.}) are those
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
157 characters that are used as punctuation in English, or are used in some
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
158 way in a programming language to separate symbols from one another.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
159 Some programming language modes, such as Emacs Lisp mode, have no
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
160 characters in this class since the few characters that are not symbol or
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
161 word constituents all have other uses. Other programming language modes,
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
162 such as C mode, use punctuation syntax for operators.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
163 @end deffn
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
164
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
165 @deffn {Syntax class} @w{open parenthesis character}
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
166 @deffnx {Syntax class} @w{close parenthesis character}
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
167 @cindex parenthesis syntax
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
168 Open and close @dfn{parenthesis characters} are characters used in
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
169 dissimilar pairs to surround sentences or expressions. Such a grouping
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
170 is begun with an open parenthesis character and terminated with a close.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
171 Each open parenthesis character matches a particular close parenthesis
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
172 character, and vice versa. Normally, Emacs indicates momentarily the
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
173 matching open parenthesis when you insert a close parenthesis.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
174 @xref{Blinking}.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
175
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
176 The class of open parentheses is designated by @samp{(}, and that of
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
177 close parentheses by @samp{)}.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
178
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
179 In English text, and in C code, the parenthesis pairs are @samp{()},
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
180 @samp{[]}, and @samp{@{@}}. In Emacs Lisp, the delimiters for lists and
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
181 vectors (@samp{()} and @samp{[]}) are classified as parenthesis
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
182 characters.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
183 @end deffn
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
184
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
185 @deffn {Syntax class} @w{string quote}
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
186 @dfn{String quote characters} (designated by @samp{"}) are used in
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
187 many languages, including Lisp and C, to delimit string constants. The
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
188 same string quote character appears at the beginning and the end of a
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
189 string. Such quoted strings do not nest.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
190
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
191 The parsing facilities of Emacs consider a string as a single token.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
192 The usual syntactic meanings of the characters in the string are
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
193 suppressed.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
194
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
195 The Lisp modes have two string quote characters: double-quote (@samp{"})
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
196 and vertical bar (@samp{|}). @samp{|} is not used in Emacs Lisp, but it
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
197 is used in Common Lisp. C also has two string quote characters:
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
198 double-quote for strings, and single-quote (@samp{'}) for character
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
199 constants.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
200
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
201 English text has no string quote characters because English is not a
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
202 programming language. Although quotation marks are used in English,
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
203 we do not want them to turn off the usual syntactic properties of
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
204 other characters in the quotation.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
205 @end deffn
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
206
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
207 @deffn {Syntax class} @w{escape-syntax character}
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
208 An @dfn{escape character} (designated by @samp{\}) starts an escape
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
209 sequence such as is used in C string and character constants. The
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
210 character @samp{\} belongs to this class in both C and Lisp. (In C, it
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
211 is used thus only inside strings, but it turns out to cause no trouble
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
212 to treat it this way throughout C code.)
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
213
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
214 Characters in this class count as part of words if
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
215 @code{words-include-escapes} is non-@code{nil}. @xref{Word Motion}.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
216 @end deffn
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
217
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
218 @deffn {Syntax class} @w{character quote}
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
219 A @dfn{character quote character} (designated by @samp{/}) quotes the
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
220 following character so that it loses its normal syntactic meaning. This
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
221 differs from an escape character in that only the character immediately
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
222 following is ever affected.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
223
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
224 Characters in this class count as part of words if
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
225 @code{words-include-escapes} is non-@code{nil}. @xref{Word Motion}.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
226
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
227 This class is used for backslash in @TeX{} mode.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
228 @end deffn
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
229
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
230 @deffn {Syntax class} @w{paired delimiter}
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
231 @dfn{Paired delimiter characters} (designated by @samp{$}) are like
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
232 string quote characters except that the syntactic properties of the
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
233 characters between the delimiters are not suppressed. Only @TeX{} mode
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
234 uses a paired delimiter presently---the @samp{$} that both enters and
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
235 leaves math mode.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
236 @end deffn
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
237
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
238 @deffn {Syntax class} @w{expression prefix}
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
239 An @dfn{expression prefix operator} (designated by @samp{'}) is used for
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
240 syntactic operators that are considered as part of an expression if they
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
241 appear next to one. In Lisp modes, these characters include the
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
242 apostrophe, @samp{'} (used for quoting), the comma, @samp{,} (used in
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
243 macros), and @samp{#} (used in the read syntax for certain data types).
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
244 @end deffn
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
245
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
246 @deffn {Syntax class} @w{comment starter}
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
247 @deffnx {Syntax class} @w{comment ender}
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
248 @cindex comment syntax
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
249 The @dfn{comment starter} and @dfn{comment ender} characters are used in
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
250 various languages to delimit comments. These classes are designated
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
251 by @samp{<} and @samp{>}, respectively.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
252
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
253 English text has no comment characters. In Lisp, the semicolon
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
254 (@samp{;}) starts a comment and a newline or formfeed ends one.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
255 @end deffn
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
256
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
257 @deffn {Syntax class} @w{inherit standard syntax}
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
258 This syntax class does not specify a particular syntax. It says to look
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
259 in the standard syntax table to find the syntax of this character. The
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
260 designator for this syntax class is @samp{@@}.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
261 @end deffn
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
262
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
263 @deffn {Syntax class} @w{generic comment delimiter}
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
264 A @dfn{generic comment delimiter} (designated by @samp{!}) starts
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
265 or ends a special kind of comment. @emph{Any} generic comment delimiter
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
266 matches @emph{any} generic comment delimiter, but they cannot match
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
267 a comment starter or comment ender; generic comment delimiters can only
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
268 match each other.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
269
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
270 This syntax class is primarily meant for use with the
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
271 @code{syntax-table} text property (@pxref{Syntax Properties}). You can
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
272 mark any range of characters as forming a comment, by giving the first
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
273 and last characters of the range @code{syntax-table} properties
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
274 identifying them as generic comment delimiters.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
275 @end deffn
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
276
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
277 @deffn {Syntax class} @w{generic string delimiter}
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
278 A @dfn{generic string delimiter} (designated by @samp{|}) starts or ends
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
279 a string. This class differs from the string quote class in that @emph{any}
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
280 generic string delimiter can match any other generic string delimiter; but
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
281 they do not match ordinary string quote characters.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
282
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
283 This syntax class is primarily meant for use with the
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
284 @code{syntax-table} text property (@pxref{Syntax Properties}). You can
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
285 mark any range of characters as forming a string constant, by giving the
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
286 first and last characters of the range @code{syntax-table} properties
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
287 identifying them as generic string delimiters.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
288 @end deffn
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
289
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
290 @node Syntax Flags
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
291 @subsection Syntax Flags
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
292 @cindex syntax flags
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
293
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
294 In addition to the classes, entries for characters in a syntax table
110310
9b5623e06689 * doc/lispref/syntax.texi (Syntax Flags): Document new `c' flag.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 109267
diff changeset
295 can specify flags. There are eight possible flags, represented by the
9b5623e06689 * doc/lispref/syntax.texi (Syntax Flags): Document new `c' flag.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 109267
diff changeset
296 characters @samp{1}, @samp{2}, @samp{3}, @samp{4}, @samp{b}, @samp{c},
9b5623e06689 * doc/lispref/syntax.texi (Syntax Flags): Document new `c' flag.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 109267
diff changeset
297 @samp{n}, and @samp{p}.
84102
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
298
110310
9b5623e06689 * doc/lispref/syntax.texi (Syntax Flags): Document new `c' flag.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 109267
diff changeset
299 All the flags except @samp{p} are used to describe comment
9b5623e06689 * doc/lispref/syntax.texi (Syntax Flags): Document new `c' flag.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 109267
diff changeset
300 delimiters. The digit flags are used for comment delimiters made up
9b5623e06689 * doc/lispref/syntax.texi (Syntax Flags): Document new `c' flag.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 109267
diff changeset
301 of 2 characters. They indicate that a character can @emph{also} be
9b5623e06689 * doc/lispref/syntax.texi (Syntax Flags): Document new `c' flag.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 109267
diff changeset
302 part of a comment sequence, in addition to the syntactic properties
9b5623e06689 * doc/lispref/syntax.texi (Syntax Flags): Document new `c' flag.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 109267
diff changeset
303 associated with its character class. The flags are independent of the
9b5623e06689 * doc/lispref/syntax.texi (Syntax Flags): Document new `c' flag.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 109267
diff changeset
304 class and each other for the sake of characters such as @samp{*} in
9b5623e06689 * doc/lispref/syntax.texi (Syntax Flags): Document new `c' flag.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 109267
diff changeset
305 C mode, which is a punctuation character, @emph{and} the second
9b5623e06689 * doc/lispref/syntax.texi (Syntax Flags): Document new `c' flag.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 109267
diff changeset
306 character of a start-of-comment sequence (@samp{/*}), @emph{and} the
9b5623e06689 * doc/lispref/syntax.texi (Syntax Flags): Document new `c' flag.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 109267
diff changeset
307 first character of an end-of-comment sequence (@samp{*/}). The flags
9b5623e06689 * doc/lispref/syntax.texi (Syntax Flags): Document new `c' flag.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 109267
diff changeset
308 @samp{b}, @samp{c}, and @samp{n} are used to qualify the corresponding
9b5623e06689 * doc/lispref/syntax.texi (Syntax Flags): Document new `c' flag.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 109267
diff changeset
309 comment delimiter.
84102
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
310
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
311 Here is a table of the possible flags for a character @var{c},
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
312 and what they mean:
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
313
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
314 @itemize @bullet
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
315 @item
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
316 @samp{1} means @var{c} is the start of a two-character comment-start
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
317 sequence.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
318
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
319 @item
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
320 @samp{2} means @var{c} is the second character of such a sequence.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
321
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
322 @item
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
323 @samp{3} means @var{c} is the start of a two-character comment-end
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
324 sequence.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
325
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
326 @item
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
327 @samp{4} means @var{c} is the second character of such a sequence.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
328
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
329 @item
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
330 @samp{b} means that @var{c} as a comment delimiter belongs to the
110310
9b5623e06689 * doc/lispref/syntax.texi (Syntax Flags): Document new `c' flag.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 109267
diff changeset
331 alternative ``b'' comment style. For a two-character comment starter,
9b5623e06689 * doc/lispref/syntax.texi (Syntax Flags): Document new `c' flag.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 109267
diff changeset
332 this flag is only significant on the second char, and for a 2-character
9b5623e06689 * doc/lispref/syntax.texi (Syntax Flags): Document new `c' flag.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 109267
diff changeset
333 comment ender it is only significant on the first char.
9b5623e06689 * doc/lispref/syntax.texi (Syntax Flags): Document new `c' flag.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 109267
diff changeset
334
9b5623e06689 * doc/lispref/syntax.texi (Syntax Flags): Document new `c' flag.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 109267
diff changeset
335 @item
9b5623e06689 * doc/lispref/syntax.texi (Syntax Flags): Document new `c' flag.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 109267
diff changeset
336 @samp{c} means that @var{c} as a comment delimiter belongs to the
9b5623e06689 * doc/lispref/syntax.texi (Syntax Flags): Document new `c' flag.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 109267
diff changeset
337 alternative ``c'' comment style. For a two-character comment
9b5623e06689 * doc/lispref/syntax.texi (Syntax Flags): Document new `c' flag.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 109267
diff changeset
338 delimiter, @samp{c} on either character makes it of style ``c''.
84102
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
339
110310
9b5623e06689 * doc/lispref/syntax.texi (Syntax Flags): Document new `c' flag.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 109267
diff changeset
340 @item
9b5623e06689 * doc/lispref/syntax.texi (Syntax Flags): Document new `c' flag.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 109267
diff changeset
341 @samp{n} on a comment delimiter character specifies
9b5623e06689 * doc/lispref/syntax.texi (Syntax Flags): Document new `c' flag.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 109267
diff changeset
342 that this kind of comment can be nested. For a two-character
9b5623e06689 * doc/lispref/syntax.texi (Syntax Flags): Document new `c' flag.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 109267
diff changeset
343 comment delimiter, @samp{n} on either character makes it
9b5623e06689 * doc/lispref/syntax.texi (Syntax Flags): Document new `c' flag.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 109267
diff changeset
344 nestable.
84102
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
345
110310
9b5623e06689 * doc/lispref/syntax.texi (Syntax Flags): Document new `c' flag.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 109267
diff changeset
346 Emacs supports several comment styles simultaneously in any one syntax
9b5623e06689 * doc/lispref/syntax.texi (Syntax Flags): Document new `c' flag.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 109267
diff changeset
347 table. A comment style is a set of flags @samp{b}, @samp{c}, and
9b5623e06689 * doc/lispref/syntax.texi (Syntax Flags): Document new `c' flag.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 109267
diff changeset
348 @samp{n}, so there can be up to 8 different comment styles.
9b5623e06689 * doc/lispref/syntax.texi (Syntax Flags): Document new `c' flag.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 109267
diff changeset
349 Each comment delimiter has a style and only matches comment delimiters
9b5623e06689 * doc/lispref/syntax.texi (Syntax Flags): Document new `c' flag.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 109267
diff changeset
350 of the same style. Thus if a comment starts with the comment-start
9b5623e06689 * doc/lispref/syntax.texi (Syntax Flags): Document new `c' flag.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 109267
diff changeset
351 sequence of style ``bn'', it will extend until the next matching
9b5623e06689 * doc/lispref/syntax.texi (Syntax Flags): Document new `c' flag.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 109267
diff changeset
352 comment-end sequence of style ``bn''.
84102
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
353
110310
9b5623e06689 * doc/lispref/syntax.texi (Syntax Flags): Document new `c' flag.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 109267
diff changeset
354 The appropriate comment syntax settings for C++ can be as follows:
84102
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
355
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
356 @table @asis
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
357 @item @samp{/}
110310
9b5623e06689 * doc/lispref/syntax.texi (Syntax Flags): Document new `c' flag.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 109267
diff changeset
358 @samp{124}
84102
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
359 @item @samp{*}
110310
9b5623e06689 * doc/lispref/syntax.texi (Syntax Flags): Document new `c' flag.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 109267
diff changeset
360 @samp{23b}
84102
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
361 @item newline
110310
9b5623e06689 * doc/lispref/syntax.texi (Syntax Flags): Document new `c' flag.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 109267
diff changeset
362 @samp{>}
84102
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
363 @end table
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
364
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
365 This defines four comment-delimiting sequences:
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
366
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
367 @table @asis
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
368 @item @samp{/*}
110310
9b5623e06689 * doc/lispref/syntax.texi (Syntax Flags): Document new `c' flag.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 109267
diff changeset
369 This is a comment-start sequence for ``b'' style because the
9b5623e06689 * doc/lispref/syntax.texi (Syntax Flags): Document new `c' flag.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 109267
diff changeset
370 second character, @samp{*}, has the @samp{b} flag.
84102
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
371
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
372 @item @samp{//}
110310
9b5623e06689 * doc/lispref/syntax.texi (Syntax Flags): Document new `c' flag.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 109267
diff changeset
373 This is a comment-start sequence for ``a'' style because the second
9b5623e06689 * doc/lispref/syntax.texi (Syntax Flags): Document new `c' flag.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 109267
diff changeset
374 character, @samp{/}, does not have the @samp{b} flag.
84102
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
375
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
376 @item @samp{*/}
110310
9b5623e06689 * doc/lispref/syntax.texi (Syntax Flags): Document new `c' flag.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 109267
diff changeset
377 This is a comment-end sequence for ``b'' style because the first
9b5623e06689 * doc/lispref/syntax.texi (Syntax Flags): Document new `c' flag.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 109267
diff changeset
378 character, @samp{*}, does have the @samp{b} flag.
84102
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
379
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
380 @item newline
110310
9b5623e06689 * doc/lispref/syntax.texi (Syntax Flags): Document new `c' flag.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 109267
diff changeset
381 This is a comment-end sequence for ``a'' style, because the newline
9b5623e06689 * doc/lispref/syntax.texi (Syntax Flags): Document new `c' flag.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 109267
diff changeset
382 character does not have the @samp{b} flag.
84102
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
383 @end table
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
384
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
385 @item
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
386 @c Emacs 19 feature
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
387 @samp{p} identifies an additional ``prefix character'' for Lisp syntax.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
388 These characters are treated as whitespace when they appear between
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
389 expressions. When they appear within an expression, they are handled
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
390 according to their usual syntax classes.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
391
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
392 The function @code{backward-prefix-chars} moves back over these
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
393 characters, as well as over characters whose primary syntax class is
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
394 prefix (@samp{'}). @xref{Motion and Syntax}.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
395 @end itemize
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
396
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
397 @node Syntax Table Functions
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
398 @section Syntax Table Functions
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
399
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
400 In this section we describe functions for creating, accessing and
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
401 altering syntax tables.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
402
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
403 @defun make-syntax-table &optional table
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
404 This function creates a new syntax table, with all values initialized
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
405 to @code{nil}. If @var{table} is non-@code{nil}, it becomes the
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
406 parent of the new syntax table, otherwise the standard syntax table is
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
407 the parent. Like all char-tables, a syntax table inherits from its
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
408 parent. Thus the original syntax of all characters in the returned
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
409 syntax table is determined by the parent. @xref{Char-Tables}.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
410
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
411 Most major mode syntax tables are created in this way.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
412 @end defun
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
413
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
414 @defun copy-syntax-table &optional table
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
415 This function constructs a copy of @var{table} and returns it. If
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
416 @var{table} is not supplied (or is @code{nil}), it returns a copy of the
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
417 standard syntax table. Otherwise, an error is signaled if @var{table} is
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
418 not a syntax table.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
419 @end defun
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
420
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
421 @deffn Command modify-syntax-entry char syntax-descriptor &optional table
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
422 This function sets the syntax entry for @var{char} according to
102922
bc1b7462d55e * syntax.texi (Syntax Table Functions): Document cons cell
Chong Yidong <cyd@stupidchicken.com>
parents: 100974
diff changeset
423 @var{syntax-descriptor}. @var{char} can be a character, or a cons
bc1b7462d55e * syntax.texi (Syntax Table Functions): Document cons cell
Chong Yidong <cyd@stupidchicken.com>
parents: 100974
diff changeset
424 cell of the form @code{(@var{min} . @var{max})}; in the latter case,
bc1b7462d55e * syntax.texi (Syntax Table Functions): Document cons cell
Chong Yidong <cyd@stupidchicken.com>
parents: 100974
diff changeset
425 the function sets the syntax entries for all characters in the range
bc1b7462d55e * syntax.texi (Syntax Table Functions): Document cons cell
Chong Yidong <cyd@stupidchicken.com>
parents: 100974
diff changeset
426 between @var{min} and @var{max}, inclusive.
bc1b7462d55e * syntax.texi (Syntax Table Functions): Document cons cell
Chong Yidong <cyd@stupidchicken.com>
parents: 100974
diff changeset
427
bc1b7462d55e * syntax.texi (Syntax Table Functions): Document cons cell
Chong Yidong <cyd@stupidchicken.com>
parents: 100974
diff changeset
428 The syntax is changed only for @var{table}, which defaults to the
bc1b7462d55e * syntax.texi (Syntax Table Functions): Document cons cell
Chong Yidong <cyd@stupidchicken.com>
parents: 100974
diff changeset
429 current buffer's syntax table, and not in any other syntax table. The
bc1b7462d55e * syntax.texi (Syntax Table Functions): Document cons cell
Chong Yidong <cyd@stupidchicken.com>
parents: 100974
diff changeset
430 argument @var{syntax-descriptor} specifies the desired syntax; this is
bc1b7462d55e * syntax.texi (Syntax Table Functions): Document cons cell
Chong Yidong <cyd@stupidchicken.com>
parents: 100974
diff changeset
431 a string beginning with a class designator character, and optionally
bc1b7462d55e * syntax.texi (Syntax Table Functions): Document cons cell
Chong Yidong <cyd@stupidchicken.com>
parents: 100974
diff changeset
432 containing a matching character and flags as well. @xref{Syntax
bc1b7462d55e * syntax.texi (Syntax Table Functions): Document cons cell
Chong Yidong <cyd@stupidchicken.com>
parents: 100974
diff changeset
433 Descriptors}.
84102
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
434
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
435 This function always returns @code{nil}. The old syntax information in
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
436 the table for this character is discarded.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
437
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
438 An error is signaled if the first character of the syntax descriptor is not
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
439 one of the seventeen syntax class designator characters. An error is also
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
440 signaled if @var{char} is not a character.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
441
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
442 @example
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
443 @group
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
444 @exdent @r{Examples:}
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
445
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
446 ;; @r{Put the space character in class whitespace.}
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
447 (modify-syntax-entry ?\s " ")
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
448 @result{} nil
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
449 @end group
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
450
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
451 @group
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
452 ;; @r{Make @samp{$} an open parenthesis character,}
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
453 ;; @r{with @samp{^} as its matching close.}
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
454 (modify-syntax-entry ?$ "(^")
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
455 @result{} nil
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
456 @end group
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
457
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
458 @group
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
459 ;; @r{Make @samp{^} a close parenthesis character,}
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
460 ;; @r{with @samp{$} as its matching open.}
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
461 (modify-syntax-entry ?^ ")$")
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
462 @result{} nil
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
463 @end group
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
464
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
465 @group
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
466 ;; @r{Make @samp{/} a punctuation character,}
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
467 ;; @r{the first character of a start-comment sequence,}
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
468 ;; @r{and the second character of an end-comment sequence.}
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
469 ;; @r{This is used in C mode.}
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
470 (modify-syntax-entry ?/ ". 14")
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
471 @result{} nil
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
472 @end group
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
473 @end example
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
474 @end deffn
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
475
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
476 @defun char-syntax character
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
477 This function returns the syntax class of @var{character}, represented
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
478 by its mnemonic designator character. This returns @emph{only} the
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
479 class, not any matching parenthesis or flags.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
480
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
481 An error is signaled if @var{char} is not a character.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
482
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
483 The following examples apply to C mode. The first example shows that
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
484 the syntax class of space is whitespace (represented by a space). The
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
485 second example shows that the syntax of @samp{/} is punctuation. This
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
486 does not show the fact that it is also part of comment-start and -end
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
487 sequences. The third example shows that open parenthesis is in the class
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
488 of open parentheses. This does not show the fact that it has a matching
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
489 character, @samp{)}.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
490
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
491 @example
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
492 @group
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
493 (string (char-syntax ?\s))
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
494 @result{} " "
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
495 @end group
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
496
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
497 @group
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
498 (string (char-syntax ?/))
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
499 @result{} "."
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
500 @end group
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
501
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
502 @group
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
503 (string (char-syntax ?\())
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
504 @result{} "("
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
505 @end group
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
506 @end example
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
507
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
508 We use @code{string} to make it easier to see the character returned by
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
509 @code{char-syntax}.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
510 @end defun
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
511
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
512 @defun set-syntax-table table
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
513 This function makes @var{table} the syntax table for the current buffer.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
514 It returns @var{table}.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
515 @end defun
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
516
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
517 @defun syntax-table
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
518 This function returns the current syntax table, which is the table for
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
519 the current buffer.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
520 @end defun
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
521
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
522 @defmac with-syntax-table @var{table} @var{body}@dots{}
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
523 This macro executes @var{body} using @var{table} as the current syntax
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
524 table. It returns the value of the last form in @var{body}, after
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
525 restoring the old current syntax table.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
526
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
527 Since each buffer has its own current syntax table, we should make that
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
528 more precise: @code{with-syntax-table} temporarily alters the current
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
529 syntax table of whichever buffer is current at the time the macro
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
530 execution starts. Other buffers are not affected.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
531 @end defmac
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
532
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
533 @node Syntax Properties
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
534 @section Syntax Properties
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
535 @kindex syntax-table @r{(text property)}
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
536
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
537 When the syntax table is not flexible enough to specify the syntax of
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
538 a language, you can use @code{syntax-table} text properties to
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
539 override the syntax table for specific character occurrences in the
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
540 buffer. @xref{Text Properties}. You can use Font Lock mode to set
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
541 @code{syntax-table} text properties. @xref{Setting Syntax
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
542 Properties}.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
543
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
544 The valid values of @code{syntax-table} text property are:
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
545
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
546 @table @asis
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
547 @item @var{syntax-table}
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
548 If the property value is a syntax table, that table is used instead of
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
549 the current buffer's syntax table to determine the syntax for this
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
550 occurrence of the character.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
551
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
552 @item @code{(@var{syntax-code} . @var{matching-char})}
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
553 A cons cell of this format specifies the syntax for this
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
554 occurrence of the character. (@pxref{Syntax Table Internals})
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
555
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
556 @item @code{nil}
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
557 If the property is @code{nil}, the character's syntax is determined from
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
558 the current syntax table in the usual way.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
559 @end table
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
560
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
561 @defvar parse-sexp-lookup-properties
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
562 If this is non-@code{nil}, the syntax scanning functions pay attention
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
563 to syntax text properties. Otherwise they use only the current syntax
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
564 table.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
565 @end defvar
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
566
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
567 @node Motion and Syntax
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
568 @section Motion and Syntax
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
569
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
570 This section describes functions for moving across characters that
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
571 have certain syntax classes.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
572
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
573 @defun skip-syntax-forward syntaxes &optional limit
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
574 This function moves point forward across characters having syntax
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
575 classes mentioned in @var{syntaxes} (a string of syntax class
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
576 characters). It stops when it encounters the end of the buffer, or
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
577 position @var{limit} (if specified), or a character it is not supposed
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
578 to skip.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
579
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
580 If @var{syntaxes} starts with @samp{^}, then the function skips
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
581 characters whose syntax is @emph{not} in @var{syntaxes}.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
582
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
583 The return value is the distance traveled, which is a nonnegative
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
584 integer.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
585 @end defun
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
586
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
587 @defun skip-syntax-backward syntaxes &optional limit
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
588 This function moves point backward across characters whose syntax
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
589 classes are mentioned in @var{syntaxes}. It stops when it encounters
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
590 the beginning of the buffer, or position @var{limit} (if specified), or
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
591 a character it is not supposed to skip.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
592
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
593 If @var{syntaxes} starts with @samp{^}, then the function skips
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
594 characters whose syntax is @emph{not} in @var{syntaxes}.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
595
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
596 The return value indicates the distance traveled. It is an integer that
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
597 is zero or less.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
598 @end defun
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
599
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
600 @defun backward-prefix-chars
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
601 This function moves point backward over any number of characters with
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
602 expression prefix syntax. This includes both characters in the
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
603 expression prefix syntax class, and characters with the @samp{p} flag.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
604 @end defun
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
605
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
606 @node Parsing Expressions
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
607 @section Parsing Expressions
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
608
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
609 This section describes functions for parsing and scanning balanced
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
610 expressions, also known as @dfn{sexps}. Basically, a sexp is either a
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
611 balanced parenthetical grouping, a string, or a symbol name (a
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
612 sequence of characters whose syntax is either word constituent or
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
613 symbol constituent). However, characters whose syntax is expression
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
614 prefix are treated as part of the sexp if they appear next to it.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
615
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
616 The syntax table controls the interpretation of characters, so these
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
617 functions can be used for Lisp expressions when in Lisp mode and for C
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
618 expressions when in C mode. @xref{List Motion}, for convenient
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
619 higher-level functions for moving over balanced expressions.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
620
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
621 A character's syntax controls how it changes the state of the
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
622 parser, rather than describing the state itself. For example, a
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
623 string delimiter character toggles the parser state between
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
624 ``in-string'' and ``in-code,'' but the syntax of characters does not
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
625 directly say whether they are inside a string. For example (note that
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
626 15 is the syntax code for generic string delimiters),
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
627
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
628 @example
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
629 (put-text-property 1 9 'syntax-table '(15 . nil))
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
630 @end example
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
631
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
632 @noindent
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
633 does not tell Emacs that the first eight chars of the current buffer
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
634 are a string, but rather that they are all string delimiters. As a
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
635 result, Emacs treats them as four consecutive empty string constants.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
636
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
637 @menu
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
638 * Motion via Parsing:: Motion functions that work by parsing.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
639 * Position Parse:: Determining the syntactic state of a position.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
640 * Parser State:: How Emacs represents a syntactic state.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
641 * Low-Level Parsing:: Parsing across a specified region.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
642 * Control Parsing:: Parameters that affect parsing.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
643 @end menu
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
644
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
645 @node Motion via Parsing
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
646 @subsection Motion Commands Based on Parsing
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
647
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
648 This section describes simple point-motion functions that operate
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
649 based on parsing expressions.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
650
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
651 @defun scan-lists from count depth
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
652 This function scans forward @var{count} balanced parenthetical groupings
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
653 from position @var{from}. It returns the position where the scan stops.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
654 If @var{count} is negative, the scan moves backwards.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
655
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
656 If @var{depth} is nonzero, parenthesis depth counting begins from that
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
657 value. The only candidates for stopping are places where the depth in
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
658 parentheses becomes zero; @code{scan-lists} counts @var{count} such
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
659 places and then stops. Thus, a positive value for @var{depth} means go
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
660 out @var{depth} levels of parenthesis.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
661
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
662 Scanning ignores comments if @code{parse-sexp-ignore-comments} is
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
663 non-@code{nil}.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
664
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
665 If the scan reaches the beginning or end of the buffer (or its
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
666 accessible portion), and the depth is not zero, an error is signaled.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
667 If the depth is zero but the count is not used up, @code{nil} is
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
668 returned.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
669 @end defun
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
670
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
671 @defun scan-sexps from count
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
672 This function scans forward @var{count} sexps from position @var{from}.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
673 It returns the position where the scan stops. If @var{count} is
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
674 negative, the scan moves backwards.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
675
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
676 Scanning ignores comments if @code{parse-sexp-ignore-comments} is
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
677 non-@code{nil}.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
678
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
679 If the scan reaches the beginning or end of (the accessible part of) the
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
680 buffer while in the middle of a parenthetical grouping, an error is
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
681 signaled. If it reaches the beginning or end between groupings but
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
682 before count is used up, @code{nil} is returned.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
683 @end defun
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
684
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
685 @defun forward-comment count
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
686 This function moves point forward across @var{count} complete comments
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
687 (that is, including the starting delimiter and the terminating
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
688 delimiter if any), plus any whitespace encountered on the way. It
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
689 moves backward if @var{count} is negative. If it encounters anything
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
690 other than a comment or whitespace, it stops, leaving point at the
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
691 place where it stopped. This includes (for instance) finding the end
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
692 of a comment when moving forward and expecting the beginning of one.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
693 The function also stops immediately after moving over the specified
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
694 number of complete comments. If @var{count} comments are found as
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
695 expected, with nothing except whitespace between them, it returns
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
696 @code{t}; otherwise it returns @code{nil}.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
697
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
698 This function cannot tell whether the ``comments'' it traverses are
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
699 embedded within a string. If they look like comments, it treats them
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
700 as comments.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
701 @end defun
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
702
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
703 To move forward over all comments and whitespace following point, use
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
704 @code{(forward-comment (buffer-size))}. @code{(buffer-size)} is a good
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
705 argument to use, because the number of comments in the buffer cannot
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
706 exceed that many.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
707
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
708 @node Position Parse
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
709 @subsection Finding the Parse State for a Position
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
710
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
711 For syntactic analysis, such as in indentation, often the useful
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
712 thing is to compute the syntactic state corresponding to a given buffer
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
713 position. This function does that conveniently.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
714
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
715 @defun syntax-ppss &optional pos
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
716 This function returns the parser state (see next section) that the
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
717 parser would reach at position @var{pos} starting from the beginning
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
718 of the buffer. This is equivalent to @code{(parse-partial-sexp
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
719 (point-min) @var{pos})}, except that @code{syntax-ppss} uses a cache
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
720 to speed up the computation. Due to this optimization, the 2nd value
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
721 (previous complete subexpression) and 6th value (minimum parenthesis
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
722 depth) of the returned parser state are not meaningful.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
723 @end defun
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
724
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
725 @code{syntax-ppss} automatically hooks itself to
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
726 @code{before-change-functions} to keep its cache consistent. But
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
727 updating can fail if @code{syntax-ppss} is called while
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
728 @code{before-change-functions} is temporarily let-bound, or if the
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
729 buffer is modified without obeying the hook, such as when using
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
730 @code{inhibit-modification-hooks}. For this reason, it is sometimes
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
731 necessary to flush the cache manually.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
732
103264
b269cabac20c * syntax.texi (Position Parse): Document rationale for ignored
Chong Yidong <cyd@stupidchicken.com>
parents: 102922
diff changeset
733 @defun syntax-ppss-flush-cache beg &rest ignored-args
b269cabac20c * syntax.texi (Position Parse): Document rationale for ignored
Chong Yidong <cyd@stupidchicken.com>
parents: 102922
diff changeset
734 This function flushes the cache used by @code{syntax-ppss}, starting
b269cabac20c * syntax.texi (Position Parse): Document rationale for ignored
Chong Yidong <cyd@stupidchicken.com>
parents: 102922
diff changeset
735 at position @var{beg}. The remaining arguments, @var{ignored-args},
b269cabac20c * syntax.texi (Position Parse): Document rationale for ignored
Chong Yidong <cyd@stupidchicken.com>
parents: 102922
diff changeset
736 are ignored; this function accepts them so that it can be directly
b269cabac20c * syntax.texi (Position Parse): Document rationale for ignored
Chong Yidong <cyd@stupidchicken.com>
parents: 102922
diff changeset
737 used on hooks such as @code{before-change-functions} (@pxref{Change
b269cabac20c * syntax.texi (Position Parse): Document rationale for ignored
Chong Yidong <cyd@stupidchicken.com>
parents: 102922
diff changeset
738 Hooks}).
84102
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
739 @end defun
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
740
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
741 Major modes can make @code{syntax-ppss} run faster by specifying
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
742 where it needs to start parsing.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
743
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
744 @defvar syntax-begin-function
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
745 If this is non-@code{nil}, it should be a function that moves to an
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
746 earlier buffer position where the parser state is equivalent to
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
747 @code{nil}---in other words, a position outside of any comment,
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
748 string, or parenthesis. @code{syntax-ppss} uses it to further
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
749 optimize its computations, when the cache gives no help.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
750 @end defvar
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
751
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
752 @node Parser State
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
753 @subsection Parser State
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
754 @cindex parser state
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
755
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
756 A @dfn{parser state} is a list of ten elements describing the final
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
757 state of parsing text syntactically as part of an expression. The
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
758 parsing functions in the following sections return a parser state as
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
759 the value, and in some cases accept one as an argument also, so that
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
760 you can resume parsing after it stops. Here are the meanings of the
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
761 elements of the parser state:
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
762
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
763 @enumerate 0
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
764 @item
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
765 The depth in parentheses, counting from 0. @strong{Warning:} this can
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
766 be negative if there are more close parens than open parens between
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
767 the start of the defun and point.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
768
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
769 @item
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
770 @cindex innermost containing parentheses
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
771 The character position of the start of the innermost parenthetical
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
772 grouping containing the stopping point; @code{nil} if none.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
773
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
774 @item
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
775 @cindex previous complete subexpression
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
776 The character position of the start of the last complete subexpression
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
777 terminated; @code{nil} if none.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
778
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
779 @item
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
780 @cindex inside string
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
781 Non-@code{nil} if inside a string. More precisely, this is the
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
782 character that will terminate the string, or @code{t} if a generic
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
783 string delimiter character should terminate it.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
784
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
785 @item
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
786 @cindex inside comment
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
787 @code{t} if inside a comment (of either style),
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
788 or the comment nesting level if inside a kind of comment
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
789 that can be nested.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
790
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
791 @item
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
792 @cindex quote character
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
793 @code{t} if point is just after a quote character.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
794
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
795 @item
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
796 The minimum parenthesis depth encountered during this scan.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
797
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
798 @item
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
799 What kind of comment is active: @code{nil} for a comment of style
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
800 ``a'' or when not inside a comment, @code{t} for a comment of style
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
801 ``b,'' and @code{syntax-table} for a comment that should be ended by a
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
802 generic comment delimiter character.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
803
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
804 @item
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
805 The string or comment start position. While inside a comment, this is
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
806 the position where the comment began; while inside a string, this is the
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
807 position where the string began. When outside of strings and comments,
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
808 this element is @code{nil}.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
809
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
810 @item
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
811 Internal data for continuing the parsing. The meaning of this
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
812 data is subject to change; it is used if you pass this list
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
813 as the @var{state} argument to another call.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
814 @end enumerate
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
815
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
816 Elements 1, 2, and 6 are ignored in a state which you pass as an
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
817 argument to continue parsing, and elements 8 and 9 are used only in
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
818 trivial cases. Those elements serve primarily to convey information
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
819 to the Lisp program which does the parsing.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
820
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
821 One additional piece of useful information is available from a
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
822 parser state using this function:
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
823
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
824 @defun syntax-ppss-toplevel-pos state
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
825 This function extracts, from parser state @var{state}, the last
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
826 position scanned in the parse which was at top level in grammatical
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
827 structure. ``At top level'' means outside of any parentheses,
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
828 comments, or strings.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
829
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
830 The value is @code{nil} if @var{state} represents a parse which has
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
831 arrived at a top level position.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
832 @end defun
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
833
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
834 We have provided this access function rather than document how the
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
835 data is represented in the state, because we plan to change the
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
836 representation in the future.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
837
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
838 @node Low-Level Parsing
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
839 @subsection Low-Level Parsing
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
840
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
841 The most basic way to use the expression parser is to tell it
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
842 to start at a given position with a certain state, and parse up to
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
843 a specified end position.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
844
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
845 @defun parse-partial-sexp start limit &optional target-depth stop-before state stop-comment
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
846 This function parses a sexp in the current buffer starting at
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
847 @var{start}, not scanning past @var{limit}. It stops at position
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
848 @var{limit} or when certain criteria described below are met, and sets
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
849 point to the location where parsing stops. It returns a parser state
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
850 describing the status of the parse at the point where it stops.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
851
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
852 @cindex parenthesis depth
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
853 If the third argument @var{target-depth} is non-@code{nil}, parsing
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
854 stops if the depth in parentheses becomes equal to @var{target-depth}.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
855 The depth starts at 0, or at whatever is given in @var{state}.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
856
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
857 If the fourth argument @var{stop-before} is non-@code{nil}, parsing
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
858 stops when it comes to any character that starts a sexp. If
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
859 @var{stop-comment} is non-@code{nil}, parsing stops when it comes to the
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
860 start of a comment. If @var{stop-comment} is the symbol
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
861 @code{syntax-table}, parsing stops after the start of a comment or a
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
862 string, or the end of a comment or a string, whichever comes first.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
863
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
864 If @var{state} is @code{nil}, @var{start} is assumed to be at the top
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
865 level of parenthesis structure, such as the beginning of a function
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
866 definition. Alternatively, you might wish to resume parsing in the
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
867 middle of the structure. To do this, you must provide a @var{state}
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
868 argument that describes the initial status of parsing. The value
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
869 returned by a previous call to @code{parse-partial-sexp} will do
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
870 nicely.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
871 @end defun
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
872
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
873 @node Control Parsing
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
874 @subsection Parameters to Control Parsing
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
875
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
876 @defvar multibyte-syntax-as-symbol
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
877 If this variable is non-@code{nil}, @code{scan-sexps} treats all
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
878 non-@acronym{ASCII} characters as symbol constituents regardless
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
879 of what the syntax table says about them. (However, text properties
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
880 can still override the syntax.)
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
881 @end defvar
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
882
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
883 @defopt parse-sexp-ignore-comments
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
884 @cindex skipping comments
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
885 If the value is non-@code{nil}, then comments are treated as
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
886 whitespace by the functions in this section and by @code{forward-sexp},
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
887 @code{scan-lists} and @code{scan-sexps}.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
888 @end defopt
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
889
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
890 @vindex parse-sexp-lookup-properties
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
891 The behavior of @code{parse-partial-sexp} is also affected by
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
892 @code{parse-sexp-lookup-properties} (@pxref{Syntax Properties}).
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
893
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
894 You can use @code{forward-comment} to move forward or backward over
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
895 one comment or several comments.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
896
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
897 @node Standard Syntax Tables
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
898 @section Some Standard Syntax Tables
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
899
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
900 Most of the major modes in Emacs have their own syntax tables. Here
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
901 are several of them:
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
902
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
903 @defun standard-syntax-table
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
904 This function returns the standard syntax table, which is the syntax
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
905 table used in Fundamental mode.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
906 @end defun
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
907
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
908 @defvar text-mode-syntax-table
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
909 The value of this variable is the syntax table used in Text mode.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
910 @end defvar
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
911
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
912 @defvar c-mode-syntax-table
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
913 The value of this variable is the syntax table for C-mode buffers.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
914 @end defvar
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
915
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
916 @defvar emacs-lisp-mode-syntax-table
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
917 The value of this variable is the syntax table used in Emacs Lisp mode
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
918 by editing commands. (It has no effect on the Lisp @code{read}
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
919 function.)
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
920 @end defvar
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
921
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
922 @node Syntax Table Internals
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
923 @section Syntax Table Internals
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
924 @cindex syntax table internals
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
925
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
926 Lisp programs don't usually work with the elements directly; the
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
927 Lisp-level syntax table functions usually work with syntax descriptors
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
928 (@pxref{Syntax Descriptors}). Nonetheless, here we document the
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
929 internal format. This format is used mostly when manipulating
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
930 syntax properties.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
931
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
932 Each element of a syntax table is a cons cell of the form
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
933 @code{(@var{syntax-code} . @var{matching-char})}. The @sc{car},
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
934 @var{syntax-code}, is an integer that encodes the syntax class, and any
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
935 flags. The @sc{cdr}, @var{matching-char}, is non-@code{nil} if
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
936 a character to match was specified.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
937
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
938 This table gives the value of @var{syntax-code} which corresponds
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
939 to each syntactic type.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
940
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
941 @multitable @columnfractions .05 .3 .3 .31
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
942 @item
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
943 @tab
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
944 @i{Integer} @i{Class}
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
945 @tab
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
946 @i{Integer} @i{Class}
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
947 @tab
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
948 @i{Integer} @i{Class}
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
949 @item
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
950 @tab
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
951 0 @ @ whitespace
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
952 @tab
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
953 5 @ @ close parenthesis
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
954 @tab
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
955 10 @ @ character quote
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
956 @item
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
957 @tab
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
958 1 @ @ punctuation
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
959 @tab
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
960 6 @ @ expression prefix
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
961 @tab
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
962 11 @ @ comment-start
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
963 @item
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
964 @tab
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
965 2 @ @ word
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
966 @tab
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
967 7 @ @ string quote
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
968 @tab
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
969 12 @ @ comment-end
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
970 @item
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
971 @tab
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
972 3 @ @ symbol
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
973 @tab
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
974 8 @ @ paired delimiter
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
975 @tab
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
976 13 @ @ inherit
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
977 @item
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
978 @tab
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
979 4 @ @ open parenthesis
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
980 @tab
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
981 9 @ @ escape
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
982 @tab
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
983 14 @ @ generic comment
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
984 @item
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
985 @tab
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
986 15 @ generic string
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
987 @end multitable
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
988
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
989 For example, the usual syntax value for @samp{(} is @code{(4 . 41)}.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
990 (41 is the character code for @samp{)}.)
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
991
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
992 The flags are encoded in higher order bits, starting 16 bits from the
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
993 least significant bit. This table gives the power of two which
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
994 corresponds to each syntax flag.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
995
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
996 @multitable @columnfractions .05 .3 .3 .3
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
997 @item
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
998 @tab
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
999 @i{Prefix} @i{Flag}
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1000 @tab
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1001 @i{Prefix} @i{Flag}
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1002 @tab
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1003 @i{Prefix} @i{Flag}
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1004 @item
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1005 @tab
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1006 @samp{1} @ @ @code{(lsh 1 16)}
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1007 @tab
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1008 @samp{4} @ @ @code{(lsh 1 19)}
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1009 @tab
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1010 @samp{b} @ @ @code{(lsh 1 21)}
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1011 @item
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1012 @tab
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1013 @samp{2} @ @ @code{(lsh 1 17)}
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1014 @tab
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1015 @samp{p} @ @ @code{(lsh 1 20)}
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1016 @tab
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1017 @samp{n} @ @ @code{(lsh 1 22)}
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1018 @item
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1019 @tab
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1020 @samp{3} @ @ @code{(lsh 1 18)}
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1021 @end multitable
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1022
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1023 @defun string-to-syntax @var{desc}
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1024 This function returns the internal form corresponding to the syntax
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1025 descriptor @var{desc}, a cons cell @code{(@var{syntax-code}
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1026 . @var{matching-char})}.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1027 @end defun
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1028
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1029 @defun syntax-after pos
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1030 This function returns the syntax code of the character in the buffer
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1031 after position @var{pos}, taking account of syntax properties as well
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1032 as the syntax table. If @var{pos} is outside the buffer's accessible
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1033 portion (@pxref{Narrowing, accessible portion}), this function returns
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1034 @code{nil}.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1035 @end defun
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1036
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1037 @defun syntax-class syntax
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1038 This function returns the syntax class of the syntax code
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1039 @var{syntax}. (It masks off the high 16 bits that hold the flags
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1040 encoded in the syntax descriptor.) If @var{syntax} is @code{nil}, it
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1041 returns @code{nil}; this is so evaluating the expression
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1042
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1043 @example
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1044 (syntax-class (syntax-after pos))
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1045 @end example
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1046
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1047 @noindent
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1048 where @code{pos} is outside the buffer's accessible portion, will
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1049 yield @code{nil} without throwing errors or producing wrong syntax
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1050 class codes.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1051 @end defun
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1052
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1053 @node Categories
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1054 @section Categories
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1055 @cindex categories of characters
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1056 @cindex character categories
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1057
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1058 @dfn{Categories} provide an alternate way of classifying characters
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1059 syntactically. You can define several categories as needed, then
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1060 independently assign each character to one or more categories. Unlike
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1061 syntax classes, categories are not mutually exclusive; it is normal for
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1062 one character to belong to several categories.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1063
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1064 @cindex category table
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1065 Each buffer has a @dfn{category table} which records which categories
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1066 are defined and also which characters belong to each category. Each
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1067 category table defines its own categories, but normally these are
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1068 initialized by copying from the standard categories table, so that the
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1069 standard categories are available in all modes.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1070
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1071 Each category has a name, which is an @acronym{ASCII} printing character in
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1072 the range @w{@samp{ }} to @samp{~}. You specify the name of a category
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1073 when you define it with @code{define-category}.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1074
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1075 The category table is actually a char-table (@pxref{Char-Tables}).
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1076 The element of the category table at index @var{c} is a @dfn{category
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1077 set}---a bool-vector---that indicates which categories character @var{c}
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1078 belongs to. In this category set, if the element at index @var{cat} is
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1079 @code{t}, that means category @var{cat} is a member of the set, and that
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1080 character @var{c} belongs to category @var{cat}.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1081
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1082 For the next three functions, the optional argument @var{table}
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1083 defaults to the current buffer's category table.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1084
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1085 @defun define-category char docstring &optional table
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1086 This function defines a new category, with name @var{char} and
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1087 documentation @var{docstring}, for the category table @var{table}.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1088 @end defun
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1089
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1090 @defun category-docstring category &optional table
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1091 This function returns the documentation string of category @var{category}
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1092 in category table @var{table}.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1093
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1094 @example
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1095 (category-docstring ?a)
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1096 @result{} "ASCII"
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1097 (category-docstring ?l)
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1098 @result{} "Latin"
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1099 @end example
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1100 @end defun
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1101
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1102 @defun get-unused-category &optional table
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1103 This function returns a category name (a character) which is not
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1104 currently defined in @var{table}. If all possible categories are in use
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1105 in @var{table}, it returns @code{nil}.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1106 @end defun
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1107
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1108 @defun category-table
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1109 This function returns the current buffer's category table.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1110 @end defun
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1111
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1112 @defun category-table-p object
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1113 This function returns @code{t} if @var{object} is a category table,
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1114 otherwise @code{nil}.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1115 @end defun
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1116
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1117 @defun standard-category-table
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1118 This function returns the standard category table.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1119 @end defun
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1120
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1121 @defun copy-category-table &optional table
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1122 This function constructs a copy of @var{table} and returns it. If
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1123 @var{table} is not supplied (or is @code{nil}), it returns a copy of the
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1124 standard category table. Otherwise, an error is signaled if @var{table}
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1125 is not a category table.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1126 @end defun
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1127
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1128 @defun set-category-table table
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1129 This function makes @var{table} the category table for the current
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1130 buffer. It returns @var{table}.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1131 @end defun
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1132
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1133 @defun make-category-table
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1134 This creates and returns an empty category table. In an empty category
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1135 table, no categories have been allocated, and no characters belong to
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1136 any categories.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1137 @end defun
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1138
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1139 @defun make-category-set categories
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1140 This function returns a new category set---a bool-vector---whose initial
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1141 contents are the categories listed in the string @var{categories}. The
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1142 elements of @var{categories} should be category names; the new category
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1143 set has @code{t} for each of those categories, and @code{nil} for all
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1144 other categories.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1145
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1146 @example
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1147 (make-category-set "al")
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1148 @result{} #&128"\0\0\0\0\0\0\0\0\0\0\0\0\2\20\0\0"
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1149 @end example
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1150 @end defun
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1151
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1152 @defun char-category-set char
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1153 This function returns the category set for character @var{char} in the
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1154 current buffer's category table. This is the bool-vector which
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1155 records which categories the character @var{char} belongs to. The
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1156 function @code{char-category-set} does not allocate storage, because
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1157 it returns the same bool-vector that exists in the category table.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1158
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1159 @example
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1160 (char-category-set ?a)
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1161 @result{} #&128"\0\0\0\0\0\0\0\0\0\0\0\0\2\20\0\0"
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1162 @end example
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1163 @end defun
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1164
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1165 @defun category-set-mnemonics category-set
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1166 This function converts the category set @var{category-set} into a string
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1167 containing the characters that designate the categories that are members
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1168 of the set.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1169
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1170 @example
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1171 (category-set-mnemonics (char-category-set ?a))
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1172 @result{} "al"
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1173 @end example
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1174 @end defun
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1175
102922
bc1b7462d55e * syntax.texi (Syntax Table Functions): Document cons cell
Chong Yidong <cyd@stupidchicken.com>
parents: 100974
diff changeset
1176 @defun modify-category-entry char category &optional table reset
bc1b7462d55e * syntax.texi (Syntax Table Functions): Document cons cell
Chong Yidong <cyd@stupidchicken.com>
parents: 100974
diff changeset
1177 This function modifies the category set of @var{char} in category
84102
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1178 table @var{table} (which defaults to the current buffer's category
102922
bc1b7462d55e * syntax.texi (Syntax Table Functions): Document cons cell
Chong Yidong <cyd@stupidchicken.com>
parents: 100974
diff changeset
1179 table). @var{char} can be a character, or a cons cell of the form
bc1b7462d55e * syntax.texi (Syntax Table Functions): Document cons cell
Chong Yidong <cyd@stupidchicken.com>
parents: 100974
diff changeset
1180 @code{(@var{min} . @var{max})}; in the latter case, the function
bc1b7462d55e * syntax.texi (Syntax Table Functions): Document cons cell
Chong Yidong <cyd@stupidchicken.com>
parents: 100974
diff changeset
1181 modifies the category sets of all characters in the range between
bc1b7462d55e * syntax.texi (Syntax Table Functions): Document cons cell
Chong Yidong <cyd@stupidchicken.com>
parents: 100974
diff changeset
1182 @var{min} and @var{max}, inclusive.
84102
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1183
102922
bc1b7462d55e * syntax.texi (Syntax Table Functions): Document cons cell
Chong Yidong <cyd@stupidchicken.com>
parents: 100974
diff changeset
1184 Normally, it modifies a category set by adding @var{category} to it.
84102
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1185 But if @var{reset} is non-@code{nil}, then it deletes @var{category}
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1186 instead.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1187 @end defun
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1188
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1189 @deffn Command describe-categories &optional buffer-or-name
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1190 This function describes the category specifications in the current
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1191 category table. It inserts the descriptions in a buffer, and then
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1192 displays that buffer. If @var{buffer-or-name} is non-@code{nil}, it
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1193 describes the category table of that buffer instead.
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1194 @end deffn
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1195
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1196 @ignore
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1197 arch-tag: 4d914e96-0283-445c-9233-75d33662908c
63784ce1491a Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1198 @end ignore