1 ;;; rst.el --- Mode for viewing and editing reStructuredText-documents.
3 ;; Copyright (C) 2003, 2004, 2005, 2006, 2007, 2008, 2009
4 ;; Free Software Foundation, Inc.
6 ;; Authors: Martin Blais <blais@furius.ca>,
7 ;; Stefan Merten <smerten@oekonux.de>,
8 ;; David Goodger <goodger@python.org>
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software: you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation, either version 3 of the License, or
15 ;; (at your option) any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
27 ;; This package provides major mode rst-mode, which supports documents marked up
28 ;; using the reStructuredText format. Support includes font locking as well as
29 ;; some convenience functions for editing. It does this by defining a Emacs
30 ;; major mode: rst-mode (ReST). This mode is derived from text-mode (and
31 ;; inherits much of it). This package also contains:
33 ;; - Functions to automatically adjust and cycle the section underline
35 ;; - A mode that displays the table of contents and allows you to jump anywhere
37 ;; - Functions to insert and automatically update a TOC in your source
39 ;; - Font-lock highlighting of notable reStructuredText structures;
40 ;; - Some other convenience functions.
42 ;; See the accompanying document in the docutils documentation about
43 ;; the contents of this package and how to use it.
45 ;; For more information about reStructuredText, see
46 ;; http://docutils.sourceforge.net/rst.html
48 ;; For full details on how to use the contents of this file, see
49 ;; http://docutils.sourceforge.net/docs/user/emacs.html
52 ;; There are a number of convenient keybindings provided by rst-mode.
55 ;; C-c C-a (also C-=): rst-adjust
57 ;; Updates or rotates the section title around point or promotes/demotes the
58 ;; decorations within the region (see full details below). Note that C-= is a
59 ;; good binding, since it allows you to specify a negative arg easily with C--
60 ;; C-= (easy to type), as well as ordinary prefix arg with C-u C-=.
62 ;; For more on bindings, see rst-mode-map below. There are also many variables
63 ;; that can be customized, look for defcustom and defvar in this file.
65 ;; If you use the table-of-contents feature, you may want to add a hook to
66 ;; update the TOC automatically everytime you adjust a section title::
68 ;; (add-hook 'rst-adjust-hook 'rst-toc-update)
70 ;; Syntax highlighting: font-lock is enabled by default. If you want to turn
71 ;; off syntax highlighting to rst-mode, you can use the following::
73 ;; (setq font-lock-global-modes '(not rst-mode ...))
81 ;; This group contains some general customizable features.
83 ;; The group is contained in the wp group.
87 ;; This group contains all necessary for customizing fonts. The default
88 ;; settings use standard font-lock-*-face's so if you set these to your
89 ;; liking they are probably good in rst-mode also.
91 ;; The group is contained in the faces group as well as in the rst group.
95 ;; This group contains all necessary for customizing the default fonts used for
96 ;; section title faces.
98 ;; The general idea for section title faces is to have a non-default background
99 ;; but do not change the background. The section level is shown by the
100 ;; lightness of the background color. If you like this general idea of
101 ;; generating faces for section titles but do not like the details this group
102 ;; is the point where you can customize the details. If you do not like the
103 ;; general idea, however, you should customize the faces used in
104 ;; rst-adornment-faces-alist.
106 ;; Note: If you are using a dark background please make sure the variable
107 ;; frame-background-mode is set to the symbol dark. This triggers
108 ;; some default values which are probably right for you.
110 ;; The group is contained in the rst-faces group.
112 ;; All customizable features have a comment explaining their meaning.
113 ;; Refer to the customization of your Emacs (try ``M-x customize``).
118 ;; The latest version of this file lies in the docutils source code repository:
119 ;; http://svn.berlios.de/svnroot/repos/docutils/trunk/docutils/tools/editors/emacs/rst.el
124 ;; Add the following lines to your `.emacs' file:
128 ;; If you are using `.txt' as a standard extension for reST files as
129 ;; http://docutils.sourceforge.net/FAQ.html#what-s-the-standard-filename-extension-for-a-restructuredtext-file
130 ;; suggests you may use one of the `Local Variables in Files' mechanism Emacs
131 ;; provides to set the major mode automatically. For instance you may use::
133 ;; .. -*- mode: rst -*-
135 ;; in the very first line of your file. The following code is useful if you
136 ;; want automatically enter rst-mode from any file with compatible extensions:
138 ;; (setq auto-mode-alist
139 ;; (append '(("\\.txt$" . rst-mode)
140 ;; ("\\.rst$" . rst-mode)
141 ;; ("\\.rest$" . rst-mode)) auto-mode-alist))
146 ;; - rst-enumeration-region: Select a single paragraph, with the top at one
147 ;; blank line before the beginning, and it will fail.
148 ;; - The active region goes away when we shift it left or right, and this
149 ;; prevents us from refilling it automatically when shifting many times.
150 ;; - The suggested decorations when adjusting should not have to cycle
151 ;; below one below the last section decoration level preceding the
152 ;; cursor. We need to fix that.
156 ;; rst-toc-insert features
157 ;; ------------------------
158 ;; - rst-toc-insert: We should parse the contents:: options to figure out how
159 ;; deep to render the inserted TOC.
160 ;; - On load, detect any existing TOCs and set the properties for links.
161 ;; - TOC insertion should have an option to add empty lines.
162 ;; - TOC insertion should deal with multiple lines.
163 ;; - There is a bug on redo after undo of adjust when rst-adjust-hook uses the
164 ;; automatic toc update. The cursor ends up in the TOC and this is
165 ;; annoying. Gotta fix that.
166 ;; - numbering: automatically detect if we have a section-numbering directive in
167 ;; the corresponding section, to render the toc.
169 ;; bulleted and enumerated list items
170 ;; ----------------------------------
171 ;; - We need to provide way to rebullet bulleted lists, and that would include
172 ;; automatic enumeration as well.
176 ;; - It would be nice to differentiate between text files using
177 ;; reStructuredText_ and other general text files. If we had a
178 ;; function to automatically guess whether a .txt file is following the
179 ;; reStructuredText_ conventions, we could trigger rst-mode without
180 ;; having to hard-code this in every text file, nor forcing the user to
181 ;; add a local mode variable at the top of the file.
182 ;; We could perform this guessing by searching for a valid decoration
183 ;; at the top of the document or searching for reStructuredText_
184 ;; directives further on.
186 ;; - We should support imenu in our major mode, with the menu filled with the
187 ;; section titles (this should be really easy).
189 ;; - We should rename "adornment" to "decoration" or vice-versa in this
190 ;; document (Stefan's code ("adornment") vs Martin ("decoration")), maybe some
191 ;; functions even overlap.
193 ;; - We need to automatically recenter on rst-forward-section movement commands.
202 (defgroup rst nil
"Support for reStructuredText documents."
205 :link
'(url-link "http://docutils.sourceforge.net/rst.html"))
210 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
211 ;; Define some generic support functions.
213 (eval-when-compile (require 'cl
)) ;; We need this for destructuring-bind below.
217 (unless (fboundp 'line-number-at-pos
)
218 (defun line-number-at-pos (&optional pos
)
219 "Return (narrowed) buffer line number at position POS.
220 If POS is nil, use current buffer location."
221 (let ((opoint (or pos
(point))) start
)
223 (goto-char (point-min))
227 (1+ (count-lines start
(point)))))) )
231 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
236 (let ((map (make-sparse-keymap)))
239 ;; Section Decorations.
241 ;; The adjustment function that decorates or rotates a section title.
242 (define-key map
[(control c
) (control a
)] 'rst-adjust
)
243 (define-key map
[(control c
) (control ?
=)] 'rst-adjust
)
244 (define-key map
[(control ?
=)] 'rst-adjust
) ;; (Does not work on the Mac OSX.)
245 ;; Display the hierarchy of decorations implied by the current document contents.
246 (define-key map
[(control c
) (control h
)] 'rst-display-decorations-hierarchy
)
247 ;; Homogeneize the decorations in the document.
248 (define-key map
[(control c
) (control s
)] 'rst-straighten-decorations
)
249 ;; (define-key map [(control c) (control s)] 'rst-straighten-deco-spacing)
252 ;; Section Movement and Selection.
254 ;; Mark the subsection where the cursor is.
255 (define-key map
[(control c
) (control m
)] 'rst-mark-section
)
256 ;; Move forward/backward between section titles.
257 (define-key map
[(control c
) (control n
)] 'rst-forward-section
)
258 (define-key map
[(control c
) (control p
)] 'rst-backward-section
)
261 ;; Operating on Blocks of Text.
263 ;; Makes paragraphs in region as a bullet list.
264 (define-key map
[(control c
) (control b
)] 'rst-bullet-list-region
)
265 ;; Makes paragraphs in region as a enumeration.
266 (define-key map
[(control c
) (control e
)] 'rst-enumerate-region
)
267 ;; Converts bullets to an enumeration.
268 (define-key map
[(control c
) (control v
)] 'rst-convert-bullets-to-enumeration
)
269 ;; Makes region a line-block.
270 (define-key map
[(control c
) (control d
)] 'rst-line-block-region
)
271 ;; Make sure that all the bullets in the region are consistent.
272 (define-key map
[(control c
) (control w
)] 'rst-straighten-bullets-region
)
273 ;; Shift region left or right (taking into account of enumerations/bullets, etc.).
274 (define-key map
[(control c
) (control l
)] 'rst-shift-region-left
)
275 (define-key map
[(control c
) (control r
)] 'rst-shift-region-right
)
276 ;; Comment/uncomment the active region.
277 (define-key map
[(control c
) (control c
)] 'comment-region
)
280 ;; Table-of-Contents Features.
282 ;; Enter a TOC buffer to view and move to a specific section.
283 (define-key map
[(control c
) (control t
)] 'rst-toc
)
284 ;; Insert a TOC here.
285 (define-key map
[(control c
) (control i
)] 'rst-toc-insert
)
286 ;; Update the document's TOC (without changing the cursor position).
287 (define-key map
[(control c
) (control u
)] 'rst-toc-update
)
288 ;; Got to the section under the cursor (cursor must be in TOC).
289 (define-key map
[(control c
) (control f
)] 'rst-goto-section
)
292 ;; Converting Documents from Emacs.
294 ;; Run one of two pre-configured toolset commands on the document.
295 (define-key map
[(control c
) (?
1)] 'rst-compile
)
296 (define-key map
[(control c
) (?
2)] 'rst-compile-alt-toolset
)
297 ;; Convert the active region to pseudo-xml using the docutils tools.
298 (define-key map
[(control c
) (?
3)] 'rst-compile-pseudo-region
)
299 ;; Convert the current document to PDF and launch a viewer on the results.
300 (define-key map
[(control c
) (?
4)] 'rst-compile-pdf-preview
)
301 ;; Convert the current document to S5 slides and view in a web browser.
302 (define-key map
[(control c
) (?
5)] 'rst-compile-slides-preview
)
305 "Keymap for reStructuredText mode commands.
306 This inherits from Text mode.")
310 (defvar rst-mode-abbrev-table nil
311 "Abbrev table used while in Rst mode.")
312 (define-abbrev-table 'rst-mode-abbrev-table
314 ("contents" ".. contents::\n..\n " nil
0)
315 ("con" ".. contents::\n..\n " nil
0)
316 ("cont" "[...]" nil
0)
317 ("skip" "\n\n[...]\n\n " nil
0)
318 ("seq" "\n\n[...]\n\n " nil
0)
319 ;; FIXME: Add footnotes, links, and more.
324 (defvar rst-mode-syntax-table
325 (let ((st (copy-syntax-table text-mode-syntax-table
)))
327 (modify-syntax-entry ?$
"." st
)
328 (modify-syntax-entry ?%
"." st
)
329 (modify-syntax-entry ?
& "." st
)
330 (modify-syntax-entry ?
' "." st
)
331 (modify-syntax-entry ?
* "." st
)
332 (modify-syntax-entry ?
+ "." st
)
333 (modify-syntax-entry ?.
"_" st
)
334 (modify-syntax-entry ?
/ "." st
)
335 (modify-syntax-entry ?
< "." st
)
336 (modify-syntax-entry ?
= "." st
)
337 (modify-syntax-entry ?
> "." st
)
338 (modify-syntax-entry ?
\\ "\\" st
)
339 (modify-syntax-entry ?|
"." st
)
340 (modify-syntax-entry ?_
"." st
)
343 "Syntax table used while in `rst-mode'.")
346 (defcustom rst-mode-hook nil
347 "Hook run when Rst mode is turned on.
348 The hook for Text mode is run before this one."
353 (defcustom rst-mode-lazy t
354 "If non-nil Rst mode tries to font-lock multi-line elements correctly.
355 Because this is really slow it should be set to nil if neither `jit-lock-mode'
356 not `lazy-lock-mode' and activated.
358 If nil, comments and literal blocks are font-locked only on the line they start.
360 The value of this variable is used when Rst mode is turned on."
364 ;; Use rst-mode for *.rst and *.rest files. Many ReStructured-Text files
365 ;; use *.txt, but this is too generic to be set as a default.
366 ;;;###autoload (add-to-list 'auto-mode-alist '("\\.re?st\\'" . rst-mode))
368 (define-derived-mode rst-mode text-mode
"ReST"
369 "Major mode for editing reStructuredText documents.
371 There are a number of convenient keybindings provided by
372 Rst mode. The main one is \\[rst-adjust], it updates or rotates
373 the section title around point or promotes/demotes the
374 decorations within the region (see full details below).
375 Use negative prefix arg to rotate in the other direction.
377 Turning on `rst-mode' calls the normal hooks `text-mode-hook'
378 and `rst-mode-hook'. This mode also supports font-lock
379 highlighting. You may customize `rst-mode-lazy' to toggle
380 font-locking of blocks.
383 :abbrev-table rst-mode-abbrev-table
384 :syntax-table rst-mode-syntax-table
387 (set (make-local-variable 'paragraph-separate
) paragraph-start
)
388 (set (make-local-variable 'indent-line-function
) 'indent-relative-maybe
)
389 (set (make-local-variable 'paragraph-start
)
390 "\f\\|>*[ \t]*$\\|>*[ \t]*[-+*] \\|>*[ \t]*[0-9#]+\\. ")
391 (set (make-local-variable 'adaptive-fill-mode
) t
)
393 ;; FIXME: No need to reset this.
394 ;; (set (make-local-variable 'indent-line-function) 'indent-relative)
396 ;; The details of the following comment setup is important because it affects
397 ;; auto-fill, and it is pretty common in running text to have an ellipsis
398 ;; ("...") which trips because of the rest comment syntax (".. ").
399 (set (make-local-variable 'comment-start
) ".. ")
400 (set (make-local-variable 'comment-start-skip
) "^\\.\\. ")
401 (set (make-local-variable 'comment-multi-line
) nil
)
404 (make-local-variable 'rst-adornment-level-alist
)
407 (set (make-local-variable 'font-lock-defaults
)
408 '(rst-font-lock-keywords-function
410 (font-lock-mark-block-function . mark-paragraph
)))
411 ;; `jit-lock-mode' has been the default since Emacs-21.1, so there's no
412 ;; point messing around with font-lock-support-mode any more.
413 ;; (when (boundp 'font-lock-support-mode)
414 ;; ;; rst-mode has its own mind about font-lock-support-mode
415 ;; (make-local-variable 'font-lock-support-mode)
416 ;; ;; jit-lock-mode replaced lazy-lock-mode in GNU Emacs 21.
417 ;; (let ((jit-or-lazy-lock-mode
419 ;; ((fboundp 'lazy-lock-mode) 'lazy-lock-mode)
420 ;; ((fboundp 'jit-lock-mode) 'jit-lock-mode)
421 ;; ;; if neither lazy-lock nor jit-lock is supported,
422 ;; ;; tell user and disable rst-mode-lazy
423 ;; (t (when rst-mode-lazy
424 ;; (message "Disabled lazy fontification, because no known support mode found.")
425 ;; (setq rst-mode-lazy nil))))))
427 ;; ((and (not rst-mode-lazy) (not font-lock-support-mode)))
428 ;; ;; No support mode set and none required - leave it alone
429 ;; ((or (not font-lock-support-mode) ;; No support mode set (but required)
430 ;; (symbolp font-lock-support-mode)) ;; or a fixed mode for all
431 ;; (setq font-lock-support-mode
432 ;; (list (cons 'rst-mode (and rst-mode-lazy jit-or-lazy-lock-mode))
433 ;; (cons t font-lock-support-mode))))
434 ;; ((and (listp font-lock-support-mode)
435 ;; (not (assoc 'rst-mode font-lock-support-mode)))
436 ;; ;; A list of modes missing rst-mode
437 ;; (setq font-lock-support-mode
438 ;; (cons (cons 'rst-mode (and rst-mode-lazy jit-or-lazy-lock-mode))
439 ;; font-lock-support-mode))))))
445 (define-minor-mode rst-minor-mode
447 Toggle ReST minor mode.
448 With no argument, this command toggles the mode.
449 Non-null prefix argument turns on the mode.
450 Null prefix argument turns off the mode.
452 When ReST minor mode is enabled, the ReST mode keybindings
453 are installed on top of the major mode bindings. Use this
454 for modes derived from Text mode, like Mail mode."
455 ;; The initial value.
457 ;; The indicator for the mode line.
459 ;; The minor mode bindings.
463 ;; FIXME: can I somehow install these too?
464 ;; :abbrev-table rst-mode-abbrev-table
465 ;; :syntax-table rst-mode-syntax-table
471 ;; Bulleted item lists.
472 (defcustom rst-bullets
474 "List of all possible bullet characters for bulleted lists."
480 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
481 ;; Section Decoration Adjusment
482 ;; ============================
484 ;; The following functions implement a smart automatic title sectioning feature.
485 ;; The idea is that with the cursor sitting on a section title, we try to get as
486 ;; much information from context and try to do the best thing automatically.
487 ;; This function can be invoked many times and/or with prefix argument to rotate
488 ;; between the various sectioning decorations.
490 ;; Definitions: the two forms of sectioning define semantically separate section
491 ;; levels. A sectioning DECORATION consists in:
495 ;; - a STYLE which can be either of 'simple' or 'over-and-under'.
497 ;; - an INDENT (meaningful for the over-and-under style only) which determines
498 ;; how many characters and over-and-under style is hanging outside of the
499 ;; title at the beginning and ending.
501 ;; Important note: an existing decoration must be formed by at least two
502 ;; characters to be recognized.
504 ;; Here are two examples of decorations (| represents the window border, column
508 ;; 1. char: '-' e |Some Title
509 ;; style: simple |----------
511 ;; 2. char: '=' |==============
512 ;; style: over-and-under | Some Title
513 ;; indent: 2 |==============
518 ;; - The underlining character that is used depends on context. The file is
519 ;; scanned to find other sections and an appropriate character is selected.
520 ;; If the function is invoked on a section that is complete, the character is
521 ;; rotated among the existing section decorations.
523 ;; Note that when rotating the characters, if we come to the end of the
524 ;; hierarchy of decorations, the variable rst-preferred-decorations is
525 ;; consulted to propose a new underline decoration, and if continued, we cycle
526 ;; the decorations all over again. Set this variable to nil if you want to
527 ;; limit the underlining character propositions to the existing decorations in
530 ;; - A prefix argument can be used to alternate the style.
532 ;; - An underline/overline that is not extended to the column at which it should
533 ;; be hanging is dubbed INCOMPLETE. For example::
538 ;; Examples of default invocation:
540 ;; |Some Title ---> |Some Title
543 ;; |Some Title ---> |Some Title
544 ;; |----- |----------
547 ;; | Some Title ---> | Some Title
550 ;; In over-and-under style, when alternating the style, a variable is
551 ;; available to select how much default indent to use (it can be zero). Note
552 ;; that if the current section decoration already has an indent, we don't
553 ;; adjust it to the default, we rather use the current indent that is already
554 ;; there for adjustment (unless we cycle, in which case we use the indent
555 ;; that has been found previously).
557 (defgroup rst-adjust nil
558 "Settings for adjustment and cycling of section title decorations."
562 (defcustom rst-preferred-decorations
'( (?
= over-and-under
1)
570 "Preferred ordering of section title decorations.
572 This sequence is consulted to offer a new decoration suggestion
573 when we rotate the underlines at the end of the existing
574 hierarchy of characters, or when there is no existing section
579 (defcustom rst-default-indent
1
580 "Number of characters to indent the section title.
582 This is used for when toggling decoration styles, when switching
583 from a simple decoration style to a over-and-under decoration
588 (defvar rst-section-text-regexp
"^[ \t]*\\S-*\\w\\S-*"
589 "Regular expression for valid section title text.")
592 (defun rst-line-homogeneous-p (&optional accept-special
)
593 "Return true if the line is homogeneous.
595 Predicate that returns the unique char if the current line is
596 composed only of a single repeated non-whitespace character.
597 This returns the char even if there is whitespace at the
598 beginning of the line.
600 If ACCEPT-SPECIAL is specified we do not ignore special sequences
601 which normally we would ignore when doing a search on many lines.
602 For example, normally we have cases to ignore commonly occurring
603 patterns, such as :: or ...; with the flag do not ignore them."
605 (back-to-indentation)
606 (unless (looking-at "\n")
607 (let ((c (thing-at-point 'char
)))
608 (if (and (looking-at (format "[%s]+[ \t]*$" c
))
612 (not (looking-at "::[ \t]*$"))
613 (not (looking-at "\\.\\.\\.[ \t]*$"))
614 ;; Discard one char line
615 (not (looking-at ".[ \t]*$"))
621 (defun rst-line-homogeneous-nodent-p (&optional accept-special
)
622 "Return true if the line is homogeneous with no indent.
623 See `rst-line-homogeneous-p' about ACCEPT-SPECIAL."
626 (if (looking-at "^[ \t]+")
628 (rst-line-homogeneous-p accept-special
)
632 (defun rst-compare-decorations (deco1 deco2
)
633 "Compare decorations.
634 Return true if both DECO1 and DECO2 decorations are equal,
635 according to restructured text semantics (only the character and
636 the style are compared, the indentation does not matter)."
637 (and (eq (car deco1
) (car deco2
))
638 (eq (cadr deco1
) (cadr deco2
))))
641 (defun rst-get-decoration-match (hier deco
)
642 "Return the index (level) in hierarchy HIER of decoration DECO.
643 This basically just searches for the item using the appropriate
644 comparison and returns the index. Return nil if the item is
647 (while (and cur
(not (rst-compare-decorations (car cur
) deco
)))
648 (setq cur
(cdr cur
)))
652 (defun rst-suggest-new-decoration (alldecos &optional prev
)
653 "Suggest a new, different decoration from all that have been seen.
655 ALLDECOS is the set of all decorations, including the line numbers.
656 PREV is the optional previous decoration, in order to suggest a
659 ;; For all the preferred decorations...
661 ;; If 'prev' is given, reorder the list to start searching after the
664 (cdr (rst-get-decoration-match rst-preferred-decorations prev
)))
666 ;; List of candidates to search.
667 (curpotential (append fplist rst-preferred-decorations
)))
669 ;; For all the decorations...
672 (while (and cur
(not found
))
673 (if (rst-compare-decorations (car cur
) (car curpotential
))
675 (setq found
(car curpotential
))
676 (setq cur
(cdr cur
))))
679 (setq curpotential
(cdr curpotential
)))
681 (copy-sequence (car curpotential
))))
683 (defun rst-delete-entire-line ()
684 "Delete the entire current line without using the `kill-ring'."
685 (delete-region (line-beginning-position)
686 (line-beginning-position 2)))
688 (defun rst-update-section (char style
&optional indent
)
689 "Unconditionally update the style of a section decoration.
691 Do this using the given character CHAR, with STYLE 'simple
692 or 'over-and-under, and with indent INDENT. If the STYLE
693 is 'simple, whitespace before the title is removed (indent
694 is always assumed to be 0).
696 If there are existing overline and/or underline from the
697 existing decoration, they are removed before adding the
698 requested decoration."
705 (setq marker
(point-marker))
707 ;; Fixup whitespace at the beginning and end of the line
708 (if (or (null indent
) (eq style
'simple
))
711 (delete-horizontal-space)
712 (insert (make-string indent ?
))
715 (delete-horizontal-space)
717 ;; Set the current column, we're at the end of the title line
718 (setq len
(+ (current-column) indent
))
720 ;; Remove previous line if it consists only of a single repeated character
723 (and (rst-line-homogeneous-p 1)
724 ;; Avoid removing the underline of a title right above us.
725 (save-excursion (forward-line -
1)
726 (not (looking-at rst-section-text-regexp
)))
727 (rst-delete-entire-line)))
729 ;; Remove following line if it consists only of a single repeated
733 (and (rst-line-homogeneous-p 1)
734 (rst-delete-entire-line))
735 ;; Add a newline if we're at the end of the buffer, for the subsequence
736 ;; inserting of the underline
737 (if (= (point) (buffer-end 1))
741 (if (eq style
'over-and-under
)
745 (insert (make-string len char
))))
750 (insert (make-string len char
))
757 (defun rst-normalize-cursor-position ()
758 "Normalize the cursor position.
759 If the cursor is on a decoration line or an empty line , place it
760 on the section title line (at the end). Returns the line offset
761 by which the cursor was moved. This works both over or under a
763 (if (save-excursion (beginning-of-line)
764 (or (rst-line-homogeneous-p 1)
765 (looking-at "^[ \t]*$")))
769 ((save-excursion (forward-line -
1)
771 (and (looking-at rst-section-text-regexp
)
772 (not (rst-line-homogeneous-p 1))))
773 (progn (forward-line -
1) -
1))
774 ((save-excursion (forward-line +1)
776 (and (looking-at rst-section-text-regexp
)
777 (not (rst-line-homogeneous-p 1))))
778 (progn (forward-line +1) +1))
783 (defun rst-find-all-decorations ()
784 "Find all the decorations in the file.
785 Return a list of (line, decoration) pairs. Each decoration
786 consists in a (char, style, indent) triple.
788 This function does not detect the hierarchy of decorations, it
789 just finds all of them in a file. You can then invoke another
790 function to remove redundancies and inconsistencies."
794 ;; Iterate over all the section titles/decorations in the file.
796 (goto-char (point-min))
797 (while (< (point) (buffer-end 1))
798 (if (rst-line-homogeneous-nodent-p)
800 (setq curline
(+ curline
(rst-normalize-cursor-position)))
802 ;; Here we have found a potential site for a decoration,
804 (let ((deco (rst-get-decoration)))
805 (if (cadr deco
) ;; Style is existing.
806 ;; Found a real decoration site.
808 (push (cons curline deco
) positions
)
809 ;; Push beyond the underline.
811 (setq curline
(+ curline
1))
815 (setq curline
(+ curline
1))
817 (reverse positions
)))
820 (defun rst-infer-hierarchy (decorations)
821 "Build a hierarchy of decorations using the list of given DECORATIONS.
823 This function expects a list of (char, style, indent) decoration
824 specifications, in order that they appear in a file, and will
825 infer a hierarchy of section levels by removing decorations that
826 have already been seen in a forward traversal of the decorations,
827 comparing just the character and style.
829 Similarly returns a list of (char, style, indent), where each
830 list element should be unique."
832 (let ((hierarchy-alist (list)))
833 (dolist (x decorations
)
836 (unless (assoc (cons char style
) hierarchy-alist
)
837 (push (cons (cons char style
) x
) hierarchy-alist
))
840 (mapcar 'cdr
(nreverse hierarchy-alist
))
844 (defun rst-get-hierarchy (&optional alldecos ignore
)
845 "Return the hierarchy of section titles in the file.
847 Return a list of decorations that represents the hierarchy of
848 section titles in the file. Reuse the list of decorations
849 already computed in ALLDECOS if present. If the line number in
850 IGNORE is specified, the decoration found on that line (if there
851 is one) is not taken into account when building the hierarchy."
852 (let ((all (or alldecos
(rst-find-all-decorations))))
853 (setq all
(assq-delete-all ignore all
))
854 (rst-infer-hierarchy (mapcar 'cdr all
))))
857 (defun rst-get-decoration (&optional point
)
858 "Get the decoration at POINT.
860 Looks around point and finds the characteristics of the
861 decoration that is found there. Assumes that the cursor is
862 already placed on the title line (and not on the overline or
865 This function returns a (char, style, indent) triple. If the
866 characters of overline and underline are different, return
867 the underline character. The indent is always calculated.
868 A decoration can be said to exist if the style is not nil.
870 A point can be specified to go to the given location before
871 extracting the decoration."
873 (let (char style indent
)
875 (if point
(goto-char point
))
877 (if (looking-at rst-section-text-regexp
)
878 (let* ((over (save-excursion
880 (rst-line-homogeneous-nodent-p)))
882 (under (save-excursion
884 (rst-line-homogeneous-nodent-p)))
887 ;; Check that the line above the overline is not part of a title
891 (and (equal (forward-line -
2) 0)
892 (looking-at rst-section-text-regexp
))))
896 ;; No decoration found, leave all return values nil.
897 ((and (eq over nil
) (eq under nil
)))
899 ;; Overline only, leave all return values nil.
901 ;; Note: we don't return the overline character, but it could
902 ;; perhaps in some cases be used to do something.
903 ((and over
(eq under nil
)))
906 ((and under
(eq over nil
))
910 ;; Both overline and underline.
913 style
'over-and-under
))
918 (setq indent
(save-excursion (back-to-indentation) (current-column)))
921 (list char style indent
)))
924 (defun rst-get-decorations-around (&optional alldecos
)
925 "Return the decorations around point.
927 Given the list of all decorations ALLDECOS (with positions),
928 find the decorations before and after the given point.
929 A list of the previous and next decorations is returned."
930 (let* ((all (or alldecos
(rst-find-all-decorations)))
931 (curline (line-number-at-pos))
935 ;; Search for the decorations around the current line.
936 (while (and cur
(< (caar cur
) curline
))
939 ;; 'cur' is the following decoration.
941 (if (and cur
(caar cur
))
942 (setq next
(if (= curline
(caar cur
)) (cdr cur
) cur
)))
944 (mapcar 'cdar
(list prev next
))
948 (defun rst-decoration-complete-p (deco)
949 "Return true if the decoration DECO around point is complete."
950 ;; Note: we assume that the detection of the overline as being the underline
951 ;; of a preceding title has already been detected, and has been eliminated
952 ;; from the decoration that is given to us.
954 ;; There is some sectioning already present, so check if the current
955 ;; sectioning is complete and correct.
956 (let* ((char (car deco
))
958 (indent (caddr deco
))
959 (endcol (save-excursion (end-of-line) (current-column)))
962 (let ((exps (concat "^"
963 (regexp-quote (make-string (+ endcol indent
) char
))
966 (save-excursion (forward-line +1)
969 (or (not (eq style
'over-and-under
))
970 (save-excursion (forward-line -
1)
977 (defun rst-get-next-decoration
978 (curdeco hier
&optional suggestion reverse-direction
)
979 "Get the next decoration for CURDECO, in given hierarchy HIER.
980 If suggesting, suggest for new decoration SUGGESTION.
981 REVERSE-DIRECTION is used to reverse the cycling order."
985 (style (cadr curdeco
))
987 ;; Build a new list of decorations for the rotation.
990 ;; Suggest a new decoration.
992 ;; If nothing to suggest, use first decoration.
995 ;; Search for next decoration.
997 (let ((cur (if reverse-direction rotdecos
998 (reverse rotdecos
))))
1000 (not (and (eq char
(caar cur
))
1001 (eq style
(cadar cur
)))))
1002 (setq cur
(cdr cur
)))
1005 ;; If not found, take the first of all decorations.
1010 (defun rst-adjust ()
1011 "Auto-adjust the decoration around point.
1013 Adjust/rotate the section decoration for the section title
1014 around point or promote/demote the decorations inside the region,
1015 depending on if the region is active. This function is meant to
1016 be invoked possibly multiple times, and can vary its behavior
1017 with a positive prefix argument (toggle style), or with a
1018 negative prefix argument (alternate behavior).
1020 This function is the main focus of this module and is a bit of a
1021 swiss knife. It is meant as the single most essential function
1022 to be bound to invoke to adjust the decorations of a section
1023 title in restructuredtext. It tries to deal with all the
1024 possible cases gracefully and to do `the right thing' in all
1027 See the documentations of `rst-adjust-decoration' and
1028 `rst-promote-region' for full details.
1033 The method can take either (but not both) of
1035 a. a (non-negative) prefix argument, which means to toggle the
1036 decoration style. Invoke with a prefix arg for example;
1038 b. a negative numerical argument, which generally inverts the
1039 direction of search in the file or hierarchy. Invoke with C--
1040 prefix for example."
1043 (let* (;; Save our original position on the current line.
1044 (origpt (set-marker (make-marker) (point)))
1046 ;; Parse the positive and negative prefix arguments.
1048 (and current-prefix-arg
1049 (< (prefix-numeric-value current-prefix-arg
) 0)))
1051 (and current-prefix-arg
(not reverse-direction
))))
1053 (if (rst-portable-mark-active-p)
1054 ;; Adjust decorations within region.
1055 (rst-promote-region current-prefix-arg
)
1056 ;; Adjust decoration around point.
1057 (rst-adjust-decoration toggle-style reverse-direction
))
1059 ;; Run the hooks to run after adjusting.
1060 (run-hooks 'rst-adjust-hook
)
1062 ;; Make sure to reset the cursor position properly after we're done.
1067 (defvar rst-adjust-hook nil
1068 "Hooks to be run after running `rst-adjust'.")
1070 (defvar rst-new-decoration-down nil
1071 "Non-nil if new decoration is added deeper.
1072 If non-nil, a new decoration being added will be initialized to
1073 be one level down from the previous decoration. If nil, a new
1074 decoration will be equal to the level of the previous
1077 (defun rst-adjust-decoration (&optional toggle-style reverse-direction
)
1078 "Adjust/rotate the section decoration for the section title around point.
1080 This function is meant to be invoked possibly multiple times, and
1081 can vary its behavior with a true TOGGLE-STYLE argument, or with
1082 a REVERSE-DIRECTION argument.
1087 The next action it takes depends on context around the point, and
1088 it is meant to be invoked possibly more than once to rotate among
1089 the various possibilities. Basically, this function deals with:
1091 - adding a decoration if the title does not have one;
1093 - adjusting the length of the underline characters to fit a
1096 - rotating the decoration in the set of already existing
1097 sectioning decorations used in the file;
1099 - switching between simple and over-and-under styles.
1101 You should normally not have to read all the following, just
1102 invoke the method and it will do the most obvious thing that you
1106 Decoration Definitions
1107 ======================
1109 The decorations consist in
1113 2. a STYLE which can be either of 'simple' or 'over-and-under'.
1115 3. an INDENT (meaningful for the over-and-under style only)
1116 which determines how many characters and over-and-under
1117 style is hanging outside of the title at the beginning and
1120 See source code for mode details.
1123 Detailed Behavior Description
1124 =============================
1126 Here are the gory details of the algorithm (it seems quite
1127 complicated, but really, it does the most obvious thing in all
1128 the particular cases):
1130 Before applying the decoration change, the cursor is placed on
1131 the closest line that could contain a section title.
1133 Case 1: No Decoration
1134 ---------------------
1136 If the current line has no decoration around it,
1138 - search backwards for the last previous decoration, and apply
1139 the decoration one level lower to the current line. If there
1140 is no defined level below this previous decoration, we suggest
1141 the most appropriate of the `rst-preferred-decorations'.
1143 If REVERSE-DIRECTION is true, we simply use the previous
1144 decoration found directly.
1146 - if there is no decoration found in the given direction, we use
1147 the first of `rst-preferred-decorations'.
1149 The prefix argument forces a toggle of the prescribed decoration
1152 Case 2: Incomplete Decoration
1153 -----------------------------
1155 If the current line does have an existing decoration, but the
1156 decoration is incomplete, that is, the underline/overline does
1157 not extend to exactly the end of the title line (it is either too
1158 short or too long), we simply extend the length of the
1159 underlines/overlines to fit exactly the section title.
1161 If the prefix argument is given, we toggle the style of the
1164 REVERSE-DIRECTION has no effect in this case.
1166 Case 3: Complete Existing Decoration
1167 ------------------------------------
1169 If the decoration is complete (i.e. the underline (overline)
1170 length is already adjusted to the end of the title line), we
1171 search/parse the file to establish the hierarchy of all the
1172 decorations (making sure not to include the decoration around
1173 point), and we rotate the current title's decoration from within
1174 that list (by default, going *down* the hierarchy that is present
1175 in the file, i.e. to a lower section level). This is meant to be
1176 used potentially multiple times, until the desired decoration is
1177 found around the title.
1179 If we hit the boundary of the hierarchy, exactly one choice from
1180 the list of preferred decorations is suggested/chosen, the first
1181 of those decoration that has not been seen in the file yet (and
1182 not including the decoration around point), and the next
1183 invocation rolls over to the other end of the hierarchy (i.e. it
1184 cycles). This allows you to avoid having to set which character
1187 If REVERSE-DIRECTION is true, the effect is to change the
1188 direction of rotation in the hierarchy of decorations, thus
1189 instead going *up* the hierarchy.
1191 However, if there is a non-negative prefix argument, we do not
1192 rotate the decoration, but instead simply toggle the style of the
1193 current decoration (this should be the most common way to toggle
1194 the style of an existing complete decoration).
1200 The invocation of this function can be carried out anywhere
1201 within the section title line, on an existing underline or
1202 overline, as well as on an empty line following a section title.
1203 This is meant to be as convenient as possible.
1209 Indented section titles such as ::
1214 are invalid in restructuredtext and thus not recognized by the
1215 parser. This code will thus not work in a way that would support
1216 indented sections (it would be ambiguous anyway).
1222 Section titles that are right next to each other may not be
1223 treated well. More work might be needed to support those, and
1224 special conditions on the completeness of existing decorations
1225 might be required to make it non-ambiguous.
1227 For now we assume that the decorations are disjoint, that is,
1228 there is at least a single line between the titles/decoration
1235 We suggest that you bind this function on C-=. It is close to
1236 C-- so a negative argument can be easily specified with a flick
1237 of the right hand fingers and the binding is unused in `text-mode'."
1240 ;; If we were invoked directly, parse the prefix arguments into the
1241 ;; arguments of the function.
1242 (if current-prefix-arg
1243 (setq reverse-direction
1244 (and current-prefix-arg
1245 (< (prefix-numeric-value current-prefix-arg
) 0))
1248 (and current-prefix-arg
(not reverse-direction
))))
1250 (let* (;; Check if we're on an underline around a section title, and move the
1251 ;; cursor to the title if this is the case.
1252 (moved (rst-normalize-cursor-position))
1254 ;; Find the decoration and completeness around point.
1255 (curdeco (rst-get-decoration))
1256 (char (car curdeco
))
1257 (style (cadr curdeco
))
1258 (indent (caddr curdeco
))
1260 ;; New values to be computed.
1261 char-new style-new indent-new
1264 ;; We've moved the cursor... if we're not looking at some text, we have
1266 (if (save-excursion (beginning-of-line)
1267 (looking-at rst-section-text-regexp
))
1270 ;;-------------------------------------------------------------------
1271 ;; Case 1: No Decoration
1272 ((and (eq char nil
) (eq style nil
))
1274 (let* ((alldecos (rst-find-all-decorations))
1276 (around (rst-get-decorations-around alldecos
))
1280 (hier (rst-get-hierarchy alldecos
))
1283 ;; Advance one level down.
1286 (if (not reverse-direction
)
1287 (or (funcall (if rst-new-decoration-down
'cadr
'car
)
1288 (rst-get-decoration-match hier prev
))
1289 (rst-suggest-new-decoration hier prev
))
1291 (copy-sequence (car rst-preferred-decorations
))))
1293 ;; Invert the style if requested.
1295 (setcar (cdr cur
) (if (eq (cadr cur
) 'simple
)
1296 'over-and-under
'simple
)) )
1298 (setq char-new
(car cur
)
1299 style-new
(cadr cur
)
1300 indent-new
(caddr cur
))
1303 ;;-------------------------------------------------------------------
1304 ;; Case 2: Incomplete Decoration
1305 ((not (rst-decoration-complete-p curdeco
))
1307 ;; Invert the style if requested.
1309 (setq style
(if (eq style
'simple
) 'over-and-under
'simple
)))
1315 ;;-------------------------------------------------------------------
1316 ;; Case 3: Complete Existing Decoration
1320 ;; Simply switch the style of the current decoration.
1322 style-new
(if (eq style
'simple
) 'over-and-under
'simple
)
1323 indent-new rst-default-indent
)
1325 ;; Else, we rotate, ignoring the decoration around the current
1327 (let* ((alldecos (rst-find-all-decorations))
1329 (hier (rst-get-hierarchy alldecos
(line-number-at-pos)))
1331 ;; Suggestion, in case we need to come up with something
1333 (suggestion (rst-suggest-new-decoration
1335 (car (rst-get-decorations-around alldecos
))))
1337 (nextdeco (rst-get-next-decoration
1338 curdeco hier suggestion reverse-direction
))
1342 ;; Indent, if present, always overrides the prescribed indent.
1343 (setq char-new
(car nextdeco
)
1344 style-new
(cadr nextdeco
)
1345 indent-new
(caddr nextdeco
))
1350 ;; Override indent with present indent!
1351 (setq indent-new
(if (> indent
0) indent indent-new
))
1353 (if (and char-new style-new
)
1354 (rst-update-section char-new style-new indent-new
))
1358 ;; Correct the position of the cursor to more accurately reflect where it
1359 ;; was located when the function was invoked.
1361 (forward-line (- moved
))
1366 ;; Maintain an alias for compatibility.
1367 (defalias 'rst-adjust-section-title
'rst-adjust
)
1370 (defun rst-promote-region (&optional demote
)
1371 "Promote the section titles within the region.
1373 With argument DEMOTE or a prefix argument, demote the section
1374 titles instead. The algorithm used at the boundaries of the
1375 hierarchy is similar to that used by `rst-adjust-decoration'."
1378 (let* ((demote (or current-prefix-arg demote
))
1379 (alldecos (rst-find-all-decorations))
1382 (hier (rst-get-hierarchy alldecos
))
1383 (suggestion (rst-suggest-new-decoration hier
))
1385 (region-begin-line (line-number-at-pos (region-beginning)))
1386 (region-end-line (line-number-at-pos (region-end)))
1391 ;; Skip the markers that come before the region beginning
1392 (while (and cur
(< (caar cur
) region-begin-line
))
1393 (setq cur
(cdr cur
)))
1395 ;; Create a list of markers for all the decorations which are found within
1399 (while (and cur
(< (setq line
(caar cur
)) region-end-line
))
1400 (setq m
(make-marker))
1402 (push (list (set-marker m
(point)) (cdar cur
)) marker-list
)
1403 (setq cur
(cdr cur
)) ))
1405 ;; Apply modifications.
1407 (dolist (p marker-list
)
1408 ;; Go to the decoration to promote.
1411 ;; Rotate the next decoration.
1412 (setq nextdeco
(rst-get-next-decoration
1413 (cadr p
) hier suggestion demote
))
1415 ;; Update the decoration.
1416 (apply 'rst-update-section nextdeco
)
1418 ;; Clear marker to avoid slowing down the editing after we're done.
1419 (set-marker (car p
) nil
)
1421 (setq deactivate-mark nil
)
1426 (defun rst-display-decorations-hierarchy (&optional decorations
)
1427 "Display the current file's section title decorations hierarchy.
1428 This function expects a list of (char, style, indent) triples in
1432 (if (not decorations
)
1433 (setq decorations
(rst-get-hierarchy)))
1434 (with-output-to-temp-buffer "*rest section hierarchy*"
1436 (with-current-buffer standard-output
1437 (dolist (x decorations
)
1438 (insert (format "\nSection Level %d" level
))
1439 (apply 'rst-update-section x
)
1440 (goto-char (point-max))
1446 (defun rst-position (elem list
)
1447 "Return position of ELEM in LIST or nil."
1448 (let ((tail (member elem list
)))
1449 (if tail
(- (length list
) (length tail
)))))
1451 (defun rst-straighten-decorations ()
1452 "Redo all the decorations in the current buffer.
1453 This is done using our preferred set of decorations. This can be
1454 used, for example, when using somebody else's copy of a document,
1455 in order to adapt it to our preferred style."
1458 (let* ((alldecos (rst-find-all-decorations))
1459 (hier (rst-get-hierarchy alldecos
))
1461 ;; Get a list of pairs of (level . marker)
1462 (levels-and-markers (mapcar
1464 (cons (rst-position (cdr deco
) hier
)
1465 (let ((m (make-marker)))
1466 (goto-line (car deco
))
1467 (set-marker m
(point))
1471 (dolist (lm levels-and-markers
)
1472 ;; Go to the appropriate position
1473 (goto-char (cdr lm
))
1475 ;; Apply the new styule
1476 (apply 'rst-update-section
(nth (car lm
) rst-preferred-decorations
))
1478 ;; Reset the market to avoid slowing down editing until it gets GC'ed
1479 (set-marker (cdr lm
) nil
)
1486 (defun rst-straighten-deco-spacing ()
1487 "Adjust the spacing before and after decorations in the entire document.
1488 The spacing will be set to two blank lines before the first two
1489 section levels, and one blank line before any of the other
1491 ;; FIXME: we need to take care of subtitle at some point.
1494 (let* ((alldecos (rst-find-all-decorations)))
1496 ;; Work the list from the end, so that we don't have to use markers to
1497 ;; adjust for the changes in the document.
1498 (dolist (deco (nreverse alldecos
))
1499 ;; Go to the appropriate position.
1500 (goto-line (car deco
))
1507 (defun rst-find-pfx-in-region (beg end pfx-re
)
1508 "Find all the positions of prefixes in region between BEG and END.
1509 This is used to find bullets and enumerated list items. PFX-RE
1510 is a regular expression for matching the lines with items."
1514 (while (< (point) end
)
1515 (back-to-indentation)
1518 (let ((pfx-col (current-column)))
1521 (back-to-indentation)
1522 (or (looking-at "^[ \t]*$")
1523 (> (current-column) pfx-col
)
1524 (and (= (current-column) pfx-col
)
1525 (looking-at pfx-re
))))))
1526 (push (cons (point) (current-column))
1531 (defvar rst-re-bullets
1532 (format "\\([%s][ \t]\\)[^ \t]" (regexp-quote (concat rst-bullets
)))
1533 "Regexp for finding bullets.")
1535 ;; (defvar rst-re-enumerations
1536 ;; "\\(\\(#\\|[0-9]+\\)\\.[ \t]\\)[^ \t]"
1537 ;; "Regexp for finding bullets.")
1539 (defvar rst-re-items
1540 (format "\\(%s\\|%s\\)[^ \t]"
1541 (format "[%s][ \t]" (regexp-quote (concat rst-bullets
)))
1542 "\\(#\\|[0-9]+\\)\\.[ \t]")
1543 "Regexp for finding bullets.")
1545 (defvar rst-preferred-bullets
1547 "List of favourite bullets to set for straightening bullets.")
1549 (defun rst-straighten-bullets-region (beg end
)
1550 "Make all the bulleted list items in the region consistent.
1551 The region is specified between BEG and END. You can use this
1552 after you have merged multiple bulleted lists to make them use
1553 the same/correct/consistent bullet characters.
1555 See variable `rst-preferred-bullets' for the list of bullets to
1556 adjust. If bullets are found on levels beyond the
1557 `rst-preferred-bullets' list, they are not modified."
1560 (let ((bullets (rst-find-pfx-in-region beg end
1562 (levtable (make-hash-table :size
4)))
1564 ;; Create a map of levels to list of positions.
1566 (let ((key (cdr x
)))
1568 (append (gethash key levtable
(list))
1572 ;; Sort this map and create a new map of prefix char and list of positions.
1573 (let ((poslist ())) ; List of (indent . positions).
1574 (maphash (lambda (x y
) (push (cons x y
) poslist
)) levtable
)
1576 (let ((bullets rst-preferred-bullets
))
1577 (dolist (x (sort poslist
'car-less-than-car
))
1579 ;; Apply the characters.
1580 (dolist (pos (cdr x
))
1583 (insert (string (car bullets
))))
1584 (setq bullets
(cdr bullets
))))))))
1586 (defun rst-rstrip (str)
1587 "Strips the whitespace at the end of string STR."
1588 (string-match "[ \t\n]*\\'" str
)
1589 (substring str
0 (match-beginning 0)))
1591 (defun rst-get-stripped-line ()
1592 "Return the line at cursor, stripped from whitespace."
1593 (re-search-forward "\\S-.*\\S-" (line-end-position))
1594 (buffer-substring-no-properties (match-beginning 0)
1597 (defun rst-section-tree (alldecos)
1598 "Get the hierarchical tree of section titles.
1600 Returns a hierarchical tree of the sections titles in the
1601 document, for decorations ALLDECOS. This can be used to generate
1602 a table of contents for the document. The top node will always
1603 be a nil node, with the top level titles as children (there may
1604 potentially be more than one).
1606 Each section title consists in a cons of the stripped title
1607 string and a marker to the section in the original text document.
1609 If there are missing section levels, the section titles are
1610 inserted automatically, and the title string is set to nil, and
1611 the marker set to the first non-nil child of itself.
1612 Conceptually, the nil nodes--i.e. those which have no title--are
1613 to be considered as being the same line as their first non-nil
1614 child. This has advantages later in processing the graph."
1616 (let* ((hier (rst-get-hierarchy alldecos
))
1617 (levels (make-hash-table :test
'equal
:size
10))
1622 ;; Compare just the character and indent in the hash table.
1623 (puthash (cons (car deco
) (cadr deco
)) lev levels
)
1626 ;; Create a list of lines that contains (text, level, marker) for each
1630 (mapcar (lambda (deco)
1631 (goto-line (car deco
))
1632 (list (gethash (cons (cadr deco
) (caddr deco
)) levels
)
1633 (rst-get-stripped-line)
1634 (let ((m (make-marker)))
1635 (beginning-of-line 1)
1636 (set-marker m
(point)))
1640 (let ((lcontnr (cons nil lines
)))
1641 (rst-section-tree-rec lcontnr -
1))))
1644 (defun rst-section-tree-rec (decos lev
)
1645 "Recursive guts of the section tree construction.
1646 DECOS is a cons cell whose cdr is the remaining list of
1647 decorations, and we change it as we consume them. LEV is
1648 the current level of that node. This function returns a
1649 pair of the subtree that was built. This treats the DECOS
1650 list destructively."
1652 (let ((ndeco (cadr decos
))
1656 ;; If the next decoration matches our level
1657 (when (and ndeco
(= (car ndeco
) lev
))
1658 ;; Pop the next decoration and create the current node with it
1659 (setcdr decos
(cddr decos
))
1660 (setq node
(cdr ndeco
)) )
1661 ;; Else we let the node title/marker be unset.
1663 ;; Build the child nodes
1664 (while (and (cdr decos
) (> (caadr decos
) lev
))
1666 (cons (rst-section-tree-rec decos
(1+ lev
))
1668 (setq children
(reverse children
))
1670 ;; If node is still unset, we use the marker of the first child.
1672 (setq node
(cons nil
(cdaar children
))))
1674 ;; Return this node with its children.
1675 (cons node children
)
1679 (defun rst-section-tree-point (node &optional point
)
1680 "Find tree node at point.
1681 Given a computed and valid section tree in NODE and a point
1682 POINT (default being the current point in the current buffer),
1683 find and return the node within the sectree where the cursor
1686 Return values: a pair of (parent path, container subtree).
1687 The parent path is simply a list of the nodes above the
1688 container subtree node that we're returning."
1692 (let* ((curpoint (or point
(point))))
1694 ;; Check if we are before the current node.
1695 (if (and (cadar node
) (>= curpoint
(cadar node
)))
1697 ;; Iterate all the children, looking for one that might contain the
1699 (let ((curnode (cdr node
))
1702 (while (and curnode
(>= curpoint
(cadaar curnode
)))
1704 curnode
(cdr curnode
)))
1707 (let ((sub (rst-section-tree-point (car last
) curpoint
)))
1708 (setq path
(car sub
)
1710 (setq outtree node
))
1713 (cons (cons (car node
) path
) outtree
)
1717 (defgroup rst-toc nil
1718 "Settings for reStructuredText table of contents."
1722 (defcustom rst-toc-indent
2
1723 "Indentation for table-of-contents display.
1724 Also used for formatting insertion, when numbering is disabled."
1727 (defcustom rst-toc-insert-style
'fixed
1728 "Insertion style for table-of-contents.
1729 Set this to one of the following values to determine numbering and
1731 - plain: no numbering (fixed indentation)
1732 - fixed: numbering, but fixed indentation
1733 - aligned: numbering, titles aligned under each other
1734 - listed: numbering, with dashes like list items (EXPERIMENTAL)"
1737 (defcustom rst-toc-insert-number-separator
" "
1738 "Separator that goes between the TOC number and the title."
1741 ;; This is used to avoid having to change the user's mode.
1742 (defvar rst-toc-insert-click-keymap
1743 (let ((map (make-sparse-keymap)))
1744 (define-key map
[mouse-1
] 'rst-toc-mode-mouse-goto
)
1746 "(Internal) What happens when you click on propertized text in the TOC.")
1748 (defcustom rst-toc-insert-max-level nil
1749 "If non-nil, maximum depth of the inserted TOC."
1753 (defun rst-toc-insert (&optional pfxarg
)
1754 "Insert a simple text rendering of the table of contents.
1755 By default the top level is ignored if there is only one, because
1756 we assume that the document will have a single title.
1758 If a numeric prefix argument PFXARG is given, insert the TOC up
1759 to the specified level.
1761 The TOC is inserted indented at the current column."
1765 (let* (;; Check maximum level override
1766 (rst-toc-insert-max-level
1767 (if (and (integerp pfxarg
) (> (prefix-numeric-value pfxarg
) 0))
1768 (prefix-numeric-value pfxarg
) rst-toc-insert-max-level
))
1770 ;; Get the section tree for the current cursor point.
1772 (rst-section-tree-point
1773 (rst-section-tree (rst-find-all-decorations))))
1775 ;; Figure out initial indent.
1776 (initial-indent (make-string (current-column) ?
))
1777 (init-point (point)))
1779 (when (cddr sectree-pair
)
1780 (rst-toc-insert-node (cdr sectree-pair
) 0 initial-indent
"")
1782 ;; Fixup for the first line.
1783 (delete-region init-point
(+ init-point
(length initial-indent
)))
1785 ;; Delete the last newline added.
1786 (delete-backward-char 1)
1789 (defun rst-toc-insert-node (node level indent pfx
)
1790 "Insert tree node NODE in table-of-contents.
1791 Recursive function that does printing of the inserted toc.
1792 LEVEL is the depth level of the sections in the tree.
1793 INDENT is the indentation string. PFX is the prefix numbering,
1794 that includes the alignment necessary for all the children of
1797 ;; Note: we do child numbering from the parent, so we start number the
1798 ;; children one level before we print them.
1799 (let ((do-print (> level
0))
1804 (unless (equal rst-toc-insert-style
'plain
)
1805 (insert pfx rst-toc-insert-number-separator
))
1806 (insert (or (caar node
) "[missing node]"))
1807 ;; Add properties to the text, even though in normal text mode it
1808 ;; won't be doing anything for now. Not sure that I want to change
1809 ;; mode stuff. At least the highlighting gives the idea that this
1810 ;; is generated automatically.
1811 (put-text-property b
(point) 'mouse-face
'highlight
)
1812 (put-text-property b
(point) 'rst-toc-target
(cadar node
))
1813 (put-text-property b
(point) 'keymap rst-toc-insert-click-keymap
)
1818 ;; Prepare indent for children.
1821 ((eq rst-toc-insert-style
'plain
)
1822 (concat indent
(make-string rst-toc-indent ?
)))
1824 ((eq rst-toc-insert-style
'fixed
)
1825 (concat indent
(make-string rst-toc-indent ?
)))
1827 ((eq rst-toc-insert-style
'aligned
)
1828 (concat indent
(make-string (+ (length pfx
) 2) ?
)))
1830 ((eq rst-toc-insert-style
'listed
)
1831 (concat (substring indent
0 -
3)
1832 (concat (make-string (+ (length pfx
) 2) ?
) " - ")))
1836 (if (or (eq rst-toc-insert-max-level nil
)
1837 (< level rst-toc-insert-max-level
))
1838 (let ((do-child-numbering (>= level
0))
1840 (if do-child-numbering
1842 ;; Add a separating dot if there is already a prefix
1843 (if (> (length pfx
) 0)
1844 (setq pfx
(concat (rst-rstrip pfx
) ".")))
1846 ;; Calculate the amount of space that the prefix will require
1849 (setq fmt
(format "%%-%dd"
1850 (1+ (floor (log10 (length
1854 (dolist (child (cdr node
))
1855 (rst-toc-insert-node child
1858 (if do-child-numbering
1859 (concat pfx
(format fmt count
)) pfx
))
1865 (defun rst-toc-insert-find-delete-contents ()
1866 "Find and delete an existing comment after the first contents directive.
1867 Delete that region. Return t if found and the cursor is left after the comment."
1868 (goto-char (point-min))
1869 ;; We look for the following and the following only (in other words, if your
1870 ;; syntax differs, this won't work. If you would like a more flexible thing,
1871 ;; contact the author, I just can't imagine that this requirement is
1872 ;; unreasonable for now).
1874 ;; .. contents:: [...anything here...]
1881 (re-search-forward "^\\.\\. contents[ \t]*::\\(.*\\)\n\\.\\."
1885 ;; Look for the first line that starts at the first column.
1889 (< (point) (point-max))
1890 (or (and (looking-at "[ \t]+[^ \t]") (setq last-real
(point)) t
)
1891 (looking-at "[ \t]*$")))
1896 (goto-char last-real
)
1898 (delete-region beg
(point)))
1903 (defun rst-toc-update ()
1904 "Automatically find the contents section of a document and update.
1905 Updates the inserted TOC if present. You can use this in your
1906 file-write hook to always make it up-to-date automatically."
1910 (when (rst-toc-insert-find-delete-contents)
1914 ;; Somehow save-excursion does not really work well.
1916 ;; Note: always return nil, because this may be used as a hook.
1919 ;; Note: we cannot bind the TOC update on file write because it messes with
1920 ;; undo. If we disable undo, since it adds and removes characters, the
1921 ;; positions in the undo list are not making sense anymore. Dunno what to do
1922 ;; with this, it would be nice to update when saving.
1924 ;; (add-hook 'write-contents-hooks 'rst-toc-update-fun)
1925 ;; (defun rst-toc-update-fun ()
1926 ;; ;; Disable undo for the write file hook.
1927 ;; (let ((buffer-undo-list t)) (rst-toc-update) ))
1929 (defalias 'rst-toc-insert-update
'rst-toc-update
) ;; backwards compat.
1931 ;;------------------------------------------------------------------------------
1933 (defun rst-toc-node (node level
)
1934 "Recursive function that does insert NODE at LEVEL in the table-of-contents."
1938 ;; Insert line text.
1939 (insert (make-string (* rst-toc-indent
(1- level
)) ?
))
1940 (insert (or (caar node
) "[missing node]"))
1943 (put-text-property b
(point) 'mouse-face
'highlight
)
1945 ;; Add link on lines.
1946 (put-text-property b
(point) 'rst-toc-target
(cadar node
))
1951 (dolist (child (cdr node
))
1952 (rst-toc-node child
(1+ level
))))
1954 (defun rst-toc-count-lines (node target-node
)
1955 "Count the number of lines from NODE to the TARGET-NODE node.
1956 This recursive function returns a cons of the number of
1957 additional lines that have been counted for its node and
1958 children, and t if the node has been found."
1962 (if (eq node target-node
)
1964 (let ((child (cdr node
)))
1965 (while (and child
(not found
))
1966 (let ((cl (rst-toc-count-lines (car child
) target-node
)))
1967 (setq count
(+ count
(car cl
))
1969 child
(cdr child
))))))
1970 (cons count found
)))
1972 (defvar rst-toc-buffer-name
"*Table of Contents*"
1973 "Name of the Table of Contents buffer.")
1975 (defvar rst-toc-return-buffer nil
1976 "Buffer to which to return when leaving the TOC.")
1980 "Display a table-of-contents.
1981 Finds all the section titles and their decorations in the
1982 file, and displays a hierarchically-organized list of the
1983 titles, which is essentially a table-of-contents of the
1986 The Emacs buffer can be navigated, and selecting a section
1987 brings the cursor in that section."
1989 (let* ((curbuf (current-buffer))
1991 ;; Get the section tree
1992 (alldecos (rst-find-all-decorations))
1993 (sectree (rst-section-tree alldecos
))
1995 (our-node (cdr (rst-section-tree-point sectree
)))
1998 ;; Create a temporary buffer.
1999 (buf (get-buffer-create rst-toc-buffer-name
))
2002 (with-current-buffer buf
2003 (let ((inhibit-read-only t
))
2005 (delete-region (point-min) (point-max))
2006 (insert (format "Table of Contents: %s\n" (or (caar sectree
) "")))
2007 (put-text-property (point-min) (point)
2008 'face
(list '(background-color .
"gray")))
2009 (rst-toc-node sectree
0)
2011 ;; Count the lines to our found node.
2012 (let ((linefound (rst-toc-count-lines sectree our-node
)))
2013 (setq line
(if (cdr linefound
) (car linefound
) 0)))
2015 (display-buffer buf
)
2018 ;; Save the buffer to return to.
2019 (set (make-local-variable 'rst-toc-return-buffer
) curbuf
)
2021 ;; Move the cursor near the right section in the TOC.
2026 (defun rst-toc-mode-find-section ()
2027 "Get the section from text property at point."
2028 (let ((pos (get-text-property (point) 'rst-toc-target
)))
2030 (error "No section on this line"))
2031 (unless (buffer-live-p (marker-buffer pos
))
2032 (error "Buffer for this section was killed"))
2035 (defun rst-goto-section (&optional kill
)
2036 "Go to the section the current line describes."
2038 (let ((pos (rst-toc-mode-find-section)))
2040 (kill-buffer (get-buffer rst-toc-buffer-name
)))
2041 (pop-to-buffer (marker-buffer pos
))
2043 ;; FIXME: make the recentering conditional on scroll.
2046 (defun rst-toc-mode-goto-section ()
2047 "Go to the section the current line describes and kill the TOC buffer."
2049 (rst-goto-section t
))
2051 (defun rst-toc-mode-mouse-goto (event)
2052 "In `rst-toc' mode, go to the occurrence whose line you click on.
2053 EVENT is the input event."
2056 (with-current-buffer (window-buffer (posn-window (event-end event
)))
2058 (goto-char (posn-point (event-end event
)))
2059 (setq pos
(rst-toc-mode-find-section))))
2060 (pop-to-buffer (marker-buffer pos
))
2064 (defun rst-toc-mode-mouse-goto-kill (event)
2065 "Same as `rst-toc-mode-mouse-goto', but kill TOC buffer as well."
2067 (call-interactively 'rst-toc-mode-mouse-goto event
)
2068 (kill-buffer (get-buffer rst-toc-buffer-name
)))
2070 (defun rst-toc-quit-window ()
2071 "Leave the current TOC buffer."
2074 (pop-to-buffer rst-toc-return-buffer
))
2076 (defvar rst-toc-mode-map
2077 (let ((map (make-sparse-keymap)))
2078 (define-key map
[mouse-1
] 'rst-toc-mode-mouse-goto-kill
)
2079 (define-key map
[mouse-2
] 'rst-toc-mode-mouse-goto
)
2080 (define-key map
"\C-m" 'rst-toc-mode-goto-section
)
2081 (define-key map
"f" 'rst-toc-mode-goto-section
)
2082 (define-key map
"q" 'rst-toc-quit-window
)
2083 (define-key map
"z" 'kill-this-buffer
)
2085 "Keymap for `rst-toc-mode'.")
2087 (put 'rst-toc-mode
'mode-class
'special
)
2089 ;; Could inherit from the new `special-mode'.
2090 (define-derived-mode rst-toc-mode nil
"ReST-TOC"
2091 "Major mode for output from \\[rst-toc], the table-of-contents for the document."
2092 (setq buffer-read-only t
))
2094 ;; Note: use occur-mode (replace.el) as a good example to complete missing
2098 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2100 ;; Section movement commands.
2103 (defun rst-forward-section (&optional offset
)
2104 "Skip to the next restructured text section title.
2105 OFFSET specifies how many titles to skip. Use a negative OFFSET to move
2106 backwards in the file (default is to use 1)."
2108 (let* (;; Default value for offset.
2109 (offset (or offset
1))
2111 ;; Get all the decorations in the file, with their line numbers.
2112 (alldecos (rst-find-all-decorations))
2114 ;; Get the current line.
2115 (curline (line-number-at-pos))
2121 ;; Find the index of the "next" decoration w.r.t. to the current line.
2122 (while (and cur
(< (caar cur
) curline
))
2123 (setq cur
(cdr cur
))
2125 ;; 'cur' is the decoration on or following the current line.
2127 (if (and (> offset
0) cur
(= (caar cur
) curline
))
2130 ;; Find the final index.
2131 (setq idx
(+ idx
(if (> offset
0) (- offset
1) offset
)))
2132 (setq cur
(nth idx alldecos
))
2134 ;; If the index is positive, goto the line, otherwise go to the buffer
2136 (if (and cur
(>= idx
0))
2137 (goto-line (car cur
))
2138 (if (> offset
0) (goto-char (point-max)) (goto-char (point-min))))
2141 (defun rst-backward-section ()
2142 "Like `rst-forward-section', except move back one title."
2144 (rst-forward-section -
1))
2146 (defun rst-mark-section (&optional arg allow-extend
)
2147 "Select the section that point is currently in."
2148 ;; Cloned from mark-paragraph.
2149 (interactive "p\np")
2150 (unless arg
(setq arg
1))
2152 (error "Cannot mark zero sections"))
2153 (cond ((and allow-extend
2154 (or (and (eq last-command this-command
) (mark t
))
2155 (rst-portable-mark-active-p)))
2159 (rst-forward-section arg
)
2162 (rst-forward-section arg
)
2164 (rst-forward-section (- arg
)))))
2171 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2172 ;; Functions to work on item lists (e.g. indent/dedent, enumerate), which are
2173 ;; always 2 or 3 characters apart horizontally with rest.
2175 ;; (FIXME: there is currently a bug that makes the region go away when we do that.)
2176 (defvar rst-shift-fill-region nil
2177 "If non-nil, automatically re-fill the region that is being shifted.")
2179 (defun rst-find-leftmost-column (beg end
)
2180 "Find the leftmost column in the region."
2181 (let ((mincol 1000))
2184 (while (< (point) end
)
2185 (back-to-indentation)
2186 (unless (looking-at "[ \t]*$")
2187 (setq mincol
(min mincol
(current-column))))
2193 ;; What we really need to do is compute all the possible alignment possibilities
2194 ;; and then select one.
2208 ;; Move backwards, accumulate the beginning positions, and also the second
2209 ;; positions, in case the line matches the bullet pattern, and then sort.
2211 (defun rst-compute-bullet-tabs (&optional pt
)
2212 "Build the list of possible horizontal alignment points.
2213 Search backwards from point (or point PT if specified) to
2214 build the list of possible horizontal alignment points that
2215 includes the beginning and contents of a restructuredtext
2216 bulleted or enumerated list item. Return a sorted list
2217 of (COLUMN-NUMBER . LINE) pairs."
2219 (when pt
(goto-char pt
))
2221 ;; We work our way backwards and towards the left.
2222 (let ((leftcol 100000) ;; Current column.
2223 (tablist nil
) ;; List of tab positions.
2226 ;; Start by skipping the current line.
2227 (beginning-of-line 0)
2229 ;; Search backwards for each line.
2230 (while (and (> (point) (point-min))
2233 ;; Skip empty lines.
2234 (unless (looking-at "^[ \t]*$")
2235 ;; Inspect the current non-empty line
2236 (back-to-indentation)
2238 ;; Skip lines that are beyond the current column (we want to move
2239 ;; towards the left).
2240 (let ((col (current-column)))
2241 (when (< col leftcol
)
2243 ;; Add the beginning of the line as a tabbing point.
2244 (unless (memq col
(mapcar 'car tablist
))
2245 (push (cons col
(point)) tablist
))
2247 ;; Look at the line to figure out if it is a bulleted or enumerate
2252 "\\(\\(?:[0-9a-zA-Z#]\\{1,3\\}[.):-]\\|[*+-]\\)[ \t]+\\)[^ \t\n]"
2254 (format "\\(%s%s+[ \t]+\\)[^ \t\n]"
2255 (regexp-quote (thing-at-point 'char
))
2256 (regexp-quote (thing-at-point 'char
)))
2259 ;; Add the column of the contained item.
2260 (let* ((matchlen (length (or (match-string 1) (match-string 2))))
2261 (newcol (+ col matchlen
)))
2262 (unless (or (>= newcol leftcol
)
2263 (memq (+ col matchlen
) (mapcar 'car tablist
)))
2264 (push (cons (+ col matchlen
) (+ (point) matchlen
))
2271 ;; Move backwards one line.
2272 (beginning-of-line 0))
2274 (sort tablist
(lambda (x y
) (<= (car x
) (car y
))))
2277 (defun rst-debug-print-tabs (tablist)
2278 "Insert a line and place special characters at the tab points in TABLIST."
2280 (insert (concat "\n" (make-string 1000 ?
) "\n"))
2281 (beginning-of-line 0)
2282 (dolist (col tablist
)
2284 (forward-char (car col
))
2289 (defun rst-debug-mark-found (tablist)
2290 "Insert a line and place special characters at the tab points in TABLIST."
2291 (dolist (col tablist
)
2293 (goto-char (cdr col
))
2297 (defvar rst-shift-basic-offset
2
2298 "Basic horizontal shift distance when there is no preceding alignment tabs.")
2300 (defun rst-shift-region-guts (find-next-fun offset-fun
)
2301 "(See `rst-shift-region-right' for a description)."
2302 (let* ((mbeg (set-marker (make-marker) (region-beginning)))
2303 (mend (set-marker (make-marker) (region-end)))
2304 (tabs (rst-compute-bullet-tabs mbeg
))
2305 (leftmostcol (rst-find-leftmost-column (region-beginning) (region-end)))
2307 ;; Add basic offset tabs at the end of the list. This is a better
2308 ;; implementation technique than hysteresis and a basic offset because it
2309 ;; insures that movement in both directions is consistently using the same
2310 ;; column positions. This makes it more predictable.
2313 (mapcar (lambda (x) (cons x nil
))
2315 (max-lisp-eval-depth 2000))
2320 (+ x rst-shift-basic-offset
))))))
2321 (addnum (or (caar (last tabs
)) 0))))
2325 ;;; (save-excursion (goto-char mbeg) (forward-char -1) (rst-debug-print-tabs tabs))))
2327 ;;; (save-excursion (rst-debug-mark-found tabs))
2329 ;; Apply the indent.
2333 ;; Find the next tab after the leftmost columnt.
2334 (let ((tab (funcall find-next-fun tabs leftmostcol
)))
2339 (message "Aligned on '%s'"
2341 (goto-char (cdar tab
))
2342 (buffer-substring-no-properties
2343 (line-beginning-position)
2344 (line-end-position))))
2346 (- (caar tab
) leftmostcol
)) ;; Num chars.
2348 ;; Otherwise use the basic offset
2349 (funcall offset-fun rst-shift-basic-offset
)
2352 ;; Optionally reindent.
2353 (when rst-shift-fill-region
2354 (fill-region mbeg mend
))
2357 (defun rst-shift-region-right (pfxarg)
2358 "Indent region ridigly, by a few characters to the right.
2359 This function first computes all possible alignment columns by
2360 inspecting the lines preceding the region for bulleted or
2361 enumerated list items. If the leftmost column is beyond the
2362 preceding lines, the region is moved to the right by
2363 `rst-shift-basic-offset'. With a prefix argument, do not
2364 automatically fill the region."
2366 (let ((rst-shift-fill-region
2367 (if (not pfxarg
) rst-shift-fill-region
)))
2368 (rst-shift-region-guts (lambda (tabs leftmostcol
)
2370 (while (and cur
(<= (caar cur
) leftmostcol
))
2371 (setq cur
(cdr cur
)))
2376 (defun rst-shift-region-left (pfxarg)
2377 "Like `rst-shift-region-right', except we move to the left.
2378 Also, if invoked with a negative prefix arg, the entire
2379 indentation is removed, up to the leftmost character in the
2380 region, and automatic filling is disabled."
2382 (let ((mbeg (set-marker (make-marker) (region-beginning)))
2383 (mend (set-marker (make-marker) (region-end)))
2384 (leftmostcol (rst-find-leftmost-column
2385 (region-beginning) (region-end)))
2386 (rst-shift-fill-region
2387 (if (not pfxarg
) rst-shift-fill-region
)))
2389 (when (> leftmostcol
0)
2390 (if (and pfxarg
(< (prefix-numeric-value pfxarg
) 0))
2392 (indent-rigidly (region-beginning) (region-end) (- leftmostcol
))
2393 (when rst-shift-fill-region
2394 (fill-region mbeg mend
))
2396 (rst-shift-region-guts (lambda (tabs leftmostcol
)
2397 (let ((cur (reverse tabs
)))
2398 (while (and cur
(>= (caar cur
) leftmostcol
))
2399 (setq cur
(cdr cur
)))
2405 (defmacro rst-iterate-leftmost-paragraphs
2406 (beg end first-only body-consequent body-alternative
)
2407 "FIXME This definition is old and deprecated / we need to move
2408 to the newer version below:
2410 Call FUN at the beginning of each line, with an argument that
2411 specifies whether we are at the first line of a paragraph that
2412 starts at the leftmost column of the given region BEG and END.
2413 Set FIRST-ONLY to true if you want to callback on the first line
2414 of each paragraph only."
2416 (let ((leftcol (rst-find-leftmost-column ,beg
,end
))
2417 (endm (set-marker (make-marker) ,end
))
2420 (do* (;; Iterate lines
2421 (l (progn (goto-char ,beg
) (back-to-indentation))
2422 (progn (forward-line 1) (back-to-indentation)))
2424 (previous nil valid
)
2426 (curcol (current-column)
2429 (valid (and (= curcol leftcol
)
2430 (not (looking-at "[ \t]*$")))
2431 (and (= curcol leftcol
)
2432 (not (looking-at "[ \t]*$"))))
2437 (and valid
(not previous
))
2445 (defmacro rst-iterate-leftmost-paragraphs-2
(spec &rest body
)
2446 "Evaluate BODY for each line in region defined by BEG END.
2447 LEFTMOST is set to true if the line is one of the leftmost of the
2448 entire paragraph. PARABEGIN is set to true if the line is the
2449 first of a paragraph."
2450 (declare (indent 1) (debug (sexp body
)))
2452 (beg end parabegin leftmost isleftmost isempty
) spec
2455 (let ((,leftmost
(rst-find-leftmost-column ,beg
,end
))
2456 (endm (set-marker (make-marker) ,end
))
2459 (do* (;; Iterate lines
2460 (l (progn (goto-char ,beg
) (back-to-indentation))
2461 (progn (forward-line 1) (back-to-indentation)))
2463 (empty-line-previous nil
,isempty
)
2465 (,isempty
(looking-at "[ \t]*$")
2466 (looking-at "[ \t]*$"))
2468 (,parabegin
(not ,isempty
)
2469 (and empty-line-previous
2472 (,isleftmost
(and (not ,isempty
)
2473 (= (current-column) ,leftmost
))
2475 (= (current-column) ,leftmost
)))
2484 ;;------------------------------------------------------------------------------
2486 ;; FIXME: these next functions should become part of a larger effort to redo the
2487 ;; bullets in bulletted lists. The enumerate would just be one of the possible
2490 ;; FIXME: TODO we need to do the enumeration removal as well.
2492 (defun rst-enumerate-region (beg end
)
2493 "Add enumeration to all the leftmost paragraphs in the given region.
2494 The region is specified between BEG and END. With prefix argument,
2495 do all lines instead of just paragraphs."
2498 (last-insert-len nil
))
2499 (rst-iterate-leftmost-paragraphs
2500 beg end
(not current-prefix-arg
)
2501 (let ((ins-string (format "%d. " (incf count
))))
2502 (setq last-insert-len
(length ins-string
))
2503 (insert ins-string
))
2504 (insert (make-string last-insert-len ?\
))
2507 (defun rst-bullet-list-region (beg end
)
2508 "Add bullets to all the leftmost paragraphs in the given region.
2509 The region is specified between BEG and END. With prefix argument,
2510 do all lines instead of just paragraphs."
2512 (rst-iterate-leftmost-paragraphs
2513 beg end
(not current-prefix-arg
)
2519 ;; FIXME: there are some problems left with the following function
2522 ;; * It does not deal with a varying number of digits appropriately
2523 ;; * It does not deal with multiple levels independently, and it should.
2525 ;; I suppose it does 90% of the job for now.
2527 (defun rst-convert-bullets-to-enumeration (beg end
)
2528 "Convert all the bulleted items and enumerated items in the
2529 region to enumerated lists, renumbering as necessary."
2531 (let* (;; Find items and convert the positions to markers.
2534 (cons (let ((m (make-marker)))
2535 (set-marker m
(car x
))
2538 (rst-find-pfx-in-region beg end rst-re-items
)))
2544 (looking-at rst-re-items
)
2545 (replace-match (format "%d. " count
) nil nil nil
1)
2552 ;;------------------------------------------------------------------------------
2554 (defun rst-line-block-region (rbeg rend
&optional pfxarg
)
2555 "Toggle line block prefixes for a region.
2556 With prefix argument set the empty lines too."
2557 (interactive "r\nP")
2558 (let ((comment-start "| ")
2560 (comment-start-skip "| ")
2561 (comment-style 'indent
)
2562 (force (not (not pfxarg
))))
2563 (rst-iterate-leftmost-paragraphs-2
2564 (rbeg rend parbegin leftmost isleft isempty
)
2565 (when (or force
(not isempty
))
2566 (move-to-column leftmost force
)
2567 (delete-region (point) (+ (point) (- (current-indentation) leftmost
)))
2572 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2574 (require 'font-lock
)
2576 (defgroup rst-faces nil
"Faces used in Rst Mode."
2581 (defcustom rst-block-face
'font-lock-keyword-face
2582 "All syntax marking up a special block."
2586 (defcustom rst-external-face
'font-lock-type-face
2587 "Field names and interpreted text."
2591 (defcustom rst-definition-face
'font-lock-function-name-face
2592 "All other defining constructs."
2596 (defcustom rst-directive-face
2597 ;; XEmacs compatibility
2598 (if (boundp 'font-lock-builtin-face
)
2599 'font-lock-builtin-face
2600 'font-lock-preprocessor-face
)
2601 "Directives and roles."
2605 (defcustom rst-comment-face
'font-lock-comment-face
2610 (defcustom rst-emphasis1-face
2611 ;; XEmacs compatibility
2619 (defcustom rst-emphasis2-face
2620 ;; XEmacs compatibility
2628 (defcustom rst-literal-face
'font-lock-string-face
2633 (defcustom rst-reference-face
'font-lock-variable-name-face
2634 "References to a definition."
2638 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2640 (defgroup rst-faces-defaults nil
2641 "Values used to generate default faces for section titles on all levels.
2642 Tweak these if you are content with how section title faces are built in
2643 general but you do not like the details."
2647 (defun rst-set-level-default (sym val
)
2648 "Set custom var SYM affecting section title text face and recompute the faces."
2649 (custom-set-default sym val
)
2650 ;; Also defines the faces initially when all values are available
2651 (and (boundp 'rst-level-face-max
)
2652 (boundp 'rst-level-face-format-light
)
2653 (boundp 'rst-level-face-base-color
)
2654 (boundp 'rst-level-face-step-light
)
2655 (boundp 'rst-level-face-base-light
)
2656 (fboundp 'rst-define-level-faces
)
2657 (rst-define-level-faces)))
2659 ;; Faces for displaying items on several levels; these definitions define
2660 ;; different shades of grey where the lightest one (i.e. least contrasting) is
2662 (defcustom rst-level-face-max
6
2663 "Maximum depth of levels for which section title faces are defined."
2664 :group
'rst-faces-defaults
2666 :set
'rst-set-level-default
)
2667 (defcustom rst-level-face-base-color
"grey"
2668 "The base name of the color to be used for creating background colors in
2669 section title faces for all levels."
2670 :group
'rst-faces-defaults
2672 :set
'rst-set-level-default
)
2673 (defcustom rst-level-face-base-light
2674 (if (eq frame-background-mode
'dark
)
2677 "The lightness factor for the base color. This value is used for level 1.
2678 The default depends on whether the value of `frame-background-mode' is
2680 :group
'rst-faces-defaults
2682 :set
'rst-set-level-default
)
2683 (defcustom rst-level-face-format-light
"%2d"
2684 "The format for the lightness factor appended to the base name of the color.
2685 This value is expanded by `format' with an integer."
2686 :group
'rst-faces-defaults
2688 :set
'rst-set-level-default
)
2689 (defcustom rst-level-face-step-light
2690 (if (eq frame-background-mode
'dark
)
2693 "The step width to use for the next color.
2696 `rst-level-face-base-light'
2697 + (`rst-level-face-max' - 1) * `rst-level-face-step-light'
2699 must result in a color level which appended to `rst-level-face-base-color'
2700 using `rst-level-face-format-light' results in a valid color such as `grey50'.
2701 This color is used as background for section title text on level
2702 `rst-level-face-max'."
2703 :group
'rst-faces-defaults
2705 :set
'rst-set-level-default
)
2707 (defcustom rst-adornment-faces-alist
2708 (let ((alist '((t . font-lock-keyword-face
)
2709 (nil . font-lock-keyword-face
)))
2711 (while (<= i rst-level-face-max
)
2712 (nconc alist
(list (cons i
(intern (format "rst-level-%d-face" i
)))))
2715 "Faces for the various adornment types.
2716 Key is a number (for the section title text of that level),
2717 t (for transitions) or nil (for section title adornment).
2718 If you generally do not like how section title text faces are
2719 set up tweak here. If the general idea is ok for you but you do not like the
2720 details check the Rst Faces Defaults group."
2727 "Section level (may not be bigger than `rst-level-face-max')")
2728 (boolean :tag
"transitions (on) / section title adornment (off)"))
2730 :set-after
'(rst-level-face-max))
2732 (defun rst-define-level-faces ()
2733 "Define the faces for the section title text faces from the values."
2734 ;; All variables used here must be checked in `rst-set-level-default'
2736 (while (<= i rst-level-face-max
)
2737 (let ((sym (intern (format "rst-level-%d-face" i
)))
2738 (doc (format "Face for showing section title text at level %d" i
))
2739 (col (format (concat "%s" rst-level-face-format-light
)
2740 rst-level-face-base-color
2741 (+ (* (1- i
) rst-level-face-step-light
)
2742 rst-level-face-base-light
))))
2743 (make-empty-face sym
)
2744 (set-face-doc-string sym doc
)
2745 (set-face-background sym col
)
2749 (rst-define-level-faces)
2752 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2755 (defvar rst-use-char-classes
2756 (string-match "[[:alpha:]]" "b")
2757 "Non-nil if we can use the character classes in our regexps.")
2759 (defun rst-font-lock-keywords-function ()
2760 "Return keywords to highlight in Rst mode according to current settings."
2761 ;; The reST-links in the comments below all relate to sections in
2762 ;; http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html
2763 (let* ( ;; This gets big - so let's define some abbreviations
2764 ;; horizontal white space
2766 ;; beginning of line with possible indentation
2767 (re-bol (concat "^" re-hws
"*"))
2768 ;; Separates block lead-ins from their content
2769 (re-blksep1 (concat "\\(" re-hws
"+\\|$\\)"))
2770 ;; explicit markup tag
2772 ;; explicit markup start
2773 (re-ems (concat re-emt re-hws
"+"))
2774 ;; inline markup prefix
2775 (re-imp1 (concat "\\(^\\|" re-hws
"\\|[-'\"([{</:]\\)"))
2776 ;; inline markup suffix
2777 (re-ims1 (concat "\\(" re-hws
"\\|[]-'\")}>/:.,;!?\\]\\|$\\)"))
2779 (re-sym1 "\\(\\sw\\|\\s_\\)")
2780 ;; inline markup content begin
2781 (re-imbeg2 "\\(\\S \\|\\S \\([^")
2783 ;; There seems to be a bug leading to error "Stack overflow in regexp
2784 ;; matcher" when "|" or "\\*" are the characters searched for
2786 (if (< emacs-major-version
21)
2789 ;; inline markup content end
2790 (re-imend (concat re-imendbeg
"\\)*[^\t \\\\]\\)"))
2791 ;; inline markup content without asterisk
2792 (re-ima2 (concat re-imbeg2
"*" re-imend
))
2793 ;; inline markup content without backquote
2794 (re-imb2 (concat re-imbeg2
"`" re-imend
))
2795 ;; inline markup content without vertical bar
2796 (re-imv2 (concat re-imbeg2
"|" re-imend
))
2797 ;; Supported URI schemes
2798 (re-uris1 "\\(acap\\|cid\\|data\\|dav\\|fax\\|file\\|ftp\\|gopher\\|http\\|https\\|imap\\|ldap\\|mailto\\|mid\\|modem\\|news\\|nfs\\|nntp\\|pop\\|prospero\\|rtsp\\|service\\|sip\\|tel\\|telnet\\|tip\\|urn\\|vemmi\\|wais\\)")
2799 ;; Line starting with adornment and optional whitespace; complete
2800 ;; adornment is in (match-string 1); there must be at least 3
2801 ;; characters because otherwise explicit markup start would be
2803 (re-ado2 (concat "^\\(\\(["
2804 (if rst-use-char-classes
2805 "^[:word:][:space:][:cntrl:]" "^\\w \t\x00-\x1F")
2806 "]\\)\\2\\2+\\)" re-hws
"*$"))
2809 ;; FIXME: Block markup is not recognized in blocks after explicit markup
2812 ;; Simple `Body Elements`_
2815 (concat re-bol
"\\([-*+]" re-blksep1
"\\)")
2817 ;; `Enumerated Lists`_
2819 (concat re-bol
"\\((?\\(#\\|[0-9]+\\|[A-Za-z]\\|[IVXLCMivxlcm]+\\)[.)]"
2822 ;; `Definition Lists`_ FIXME: missing
2825 (concat re-bol
"\\(:[^:\n]+:\\)" re-blksep1
)
2826 1 rst-external-face
)
2829 (concat re-bol
"\\(\\(\\(\\([-+/]\\|--\\)\\sw\\(-\\|\\sw\\)*"
2830 "\\([ =]\\S +\\)?\\)\\(,[\t ]\\)?\\)+\\)\\($\\|[\t ]\\{2\\}\\)")
2833 ;; `Tables`_ FIXME: missing
2835 ;; All the `Explicit Markup Blocks`_
2836 ;; `Footnotes`_ / `Citations`_
2838 (concat re-bol
"\\(" re-ems
"\\[[^[\n]+\\]\\)" re-blksep1
)
2839 1 rst-definition-face
)
2840 ;; `Directives`_ / `Substitution Definitions`_
2842 (concat re-bol
"\\(" re-ems
"\\)\\(\\(|[^|\n]+|[\t ]+\\)?\\)\\("
2843 re-sym1
"+::\\)" re-blksep1
)
2844 (list 1 rst-directive-face
)
2845 (list 2 rst-definition-face
)
2846 (list 4 rst-directive-face
))
2847 ;; `Hyperlink Targets`_
2849 (concat re-bol
"\\(" re-ems
"_\\([^:\\`\n]\\|\\\\.\\|`[^`\n]+`\\)+:\\)"
2851 1 rst-definition-face
)
2853 (concat re-bol
"\\(__\\)" re-blksep1
)
2854 1 rst-definition-face
)
2856 ;; All `Inline Markup`_
2857 ;; FIXME: Condition 5 preventing fontification of e.g. "*" not implemented
2858 ;; `Strong Emphasis`_
2860 (concat re-imp1
"\\(\\*\\*" re-ima2
"\\*\\*\\)" re-ims1
)
2861 2 rst-emphasis2-face
)
2864 (concat re-imp1
"\\(\\*" re-ima2
"\\*\\)" re-ims1
)
2865 2 rst-emphasis1-face
)
2866 ;; `Inline Literals`_
2868 (concat re-imp1
"\\(``" re-imb2
"``\\)" re-ims1
)
2870 ;; `Inline Internal Targets`_
2872 (concat re-imp1
"\\(_`" re-imb2
"`\\)" re-ims1
)
2873 2 rst-definition-face
)
2874 ;; `Hyperlink References`_
2875 ;; FIXME: `Embedded URIs`_ not considered
2877 (concat re-imp1
"\\(\\(`" re-imb2
"`\\|\\(\\sw\\(\\sw\\|-\\)+\\sw\\)\\)__?\\)" re-ims1
)
2878 2 rst-reference-face
)
2879 ;; `Interpreted Text`_
2881 (concat re-imp1
"\\(\\(:" re-sym1
"+:\\)?\\)\\(`" re-imb2
"`\\)\\(\\(:"
2882 re-sym1
"+:\\)?\\)" re-ims1
)
2883 (list 2 rst-directive-face
)
2884 (list 5 rst-external-face
)
2885 (list 8 rst-directive-face
))
2886 ;; `Footnote References`_ / `Citation References`_
2888 (concat re-imp1
"\\(\\[[^]]+\\]_\\)" re-ims1
)
2889 2 rst-reference-face
)
2890 ;; `Substitution References`_
2892 (concat re-imp1
"\\(|" re-imv2
"|\\)" re-ims1
)
2893 2 rst-reference-face
)
2894 ;; `Standalone Hyperlinks`_
2896 ;; FIXME: This takes it easy by using a whitespace as delimiter
2897 (concat re-imp1
"\\(" re-uris1
":\\S +\\)" re-ims1
)
2898 2 rst-definition-face
)
2900 (concat re-imp1
"\\(" re-sym1
"+@" re-sym1
"+\\)" re-ims1
)
2901 2 rst-definition-face
)
2903 ;; Do all block fontification as late as possible so 'append works
2905 ;; Sections_ / Transitions_
2909 (if (not rst-mode-lazy
)
2910 (list 1 rst-block-face
)
2912 (list 'rst-font-lock-handle-adornment
2914 (setq rst-font-lock-adornment-point
(match-end 1))
2917 (list 1 '(cdr (assoc nil rst-adornment-faces-alist
))
2919 (list 2 '(cdr (assoc rst-font-lock-level
2920 rst-adornment-faces-alist
))
2922 (list 3 '(cdr (assoc nil rst-adornment-faces-alist
))
2928 (concat re-bol
"\\(" re-ems
"\\)\[^[|_]\\([^:\n]\\|:\\([^:\n]\\|$\\)\\)*$")
2930 (list 1 rst-comment-face
))
2933 (list 'rst-font-lock-find-unindented-line
2935 (setq rst-font-lock-indentation-point
(match-end 1))
2938 (list 0 rst-comment-face
'append
)))))
2941 (concat re-bol
"\\(" re-emt
"\\)\\(\\s *\\)$")
2942 (list 1 rst-comment-face
)
2943 (list 2 rst-comment-face
))
2946 (list 'rst-font-lock-find-unindented-line
2948 (setq rst-font-lock-indentation-point
'next
)
2951 (list 0 rst-comment-face
'append
)))))
2953 ;; `Literal Blocks`_
2956 (concat re-bol
"\\(\\([^.\n]\\|\\.[^.\n]\\).*\\)?\\(::\\)$")
2957 (list 3 rst-block-face
))
2960 (list 'rst-font-lock-find-unindented-line
2962 (setq rst-font-lock-indentation-point t
)
2965 (list 0 rst-literal-face
'append
)))))
2967 ;; `Doctest Blocks`_
2970 (concat re-bol
"\\(>>>\\|\\.\\.\\.\\)\\(.+\\)")
2971 (list 1 rst-block-face
)
2972 (list 2 rst-literal-face
)))
2977 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2980 (defun rst-forward-indented-block (&optional column limit
)
2981 "Move forward across one indented block.
2982 Find the next non-empty line which is not indented at least to COLUMN (defaults
2983 to the column of the point). Moves point to first character of this line or the
2984 first empty line immediately before it and returns that position. If there is
2985 no such line before LIMIT (defaults to the end of the buffer) returns nil and
2986 point is not moved."
2988 (let ((clm (or column
(current-column)))
2992 (setq limit
(point-max)))
2994 (while (and (not fnd
) (< (point) limit
))
2996 (when (< (point) limit
)
2998 (if (looking-at "\\s *$")
2999 (setq cand
(or cand beg
)) ; An empty line is a candidate
3000 (move-to-column clm
)
3001 ;; FIXME: No indentation [(zerop clm)] must be handled in some
3002 ;; useful way - though it is not clear what this should mean at all
3004 "^\\s *$" (buffer-substring-no-properties beg
(point)))
3005 (setq cand nil
) ; An indented line resets a candidate
3006 (setq fnd
(or cand beg
)))))))
3007 (goto-char (or fnd start
))
3010 ;; Stores the point where the current indentation ends if a number. If `next'
3011 ;; indicates `rst-font-lock-find-unindented-line' shall take the indentation
3012 ;; from the next line if this is not empty. If non-nil indicates
3013 ;; `rst-font-lock-find-unindented-line' shall take the indentation from the
3014 ;; next non-empty line. Also used as a trigger for
3015 ;; `rst-font-lock-find-unindented-line'.
3016 (defvar rst-font-lock-indentation-point nil
)
3018 (defun rst-font-lock-find-unindented-line (limit)
3019 (let* ((ind-pnt rst-font-lock-indentation-point
)
3021 ;; May run only once - enforce this
3022 (setq rst-font-lock-indentation-point nil
)
3023 (when (and ind-pnt
(not (numberp ind-pnt
)))
3024 ;; Find indentation point in next line if any
3028 (if (eq ind-pnt
'next
)
3029 (when (and (zerop (forward-line 1)) (< (point) limit
))
3030 (setq beg-pnt
(point))
3031 (when (not (looking-at "\\s *$"))
3032 (looking-at "\\s *")
3034 (while (and (zerop (forward-line 1)) (< (point) limit
)
3035 (looking-at "\\s *$")))
3036 (when (< (point) limit
)
3037 (setq beg-pnt
(point))
3038 (looking-at "\\s *")
3042 ;; Always succeeds because the limit set by PRE-MATCH-FORM is the
3043 ;; ultimate point to find
3044 (goto-char (or (rst-forward-indented-block nil limit
) limit
))
3046 ;; Include subsequent empty lines in the font-lock block,
3047 ;; in case the user subsequently changes the indentation of the next
3048 ;; non-empty line to move it into the indented element.
3049 (skip-chars-forward " \t\n")
3050 (put-text-property beg-pnt
(point) 'font-lock-multiline t
))
3051 (set-match-data (list beg-pnt
(point)))
3054 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3057 (defvar rst-font-lock-adornment-point nil
3058 "Stores the point where the current adornment ends.
3059 Also used as a trigger for `rst-font-lock-handle-adornment'.")
3061 ;; Here `rst-font-lock-handle-adornment' stores the section level of the
3062 ;; current adornment or t for a transition.
3063 (defvar rst-font-lock-level nil
)
3065 ;; FIXME: It would be good if this could be used to markup section titles of
3066 ;; given level with a special key; it would be even better to be able to
3067 ;; customize this so it can be used for a generally available personal style
3069 ;; FIXME: There should be some way to reset and reload this variable - probably
3072 ;; FIXME: Some support for `outline-mode' would be nice which should be based
3073 ;; on this information
3074 (defvar rst-adornment-level-alist nil
3075 "Associates adornments with section levels.
3076 The key is a two character string. The first character is the adornment
3077 character. The second character distinguishes underline section titles (`u')
3078 from overline/underline section titles (`o'). The value is the section level.
3080 This is made buffer local on start and adornments found during font lock are
3083 ;; Returns section level for adornment key KEY. Adds new section level if KEY
3084 ;; is not found and ADD. If KEY is not a string it is simply returned.
3085 (defun rst-adornment-level (key &optional add
)
3086 (let ((fnd (assoc key rst-adornment-level-alist
))
3089 ((not (stringp key
))
3094 (while (rassoc new rst-adornment-level-alist
)
3095 (setq new
(1+ new
)))
3096 (setq rst-adornment-level-alist
3097 (append rst-adornment-level-alist
(list (cons key new
))))
3100 ;; Classifies adornment for section titles and transitions. ADORNMENT is the
3101 ;; complete adornment string as found in the buffer. END is the point after the
3102 ;; last character of ADORNMENT. For overline section adornment LIMIT limits the
3103 ;; search for the matching underline. Returns a list. The first entry is t for
3104 ;; a transition, or a key string for `rst-adornment-level' for a section title.
3105 ;; The following eight values forming four match groups as can be used for
3106 ;; `set-match-data'. First match group contains the maximum points of the whole
3107 ;; construct. Second and last match group matched pure section title adornment
3108 ;; while third match group matched the section title text or the transition.
3109 ;; Each group but the first may or may not exist.
3110 (defun rst-classify-adornment (adornment end limit
)
3114 (let ((ado-ch (aref adornment
0))
3115 (ado-re (regexp-quote adornment
))
3122 (or (not (zerop (forward-line 1)))
3123 (looking-at "\\s *$"))))
3126 (or (not (zerop (forward-line -
1)))
3127 (looking-at "\\s *$"))))
3128 key beg-ovr end-ovr beg-txt end-txt beg-und end-und
)
3130 ((and nxt-emp prv-emp
)
3133 (setq beg-txt beg-pnt
)
3134 (setq end-txt end-pnt
))
3137 (setq key
(concat (list ado-ch
) "o"))
3138 (setq beg-ovr beg-pnt
)
3139 (setq end-ovr end-pnt
)
3141 (setq beg-txt
(point))
3142 (while (and (< (point) limit
) (not end-txt
))
3143 (if (looking-at "\\s *$")
3144 ;; No underline found
3145 (setq end-txt
(1- (point)))
3146 (when (looking-at (concat "\\(" ado-re
"\\)\\s *$"))
3147 (setq end-und
(match-end 1))
3148 (setq beg-und
(point))
3149 (setq end-txt
(1- beg-und
))))
3153 (setq key
(concat (list ado-ch
) "u"))
3154 (setq beg-und beg-pnt
)
3155 (setq end-und end-pnt
)
3156 (setq end-txt
(1- beg-und
))
3157 (setq beg-txt
(progn
3158 (if (re-search-backward "^\\s *$" 1 'move
)
3162 (or beg-ovr beg-txt beg-und
)
3163 (or end-und end-txt end-und
)
3164 beg-ovr end-ovr beg-txt end-txt beg-und end-und
)))))
3166 ;; Handles adornments for font-locking section titles and transitions. Returns
3167 ;; three match groups. First and last match group matched pure overline /
3168 ;; underline adornment while second group matched section title text. Each
3169 ;; group may not exist.
3170 (defun rst-font-lock-handle-adornment (limit)
3171 (let ((ado-pnt rst-font-lock-adornment-point
))
3172 ;; May run only once - enforce this
3173 (setq rst-font-lock-adornment-point nil
)
3175 (let* ((ado (rst-classify-adornment (match-string-no-properties 1)
3179 (setq rst-font-lock-level
(rst-adornment-level key t
))
3180 (goto-char (nth 1 mtc
))
3181 (put-text-property (nth 0 mtc
) (nth 1 mtc
) 'font-lock-multiline t
)
3182 (set-match-data mtc
)
3188 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3189 ;; Support for conversion from within Emacs
3191 (defgroup rst-compile nil
3192 "Settings for support of conversion of reStructuredText
3193 document with \\[rst-compile]."
3197 (defvar rst-compile-toolsets
3198 '((html .
("rst2html.py" ".html" nil
))
3199 (latex .
("rst2latex.py" ".tex" nil
))
3200 (newlatex .
("rst2newlatex.py" ".tex" nil
))
3201 (pseudoxml .
("rst2pseudoxml.py" ".xml" nil
))
3202 (xml .
("rst2xml.py" ".xml" nil
)))
3203 "Table describing the command to use for each toolset.
3204 An association list of the toolset to a list of the (command to use,
3205 extension of produced filename, options to the tool (nil or a
3206 string)) to be used for converting the document.")
3208 ;; Note for Python programmers not familiar with association lists: you can set
3209 ;; values in an alists like this, e.g. :
3210 ;; (setcdr (assq 'html rst-compile-toolsets)
3211 ;; '("rst2html.py" ".htm" "--stylesheet=/docutils.css"))
3214 (defvar rst-compile-primary-toolset
'html
3215 "The default toolset for `rst-compile'.")
3217 (defvar rst-compile-secondary-toolset
'latex
3218 "The default toolset for `rst-compile' with a prefix argument.")
3220 (defun rst-compile-find-conf ()
3221 "Look for the configuration file in the parents of the current path."
3223 (let ((file-name "docutils.conf")
3224 (buffer-file (buffer-file-name)))
3225 ;; Move up in the dir hierarchy till we find a change log file.
3226 (let* ((dir (file-name-directory buffer-file
))
3228 (while (and (or (not (string= dir prevdir
))
3231 (not (file-exists-p (concat dir file-name
))))
3232 ;; Move up to the parent dir and try again.
3234 (setq dir
(expand-file-name (file-name-directory
3235 (directory-file-name
3236 (file-name-directory dir
)))))
3238 (or (and dir
(concat dir file-name
)) nil
)
3244 (defun rst-compile (&optional pfxarg
)
3245 "Compile command to convert reST document into some output file.
3246 Attempts to find configuration file, if it can, overrides the
3247 options. There are two commands to choose from, with a prefix
3248 argument, select the alternative toolset."
3250 ;; Note: maybe we want to check if there is a Makefile too and not do anything
3251 ;; if that is the case. I dunno.
3252 (let* ((toolset (cdr (assq (if pfxarg
3253 rst-compile-secondary-toolset
3254 rst-compile-primary-toolset
)
3255 rst-compile-toolsets
)))
3256 (command (car toolset
))
3257 (extension (cadr toolset
))
3258 (options (caddr toolset
))
3259 (conffile (rst-compile-find-conf))
3260 (bufname (file-name-nondirectory buffer-file-name
))
3261 (outname (file-name-sans-extension bufname
)))
3263 ;; Set compile-command before invocation of compile.
3264 (set (make-local-variable 'compile-command
)
3265 (mapconcat 'identity
3269 (concat "--config=\"" conffile
"\"")
3272 (concat outname extension
))
3275 ;; Invoke the compile command.
3276 (if (or compilation-read-command current-prefix-arg
)
3277 (call-interactively 'compile
)
3278 (compile compile-command
))
3281 (defun rst-compile-alt-toolset ()
3282 "Compile command with the alternative toolset."
3286 (defun rst-compile-pseudo-region ()
3287 "Show the pseudo-XML rendering of the current active region,
3288 or of the entire buffer, if the region is not selected."
3290 (with-output-to-temp-buffer "*pseudoxml*"
3291 (shell-command-on-region
3292 (if mark-active
(region-beginning) (point-min))
3293 (if mark-active
(region-end) (point-max))
3297 (defvar rst-pdf-program
"xpdf"
3298 "Program used to preview PDF files.")
3300 (defun rst-compile-pdf-preview ()
3301 "Convert the document to a PDF file and launch a preview program."
3303 (let* ((tmp-filename "/tmp/out.pdf")
3304 (command (format "rst2pdf.py %s %s && %s %s"
3305 buffer-file-name tmp-filename
3306 rst-pdf-program tmp-filename
)))
3307 (start-process-shell-command "rst-pdf-preview" nil command
)
3308 ;; Note: you could also use (compile command) to view the compilation
3312 (defvar rst-slides-program
"firefox"
3313 "Program used to preview S5 slides.")
3315 (defun rst-compile-slides-preview ()
3316 "Convert the document to an S5 slide presentation and launch a preview program."
3318 (let* ((tmp-filename "/tmp/slides.html")
3319 (command (format "rst2s5.py %s %s && %s %s"
3320 buffer-file-name tmp-filename
3321 rst-slides-program tmp-filename
)))
3322 (start-process-shell-command "rst-slides-preview" nil command
)
3323 ;; Note: you could also use (compile command) to view the compilation
3329 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3331 ;; Generic text functions that are more convenient than the defaults.
3334 (defun rst-replace-lines (fromchar tochar
)
3335 "Replace flush-left lines, consisting of multiple FROMCHAR characters,
3336 with equal-length lines of TOCHAR."
3338 cSearch for flush-left lines of char:
3339 cand replace with char: ")
3341 (let ((searchre (concat "^" (regexp-quote (string fromchar
)) "+\\( *\\)$"))
3343 (while (search-forward-regexp searchre nil t
)
3344 (setq found
(1+ found
))
3345 (goto-char (match-beginning 1))
3346 (let ((width (current-column)))
3347 (rst-delete-entire-line)
3348 (insert-char tochar width
)))
3349 (message (format "%d lines replaced." found
)))))
3351 (defun rst-join-paragraph ()
3352 "Join lines in current paragraph into one line, removing end-of-lines."
3354 (let ((fill-column 65000)) ; some big number
3355 (call-interactively 'fill-paragraph
)))
3357 (defun rst-force-fill-paragraph ()
3358 "Fill paragraph at point, first joining the paragraph's lines into one.
3359 This is useful for filling list item paragraphs."
3361 (rst-join-paragraph)
3362 (fill-paragraph nil
))
3365 ;; Generic character repeater function.
3366 ;; For sections, better to use the specialized function above, but this can
3367 ;; be useful for creating separators.
3368 (defun rst-repeat-last-character (&optional tofill
)
3369 "Fill the current line up to the length of the preceding line (if not
3370 empty), using the last character on the current line. If the preceding line is
3371 empty, we use the `fill-column'.
3373 If a prefix argument is provided, use the next line rather than the preceding
3376 If the current line is longer than the desired length, shave the characters off
3377 the current line to fit the desired length.
3379 As an added convenience, if the command is repeated immediately, the alternative
3380 column is used (fill-column vs. end of previous/next line)."
3382 (let* ((curcol (current-column))
3383 (curline (+ (count-lines (point-min) (point))
3384 (if (eq curcol
0) 1 0)))
3385 (lbp (line-beginning-position 0))
3386 (prevcol (if (and (= curline
1) (not current-prefix-arg
))
3389 (forward-line (if current-prefix-arg
1 -
1))
3391 (skip-chars-backward " \t" lbp
)
3392 (let ((cc (current-column)))
3393 (if (= cc
0) fill-column cc
)))))
3395 (cond (tofill fill-column
)
3396 ((equal last-command
'rst-repeat-last-character
)
3397 (if (= curcol fill-column
) prevcol fill-column
))
3399 (if (= prevcol
0) fill-column prevcol
)))
3402 (if (> (current-column) rightmost-column
)
3403 ;; shave characters off the end
3404 (delete-region (- (point)
3405 (- (current-column) rightmost-column
))
3407 ;; fill with last characters
3408 (insert-char (preceding-char)
3409 (- rightmost-column
(current-column))))
3413 (defun rst-portable-mark-active-p ()
3414 "A portable function that returns non-nil if the mark is active."
3416 ((fboundp 'region-active-p
) (region-active-p))
3417 ((boundp 'transient-mark-mode
) transient-mark-mode mark-active
)))
3423 ;; arch-tag: 255ac0a3-a689-44cb-8643-04ca55ae490d
3424 ;;; rst.el ends here
HCoop / bpt / emacs.git / blob