/
amsmath.el
285 lines (253 loc) · 10.8 KB
/
amsmath.el
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
;;; amsmath.el --- Style hook for the AMS-LaTeX amsmath package. -*- lexical-binding: t; -*-
;; Copyright (C) 2002, 2005-2007, 2012-2014, 2017-2020, 2022
;; Free Software Foundation, Inc.
;; FIXME: What about the copyright for <= 2001?
;; Author: Carsten Dominik <dominik@strw.leidenuniv.nl>
;; Maintainer: auctex-devel@gnu.org
;; This file is part of AUCTeX.
;; AUCTeX is free software; you can redistribute it and/or modify it
;; under the terms of the GNU General Public License as published by
;; the Free Software Foundation; either version 3, or (at your option)
;; any later version.
;; AUCTeX is distributed in the hope that it will be useful, but
;; WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
;; General Public License for more details.
;; You should have received a copy of the GNU General Public License
;; along with AUCTeX; see the file COPYING. If not, write to the Free
;; Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
;; 02110-1301, USA.
;;; Commentary:
;; This will also load the amstext, amsbsy and amsopn style files.
;;; Code:
(require 'tex)
(require 'latex)
;; Fontification
(declare-function font-latex-add-keywords
"font-latex"
(keywords class))
(TeX-add-style-hook
"amsmath"
(lambda ()
(LaTeX-add-environments
'("align" LaTeX-env-label)
'("gather" LaTeX-env-label)
'("flalign" LaTeX-env-label)
'("multline" LaTeX-env-label)
'("alignat" LaTeX-amsmath-env-alignat)
'("alignat*" LaTeX-amsmath-env-alignat)
'("xalignat" LaTeX-amsmath-env-alignat)
'("xalignat*" LaTeX-amsmath-env-alignat)
'("xxalignat" LaTeX-amsmath-env-alignat)
'("aligned" ["Vertical position (t or b)"])
'("gathered" ["Vertical position (t or b)"])
'("alignedat" LaTeX-amsmath-env-alignedat)
"align*" "gather*" "flalign*" "multline*" "equation*"
"split"
"cases"
"matrix" "smallmatrix"
"bmatrix" "Bmatrix" "pmatrix" "vmatrix" "Vmatrix"
"subequations"
'("subarray" "Alignment"))
(TeX-add-symbols
'("eqref" TeX-arg-ref)
'("numberwithin" TeX-arg-counter "Section level")
'("raisetag" "Dimension")
'("shoveright" t) '("shoveleft" t)
'("intertext" t)
'("hdotsfor" ["Stretch"] "Number of columns to cover")
'("xleftarrow" ["Below"] "Above")
'("xrightarrow" ["Below"] "Above")
'("overset" "Above symbol" "Symbol")
'("underset" "Below symbol" "Symbol")
'("overunderset" "Above symbol" "Below symbol" "Symbol")
'("dfrac" 2)
'("tfrac" 2)
'("binom" 2)
'("dbinom" 2)
'("tbinom" 2)
'("genfrac" "Left delimiter" "Right delimiter" "Thickness"
"Mathstyle" 2)
'("cfrac" ["position (l or r)"] 2)
'("smash" ["where (t or b)"] t)
'("sideset" "Left" "Right")
'("tag" "(Tag)")
'("tag*" "Tag")
'("displaybreak" ["Weight (0..4)"])
'("allowdisplaybreaks" ["Weight (1..4)"])
'("substack" t)
'("leftroot" "Push root index left by")
'("uproot" "Push root index upward by")
'("boxed" t)
'("mspace" t)
'("mod" t)
'("pmod" t)
'("pod" t)
'("overleftrightarrow" t)
'("underleftarrow" t)
'("underrightarrow" t)
'("underleftrightarrow" t)
'("dddot" t)
'("ddddot" t)
"bmod" "notag"
"dots" "dotsb" "dotsc" "dotsi" "dotsm" "dotso" "nobreakdash"
'("lvert" TeX-arg-insert-right-brace-maybe)
'("lVert" TeX-arg-insert-right-brace-maybe)
"rvert" "rVert"
"iint" "iiint" "iiiint" "idotsint")
(setq LaTeX-item-list
(append '(("split" . LaTeX-item-equation)
("multline" . LaTeX-item-equation)
("multline*" . LaTeX-item-equation)
("gather" . LaTeX-item-equation)
("gather*" . LaTeX-item-equation)
("gathered" . LaTeX-item-equation)
("align" . LaTeX-item-equation)
("align*" . LaTeX-item-equation)
("aligned" . LaTeX-item-equation)
("alignat" . LaTeX-item-equation-alignat)
("alignat*" . LaTeX-item-equation-alignat)
("xalignat" . LaTeX-item-equation-alignat)
("xalignat*" . LaTeX-item-equation-alignat)
("xxalignat" . LaTeX-item-equation-alignat)
("alignedat" . LaTeX-item-equation-alignat)
("flalign" . LaTeX-item-equation)
("flalign*" . LaTeX-item-equation)
("matrix" . LaTeX-item-equation-matrix)
("pmatrix" . LaTeX-item-equation-matrix)
("bmatrix" . LaTeX-item-equation-matrix)
("Bmatrix" . LaTeX-item-equation-matrix)
("vmatrix" . LaTeX-item-equation-matrix)
("Vmatrix" . LaTeX-item-equation-matrix)
("smallmatrix" . LaTeX-item-equation-matrix)
("subarray" . LaTeX-item-equation)
("cases" . LaTeX-item-equation))
LaTeX-item-list))
;; When `LaTeX-amsmath-label' is nil, use value of LaTeX-equation-label:
(unless LaTeX-amsmath-label
(setq LaTeX-amsmath-label LaTeX-equation-label))
(setq LaTeX-label-alist
;; Append amsmath environments to `LaTeX-label-alist', in order not to
;; override possible custome values.
(append LaTeX-label-alist
'(("align" . LaTeX-amsmath-label)
("alignat" . LaTeX-amsmath-label)
("xalignat" . LaTeX-amsmath-label)
("multline" . LaTeX-amsmath-label)
("flalign" . LaTeX-amsmath-label)
("gather" . LaTeX-amsmath-label))))
(set (make-local-variable 'TeX-braces-association)
(append '(("\\lvert" . "\\rvert")
("\\lVert" . "\\rVert"))
TeX-braces-association))
(set (make-local-variable 'TeX-left-right-braces)
(append '(("\\lvert") ("\\rvert") ("\\lVert") ("\\rVert"))
TeX-left-right-braces))
;; amsmath includes amstext, amsbsy, & amsopn.
;; So we run their hooks, too.
(TeX-run-style-hooks "amstext" "amsbsy" "amsopn")
;; RefTeX support: Tell RefTeX about amsmath environments.
(when (fboundp 'reftex-add-to-label-alist)
(reftex-add-to-label-alist '(AMSTeX)))
;; Add \eqref to `reftex-ref-style-alist' and associate it to `e'
(when (and (boundp 'reftex-ref-style-alist)
;; check if Emacs is already equipped with this
(not (assoc "AMSmath" reftex-ref-style-alist)))
;; Append it to a local version in order to avoid a clash with
;; user settings
(add-to-list (make-local-variable 'reftex-ref-style-alist)
'("AMSmath" "amsmath" (("\\eqref" ?e)))
t))
;; Activate `AMSmath' when `LaTeX-reftex-ref-style-auto-activate'
;; is non-nil
(and LaTeX-reftex-ref-style-auto-activate
(fboundp 'reftex-ref-style-activate)
(reftex-ref-style-activate "AMSmath"))
(when (and (featurep 'font-latex)
(eq TeX-install-font-lock 'font-latex-setup))
(font-latex-add-keywords '(("boxed" "{"))
'math-command)))
TeX-dialect)
(defun LaTeX-amsmath-env-alignat (env)
"Insert ENV with column number specifications.
Insert suitable number of ampersands also if possible."
(let ((ncols (TeX-read-string "Number of columns: ")))
(LaTeX-insert-environment env (concat TeX-grop ncols TeX-grcl))
(LaTeX-item-equation-alignat t)))
(defun LaTeX-amsmath-env-alignedat (env)
"Insert ENV with position and column number specifications.
Insert suitable number of ampersands also if possible."
(let ((where (TeX-read-string "(Optional) Vertical position (t or b): "))
(ncols (TeX-read-string "Number of columns: ")))
(unless (string= where "")
(setq where (concat LaTeX-optop where LaTeX-optcl)))
(LaTeX-insert-environment env (concat where TeX-grop ncols TeX-grcl))
(LaTeX-item-equation-alignat t)))
(defun LaTeX-item-equation (&optional suppress)
"Insert contents to terminate a line in multi-line equations environment.
Put line break macro on the last line. If the current environment
wants \\label, insert it also.
If SUPPRESS is non-nil, do not insert line break macro."
(unless suppress
(end-of-line 0)
(just-one-space)
(TeX-insert-macro "\\")
(forward-line 1)
(indent-according-to-mode))
(let ((env (LaTeX-current-environment)))
(when (and (assoc env LaTeX-label-alist)
(LaTeX-label env 'environment))
(LaTeX-newline)
(indent-according-to-mode))))
(defun LaTeX-item-equation-matrix ()
"Insert contents to terminate a line in matrix environments.
Put line break macro on the last line and insert suitable number
of ampersands if possible. This number is extracted from the
first line of the environment."
(end-of-line 0)
(just-one-space)
(TeX-insert-macro "\\")
(forward-line 1)
(indent-according-to-mode)
(let* ((p (point))
(s (save-excursion
(LaTeX-find-matching-begin)
(point)))
(e (save-excursion
(goto-char s)
(search-forward "\\\\" p t)))
n)
(save-excursion
(goto-char s)
(setq n (how-many "[^\\]&" s e)))
(when (and n (> n 0))
(save-excursion
(insert (make-string n ?&))))))
(defun LaTeX-item-equation-alignat (&optional suppress)
"Insert contents to terminate a line in multi-line equations environment.
Put line break macro on the last line. Next, if the current
environment wants \\label, insert it also. And insert suitable number
of ampersands if possible.
If SUPPRESS is non-nil, do not insert line break macro."
(LaTeX-item-equation suppress)
(LaTeX-insert-ampersands
(concat "\\(?:"
(regexp-quote LaTeX-optop) "[tb]" (regexp-quote LaTeX-optcl)
"\\)?")
#'LaTeX-amsmath-alignat-number-of-ampersands))
(defun LaTeX-amsmath-alignat-number-of-ampersands (start end)
"Return the number of ampersands to insert.
The number is 2N-1 where N is the number taken from the text between
START and END."
(let ((num (string-to-number (buffer-substring-no-properties start end))))
(if (integerp num) (+ num num -1))))
(defvar LaTeX-amsmath-package-options '("intlimits" "nointlimits"
"sumlimits" "nosumlimits"
"namelimits" "nonamelimits"
"leqno" "reqno" "centertags"
"tbtags" "cmex10" "fleqn" "?"
"alignedleftspaceyes"
"alignedleftspaceno"
"alignedleftspaceyesifneg")
"Package options for the amsmath package.")
;;; amsmath.el ends here.