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
|
;;; environ.el --- AUCTeX style for `environ.sty' version v0.3 -*- lexical-binding: t; -*-
;; Copyright (C) 2015, 2016, 2018, 2020 Free Software Foundation, Inc.
;; Author: Arash Esbati <arash@gnu.org>
;; Maintainer: auctex-devel@gnu.org
;; Created: 2015-07-04
;; Keywords: tex
;; 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 file adds support for `environ.sty' version v0.3 from
;; 2014/05/04. `environ.sty' is part of TeXLive.
;; Name of new env's defined with `\NewEnviron' are automatically
;; added to list of known env's, e.g.:
;;
;; \NewEnviron{test}{<macro code>}
;;
;; `test' will be in completion list upon `C-c C-e'.
;; More sophisticated definions must go through AUCTeX's parser, e.g.:
;;
;; \NewEnviron{test}[2][]{<macro code>}
;;
;; After a definition like this, you have to invoke `C-c C-n' to get
;; the correct completion.
;;; Code:
(require 'tex)
(require 'latex)
;; Silence the compiler:
(declare-function font-latex-add-keywords
"font-latex"
(keywords class))
(defvar LaTeX-auto-environ-NewEnviron nil
"Temporary for parsing the arguments of `\\NewEnviron'
from `environ' package.")
(defvar LaTeX-environ-NewEnviron-regexp
`(,(concat "\\\\\\(?:Ren\\|N\\)ewEnviron"
"[ \t\n\r]*{\\([A-Za-z0-9]+\\)}%?"
"[ \t\n\r]*\\[?\\([0-9]?\\)\\]?%?"
"[ \t\n\r]*\\(\\[\\)?")
(1 2 3) LaTeX-auto-environ-NewEnviron)
"Matches the argument of `\\NewEnviron' and `\\RenewEnviron'
from `environ.sty'.")
(defun LaTeX-environ-auto-prepare ()
"Clear temporary variable from `environ.sty' before parsing."
(setq LaTeX-auto-environ-NewEnviron nil))
(defun LaTeX-environ-auto-cleanup ()
"Process the parsed results of `\\NewEnviron'."
(dolist (env-args LaTeX-auto-environ-NewEnviron)
(let ((env (car env-args))
(args (cadr env-args))
(opt (nth 2 env-args)))
(cond (;; opt. 1st argument and mandatory argument(s)
(and args (not (string-equal args ""))
opt (not (string-equal opt "")))
(add-to-list 'LaTeX-auto-environment
(list env 'LaTeX-env-args (vector "argument")
(1- (string-to-number args)))))
(;; mandatory argument(s) only
(and args (not (string-equal args ""))
(string-equal opt ""))
(add-to-list 'LaTeX-auto-environment
(list env (string-to-number args))))
(t ; No args
(add-to-list 'LaTeX-auto-environment (list env)))))))
(add-hook 'TeX-auto-prepare-hook #'LaTeX-environ-auto-prepare t)
(add-hook 'TeX-auto-cleanup-hook #'LaTeX-environ-auto-cleanup t)
(add-hook 'TeX-update-style-hook #'TeX-auto-parse t)
(defun TeX-arg-environ-final-code (_optional)
"Query for the presence of optional `final code' as argument to
`\\NewEnviron' and insert the appropriate brackets."
(let ((fincode (y-or-n-p "With optional final code? ")))
(when fincode
(insert "[]"))))
(TeX-add-style-hook
"environ"
(lambda ()
;; Add it to the parser
(TeX-auto-add-regexp LaTeX-environ-NewEnviron-regexp)
(TeX-add-symbols
;; \NewEnviron{<name>}[<No.args>][<Opt.arg.>]{<Macro code>}[<Final code>]
'("NewEnviron"
(TeX-arg-define-environment "Environment")
[ "Number of arguments" ] [ "argument" ] t TeX-arg-environ-final-code)
'("RenewEnviron"
(TeX-arg-environment "Environment")
[ "Number of arguments" ] [ "argument" ] t TeX-arg-environ-final-code)
;; Insert a pair of braces and we're done
'("environfinalcode" t)
;; Pre-defined
'("BODY")
;; Define another macro instead of \BODY
'("environbodyname" TeX-arg-define-macro))
;; Fontification
(when (and (featurep 'font-latex)
(eq TeX-install-font-lock 'font-latex-setup))
(font-latex-add-keywords '(("NewEnviron" "{[[{[")
("RenewEnviron" "{[[{[")
("environbodyname" "|{\\"))
'function)))
TeX-dialect)
(defvar LaTeX-environ-package-options nil
"Package options for the environ package.")
;;; environ.el ends here
|
