File: doc.el

package info (click to toggle)
auctex 11.91-2
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 5,952 kB
  • sloc: lisp: 45,907; makefile: 890; sh: 112; perl: 90
file content (193 lines) | stat: -rw-r--r-- 5,312 bytes parent folder | download | duplicates (2)
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
;;; doc.el --- AUCTeX style for `doc.sty'

;; Copyright (C) 2004, 2008, 2016 Free Software Foundation, Inc.

;; Author: Frank Kster <frank@kuesterei.ch>
;; Maintainer: auctex-devel@gnu.org
;; 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 `doc.sty'.

;;; Code:

(defun LaTeX-env-no-comment (environment)
  "Insert ENVIRONMENT and make sure there is no commented empty line inside."
  (LaTeX-insert-environment environment
			    (when (string-equal environment "macro")
			      (let ((macroname (TeX-read-string
						(TeX-argument-prompt nil nil "Macro")
						TeX-esc)))
				(format "{%s}" macroname))))
  (unless (TeX-active-mark)
    (when (save-excursion
	    (beginning-of-line)
	    (looking-at (concat "[ \t]+$\\|[ \t]*"
				TeX-comment-start-regexp "+[ \t]*$")))
      (delete-region (line-beginning-position) (line-end-position))
      (indent-according-to-mode))))

(defun LaTeX-doc-after-insert-macrocode (env start end)
  "Make sure the macrocode environment is properly formatted after insertion."
  (when (TeX-member env '("macro" "macrocode" "macrocode*") 'string-equal)
    (save-excursion
      (goto-char end)
      (skip-chars-backward " \t")
      (when (bolp)
	(insert "%")
	(indent-according-to-mode))
      (goto-char start)
      (skip-chars-backward " \t")
      (when (bolp)
	(insert "%")
	(indent-according-to-mode)))))

(TeX-add-style-hook
 "doc"
 (lambda ()
   (add-to-list (make-local-variable 'LaTeX-indent-environment-list)
		'("macrocode" current-indentation) t)
   (add-to-list 'LaTeX-indent-environment-list
		'("macrocode*" current-indentation) t)
   (add-to-list 'LaTeX-indent-environment-list
		'("macro" current-indentation) t)
   (add-hook 'LaTeX-after-insert-env-hooks 'LaTeX-doc-after-insert-macrocode
	     nil t)
   (LaTeX-add-environments
    "theglossary"
    '("macrocode" LaTeX-env-no-comment)
    '("macrocode*" LaTeX-env-no-comment)
    '("macro" LaTeX-env-no-comment))
   (TeX-add-symbols
    "EnableCrossrefs"
    "DisableCrossrefs"
    '("DoNotIndex" t)
    "DontCheckModules"
    "CheckModules"
    "Module"
    '("DescribeMacro" (TeX-arg-eval
		       (lambda ()
			 (let ((name (TeX-read-string
				      (TeX-argument-prompt optional nil "Macro")
				      TeX-esc)))
			   (format "%s" name)))))
    '("DescribeEnv" "Environment")
    "verbatim"
    "verb"
    '("parg" "Argument")
    '("oarg" "Argument")
    '("marg" "Argument")
    '("meta" "Text")
    '("cs" "Name")
    '("cmd" (TeX-arg-eval
	     (lambda ()
	       (let ((name (TeX-read-string
			    (TeX-argument-prompt optional nil "Name")
			    TeX-esc)))
		 (format "%s" name)))))
    "makelabel"
    '("MacroFont" t)
    '("AltMacroFont" t)
    "PrintMacroName"
    "PrintDescribeMacro"
    "PrintDescribeEnv"
    "PrintEnvName"
    "MakePrivateLetters"
    "actualchar"
    "quotechar"
    "levelchar"
    "encapchar"
    "verbatimchar"
    "SpecialIndex"
    "SpecialMainIndex"
    "SpecialMainEnvIndex"
    "SpecialUsageIndex"
    "SpecialEnvIndex"
    "SortIndex"
    "LeftBraceIndex"
    "RightBraceIndex"
    "PercentIndex"
    "OldMakeindex"
    "PercentIndex"
    "IndexPrologue"
    "IndexParms"
    "subitem"
    "subsubitem"
    "indexspace"
    "efill"
    "pfill"
    "PrintIndex"
    '("changes" "version" TeX-arg-date t)
    "generalname"
    "RecordChanges"
    "GlossaryPrologue"
    "GlossaryParms"
    "PrintChanges"
    "AlsoImplementation"
    '("StopEventually" t)
    "OnlyDescription"
    "Finale"
    "IndexInput"
    "maketitle"
    "MakeShortVerb"
    "DeleteShortVerb"
    "MakeShortverb"
    "DeleteShortverb"
    "CheckSum"
    "CharacterTable"
    "CharTableChanges"
    "CodelineNumbered"
    "CodelineIndex"
    "PageIndex"
    "theCodelineNo"
    "DocstyleParms"
    "MakePercentIgnore"
    "MakePercentComment"
    '("DocInput"
      (TeX-arg-eval
       (lambda ()
	 (let ((file (file-relative-name
		      (read-file-name
		       "File to input: " nil nil nil nil
		       (lambda (x)
			 (string-match "\\.fdd$\\|\\.dtx$" x)))
		      (TeX-master-directory))))
	   (format "%s" file)))))
    '("DocInclude"
      (TeX-arg-eval
       (lambda ()
	 (let ((file (file-relative-name
		      (read-file-name
		       "File to include: " nil nil nil nil
		       (lambda (x)
			 (string-match "\\.fdd$\\|\\.dtx$" x)))
		      (TeX-master-directory))))
	   (format "%s" file)))))
    "GetFileInfo"
    "filename"
    "fileinfo")
   (TeX-run-style-hooks "shortvrb")
   (LaTeX-add-lengths "MacrocodeTopsep" "MacroTopsep" "MacroIndent"))
 LaTeX-dialect)

;; Local Variables:
;; coding: iso-8859-1
;; End: