Commit | Line | Data |
---|---|---|
94e9c286 SM |
1 | ;;; rst.el --- Mode for viewing and editing reStructuredText-documents. |
2 | ||
ab422c4d | 3 | ;; Copyright (C) 2003-2013 Free Software Foundation, Inc. |
94e9c286 | 4 | |
d13c8be6 | 5 | ;; Maintainer: Stefan Merten <smerten@oekonux.de> |
6d3f7c2f SM |
6 | ;; Author: Stefan Merten <smerten@oekonux.de>, |
7 | ;; Martin Blais <blais@furius.ca>, | |
d13c8be6 SM |
8 | ;; David Goodger <goodger@python.org>, |
9 | ;; Wei-Wei Guo <wwguocn@gmail.com> | |
94e9c286 SM |
10 | |
11 | ;; This file is part of GNU Emacs. | |
12 | ||
13 | ;; GNU Emacs is free software: you can redistribute it and/or modify | |
14 | ;; it under the terms of the GNU General Public License as published by | |
15 | ;; the Free Software Foundation, either version 3 of the License, or | |
16 | ;; (at your option) any later version. | |
17 | ||
18 | ;; GNU Emacs is distributed in the hope that it will be useful, | |
19 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
20 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
21 | ;; GNU General Public License for more details. | |
22 | ||
23 | ;; You should have received a copy of the GNU General Public License | |
24 | ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. | |
25 | ||
26 | ;;; Commentary: | |
27 | ||
d13c8be6 | 28 | ;; This package provides major mode rst-mode, which supports documents marked |
6d3f7c2f SM |
29 | ;; up using the reStructuredText format. Support includes font locking as well |
30 | ;; as a lot of convenience functions for editing. It does this by defining a | |
31 | ;; Emacs major mode: rst-mode (ReST). This mode is derived from text-mode. | |
32 | ;; This package also contains: | |
94e9c286 SM |
33 | ;; |
34 | ;; - Functions to automatically adjust and cycle the section underline | |
d13c8be6 | 35 | ;; adornments; |
94e9c286 SM |
36 | ;; - A mode that displays the table of contents and allows you to jump anywhere |
37 | ;; from it; | |
38 | ;; - Functions to insert and automatically update a TOC in your source | |
39 | ;; document; | |
d13c8be6 SM |
40 | ;; - Function to insert list, processing item bullets and enumerations |
41 | ;; automatically; | |
42 | ;; - Font-lock highlighting of most reStructuredText structures; | |
43 | ;; - Indentation and filling according to reStructuredText syntax; | |
44 | ;; - Cursor movement according to reStructuredText syntax; | |
94e9c286 SM |
45 | ;; - Some other convenience functions. |
46 | ;; | |
47 | ;; See the accompanying document in the docutils documentation about | |
48 | ;; the contents of this package and how to use it. | |
49 | ;; | |
50 | ;; For more information about reStructuredText, see | |
51 | ;; http://docutils.sourceforge.net/rst.html | |
52 | ;; | |
53 | ;; For full details on how to use the contents of this file, see | |
54 | ;; http://docutils.sourceforge.net/docs/user/emacs.html | |
55 | ;; | |
56 | ;; | |
6d3f7c2f | 57 | ;; There are a number of convenient key bindings provided by rst-mode. |
b4747519 | 58 | ;; For more on bindings, see rst-mode-map below. There are also many variables |
d13c8be6 | 59 | ;; that can be customized, look for defcustom in this file. |
94e9c286 SM |
60 | ;; |
61 | ;; If you use the table-of-contents feature, you may want to add a hook to | |
6d3f7c2f | 62 | ;; update the TOC automatically every time you adjust a section title:: |
94e9c286 SM |
63 | ;; |
64 | ;; (add-hook 'rst-adjust-hook 'rst-toc-update) | |
65 | ;; | |
b4747519 SM |
66 | ;; Syntax highlighting: font-lock is enabled by default. If you want to turn |
67 | ;; off syntax highlighting to rst-mode, you can use the following:: | |
94e9c286 SM |
68 | ;; |
69 | ;; (setq font-lock-global-modes '(not rst-mode ...)) | |
70 | ;; | |
94e9c286 | 71 | ;; |
94e9c286 | 72 | ;; |
d13c8be6 | 73 | ;; Customization is done by customizable variables contained in customization |
6d3f7c2f | 74 | ;; group "rst" and subgroups. Group "rst" is contained in the "wp" group. |
94e9c286 | 75 | ;; |
94e9c286 SM |
76 | |
77 | ;;; DOWNLOAD | |
78 | ||
d13c8be6 SM |
79 | ;; The latest release of this file lies in the docutils source code repository: |
80 | ;; http://docutils.svn.sourceforge.net/svnroot/docutils/trunk/docutils/tools/editors/emacs/rst.el | |
94e9c286 SM |
81 | |
82 | ;;; INSTALLATION | |
83 | ||
865fe16f | 84 | ;; Add the following lines to your init file: |
94e9c286 SM |
85 | ;; |
86 | ;; (require 'rst) | |
87 | ;; | |
88 | ;; If you are using `.txt' as a standard extension for reST files as | |
89 | ;; http://docutils.sourceforge.net/FAQ.html#what-s-the-standard-filename-extension-for-a-restructuredtext-file | |
90 | ;; suggests you may use one of the `Local Variables in Files' mechanism Emacs | |
b4747519 | 91 | ;; provides to set the major mode automatically. For instance you may use:: |
94e9c286 SM |
92 | ;; |
93 | ;; .. -*- mode: rst -*- | |
94 | ;; | |
b4747519 SM |
95 | ;; in the very first line of your file. The following code is useful if you |
96 | ;; want automatically enter rst-mode from any file with compatible extensions: | |
94e9c286 SM |
97 | ;; |
98 | ;; (setq auto-mode-alist | |
6d3f7c2f SM |
99 | ;; (append '(("\\.txt\\'" . rst-mode) |
100 | ;; ("\\.rst\\'" . rst-mode) | |
101 | ;; ("\\.rest\\'" . rst-mode)) auto-mode-alist)) | |
94e9c286 SM |
102 | ;; |
103 | ||
d13c8be6 | 104 | ;;; Code: |
94e9c286 | 105 | |
64f6a736 SM |
106 | ;; FIXME: Check through major mode conventions again. |
107 | ||
1f45e27e SM |
108 | ;; FIXME: Add proper ";;;###autoload" comments. |
109 | ||
7ae2ea10 SM |
110 | ;; FIXME: When 24.1 is common place remove use of `lexical-let' and put "-*- |
111 | ;; lexical-binding: t -*-" in the first line. | |
112 | ||
64f6a736 SM |
113 | ;; FIXME: Use `testcover'. |
114 | ||
ee97deee SM |
115 | ;; FIXME: The adornment classification often called `ado' should be a |
116 | ;; `defstruct'. | |
117 | ||
64f6a736 SM |
118 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; |
119 | ;; Support for `testcover' | |
120 | ||
70efc5c9 SM |
121 | (when (and (boundp 'testcover-1value-functions) |
122 | (boundp 'testcover-compose-functions)) | |
64f6a736 SM |
123 | ;; Below `lambda' is used in a loop with varying parameters and is thus not |
124 | ;; 1valued. | |
125 | (setq testcover-1value-functions | |
126 | (delq 'lambda testcover-1value-functions)) | |
127 | (add-to-list 'testcover-compose-functions 'lambda)) | |
128 | ||
129 | (defun rst-testcover-defcustom () | |
130 | "Remove all customized variables from `testcover-module-constants'. | |
131 | This seems to be a bug in `testcover': `defcustom' variables are | |
132 | considered constants. Revert it with this function after each `defcustom'." | |
133 | (when (boundp 'testcover-module-constants) | |
134 | (setq testcover-module-constants | |
135 | (delq nil | |
136 | (mapcar | |
137 | (lambda (sym) | |
138 | (if (not (plist-member (symbol-plist sym) 'standard-value)) | |
139 | sym)) | |
140 | testcover-module-constants))))) | |
141 | ||
142 | (defun rst-testcover-add-compose (fun) | |
143 | "Add FUN to `testcover-compose-functions'." | |
144 | (when (boundp 'testcover-compose-functions) | |
145 | (add-to-list 'testcover-compose-functions fun))) | |
146 | ||
147 | (defun rst-testcover-add-1value (fun) | |
148 | "Add FUN to `testcover-1value-functions'." | |
149 | (when (boundp 'testcover-1value-functions) | |
150 | (add-to-list 'testcover-1value-functions fun))) | |
151 | ||
152 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; | |
153 | ;; Common Lisp stuff | |
154 | ||
7b4cdbf4 SM |
155 | ;; Only use of macros is allowed - may be replaced by `cl-lib' some time. |
156 | (eval-when-compile | |
157 | (require 'cl)) | |
158 | ||
159 | ;; Redefine some functions from `cl.el' in a proper namespace until they may be | |
160 | ;; used from there. | |
161 | ||
162 | (defun rst-signum (x) | |
163 | "Return 1 if X is positive, -1 if negative, 0 if zero." | |
164 | (cond | |
165 | ((> x 0) 1) | |
166 | ((< x 0) -1) | |
167 | (t 0))) | |
168 | ||
169 | (defun rst-some (seq &optional pred) | |
170 | "Return non-nil if any element of SEQ yields non-nil when PRED is applied. | |
171 | Apply PRED to each element of list SEQ until the first non-nil | |
1f45e27e | 172 | result is yielded and return this result. PRED defaults to |
7b4cdbf4 SM |
173 | `identity'." |
174 | (unless pred | |
175 | (setq pred 'identity)) | |
176 | (catch 'rst-some | |
177 | (dolist (elem seq) | |
178 | (let ((r (funcall pred elem))) | |
179 | (when r | |
180 | (throw 'rst-some r)))))) | |
181 | ||
182 | (defun rst-position-if (pred seq) | |
183 | "Return position of first element satisfying PRED in list SEQ or nil." | |
184 | (catch 'rst-position-if | |
185 | (let ((i 0)) | |
186 | (dolist (elem seq) | |
187 | (when (funcall pred elem) | |
188 | (throw 'rst-position-if i)) | |
189 | (incf i))))) | |
190 | ||
191 | (defun rst-position (elem seq) | |
192 | "Return position of ELEM in list SEQ or nil. | |
193 | Comparison done with `equal'." | |
194 | ;; Create a closure containing `elem' so the `lambda' always sees our | |
195 | ;; parameter instead of an `elem' which may be in dynamic scope at the time | |
196 | ;; of execution of the `lambda'. | |
197 | (lexical-let ((elem elem)) | |
198 | (rst-position-if (function (lambda (e) | |
199 | (equal elem e))) | |
200 | seq))) | |
94e9c286 | 201 | |
7ae2ea10 | 202 | ;; FIXME: Embed complicated `defconst's in `eval-when-compile'. |
7b4cdbf4 | 203 | |
d13c8be6 SM |
204 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; |
205 | ;; Versions | |
206 | ||
64f6a736 | 207 | ;; testcover: ok. |
d13c8be6 | 208 | (defun rst-extract-version (delim-re head-re re tail-re var &optional default) |
6d3f7c2f SM |
209 | "Extract the version from a variable according to the given regexes. |
210 | Return the version after regex DELIM-RE and HEAD-RE matching RE | |
211 | and before TAIL-RE and DELIM-RE in VAR or DEFAULT for no match." | |
d13c8be6 SM |
212 | (if (string-match |
213 | (concat delim-re head-re "\\(" re "\\)" tail-re delim-re) | |
214 | var) | |
215 | (match-string 1 var) | |
216 | default)) | |
217 | ||
218 | ;; Use CVSHeader to really get information from CVS and not other version | |
6d3f7c2f | 219 | ;; control systems. |
d13c8be6 | 220 | (defconst rst-cvs-header |
557337e9 | 221 | "$CVSHeader: sm/rst_el/rst.el,v 1.327.2.6 2012-10-07 13:05:50 stefan Exp $") |
d13c8be6 SM |
222 | (defconst rst-cvs-rev |
223 | (rst-extract-version "\\$" "CVSHeader: \\S + " "[0-9]+\\(?:\\.[0-9]+\\)+" | |
224 | " .*" rst-cvs-header "0.0") | |
6d3f7c2f | 225 | "The CVS revision of this file. CVS revision is the development revision.") |
d13c8be6 SM |
226 | (defconst rst-cvs-timestamp |
227 | (rst-extract-version "\\$" "CVSHeader: \\S + \\S + " | |
228 | "[0-9]+-[0-9]+-[0-9]+ [0-9]+:[0-9]+:[0-9]+" " .*" | |
229 | rst-cvs-header "1970-01-01 00:00:00") | |
6d3f7c2f | 230 | "The CVS time stamp of this file.") |
d13c8be6 | 231 | |
6d3f7c2f | 232 | ;; Use LastChanged... to really get information from SVN. |
d13c8be6 SM |
233 | (defconst rst-svn-rev |
234 | (rst-extract-version "\\$" "LastChangedRevision: " "[0-9]+" " " | |
48a24920 | 235 | "$LastChangedRevision: 7515 $") |
d13c8be6 SM |
236 | "The SVN revision of this file. |
237 | SVN revision is the upstream (docutils) revision.") | |
238 | (defconst rst-svn-timestamp | |
239 | (rst-extract-version "\\$" "LastChangedDate: " ".+?+" " " | |
48a24920 | 240 | "$LastChangedDate: 2012-09-20 23:28:53 +0200 (Thu, 20 Sep 2012) $") |
6d3f7c2f | 241 | "The SVN time stamp of this file.") |
d13c8be6 | 242 | |
6d3f7c2f | 243 | ;; Maintained by the release process. |
d13c8be6 SM |
244 | (defconst rst-official-version |
245 | (rst-extract-version "%" "OfficialVersion: " "[0-9]+\\(?:\\.[0-9]+\\)+" " " | |
48a24920 | 246 | "%OfficialVersion: 1.4.0 %") |
d13c8be6 SM |
247 | "Official version of the package.") |
248 | (defconst rst-official-cvs-rev | |
249 | (rst-extract-version "[%$]" "Revision: " "[0-9]+\\(?:\\.[0-9]+\\)+" " " | |
557337e9 | 250 | "%Revision: 1.327 %") |
d13c8be6 SM |
251 | "CVS revision of this file in the official version.") |
252 | ||
253 | (defconst rst-version | |
254 | (if (equal rst-official-cvs-rev rst-cvs-rev) | |
255 | rst-official-version | |
256 | (format "%s (development %s [%s])" rst-official-version | |
257 | rst-cvs-rev rst-cvs-timestamp)) | |
258 | "The version string. | |
6d3f7c2f SM |
259 | Starts with the current official version. For developer versions |
260 | in parentheses follows the development revision and the time stamp.") | |
d13c8be6 SM |
261 | |
262 | (defconst rst-package-emacs-version-alist | |
2a1e2476 GM |
263 | '(("1.0.0" . "24.3") |
264 | ("1.1.0" . "24.3") | |
265 | ("1.2.0" . "24.3") | |
266 | ("1.2.1" . "24.3") | |
267 | ("1.3.0" . "24.3") | |
268 | ("1.3.1" . "24.3") | |
48a24920 | 269 | ("1.4.0" . "24.3") |
1f45e27e | 270 | )) |
d13c8be6 SM |
271 | |
272 | (unless (assoc rst-official-version rst-package-emacs-version-alist) | |
273 | (error "Version %s not listed in `rst-package-emacs-version-alist'" | |
274 | rst-version)) | |
275 | ||
276 | (add-to-list 'customize-package-emacs-version-alist | |
277 | (cons 'ReST rst-package-emacs-version-alist)) | |
94e9c286 | 278 | |
d13c8be6 SM |
279 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; |
280 | ;; Initialize customization | |
94e9c286 SM |
281 | |
282 | \f | |
92439579 | 283 | (defgroup rst nil "Support for reStructuredText documents." |
94e9c286 SM |
284 | :group 'wp |
285 | :version "23.1" | |
286 | :link '(url-link "http://docutils.sourceforge.net/rst.html")) | |
287 | ||
94e9c286 SM |
288 | \f |
289 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; | |
d13c8be6 SM |
290 | ;; Facilities for regular expressions used everywhere |
291 | ||
292 | ;; The trailing numbers in the names give the number of referenceable regex | |
6d3f7c2f | 293 | ;; groups contained in the regex. |
d13c8be6 SM |
294 | |
295 | ;; Used to be customizable but really is not customizable but fixed by the reST | |
6d3f7c2f | 296 | ;; syntax. |
d13c8be6 | 297 | (defconst rst-bullets |
6d3f7c2f | 298 | ;; Sorted so they can form a character class when concatenated. |
d13c8be6 SM |
299 | '(?- ?* ?+ ?\u2022 ?\u2023 ?\u2043) |
300 | "List of all possible bullet characters for bulleted lists.") | |
301 | ||
302 | (defconst rst-uri-schemes | |
303 | '("acap" "cid" "data" "dav" "fax" "file" "ftp" "gopher" "http" "https" "imap" | |
304 | "ldap" "mailto" "mid" "modem" "news" "nfs" "nntp" "pop" "prospero" "rtsp" | |
305 | "service" "sip" "tel" "telnet" "tip" "urn" "vemmi" "wais") | |
306 | "Supported URI schemes.") | |
307 | ||
308 | (defconst rst-adornment-chars | |
6d3f7c2f | 309 | ;; Sorted so they can form a character class when concatenated. |
d13c8be6 SM |
310 | '(?\] |
311 | ?! ?\" ?# ?$ ?% ?& ?' ?\( ?\) ?* ?+ ?, ?. ?/ ?: ?\; ?< ?= ?> ?? ?@ ?\[ ?\\ | |
312 | ?^ ?_ ?` ?{ ?| ?} ?~ | |
313 | ?-) | |
314 | "Characters which may be used in adornments for sections and transitions.") | |
315 | ||
316 | (defconst rst-max-inline-length | |
317 | 1000 | |
318 | "Maximum length of inline markup to recognize.") | |
319 | ||
320 | (defconst rst-re-alist-def | |
6d3f7c2f SM |
321 | ;; `*-beg' matches * at the beginning of a line. |
322 | ;; `*-end' matches * at the end of a line. | |
323 | ;; `*-prt' matches a part of *. | |
324 | ;; `*-tag' matches *. | |
325 | ;; `*-sta' matches the start of * which may be followed by respective content. | |
326 | ;; `*-pfx' matches the delimiter left of *. | |
327 | ;; `*-sfx' matches the delimiter right of *. | |
328 | ;; `*-hlp' helper for *. | |
d13c8be6 SM |
329 | ;; |
330 | ;; A trailing number says how many referenceable groups are contained. | |
331 | `( | |
332 | ||
333 | ;; Horizontal white space (`hws') | |
334 | (hws-prt "[\t ]") | |
6d3f7c2f SM |
335 | (hws-tag hws-prt "*") ; Optional sequence of horizontal white space. |
336 | (hws-sta hws-prt "+") ; Mandatory sequence of horizontal white space. | |
d13c8be6 SM |
337 | |
338 | ;; Lines (`lin') | |
6d3f7c2f SM |
339 | (lin-beg "^" hws-tag) ; Beginning of a possibly indented line. |
340 | (lin-end hws-tag "$") ; End of a line with optional trailing white space. | |
341 | (linemp-tag "^" hws-tag "$") ; Empty line with optional white space. | |
d13c8be6 SM |
342 | |
343 | ;; Various tags and parts | |
344 | (ell-tag "\\.\\.\\.") ; Ellipsis | |
6d3f7c2f SM |
345 | (bul-tag ,(concat "[" rst-bullets "]")) ; A bullet. |
346 | (ltr-tag "[a-zA-Z]") ; A letter enumerator tag. | |
347 | (num-prt "[0-9]") ; A number enumerator part. | |
348 | (num-tag num-prt "+") ; A number enumerator tag. | |
349 | (rom-prt "[IVXLCDMivxlcdm]") ; A roman enumerator part. | |
350 | (rom-tag rom-prt "+") ; A roman enumerator tag. | |
351 | (aut-tag "#") ; An automatic enumerator tag. | |
352 | (dcl-tag "::") ; Double colon. | |
d13c8be6 SM |
353 | |
354 | ;; Block lead in (`bli') | |
355 | (bli-sfx (:alt hws-sta "$")) ; Suffix of a block lead-in with *optional* | |
6d3f7c2f | 356 | ; immediate content. |
d13c8be6 SM |
357 | |
358 | ;; Various starts | |
6d3f7c2f | 359 | (bul-sta bul-tag bli-sfx) ; Start of a bulleted item. |
d13c8be6 SM |
360 | |
361 | ;; Explicit markup tag (`exm') | |
362 | (exm-tag "\\.\\.") | |
363 | (exm-sta exm-tag hws-sta) | |
364 | (exm-beg lin-beg exm-sta) | |
365 | ||
366 | ;; Counters in enumerations (`cnt') | |
6d3f7c2f SM |
367 | (cntany-tag (:alt ltr-tag num-tag rom-tag aut-tag)) ; An arbitrary counter. |
368 | (cntexp-tag (:alt ltr-tag num-tag rom-tag)) ; An arbitrary explicit counter. | |
d13c8be6 SM |
369 | |
370 | ;; Enumerator (`enm') | |
371 | (enmany-tag (:alt | |
372 | (:seq cntany-tag "\\.") | |
6d3f7c2f | 373 | (:seq "(?" cntany-tag ")"))) ; An arbitrary enumerator. |
d13c8be6 SM |
374 | (enmexp-tag (:alt |
375 | (:seq cntexp-tag "\\.") | |
376 | (:seq "(?" cntexp-tag ")"))) ; An arbitrary explicit | |
6d3f7c2f | 377 | ; enumerator. |
d13c8be6 SM |
378 | (enmaut-tag (:alt |
379 | (:seq aut-tag "\\.") | |
6d3f7c2f SM |
380 | (:seq "(?" aut-tag ")"))) ; An automatic enumerator. |
381 | (enmany-sta enmany-tag bli-sfx) ; An arbitrary enumerator start. | |
382 | (enmexp-sta enmexp-tag bli-sfx) ; An arbitrary explicit enumerator start. | |
d13c8be6 | 383 | (enmexp-beg lin-beg enmexp-sta) ; An arbitrary explicit enumerator start |
6d3f7c2f | 384 | ; at the beginning of a line. |
d13c8be6 SM |
385 | |
386 | ;; Items may be enumerated or bulleted (`itm') | |
6d3f7c2f | 387 | (itmany-tag (:alt enmany-tag bul-tag)) ; An arbitrary item tag. |
d13c8be6 | 388 | (itmany-sta-1 (:grp itmany-tag) bli-sfx) ; An arbitrary item start, group |
6d3f7c2f | 389 | ; is the item tag. |
d13c8be6 SM |
390 | (itmany-beg-1 lin-beg itmany-sta-1) ; An arbitrary item start at the |
391 | ; beginning of a line, group is the | |
6d3f7c2f | 392 | ; item tag. |
d13c8be6 SM |
393 | |
394 | ;; Inline markup (`ilm') | |
395 | (ilm-pfx (:alt "^" hws-prt "[-'\"([{<\u2018\u201c\u00ab\u2019/:]")) | |
396 | (ilm-sfx (:alt "$" hws-prt "[]-'\")}>\u2019\u201d\u00bb/:.,;!?\\]")) | |
397 | ||
398 | ;; Inline markup content (`ilc') | |
6d3f7c2f SM |
399 | (ilcsgl-tag "\\S ") ; A single non-white character. |
400 | (ilcast-prt (:alt "[^*\\]" "\\\\.")) ; Part of non-asterisk content. | |
401 | (ilcbkq-prt (:alt "[^`\\]" "\\\\.")) ; Part of non-backquote content. | |
d13c8be6 | 402 | (ilcbkqdef-prt (:alt "[^`\\\n]" "\\\\.")) ; Part of non-backquote |
6d3f7c2f SM |
403 | ; definition. |
404 | (ilcbar-prt (:alt "[^|\\]" "\\\\.")) ; Part of non-vertical-bar content. | |
d13c8be6 | 405 | (ilcbardef-prt (:alt "[^|\\\n]" "\\\\.")) ; Part of non-vertical-bar |
6d3f7c2f SM |
406 | ; definition. |
407 | (ilcast-sfx "[^\t *\\]") ; Suffix of non-asterisk content. | |
408 | (ilcbkq-sfx "[^\t `\\]") ; Suffix of non-backquote content. | |
409 | (ilcbar-sfx "[^\t |\\]") ; Suffix of non-vertical-bar content. | |
410 | (ilcrep-hlp ,(format "\\{0,%d\\}" rst-max-inline-length)) ; Repeat count. | |
d13c8be6 SM |
411 | (ilcast-tag (:alt ilcsgl-tag |
412 | (:seq ilcsgl-tag | |
413 | ilcast-prt ilcrep-hlp | |
6d3f7c2f | 414 | ilcast-sfx))) ; Non-asterisk content. |
d13c8be6 SM |
415 | (ilcbkq-tag (:alt ilcsgl-tag |
416 | (:seq ilcsgl-tag | |
417 | ilcbkq-prt ilcrep-hlp | |
6d3f7c2f | 418 | ilcbkq-sfx))) ; Non-backquote content. |
d13c8be6 SM |
419 | (ilcbkqdef-tag (:alt ilcsgl-tag |
420 | (:seq ilcsgl-tag | |
421 | ilcbkqdef-prt ilcrep-hlp | |
6d3f7c2f | 422 | ilcbkq-sfx))) ; Non-backquote definition. |
d13c8be6 SM |
423 | (ilcbar-tag (:alt ilcsgl-tag |
424 | (:seq ilcsgl-tag | |
425 | ilcbar-prt ilcrep-hlp | |
6d3f7c2f | 426 | ilcbar-sfx))) ; Non-vertical-bar content. |
d13c8be6 SM |
427 | (ilcbardef-tag (:alt ilcsgl-tag |
428 | (:seq ilcsgl-tag | |
429 | ilcbardef-prt ilcrep-hlp | |
6d3f7c2f | 430 | ilcbar-sfx))) ; Non-vertical-bar definition. |
d13c8be6 SM |
431 | |
432 | ;; Fields (`fld') | |
6d3f7c2f SM |
433 | (fldnam-prt (:alt "[^:\n]" "\\\\:")) ; Part of a field name. |
434 | (fldnam-tag fldnam-prt "+") ; A field name. | |
435 | (fld-tag ":" fldnam-tag ":") ; A field marker. | |
d13c8be6 SM |
436 | |
437 | ;; Options (`opt') | |
6d3f7c2f SM |
438 | (optsta-tag (:alt "[-+/]" "--")) ; Start of an option. |
439 | (optnam-tag "\\sw" (:alt "-" "\\sw") "*") ; Name of an option. | |
440 | (optarg-tag (:shy "[ =]\\S +")) ; Option argument. | |
441 | (optsep-tag (:shy "," hws-prt)) ; Separator between options. | |
442 | (opt-tag (:shy optsta-tag optnam-tag optarg-tag "?")) ; A complete option. | |
d13c8be6 SM |
443 | |
444 | ;; Footnotes and citations (`fnc') | |
6d3f7c2f SM |
445 | (fncnam-prt "[^\]\n]") ; Part of a footnote or citation name. |
446 | (fncnam-tag fncnam-prt "+") ; A footnote or citation name. | |
447 | (fnc-tag "\\[" fncnam-tag "]") ; A complete footnote or citation tag. | |
d13c8be6 SM |
448 | (fncdef-tag-2 (:grp exm-sta) |
449 | (:grp fnc-tag)) ; A complete footnote or citation definition | |
6d3f7c2f | 450 | ; tag. First group is the explicit markup |
d13c8be6 | 451 | ; start, second group is the footnote / |
6d3f7c2f | 452 | ; citation tag. |
d13c8be6 | 453 | (fnc-sta-2 fncdef-tag-2 bli-sfx) ; Start of a footnote or citation |
6d3f7c2f | 454 | ; definition. First group is the explicit |
d13c8be6 | 455 | ; markup start, second group is the |
6d3f7c2f | 456 | ; footnote / citation tag. |
d13c8be6 SM |
457 | |
458 | ;; Substitutions (`sub') | |
6d3f7c2f | 459 | (sub-tag "|" ilcbar-tag "|") ; A complete substitution tag. |
d13c8be6 | 460 | (subdef-tag "|" ilcbardef-tag "|") ; A complete substitution definition |
6d3f7c2f | 461 | ; tag. |
d13c8be6 SM |
462 | |
463 | ;; Symbol (`sym') | |
7ae2ea10 SM |
464 | (sym-prt "[-+.:_]") ; Non-word part of a symbol. |
465 | (sym-tag (:shy "\\sw+" (:shy sym-prt "\\sw+") "*")) | |
d13c8be6 SM |
466 | |
467 | ;; URIs (`uri') | |
468 | (uri-tag (:alt ,@rst-uri-schemes)) | |
469 | ||
470 | ;; Adornment (`ado') | |
471 | (ado-prt "[" ,(concat rst-adornment-chars) "]") | |
472 | (adorep3-hlp "\\{3,\\}") ; There must be at least 3 characters because | |
473 | ; otherwise explicit markup start would be | |
6d3f7c2f | 474 | ; recognized. |
d13c8be6 | 475 | (adorep2-hlp "\\{2,\\}") ; As `adorep3-hlp' but when the first of three |
6d3f7c2f | 476 | ; characters is matched differently. |
d13c8be6 SM |
477 | (ado-tag-1-1 (:grp ado-prt) |
478 | "\\1" adorep2-hlp) ; A complete adornment, group is the first | |
479 | ; adornment character and MUST be the FIRST | |
6d3f7c2f | 480 | ; group in the whole expression. |
d13c8be6 SM |
481 | (ado-tag-1-2 (:grp ado-prt) |
482 | "\\2" adorep2-hlp) ; A complete adornment, group is the first | |
483 | ; adornment character and MUST be the | |
6d3f7c2f | 484 | ; SECOND group in the whole expression. |
d13c8be6 SM |
485 | (ado-beg-2-1 "^" (:grp ado-tag-1-2) |
486 | lin-end) ; A complete adornment line; first group is the whole | |
487 | ; adornment and MUST be the FIRST group in the whole | |
488 | ; expression; second group is the first adornment | |
6d3f7c2f | 489 | ; character. |
d13c8be6 SM |
490 | |
491 | ;; Titles (`ttl') | |
6d3f7c2f SM |
492 | (ttl-tag "\\S *\\w\\S *") ; A title text. |
493 | (ttl-beg lin-beg ttl-tag) ; A title text at the beginning of a line. | |
d13c8be6 SM |
494 | |
495 | ;; Directives and substitution definitions (`dir') | |
496 | (dir-tag-3 (:grp exm-sta) | |
497 | (:grp (:shy subdef-tag hws-sta) "?") | |
498 | (:grp sym-tag dcl-tag)) ; A directive or substitution definition | |
6d3f7c2f | 499 | ; tag. First group is explicit markup |
d13c8be6 SM |
500 | ; start, second group is a possibly |
501 | ; empty substitution tag, third group is | |
502 | ; the directive tag including the double | |
6d3f7c2f | 503 | ; colon. |
d13c8be6 | 504 | (dir-sta-3 dir-tag-3 bli-sfx) ; Start of a directive or substitution |
6d3f7c2f | 505 | ; definition. Groups are as in dir-tag-3. |
d13c8be6 SM |
506 | |
507 | ;; Literal block (`lit') | |
508 | (lit-sta-2 (:grp (:alt "[^.\n]" "\\.[^.\n]") ".*") "?" | |
6d3f7c2f | 509 | (:grp dcl-tag) "$") ; Start of a literal block. First group is |
d13c8be6 SM |
510 | ; any text before the double colon tag which |
511 | ; may not exist, second group is the double | |
6d3f7c2f | 512 | ; colon tag. |
d13c8be6 SM |
513 | |
514 | ;; Comments (`cmt') | |
515 | (cmt-sta-1 (:grp exm-sta) "[^\[|_\n]" | |
516 | (:alt "[^:\n]" (:seq ":" (:alt "[^:\n]" "$"))) | |
517 | "*$") ; Start of a comment block; first group is explicit markup | |
6d3f7c2f | 518 | ; start. |
d13c8be6 SM |
519 | |
520 | ;; Paragraphs (`par') | |
521 | (par-tag- (:alt itmany-tag fld-tag opt-tag fncdef-tag-2 dir-tag-3 exm-tag) | |
522 | ) ; Tag at the beginning of a paragraph; there may be groups in | |
6d3f7c2f | 523 | ; certain cases. |
d13c8be6 SM |
524 | ) |
525 | "Definition alist of relevant regexes. | |
526 | Each entry consists of the symbol naming the regex and an | |
527 | argument list for `rst-re'.") | |
528 | ||
7b4cdbf4 SM |
529 | (defvar rst-re-alist) ; Forward declare to use it in `rst-re'. |
530 | ||
6d3f7c2f | 531 | ;; FIXME: Use `sregex` or `rx` instead of re-inventing the wheel. |
64f6a736 SM |
532 | (rst-testcover-add-compose 'rst-re) |
533 | ;; testcover: ok. | |
d13c8be6 SM |
534 | (defun rst-re (&rest args) |
535 | "Interpret ARGS as regular expressions and return a regex string. | |
536 | Each element of ARGS may be one of the following: | |
537 | ||
538 | A string which is inserted unchanged. | |
539 | ||
540 | A character which is resolved to a quoted regex. | |
541 | ||
542 | A symbol which is resolved to a string using `rst-re-alist-def'. | |
543 | ||
6d3f7c2f SM |
544 | A list with a keyword in the car. Each element of the cdr of such |
545 | a list is recursively interpreted as ARGS. The results of this | |
d13c8be6 SM |
546 | interpretation are concatenated according to the keyword. |
547 | ||
548 | For the keyword `:seq' the results are simply concatenated. | |
549 | ||
550 | For the keyword `:shy' the results are concatenated and | |
551 | surrounded by a shy-group (\"\\(?:...\\)\"). | |
552 | ||
553 | For the keyword `:alt' the results form an alternative (\"\\|\") | |
554 | which is shy-grouped (\"\\(?:...\\)\"). | |
555 | ||
556 | For the keyword `:grp' the results are concatenated and form a | |
6d3f7c2f | 557 | referenceable group (\"\\(...\\)\"). |
d13c8be6 SM |
558 | |
559 | After interpretation of ARGS the results are concatenated as for | |
6d3f7c2f | 560 | `:seq'." |
d13c8be6 SM |
561 | (apply 'concat |
562 | (mapcar | |
563 | (lambda (re) | |
564 | (cond | |
565 | ((stringp re) | |
566 | re) | |
567 | ((symbolp re) | |
568 | (cadr (assoc re rst-re-alist))) | |
8f6b6da8 | 569 | ((characterp re) |
d13c8be6 SM |
570 | (regexp-quote (char-to-string re))) |
571 | ((listp re) | |
572 | (let ((nested | |
573 | (mapcar (lambda (elt) | |
574 | (rst-re elt)) | |
575 | (cdr re)))) | |
576 | (cond | |
577 | ((eq (car re) :seq) | |
578 | (mapconcat 'identity nested "")) | |
579 | ((eq (car re) :shy) | |
580 | (concat "\\(?:" (mapconcat 'identity nested "") "\\)")) | |
581 | ((eq (car re) :grp) | |
582 | (concat "\\(" (mapconcat 'identity nested "") "\\)")) | |
583 | ((eq (car re) :alt) | |
584 | (concat "\\(?:" (mapconcat 'identity nested "\\|") "\\)")) | |
585 | (t | |
586 | (error "Unknown list car: %s" (car re)))))) | |
587 | (t | |
588 | (error "Unknown object type for building regex: %s" re)))) | |
589 | args))) | |
590 | ||
51fa99f1 | 591 | ;; FIXME: Remove circular dependency between `rst-re' and `rst-re-alist'. |
7b4cdbf4 SM |
592 | (with-no-warnings ; Silence byte-compiler about this construction. |
593 | (defconst rst-re-alist | |
594 | ;; Shadow global value we are just defining so we can construct it step by | |
595 | ;; step. | |
596 | (let (rst-re-alist) | |
597 | (dolist (re rst-re-alist-def rst-re-alist) | |
598 | (setq rst-re-alist | |
599 | (nconc rst-re-alist | |
600 | (list (list (car re) (apply 'rst-re (cdr re)))))))) | |
601 | "Alist mapping symbols from `rst-re-alist-def' to regex strings.")) | |
51fa99f1 | 602 | |
94e9c286 SM |
603 | \f |
604 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; | |
6d3f7c2f | 605 | ;; Mode definition |
d13c8be6 | 606 | |
64f6a736 | 607 | ;; testcover: ok. |
d13c8be6 | 608 | (defun rst-define-key (keymap key def &rest deprecated) |
6d3f7c2f SM |
609 | "Bind like `define-key' but add deprecated key definitions. |
610 | KEYMAP, KEY, and DEF are as in `define-key'. DEPRECATED key | |
611 | definitions should be in vector notation. These are defined as | |
612 | well but give an additional message." | |
d13c8be6 SM |
613 | (define-key keymap key def) |
614 | (dolist (dep-key deprecated) | |
6d3f7c2f SM |
615 | (define-key keymap dep-key |
616 | `(lambda () | |
617 | ,(format "Deprecated binding for %s, use \\[%s] instead." def def) | |
618 | (interactive) | |
619 | (call-interactively ',def) | |
620 | (message "[Deprecated use of key %s; use key %s instead]" | |
621 | (key-description (this-command-keys)) | |
622 | (key-description ,key)))))) | |
d13c8be6 | 623 | |
94e9c286 SM |
624 | ;; Key bindings. |
625 | (defvar rst-mode-map | |
626 | (let ((map (make-sparse-keymap))) | |
627 | ||
6d3f7c2f | 628 | ;; \C-c is the general keymap. |
d13c8be6 SM |
629 | (rst-define-key map [?\C-c ?\C-h] 'describe-prefix-bindings) |
630 | ||
94e9c286 | 631 | ;; |
6d3f7c2f | 632 | ;; Section Adornments |
94e9c286 | 633 | ;; |
d13c8be6 SM |
634 | ;; The adjustment function that adorns or rotates a section title. |
635 | (rst-define-key map [?\C-c ?\C-=] 'rst-adjust [?\C-c ?\C-a t]) | |
1f45e27e SM |
636 | (rst-define-key map [?\C-=] 'rst-adjust) ; Does not work on the Mac OSX and |
637 | ; on consoles. | |
d13c8be6 | 638 | |
6d3f7c2f | 639 | ;; \C-c \C-a is the keymap for adornments. |
d13c8be6 | 640 | (rst-define-key map [?\C-c ?\C-a ?\C-h] 'describe-prefix-bindings) |
1f45e27e SM |
641 | ;; Another binding which works with all types of input. |
642 | (rst-define-key map [?\C-c ?\C-a ?\C-a] 'rst-adjust) | |
6d3f7c2f SM |
643 | ;; Display the hierarchy of adornments implied by the current document |
644 | ;; contents. | |
d13c8be6 SM |
645 | (rst-define-key map [?\C-c ?\C-a ?\C-d] 'rst-display-adornments-hierarchy) |
646 | ;; Homogenize the adornments in the document. | |
647 | (rst-define-key map [?\C-c ?\C-a ?\C-s] 'rst-straighten-adornments | |
648 | [?\C-c ?\C-s]) | |
94e9c286 SM |
649 | |
650 | ;; | |
6d3f7c2f | 651 | ;; Section Movement and Selection |
94e9c286 SM |
652 | ;; |
653 | ;; Mark the subsection where the cursor is. | |
d13c8be6 | 654 | (rst-define-key map [?\C-\M-h] 'rst-mark-section |
6d3f7c2f | 655 | ;; Same as mark-defun sgml-mark-current-element. |
d13c8be6 | 656 | [?\C-c ?\C-m]) |
4cf9b38d | 657 | ;; Move backward/forward between section titles. |
7ae2ea10 | 658 | ;; FIXME: Also bind similar to outline mode. |
4cf9b38d | 659 | (rst-define-key map [?\C-\M-a] 'rst-backward-section |
6d3f7c2f | 660 | ;; Same as beginning-of-defun. |
d13c8be6 | 661 | [?\C-c ?\C-n]) |
4cf9b38d | 662 | (rst-define-key map [?\C-\M-e] 'rst-forward-section |
6d3f7c2f | 663 | ;; Same as end-of-defun. |
d13c8be6 | 664 | [?\C-c ?\C-p]) |
94e9c286 SM |
665 | |
666 | ;; | |
6d3f7c2f | 667 | ;; Operating on regions |
94e9c286 | 668 | ;; |
6d3f7c2f | 669 | ;; \C-c \C-r is the keymap for regions. |
d13c8be6 SM |
670 | (rst-define-key map [?\C-c ?\C-r ?\C-h] 'describe-prefix-bindings) |
671 | ;; Makes region a line-block. | |
672 | (rst-define-key map [?\C-c ?\C-r ?\C-l] 'rst-line-block-region | |
673 | [?\C-c ?\C-d]) | |
6d3f7c2f | 674 | ;; Shift region left or right according to tabs. |
d13c8be6 SM |
675 | (rst-define-key map [?\C-c ?\C-r tab] 'rst-shift-region |
676 | [?\C-c ?\C-r t] [?\C-c ?\C-l t]) | |
677 | ||
678 | ;; | |
6d3f7c2f | 679 | ;; Operating on lists |
d13c8be6 | 680 | ;; |
6d3f7c2f | 681 | ;; \C-c \C-l is the keymap for lists. |
d13c8be6 | 682 | (rst-define-key map [?\C-c ?\C-l ?\C-h] 'describe-prefix-bindings) |
94e9c286 | 683 | ;; Makes paragraphs in region as a bullet list. |
d13c8be6 SM |
684 | (rst-define-key map [?\C-c ?\C-l ?\C-b] 'rst-bullet-list-region |
685 | [?\C-c ?\C-b]) | |
94e9c286 | 686 | ;; Makes paragraphs in region as a enumeration. |
d13c8be6 SM |
687 | (rst-define-key map [?\C-c ?\C-l ?\C-e] 'rst-enumerate-region |
688 | [?\C-c ?\C-e]) | |
94e9c286 | 689 | ;; Converts bullets to an enumeration. |
d13c8be6 SM |
690 | (rst-define-key map [?\C-c ?\C-l ?\C-c] 'rst-convert-bullets-to-enumeration |
691 | [?\C-c ?\C-v]) | |
94e9c286 | 692 | ;; Make sure that all the bullets in the region are consistent. |
d13c8be6 SM |
693 | (rst-define-key map [?\C-c ?\C-l ?\C-s] 'rst-straighten-bullets-region |
694 | [?\C-c ?\C-w]) | |
6d3f7c2f | 695 | ;; Insert a list item. |
d13c8be6 | 696 | (rst-define-key map [?\C-c ?\C-l ?\C-i] 'rst-insert-list) |
94e9c286 SM |
697 | |
698 | ;; | |
6d3f7c2f | 699 | ;; Table-of-Contents Features |
94e9c286 | 700 | ;; |
6d3f7c2f | 701 | ;; \C-c \C-t is the keymap for table of contents. |
d13c8be6 | 702 | (rst-define-key map [?\C-c ?\C-t ?\C-h] 'describe-prefix-bindings) |
94e9c286 | 703 | ;; Enter a TOC buffer to view and move to a specific section. |
d13c8be6 | 704 | (rst-define-key map [?\C-c ?\C-t ?\C-t] 'rst-toc) |
94e9c286 | 705 | ;; Insert a TOC here. |
d13c8be6 SM |
706 | (rst-define-key map [?\C-c ?\C-t ?\C-i] 'rst-toc-insert |
707 | [?\C-c ?\C-i]) | |
94e9c286 | 708 | ;; Update the document's TOC (without changing the cursor position). |
d13c8be6 SM |
709 | (rst-define-key map [?\C-c ?\C-t ?\C-u] 'rst-toc-update |
710 | [?\C-c ?\C-u]) | |
6d3f7c2f | 711 | ;; Go to the section under the cursor (cursor must be in TOC). |
d13c8be6 SM |
712 | (rst-define-key map [?\C-c ?\C-t ?\C-j] 'rst-goto-section |
713 | [?\C-c ?\C-f]) | |
94e9c286 SM |
714 | |
715 | ;; | |
6d3f7c2f | 716 | ;; Converting Documents from Emacs |
94e9c286 | 717 | ;; |
6d3f7c2f | 718 | ;; \C-c \C-c is the keymap for compilation. |
d13c8be6 | 719 | (rst-define-key map [?\C-c ?\C-c ?\C-h] 'describe-prefix-bindings) |
94e9c286 | 720 | ;; Run one of two pre-configured toolset commands on the document. |
d13c8be6 SM |
721 | (rst-define-key map [?\C-c ?\C-c ?\C-c] 'rst-compile |
722 | [?\C-c ?1]) | |
723 | (rst-define-key map [?\C-c ?\C-c ?\C-a] 'rst-compile-alt-toolset | |
724 | [?\C-c ?2]) | |
94e9c286 | 725 | ;; Convert the active region to pseudo-xml using the docutils tools. |
d13c8be6 SM |
726 | (rst-define-key map [?\C-c ?\C-c ?\C-x] 'rst-compile-pseudo-region |
727 | [?\C-c ?3]) | |
94e9c286 | 728 | ;; Convert the current document to PDF and launch a viewer on the results. |
d13c8be6 SM |
729 | (rst-define-key map [?\C-c ?\C-c ?\C-p] 'rst-compile-pdf-preview |
730 | [?\C-c ?4]) | |
94e9c286 | 731 | ;; Convert the current document to S5 slides and view in a web browser. |
d13c8be6 SM |
732 | (rst-define-key map [?\C-c ?\C-c ?\C-s] 'rst-compile-slides-preview |
733 | [?\C-c ?5]) | |
94e9c286 SM |
734 | |
735 | map) | |
e6438428 | 736 | "Keymap for reStructuredText mode commands. |
b4747519 | 737 | This inherits from Text mode.") |
94e9c286 SM |
738 | |
739 | ||
740 | ;; Abbrevs. | |
94e9c286 | 741 | (define-abbrev-table 'rst-mode-abbrev-table |
32845226 SM |
742 | (mapcar (lambda (x) (append x '(nil 0 system))) |
743 | '(("contents" ".. contents::\n..\n ") | |
744 | ("con" ".. contents::\n..\n ") | |
745 | ("cont" "[...]") | |
746 | ("skip" "\n\n[...]\n\n ") | |
747 | ("seq" "\n\n[...]\n\n ") | |
748 | ;; FIXME: Add footnotes, links, and more. | |
6d3f7c2f SM |
749 | )) |
750 | "Abbrev table used while in `rst-mode'.") | |
94e9c286 SM |
751 | |
752 | ||
753 | ;; Syntax table. | |
754 | (defvar rst-mode-syntax-table | |
755 | (let ((st (copy-syntax-table text-mode-syntax-table))) | |
94e9c286 SM |
756 | (modify-syntax-entry ?$ "." st) |
757 | (modify-syntax-entry ?% "." st) | |
758 | (modify-syntax-entry ?& "." st) | |
759 | (modify-syntax-entry ?' "." st) | |
760 | (modify-syntax-entry ?* "." st) | |
7ae2ea10 SM |
761 | (modify-syntax-entry ?+ "." st) |
762 | (modify-syntax-entry ?- "." st) | |
94e9c286 SM |
763 | (modify-syntax-entry ?/ "." st) |
764 | (modify-syntax-entry ?< "." st) | |
765 | (modify-syntax-entry ?= "." st) | |
766 | (modify-syntax-entry ?> "." st) | |
767 | (modify-syntax-entry ?\\ "\\" st) | |
7ae2ea10 | 768 | (modify-syntax-entry ?_ "." st) |
94e9c286 | 769 | (modify-syntax-entry ?| "." st) |
d13c8be6 SM |
770 | (modify-syntax-entry ?\u00ab "." st) |
771 | (modify-syntax-entry ?\u00bb "." st) | |
772 | (modify-syntax-entry ?\u2018 "." st) | |
773 | (modify-syntax-entry ?\u2019 "." st) | |
774 | (modify-syntax-entry ?\u201c "." st) | |
775 | (modify-syntax-entry ?\u201d "." st) | |
94e9c286 SM |
776 | |
777 | st) | |
778 | "Syntax table used while in `rst-mode'.") | |
779 | ||
780 | ||
781 | (defcustom rst-mode-hook nil | |
d13c8be6 SM |
782 | "Hook run when `rst-mode' is turned on. |
783 | The hook for `text-mode' is run before this one." | |
94e9c286 SM |
784 | :group 'rst |
785 | :type '(hook)) | |
64f6a736 | 786 | (rst-testcover-defcustom) |
94e9c286 | 787 | |
7b4cdbf4 SM |
788 | ;; Pull in variable definitions silencing byte-compiler. |
789 | (require 'newcomment) | |
94e9c286 | 790 | |
0667a132 SM |
791 | ;; Use rst-mode for *.rst and *.rest files. Many ReStructured-Text files |
792 | ;; use *.txt, but this is too generic to be set as a default. | |
1e8780b1 | 793 | ;;;###autoload (add-to-list 'auto-mode-alist (purecopy '("\\.re?st\\'" . rst-mode))) |
94e9c286 SM |
794 | ;;;###autoload |
795 | (define-derived-mode rst-mode text-mode "ReST" | |
94e9c286 | 796 | "Major mode for editing reStructuredText documents. |
e6438428 | 797 | \\<rst-mode-map> |
94e9c286 | 798 | |
e6438428 JB |
799 | Turning on `rst-mode' calls the normal hooks `text-mode-hook' |
800 | and `rst-mode-hook'. This mode also supports font-lock | |
d13c8be6 | 801 | highlighting. |
e6438428 JB |
802 | |
803 | \\{rst-mode-map}" | |
536db356 JPW |
804 | :abbrev-table rst-mode-abbrev-table |
805 | :syntax-table rst-mode-syntax-table | |
806 | :group 'rst | |
94e9c286 | 807 | |
6d3f7c2f | 808 | ;; Paragraph recognition. |
d13c8be6 SM |
809 | (set (make-local-variable 'paragraph-separate) |
810 | (rst-re '(:alt | |
811 | "\f" | |
812 | lin-end))) | |
94e9c286 | 813 | (set (make-local-variable 'paragraph-start) |
d13c8be6 SM |
814 | (rst-re '(:alt |
815 | "\f" | |
816 | lin-end | |
817 | (:seq hws-tag par-tag- bli-sfx)))) | |
94e9c286 | 818 | |
6d3f7c2f | 819 | ;; Indenting and filling. |
d13c8be6 SM |
820 | (set (make-local-variable 'indent-line-function) 'rst-indent-line) |
821 | (set (make-local-variable 'adaptive-fill-mode) t) | |
822 | (set (make-local-variable 'adaptive-fill-regexp) | |
823 | (rst-re 'hws-tag 'par-tag- "?" 'hws-tag)) | |
824 | (set (make-local-variable 'adaptive-fill-function) 'rst-adaptive-fill) | |
825 | (set (make-local-variable 'fill-paragraph-handle-comment) nil) | |
94e9c286 | 826 | |
6d3f7c2f | 827 | ;; Comments. |
94e9c286 | 828 | (set (make-local-variable 'comment-start) ".. ") |
d13c8be6 SM |
829 | (set (make-local-variable 'comment-start-skip) |
830 | (rst-re 'lin-beg 'exm-tag 'bli-sfx)) | |
831 | (set (make-local-variable 'comment-continue) " ") | |
832 | (set (make-local-variable 'comment-multi-line) t) | |
833 | (set (make-local-variable 'comment-use-syntax) nil) | |
834 | ;; reStructuredText has not really a comment ender but nil is not really a | |
6d3f7c2f | 835 | ;; permissible value. |
d13c8be6 SM |
836 | (set (make-local-variable 'comment-end) "") |
837 | (set (make-local-variable 'comment-end-skip) nil) | |
838 | ||
6d3f7c2f SM |
839 | ;; Commenting in reStructuredText is very special so use our own set of |
840 | ;; functions. | |
d13c8be6 SM |
841 | (set (make-local-variable 'comment-line-break-function) |
842 | 'rst-comment-line-break) | |
843 | (set (make-local-variable 'comment-indent-function) | |
844 | 'rst-comment-indent) | |
845 | (set (make-local-variable 'comment-insert-comment-function) | |
846 | 'rst-comment-insert-comment) | |
847 | (set (make-local-variable 'comment-region-function) | |
848 | 'rst-comment-region) | |
849 | (set (make-local-variable 'uncomment-region-function) | |
850 | 'rst-uncomment-region) | |
94e9c286 | 851 | |
ee97deee SM |
852 | ;; Imenu and which function. |
853 | ;; FIXME: Check documentation of `which-function' for alternative ways to | |
854 | ;; determine the current function name. | |
855 | (set (make-local-variable 'imenu-create-index-function) | |
856 | 'rst-imenu-create-index) | |
857 | ||
6d3f7c2f SM |
858 | ;; Font lock. |
859 | (set (make-local-variable 'font-lock-defaults) | |
860 | '(rst-font-lock-keywords | |
861 | t nil nil nil | |
862 | (font-lock-multiline . t) | |
863 | (font-lock-mark-block-function . mark-paragraph))) | |
d13c8be6 SM |
864 | (add-hook 'font-lock-extend-region-functions 'rst-font-lock-extend-region t) |
865 | ||
6d3f7c2f | 866 | ;; Text after a changed line may need new fontification. |
d13c8be6 | 867 | (set (make-local-variable 'jit-lock-contextually) t)) |
94e9c286 SM |
868 | |
869 | ;;;###autoload | |
870 | (define-minor-mode rst-minor-mode | |
ac6c8639 CY |
871 | "Toggle ReST minor mode. |
872 | With a prefix argument ARG, enable ReST minor mode if ARG is | |
873 | positive, and disable it otherwise. If called from Lisp, enable | |
874 | the mode if ARG is omitted or nil. | |
94e9c286 | 875 | |
92439579 JB |
876 | When ReST minor mode is enabled, the ReST mode keybindings |
877 | are installed on top of the major mode bindings. Use this | |
878 | for modes derived from Text mode, like Mail mode." | |
94e9c286 SM |
879 | ;; The initial value. |
880 | nil | |
881 | ;; The indicator for the mode line. | |
882 | " ReST" | |
883 | ;; The minor mode bindings. | |
884 | rst-mode-map | |
885 | :group 'rst) | |
886 | ||
887 | ;; FIXME: can I somehow install these too? | |
6d3f7c2f SM |
888 | ;; :abbrev-table rst-mode-abbrev-table |
889 | ;; :syntax-table rst-mode-syntax-table | |
94e9c286 | 890 | |
94e9c286 SM |
891 | \f |
892 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; | |
d13c8be6 SM |
893 | ;; Section Adornment Adjustment |
894 | ;; ============================ | |
94e9c286 SM |
895 | ;; |
896 | ;; The following functions implement a smart automatic title sectioning feature. | |
897 | ;; The idea is that with the cursor sitting on a section title, we try to get as | |
898 | ;; much information from context and try to do the best thing automatically. | |
899 | ;; This function can be invoked many times and/or with prefix argument to rotate | |
d13c8be6 | 900 | ;; between the various sectioning adornments. |
94e9c286 SM |
901 | ;; |
902 | ;; Definitions: the two forms of sectioning define semantically separate section | |
d13c8be6 | 903 | ;; levels. A sectioning ADORNMENT consists in: |
94e9c286 SM |
904 | ;; |
905 | ;; - a CHARACTER | |
906 | ;; | |
907 | ;; - a STYLE which can be either of 'simple' or 'over-and-under'. | |
908 | ;; | |
909 | ;; - an INDENT (meaningful for the over-and-under style only) which determines | |
910 | ;; how many characters and over-and-under style is hanging outside of the | |
911 | ;; title at the beginning and ending. | |
912 | ;; | |
d13c8be6 | 913 | ;; Here are two examples of adornments (| represents the window border, column |
94e9c286 SM |
914 | ;; 0): |
915 | ;; | |
916 | ;; | | |
917 | ;; 1. char: '-' e |Some Title | |
918 | ;; style: simple |---------- | |
919 | ;; | | |
920 | ;; 2. char: '=' |============== | |
921 | ;; style: over-and-under | Some Title | |
922 | ;; indent: 2 |============== | |
923 | ;; | | |
924 | ;; | |
925 | ;; Some notes: | |
926 | ;; | |
927 | ;; - The underlining character that is used depends on context. The file is | |
928 | ;; scanned to find other sections and an appropriate character is selected. | |
929 | ;; If the function is invoked on a section that is complete, the character is | |
d13c8be6 | 930 | ;; rotated among the existing section adornments. |
94e9c286 SM |
931 | ;; |
932 | ;; Note that when rotating the characters, if we come to the end of the | |
d13c8be6 SM |
933 | ;; hierarchy of adornments, the variable rst-preferred-adornments is |
934 | ;; consulted to propose a new underline adornment, and if continued, we cycle | |
935 | ;; the adornments all over again. Set this variable to nil if you want to | |
936 | ;; limit the underlining character propositions to the existing adornments in | |
94e9c286 SM |
937 | ;; the file. |
938 | ;; | |
94e9c286 SM |
939 | ;; - An underline/overline that is not extended to the column at which it should |
940 | ;; be hanging is dubbed INCOMPLETE. For example:: | |
941 | ;; | |
942 | ;; |Some Title | |
943 | ;; |------- | |
944 | ;; | |
945 | ;; Examples of default invocation: | |
946 | ;; | |
947 | ;; |Some Title ---> |Some Title | |
948 | ;; | |---------- | |
949 | ;; | |
950 | ;; |Some Title ---> |Some Title | |
951 | ;; |----- |---------- | |
952 | ;; | |
953 | ;; | |------------ | |
954 | ;; | Some Title ---> | Some Title | |
955 | ;; | |------------ | |
956 | ;; | |
957 | ;; In over-and-under style, when alternating the style, a variable is | |
958 | ;; available to select how much default indent to use (it can be zero). Note | |
d13c8be6 | 959 | ;; that if the current section adornment already has an indent, we don't |
94e9c286 SM |
960 | ;; adjust it to the default, we rather use the current indent that is already |
961 | ;; there for adjustment (unless we cycle, in which case we use the indent | |
962 | ;; that has been found previously). | |
963 | ||
964 | (defgroup rst-adjust nil | |
d13c8be6 | 965 | "Settings for adjustment and cycling of section title adornments." |
94e9c286 SM |
966 | :group 'rst |
967 | :version "21.1") | |
968 | ||
d13c8be6 | 969 | (define-obsolete-variable-alias |
18dec750 | 970 | 'rst-preferred-decorations 'rst-preferred-adornments "rst 1.0.0") |
d13c8be6 SM |
971 | (defcustom rst-preferred-adornments '((?= over-and-under 1) |
972 | (?= simple 0) | |
973 | (?- simple 0) | |
974 | (?~ simple 0) | |
975 | (?+ simple 0) | |
976 | (?` simple 0) | |
977 | (?# simple 0) | |
978 | (?@ simple 0)) | |
979 | "Preferred hierarchy of section title adornments. | |
980 | ||
981 | A list consisting of lists of the form (CHARACTER STYLE INDENT). | |
6d3f7c2f SM |
982 | CHARACTER is the character used. STYLE is one of the symbols |
983 | OVER-AND-UNDER or SIMPLE. INDENT is an integer giving the wanted | |
984 | indentation for STYLE OVER-AND-UNDER. CHARACTER and STYLE are | |
985 | always used when a section adornment is described. In other | |
d13c8be6 SM |
986 | places t instead of a list stands for a transition. |
987 | ||
988 | This sequence is consulted to offer a new adornment suggestion | |
94e9c286 SM |
989 | when we rotate the underlines at the end of the existing |
990 | hierarchy of characters, or when there is no existing section | |
d13c8be6 SM |
991 | title in the file. |
992 | ||
993 | Set this to an empty list to use only the adornment found in the | |
994 | file." | |
995 | :group 'rst-adjust | |
996 | :type `(repeat | |
997 | (group :tag "Adornment specification" | |
998 | (choice :tag "Adornment character" | |
999 | ,@(mapcar (lambda (char) | |
1000 | (list 'const | |
1001 | :tag (char-to-string char) char)) | |
1002 | rst-adornment-chars)) | |
1003 | (radio :tag "Adornment type" | |
1004 | (const :tag "Overline and underline" over-and-under) | |
1005 | (const :tag "Underline only" simple)) | |
1006 | (integer :tag "Indentation for overline and underline type" | |
1007 | :value 0)))) | |
64f6a736 | 1008 | (rst-testcover-defcustom) |
94e9c286 SM |
1009 | |
1010 | (defcustom rst-default-indent 1 | |
1011 | "Number of characters to indent the section title. | |
1012 | ||
d13c8be6 SM |
1013 | This is used for when toggling adornment styles, when switching |
1014 | from a simple adornment style to a over-and-under adornment | |
94e9c286 | 1015 | style." |
d13c8be6 SM |
1016 | :group 'rst-adjust |
1017 | :type '(integer)) | |
64f6a736 | 1018 | (rst-testcover-defcustom) |
94e9c286 | 1019 | |
d13c8be6 SM |
1020 | (defun rst-compare-adornments (ado1 ado2) |
1021 | "Compare adornments. | |
1022 | Return true if both ADO1 and ADO2 adornments are equal, | |
94e9c286 | 1023 | according to restructured text semantics (only the character and |
92439579 | 1024 | the style are compared, the indentation does not matter)." |
d13c8be6 SM |
1025 | (and (eq (car ado1) (car ado2)) |
1026 | (eq (cadr ado1) (cadr ado2)))) | |
94e9c286 SM |
1027 | |
1028 | ||
d13c8be6 SM |
1029 | (defun rst-get-adornment-match (hier ado) |
1030 | "Return the index (level) in hierarchy HIER of adornment ADO. | |
94e9c286 | 1031 | This basically just searches for the item using the appropriate |
92439579 | 1032 | comparison and returns the index. Return nil if the item is |
94e9c286 SM |
1033 | not found." |
1034 | (let ((cur hier)) | |
d13c8be6 | 1035 | (while (and cur (not (rst-compare-adornments (car cur) ado))) |
94e9c286 SM |
1036 | (setq cur (cdr cur))) |
1037 | cur)) | |
1038 | ||
64f6a736 SM |
1039 | ;; testcover: FIXME: Test with `rst-preferred-adornments' == nil. Add test |
1040 | ;; `rst-adjust-no-preference'. | |
d13c8be6 SM |
1041 | (defun rst-suggest-new-adornment (allados &optional prev) |
1042 | "Suggest a new, different adornment from all that have been seen. | |
94e9c286 | 1043 | |
d13c8be6 SM |
1044 | ALLADOS is the set of all adornments, including the line numbers. |
1045 | PREV is the optional previous adornment, in order to suggest a | |
92439579 | 1046 | better match." |
94e9c286 | 1047 | |
d13c8be6 | 1048 | ;; For all the preferred adornments... |
94e9c286 SM |
1049 | (let* ( |
1050 | ;; If 'prev' is given, reorder the list to start searching after the | |
1051 | ;; match. | |
1052 | (fplist | |
d13c8be6 | 1053 | (cdr (rst-get-adornment-match rst-preferred-adornments prev))) |
94e9c286 SM |
1054 | |
1055 | ;; List of candidates to search. | |
d13c8be6 | 1056 | (curpotential (append fplist rst-preferred-adornments))) |
94e9c286 | 1057 | (while |
d13c8be6 SM |
1058 | ;; For all the adornments... |
1059 | (let ((cur allados) | |
94e9c286 SM |
1060 | found) |
1061 | (while (and cur (not found)) | |
d13c8be6 | 1062 | (if (rst-compare-adornments (car cur) (car curpotential)) |
94e9c286 SM |
1063 | ;; Found it! |
1064 | (setq found (car curpotential)) | |
1065 | (setq cur (cdr cur)))) | |
1066 | found) | |
1067 | ||
1068 | (setq curpotential (cdr curpotential))) | |
1069 | ||
b4747519 | 1070 | (copy-sequence (car curpotential)))) |
94e9c286 SM |
1071 | |
1072 | (defun rst-delete-entire-line () | |
1073 | "Delete the entire current line without using the `kill-ring'." | |
b4747519 SM |
1074 | (delete-region (line-beginning-position) |
1075 | (line-beginning-position 2))) | |
94e9c286 SM |
1076 | |
1077 | (defun rst-update-section (char style &optional indent) | |
d13c8be6 | 1078 | "Unconditionally update the style of a section adornment. |
94e9c286 | 1079 | |
92439579 JB |
1080 | Do this using the given character CHAR, with STYLE 'simple |
1081 | or 'over-and-under, and with indent INDENT. If the STYLE | |
1082 | is 'simple, whitespace before the title is removed (indent | |
1083 | is always assumed to be 0). | |
94e9c286 SM |
1084 | |
1085 | If there are existing overline and/or underline from the | |
d13c8be6 SM |
1086 | existing adornment, they are removed before adding the |
1087 | requested adornment." | |
1088 | (end-of-line) | |
8bbb7dd8 SM |
1089 | (let ((marker (point-marker)) |
1090 | len) | |
94e9c286 | 1091 | |
6d3f7c2f | 1092 | ;; Fixup whitespace at the beginning and end of the line. |
64f6a736 | 1093 | (if (or (null indent) (eq style 'simple)) ;; testcover: ok. |
94e9c286 SM |
1094 | (setq indent 0)) |
1095 | (beginning-of-line) | |
1096 | (delete-horizontal-space) | |
1097 | (insert (make-string indent ? )) | |
1098 | ||
1099 | (end-of-line) | |
1100 | (delete-horizontal-space) | |
1101 | ||
6d3f7c2f | 1102 | ;; Set the current column, we're at the end of the title line. |
94e9c286 SM |
1103 | (setq len (+ (current-column) indent)) |
1104 | ||
6d3f7c2f | 1105 | ;; Remove previous line if it is an adornment. |
94e9c286 | 1106 | (save-excursion |
64f6a736 SM |
1107 | (forward-line -1) ;; testcover: FIXME: Doesn't work when in first line |
1108 | ;; of buffer. | |
d13c8be6 SM |
1109 | (if (and (looking-at (rst-re 'ado-beg-2-1)) |
1110 | ;; Avoid removing the underline of a title right above us. | |
1111 | (save-excursion (forward-line -1) | |
1112 | (not (looking-at (rst-re 'ttl-beg))))) | |
1113 | (rst-delete-entire-line))) | |
1114 | ||
6d3f7c2f | 1115 | ;; Remove following line if it is an adornment. |
94e9c286 | 1116 | (save-excursion |
64f6a736 SM |
1117 | (forward-line +1) ;; testcover: FIXME: Doesn't work when in last line |
1118 | ;; of buffer. | |
d13c8be6 SM |
1119 | (if (looking-at (rst-re 'ado-beg-2-1)) |
1120 | (rst-delete-entire-line)) | |
94e9c286 | 1121 | ;; Add a newline if we're at the end of the buffer, for the subsequence |
6d3f7c2f | 1122 | ;; inserting of the underline. |
94e9c286 SM |
1123 | (if (= (point) (buffer-end 1)) |
1124 | (newline 1))) | |
1125 | ||
6d3f7c2f | 1126 | ;; Insert overline. |
94e9c286 SM |
1127 | (if (eq style 'over-and-under) |
1128 | (save-excursion | |
1129 | (beginning-of-line) | |
1130 | (open-line 1) | |
1131 | (insert (make-string len char)))) | |
1132 | ||
6d3f7c2f | 1133 | ;; Insert underline. |
64f6a736 SM |
1134 | (1value ;; Line has been inserted above. |
1135 | (forward-line +1)) | |
94e9c286 SM |
1136 | (open-line 1) |
1137 | (insert (make-string len char)) | |
1138 | ||
64f6a736 SM |
1139 | (1value ;; Line has been inserted above. |
1140 | (forward-line +1)) | |
1141 | (goto-char marker))) | |
94e9c286 | 1142 | |
d13c8be6 SM |
1143 | (defun rst-classify-adornment (adornment end) |
1144 | "Classify adornment for section titles and transitions. | |
1145 | ADORNMENT is the complete adornment string as found in the buffer | |
6d3f7c2f | 1146 | with optional trailing whitespace. END is the point after the |
d13c8be6 | 1147 | last character of ADORNMENT. |
94e9c286 | 1148 | |
6d3f7c2f SM |
1149 | Return a list. The first entry is t for a transition or a |
1150 | cons (CHARACTER . STYLE). Check `rst-preferred-adornments' for | |
d13c8be6 | 1151 | the meaning of CHARACTER and STYLE. |
94e9c286 | 1152 | |
d13c8be6 | 1153 | The remaining list forms four match groups as returned by |
6d3f7c2f SM |
1154 | `match-data'. Match group 0 matches the whole construct. Match |
1155 | group 1 matches the overline adornment if present. Match group 2 | |
1156 | matches the section title text or the transition. Match group 3 | |
d13c8be6 | 1157 | matches the underline adornment. |
94e9c286 | 1158 | |
d13c8be6 SM |
1159 | Return nil if no syntactically valid adornment is found." |
1160 | (save-excursion | |
1161 | (save-match-data | |
1162 | (when (string-match (rst-re 'ado-beg-2-1) adornment) | |
1163 | (goto-char end) | |
1164 | (let* ((ado-ch (string-to-char (match-string 2 adornment))) | |
1165 | (ado-re (rst-re ado-ch 'adorep3-hlp)) | |
1166 | (end-pnt (point)) | |
1167 | (beg-pnt (progn | |
64f6a736 SM |
1168 | (1value ;; No lines may be left to move. |
1169 | (forward-line 0)) | |
d13c8be6 | 1170 | (point))) |
c846da43 | 1171 | (nxt-emp ; Next line nonexistent or empty |
d13c8be6 SM |
1172 | (save-excursion |
1173 | (or (not (zerop (forward-line 1))) | |
64f6a736 SM |
1174 | ;; testcover: FIXME: Add test classifying at the end of |
1175 | ;; buffer. | |
d13c8be6 | 1176 | (looking-at (rst-re 'lin-end))))) |
c846da43 | 1177 | (prv-emp ; Previous line nonexistent or empty |
d13c8be6 SM |
1178 | (save-excursion |
1179 | (or (not (zerop (forward-line -1))) | |
1180 | (looking-at (rst-re 'lin-end))))) | |
6d3f7c2f | 1181 | (ttl-blw ; Title found below starting here. |
d13c8be6 SM |
1182 | (save-excursion |
1183 | (and | |
64f6a736 SM |
1184 | (zerop (forward-line 1)) ;; testcover: FIXME: Add test |
1185 | ;; classifying at the end of | |
1186 | ;; buffer. | |
d13c8be6 SM |
1187 | (looking-at (rst-re 'ttl-beg)) |
1188 | (point)))) | |
6d3f7c2f | 1189 | (ttl-abv ; Title found above starting here. |
d13c8be6 SM |
1190 | (save-excursion |
1191 | (and | |
1192 | (zerop (forward-line -1)) | |
1193 | (looking-at (rst-re 'ttl-beg)) | |
1194 | (point)))) | |
6d3f7c2f | 1195 | (und-fnd ; Matching underline found starting here. |
d13c8be6 SM |
1196 | (save-excursion |
1197 | (and ttl-blw | |
64f6a736 SM |
1198 | (zerop (forward-line 2)) ;; testcover: FIXME: Add test |
1199 | ;; classifying at the end of | |
1200 | ;; buffer. | |
d13c8be6 SM |
1201 | (looking-at (rst-re ado-re 'lin-end)) |
1202 | (point)))) | |
6d3f7c2f | 1203 | (ovr-fnd ; Matching overline found starting here. |
d13c8be6 SM |
1204 | (save-excursion |
1205 | (and ttl-abv | |
1206 | (zerop (forward-line -2)) | |
1207 | (looking-at (rst-re ado-re 'lin-end)) | |
1208 | (point)))) | |
1209 | key beg-ovr end-ovr beg-txt end-txt beg-und end-und) | |
1210 | (cond | |
1211 | ((and nxt-emp prv-emp) | |
6d3f7c2f | 1212 | ;; A transition. |
d13c8be6 SM |
1213 | (setq key t |
1214 | beg-txt beg-pnt | |
1215 | end-txt end-pnt)) | |
1216 | ((or und-fnd ovr-fnd) | |
6d3f7c2f | 1217 | ;; An overline with an underline. |
d13c8be6 | 1218 | (setq key (cons ado-ch 'over-and-under)) |
6d3f7c2f | 1219 | (let (;; Prefer overline match over underline match. |
d13c8be6 SM |
1220 | (und-pnt (if ovr-fnd beg-pnt und-fnd)) |
1221 | (ovr-pnt (if ovr-fnd ovr-fnd beg-pnt)) | |
1222 | (txt-pnt (if ovr-fnd ttl-abv ttl-blw))) | |
1223 | (goto-char ovr-pnt) | |
1224 | (setq beg-ovr (point) | |
1225 | end-ovr (line-end-position)) | |
1226 | (goto-char txt-pnt) | |
1227 | (setq beg-txt (point) | |
1228 | end-txt (line-end-position)) | |
1229 | (goto-char und-pnt) | |
1230 | (setq beg-und (point) | |
1231 | end-und (line-end-position)))) | |
1232 | (ttl-abv | |
6d3f7c2f | 1233 | ;; An underline. |
d13c8be6 SM |
1234 | (setq key (cons ado-ch 'simple) |
1235 | beg-und beg-pnt | |
1236 | end-und end-pnt) | |
1237 | (goto-char ttl-abv) | |
1238 | (setq beg-txt (point) | |
1239 | end-txt (line-end-position))) | |
1240 | (t | |
6d3f7c2f | 1241 | ;; Invalid adornment. |
d13c8be6 SM |
1242 | (setq key nil))) |
1243 | (if key | |
1244 | (list key | |
64f6a736 SM |
1245 | (or beg-ovr beg-txt) |
1246 | (or end-und end-txt) | |
d13c8be6 SM |
1247 | beg-ovr end-ovr beg-txt end-txt beg-und end-und))))))) |
1248 | ||
1249 | (defun rst-find-title-line () | |
1250 | "Find a section title line around point and return its characteristics. | |
1251 | If the point is on an adornment line find the respective title | |
6d3f7c2f SM |
1252 | line. If the point is on an empty line check previous or next |
1253 | line whether it is a suitable title line and use it if so. If | |
d13c8be6 SM |
1254 | point is on a suitable title line use it. |
1255 | ||
1256 | If no title line is found return nil. | |
1257 | ||
6d3f7c2f | 1258 | Otherwise return as `rst-classify-adornment' does. However, if |
d13c8be6 | 1259 | the title line has no syntactically valid adornment STYLE is nil |
6d3f7c2f | 1260 | in the first element. If there is no adornment around the title |
d13c8be6 SM |
1261 | CHARACTER is also nil and match groups for overline and underline |
1262 | are nil." | |
1263 | (save-excursion | |
64f6a736 SM |
1264 | (1value ;; No lines may be left to move. |
1265 | (forward-line 0)) | |
d13c8be6 SM |
1266 | (let ((orig-pnt (point)) |
1267 | (orig-end (line-end-position))) | |
1268 | (cond | |
1269 | ((looking-at (rst-re 'ado-beg-2-1)) | |
1270 | (let ((char (string-to-char (match-string-no-properties 2))) | |
1271 | (r (rst-classify-adornment (match-string-no-properties 0) | |
1272 | (match-end 0)))) | |
1273 | (cond | |
1274 | ((not r) | |
6d3f7c2f | 1275 | ;; Invalid adornment - check whether this is an incomplete overline. |
d13c8be6 SM |
1276 | (if (and |
1277 | (zerop (forward-line 1)) | |
1278 | (looking-at (rst-re 'ttl-beg))) | |
1279 | (list (cons char nil) orig-pnt (line-end-position) | |
1280 | orig-pnt orig-end (point) (line-end-position) nil nil))) | |
1281 | ((consp (car r)) | |
6d3f7c2f | 1282 | ;; A section title - not a transition. |
d13c8be6 SM |
1283 | r)))) |
1284 | ((looking-at (rst-re 'lin-end)) | |
1285 | (or | |
1286 | (save-excursion | |
1287 | (if (and (zerop (forward-line -1)) | |
1288 | (looking-at (rst-re 'ttl-beg))) | |
1289 | (list (cons nil nil) (point) (line-end-position) | |
1290 | nil nil (point) (line-end-position) nil nil))) | |
1291 | (save-excursion | |
1292 | (if (and (zerop (forward-line 1)) | |
1293 | (looking-at (rst-re 'ttl-beg))) | |
1294 | (list (cons nil nil) (point) (line-end-position) | |
1295 | nil nil (point) (line-end-position) nil nil))))) | |
1296 | ((looking-at (rst-re 'ttl-beg)) | |
6d3f7c2f | 1297 | ;; Try to use the underline. |
d13c8be6 | 1298 | (let ((r (rst-classify-adornment |
8f6b6da8 | 1299 | (buffer-substring-no-properties |
d13c8be6 SM |
1300 | (line-beginning-position 2) (line-end-position 2)) |
1301 | (line-end-position 2)))) | |
1302 | (if r | |
1303 | r | |
6d3f7c2f | 1304 | ;; No valid adornment found. |
d13c8be6 SM |
1305 | (list (cons nil nil) (point) (line-end-position) |
1306 | nil nil (point) (line-end-position) nil nil)))))))) | |
1307 | ||
1308 | ;; The following function and variables are used to maintain information about | |
1309 | ;; current section adornment in a buffer local cache. Thus they can be used for | |
1310 | ;; font-locking and manipulation commands. | |
1311 | ||
d13c8be6 SM |
1312 | (defvar rst-all-sections nil |
1313 | "All section adornments in the buffer as found by `rst-find-all-adornments'. | |
1314 | t when no section adornments were found.") | |
1315 | (make-variable-buffer-local 'rst-all-sections) | |
1316 | ||
1317 | ;; FIXME: If this variable is set to a different value font-locking of section | |
6d3f7c2f | 1318 | ;; headers is wrong. |
d13c8be6 SM |
1319 | (defvar rst-section-hierarchy nil |
1320 | "Section hierarchy in the buffer as determined by `rst-get-hierarchy'. | |
6d3f7c2f | 1321 | t when no section adornments were found. Value depends on |
d13c8be6 SM |
1322 | `rst-all-sections'.") |
1323 | (make-variable-buffer-local 'rst-section-hierarchy) | |
1324 | ||
64f6a736 | 1325 | (rst-testcover-add-1value 'rst-reset-section-caches) |
8f6b6da8 JB |
1326 | (defun rst-reset-section-caches () |
1327 | "Reset all section cache variables. | |
1328 | Should be called by interactive functions which deal with sections." | |
1329 | (setq rst-all-sections nil | |
1330 | rst-section-hierarchy nil)) | |
1331 | ||
d13c8be6 SM |
1332 | (defun rst-find-all-adornments () |
1333 | "Return all the section adornments in the current buffer. | |
1334 | Return a list of (LINE . ADORNMENT) with ascending LINE where | |
6d3f7c2f | 1335 | LINE is the line containing the section title. ADORNMENT consists |
d13c8be6 SM |
1336 | of a (CHARACTER STYLE INDENT) triple as described for |
1337 | `rst-preferred-adornments'. | |
1338 | ||
1339 | Uses and sets `rst-all-sections'." | |
1340 | (unless rst-all-sections | |
1341 | (let (positions) | |
1342 | ;; Iterate over all the section titles/adornments in the file. | |
1343 | (save-excursion | |
1344 | (goto-char (point-min)) | |
1345 | (while (re-search-forward (rst-re 'ado-beg-2-1) nil t) | |
1346 | (let ((ado-data (rst-classify-adornment | |
1347 | (match-string-no-properties 0) (point)))) | |
1348 | (when (and ado-data | |
6d3f7c2f | 1349 | (consp (car ado-data))) ; Ignore transitions. |
d13c8be6 | 1350 | (set-match-data (cdr ado-data)) |
6d3f7c2f | 1351 | (goto-char (match-beginning 2)) ; Goto the title start. |
d13c8be6 SM |
1352 | (push (cons (1+ (count-lines (point-min) (point))) |
1353 | (list (caar ado-data) | |
1354 | (cdar ado-data) | |
1355 | (current-indentation))) | |
1356 | positions) | |
6d3f7c2f | 1357 | (goto-char (match-end 0))))) ; Go beyond the whole thing. |
d13c8be6 SM |
1358 | (setq positions (nreverse positions)) |
1359 | (setq rst-all-sections (or positions t))))) | |
1360 | (if (eq rst-all-sections t) | |
1361 | nil | |
1362 | rst-all-sections)) | |
1363 | ||
1364 | (defun rst-infer-hierarchy (adornments) | |
1365 | "Build a hierarchy of adornments using the list of given ADORNMENTS. | |
1366 | ||
1367 | ADORNMENTS is a list of (CHARACTER STYLE INDENT) adornment | |
94e9c286 | 1368 | specifications, in order that they appear in a file, and will |
d13c8be6 SM |
1369 | infer a hierarchy of section levels by removing adornments that |
1370 | have already been seen in a forward traversal of the adornments, | |
1371 | comparing just CHARACTER and STYLE. | |
94e9c286 | 1372 | |
d13c8be6 | 1373 | Similarly returns a list of (CHARACTER STYLE INDENT), where each |
94e9c286 | 1374 | list element should be unique." |
d13c8be6 SM |
1375 | (let (hierarchy-alist) |
1376 | (dolist (x adornments) | |
94e9c286 SM |
1377 | (let ((char (car x)) |
1378 | (style (cadr x))) | |
1379 | (unless (assoc (cons char style) hierarchy-alist) | |
d13c8be6 SM |
1380 | (push (cons (cons char style) x) hierarchy-alist)))) |
1381 | (mapcar 'cdr (nreverse hierarchy-alist)))) | |
94e9c286 | 1382 | |
d13c8be6 | 1383 | (defun rst-get-hierarchy (&optional ignore) |
94e9c286 SM |
1384 | "Return the hierarchy of section titles in the file. |
1385 | ||
d13c8be6 | 1386 | Return a list of adornments that represents the hierarchy of |
6d3f7c2f SM |
1387 | section titles in the file. Each element consists of (CHARACTER |
1388 | STYLE INDENT) as described for `rst-find-all-adornments'. If the | |
d13c8be6 SM |
1389 | line number in IGNORE is specified, a possibly adornment found on |
1390 | that line is not taken into account when building the hierarchy. | |
1391 | ||
1392 | Uses and sets `rst-section-hierarchy' unless IGNORE is given." | |
1393 | (if (and (not ignore) rst-section-hierarchy) | |
1394 | (if (eq rst-section-hierarchy t) | |
1395 | nil | |
1396 | rst-section-hierarchy) | |
1397 | (let ((r (rst-infer-hierarchy | |
1398 | (mapcar 'cdr | |
1399 | (assq-delete-all | |
1400 | ignore | |
1401 | (rst-find-all-adornments)))))) | |
1402 | (setq rst-section-hierarchy | |
1403 | (if ignore | |
1404 | ;; Clear cache reflecting that a possible update is not | |
6d3f7c2f | 1405 | ;; reflected. |
d13c8be6 SM |
1406 | nil |
1407 | (or r t))) | |
1408 | r))) | |
1409 | ||
1410 | (defun rst-get-adornments-around () | |
1411 | "Return the adornments around point. | |
1412 | Return a list of the previous and next adornments." | |
1413 | (let* ((all (rst-find-all-adornments)) | |
94e9c286 SM |
1414 | (curline (line-number-at-pos)) |
1415 | prev next | |
1416 | (cur all)) | |
1417 | ||
d13c8be6 | 1418 | ;; Search for the adornments around the current line. |
94e9c286 SM |
1419 | (while (and cur (< (caar cur) curline)) |
1420 | (setq prev cur | |
1421 | cur (cdr cur))) | |
d13c8be6 | 1422 | ;; 'cur' is the following adornment. |
94e9c286 SM |
1423 | |
1424 | (if (and cur (caar cur)) | |
1425 | (setq next (if (= curline (caar cur)) (cdr cur) cur))) | |
1426 | ||
64f6a736 | 1427 | (mapcar 'cdar (list prev next)))) |
94e9c286 | 1428 | |
d13c8be6 SM |
1429 | (defun rst-adornment-complete-p (ado) |
1430 | "Return true if the adornment ADO around point is complete." | |
94e9c286 SM |
1431 | ;; Note: we assume that the detection of the overline as being the underline |
1432 | ;; of a preceding title has already been detected, and has been eliminated | |
d13c8be6 | 1433 | ;; from the adornment that is given to us. |
94e9c286 SM |
1434 | |
1435 | ;; There is some sectioning already present, so check if the current | |
1436 | ;; sectioning is complete and correct. | |
d13c8be6 SM |
1437 | (let* ((char (car ado)) |
1438 | (style (cadr ado)) | |
1439 | (indent (caddr ado)) | |
64f6a736 | 1440 | (endcol (save-excursion (end-of-line) (current-column)))) |
94e9c286 | 1441 | (if char |
d13c8be6 | 1442 | (let ((exps (rst-re "^" char (format "\\{%d\\}" (+ endcol indent)) "$"))) |
94e9c286 SM |
1443 | (and |
1444 | (save-excursion (forward-line +1) | |
1445 | (beginning-of-line) | |
1446 | (looking-at exps)) | |
1447 | (or (not (eq style 'over-and-under)) | |
1448 | (save-excursion (forward-line -1) | |
1449 | (beginning-of-line) | |
64f6a736 | 1450 | (looking-at exps)))))))) |
94e9c286 SM |
1451 | |
1452 | ||
d13c8be6 SM |
1453 | (defun rst-get-next-adornment |
1454 | (curado hier &optional suggestion reverse-direction) | |
1455 | "Get the next adornment for CURADO, in given hierarchy HIER. | |
1456 | If suggesting, suggest for new adornment SUGGESTION. | |
94e9c286 SM |
1457 | REVERSE-DIRECTION is used to reverse the cycling order." |
1458 | ||
1459 | (let* ( | |
d13c8be6 SM |
1460 | (char (car curado)) |
1461 | (style (cadr curado)) | |
94e9c286 | 1462 | |
d13c8be6 SM |
1463 | ;; Build a new list of adornments for the rotation. |
1464 | (rotados | |
94e9c286 | 1465 | (append hier |
d13c8be6 | 1466 | ;; Suggest a new adornment. |
94e9c286 | 1467 | (list suggestion |
d13c8be6 | 1468 | ;; If nothing to suggest, use first adornment. |
94e9c286 SM |
1469 | (car hier)))) ) |
1470 | (or | |
d13c8be6 | 1471 | ;; Search for next adornment. |
94e9c286 | 1472 | (cadr |
d13c8be6 SM |
1473 | (let ((cur (if reverse-direction rotados |
1474 | (reverse rotados)))) | |
94e9c286 SM |
1475 | (while (and cur |
1476 | (not (and (eq char (caar cur)) | |
1477 | (eq style (cadar cur))))) | |
1478 | (setq cur (cdr cur))) | |
1479 | cur)) | |
1480 | ||
d13c8be6 | 1481 | ;; If not found, take the first of all adornments. |
64f6a736 | 1482 | suggestion))) |
94e9c286 SM |
1483 | |
1484 | ||
6d3f7c2f | 1485 | ;; FIXME: A line "``/`` full" is not accepted as a section title. |
d13c8be6 SM |
1486 | (defun rst-adjust (pfxarg) |
1487 | "Auto-adjust the adornment around point. | |
94e9c286 | 1488 | |
6d3f7c2f SM |
1489 | Adjust/rotate the section adornment for the section title around |
1490 | point or promote/demote the adornments inside the region, | |
94e9c286 | 1491 | depending on if the region is active. This function is meant to |
fffa137c | 1492 | be invoked possibly multiple times, and can vary its behavior |
6d3f7c2f SM |
1493 | with a positive PFXARG (toggle style), or with a negative |
1494 | PFXARG (alternate behavior). | |
94e9c286 | 1495 | |
6d3f7c2f SM |
1496 | This function is a bit of a swiss knife. It is meant to adjust |
1497 | the adornments of a section title in reStructuredText. It tries | |
d13c8be6 SM |
1498 | to deal with all the possible cases gracefully and to do `the |
1499 | right thing' in all cases. | |
94e9c286 | 1500 | |
d13c8be6 | 1501 | See the documentations of `rst-adjust-adornment-work' and |
94e9c286 SM |
1502 | `rst-promote-region' for full details. |
1503 | ||
1504 | Prefix Arguments | |
1505 | ================ | |
1506 | ||
1507 | The method can take either (but not both) of | |
1508 | ||
1509 | a. a (non-negative) prefix argument, which means to toggle the | |
6d3f7c2f | 1510 | adornment style. Invoke with a prefix argument for example; |
94e9c286 SM |
1511 | |
1512 | b. a negative numerical argument, which generally inverts the | |
1513 | direction of search in the file or hierarchy. Invoke with C-- | |
1514 | prefix for example." | |
d13c8be6 | 1515 | (interactive "P") |
94e9c286 SM |
1516 | |
1517 | (let* (;; Save our original position on the current line. | |
8bbb7dd8 | 1518 | (origpt (point-marker)) |
94e9c286 | 1519 | |
d13c8be6 SM |
1520 | (reverse-direction (and pfxarg (< (prefix-numeric-value pfxarg) 0))) |
1521 | (toggle-style (and pfxarg (not reverse-direction)))) | |
94e9c286 | 1522 | |
64f6a736 | 1523 | (if (use-region-p) |
d13c8be6 SM |
1524 | ;; Adjust adornments within region. |
1525 | (rst-promote-region (and pfxarg t)) | |
1526 | ;; Adjust adornment around point. | |
1527 | (rst-adjust-adornment-work toggle-style reverse-direction)) | |
94e9c286 SM |
1528 | |
1529 | ;; Run the hooks to run after adjusting. | |
1530 | (run-hooks 'rst-adjust-hook) | |
1531 | ||
1532 | ;; Make sure to reset the cursor position properly after we're done. | |
64f6a736 | 1533 | (goto-char origpt))) |
94e9c286 | 1534 | |
d13c8be6 SM |
1535 | (defcustom rst-adjust-hook nil |
1536 | "Hooks to be run after running `rst-adjust'." | |
1537 | :group 'rst-adjust | |
1538 | :type '(hook) | |
1539 | :package-version '(rst . "1.1.0")) | |
64f6a736 | 1540 | (rst-testcover-defcustom) |
94e9c286 | 1541 | |
d13c8be6 SM |
1542 | (defcustom rst-new-adornment-down nil |
1543 | "Controls level of new adornment for section headers." | |
1544 | :group 'rst-adjust | |
1545 | :type '(choice | |
1546 | (const :tag "Same level as previous one" nil) | |
1547 | (const :tag "One level down relative to the previous one" t)) | |
1548 | :package-version '(rst . "1.1.0")) | |
64f6a736 | 1549 | (rst-testcover-defcustom) |
94e9c286 | 1550 | |
d13c8be6 SM |
1551 | (defun rst-adjust-adornment (pfxarg) |
1552 | "Call `rst-adjust-adornment-work' interactively. | |
1553 | ||
6d3f7c2f SM |
1554 | Keep this for compatibility for older bindings (are there any?). |
1555 | Argument PFXARG has the same meaning as for `rst-adjust'." | |
d13c8be6 SM |
1556 | (interactive "P") |
1557 | ||
1558 | (let* ((reverse-direction (and pfxarg (< (prefix-numeric-value pfxarg) 0))) | |
1559 | (toggle-style (and pfxarg (not reverse-direction)))) | |
1560 | (rst-adjust-adornment-work toggle-style reverse-direction))) | |
1561 | ||
1562 | (defun rst-adjust-adornment-work (toggle-style reverse-direction) | |
1563 | "Adjust/rotate the section adornment for the section title around point. | |
94e9c286 SM |
1564 | |
1565 | This function is meant to be invoked possibly multiple times, and | |
fffa137c | 1566 | can vary its behavior with a true TOGGLE-STYLE argument, or with |
94e9c286 SM |
1567 | a REVERSE-DIRECTION argument. |
1568 | ||
92439579 JB |
1569 | General Behavior |
1570 | ================ | |
94e9c286 SM |
1571 | |
1572 | The next action it takes depends on context around the point, and | |
1573 | it is meant to be invoked possibly more than once to rotate among | |
1574 | the various possibilities. Basically, this function deals with: | |
1575 | ||
d13c8be6 | 1576 | - adding a adornment if the title does not have one; |
94e9c286 SM |
1577 | |
1578 | - adjusting the length of the underline characters to fit a | |
1579 | modified title; | |
1580 | ||
d13c8be6 SM |
1581 | - rotating the adornment in the set of already existing |
1582 | sectioning adornments used in the file; | |
94e9c286 SM |
1583 | |
1584 | - switching between simple and over-and-under styles. | |
1585 | ||
1586 | You should normally not have to read all the following, just | |
1587 | invoke the method and it will do the most obvious thing that you | |
1588 | would expect. | |
1589 | ||
1590 | ||
d13c8be6 SM |
1591 | Adornment Definitions |
1592 | ===================== | |
94e9c286 | 1593 | |
d13c8be6 | 1594 | The adornments consist in |
94e9c286 SM |
1595 | |
1596 | 1. a CHARACTER | |
1597 | ||
1598 | 2. a STYLE which can be either of 'simple' or 'over-and-under'. | |
1599 | ||
1600 | 3. an INDENT (meaningful for the over-and-under style only) | |
1601 | which determines how many characters and over-and-under | |
1602 | style is hanging outside of the title at the beginning and | |
1603 | ending. | |
1604 | ||
1605 | See source code for mode details. | |
1606 | ||
1607 | ||
92439579 JB |
1608 | Detailed Behavior Description |
1609 | ============================= | |
94e9c286 SM |
1610 | |
1611 | Here are the gory details of the algorithm (it seems quite | |
1612 | complicated, but really, it does the most obvious thing in all | |
1613 | the particular cases): | |
1614 | ||
d13c8be6 | 1615 | Before applying the adornment change, the cursor is placed on |
94e9c286 SM |
1616 | the closest line that could contain a section title. |
1617 | ||
d13c8be6 SM |
1618 | Case 1: No Adornment |
1619 | -------------------- | |
94e9c286 | 1620 | |
d13c8be6 | 1621 | If the current line has no adornment around it, |
94e9c286 | 1622 | |
d13c8be6 SM |
1623 | - search backwards for the last previous adornment, and apply |
1624 | the adornment one level lower to the current line. If there | |
1625 | is no defined level below this previous adornment, we suggest | |
1626 | the most appropriate of the `rst-preferred-adornments'. | |
94e9c286 SM |
1627 | |
1628 | If REVERSE-DIRECTION is true, we simply use the previous | |
d13c8be6 | 1629 | adornment found directly. |
94e9c286 | 1630 | |
d13c8be6 SM |
1631 | - if there is no adornment found in the given direction, we use |
1632 | the first of `rst-preferred-adornments'. | |
94e9c286 | 1633 | |
d13c8be6 | 1634 | TOGGLE-STYLE forces a toggle of the prescribed adornment style. |
94e9c286 | 1635 | |
d13c8be6 SM |
1636 | Case 2: Incomplete Adornment |
1637 | ---------------------------- | |
94e9c286 | 1638 | |
d13c8be6 SM |
1639 | If the current line does have an existing adornment, but the |
1640 | adornment is incomplete, that is, the underline/overline does | |
94e9c286 SM |
1641 | not extend to exactly the end of the title line (it is either too |
1642 | short or too long), we simply extend the length of the | |
1643 | underlines/overlines to fit exactly the section title. | |
1644 | ||
d13c8be6 | 1645 | If TOGGLE-STYLE we toggle the style of the adornment as well. |
94e9c286 SM |
1646 | |
1647 | REVERSE-DIRECTION has no effect in this case. | |
1648 | ||
d13c8be6 SM |
1649 | Case 3: Complete Existing Adornment |
1650 | ----------------------------------- | |
94e9c286 | 1651 | |
d13c8be6 | 1652 | If the adornment is complete (i.e. the underline (overline) |
94e9c286 SM |
1653 | length is already adjusted to the end of the title line), we |
1654 | search/parse the file to establish the hierarchy of all the | |
d13c8be6 SM |
1655 | adornments (making sure not to include the adornment around |
1656 | point), and we rotate the current title's adornment from within | |
94e9c286 SM |
1657 | that list (by default, going *down* the hierarchy that is present |
1658 | in the file, i.e. to a lower section level). This is meant to be | |
d13c8be6 | 1659 | used potentially multiple times, until the desired adornment is |
94e9c286 SM |
1660 | found around the title. |
1661 | ||
1662 | If we hit the boundary of the hierarchy, exactly one choice from | |
d13c8be6 SM |
1663 | the list of preferred adornments is suggested/chosen, the first |
1664 | of those adornment that has not been seen in the file yet (and | |
1665 | not including the adornment around point), and the next | |
94e9c286 SM |
1666 | invocation rolls over to the other end of the hierarchy (i.e. it |
1667 | cycles). This allows you to avoid having to set which character | |
92439579 | 1668 | to use. |
94e9c286 SM |
1669 | |
1670 | If REVERSE-DIRECTION is true, the effect is to change the | |
d13c8be6 | 1671 | direction of rotation in the hierarchy of adornments, thus |
94e9c286 SM |
1672 | instead going *up* the hierarchy. |
1673 | ||
d13c8be6 SM |
1674 | However, if TOGGLE-STYLE, we do not rotate the adornment, but |
1675 | instead simply toggle the style of the current adornment (this | |
1676 | should be the most common way to toggle the style of an existing | |
1677 | complete adornment). | |
94e9c286 SM |
1678 | |
1679 | ||
1680 | Point Location | |
1681 | ============== | |
1682 | ||
1683 | The invocation of this function can be carried out anywhere | |
1684 | within the section title line, on an existing underline or | |
1685 | overline, as well as on an empty line following a section title. | |
1686 | This is meant to be as convenient as possible. | |
1687 | ||
1688 | ||
1689 | Indented Sections | |
1690 | ================= | |
1691 | ||
1692 | Indented section titles such as :: | |
1693 | ||
1694 | My Title | |
1695 | -------- | |
1696 | ||
d13c8be6 | 1697 | are invalid in reStructuredText and thus not recognized by the |
94e9c286 SM |
1698 | parser. This code will thus not work in a way that would support |
1699 | indented sections (it would be ambiguous anyway). | |
1700 | ||
1701 | ||
1702 | Joint Sections | |
1703 | ============== | |
1704 | ||
1705 | Section titles that are right next to each other may not be | |
1706 | treated well. More work might be needed to support those, and | |
d13c8be6 | 1707 | special conditions on the completeness of existing adornments |
94e9c286 SM |
1708 | might be required to make it non-ambiguous. |
1709 | ||
d13c8be6 SM |
1710 | For now we assume that the adornments are disjoint, that is, |
1711 | there is at least a single line between the titles/adornment | |
1712 | lines." | |
1713 | (rst-reset-section-caches) | |
1714 | (let ((ttl-fnd (rst-find-title-line)) | |
1715 | (orig-pnt (point))) | |
1716 | (when ttl-fnd | |
1717 | (set-match-data (cdr ttl-fnd)) | |
1718 | (goto-char (match-beginning 2)) | |
1719 | (let* ((moved (- (line-number-at-pos) (line-number-at-pos orig-pnt))) | |
1720 | (char (caar ttl-fnd)) | |
1721 | (style (cdar ttl-fnd)) | |
1722 | (indent (current-indentation)) | |
1723 | (curado (list char style indent)) | |
1724 | char-new style-new indent-new) | |
1725 | (cond | |
1726 | ;;------------------------------------------------------------------- | |
1727 | ;; Case 1: No valid adornment | |
1728 | ((not style) | |
1729 | (let ((prev (car (rst-get-adornments-around))) | |
1730 | cur | |
1731 | (hier (rst-get-hierarchy))) | |
1732 | ;; Advance one level down. | |
1733 | (setq cur | |
1734 | (if prev | |
1735 | (if (or (and rst-new-adornment-down reverse-direction) | |
1736 | (and (not rst-new-adornment-down) | |
1737 | (not reverse-direction))) | |
1738 | prev | |
1739 | (or (cadr (rst-get-adornment-match hier prev)) | |
1740 | (rst-suggest-new-adornment hier prev))) | |
1741 | (copy-sequence (car rst-preferred-adornments)))) | |
1742 | ;; Invert the style if requested. | |
1743 | (if toggle-style | |
1744 | (setcar (cdr cur) (if (eq (cadr cur) 'simple) | |
1745 | 'over-and-under 'simple)) ) | |
1746 | (setq char-new (car cur) | |
1747 | style-new (cadr cur) | |
1748 | indent-new (caddr cur)))) | |
1749 | ;;------------------------------------------------------------------- | |
1750 | ;; Case 2: Incomplete Adornment | |
1751 | ((not (rst-adornment-complete-p curado)) | |
1752 | ;; Invert the style if requested. | |
1753 | (if toggle-style | |
1754 | (setq style (if (eq style 'simple) 'over-and-under 'simple))) | |
1755 | (setq char-new char | |
1756 | style-new style | |
1757 | indent-new indent)) | |
1758 | ;;------------------------------------------------------------------- | |
1759 | ;; Case 3: Complete Existing Adornment | |
1760 | (t | |
1761 | (if toggle-style | |
1762 | ;; Simply switch the style of the current adornment. | |
1763 | (setq char-new char | |
1764 | style-new (if (eq style 'simple) 'over-and-under 'simple) | |
1765 | indent-new rst-default-indent) | |
1766 | ;; Else, we rotate, ignoring the adornment around the current | |
1767 | ;; line... | |
1768 | (let* ((hier (rst-get-hierarchy (line-number-at-pos))) | |
6d3f7c2f | 1769 | ;; Suggestion, in case we need to come up with something new. |
d13c8be6 SM |
1770 | (suggestion (rst-suggest-new-adornment |
1771 | hier | |
1772 | (car (rst-get-adornments-around)))) | |
1773 | (nextado (rst-get-next-adornment | |
1774 | curado hier suggestion reverse-direction))) | |
1775 | ;; Indent, if present, always overrides the prescribed indent. | |
1776 | (setq char-new (car nextado) | |
1777 | style-new (cadr nextado) | |
1778 | indent-new (caddr nextado)))))) | |
1779 | ;; Override indent with present indent! | |
1780 | (setq indent-new (if (> indent 0) indent indent-new)) | |
1781 | (if (and char-new style-new) | |
1782 | (rst-update-section char-new style-new indent-new)) | |
1783 | ;; Correct the position of the cursor to more accurately reflect where | |
1784 | ;; it was located when the function was invoked. | |
1785 | (unless (zerop moved) | |
1786 | (forward-line (- moved)) | |
1787 | (end-of-line)))))) | |
94e9c286 SM |
1788 | |
1789 | ;; Maintain an alias for compatibility. | |
1790 | (defalias 'rst-adjust-section-title 'rst-adjust) | |
1791 | ||
1792 | ||
d13c8be6 | 1793 | (defun rst-promote-region (demote) |
94e9c286 SM |
1794 | "Promote the section titles within the region. |
1795 | ||
e6438428 JB |
1796 | With argument DEMOTE or a prefix argument, demote the section |
1797 | titles instead. The algorithm used at the boundaries of the | |
d13c8be6 SM |
1798 | hierarchy is similar to that used by `rst-adjust-adornment-work'." |
1799 | (interactive "P") | |
1800 | (rst-reset-section-caches) | |
1801 | (let* ((cur (rst-find-all-adornments)) | |
1802 | (hier (rst-get-hierarchy)) | |
1803 | (suggestion (rst-suggest-new-adornment hier)) | |
94e9c286 SM |
1804 | |
1805 | (region-begin-line (line-number-at-pos (region-beginning))) | |
1806 | (region-end-line (line-number-at-pos (region-end))) | |
1807 | ||
64f6a736 | 1808 | marker-list) |
94e9c286 | 1809 | |
6d3f7c2f | 1810 | ;; Skip the markers that come before the region beginning. |
94e9c286 SM |
1811 | (while (and cur (< (caar cur) region-begin-line)) |
1812 | (setq cur (cdr cur))) | |
1813 | ||
d13c8be6 | 1814 | ;; Create a list of markers for all the adornments which are found within |
94e9c286 SM |
1815 | ;; the region. |
1816 | (save-excursion | |
8bbb7dd8 | 1817 | (let (line) |
94e9c286 | 1818 | (while (and cur (< (setq line (caar cur)) region-end-line)) |
e6ce8c42 GM |
1819 | (goto-char (point-min)) |
1820 | (forward-line (1- line)) | |
8bbb7dd8 | 1821 | (push (list (point-marker) (cdar cur)) marker-list) |
94e9c286 SM |
1822 | (setq cur (cdr cur)) )) |
1823 | ||
1824 | ;; Apply modifications. | |
8bbb7dd8 | 1825 | (dolist (p marker-list) |
d13c8be6 SM |
1826 | ;; Go to the adornment to promote. |
1827 | (goto-char (car p)) | |
8bbb7dd8 | 1828 | |
d13c8be6 SM |
1829 | ;; Update the adornment. |
1830 | (apply 'rst-update-section | |
1831 | ;; Rotate the next adornment. | |
1832 | (rst-get-next-adornment | |
1833 | (cadr p) hier suggestion demote)) | |
8bbb7dd8 | 1834 | |
d13c8be6 SM |
1835 | ;; Clear marker to avoid slowing down the editing after we're done. |
1836 | (set-marker (car p) nil)) | |
64f6a736 | 1837 | (setq deactivate-mark nil)))) |
94e9c286 SM |
1838 | |
1839 | ||
1840 | ||
d13c8be6 SM |
1841 | (defun rst-display-adornments-hierarchy (&optional adornments) |
1842 | "Display the current file's section title adornments hierarchy. | |
1843 | This function expects a list of (CHARACTER STYLE INDENT) triples | |
1844 | in ADORNMENTS." | |
94e9c286 | 1845 | (interactive) |
d13c8be6 SM |
1846 | (rst-reset-section-caches) |
1847 | (if (not adornments) | |
1848 | (setq adornments (rst-get-hierarchy))) | |
94e9c286 SM |
1849 | (with-output-to-temp-buffer "*rest section hierarchy*" |
1850 | (let ((level 1)) | |
1851 | (with-current-buffer standard-output | |
d13c8be6 | 1852 | (dolist (x adornments) |
94e9c286 SM |
1853 | (insert (format "\nSection Level %d" level)) |
1854 | (apply 'rst-update-section x) | |
1855 | (goto-char (point-max)) | |
1856 | (insert "\n") | |
64f6a736 | 1857 | (incf level)))))) |
94e9c286 | 1858 | |
d13c8be6 SM |
1859 | (defun rst-straighten-adornments () |
1860 | "Redo all the adornments in the current buffer. | |
1861 | This is done using our preferred set of adornments. This can be | |
94e9c286 SM |
1862 | used, for example, when using somebody else's copy of a document, |
1863 | in order to adapt it to our preferred style." | |
1864 | (interactive) | |
d13c8be6 | 1865 | (rst-reset-section-caches) |
94e9c286 | 1866 | (save-excursion |
6d3f7c2f | 1867 | (let (;; Get a list of pairs of (level . marker). |
d13c8be6 SM |
1868 | (levels-and-markers (mapcar |
1869 | (lambda (ado) | |
1870 | (cons (rst-position (cdr ado) | |
1871 | (rst-get-hierarchy)) | |
1872 | (progn | |
1873 | (goto-char (point-min)) | |
1874 | (forward-line (1- (car ado))) | |
1875 | (point-marker)))) | |
1876 | (rst-find-all-adornments)))) | |
94e9c286 | 1877 | (dolist (lm levels-and-markers) |
6d3f7c2f | 1878 | ;; Go to the appropriate position. |
94e9c286 SM |
1879 | (goto-char (cdr lm)) |
1880 | ||
6d3f7c2f | 1881 | ;; Apply the new style. |
d13c8be6 | 1882 | (apply 'rst-update-section (nth (car lm) rst-preferred-adornments)) |
94e9c286 | 1883 | |
7ae2ea10 | 1884 | ;; Reset the marker to avoid slowing down editing until it gets GC'ed. |
64f6a736 | 1885 | (set-marker (cdr lm) nil))))) |
94e9c286 | 1886 | |
d13c8be6 SM |
1887 | \f |
1888 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; | |
1889 | ;; Insert list items | |
1890 | ;; ================= | |
1891 | ||
1892 | ||
1893 | ;================================================= | |
6d3f7c2f | 1894 | ; Borrowed from a2r.el (version 1.3), by Lawrence Mitchell <wence@gmx.li>. |
d13c8be6 SM |
1895 | ; I needed to make some tiny changes to the functions, so I put it here. |
1896 | ; -- Wei-Wei Guo | |
1897 | ||
1898 | (defconst rst-arabic-to-roman | |
1899 | '((1000 . "M") (900 . "CM") (500 . "D") (400 . "CD") | |
1900 | (100 . "C") (90 . "XC") (50 . "L") (40 . "XL") | |
1901 | (10 . "X") (9 . "IX") (5 . "V") (4 . "IV") | |
1902 | (1 . "I")) | |
1903 | "List of maps between Arabic numbers and their Roman numeral equivalents.") | |
1904 | ||
1905 | (defun rst-arabic-to-roman (num &optional arg) | |
1906 | "Convert Arabic number NUM to its Roman numeral representation. | |
1907 | ||
1908 | Obviously, NUM must be greater than zero. Don't blame me, blame the | |
1909 | Romans, I mean \"what have the Romans ever _done_ for /us/?\" (with | |
1910 | apologies to Monty Python). | |
1911 | If optional prefix ARG is non-nil, insert in current buffer." | |
1912 | (let ((map rst-arabic-to-roman) | |
1913 | res) | |
1914 | (while (and map (> num 0)) | |
1915 | (if (or (= num (caar map)) | |
1916 | (> num (caar map))) | |
1917 | (setq res (concat res (cdar map)) | |
1918 | num (- num (caar map))) | |
1919 | (setq map (cdr map)))) | |
1920 | res)) | |
1921 | ||
1922 | (defun rst-roman-to-arabic (string &optional arg) | |
1923 | "Convert STRING of Roman numerals to an Arabic number. | |
1924 | ||
1925 | If STRING contains a letter which isn't a valid Roman numeral, the rest | |
1926 | of the string from that point onwards is ignored. | |
1927 | ||
1928 | Hence: | |
1929 | MMD == 2500 | |
1930 | and | |
1931 | MMDFLXXVI == 2500. | |
1932 | If optional ARG is non-nil, insert in current buffer." | |
1933 | (let ((res 0) | |
1934 | (map rst-arabic-to-roman)) | |
1935 | (while map | |
1936 | (if (string-match (concat "^" (cdar map)) string) | |
1937 | (setq res (+ res (caar map)) | |
1938 | string (replace-match "" nil t string)) | |
1939 | (setq map (cdr map)))) | |
1940 | res)) | |
1941 | ;================================================= | |
94e9c286 SM |
1942 | |
1943 | (defun rst-find-pfx-in-region (beg end pfx-re) | |
1944 | "Find all the positions of prefixes in region between BEG and END. | |
6d3f7c2f | 1945 | This is used to find bullets and enumerated list items. PFX-RE is |
d13c8be6 | 1946 | a regular expression for matching the lines after indentation |
6d3f7c2f | 1947 | with items. Returns a list of cons cells consisting of the point |
d13c8be6 | 1948 | and the column of the point." |
8bbb7dd8 | 1949 | (let ((pfx ())) |
94e9c286 SM |
1950 | (save-excursion |
1951 | (goto-char beg) | |
1952 | (while (< (point) end) | |
1953 | (back-to-indentation) | |
1954 | (when (and | |
d13c8be6 | 1955 | (looking-at pfx-re) ; pfx found and... |
94e9c286 SM |
1956 | (let ((pfx-col (current-column))) |
1957 | (save-excursion | |
d13c8be6 | 1958 | (forward-line -1) ; ...previous line is... |
94e9c286 | 1959 | (back-to-indentation) |
d13c8be6 SM |
1960 | (or (looking-at (rst-re 'lin-end)) ; ...empty, |
1961 | (> (current-column) pfx-col) ; ...deeper level, or | |
94e9c286 | 1962 | (and (= (current-column) pfx-col) |
6d3f7c2f | 1963 | (looking-at pfx-re)))))) ; ...pfx at same level. |
b4747519 SM |
1964 | (push (cons (point) (current-column)) |
1965 | pfx)) | |
64f6a736 | 1966 | (forward-line 1))) |
94e9c286 SM |
1967 | (nreverse pfx))) |
1968 | ||
d13c8be6 | 1969 | (defun rst-insert-list-pos (newitem) |
6d3f7c2f | 1970 | "Arrange relative position of a newly inserted list item of style NEWITEM. |
d13c8be6 SM |
1971 | |
1972 | Adding a new list might consider three situations: | |
94e9c286 | 1973 | |
d13c8be6 SM |
1974 | (a) Current line is a blank line. |
1975 | (b) Previous line is a blank line. | |
1976 | (c) Following line is a blank line. | |
94e9c286 | 1977 | |
d13c8be6 | 1978 | When (a) and (b), just add the new list at current line. |
94e9c286 | 1979 | |
d13c8be6 SM |
1980 | when (a) and not (b), a blank line is added before adding the new list. |
1981 | ||
1982 | When not (a), first forward point to the end of the line, and add two | |
1983 | blank lines, then add the new list. | |
1984 | ||
1985 | Other situations are just ignored and left to users themselves." | |
1986 | (if (save-excursion | |
1987 | (beginning-of-line) | |
1988 | (looking-at (rst-re 'lin-end))) | |
1989 | (if (save-excursion | |
1990 | (forward-line -1) | |
1991 | (looking-at (rst-re 'lin-end))) | |
1992 | (insert newitem " ") | |
1993 | (insert "\n" newitem " ")) | |
1994 | (end-of-line) | |
1995 | (insert "\n\n" newitem " "))) | |
1996 | ||
d8a52e15 | 1997 | ;; FIXME: Isn't this a `defconst'? |
d13c8be6 SM |
1998 | (defvar rst-initial-enums |
1999 | (let (vals) | |
2000 | (dolist (fmt '("%s." "(%s)" "%s)")) | |
2001 | (dolist (c '("1" "a" "A" "I" "i")) | |
2002 | (push (format fmt c) vals))) | |
2003 | (cons "#." (nreverse vals))) | |
2004 | "List of initial enumerations.") | |
2005 | ||
d8a52e15 | 2006 | ;; FIXME: Isn't this a `defconst'? |
d13c8be6 SM |
2007 | (defvar rst-initial-items |
2008 | (append (mapcar 'char-to-string rst-bullets) rst-initial-enums) | |
2009 | "List of initial items. It's collection of bullets and enumerations.") | |
2010 | ||
2011 | (defun rst-insert-list-new-item () | |
2012 | "Insert a new list item. | |
2013 | ||
2014 | User is asked to select the item style first, for example (a), i), +. Use TAB | |
c846da43 | 2015 | for completion and choices. |
d13c8be6 SM |
2016 | |
2017 | If user selects bullets or #, it's just added with position arranged by | |
2018 | `rst-insert-list-pos'. | |
2019 | ||
6d3f7c2f | 2020 | If user selects enumerations, a further prompt is given. User need to input a |
d13c8be6 SM |
2021 | starting item, for example 'e' for 'A)' style. The position is also arranged by |
2022 | `rst-insert-list-pos'." | |
2023 | (interactive) | |
6d3f7c2f | 2024 | ;; FIXME: Make this comply to `interactive' standards. |
d13c8be6 SM |
2025 | (let* ((itemstyle (completing-read |
2026 | "Select preferred item style [#.]: " | |
2027 | rst-initial-items nil t nil nil "#.")) | |
2028 | (cnt (if (string-match (rst-re 'cntexp-tag) itemstyle) | |
2029 | (match-string 0 itemstyle))) | |
2030 | (no | |
2031 | (save-match-data | |
6d3f7c2f | 2032 | ;; FIXME: Make this comply to `interactive' standards. |
d13c8be6 SM |
2033 | (cond |
2034 | ((equal cnt "a") | |
2035 | (let ((itemno (read-string "Give starting value [a]: " | |
2036 | nil nil "a"))) | |
2037 | (downcase (substring itemno 0 1)))) | |
2038 | ((equal cnt "A") | |
2039 | (let ((itemno (read-string "Give starting value [A]: " | |
2040 | nil nil "A"))) | |
2041 | (upcase (substring itemno 0 1)))) | |
2042 | ((equal cnt "I") | |
2043 | (let ((itemno (read-number "Give starting value [1]: " 1))) | |
2044 | (rst-arabic-to-roman itemno))) | |
2045 | ((equal cnt "i") | |
2046 | (let ((itemno (read-number "Give starting value [1]: " 1))) | |
2047 | (downcase (rst-arabic-to-roman itemno)))) | |
2048 | ((equal cnt "1") | |
2049 | (let ((itemno (read-number "Give starting value [1]: " 1))) | |
2050 | (number-to-string itemno))))))) | |
2051 | (if no | |
2052 | (setq itemstyle (replace-match no t t itemstyle))) | |
2053 | (rst-insert-list-pos itemstyle))) | |
2054 | ||
2055 | (defcustom rst-preferred-bullets | |
2056 | '(?* ?- ?+) | |
2057 | "List of favorite bullets." | |
2058 | :group 'rst | |
2059 | :type `(repeat | |
2060 | (choice ,@(mapcar (lambda (char) | |
2061 | (list 'const | |
2062 | :tag (char-to-string char) char)) | |
2063 | rst-bullets))) | |
2064 | :package-version '(rst . "1.1.0")) | |
64f6a736 | 2065 | (rst-testcover-defcustom) |
d13c8be6 SM |
2066 | |
2067 | (defun rst-insert-list-continue (curitem prefer-roman) | |
6d3f7c2f SM |
2068 | "Insert a list item with list start CURITEM including its indentation level. |
2069 | If PREFER-ROMAN roman numbering is preferred over using letters." | |
d13c8be6 SM |
2070 | (end-of-line) |
2071 | (insert | |
6d3f7c2f | 2072 | "\n" ; FIXME: Separating lines must be possible. |
d13c8be6 SM |
2073 | (cond |
2074 | ((string-match (rst-re '(:alt enmaut-tag | |
2075 | bul-tag)) curitem) | |
2076 | curitem) | |
2077 | ((string-match (rst-re 'num-tag) curitem) | |
2078 | (replace-match (number-to-string | |
2079 | (1+ (string-to-number (match-string 0 curitem)))) | |
2080 | nil nil curitem)) | |
2081 | ((and (string-match (rst-re 'rom-tag) curitem) | |
2082 | (save-match-data | |
6d3f7c2f | 2083 | (if (string-match (rst-re 'ltr-tag) curitem) ; Also a letter tag. |
d13c8be6 SM |
2084 | (save-excursion |
2085 | ;; FIXME: Assumes one line list items without separating | |
6d3f7c2f | 2086 | ;; empty lines. |
d13c8be6 SM |
2087 | (if (and (zerop (forward-line -1)) |
2088 | (looking-at (rst-re 'enmexp-beg))) | |
2089 | (string-match | |
2090 | (rst-re 'rom-tag) | |
6d3f7c2f SM |
2091 | (match-string 0)) ; Previous was a roman tag. |
2092 | prefer-roman)) ; Don't know - use flag. | |
2093 | t))) ; Not a letter tag. | |
d13c8be6 SM |
2094 | (replace-match |
2095 | (let* ((old (match-string 0 curitem)) | |
2096 | (new (save-match-data | |
2097 | (rst-arabic-to-roman | |
2098 | (1+ (rst-roman-to-arabic | |
2099 | (upcase old))))))) | |
2100 | (if (equal old (upcase old)) | |
2101 | (upcase new) | |
2102 | (downcase new))) | |
2103 | t nil curitem)) | |
2104 | ((string-match (rst-re 'ltr-tag) curitem) | |
2105 | (replace-match (char-to-string | |
2106 | (1+ (string-to-char (match-string 0 curitem)))) | |
2107 | nil nil curitem))))) | |
2108 | ||
2109 | ||
2110 | (defun rst-insert-list (&optional prefer-roman) | |
2111 | "Insert a list item at the current point. | |
2112 | ||
6d3f7c2f SM |
2113 | The command can insert a new list or a continuing list. When it is called at a |
2114 | non-list line, it will promote to insert new list. When it is called at a list | |
d13c8be6 SM |
2115 | line, it will insert a list with the same list style. |
2116 | ||
2117 | 1. When inserting a new list: | |
2118 | ||
6d3f7c2f | 2119 | User is asked to select the item style first, for example (a), i), +. Use TAB |
c846da43 | 2120 | for completion and choices. |
d13c8be6 SM |
2121 | |
2122 | (a) If user selects bullets or #, it's just added. | |
2123 | (b) If user selects enumerations, a further prompt is given. User needs to | |
2124 | input a starting item, for example 'e' for 'A)' style. | |
2125 | ||
2126 | The position of the new list is arranged according to whether or not the | |
2127 | current line and the previous line are blank lines. | |
2128 | ||
2129 | 2. When continuing a list, one thing need to be noticed: | |
2130 | ||
2131 | List style alphabetical list, such as 'a.', and roman numerical list, such as | |
2132 | 'i.', have some overlapping items, for example 'v.' The function can deal with | |
2133 | the problem elegantly in most situations. But when those overlapped list are | |
2134 | preceded by a blank line, it is hard to determine which type to use | |
2135 | automatically. The function uses alphabetical list by default. If you want | |
6d3f7c2f | 2136 | roman numerical list, just use a prefix to set PREFER-ROMAN." |
d13c8be6 SM |
2137 | (interactive "P") |
2138 | (beginning-of-line) | |
2139 | (if (looking-at (rst-re 'itmany-beg-1)) | |
2140 | (rst-insert-list-continue (match-string 0) prefer-roman) | |
2141 | (rst-insert-list-new-item))) | |
94e9c286 SM |
2142 | |
2143 | (defun rst-straighten-bullets-region (beg end) | |
2144 | "Make all the bulleted list items in the region consistent. | |
2145 | The region is specified between BEG and END. You can use this | |
2146 | after you have merged multiple bulleted lists to make them use | |
2147 | the same/correct/consistent bullet characters. | |
2148 | ||
2149 | See variable `rst-preferred-bullets' for the list of bullets to | |
2150 | adjust. If bullets are found on levels beyond the | |
2151 | `rst-preferred-bullets' list, they are not modified." | |
2152 | (interactive "r") | |
2153 | ||
d13c8be6 | 2154 | (let ((bullets (rst-find-pfx-in-region beg end (rst-re 'bul-sta))) |
94e9c286 SM |
2155 | (levtable (make-hash-table :size 4))) |
2156 | ||
2157 | ;; Create a map of levels to list of positions. | |
2158 | (dolist (x bullets) | |
2159 | (let ((key (cdr x))) | |
2160 | (puthash key | |
2161 | (append (gethash key levtable (list)) | |
2162 | (list (car x))) | |
2163 | levtable))) | |
2164 | ||
2165 | ;; Sort this map and create a new map of prefix char and list of positions. | |
b4747519 SM |
2166 | (let ((poslist ())) ; List of (indent . positions). |
2167 | (maphash (lambda (x y) (push (cons x y) poslist)) levtable) | |
2168 | ||
2169 | (let ((bullets rst-preferred-bullets)) | |
2170 | (dolist (x (sort poslist 'car-less-than-car)) | |
2171 | (when bullets | |
2172 | ;; Apply the characters. | |
2173 | (dolist (pos (cdr x)) | |
2174 | (goto-char pos) | |
2175 | (delete-char 1) | |
2176 | (insert (string (car bullets)))) | |
2177 | (setq bullets (cdr bullets)))))))) | |
94e9c286 | 2178 | |
d13c8be6 SM |
2179 | \f |
2180 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; | |
2181 | ;; Table of contents | |
2182 | ;; ================= | |
94e9c286 | 2183 | |
ee97deee | 2184 | ;; FIXME: Return value should be a `defstruct'. |
d13c8be6 | 2185 | (defun rst-section-tree () |
ee97deee SM |
2186 | "Return the hierarchical tree of section titles. |
2187 | A tree entry looks like ((TITLE MARKER) CHILD...). TITLE is the | |
2188 | stripped text of the section title. MARKER is a marker for the | |
2189 | beginning of the title text. For the top node or a missing | |
2190 | section level node TITLE is nil and MARKER points to the title | |
2191 | text of the first child. Each CHILD is another tree entry. The | |
2192 | CHILD list may be empty." | |
d13c8be6 | 2193 | (let ((hier (rst-get-hierarchy)) |
ee97deee SM |
2194 | (ch-sty2level (make-hash-table :test 'equal :size 10)) |
2195 | lev-ttl-mrk-l) | |
94e9c286 SM |
2196 | |
2197 | (let ((lev 0)) | |
d13c8be6 | 2198 | (dolist (ado hier) |
94e9c286 | 2199 | ;; Compare just the character and indent in the hash table. |
ee97deee | 2200 | (puthash (cons (car ado) (cadr ado)) lev ch-sty2level) |
94e9c286 SM |
2201 | (incf lev))) |
2202 | ||
ee97deee | 2203 | ;; Create a list that contains (LEVEL TITLE MARKER) for each adornment. |
94e9c286 | 2204 | (save-excursion |
ee97deee | 2205 | (setq lev-ttl-mrk-l |
d13c8be6 | 2206 | (mapcar (lambda (ado) |
e6ce8c42 | 2207 | (goto-char (point-min)) |
ee97deee SM |
2208 | (1value ;; This should really succeed. |
2209 | (forward-line (1- (car ado)))) | |
2210 | (list (gethash (cons (cadr ado) (caddr ado)) ch-sty2level) | |
2211 | ;; Get title. | |
2212 | (save-excursion | |
2213 | (if (re-search-forward | |
2214 | (rst-re "\\S .*\\S ") (line-end-position) t) | |
2215 | (buffer-substring-no-properties | |
2216 | (match-beginning 0) (match-end 0)) | |
2217 | "")) | |
2218 | (point-marker))) | |
d13c8be6 | 2219 | (rst-find-all-adornments)))) |
ee97deee SM |
2220 | (cdr (rst-section-tree-rec lev-ttl-mrk-l -1)))) |
2221 | ||
2222 | ;; FIXME: Return value should be a `defstruct'. | |
2223 | (defun rst-section-tree-rec (remaining lev) | |
2224 | "Process the first entry of REMAINING expected to be on level LEV. | |
2225 | REMAINING is the remaining list of adornments consisting | |
2226 | of (LEVEL TITLE MARKER) entries. | |
2227 | ||
2228 | Return (UNPROCESSED (TITLE MARKER) CHILD...) for the first entry | |
2229 | of REMAINING where TITLE is nil if the expected level is not | |
2230 | matched. UNPROCESSED is the list of still unprocessed entries. | |
2231 | Each CHILD is a child of this entry in the same format but | |
2232 | without UNPROCESSED." | |
2233 | (let ((cur (car remaining)) | |
2234 | (unprocessed remaining) | |
2235 | ttl-mrk children) | |
2236 | ;; If the current adornment matches expected level. | |
2237 | (when (and cur (= (car cur) lev)) | |
2238 | ;; Consume the current entry and create the current node with it. | |
2239 | (setq unprocessed (cdr remaining)) | |
2240 | (setq ttl-mrk (cdr cur))) | |
2241 | ||
2242 | ;; Build the child nodes as long as they have deeper level. | |
2243 | (while (and unprocessed (> (caar unprocessed) lev)) | |
2244 | (let ((rem-children (rst-section-tree-rec unprocessed (1+ lev)))) | |
2245 | (setq children (cons (cdr rem-children) children)) | |
2246 | (setq unprocessed (car rem-children)))) | |
94e9c286 SM |
2247 | (setq children (reverse children)) |
2248 | ||
ee97deee SM |
2249 | (cons unprocessed |
2250 | (cons (or ttl-mrk | |
2251 | ;; Node on this level missing - use nil as text and the | |
2252 | ;; marker of the first child. | |
2253 | (cons nil (cdaar children))) | |
2254 | children)))) | |
2255 | ||
2256 | (defun rst-section-tree-point (tree &optional point) | |
2257 | "Return section containing POINT by returning the closest node in TREE. | |
2258 | TREE is a section tree as returned by `rst-section-tree' | |
2259 | consisting of (NODE CHILD...) entries. POINT defaults to the | |
2260 | current point. A NODE must have the structure (IGNORED MARKER | |
2261 | ...). | |
2262 | ||
2263 | Return (PATH NODE CHILD...). NODE is the node where POINT is in | |
2264 | if any. PATH is a list of nodes from the top of the tree down to | |
2265 | and including NODE. List of CHILD are the children of NODE if | |
2266 | any." | |
2267 | (setq point (or point (point))) | |
2268 | (let ((cur (car tree)) | |
2269 | (children (cdr tree))) | |
2270 | ;; Point behind current node? | |
2271 | (if (and (cadr cur) (>= point (cadr cur))) | |
2272 | ;; Iterate all the children, looking for one that might contain the | |
2273 | ;; current section. | |
2274 | (let (found) | |
2275 | (while (and children (>= point (cadaar children))) | |
2276 | (setq found children | |
2277 | children (cdr children))) | |
2278 | (if found | |
2279 | ;; Found section containing point in children. | |
2280 | (let ((sub (rst-section-tree-point (car found) point))) | |
2281 | ;; Extend path with current node and return NODE CHILD... from | |
2282 | ;; sub. | |
2283 | (cons (cons cur (car sub)) (cdr sub))) | |
2284 | ;; Point in this section: Start a new path with current node and | |
2285 | ;; return current NODE CHILD... | |
2286 | (cons (list cur) tree))) | |
2287 | ;; Current node behind point: start a new path with current node and | |
2288 | ;; no NODE CHILD... | |
2289 | (list (list cur))))) | |
94e9c286 | 2290 | |
b4747519 SM |
2291 | (defgroup rst-toc nil |
2292 | "Settings for reStructuredText table of contents." | |
2293 | :group 'rst | |
2294 | :version "21.1") | |
2295 | ||
2296 | (defcustom rst-toc-indent 2 | |
2297 | "Indentation for table-of-contents display. | |
2298 | Also used for formatting insertion, when numbering is disabled." | |
2299 | :group 'rst-toc) | |
64f6a736 | 2300 | (rst-testcover-defcustom) |
b4747519 SM |
2301 | |
2302 | (defcustom rst-toc-insert-style 'fixed | |
2303 | "Insertion style for table-of-contents. | |
2304 | Set this to one of the following values to determine numbering and | |
2305 | indentation style: | |
2306 | - plain: no numbering (fixed indentation) | |
2307 | - fixed: numbering, but fixed indentation | |
2308 | - aligned: numbering, titles aligned under each other | |
2309 | - listed: numbering, with dashes like list items (EXPERIMENTAL)" | |
2310 | :group 'rst-toc) | |
64f6a736 | 2311 | (rst-testcover-defcustom) |
b4747519 SM |
2312 | |
2313 | (defcustom rst-toc-insert-number-separator " " | |
2314 | "Separator that goes between the TOC number and the title." | |
2315 | :group 'rst-toc) | |
64f6a736 | 2316 | (rst-testcover-defcustom) |
b4747519 SM |
2317 | |
2318 | ;; This is used to avoid having to change the user's mode. | |
2319 | (defvar rst-toc-insert-click-keymap | |
2320 | (let ((map (make-sparse-keymap))) | |
2321 | (define-key map [mouse-1] 'rst-toc-mode-mouse-goto) | |
2322 | map) | |
2323 | "(Internal) What happens when you click on propertized text in the TOC.") | |
2324 | ||
2325 | (defcustom rst-toc-insert-max-level nil | |
2326 | "If non-nil, maximum depth of the inserted TOC." | |
2327 | :group 'rst-toc) | |
64f6a736 | 2328 | (rst-testcover-defcustom) |
b4747519 | 2329 | |
94e9c286 SM |
2330 | (defun rst-toc-insert (&optional pfxarg) |
2331 | "Insert a simple text rendering of the table of contents. | |
2332 | By default the top level is ignored if there is only one, because | |
2333 | we assume that the document will have a single title. | |
2334 | ||
2335 | If a numeric prefix argument PFXARG is given, insert the TOC up | |
2336 | to the specified level. | |
2337 | ||
2338 | The TOC is inserted indented at the current column." | |
94e9c286 | 2339 | (interactive "P") |
d13c8be6 | 2340 | (rst-reset-section-caches) |
6d3f7c2f | 2341 | (let* (;; Check maximum level override. |
94e9c286 SM |
2342 | (rst-toc-insert-max-level |
2343 | (if (and (integerp pfxarg) (> (prefix-numeric-value pfxarg) 0)) | |
2344 | (prefix-numeric-value pfxarg) rst-toc-insert-max-level)) | |
2345 | ||
2346 | ;; Get the section tree for the current cursor point. | |
2347 | (sectree-pair | |
2348 | (rst-section-tree-point | |
d13c8be6 | 2349 | (rst-section-tree))) |
94e9c286 SM |
2350 | |
2351 | ;; Figure out initial indent. | |
2352 | (initial-indent (make-string (current-column) ? )) | |
2353 | (init-point (point))) | |
2354 | ||
2355 | (when (cddr sectree-pair) | |
2356 | (rst-toc-insert-node (cdr sectree-pair) 0 initial-indent "") | |
2357 | ||
2358 | ;; Fixup for the first line. | |
2359 | (delete-region init-point (+ init-point (length initial-indent))) | |
2360 | ||
2361 | ;; Delete the last newline added. | |
64f6a736 | 2362 | (delete-char -1)))) |
94e9c286 | 2363 | |
94e9c286 SM |
2364 | (defun rst-toc-insert-node (node level indent pfx) |
2365 | "Insert tree node NODE in table-of-contents. | |
92439579 JB |
2366 | Recursive function that does printing of the inserted toc. |
2367 | LEVEL is the depth level of the sections in the tree. | |
2368 | INDENT is the indentation string. PFX is the prefix numbering, | |
2369 | that includes the alignment necessary for all the children of | |
2370 | level to align." | |
94e9c286 SM |
2371 | |
2372 | ;; Note: we do child numbering from the parent, so we start number the | |
2373 | ;; children one level before we print them. | |
2374 | (let ((do-print (> level 0)) | |
2375 | (count 1)) | |
2376 | (when do-print | |
2377 | (insert indent) | |
2378 | (let ((b (point))) | |
2379 | (unless (equal rst-toc-insert-style 'plain) | |
2380 | (insert pfx rst-toc-insert-number-separator)) | |
2381 | (insert (or (caar node) "[missing node]")) | |
2382 | ;; Add properties to the text, even though in normal text mode it | |
2383 | ;; won't be doing anything for now. Not sure that I want to change | |
2384 | ;; mode stuff. At least the highlighting gives the idea that this | |
2385 | ;; is generated automatically. | |
2386 | (put-text-property b (point) 'mouse-face 'highlight) | |
2387 | (put-text-property b (point) 'rst-toc-target (cadar node)) | |
64f6a736 | 2388 | (put-text-property b (point) 'keymap rst-toc-insert-click-keymap)) |
94e9c286 SM |
2389 | (insert "\n") |
2390 | ||
2391 | ;; Prepare indent for children. | |
2392 | (setq indent | |
2393 | (cond | |
2394 | ((eq rst-toc-insert-style 'plain) | |
2395 | (concat indent (make-string rst-toc-indent ? ))) | |
2396 | ||
2397 | ((eq rst-toc-insert-style 'fixed) | |
2398 | (concat indent (make-string rst-toc-indent ? ))) | |
2399 | ||
2400 | ((eq rst-toc-insert-style 'aligned) | |
2401 | (concat indent (make-string (+ (length pfx) 2) ? ))) | |
2402 | ||
2403 | ((eq rst-toc-insert-style 'listed) | |
2404 | (concat (substring indent 0 -3) | |
64f6a736 | 2405 | (concat (make-string (+ (length pfx) 2) ? ) " - ")))))) |
94e9c286 SM |
2406 | |
2407 | (if (or (eq rst-toc-insert-max-level nil) | |
2408 | (< level rst-toc-insert-max-level)) | |
2409 | (let ((do-child-numbering (>= level 0)) | |
2410 | fmt) | |
2411 | (if do-child-numbering | |
2412 | (progn | |
6d3f7c2f | 2413 | ;; Add a separating dot if there is already a prefix. |
d13c8be6 SM |
2414 | (when (> (length pfx) 0) |
2415 | (string-match (rst-re "[ \t\n]*\\'") pfx) | |
2416 | (setq pfx (concat (replace-match "" t t pfx) "."))) | |
94e9c286 SM |
2417 | |
2418 | ;; Calculate the amount of space that the prefix will require | |
2419 | ;; for the numbers. | |
2420 | (if (cdr node) | |
2421 | (setq fmt (format "%%-%dd" | |
2422 | (1+ (floor (log10 (length | |
64f6a736 | 2423 | (cdr node)))))))))) |
94e9c286 SM |
2424 | |
2425 | (dolist (child (cdr node)) | |
2426 | (rst-toc-insert-node child | |
2427 | (1+ level) | |
2428 | indent | |
2429 | (if do-child-numbering | |
2430 | (concat pfx (format fmt count)) pfx)) | |
64f6a736 | 2431 | (incf count)))))) |
94e9c286 SM |
2432 | |
2433 | ||
94e9c286 SM |
2434 | (defun rst-toc-update () |
2435 | "Automatically find the contents section of a document and update. | |
2436 | Updates the inserted TOC if present. You can use this in your | |
2437 | file-write hook to always make it up-to-date automatically." | |
2438 | (interactive) | |
d13c8be6 SM |
2439 | (save-excursion |
2440 | ;; Find and delete an existing comment after the first contents directive. | |
2441 | ;; Delete that region. | |
2442 | (goto-char (point-min)) | |
2443 | ;; We look for the following and the following only (in other words, if your | |
2444 | ;; syntax differs, this won't work.). | |
2445 | ;; | |
2446 | ;; .. contents:: [...anything here...] | |
2447 | ;; [:field: value]... | |
2448 | ;; .. | |
2449 | ;; XXXXXXXX | |
2450 | ;; XXXXXXXX | |
2451 | ;; [more lines] | |
2452 | (let ((beg (re-search-forward | |
2453 | (rst-re "^" 'exm-sta "contents" 'dcl-tag ".*\n" | |
2454 | "\\(?:" 'hws-sta 'fld-tag ".*\n\\)*" 'exm-tag) nil t)) | |
2455 | last-real) | |
2456 | (when beg | |
2457 | ;; Look for the first line that starts at the first column. | |
2458 | (forward-line 1) | |
2459 | (while (and | |
2460 | (< (point) (point-max)) | |
2461 | (or (if (looking-at | |
6d3f7c2f | 2462 | (rst-re 'hws-sta "\\S ")) ; indented content. |
d13c8be6 | 2463 | (setq last-real (point))) |
6d3f7c2f | 2464 | (looking-at (rst-re 'lin-end)))) ; empty line. |
d13c8be6 SM |
2465 | (forward-line 1)) |
2466 | (if last-real | |
2467 | (progn | |
2468 | (goto-char last-real) | |
2469 | (end-of-line) | |
2470 | (delete-region beg (point))) | |
2471 | (goto-char beg)) | |
2472 | (insert "\n ") | |
2473 | (rst-toc-insert)))) | |
94e9c286 | 2474 | ;; Note: always return nil, because this may be used as a hook. |
d13c8be6 | 2475 | nil) |
94e9c286 SM |
2476 | |
2477 | ;; Note: we cannot bind the TOC update on file write because it messes with | |
2478 | ;; undo. If we disable undo, since it adds and removes characters, the | |
2479 | ;; positions in the undo list are not making sense anymore. Dunno what to do | |
2480 | ;; with this, it would be nice to update when saving. | |
2481 | ;; | |
2482 | ;; (add-hook 'write-contents-hooks 'rst-toc-update-fun) | |
2483 | ;; (defun rst-toc-update-fun () | |
2484 | ;; ;; Disable undo for the write file hook. | |
2485 | ;; (let ((buffer-undo-list t)) (rst-toc-update) )) | |
2486 | ||
d13c8be6 | 2487 | (defalias 'rst-toc-insert-update 'rst-toc-update) ; backwards compat. |
94e9c286 SM |
2488 | |
2489 | ;;------------------------------------------------------------------------------ | |
2490 | ||
2491 | (defun rst-toc-node (node level) | |
2492 | "Recursive function that does insert NODE at LEVEL in the table-of-contents." | |
2493 | ||
2494 | (if (> level 0) | |
2495 | (let ((b (point))) | |
2496 | ;; Insert line text. | |
2497 | (insert (make-string (* rst-toc-indent (1- level)) ? )) | |
2498 | (insert (or (caar node) "[missing node]")) | |
2499 | ||
2500 | ;; Highlight lines. | |
2501 | (put-text-property b (point) 'mouse-face 'highlight) | |
2502 | ||
2503 | ;; Add link on lines. | |
2504 | (put-text-property b (point) 'rst-toc-target (cadar node)) | |
2505 | ||
64f6a736 | 2506 | (insert "\n"))) |
94e9c286 SM |
2507 | |
2508 | (dolist (child (cdr node)) | |
2509 | (rst-toc-node child (1+ level)))) | |
2510 | ||
2511 | (defun rst-toc-count-lines (node target-node) | |
2512 | "Count the number of lines from NODE to the TARGET-NODE node. | |
2513 | This recursive function returns a cons of the number of | |
92439579 JB |
2514 | additional lines that have been counted for its node and |
2515 | children, and t if the node has been found." | |
94e9c286 SM |
2516 | |
2517 | (let ((count 1) | |
2518 | found) | |
2519 | (if (eq node target-node) | |
2520 | (setq found t) | |
2521 | (let ((child (cdr node))) | |
2522 | (while (and child (not found)) | |
2523 | (let ((cl (rst-toc-count-lines (car child) target-node))) | |
2524 | (setq count (+ count (car cl)) | |
2525 | found (cdr cl) | |
2526 | child (cdr child)))))) | |
2527 | (cons count found))) | |
2528 | ||
b4747519 SM |
2529 | (defvar rst-toc-buffer-name "*Table of Contents*" |
2530 | "Name of the Table of Contents buffer.") | |
2531 | ||
d13c8be6 SM |
2532 | (defvar rst-toc-return-wincfg nil |
2533 | "Window configuration to which to return when leaving the TOC.") | |
b4747519 | 2534 | |
94e9c286 SM |
2535 | |
2536 | (defun rst-toc () | |
2537 | "Display a table-of-contents. | |
d13c8be6 | 2538 | Finds all the section titles and their adornments in the |
94e9c286 SM |
2539 | file, and displays a hierarchically-organized list of the |
2540 | titles, which is essentially a table-of-contents of the | |
2541 | document. | |
2542 | ||
2543 | The Emacs buffer can be navigated, and selecting a section | |
2544 | brings the cursor in that section." | |
2545 | (interactive) | |
d13c8be6 SM |
2546 | (rst-reset-section-caches) |
2547 | (let* ((curbuf (list (current-window-configuration) (point-marker))) | |
2548 | (sectree (rst-section-tree)) | |
94e9c286 SM |
2549 | |
2550 | (our-node (cdr (rst-section-tree-point sectree))) | |
2551 | line | |
2552 | ||
2553 | ;; Create a temporary buffer. | |
64f6a736 | 2554 | (buf (get-buffer-create rst-toc-buffer-name))) |
94e9c286 SM |
2555 | |
2556 | (with-current-buffer buf | |
2557 | (let ((inhibit-read-only t)) | |
2558 | (rst-toc-mode) | |
2559 | (delete-region (point-min) (point-max)) | |
2560 | (insert (format "Table of Contents: %s\n" (or (caar sectree) ""))) | |
2561 | (put-text-property (point-min) (point) | |
2562 | 'face (list '(background-color . "gray"))) | |
2563 | (rst-toc-node sectree 0) | |
2564 | ||
2565 | ;; Count the lines to our found node. | |
2566 | (let ((linefound (rst-toc-count-lines sectree our-node))) | |
64f6a736 | 2567 | (setq line (if (cdr linefound) (car linefound) 0))))) |
94e9c286 SM |
2568 | (display-buffer buf) |
2569 | (pop-to-buffer buf) | |
2570 | ||
2571 | ;; Save the buffer to return to. | |
d13c8be6 | 2572 | (set (make-local-variable 'rst-toc-return-wincfg) curbuf) |
94e9c286 SM |
2573 | |
2574 | ;; Move the cursor near the right section in the TOC. | |
e6ce8c42 | 2575 | (goto-char (point-min)) |
64f6a736 | 2576 | (forward-line (1- line)))) |
94e9c286 SM |
2577 | |
2578 | ||
2579 | (defun rst-toc-mode-find-section () | |
2580 | "Get the section from text property at point." | |
2581 | (let ((pos (get-text-property (point) 'rst-toc-target))) | |
2582 | (unless pos | |
2583 | (error "No section on this line")) | |
2584 | (unless (buffer-live-p (marker-buffer pos)) | |
2585 | (error "Buffer for this section was killed")) | |
2586 | pos)) | |
2587 | ||
d13c8be6 SM |
2588 | ;; FIXME: Cursor before or behind the list must be handled properly; before the |
2589 | ;; list should jump to the top and behind the list to the last normal | |
6d3f7c2f | 2590 | ;; paragraph. |
94e9c286 | 2591 | (defun rst-goto-section (&optional kill) |
6d3f7c2f SM |
2592 | "Go to the section the current line describes. |
2593 | If KILL a toc buffer is destroyed." | |
94e9c286 SM |
2594 | (interactive) |
2595 | (let ((pos (rst-toc-mode-find-section))) | |
2596 | (when kill | |
6d3f7c2f | 2597 | ;; FIXME: This should rather go to `rst-toc-mode-goto-section'. |
d13c8be6 | 2598 | (set-window-configuration (car rst-toc-return-wincfg)) |
94e9c286 SM |
2599 | (kill-buffer (get-buffer rst-toc-buffer-name))) |
2600 | (pop-to-buffer (marker-buffer pos)) | |
2601 | (goto-char pos) | |
2602 | ;; FIXME: make the recentering conditional on scroll. | |
2603 | (recenter 5))) | |
2604 | ||
2605 | (defun rst-toc-mode-goto-section () | |
92439579 | 2606 | "Go to the section the current line describes and kill the TOC buffer." |
94e9c286 SM |
2607 | (interactive) |
2608 | (rst-goto-section t)) | |
2609 | ||
2610 | (defun rst-toc-mode-mouse-goto (event) | |
2611 | "In `rst-toc' mode, go to the occurrence whose line you click on. | |
2612 | EVENT is the input event." | |
2613 | (interactive "e") | |
8bbb7dd8 | 2614 | (let ((pos |
d13c8be6 SM |
2615 | (with-current-buffer (window-buffer (posn-window (event-end event))) |
2616 | (save-excursion | |
2617 | (goto-char (posn-point (event-end event))) | |
8bbb7dd8 | 2618 | (rst-toc-mode-find-section))))) |
94e9c286 SM |
2619 | (pop-to-buffer (marker-buffer pos)) |
2620 | (goto-char pos) | |
2621 | (recenter 5))) | |
2622 | ||
2623 | (defun rst-toc-mode-mouse-goto-kill (event) | |
6d3f7c2f SM |
2624 | "Same as `rst-toc-mode-mouse-goto', but kill TOC buffer as well. |
2625 | EVENT is the input event." | |
94e9c286 SM |
2626 | (interactive "e") |
2627 | (call-interactively 'rst-toc-mode-mouse-goto event) | |
2628 | (kill-buffer (get-buffer rst-toc-buffer-name))) | |
2629 | ||
94e9c286 | 2630 | (defun rst-toc-quit-window () |
b4747519 | 2631 | "Leave the current TOC buffer." |
94e9c286 | 2632 | (interactive) |
d13c8be6 SM |
2633 | (let ((retbuf rst-toc-return-wincfg)) |
2634 | (set-window-configuration (car retbuf)) | |
2635 | (goto-char (cadr retbuf)))) | |
94e9c286 SM |
2636 | |
2637 | (defvar rst-toc-mode-map | |
2638 | (let ((map (make-sparse-keymap))) | |
2639 | (define-key map [mouse-1] 'rst-toc-mode-mouse-goto-kill) | |
2640 | (define-key map [mouse-2] 'rst-toc-mode-mouse-goto) | |
2641 | (define-key map "\C-m" 'rst-toc-mode-goto-section) | |
2642 | (define-key map "f" 'rst-toc-mode-goto-section) | |
2643 | (define-key map "q" 'rst-toc-quit-window) | |
2644 | (define-key map "z" 'kill-this-buffer) | |
2645 | map) | |
2646 | "Keymap for `rst-toc-mode'.") | |
2647 | ||
2648 | (put 'rst-toc-mode 'mode-class 'special) | |
2649 | ||
b4747519 SM |
2650 | ;; Could inherit from the new `special-mode'. |
2651 | (define-derived-mode rst-toc-mode nil "ReST-TOC" | |
94e9c286 | 2652 | "Major mode for output from \\[rst-toc], the table-of-contents for the document." |
b4747519 | 2653 | (setq buffer-read-only t)) |
94e9c286 SM |
2654 | |
2655 | ;; Note: use occur-mode (replace.el) as a good example to complete missing | |
2656 | ;; features. | |
2657 | ||
94e9c286 | 2658 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; |
d13c8be6 SM |
2659 | ;; Section movement commands |
2660 | ;; ========================= | |
94e9c286 SM |
2661 | |
2662 | (defun rst-forward-section (&optional offset) | |
d13c8be6 | 2663 | "Skip to the next reStructuredText section title. |
b4747519 SM |
2664 | OFFSET specifies how many titles to skip. Use a negative OFFSET to move |
2665 | backwards in the file (default is to use 1)." | |
94e9c286 | 2666 | (interactive) |
d13c8be6 | 2667 | (rst-reset-section-caches) |
94e9c286 SM |
2668 | (let* (;; Default value for offset. |
2669 | (offset (or offset 1)) | |
2670 | ||
d13c8be6 SM |
2671 | ;; Get all the adornments in the file, with their line numbers. |
2672 | (allados (rst-find-all-adornments)) | |
94e9c286 SM |
2673 | |
2674 | ;; Get the current line. | |
2675 | (curline (line-number-at-pos)) | |
2676 | ||
d13c8be6 | 2677 | (cur allados) |
64f6a736 | 2678 | (idx 0)) |
94e9c286 | 2679 | |
d13c8be6 | 2680 | ;; Find the index of the "next" adornment w.r.t. to the current line. |
94e9c286 SM |
2681 | (while (and cur (< (caar cur) curline)) |
2682 | (setq cur (cdr cur)) | |
2683 | (incf idx)) | |
d13c8be6 | 2684 | ;; 'cur' is the adornment on or following the current line. |
94e9c286 SM |
2685 | |
2686 | (if (and (> offset 0) cur (= (caar cur) curline)) | |
2687 | (incf idx)) | |
2688 | ||
2689 | ;; Find the final index. | |
2690 | (setq idx (+ idx (if (> offset 0) (- offset 1) offset))) | |
d13c8be6 | 2691 | (setq cur (nth idx allados)) |
94e9c286 SM |
2692 | |
2693 | ;; If the index is positive, goto the line, otherwise go to the buffer | |
2694 | ;; boundaries. | |
2695 | (if (and cur (>= idx 0)) | |
e6ce8c42 GM |
2696 | (progn |
2697 | (goto-char (point-min)) | |
2698 | (forward-line (1- (car cur)))) | |
64f6a736 | 2699 | (if (> offset 0) (goto-char (point-max)) (goto-char (point-min)))))) |
94e9c286 SM |
2700 | |
2701 | (defun rst-backward-section () | |
e6438428 | 2702 | "Like `rst-forward-section', except move back one title." |
94e9c286 SM |
2703 | (interactive) |
2704 | (rst-forward-section -1)) | |
2705 | ||
6d3f7c2f SM |
2706 | ;; FIXME: What is `allow-extend' for? |
2707 | (defun rst-mark-section (&optional count allow-extend) | |
2708 | "Select COUNT sections around point. | |
2709 | Mark following sections for positive COUNT or preceding sections | |
2710 | for negative COUNT." | |
94e9c286 SM |
2711 | ;; Cloned from mark-paragraph. |
2712 | (interactive "p\np") | |
6d3f7c2f SM |
2713 | (unless count (setq count 1)) |
2714 | (when (zerop count) | |
94e9c286 SM |
2715 | (error "Cannot mark zero sections")) |
2716 | (cond ((and allow-extend | |
2717 | (or (and (eq last-command this-command) (mark t)) | |
64f6a736 | 2718 | (use-region-p))) |
94e9c286 SM |
2719 | (set-mark |
2720 | (save-excursion | |
2721 | (goto-char (mark)) | |
6d3f7c2f | 2722 | (rst-forward-section count) |
94e9c286 SM |
2723 | (point)))) |
2724 | (t | |
6d3f7c2f | 2725 | (rst-forward-section count) |
94e9c286 | 2726 | (push-mark nil t t) |
6d3f7c2f | 2727 | (rst-forward-section (- count))))) |
94e9c286 | 2728 | |
94e9c286 SM |
2729 | \f |
2730 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; | |
2731 | ;; Functions to work on item lists (e.g. indent/dedent, enumerate), which are | |
2732 | ;; always 2 or 3 characters apart horizontally with rest. | |
2733 | ||
94e9c286 | 2734 | (defun rst-find-leftmost-column (beg end) |
d13c8be6 SM |
2735 | "Return the leftmost column in region BEG to END." |
2736 | (let (mincol) | |
94e9c286 SM |
2737 | (save-excursion |
2738 | (goto-char beg) | |
2739 | (while (< (point) end) | |
2740 | (back-to-indentation) | |
d13c8be6 SM |
2741 | (unless (looking-at (rst-re 'lin-end)) |
2742 | (setq mincol (if mincol | |
2743 | (min mincol (current-column)) | |
2744 | (current-column)))) | |
2745 | (forward-line 1))) | |
94e9c286 SM |
2746 | mincol)) |
2747 | ||
6d3f7c2f SM |
2748 | ;; FIXME: This definition is old and deprecated. We need to move to the newer |
2749 | ;; version below. | |
94e9c286 SM |
2750 | (defmacro rst-iterate-leftmost-paragraphs |
2751 | (beg end first-only body-consequent body-alternative) | |
6d3f7c2f SM |
2752 | ;; FIXME: The following comment is pretty useless. |
2753 | "Call FUN at the beginning of each line, with an argument that | |
94e9c286 SM |
2754 | specifies whether we are at the first line of a paragraph that |
2755 | starts at the leftmost column of the given region BEG and END. | |
2756 | Set FIRST-ONLY to true if you want to callback on the first line | |
2757 | of each paragraph only." | |
2758 | `(save-excursion | |
2759 | (let ((leftcol (rst-find-leftmost-column ,beg ,end)) | |
8bbb7dd8 | 2760 | (endm (copy-marker ,end))) |
94e9c286 | 2761 | |
6d3f7c2f | 2762 | (do* (;; Iterate lines. |
94e9c286 SM |
2763 | (l (progn (goto-char ,beg) (back-to-indentation)) |
2764 | (progn (forward-line 1) (back-to-indentation))) | |
2765 | ||
2766 | (previous nil valid) | |
2767 | ||
2768 | (curcol (current-column) | |
2769 | (current-column)) | |
2770 | ||
2771 | (valid (and (= curcol leftcol) | |
d13c8be6 | 2772 | (not (looking-at (rst-re 'lin-end)))) |
94e9c286 | 2773 | (and (= curcol leftcol) |
64f6a736 | 2774 | (not (looking-at (rst-re 'lin-end)))))) |
b4747519 | 2775 | ((>= (point) endm)) |
94e9c286 SM |
2776 | |
2777 | (if (if ,first-only | |
2778 | (and valid (not previous)) | |
2779 | valid) | |
2780 | ,body-consequent | |
64f6a736 | 2781 | ,body-alternative))))) |
94e9c286 | 2782 | |
6d3f7c2f SM |
2783 | ;; FIXME: This needs to be refactored. Probably this is simply a function |
2784 | ;; applying BODY rather than a macro. | |
94e9c286 SM |
2785 | (defmacro rst-iterate-leftmost-paragraphs-2 (spec &rest body) |
2786 | "Evaluate BODY for each line in region defined by BEG END. | |
2787 | LEFTMOST is set to true if the line is one of the leftmost of the | |
b4747519 | 2788 | entire paragraph. PARABEGIN is set to true if the line is the |
94e9c286 | 2789 | first of a paragraph." |
b4747519 | 2790 | (declare (indent 1) (debug (sexp body))) |
94e9c286 SM |
2791 | (destructuring-bind |
2792 | (beg end parabegin leftmost isleftmost isempty) spec | |
2793 | ||
2794 | `(save-excursion | |
2795 | (let ((,leftmost (rst-find-leftmost-column ,beg ,end)) | |
8bbb7dd8 | 2796 | (endm (copy-marker ,end))) |
94e9c286 | 2797 | |
6d3f7c2f | 2798 | (do* (;; Iterate lines. |
94e9c286 SM |
2799 | (l (progn (goto-char ,beg) (back-to-indentation)) |
2800 | (progn (forward-line 1) (back-to-indentation))) | |
2801 | ||
2802 | (empty-line-previous nil ,isempty) | |
2803 | ||
d13c8be6 SM |
2804 | (,isempty (looking-at (rst-re 'lin-end)) |
2805 | (looking-at (rst-re 'lin-end))) | |
94e9c286 SM |
2806 | |
2807 | (,parabegin (not ,isempty) | |
2808 | (and empty-line-previous | |
2809 | (not ,isempty))) | |
2810 | ||
2811 | (,isleftmost (and (not ,isempty) | |
2812 | (= (current-column) ,leftmost)) | |
2813 | (and (not ,isempty) | |
64f6a736 | 2814 | (= (current-column) ,leftmost)))) |
b4747519 | 2815 | ((>= (point) endm)) |
94e9c286 | 2816 | |
64f6a736 | 2817 | (progn ,@body)))))) |
94e9c286 | 2818 | |
d13c8be6 SM |
2819 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; |
2820 | ;; Indentation | |
2821 | ||
2822 | ;; FIXME: At the moment only block comments with leading empty comment line are | |
6d3f7c2f SM |
2823 | ;; supported. Comment lines with leading comment markup should be also |
2824 | ;; supported. May be a customizable option could control which style to | |
2825 | ;; prefer. | |
d13c8be6 | 2826 | |
c846da43 | 2827 | (defgroup rst-indent nil "Settings for indentation in reStructuredText. |
d13c8be6 | 2828 | |
c846da43 | 2829 | In reStructuredText indentation points are usually determined by |
d13c8be6 | 2830 | preceding lines. Sometimes the syntax allows arbitrary |
c846da43 | 2831 | indentation points such as where to start the first line |
d13c8be6 SM |
2832 | following a directive. These indentation widths can be customized |
2833 | here." | |
2834 | :group 'rst | |
2835 | :package-version '(rst . "1.1.0")) | |
2836 | ||
2837 | (define-obsolete-variable-alias | |
18dec750 | 2838 | 'rst-shift-basic-offset 'rst-indent-width "rst 1.0.0") |
d13c8be6 SM |
2839 | (defcustom rst-indent-width 2 |
2840 | "Indentation when there is no more indentation point given." | |
2841 | :group 'rst-indent | |
2842 | :type '(integer)) | |
64f6a736 | 2843 | (rst-testcover-defcustom) |
d13c8be6 SM |
2844 | |
2845 | (defcustom rst-indent-field 3 | |
6d3f7c2f | 2846 | "Indentation for first line after a field or 0 to always indent for content." |
d13c8be6 | 2847 | :group 'rst-indent |
78d876b9 | 2848 | :package-version '(rst . "1.1.0") |
d13c8be6 | 2849 | :type '(integer)) |
64f6a736 | 2850 | (rst-testcover-defcustom) |
d13c8be6 SM |
2851 | |
2852 | (defcustom rst-indent-literal-normal 3 | |
6d3f7c2f | 2853 | "Default indentation for literal block after a markup on an own line." |
d13c8be6 | 2854 | :group 'rst-indent |
78d876b9 | 2855 | :package-version '(rst . "1.1.0") |
d13c8be6 | 2856 | :type '(integer)) |
64f6a736 | 2857 | (rst-testcover-defcustom) |
d13c8be6 SM |
2858 | |
2859 | (defcustom rst-indent-literal-minimized 2 | |
6d3f7c2f | 2860 | "Default indentation for literal block after a minimized markup." |
d13c8be6 | 2861 | :group 'rst-indent |
78d876b9 | 2862 | :package-version '(rst . "1.1.0") |
d13c8be6 | 2863 | :type '(integer)) |
64f6a736 | 2864 | (rst-testcover-defcustom) |
d13c8be6 SM |
2865 | |
2866 | (defcustom rst-indent-comment 3 | |
c846da43 | 2867 | "Default indentation for first line of a comment." |
d13c8be6 | 2868 | :group 'rst-indent |
78d876b9 | 2869 | :package-version '(rst . "1.1.0") |
d13c8be6 | 2870 | :type '(integer)) |
64f6a736 | 2871 | (rst-testcover-defcustom) |
d13c8be6 SM |
2872 | |
2873 | ;; FIXME: Must consider other tabs: | |
6d3f7c2f SM |
2874 | ;; * Line blocks |
2875 | ;; * Definition lists | |
2876 | ;; * Option lists | |
d13c8be6 SM |
2877 | (defun rst-line-tabs () |
2878 | "Return tabs of the current line or nil for no tab. | |
2879 | The list is sorted so the tab where writing continues most likely | |
6d3f7c2f SM |
2880 | is the first one. Each tab is of the form (COLUMN . INNER). |
2881 | COLUMN is the column of the tab. INNER is non-nil if this is an | |
2882 | inner tab. I.e. a tab which does come from the basic indentation | |
d13c8be6 SM |
2883 | and not from inner alignment points." |
2884 | (save-excursion | |
2885 | (forward-line 0) | |
2886 | (save-match-data | |
2887 | (unless (looking-at (rst-re 'lin-end)) | |
2888 | (back-to-indentation) | |
48d1354e | 2889 | ;; Current indentation is always the least likely tab. |
d13c8be6 | 2890 | (let ((tabs (list (list (point) 0 nil)))) ; (POINT OFFSET INNER) |
6d3f7c2f | 2891 | ;; Push inner tabs more likely to continue writing. |
d13c8be6 | 2892 | (cond |
6d3f7c2f | 2893 | ;; Item. |
d13c8be6 SM |
2894 | ((looking-at (rst-re '(:grp itmany-tag hws-sta) '(:grp "\\S ") "?")) |
2895 | (when (match-string 2) | |
2896 | (push (list (match-beginning 2) 0 t) tabs))) | |
6d3f7c2f | 2897 | ;; Field. |
d13c8be6 SM |
2898 | ((looking-at (rst-re '(:grp fld-tag) '(:grp hws-tag) |
2899 | '(:grp "\\S ") "?")) | |
2900 | (unless (zerop rst-indent-field) | |
2901 | (push (list (match-beginning 1) rst-indent-field t) tabs)) | |
2902 | (if (match-string 3) | |
2903 | (push (list (match-beginning 3) 0 t) tabs) | |
2904 | (if (zerop rst-indent-field) | |
2905 | (push (list (match-end 2) | |
2906 | (if (string= (match-string 2) "") 1 0) | |
2907 | t) tabs)))) | |
6d3f7c2f | 2908 | ;; Directive. |
d13c8be6 SM |
2909 | ((looking-at (rst-re 'dir-sta-3 '(:grp "\\S ") "?")) |
2910 | (push (list (match-end 1) 0 t) tabs) | |
2911 | (unless (string= (match-string 2) "") | |
2912 | (push (list (match-end 2) 0 t) tabs)) | |
2913 | (when (match-string 4) | |
2914 | (push (list (match-beginning 4) 0 t) tabs))) | |
6d3f7c2f | 2915 | ;; Footnote or citation definition. |
d13c8be6 SM |
2916 | ((looking-at (rst-re 'fnc-sta-2 '(:grp "\\S ") "?")) |
2917 | (push (list (match-end 1) 0 t) tabs) | |
2918 | (when (match-string 3) | |
2919 | (push (list (match-beginning 3) 0 t) tabs))) | |
6d3f7c2f | 2920 | ;; Comment. |
d13c8be6 SM |
2921 | ((looking-at (rst-re 'cmt-sta-1)) |
2922 | (push (list (point) rst-indent-comment t) tabs))) | |
6d3f7c2f | 2923 | ;; Start of literal block. |
d13c8be6 SM |
2924 | (when (looking-at (rst-re 'lit-sta-2)) |
2925 | (let ((tab0 (first tabs))) | |
2926 | (push (list (first tab0) | |
2927 | (+ (second tab0) | |
2928 | (if (match-string 1) | |
2929 | rst-indent-literal-minimized | |
2930 | rst-indent-literal-normal)) | |
2931 | t) tabs))) | |
2932 | (mapcar (lambda (tab) | |
2933 | (goto-char (first tab)) | |
2934 | (cons (+ (current-column) (second tab)) (third tab))) | |
2935 | tabs)))))) | |
2936 | ||
2937 | (defun rst-compute-tabs (pt) | |
2938 | "Build the list of possible tabs for all lines above. | |
2939 | Search backwards from point PT to build the list of possible | |
6d3f7c2f SM |
2940 | tabs. Return a list of tabs sorted by likeliness to continue |
2941 | writing like `rst-line-tabs'. Nearer lines have generally a | |
2942 | higher likeliness than farther lines. Return nil if no tab is found | |
d13c8be6 SM |
2943 | in the text above." |
2944 | (save-excursion | |
2945 | (goto-char pt) | |
6d3f7c2f SM |
2946 | (let (leftmost ; Leftmost column found so far. |
2947 | innermost ; Leftmost column for inner tab. | |
d13c8be6 SM |
2948 | tablist) |
2949 | (while (and (zerop (forward-line -1)) | |
2950 | (or (not leftmost) | |
2951 | (> leftmost 0))) | |
2952 | (let* ((tabs (rst-line-tabs)) | |
2953 | (leftcol (if tabs (apply 'min (mapcar 'car tabs))))) | |
2954 | (when tabs | |
6d3f7c2f | 2955 | ;; Consider only lines indented less or same if not INNERMOST. |
d13c8be6 SM |
2956 | (when (or (not leftmost) |
2957 | (< leftcol leftmost) | |
2958 | (and (not innermost) (= leftcol leftmost))) | |
2959 | (dolist (tab tabs) | |
2960 | (let ((inner (cdr tab)) | |
2961 | (newcol (car tab))) | |
2962 | (when (and | |
2963 | (or | |
2964 | (and (not inner) | |
2965 | (or (not leftmost) | |
2966 | (< newcol leftmost))) | |
2967 | (and inner | |
2968 | (or (not innermost) | |
2969 | (< newcol innermost)))) | |
2970 | (not (memq newcol tablist))) | |
2971 | (push newcol tablist)))) | |
7b4cdbf4 | 2972 | (setq innermost (if (rst-some (mapcar 'cdr tabs)) ; Has inner. |
d13c8be6 SM |
2973 | leftcol |
2974 | innermost)) | |
2975 | (setq leftmost leftcol))))) | |
2976 | (nreverse tablist)))) | |
2977 | ||
2978 | (defun rst-indent-line (&optional dflt) | |
2979 | "Indent current line to next best reStructuredText tab. | |
2980 | The next best tab is taken from the tab list returned by | |
6d3f7c2f SM |
2981 | `rst-compute-tabs' which is used in a cyclic manner. If the |
2982 | current indentation does not end on a tab use the first one. If | |
2983 | the current indentation is on a tab use the next tab. This allows | |
d13c8be6 | 2984 | a repeated use of \\[indent-for-tab-command] to cycle through all |
6d3f7c2f SM |
2985 | possible tabs. If no indentation is possible return `noindent' or |
2986 | use DFLT. Return the indentation indented to. When point is in | |
2987 | indentation it ends up at its end. Otherwise the point is kept | |
d13c8be6 SM |
2988 | relative to the content." |
2989 | (let* ((pt (point-marker)) | |
2990 | (cur (current-indentation)) | |
2991 | (clm (current-column)) | |
2992 | (tabs (rst-compute-tabs (point))) | |
7b4cdbf4 | 2993 | (fnd (rst-position cur tabs)) |
d13c8be6 SM |
2994 | ind) |
2995 | (if (and (not tabs) (not dflt)) | |
2996 | 'noindent | |
2997 | (if (not tabs) | |
2998 | (setq ind dflt) | |
2999 | (if (not fnd) | |
3000 | (setq fnd 0) | |
3001 | (setq fnd (1+ fnd)) | |
3002 | (if (>= fnd (length tabs)) | |
3003 | (setq fnd 0))) | |
3004 | (setq ind (nth fnd tabs))) | |
3005 | (indent-line-to ind) | |
3006 | (if (> clm cur) | |
3007 | (goto-char pt)) | |
3008 | (set-marker pt nil) | |
3009 | ind))) | |
3010 | ||
3011 | (defun rst-shift-region (beg end cnt) | |
3012 | "Shift region BEG to END by CNT tabs. | |
3013 | Shift by one tab to the right (CNT > 0) or left (CNT < 0) or | |
6d3f7c2f SM |
3014 | remove all indentation (CNT = 0). A tab is taken from the text |
3015 | above. If no suitable tab is found `rst-indent-width' is used." | |
d13c8be6 SM |
3016 | (interactive "r\np") |
3017 | (let ((tabs (sort (rst-compute-tabs beg) (lambda (x y) (<= x y)))) | |
3018 | (leftmostcol (rst-find-leftmost-column beg end))) | |
3019 | (when (or (> leftmostcol 0) (> cnt 0)) | |
6d3f7c2f | 3020 | ;; Apply the indent. |
d13c8be6 SM |
3021 | (indent-rigidly |
3022 | beg end | |
3023 | (if (zerop cnt) | |
3024 | (- leftmostcol) | |
6d3f7c2f | 3025 | ;; Find the next tab after the leftmost column. |
d13c8be6 SM |
3026 | (let* ((cmp (if (> cnt 0) '> '<)) |
3027 | (tabs (if (> cnt 0) tabs (reverse tabs))) | |
3028 | (len (length tabs)) | |
7b4cdbf4 | 3029 | (dir (rst-signum cnt)) ; Direction to take. |
6d3f7c2f SM |
3030 | (abs (abs cnt)) ; Absolute number of steps to take. |
3031 | ;; Get the position of the first tab beyond leftmostcol. | |
7b4cdbf4 SM |
3032 | (fnd (lexical-let ((cmp cmp) |
3033 | (leftmostcol leftmostcol)) ; Create closure. | |
3034 | (rst-position-if (lambda (elt) | |
3035 | (funcall cmp elt leftmostcol)) | |
3036 | tabs))) | |
6d3f7c2f | 3037 | ;; Virtual position of tab. |
d13c8be6 SM |
3038 | (pos (+ (or fnd len) (1- abs))) |
3039 | (tab (if (< pos len) | |
6d3f7c2f | 3040 | ;; Tab exists - use it. |
d13c8be6 | 3041 | (nth pos tabs) |
6d3f7c2f | 3042 | ;; Column needs to be computed. |
d13c8be6 | 3043 | (let ((col (+ (or (car (last tabs)) leftmostcol) |
6d3f7c2f SM |
3044 | ;; Base on last known column. |
3045 | (* (- pos (1- len)) ; Distance left. | |
3046 | dir ; Direction to take. | |
d13c8be6 SM |
3047 | rst-indent-width)))) |
3048 | (if (< col 0) 0 col))))) | |
3049 | (- tab leftmostcol))))))) | |
3050 | ||
3051 | ;; FIXME: A paragraph with an (incorrectly) indented second line is not filled | |
6d3f7c2f | 3052 | ;; correctly:: |
d13c8be6 | 3053 | ;; |
6d3f7c2f SM |
3054 | ;; Some start |
3055 | ;; continued wrong | |
d13c8be6 SM |
3056 | (defun rst-adaptive-fill () |
3057 | "Return fill prefix found at point. | |
3058 | Value for `adaptive-fill-function'." | |
3059 | (let ((fnd (if (looking-at adaptive-fill-regexp) | |
3060 | (match-string-no-properties 0)))) | |
3061 | (if (save-match-data | |
3062 | (not (string-match comment-start-skip fnd))) | |
6d3f7c2f | 3063 | ;; An non-comment prefix is fine. |
d13c8be6 | 3064 | fnd |
6d3f7c2f | 3065 | ;; Matches a comment - return whitespace instead. |
d13c8be6 SM |
3066 | (make-string (- |
3067 | (save-excursion | |
3068 | (goto-char (match-end 0)) | |
3069 | (current-column)) | |
3070 | (save-excursion | |
3071 | (goto-char (match-beginning 0)) | |
3072 | (current-column))) ? )))) | |
3073 | ||
3074 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; | |
3075 | ;; Comments | |
3076 | ||
3077 | (defun rst-comment-line-break (&optional soft) | |
3078 | "Break line and indent, continuing reStructuredText comment if within one. | |
6d3f7c2f SM |
3079 | Value for `comment-line-break-function'. If SOFT use soft |
3080 | newlines as mandated by `comment-line-break-function'." | |
d13c8be6 SM |
3081 | (if soft |
3082 | (insert-and-inherit ?\n) | |
3083 | (newline 1)) | |
3084 | (save-excursion | |
3085 | (forward-char -1) | |
3086 | (delete-horizontal-space)) | |
3087 | (delete-horizontal-space) | |
3088 | (let ((tabs (rst-compute-tabs (point)))) | |
3089 | (when tabs | |
3090 | (indent-line-to (car tabs))))) | |
3091 | ||
3092 | (defun rst-comment-indent () | |
3093 | "Return indentation for current comment line." | |
3094 | (car (rst-compute-tabs (point)))) | |
3095 | ||
3096 | (defun rst-comment-insert-comment () | |
3097 | "Insert a comment in the current line." | |
3098 | (rst-indent-line 0) | |
3099 | (insert comment-start)) | |
3100 | ||
3101 | (defun rst-comment-region (beg end &optional arg) | |
6d3f7c2f SM |
3102 | "Comment or uncomment the current region. |
3103 | Region is from from BEG to END. Uncomment if ARG." | |
d13c8be6 SM |
3104 | (save-excursion |
3105 | (if (consp arg) | |
3106 | (rst-uncomment-region beg end arg) | |
3107 | (goto-char beg) | |
3108 | (let ((ind (current-indentation)) | |
3109 | bol) | |
3110 | (forward-line 0) | |
3111 | (setq bol (point)) | |
3112 | (indent-rigidly bol end rst-indent-comment) | |
3113 | (goto-char bol) | |
3114 | (open-line 1) | |
3115 | (indent-line-to ind) | |
3116 | (insert (comment-string-strip comment-start t t)))))) | |
3117 | ||
3118 | (defun rst-uncomment-region (beg end &optional arg) | |
3119 | "Uncomment the current region. | |
6d3f7c2f | 3120 | Region is from BEG to END. ARG is ignored" |
d13c8be6 SM |
3121 | (save-excursion |
3122 | (let (bol eol) | |
3123 | (goto-char beg) | |
3124 | (forward-line 0) | |
3125 | (setq bol (point)) | |
3126 | (forward-line 1) | |
3127 | (setq eol (point)) | |
3128 | (indent-rigidly eol end (- rst-indent-comment)) | |
3129 | (delete-region bol eol)))) | |
94e9c286 | 3130 | |
b4747519 SM |
3131 | ;;------------------------------------------------------------------------------ |
3132 | ||
6d3f7c2f SM |
3133 | ;; FIXME: These next functions should become part of a larger effort to redo |
3134 | ;; the bullets in bulleted lists. The enumerate would just be one of | |
3135 | ;; the possible outputs. | |
b4747519 | 3136 | ;; |
d13c8be6 | 3137 | ;; FIXME: We need to do the enumeration removal as well. |
b4747519 | 3138 | |
d13c8be6 | 3139 | (defun rst-enumerate-region (beg end all) |
b4747519 | 3140 | "Add enumeration to all the leftmost paragraphs in the given region. |
d13c8be6 | 3141 | The region is specified between BEG and END. With ALL, |
b4747519 | 3142 | do all lines instead of just paragraphs." |
d13c8be6 | 3143 | (interactive "r\nP") |
b4747519 SM |
3144 | (let ((count 0) |
3145 | (last-insert-len nil)) | |
3146 | (rst-iterate-leftmost-paragraphs | |
d13c8be6 | 3147 | beg end (not all) |
b4747519 SM |
3148 | (let ((ins-string (format "%d. " (incf count)))) |
3149 | (setq last-insert-len (length ins-string)) | |
3150 | (insert ins-string)) | |
64f6a736 | 3151 | (insert (make-string last-insert-len ?\ ))))) |
b4747519 | 3152 | |
d13c8be6 | 3153 | (defun rst-bullet-list-region (beg end all) |
b4747519 | 3154 | "Add bullets to all the leftmost paragraphs in the given region. |
d13c8be6 | 3155 | The region is specified between BEG and END. With ALL, |
b4747519 | 3156 | do all lines instead of just paragraphs." |
d13c8be6 | 3157 | (interactive "r\nP") |
b4747519 | 3158 | (rst-iterate-leftmost-paragraphs |
d13c8be6 SM |
3159 | beg end (not all) |
3160 | (insert (car rst-preferred-bullets) " ") | |
64f6a736 | 3161 | (insert " "))) |
b4747519 | 3162 | |
6d3f7c2f SM |
3163 | ;; FIXME: Does not deal with a varying number of digits appropriately. |
3164 | ;; FIXME: Does not deal with multiple levels independently. | |
3165 | ;; FIXME: Does not indent a multiline item correctly. | |
94e9c286 | 3166 | (defun rst-convert-bullets-to-enumeration (beg end) |
d13c8be6 | 3167 | "Convert the bulleted and enumerated items in the region to enumerated lists. |
6d3f7c2f | 3168 | Renumber as necessary. Region is from BEG to END." |
94e9c286 SM |
3169 | (interactive "r") |
3170 | (let* (;; Find items and convert the positions to markers. | |
3171 | (items (mapcar | |
3172 | (lambda (x) | |
8bbb7dd8 | 3173 | (cons (copy-marker (car x)) |
94e9c286 | 3174 | (cdr x))) |
d13c8be6 | 3175 | (rst-find-pfx-in-region beg end (rst-re 'itmany-sta-1)))) |
64f6a736 | 3176 | (count 1)) |
94e9c286 SM |
3177 | (save-excursion |
3178 | (dolist (x items) | |
3179 | (goto-char (car x)) | |
d13c8be6 SM |
3180 | (looking-at (rst-re 'itmany-beg-1)) |
3181 | (replace-match (format "%d." count) nil nil nil 1) | |
64f6a736 | 3182 | (incf count))))) |
94e9c286 SM |
3183 | |
3184 | ;;------------------------------------------------------------------------------ | |
3185 | ||
3186 | (defun rst-line-block-region (rbeg rend &optional pfxarg) | |
b4747519 | 3187 | "Toggle line block prefixes for a region. |
6d3f7c2f | 3188 | Region is from RBEG to REND. With PFXARG set the empty lines too." |
94e9c286 SM |
3189 | (interactive "r\nP") |
3190 | (let ((comment-start "| ") | |
3191 | (comment-end "") | |
3192 | (comment-start-skip "| ") | |
3193 | (comment-style 'indent) | |
b4747519 | 3194 | (force (not (not pfxarg)))) |
94e9c286 | 3195 | (rst-iterate-leftmost-paragraphs-2 |
b4747519 SM |
3196 | (rbeg rend parbegin leftmost isleft isempty) |
3197 | (when (or force (not isempty)) | |
3198 | (move-to-column leftmost force) | |
3199 | (delete-region (point) (+ (point) (- (current-indentation) leftmost))) | |
3200 | (insert "| "))))) | |
94e9c286 SM |
3201 | |
3202 | ||
3203 | \f | |
3204 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; | |
d13c8be6 SM |
3205 | ;; Font lock |
3206 | ;; ========= | |
94e9c286 SM |
3207 | |
3208 | (require 'font-lock) | |
3209 | ||
6d3f7c2f | 3210 | ;; FIXME: The obsolete variables need to disappear. |
d13c8be6 | 3211 | |
7b4cdbf4 SM |
3212 | ;; The following versions have been done inside Emacs and should not be |
3213 | ;; replaced by `:package-version' attributes until a change. | |
d8a52e15 | 3214 | |
92439579 | 3215 | (defgroup rst-faces nil "Faces used in Rst Mode." |
94e9c286 SM |
3216 | :group 'rst |
3217 | :group 'faces | |
3218 | :version "21.1") | |
3219 | ||
2b1400b9 GM |
3220 | (defface rst-block '((t :inherit font-lock-keyword-face)) |
3221 | "Face used for all syntax marking up a special block." | |
3222 | :version "24.1" | |
3223 | :group 'rst-faces) | |
3224 | ||
3225 | (defcustom rst-block-face 'rst-block | |
b4747519 | 3226 | "All syntax marking up a special block." |
2b1400b9 | 3227 | :version "24.1" |
94e9c286 SM |
3228 | :group 'rst-faces |
3229 | :type '(face)) | |
64f6a736 | 3230 | (rst-testcover-defcustom) |
2b1400b9 GM |
3231 | (make-obsolete-variable 'rst-block-face |
3232 | "customize the face `rst-block' instead." | |
3233 | "24.1") | |
3234 | ||
3235 | (defface rst-external '((t :inherit font-lock-type-face)) | |
3236 | "Face used for field names and interpreted text." | |
3237 | :version "24.1" | |
3238 | :group 'rst-faces) | |
94e9c286 | 3239 | |
2b1400b9 | 3240 | (defcustom rst-external-face 'rst-external |
b4747519 | 3241 | "Field names and interpreted text." |
2b1400b9 | 3242 | :version "24.1" |
94e9c286 SM |
3243 | :group 'rst-faces |
3244 | :type '(face)) | |
64f6a736 | 3245 | (rst-testcover-defcustom) |
2b1400b9 GM |
3246 | (make-obsolete-variable 'rst-external-face |
3247 | "customize the face `rst-external' instead." | |
3248 | "24.1") | |
94e9c286 | 3249 | |
2b1400b9 GM |
3250 | (defface rst-definition '((t :inherit font-lock-function-name-face)) |
3251 | "Face used for all other defining constructs." | |
3252 | :version "24.1" | |
3253 | :group 'rst-faces) | |
3254 | ||
3255 | (defcustom rst-definition-face 'rst-definition | |
b4747519 | 3256 | "All other defining constructs." |
2b1400b9 | 3257 | :version "24.1" |
94e9c286 SM |
3258 | :group 'rst-faces |
3259 | :type '(face)) | |
64f6a736 | 3260 | (rst-testcover-defcustom) |
2b1400b9 GM |
3261 | (make-obsolete-variable 'rst-definition-face |
3262 | "customize the face `rst-definition' instead." | |
3263 | "24.1") | |
3264 | ||
3265 | ;; XEmacs compatibility (?). | |
3266 | (defface rst-directive (if (boundp 'font-lock-builtin-face) | |
3267 | '((t :inherit font-lock-builtin-face)) | |
3268 | '((t :inherit font-lock-preprocessor-face))) | |
3269 | "Face used for directives and roles." | |
3270 | :version "24.1" | |
3271 | :group 'rst-faces) | |
3272 | ||
3273 | (defcustom rst-directive-face 'rst-directive | |
b4747519 | 3274 | "Directives and roles." |
94e9c286 SM |
3275 | :group 'rst-faces |
3276 | :type '(face)) | |
64f6a736 | 3277 | (rst-testcover-defcustom) |
2b1400b9 GM |
3278 | (make-obsolete-variable 'rst-directive-face |
3279 | "customize the face `rst-directive' instead." | |
3280 | "24.1") | |
94e9c286 | 3281 | |
2b1400b9 GM |
3282 | (defface rst-comment '((t :inherit font-lock-comment-face)) |
3283 | "Face used for comments." | |
3284 | :version "24.1" | |
3285 | :group 'rst-faces) | |
3286 | ||
3287 | (defcustom rst-comment-face 'rst-comment | |
b4747519 | 3288 | "Comments." |
2b1400b9 | 3289 | :version "24.1" |
94e9c286 SM |
3290 | :group 'rst-faces |
3291 | :type '(face)) | |
64f6a736 | 3292 | (rst-testcover-defcustom) |
2b1400b9 GM |
3293 | (make-obsolete-variable 'rst-comment-face |
3294 | "customize the face `rst-comment' instead." | |
3295 | "24.1") | |
3296 | ||
3297 | (defface rst-emphasis1 '((t :inherit italic)) | |
3298 | "Face used for simple emphasis." | |
3299 | :version "24.1" | |
3300 | :group 'rst-faces) | |
94e9c286 | 3301 | |
2b1400b9 | 3302 | (defcustom rst-emphasis1-face 'rst-emphasis1 |
b4747519 | 3303 | "Simple emphasis." |
2b1400b9 | 3304 | :version "24.1" |
94e9c286 SM |
3305 | :group 'rst-faces |
3306 | :type '(face)) | |
64f6a736 | 3307 | (rst-testcover-defcustom) |
2b1400b9 GM |
3308 | (make-obsolete-variable 'rst-emphasis1-face |
3309 | "customize the face `rst-emphasis1' instead." | |
3310 | "24.1") | |
94e9c286 | 3311 | |
2b1400b9 GM |
3312 | (defface rst-emphasis2 '((t :inherit bold)) |
3313 | "Face used for double emphasis." | |
3314 | :version "24.1" | |
3315 | :group 'rst-faces) | |
3316 | ||
3317 | (defcustom rst-emphasis2-face 'rst-emphasis2 | |
b4747519 | 3318 | "Double emphasis." |
94e9c286 SM |
3319 | :group 'rst-faces |
3320 | :type '(face)) | |
64f6a736 | 3321 | (rst-testcover-defcustom) |
2b1400b9 GM |
3322 | (make-obsolete-variable 'rst-emphasis2-face |
3323 | "customize the face `rst-emphasis2' instead." | |
3324 | "24.1") | |
3325 | ||
3326 | (defface rst-literal '((t :inherit font-lock-string-face)) | |
3327 | "Face used for literal text." | |
3328 | :version "24.1" | |
3329 | :group 'rst-faces) | |
94e9c286 | 3330 | |
2b1400b9 | 3331 | (defcustom rst-literal-face 'rst-literal |
b4747519 | 3332 | "Literal text." |
2b1400b9 | 3333 | :version "24.1" |
94e9c286 SM |
3334 | :group 'rst-faces |
3335 | :type '(face)) | |
64f6a736 | 3336 | (rst-testcover-defcustom) |
2b1400b9 GM |
3337 | (make-obsolete-variable 'rst-literal-face |
3338 | "customize the face `rst-literal' instead." | |
3339 | "24.1") | |
94e9c286 | 3340 | |
2b1400b9 GM |
3341 | (defface rst-reference '((t :inherit font-lock-variable-name-face)) |
3342 | "Face used for references to a definition." | |
3343 | :version "24.1" | |
3344 | :group 'rst-faces) | |
3345 | ||
3346 | (defcustom rst-reference-face 'rst-reference | |
b4747519 | 3347 | "References to a definition." |
2b1400b9 | 3348 | :version "24.1" |
94e9c286 SM |
3349 | :group 'rst-faces |
3350 | :type '(face)) | |
64f6a736 | 3351 | (rst-testcover-defcustom) |
2b1400b9 GM |
3352 | (make-obsolete-variable 'rst-reference-face |
3353 | "customize the face `rst-reference' instead." | |
3354 | "24.1") | |
94e9c286 | 3355 | |
d8a52e15 SM |
3356 | (defface rst-transition '((t :inherit font-lock-keyword-face)) |
3357 | "Face used for a transition." | |
7b4cdbf4 | 3358 | :package-version '(rst . "1.3.0") |
d8a52e15 SM |
3359 | :group 'rst-faces) |
3360 | ||
3361 | (defface rst-adornment '((t :inherit font-lock-keyword-face)) | |
3362 | "Face used for the adornment of a section header." | |
7b4cdbf4 | 3363 | :package-version '(rst . "1.3.0") |
d8a52e15 SM |
3364 | :group 'rst-faces) |
3365 | ||
94e9c286 SM |
3366 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; |
3367 | ||
48a24920 SM |
3368 | (dolist (var '(rst-level-face-max rst-level-face-base-color |
3369 | rst-level-face-base-light | |
3370 | rst-level-face-format-light | |
3371 | rst-level-face-step-light | |
3372 | rst-level-1-face | |
3373 | rst-level-2-face | |
3374 | rst-level-3-face | |
3375 | rst-level-4-face | |
3376 | rst-level-5-face | |
3377 | rst-level-6-face)) | |
3378 | (make-obsolete-variable var "customize the faces `rst-level-*' instead." | |
3379 | "24.3")) | |
3380 | ||
3381 | ;; Define faces for the first 6 levels. More levels are possible, however. | |
3382 | (defface rst-level-1 '((((background light)) (:background "grey85")) | |
3383 | (((background dark)) (:background "grey15"))) | |
3384 | "Default face for section title text at level 1." | |
3385 | :package-version '(rst . "1.4.0")) | |
3386 | ||
3387 | (defface rst-level-2 '((((background light)) (:background "grey78")) | |
3388 | (((background dark)) (:background "grey22"))) | |
3389 | "Default face for section title text at level 2." | |
3390 | :package-version '(rst . "1.4.0")) | |
3391 | ||
3392 | (defface rst-level-3 '((((background light)) (:background "grey71")) | |
3393 | (((background dark)) (:background "grey29"))) | |
3394 | "Default face for section title text at level 3." | |
3395 | :package-version '(rst . "1.4.0")) | |
3396 | ||
3397 | (defface rst-level-4 '((((background light)) (:background "grey64")) | |
3398 | (((background dark)) (:background "grey36"))) | |
3399 | "Default face for section title text at level 4." | |
3400 | :package-version '(rst . "1.4.0")) | |
3401 | ||
3402 | (defface rst-level-5 '((((background light)) (:background "grey57")) | |
3403 | (((background dark)) (:background "grey43"))) | |
3404 | "Default face for section title text at level 5." | |
3405 | :package-version '(rst . "1.4.0")) | |
3406 | ||
3407 | (defface rst-level-6 '((((background light)) (:background "grey50")) | |
3408 | (((background dark)) (:background "grey50"))) | |
3409 | "Default face for section title text at level 6." | |
3410 | :package-version '(rst . "1.4.0")) | |
94e9c286 SM |
3411 | |
3412 | (defcustom rst-adornment-faces-alist | |
48a24920 SM |
3413 | '((t . rst-transition) |
3414 | (nil . rst-adornment) | |
3415 | (1 . rst-level-1) | |
3416 | (2 . rst-level-2) | |
3417 | (3 . rst-level-3) | |
3418 | (4 . rst-level-4) | |
3419 | (5 . rst-level-5) | |
3420 | (6 . rst-level-6)) | |
3421 | "Faces for the various adornment types. | |
d8a52e15 SM |
3422 | Key is a number (for the section title text of that level |
3423 | starting with 1), t (for transitions) or nil (for section title | |
48a24920 SM |
3424 | adornment). If you need levels beyond 6 you have to define faces |
3425 | of your own." | |
94e9c286 SM |
3426 | :group 'rst-faces |
3427 | :type '(alist | |
3428 | :key-type | |
3429 | (choice | |
d8a52e15 SM |
3430 | (integer :tag "Section level") |
3431 | (const :tag "transitions" t) | |
3432 | (const :tag "section title adornment" nil)) | |
48a24920 | 3433 | :value-type (face))) |
64f6a736 | 3434 | (rst-testcover-defcustom) |
94e9c286 | 3435 | |
94e9c286 | 3436 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; |
94e9c286 | 3437 | |
d13c8be6 | 3438 | (defvar rst-font-lock-keywords |
94e9c286 | 3439 | ;; The reST-links in the comments below all relate to sections in |
6d3f7c2f | 3440 | ;; http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html. |
d13c8be6 | 3441 | `(;; FIXME: Block markup is not recognized in blocks after explicit markup |
6d3f7c2f | 3442 | ;; start. |
d13c8be6 SM |
3443 | |
3444 | ;; Simple `Body Elements`_ | |
3445 | ;; `Bullet Lists`_ | |
6d3f7c2f | 3446 | ;; FIXME: A bullet directly after a field name is not recognized. |
d13c8be6 SM |
3447 | (,(rst-re 'lin-beg '(:grp bul-sta)) |
3448 | 1 rst-block-face) | |
3449 | ;; `Enumerated Lists`_ | |
3450 | (,(rst-re 'lin-beg '(:grp enmany-sta)) | |
3451 | 1 rst-block-face) | |
6d3f7c2f SM |
3452 | ;; `Definition Lists`_ |
3453 | ;; FIXME: missing. | |
d13c8be6 SM |
3454 | ;; `Field Lists`_ |
3455 | (,(rst-re 'lin-beg '(:grp fld-tag) 'bli-sfx) | |
3456 | 1 rst-external-face) | |
3457 | ;; `Option Lists`_ | |
3458 | (,(rst-re 'lin-beg '(:grp opt-tag (:shy optsep-tag opt-tag) "*") | |
3459 | '(:alt "$" (:seq hws-prt "\\{2\\}"))) | |
3460 | 1 rst-block-face) | |
3461 | ;; `Line Blocks`_ | |
6d3f7c2f | 3462 | ;; Only for lines containing no more bar - to distinguish from tables. |
d13c8be6 SM |
3463 | (,(rst-re 'lin-beg '(:grp "|" bli-sfx) "[^|\n]*$") |
3464 | 1 rst-block-face) | |
3465 | ||
6d3f7c2f SM |
3466 | ;; `Tables`_ |
3467 | ;; FIXME: missing | |
d13c8be6 SM |
3468 | |
3469 | ;; All the `Explicit Markup Blocks`_ | |
3470 | ;; `Footnotes`_ / `Citations`_ | |
3471 | (,(rst-re 'lin-beg 'fnc-sta-2) | |
3472 | (1 rst-definition-face) | |
3473 | (2 rst-definition-face)) | |
3474 | ;; `Directives`_ / `Substitution Definitions`_ | |
3475 | (,(rst-re 'lin-beg 'dir-sta-3) | |
3476 | (1 rst-directive-face) | |
3477 | (2 rst-definition-face) | |
3478 | (3 rst-directive-face)) | |
3479 | ;; `Hyperlink Targets`_ | |
3480 | (,(rst-re 'lin-beg | |
3481 | '(:grp exm-sta "_" (:alt | |
3482 | (:seq "`" ilcbkqdef-tag "`") | |
3483 | (:seq (:alt "[^:\\\n]" "\\\\.") "+")) ":") | |
3484 | 'bli-sfx) | |
3485 | 1 rst-definition-face) | |
3486 | (,(rst-re 'lin-beg '(:grp "__") 'bli-sfx) | |
3487 | 1 rst-definition-face) | |
3488 | ||
6d3f7c2f SM |
3489 | ;; All `Inline Markup`_ |
3490 | ;; Most of them may be multiline though this is uninteresting. | |
d13c8be6 SM |
3491 | |
3492 | ;; FIXME: Condition 5 preventing fontification of e.g. "*" not implemented | |
6d3f7c2f | 3493 | ;; `Strong Emphasis`_. |
d13c8be6 SM |
3494 | (,(rst-re 'ilm-pfx '(:grp "\\*\\*" ilcast-tag "\\*\\*") 'ilm-sfx) |
3495 | 1 rst-emphasis2-face) | |
3496 | ;; `Emphasis`_ | |
3497 | (,(rst-re 'ilm-pfx '(:grp "\\*" ilcast-tag "\\*") 'ilm-sfx) | |
3498 | 1 rst-emphasis1-face) | |
3499 | ;; `Inline Literals`_ | |
3500 | (,(rst-re 'ilm-pfx '(:grp "``" ilcbkq-tag "``") 'ilm-sfx) | |
3501 | 1 rst-literal-face) | |
3502 | ;; `Inline Internal Targets`_ | |
3503 | (,(rst-re 'ilm-pfx '(:grp "_`" ilcbkq-tag "`") 'ilm-sfx) | |
3504 | 1 rst-definition-face) | |
3505 | ;; `Hyperlink References`_ | |
6d3f7c2f | 3506 | ;; FIXME: `Embedded URIs`_ not considered. |
c846da43 | 3507 | ;; FIXME: Directly adjacent marked up words are not fontified correctly |
6d3f7c2f | 3508 | ;; unless they are not separated by two spaces: foo_ bar_. |
d13c8be6 SM |
3509 | (,(rst-re 'ilm-pfx '(:grp (:alt (:seq "`" ilcbkq-tag "`") |
3510 | (:seq "\\sw" (:alt "\\sw" "-") "+\\sw")) | |
3511 | "__?") 'ilm-sfx) | |
3512 | 1 rst-reference-face) | |
3513 | ;; `Interpreted Text`_ | |
3514 | (,(rst-re 'ilm-pfx '(:grp (:shy ":" sym-tag ":") "?") | |
3515 | '(:grp "`" ilcbkq-tag "`") | |
3516 | '(:grp (:shy ":" sym-tag ":") "?") 'ilm-sfx) | |
3517 | (1 rst-directive-face) | |
3518 | (2 rst-external-face) | |
3519 | (3 rst-directive-face)) | |
3520 | ;; `Footnote References`_ / `Citation References`_ | |
3521 | (,(rst-re 'ilm-pfx '(:grp fnc-tag "_") 'ilm-sfx) | |
3522 | 1 rst-reference-face) | |
3523 | ;; `Substitution References`_ | |
3524 | ;; FIXME: References substitutions like |this|_ or |this|__ are not | |
6d3f7c2f | 3525 | ;; fontified correctly. |
d13c8be6 SM |
3526 | (,(rst-re 'ilm-pfx '(:grp sub-tag) 'ilm-sfx) |
3527 | 1 rst-reference-face) | |
3528 | ;; `Standalone Hyperlinks`_ | |
6d3f7c2f | 3529 | ;; FIXME: This takes it easy by using a whitespace as delimiter. |
d13c8be6 SM |
3530 | (,(rst-re 'ilm-pfx '(:grp uri-tag ":\\S +") 'ilm-sfx) |
3531 | 1 rst-definition-face) | |
3532 | (,(rst-re 'ilm-pfx '(:grp sym-tag "@" sym-tag ) 'ilm-sfx) | |
3533 | 1 rst-definition-face) | |
3534 | ||
6d3f7c2f | 3535 | ;; Do all block fontification as late as possible so 'append works. |
d13c8be6 | 3536 | |
6d3f7c2f SM |
3537 | ;; Sections_ / Transitions_ |
3538 | ;; For sections this is multiline. | |
d13c8be6 SM |
3539 | (,(rst-re 'ado-beg-2-1) |
3540 | (rst-font-lock-handle-adornment-matcher | |
3541 | (rst-font-lock-handle-adornment-pre-match-form | |
3542 | (match-string-no-properties 1) (match-end 1)) | |
3543 | nil | |
3544 | (1 (cdr (assoc nil rst-adornment-faces-alist)) append t) | |
3545 | (2 (cdr (assoc rst-font-lock-adornment-level | |
3546 | rst-adornment-faces-alist)) append t) | |
3547 | (3 (cdr (assoc nil rst-adornment-faces-alist)) append t))) | |
3548 | ||
3549 | ;; FIXME: FACESPEC could be used instead of ordinary faces to set | |
3550 | ;; properties on comments and literal blocks so they are *not* | |
6d3f7c2f | 3551 | ;; inline fontified. See (elisp)Search-based Fontification. |
d13c8be6 SM |
3552 | |
3553 | ;; FIXME: And / or use `syntax-propertize` functions as in `octave-mod.el` | |
6d3f7c2f SM |
3554 | ;; and other V24 modes. May make `font-lock-extend-region` |
3555 | ;; superfluous. | |
d13c8be6 | 3556 | |
6d3f7c2f SM |
3557 | ;; `Comments`_ |
3558 | ;; This is multiline. | |
d13c8be6 SM |
3559 | (,(rst-re 'lin-beg 'cmt-sta-1) |
3560 | (1 rst-comment-face) | |
3561 | (rst-font-lock-find-unindented-line-match | |
3562 | (rst-font-lock-find-unindented-line-limit (match-end 1)) | |
3563 | nil | |
3564 | (0 rst-comment-face append))) | |
3565 | (,(rst-re 'lin-beg '(:grp exm-tag) '(:grp hws-tag) "$") | |
3566 | (1 rst-comment-face) | |
3567 | (2 rst-comment-face) | |
3568 | (rst-font-lock-find-unindented-line-match | |
3569 | (rst-font-lock-find-unindented-line-limit 'next) | |
3570 | nil | |
3571 | (0 rst-comment-face append))) | |
3572 | ||
3573 | ;; FIXME: This is not rendered as comment:: | |
6d3f7c2f SM |
3574 | ;; .. .. list-table:: |
3575 | ;; :stub-columns: 1 | |
3576 | ;; :header-rows: 1 | |
d13c8be6 SM |
3577 | |
3578 | ;; FIXME: This is rendered wrong:: | |
3579 | ;; | |
3580 | ;; xxx yyy:: | |
3581 | ;; | |
3582 | ;; ----|> KKKKK <|---- | |
3583 | ;; / \ | |
3584 | ;; -|> AAAAAAAAAAPPPPPP <|- -|> AAAAAAAAAABBBBBBB <|- | |
3585 | ;; | | | | | |
3586 | ;; | | | | | |
3587 | ;; PPPPPP PPPPPPDDDDDDD BBBBBBB PPPPPPBBBBBBB | |
3588 | ;; | |
3589 | ;; Indentation needs to be taken from the line with the ``::`` and not from | |
3590 | ;; the first content line. | |
94e9c286 | 3591 | |
6d3f7c2f SM |
3592 | ;; `Indented Literal Blocks`_ |
3593 | ;; This is multiline. | |
d13c8be6 SM |
3594 | (,(rst-re 'lin-beg 'lit-sta-2) |
3595 | (2 rst-block-face) | |
3596 | (rst-font-lock-find-unindented-line-match | |
3597 | (rst-font-lock-find-unindented-line-limit t) | |
3598 | nil | |
3599 | (0 rst-literal-face append))) | |
94e9c286 | 3600 | |
6d3f7c2f SM |
3601 | ;; FIXME: `Quoted Literal Blocks`_ missing. |
3602 | ;; This is multiline. | |
94e9c286 | 3603 | |
d13c8be6 SM |
3604 | ;; `Doctest Blocks`_ |
3605 | ;; FIXME: This is wrong according to the specification: | |
3606 | ;; | |
3607 | ;; Doctest blocks are text blocks which begin with ">>> ", the Python | |
3608 | ;; interactive interpreter main prompt, and end with a blank line. | |
3609 | ;; Doctest blocks are treated as a special case of literal blocks, | |
3610 | ;; without requiring the literal block syntax. If both are present, the | |
3611 | ;; literal block syntax takes priority over Doctest block syntax: | |
3612 | ;; | |
3613 | ;; This is an ordinary paragraph. | |
3614 | ;; | |
3615 | ;; >>> print 'this is a Doctest block' | |
3616 | ;; this is a Doctest block | |
3617 | ;; | |
3618 | ;; The following is a literal block:: | |
3619 | ;; | |
3620 | ;; >>> This is not recognized as a doctest block by | |
3621 | ;; reStructuredText. It *will* be recognized by the doctest | |
3622 | ;; module, though! | |
3623 | ;; | |
3624 | ;; Indentation is not required for doctest blocks. | |
3625 | (,(rst-re 'lin-beg '(:grp (:alt ">>>" ell-tag)) '(:grp ".+")) | |
3626 | (1 rst-block-face) | |
64f6a736 | 3627 | (2 rst-literal-face))) |
d13c8be6 SM |
3628 | "Keywords to highlight in rst mode.") |
3629 | ||
8f6b6da8 JB |
3630 | (defvar font-lock-beg) |
3631 | (defvar font-lock-end) | |
3632 | ||
d13c8be6 | 3633 | (defun rst-font-lock-extend-region () |
6d3f7c2f SM |
3634 | "Extend the font-lock region if it might be in a multi-line construct. |
3635 | Return non-nil if so. Font-lock region is from `font-lock-beg' | |
3636 | to `font-lock-end'." | |
d13c8be6 SM |
3637 | (let ((r (rst-font-lock-extend-region-internal font-lock-beg font-lock-end))) |
3638 | (when r | |
3639 | (setq font-lock-beg (car r)) | |
3640 | (setq font-lock-end (cdr r)) | |
3641 | t))) | |
3642 | ||
3643 | (defun rst-font-lock-extend-region-internal (beg end) | |
6d3f7c2f | 3644 | "Check the region BEG / END for being in the middle of a multi-line construct. |
d13c8be6 SM |
3645 | Return nil if not or a cons with new values for BEG / END" |
3646 | (let ((nbeg (rst-font-lock-extend-region-extend beg -1)) | |
3647 | (nend (rst-font-lock-extend-region-extend end 1))) | |
3648 | (if (or nbeg nend) | |
3649 | (cons (or nbeg beg) (or nend end))))) | |
3650 | ||
3651 | (defun rst-forward-line (&optional n) | |
6d3f7c2f SM |
3652 | "Like `forward-line' but always end up in column 0 and return accordingly. |
3653 | Move N lines forward just as `forward-line'." | |
d13c8be6 SM |
3654 | (let ((moved (forward-line n))) |
3655 | (if (bolp) | |
3656 | moved | |
3657 | (forward-line 0) | |
7b4cdbf4 | 3658 | (- moved (rst-signum n))))) |
d13c8be6 | 3659 | |
d8a52e15 SM |
3660 | ;; FIXME: If a single line is made a section header by `rst-adjust' the header |
3661 | ;; is not always fontified immediately. | |
d13c8be6 SM |
3662 | (defun rst-font-lock-extend-region-extend (pt dir) |
3663 | "Extend the region starting at point PT and extending in direction DIR. | |
3664 | Return extended point or nil if not moved." | |
3665 | ;; There are many potential multiline constructs but there are two groups | |
3666 | ;; which are really relevant. The first group consists of | |
3667 | ;; | |
3668 | ;; * comment lines without leading explicit markup tag and | |
3669 | ;; | |
3670 | ;; * literal blocks following "::" | |
3671 | ;; | |
c846da43 | 3672 | ;; which are both indented. Thus indentation is the first thing recognized |
d13c8be6 SM |
3673 | ;; here. The second criteria is an explicit markup tag which may be a comment |
3674 | ;; or a double colon at the end of a line. | |
3675 | ;; | |
3676 | ;; The second group consists of the adornment cases. | |
3677 | (if (not (get-text-property pt 'font-lock-multiline)) | |
6d3f7c2f | 3678 | ;; Move only if we don't start inside a multiline construct already. |
d13c8be6 | 3679 | (save-excursion |
6d3f7c2f SM |
3680 | (let (;; Non-empty non-indented line, explicit markup tag or literal |
3681 | ;; block tag. | |
d13c8be6 SM |
3682 | (stop-re (rst-re '(:alt "[^ \t\n]" |
3683 | (:seq hws-tag exm-tag) | |
3684 | (:seq ".*" dcl-tag lin-end))))) | |
6d3f7c2f | 3685 | ;; The comments below are for dir == -1 / dir == 1. |
d13c8be6 SM |
3686 | (goto-char pt) |
3687 | (forward-line 0) | |
3688 | (setq pt (point)) | |
3689 | (while (and (not (looking-at stop-re)) | |
3690 | (zerop (rst-forward-line dir)))) ; try previous / next | |
6d3f7c2f | 3691 | ; line if it exists. |
d13c8be6 | 3692 | (if (looking-at (rst-re 'ado-beg-2-1)) ; may be an underline / |
6d3f7c2f | 3693 | ; overline. |
d13c8be6 SM |
3694 | (if (zerop (rst-forward-line dir)) |
3695 | (if (looking-at (rst-re 'ttl-beg)) ; title found, i.e. | |
3696 | ; underline / overline | |
6d3f7c2f | 3697 | ; found. |
d13c8be6 SM |
3698 | (if (zerop (rst-forward-line dir)) |
3699 | (if (not | |
3700 | (looking-at (rst-re 'ado-beg-2-1))) ; no | |
3701 | ; overline / | |
6d3f7c2f | 3702 | ; underline. |
d13c8be6 | 3703 | (rst-forward-line (- dir)))) ; step back to title |
6d3f7c2f SM |
3704 | ; / adornment. |
3705 | (if (< dir 0) ; keep downward adornment. | |
3706 | (rst-forward-line (- dir))))) ; step back to adornment. | |
3707 | (if (looking-at (rst-re 'ttl-beg)) ; may be a title. | |
d13c8be6 SM |
3708 | (if (zerop (rst-forward-line dir)) |
3709 | (if (not | |
3710 | (looking-at (rst-re 'ado-beg-2-1))) ; no overline / | |
6d3f7c2f SM |
3711 | ; underline. |
3712 | (rst-forward-line (- dir)))))) ; step back to line. | |
d13c8be6 SM |
3713 | (if (not (= (point) pt)) |
3714 | (point)))))) | |
94e9c286 SM |
3715 | |
3716 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; | |
3717 | ;; Indented blocks | |
3718 | ||
3719 | (defun rst-forward-indented-block (&optional column limit) | |
3720 | "Move forward across one indented block. | |
3721 | Find the next non-empty line which is not indented at least to COLUMN (defaults | |
b4747519 SM |
3722 | to the column of the point). Moves point to first character of this line or the |
3723 | first empty line immediately before it and returns that position. If there is | |
94e9c286 SM |
3724 | no such line before LIMIT (defaults to the end of the buffer) returns nil and |
3725 | point is not moved." | |
3726 | (interactive) | |
3727 | (let ((clm (or column (current-column))) | |
3728 | (start (point)) | |
3729 | fnd beg cand) | |
3730 | (if (not limit) | |
3731 | (setq limit (point-max))) | |
3732 | (save-match-data | |
3733 | (while (and (not fnd) (< (point) limit)) | |
3734 | (forward-line 1) | |
3735 | (when (< (point) limit) | |
3736 | (setq beg (point)) | |
d13c8be6 | 3737 | (if (looking-at (rst-re 'lin-end)) |
6d3f7c2f | 3738 | (setq cand (or cand beg)) ; An empty line is a candidate. |
94e9c286 SM |
3739 | (move-to-column clm) |
3740 | ;; FIXME: No indentation [(zerop clm)] must be handled in some | |
6d3f7c2f SM |
3741 | ;; useful way - though it is not clear what this should mean |
3742 | ;; at all. | |
94e9c286 | 3743 | (if (string-match |
d13c8be6 SM |
3744 | (rst-re 'linemp-tag) |
3745 | (buffer-substring-no-properties beg (point))) | |
6d3f7c2f | 3746 | (setq cand nil) ; An indented line resets a candidate. |
94e9c286 SM |
3747 | (setq fnd (or cand beg))))))) |
3748 | (goto-char (or fnd start)) | |
3749 | fnd)) | |
3750 | ||
d13c8be6 | 3751 | (defvar rst-font-lock-find-unindented-line-begin nil |
6d3f7c2f | 3752 | "Beginning of the match if `rst-font-lock-find-unindented-line-end'.") |
d13c8be6 SM |
3753 | |
3754 | (defvar rst-font-lock-find-unindented-line-end nil | |
3755 | "End of the match as determined by `rst-font-lock-find-unindented-line-limit'. | |
3756 | Also used as a trigger for | |
3757 | `rst-font-lock-find-unindented-line-match'.") | |
3758 | ||
3759 | (defun rst-font-lock-find-unindented-line-limit (ind-pnt) | |
c846da43 | 3760 | "Find the next unindented line relative to indentation at IND-PNT. |
d13c8be6 SM |
3761 | Return this point, the end of the buffer or nil if nothing found. |
3762 | If IND-PNT is `next' take the indentation from the next line if | |
6d3f7c2f | 3763 | this is not empty and indented more than the current one. If |
d13c8be6 SM |
3764 | IND-PNT is non-nil but not a number take the indentation from the |
3765 | next non-empty line if this is indented more than the current | |
3766 | one." | |
3767 | (setq rst-font-lock-find-unindented-line-begin ind-pnt) | |
3768 | (setq rst-font-lock-find-unindented-line-end | |
3769 | (save-excursion | |
3770 | (when (not (numberp ind-pnt)) | |
6d3f7c2f | 3771 | ;; Find indentation point in next line if any. |
d13c8be6 SM |
3772 | (setq ind-pnt |
3773 | ;; FIXME: Should be refactored to two different functions | |
3774 | ;; giving their result to this function, may be | |
6d3f7c2f | 3775 | ;; integrated in caller. |
d13c8be6 SM |
3776 | (save-match-data |
3777 | (let ((cur-ind (current-indentation))) | |
3778 | (if (eq ind-pnt 'next) | |
3779 | (when (and (zerop (forward-line 1)) | |
3780 | (< (point) (point-max))) | |
6d3f7c2f | 3781 | ;; Not at EOF. |
d13c8be6 SM |
3782 | (setq rst-font-lock-find-unindented-line-begin |
3783 | (point)) | |
3784 | (when (and (not (looking-at (rst-re 'lin-end))) | |
3785 | (> (current-indentation) cur-ind)) | |
6d3f7c2f | 3786 | ;; Use end of indentation if non-empty line. |
d13c8be6 SM |
3787 | (looking-at (rst-re 'hws-tag)) |
3788 | (match-end 0))) | |
6d3f7c2f | 3789 | ;; Skip until non-empty line or EOF. |
d13c8be6 SM |
3790 | (while (and (zerop (forward-line 1)) |
3791 | (< (point) (point-max)) | |
3792 | (looking-at (rst-re 'lin-end)))) | |
3793 | (when (< (point) (point-max)) | |
6d3f7c2f | 3794 | ;; Not at EOF. |
d13c8be6 SM |
3795 | (setq rst-font-lock-find-unindented-line-begin |
3796 | (point)) | |
3797 | (when (> (current-indentation) cur-ind) | |
6d3f7c2f | 3798 | ;; Indentation bigger than line of departure. |
d13c8be6 SM |
3799 | (looking-at (rst-re 'hws-tag)) |
3800 | (match-end 0)))))))) | |
3801 | (when ind-pnt | |
3802 | (goto-char ind-pnt) | |
3803 | (or (rst-forward-indented-block nil (point-max)) | |
3804 | (point-max)))))) | |
3805 | ||
3806 | (defun rst-font-lock-find-unindented-line-match (limit) | |
6d3f7c2f SM |
3807 | "Set the match found earlier if match were found. |
3808 | Match has been found by | |
d13c8be6 | 3809 | `rst-font-lock-find-unindented-line-limit' the first time called |
6d3f7c2f SM |
3810 | or no match is found. Return non-nil if match was found. LIMIT |
3811 | is not used but mandated by the caller." | |
d13c8be6 SM |
3812 | (when rst-font-lock-find-unindented-line-end |
3813 | (set-match-data | |
3814 | (list rst-font-lock-find-unindented-line-begin | |
3815 | rst-font-lock-find-unindented-line-end)) | |
3816 | (put-text-property rst-font-lock-find-unindented-line-begin | |
3817 | rst-font-lock-find-unindented-line-end | |
3818 | 'font-lock-multiline t) | |
6d3f7c2f | 3819 | ;; Make sure this is called only once. |
d13c8be6 SM |
3820 | (setq rst-font-lock-find-unindented-line-end nil) |
3821 | t)) | |
94e9c286 SM |
3822 | |
3823 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; | |
3824 | ;; Adornments | |
3825 | ||
d13c8be6 SM |
3826 | (defvar rst-font-lock-adornment-level nil |
3827 | "Storage for `rst-font-lock-handle-adornment-matcher'. | |
3828 | Either section level of the current adornment or t for a transition.") | |
3829 | ||
3830 | (defun rst-adornment-level (key) | |
3831 | "Return section level for adornment KEY. | |
3832 | KEY is the first element of the return list of | |
6d3f7c2f SM |
3833 | `rst-classify-adornment'. If KEY is not a cons return it. If KEY is found |
3834 | in the hierarchy return its level. Otherwise return a level one | |
d13c8be6 SM |
3835 | beyond the existing hierarchy." |
3836 | (if (not (consp key)) | |
3837 | key | |
3838 | (let* ((hier (rst-get-hierarchy)) | |
3839 | (char (car key)) | |
3840 | (style (cdr key))) | |
7b4cdbf4 SM |
3841 | (1+ (or (lexical-let ((char char) |
3842 | (style style) | |
3843 | (hier hier)) ; Create closure. | |
3844 | (rst-position-if (lambda (elt) | |
3845 | (and (equal (car elt) char) | |
3846 | (equal (cadr elt) style))) hier)) | |
d13c8be6 SM |
3847 | (length hier)))))) |
3848 | ||
3849 | (defvar rst-font-lock-adornment-match nil | |
3850 | "Storage for match for current adornment. | |
6d3f7c2f | 3851 | Set by `rst-font-lock-handle-adornment-pre-match-form'. Also used |
d13c8be6 SM |
3852 | as a trigger for `rst-font-lock-handle-adornment-matcher'.") |
3853 | ||
3854 | (defun rst-font-lock-handle-adornment-pre-match-form (ado ado-end) | |
6d3f7c2f SM |
3855 | "Determine limit for adornments. |
3856 | Determine all things necessary for font-locking section titles | |
3857 | and transitions and put the result to | |
d13c8be6 | 3858 | `rst-font-lock-adornment-match' and |
6d3f7c2f SM |
3859 | `rst-font-lock-adornment-level'. ADO is the complete adornment |
3860 | matched. ADO-END is the point where ADO ends. Return the point | |
d13c8be6 SM |
3861 | where the whole adorned construct ends. |
3862 | ||
3863 | Called as a PRE-MATCH-FORM in the sense of `font-lock-keywords'." | |
3864 | (let ((ado-data (rst-classify-adornment ado ado-end))) | |
3865 | (if (not ado-data) | |
3866 | (setq rst-font-lock-adornment-level nil | |
3867 | rst-font-lock-adornment-match nil) | |
3868 | (setq rst-font-lock-adornment-level | |
3869 | (rst-adornment-level (car ado-data))) | |
3870 | (setq rst-font-lock-adornment-match (cdr ado-data)) | |
6d3f7c2f SM |
3871 | (goto-char (nth 1 ado-data)) ; Beginning of construct. |
3872 | (nth 2 ado-data)))) ; End of construct. | |
d13c8be6 SM |
3873 | |
3874 | (defun rst-font-lock-handle-adornment-matcher (limit) | |
6d3f7c2f SM |
3875 | "Set the match found earlier if match were found. |
3876 | Match has been found by | |
3877 | `rst-font-lock-handle-adornment-pre-match-form' the first time | |
3878 | called or no match is found. Return non-nil if match was found. | |
d13c8be6 | 3879 | |
6d3f7c2f SM |
3880 | Called as a MATCHER in the sense of `font-lock-keywords'. |
3881 | LIMIT is not used but mandated by the caller." | |
d13c8be6 | 3882 | (let ((match rst-font-lock-adornment-match)) |
6d3f7c2f | 3883 | ;; May run only once - enforce this. |
d13c8be6 SM |
3884 | (setq rst-font-lock-adornment-match nil) |
3885 | (when match | |
3886 | (set-match-data match) | |
3887 | (goto-char (match-end 0)) | |
3888 | (put-text-property (match-beginning 0) (match-end 0) | |
3889 | 'font-lock-multiline t) | |
3890 | t))) | |
94e9c286 SM |
3891 | |
3892 | \f | |
3893 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; | |
d13c8be6 | 3894 | ;; Compilation |
94e9c286 SM |
3895 | |
3896 | (defgroup rst-compile nil | |
3897 | "Settings for support of conversion of reStructuredText | |
3898 | document with \\[rst-compile]." | |
3899 | :group 'rst | |
3900 | :version "21.1") | |
3901 | ||
ef4271fe GM |
3902 | (defcustom rst-compile-toolsets |
3903 | `((html ,(if (executable-find "rst2html.py") "rst2html.py" "rst2html") | |
3904 | ".html" nil) | |
3905 | (latex ,(if (executable-find "rst2latex.py") "rst2latex.py" "rst2latex") | |
3906 | ".tex" nil) | |
3907 | (newlatex ,(if (executable-find "rst2newlatex.py") "rst2newlatex.py" | |
3908 | "rst2newlatex") | |
3909 | ".tex" nil) | |
3910 | (pseudoxml ,(if (executable-find "rst2pseudoxml.py") "rst2pseudoxml.py" | |
3911 | "rst2pseudoxml") | |
3912 | ".xml" nil) | |
3913 | (xml ,(if (executable-find "rst2xml.py") "rst2xml.py" "rst2xml") | |
3914 | ".xml" nil) | |
3915 | (pdf ,(if (executable-find "rst2pdf.py") "rst2pdf.py" "rst2pdf") | |
3916 | ".pdf" nil) | |
3917 | (s5 ,(if (executable-find "rst2s5.py") "rst2s5.py" "rst2s5") | |
3918 | ".html" nil)) | |
6d3f7c2f SM |
3919 | "Table describing the command to use for each tool-set. |
3920 | An association list of the tool-set to a list of the (command to use, | |
94e9c286 | 3921 | extension of produced filename, options to the tool (nil or a |
ef4271fe | 3922 | string)) to be used for converting the document." |
d13c8be6 | 3923 | ;; FIXME: These are not options but symbols which may be referenced by |
1f45e27e SM |
3924 | ;; `rst-compile-*-toolset` below. The `:validate' keyword of |
3925 | ;; `defcustom' may help to define this properly in newer Emacs | |
3926 | ;; versions (> 23.1). | |
3f1b6eb2 | 3927 | :type '(alist :options (html latex newlatex pseudoxml xml pdf s5) |
ef4271fe GM |
3928 | :key-type symbol |
3929 | :value-type (list :tag "Specification" | |
3930 | (file :tag "Command") | |
3931 | (string :tag "File extension") | |
3932 | (choice :tag "Command options" | |
3933 | (const :tag "No options" nil) | |
3934 | (string :tag "Options")))) | |
3935 | :group 'rst | |
7b4cdbf4 | 3936 | :package-version "1.2.0") |
64f6a736 | 3937 | (rst-testcover-defcustom) |
94e9c286 | 3938 | |
6d3f7c2f | 3939 | ;; FIXME: Must be `defcustom`. |
94e9c286 | 3940 | (defvar rst-compile-primary-toolset 'html |
6d3f7c2f | 3941 | "The default tool-set for `rst-compile'.") |
94e9c286 | 3942 | |
6d3f7c2f | 3943 | ;; FIXME: Must be `defcustom`. |
94e9c286 | 3944 | (defvar rst-compile-secondary-toolset 'latex |
6d3f7c2f | 3945 | "The default tool-set for `rst-compile' with a prefix argument.") |
94e9c286 SM |
3946 | |
3947 | (defun rst-compile-find-conf () | |
3948 | "Look for the configuration file in the parents of the current path." | |
3949 | (interactive) | |
3950 | (let ((file-name "docutils.conf") | |
3951 | (buffer-file (buffer-file-name))) | |
3952 | ;; Move up in the dir hierarchy till we find a change log file. | |
3953 | (let* ((dir (file-name-directory buffer-file)) | |
3954 | (prevdir nil)) | |
3955 | (while (and (or (not (string= dir prevdir)) | |
3956 | (setq dir nil) | |
3957 | nil) | |
3958 | (not (file-exists-p (concat dir file-name)))) | |
3959 | ;; Move up to the parent dir and try again. | |
3960 | (setq prevdir dir) | |
3961 | (setq dir (expand-file-name (file-name-directory | |
3962 | (directory-file-name | |
64f6a736 SM |
3963 | (file-name-directory dir)))))) |
3964 | (or (and dir (concat dir file-name)) nil)))) | |
94e9c286 SM |
3965 | |
3966 | (require 'compile) | |
3967 | ||
d13c8be6 | 3968 | (defun rst-compile (&optional use-alt) |
94e9c286 SM |
3969 | "Compile command to convert reST document into some output file. |
3970 | Attempts to find configuration file, if it can, overrides the | |
d13c8be6 | 3971 | options. There are two commands to choose from, with USE-ALT, |
6d3f7c2f | 3972 | select the alternative tool-set." |
94e9c286 SM |
3973 | (interactive "P") |
3974 | ;; Note: maybe we want to check if there is a Makefile too and not do anything | |
3975 | ;; if that is the case. I dunno. | |
d13c8be6 | 3976 | (let* ((toolset (cdr (assq (if use-alt |
94e9c286 SM |
3977 | rst-compile-secondary-toolset |
3978 | rst-compile-primary-toolset) | |
3979 | rst-compile-toolsets))) | |
3980 | (command (car toolset)) | |
3981 | (extension (cadr toolset)) | |
3982 | (options (caddr toolset)) | |
3983 | (conffile (rst-compile-find-conf)) | |
3984 | (bufname (file-name-nondirectory buffer-file-name)) | |
3985 | (outname (file-name-sans-extension bufname))) | |
3986 | ||
3987 | ;; Set compile-command before invocation of compile. | |
3988 | (set (make-local-variable 'compile-command) | |
3989 | (mapconcat 'identity | |
3990 | (list command | |
3991 | (or options "") | |
3992 | (if conffile | |
d13c8be6 | 3993 | (concat "--config=" (shell-quote-argument conffile)) |
94e9c286 | 3994 | "") |
d13c8be6 SM |
3995 | (shell-quote-argument bufname) |
3996 | (shell-quote-argument (concat outname extension))) | |
94e9c286 SM |
3997 | " ")) |
3998 | ||
3999 | ;; Invoke the compile command. | |
d13c8be6 | 4000 | (if (or compilation-read-command use-alt) |
94e9c286 | 4001 | (call-interactively 'compile) |
64f6a736 | 4002 | (compile compile-command)))) |
94e9c286 SM |
4003 | |
4004 | (defun rst-compile-alt-toolset () | |
6d3f7c2f | 4005 | "Compile command with the alternative tool-set." |
94e9c286 | 4006 | (interactive) |
d13c8be6 | 4007 | (rst-compile t)) |
94e9c286 SM |
4008 | |
4009 | (defun rst-compile-pseudo-region () | |
6d3f7c2f SM |
4010 | "Show pseudo-XML rendering. |
4011 | Rendering is done of the current active region, or of the entire | |
4012 | buffer, if the region is not selected." | |
4013 | ;; FIXME: The region should be given interactively. | |
94e9c286 SM |
4014 | (interactive) |
4015 | (with-output-to-temp-buffer "*pseudoxml*" | |
4016 | (shell-command-on-region | |
4017 | (if mark-active (region-beginning) (point-min)) | |
4018 | (if mark-active (region-end) (point-max)) | |
ef4271fe | 4019 | (cadr (assq 'pseudoxml rst-compile-toolsets)) |
94e9c286 SM |
4020 | standard-output))) |
4021 | ||
6d3f7c2f | 4022 | ;; FIXME: Should be `defcustom`. |
94e9c286 SM |
4023 | (defvar rst-pdf-program "xpdf" |
4024 | "Program used to preview PDF files.") | |
4025 | ||
4026 | (defun rst-compile-pdf-preview () | |
4027 | "Convert the document to a PDF file and launch a preview program." | |
4028 | (interactive) | |
d13c8be6 SM |
4029 | (let* ((tmp-filename (make-temp-file "rst_el" nil ".pdf")) |
4030 | (command (format "%s %s %s && %s %s ; rm %s" | |
ef4271fe | 4031 | (cadr (assq 'pdf rst-compile-toolsets)) |
94e9c286 | 4032 | buffer-file-name tmp-filename |
d13c8be6 | 4033 | rst-pdf-program tmp-filename tmp-filename))) |
94e9c286 SM |
4034 | (start-process-shell-command "rst-pdf-preview" nil command) |
4035 | ;; Note: you could also use (compile command) to view the compilation | |
4036 | ;; output. | |
4037 | )) | |
4038 | ||
6d3f7c2f | 4039 | ;; FIXME: Should be `defcustom` or use something like `browse-url`. |
94e9c286 SM |
4040 | (defvar rst-slides-program "firefox" |
4041 | "Program used to preview S5 slides.") | |
4042 | ||
4043 | (defun rst-compile-slides-preview () | |
4044 | "Convert the document to an S5 slide presentation and launch a preview program." | |
4045 | (interactive) | |
d13c8be6 SM |
4046 | (let* ((tmp-filename (make-temp-file "rst_el" nil ".html")) |
4047 | (command (format "%s %s %s && %s %s ; rm %s" | |
ef4271fe | 4048 | (cadr (assq 's5 rst-compile-toolsets)) |
94e9c286 | 4049 | buffer-file-name tmp-filename |
d13c8be6 | 4050 | rst-slides-program tmp-filename tmp-filename))) |
94e9c286 SM |
4051 | (start-process-shell-command "rst-slides-preview" nil command) |
4052 | ;; Note: you could also use (compile command) to view the compilation | |
4053 | ;; output. | |
4054 | )) | |
4055 | ||
94e9c286 | 4056 | \f |
ee97deee SM |
4057 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; |
4058 | ;; Imenu support. | |
4059 | ||
4060 | ;; FIXME: Integrate this properly. Consider a key binding. | |
4061 | ||
4062 | ;; Based on code from Masatake YAMATO <yamato@redhat.com>. | |
4063 | ||
4064 | (defun rst-imenu-find-adornments-for-position (adornments pos) | |
4065 | "Find adornments cell in ADORNMENTS for position POS." | |
4066 | (let ((a nil)) | |
4067 | (while adornments | |
4068 | (if (and (car adornments) | |
4069 | (eq (car (car adornments)) pos)) | |
4070 | (setq a adornments | |
4071 | adornments nil) | |
4072 | (setq adornments (cdr adornments)))) | |
4073 | a)) | |
4074 | ||
4075 | (defun rst-imenu-convert-cell (elt adornments) | |
4076 | "Convert a cell ELT in a tree returned from `rst-section-tree' to imenu index. | |
4077 | ADORNMENTS is used as hint information for conversion." | |
4078 | (let* ((kar (car elt)) | |
4079 | (kdr (cdr elt)) | |
4080 | (title (car kar))) | |
4081 | (if kar | |
4082 | (let* ((p (marker-position (cadr kar))) | |
4083 | (adornments | |
4084 | (rst-imenu-find-adornments-for-position adornments p)) | |
4085 | (a (car adornments)) | |
4086 | (adornments (cdr adornments)) | |
4087 | ;; FIXME: Overline adornment characters need to be in front so | |
4088 | ;; they become visible even for long title lines. May be | |
4089 | ;; an additional level number is also useful. | |
4090 | (title (format "%s%s%s" | |
4091 | (make-string (1+ (nth 3 a)) (nth 1 a)) | |
4092 | title | |
4093 | (if (eq (nth 2 a) 'simple) | |
4094 | "" | |
4095 | (char-to-string (nth 1 a)))))) | |
4096 | (cons title | |
4097 | (if (null kdr) | |
4098 | p | |
4099 | (cons | |
4100 | ;; A bit ugly but this make which-func happy. | |
4101 | (cons title p) | |
4102 | (mapcar (lambda (elt0) | |
4103 | (rst-imenu-convert-cell elt0 adornments)) | |
4104 | kdr))))) | |
4105 | nil))) | |
4106 | ||
4107 | ;; FIXME: Document title and subtitle need to be handled properly. They should | |
4108 | ;; get an own "Document" top level entry. | |
4109 | (defun rst-imenu-create-index () | |
4110 | "Create index for imenu. | |
4111 | Return as described for `imenu--index-alist'." | |
4112 | (rst-reset-section-caches) | |
4113 | (let ((tree (rst-section-tree)) | |
4114 | ;; Translate line notation to point notation. | |
4115 | (adornments (save-excursion | |
4116 | (mapcar (lambda (ln-ado) | |
4117 | (cons (progn | |
4118 | (goto-char (point-min)) | |
4119 | (forward-line (1- (car ln-ado))) | |
4120 | ;; FIXME: Need to consider | |
4121 | ;; `imenu-use-markers' here? | |
4122 | (point)) | |
4123 | (cdr ln-ado))) | |
4124 | (rst-find-all-adornments))))) | |
4125 | (delete nil (mapcar (lambda (elt) | |
4126 | (rst-imenu-convert-cell elt adornments)) | |
4127 | tree)))) | |
4128 | ||
4129 | \f | |
94e9c286 | 4130 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; |
94e9c286 | 4131 | ;; Generic text functions that are more convenient than the defaults. |
94e9c286 | 4132 | |
6d3f7c2f | 4133 | ;; FIXME: Unbound command - should be bound or removed. |
94e9c286 | 4134 | (defun rst-replace-lines (fromchar tochar) |
6d3f7c2f | 4135 | "Replace flush-left lines of FROMCHAR with equal-length lines of TOCHAR." |
94e9c286 SM |
4136 | (interactive "\ |
4137 | cSearch for flush-left lines of char: | |
4138 | cand replace with char: ") | |
4139 | (save-excursion | |
d13c8be6 | 4140 | (let ((searchre (rst-re "^" fromchar "+\\( *\\)$")) |
b4747519 SM |
4141 | (found 0)) |
4142 | (while (search-forward-regexp searchre nil t) | |
4143 | (setq found (1+ found)) | |
4144 | (goto-char (match-beginning 1)) | |
4145 | (let ((width (current-column))) | |
4146 | (rst-delete-entire-line) | |
4147 | (insert-char tochar width))) | |
4148 | (message (format "%d lines replaced." found))))) | |
94e9c286 | 4149 | |
6d3f7c2f | 4150 | ;; FIXME: Unbound command - should be bound or removed. |
94e9c286 SM |
4151 | (defun rst-join-paragraph () |
4152 | "Join lines in current paragraph into one line, removing end-of-lines." | |
4153 | (interactive) | |
7b4cdbf4 | 4154 | (let ((fill-column 65000)) ; Some big number. |
94e9c286 SM |
4155 | (call-interactively 'fill-paragraph))) |
4156 | ||
6d3f7c2f | 4157 | ;; FIXME: Unbound command - should be bound or removed. |
94e9c286 SM |
4158 | (defun rst-force-fill-paragraph () |
4159 | "Fill paragraph at point, first joining the paragraph's lines into one. | |
4160 | This is useful for filling list item paragraphs." | |
4161 | (interactive) | |
4162 | (rst-join-paragraph) | |
4163 | (fill-paragraph nil)) | |
4164 | ||
4165 | ||
6d3f7c2f | 4166 | ;; FIXME: Unbound command - should be bound or removed. |
94e9c286 SM |
4167 | ;; Generic character repeater function. |
4168 | ;; For sections, better to use the specialized function above, but this can | |
4169 | ;; be useful for creating separators. | |
d13c8be6 | 4170 | (defun rst-repeat-last-character (use-next) |
6d3f7c2f SM |
4171 | "Fill the current line using the last character on the current line. |
4172 | Fill up to the length of the preceding line or up to | |
4173 | `fill-column' if preceding line is empty. | |
94e9c286 | 4174 | |
d13c8be6 | 4175 | If USE-NEXT, use the next line rather than the preceding line. |
94e9c286 SM |
4176 | |
4177 | If the current line is longer than the desired length, shave the characters off | |
4178 | the current line to fit the desired length. | |
4179 | ||
4180 | As an added convenience, if the command is repeated immediately, the alternative | |
4181 | column is used (fill-column vs. end of previous/next line)." | |
d13c8be6 | 4182 | (interactive "P") |
94e9c286 SM |
4183 | (let* ((curcol (current-column)) |
4184 | (curline (+ (count-lines (point-min) (point)) | |
d13c8be6 | 4185 | (if (zerop curcol) 1 0))) |
94e9c286 | 4186 | (lbp (line-beginning-position 0)) |
d13c8be6 | 4187 | (prevcol (if (and (= curline 1) (not use-next)) |
94e9c286 SM |
4188 | fill-column |
4189 | (save-excursion | |
d13c8be6 | 4190 | (forward-line (if use-next 1 -1)) |
94e9c286 SM |
4191 | (end-of-line) |
4192 | (skip-chars-backward " \t" lbp) | |
4193 | (let ((cc (current-column))) | |
d13c8be6 | 4194 | (if (zerop cc) fill-column cc))))) |
94e9c286 | 4195 | (rightmost-column |
d13c8be6 | 4196 | (cond ((equal last-command 'rst-repeat-last-character) |
94e9c286 SM |
4197 | (if (= curcol fill-column) prevcol fill-column)) |
4198 | (t (save-excursion | |
64f6a736 | 4199 | (if (zerop prevcol) fill-column prevcol)))))) |
94e9c286 SM |
4200 | (end-of-line) |
4201 | (if (> (current-column) rightmost-column) | |
6d3f7c2f | 4202 | ;; Shave characters off the end. |
94e9c286 SM |
4203 | (delete-region (- (point) |
4204 | (- (current-column) rightmost-column)) | |
4205 | (point)) | |
6d3f7c2f | 4206 | ;; Fill with last characters. |
94e9c286 | 4207 | (insert-char (preceding-char) |
64f6a736 | 4208 | (- rightmost-column (current-column)))))) |
94e9c286 SM |
4209 | |
4210 | \f | |
6d3f7c2f SM |
4211 | |
4212 | ;; LocalWords: docutils http sourceforge rst html wp svn svnroot txt reST regex | |
4213 | ;; LocalWords: regexes alist seq alt grp keymap abbrev overline overlines toc | |
d8a52e15 | 4214 | ;; LocalWords: XML PNT propertized |
6d3f7c2f SM |
4215 | |
4216 | ;; Local Variables: | |
4217 | ;; sentence-end-double-space: t | |
4218 | ;; End: | |
4219 | ||
d8a52e15 SM |
4220 | (provide 'rst) |
4221 | ||
4222 | ;;; rst.el ends here |