| blob | d303299f4b4a3cc7ebb3d731246136db1a50458d |
1 ;;; rst.el --- Mode for viewing and editing reStructuredText-documents -*- lexical-binding: t -*-
3 ;; Copyright (C) 2003-2017 Free Software Foundation, Inc.
5 ;; Maintainer: Stefan Merten <stefan at merten-home dot de>
6 ;; Author: Stefan Merten <stefan at merten-home dot de>,
7 ;; Martin Blais <blais@furius.ca>,
8 ;; David Goodger <goodger@python.org>,
9 ;; Wei-Wei Guo <wwguocn@gmail.com>
11 ;; This file is part of GNU Emacs.
13 ;; GNU Emacs is free software: you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation, either version 3 of the License, or
16 ;; (at your option) any later version.
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
26 ;;; Commentary:
28 ;; This package provides major mode rst-mode, which supports documents marked
29 ;; up using the reStructuredText format. Support includes font locking as well
30 ;; as a lot of convenience functions for editing. It does this by defining a
31 ;; Emacs major mode: rst-mode (ReST). This mode is derived from text-mode.
32 ;; This package also contains:
33 ;;
34 ;; - Functions to automatically adjust and cycle the section underline
35 ;; adornments;
36 ;; - A mode that displays the table of contents and allows you to jump anywhere
37 ;; from it;
38 ;; - Functions to insert and automatically update a TOC in your source
39 ;; document;
40 ;; - Function to insert list, processing item bullets and enumerations
41 ;; automatically;
42 ;; - Font-lock highlighting of most reStructuredText structures;
43 ;; - Indentation and filling according to reStructuredText syntax;
44 ;; - Cursor movement according to reStructuredText syntax;
45 ;; - Some other convenience functions.
46 ;;
47 ;; See the accompanying document in the docutils documentation about
48 ;; the contents of this package and how to use it.
49 ;;
50 ;; For more information about reStructuredText, see
51 ;; http://docutils.sourceforge.net/rst.html
52 ;;
53 ;; For full details on how to use the contents of this file, see
54 ;; http://docutils.sourceforge.net/docs/user/emacs.html
55 ;;
56 ;; There are a number of convenient key bindings provided by rst-mode. For the
57 ;; bindings, try C-c C-h when in rst-mode. There are also many variables that
58 ;; can be customized, look for defcustom in this file or look for the "rst"
59 ;; customization group contained in the "wp" group.
60 ;;
61 ;; If you use the table-of-contents feature, you may want to add a hook to
62 ;; update the TOC automatically every time you adjust a section title::
63 ;;
64 ;; (add-hook 'rst-adjust-hook 'rst-toc-update)
65 ;;
66 ;; Syntax highlighting: font-lock is enabled by default. If you want to turn
67 ;; off syntax highlighting to rst-mode, you can use the following::
68 ;;
69 ;; (setq font-lock-global-modes '(not rst-mode ...))
70 ;;
72 ;;; DOWNLOAD
74 ;; The latest release of this file lies in the docutils source code repository:
75 ;; http://docutils.svn.sourceforge.net/svnroot/docutils/trunk/docutils/tools/editors/emacs/rst.el
77 ;;; INSTALLATION
79 ;; Add the following lines to your init file:
80 ;;
81 ;; (require 'rst)
82 ;;
83 ;; If you are using `.txt' as a standard extension for reST files as
84 ;; http://docutils.sourceforge.net/FAQ.html#what-s-the-standard-filename-extension-for-a-restructuredtext-file
85 ;; suggests you may use one of the `Local Variables in Files' mechanism Emacs
86 ;; provides to set the major mode automatically. For instance you may use::
87 ;;
88 ;; .. -*- mode: rst -*-
89 ;;
90 ;; in the very first line of your file. The following code is useful if you
91 ;; want automatically enter rst-mode from any file with compatible extensions:
92 ;;
93 ;; (setq auto-mode-alist
94 ;; (append '(("\\.txt\\'" . rst-mode)
95 ;; ("\\.rst\\'" . rst-mode)
96 ;; ("\\.rest\\'" . rst-mode)) auto-mode-alist))
97 ;;
99 ;;; Code:
101 ;; FIXME: Check through major mode conventions again.
103 ;; FIXME: Embed complicated `defconst's in `eval-when-compile'.
105 ;; Common Lisp stuff
108 ;; Correct wrong declaration.
112 ;; Correct wrong declaration. This still doesn't support dotted desctructuring
113 ;; though.
122 )))
124 ;; Add missing declaration.
126 ;; enough.
128 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
129 ;; Support for `testcover'
133 ;; Below `lambda' is used in a loop with varying parameters and is thus not
134 ;; 1valued.
140 "Remove all customized variables from `testcover-module-constants'.
141 This seems to be a bug in `testcover': `defcustom' variables are
142 considered constants. Revert it with this function after each `defcustom'."
149 sym))
150 testcover-module-constants)))))
153 "Add FUN to `testcover-compose-functions'."
158 "Add FUN to `testcover-1value-functions'."
162 \f
163 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
164 ;; Helpers.
168 "`cl-dolist' with destructuring of the list elements.
169 ARGLIST is a Common List argument list which may include
170 destructuring. LIST, RESULT and BODY are as for `cl-dolist'.
171 Note that definitions in ARGLIST are visible only in the BODY and
172 neither in RESULT nor in LIST."
173 ;; FIXME: It would be very useful if the definitions in ARGLIST would be
174 ;; visible in RESULT. But may be this is rather a
175 ;; `rst-destructuring-do' then.
178 cl-declarations def-body))
186 ;; testcover: ok.
187 "Try to move point to beginning of line I + N where I is the current line.
188 Return t if movement is successful. Otherwise don't move point
189 and return nil. If a position is given by LIMIT, movement
190 happened but the following line is missing and thus its beginning
191 can not be reached but the movement reached at least LIMIT
192 consider this a successful movement. LIMIT is ignored in other
193 cases."
199 t
201 nil)))
204 ;; testcover: ok.
205 "Move forward N lines and if successful check whether RST-RE-ARGS is matched.
206 Moving forward is done by `rst-forward-line-strict'. RST-RE-ARGS
207 is a single or a list of arguments for `rst-re'. FUN is a
208 function defaulting to `identity' which is called after the call
209 to `looking-at' receiving its return value as the first argument.
210 When FUN is called match data is just set by `looking-at' and
211 point is at the beginning of the line. Return nil if moving
212 forward failed or otherwise the return value of FUN. Preserve
213 global match data, point, mark and current buffer."
225 "Move N lines and delete the entire line."
229 \f
230 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
231 ;; Versions
234 ;; testcover: ok.
235 "Extract the version from a variable according to the given regexes.
236 Return the version after regex DELIM-RE and HEAD-RE matching RE
237 and before TAIL-RE and DELIM-RE in VAR or DEFAULT for no match."
240 var)
242 default))
244 ;; Use CVSHeader to really get information from CVS and not other version
245 ;; control systems.
258 ;; Use LastChanged... to really get information from SVN.
262 "The SVN revision of this file.
269 ;; Maintained by the release process.
281 rst-official-version
283 rst-cvs-rev rst-cvs-timestamp))
284 "The version string.
285 Starts with the current official version. For developer versions
300 ))
304 rst-version))
309 \f
310 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
311 ;; Initialize customization
318 \f
319 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
320 ;; Facilities for regular expressions used everywhere
322 ;; The trailing numbers in the names give the number of referenceable regex
323 ;; groups contained in the regex.
325 ;; Used to be customizable but really is not customizable but fixed by the reST
326 ;; syntax.
328 ;; Sorted so they can form a character class when concatenated.
339 ;; Sorted so they can form a character class when concatenated.
343 ?-)
347 1000
351 ;; `*-beg' matches * at the beginning of a line.
352 ;; `*-end' matches * at the end of a line.
353 ;; `*-prt' matches a part of *.
354 ;; `*-tag' matches *.
355 ;; `*-sta' matches the start of * which may be followed by respective content.
356 ;; `*-pfx' matches the delimiter left of *.
357 ;; `*-sfx' matches the delimiter right of *.
358 ;; `*-hlp' helper for *.
359 ;;
360 ;; A trailing number says how many referenceable groups are contained.
361 `(
363 ;; Horizontal white space (`hws')
368 ;; Lines (`lin')
373 ;; Various tags and parts
384 ;; Block lead in (`bli')
386 ; immediate content.
388 ;; Various starts
392 ;; Explicit markup tag (`exm')
397 ;; Counters in enumerations (`cnt')
401 ;; Enumerator (`enm')
408 ; enumerator.
415 ; at the beginning of a line.
417 ;; Items may be enumerated or bulleted (`itm')
420 ; is the item tag.
422 ; beginning of a line, group is the
423 ; item tag.
425 ;; Inline markup (`ilm')
429 ;; Inline markup content (`ilc')
434 ; definition.
437 ; definition.
443 (:seq ilcsgl-tag
444 ilcast-prt ilcrep-hlp
447 (:seq ilcsgl-tag
448 ilcbkq-prt ilcrep-hlp
451 (:seq ilcsgl-tag
452 ilcbkqdef-prt ilcrep-hlp
455 (:seq ilcsgl-tag
456 ilcbar-prt ilcrep-hlp
459 (:seq ilcsgl-tag
460 ilcbardef-prt ilcrep-hlp
463 ;; Fields (`fld')
468 ;; Options (`opt')
475 ;; Footnotes and citations (`fnc')
481 ; tag. First group is the explicit markup
482 ; start, second group is the footnote /
483 ; citation tag.
485 ; definition. First group is the explicit
486 ; markup start, second group is the
487 ; footnote / citation tag.
489 ;; Substitutions (`sub')
492 ; tag.
494 ;; Symbol (`sym')
498 ;; URIs (`uri')
501 ;; Adornment (`ado')
504 ; otherwise explicit markup start would be
505 ; recognized.
507 ; characters is matched differently.
510 ; adornment character and MUST be the FIRST
511 ; group in the whole expression.
514 ; adornment character and MUST be the
515 ; SECOND group in the whole expression.
518 ; adornment and MUST be the FIRST group in the whole
519 ; expression; second group is the first adornment
520 ; character.
522 ;; Titles (`ttl')
525 ; line. First group is the complete,
526 ; trimmed title text.
528 ;; Directives and substitution definitions (`dir')
532 ; tag. First group is explicit markup
533 ; start, second group is a possibly
534 ; empty substitution tag, third group is
535 ; the directive tag including the double
536 ; colon.
538 ; definition. Groups are as in dir-tag-3.
540 ;; Literal block (`lit')
543 ; any text before the double colon tag which
544 ; may not exist, second group is the double
545 ; colon tag.
547 ;; Comments (`cmt')
551 ; start.
553 ;; Paragraphs (`par')
556 ; certain cases.
557 )
558 "Definition alist of relevant regexes.
559 Each entry consists of the symbol naming the regex and an
564 ;; FIXME: Use `sregex' or `rx' instead of re-inventing the wheel.
567 ;; testcover: ok.
568 "Interpret ARGS as regular expressions and return a regex string.
569 Each element of ARGS may be one of the following:
571 A string which is inserted unchanged.
573 A character which is resolved to a quoted regex.
575 A symbol which is resolved to a string using `rst-re-alist-def'.
577 A list with a keyword in the car. Each element of the cdr of such
578 a list is recursively interpreted as ARGS. The results of this
579 interpretation are concatenated according to the keyword.
581 For the keyword `:seq' the results are simply concatenated.
583 For the keyword `:shy' the results are concatenated and
589 For the keyword `:grp' the results are concatenated and form a
592 After interpretation of ARGS the results are concatenated as for
593 `:seq'."
599 re)
622 args)))
624 ;; FIXME: Remove circular dependency between `rst-re' and `rst-re-alist'.
627 ;; Shadow global value we are just defining so we can construct it step by
628 ;; step.
636 \f
637 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
638 ;; Concepts
640 ;; Each of the following classes represents an own concept. The suffix of the
641 ;; class name is used in the code to represent entities of the respective
642 ;; class.
643 ;;
644 ;; In addition a reStructuredText section header in the buffer is called
645 ;; "section".
646 ;;
647 ;; For lists a "s" is added to the name of the concepts.
649 \f
650 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
651 ;; Class rst-Ado
656 ;; Construct a transition.
657 (:constructor
658 rst-Ado-new-transition
659 (&aux
662 ;; Construct a simple section header.
663 (:constructor
664 rst-Ado-new-simple
666 &aux
669 ;; Construct a over-and-under section header.
670 (:constructor
671 rst-Ado-new-over-and-under
673 &aux
676 ;; Construct from adornment with inverted style.
677 (:constructor
678 rst-Ado-new-invert
680 &aux
689 "Representation of a reStructuredText adornment.
690 Adornments are either section markers where they markup the
691 section header or transitions.
693 This type is immutable."
694 ;; The character used for the adornment.
696 ;; The style of the adornment. This is a private attribute.
699 ;; Private class methods
702 ;; testcover: ok.
703 "Validate CHAR to be a valid adornment character.
704 Return CHAR if so or signal an error otherwise."
710 char)
712 ;; Public methods
715 ;; testcover: ok.
716 "Return non-nil if SELF is a transition adornment."
721 ;; testcover: ok.
722 "Return non-nil if SELF is a section adornment."
727 ;; testcover: ok.
728 "Return non-nil if SELF is a simple section adornment."
733 ;; testcover: ok.
734 "Return non-nil if SELF is a over-and-under section adornment."
739 ;; testcover: ok.
740 "Return non-nil when SELF and OTHER are equal."
745 nil)
750 ;; testcover: ok.
751 "Return position of SELF in ADOS or nil."
755 ados))
757 \f
758 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
759 ;; Class rst-Hdr
764 ;; Construct while all parameters must be valid.
765 (:constructor
766 rst-Hdr-new
768 indent-arg
769 &aux
772 ;; Construct while all parameters but `indent' must be valid.
773 (:constructor
774 rst-Hdr-new-lax
776 indent-arg
777 &aux
780 ;; Construct a header with same characteristics but opposite style as `ado'.
781 (:constructor
782 rst-Hdr-new-invert
784 indent-arg
785 &aux
789 "Representation of reStructuredText section header characteristics.
791 This type is immutable."
792 ;; The adornment of the header.
794 ;; The indentation of a title text or nil if not given.
797 ;; Private class methods
800 ;; testcover: ok.
801 "Validate INDENT to be a valid indentation for ADO.
802 Return INDENT if so or signal an error otherwise. If LAX don't
803 signal an error and return a valid indent."
807 indent)
810 0
815 0
818 ;; Implicitly over-and-under.
822 ;; testcover: ok.
823 "Validate ADO to be a valid adornment.
824 Return ADO if so or signal an error otherwise."
832 ;; Public class methods
837 ;; testcover: ok.
838 "Return preferred adornments as list of `rst-Hdr'."
845 indent)))
846 rst-preferred-adornments))
848 ;; Public methods
851 ;; testcover: ok.
852 "Return sublist of HDRS whose car's adornment equals that of SELF or nil."
857 hdrs)))
860 ;; testcover: ok.
861 "Return `rst-Ado' list extracted from elements of SELVES."
865 ;; testcover: ok.
866 "Return character of the adornment of SELF."
871 ;; testcover: ok.
872 "Return non-nil if SELF is a over-and-under section header."
876 \f
877 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
878 ;; Class rst-Ttl
883 ;; Construct with valid parameters for all attributes.
885 rst-Ttl--new
887 match-arg
888 indent-arg
889 text-arg
890 &aux
899 "Representation of a reStructuredText section header as found in a buffer.
900 This type gathers information about an adorned part in the buffer.
902 This type is immutable."
903 ;; The adornment characteristics or nil for a title candidate.
905 ;; The match-data for `ado' in a form similarly returned by `match-data' (but
906 ;; not necessarily with markers in buffers). Match group 0 matches the whole
907 ;; construct. Match group 1 matches the overline adornment if present.
908 ;; Match group 2 matches the section title text or the transition. Match
909 ;; group 3 matches the underline adornment.
911 ;; An indentation found for the title line or nil for a transition.
913 ;; The text of the title or nil for a transition.
915 ;; The header characteristics if it is a valid section header.
917 ;; FIXME refactoring: Should have an attribute `buffer' for the buffer this
918 ;; title is found in. This breaks lots and lots of tests.
919 ;; However, with private constructor they may not be
920 ;; necessary any more. In case it is really a buffer then
921 ;; also `match' could be real data from `match-data' which
922 ;; contains markers instead of integers.
923 )
925 ;; Private class methods
928 ;; testcover: ok.
929 "Return valid ADO or signal error."
931 ado)
934 ;; testcover: ok.
935 "Return valid MATCH matching ADO or signal error."
944 ovr-beg ovr-end
945 txt-beg txt-end
946 und-beg und-end) match
976 match)
979 ;; testcover: ok.
980 "Return valid INDENT for ADO or signal error."
986 indent)
989 ;; testcover: ok.
990 "Return valid TEXT for ADO or signal error."
995 text)
997 ;; Public class methods
1000 ;; testcover: ok.
1001 "Return a `rst-Ttl' constructed from information in the current buffer.
1002 ADO is the adornment or nil for a title candidate. BEG-OVR and
1003 BEG-UND are the starting points of the overline or underline,
1004 respectively. They may be nil if the respective thing is missing.
1005 BEG-TXT is the beginning of the title line or the transition and
1006 must be given. The end of the line is used as the end point. TXT
1007 is the title text or nil. If TXT is given the indendation of the
1008 line containing BEG-TXT is used as indentation. Match group 0 is
1009 derived from the remaining information."
1027 beg-ovr end-ovr
1028 beg-txt end-txt
1029 beg-und end-und)
1030 ind txt))))
1032 ;; Public methods
1035 ;; testcover: ok.
1036 "Return position of beginning of title text of SELF.
1037 This position should always be at the start of a line."
1042 ;; testcover: ok.
1043 "Return position of beginning of whole SELF."
1048 ;; testcover: ok.
1049 "Return position of end of whole SELF."
1054 ;; testcover: ok.
1055 "Return non-nil if SELF is a section header or candidate."
1060 ;; testcover: ok.
1061 "Return non-nil if SELF is a candidate for a section header."
1066 "Return whether SELF contain POSITION.
1067 Return 0 if SELF contains POSITION, < 0 if SELF ends before
1068 POSITION and > 0 if SELF starts after position."
1078 \f
1079 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1080 ;; Class rst-Stn
1085 ;; Construct while all parameters must be valid.
1086 (:constructor
1087 rst-Stn-new
1089 level-arg
1090 children-arg
1091 &aux
1095 "Representation of a section tree node.
1097 This type is immutable."
1098 ;; The title of the node or nil for a missing node.
1100 ;; The level of the node in the tree. Negative for the (virtual) top level
1101 ;; node.
1103 ;; The list of children of the node.
1105 ;; FIXME refactoring: Should have an attribute `buffer' for the buffer this
1106 ;; title is found in. Or use `rst-Ttl-buffer'.
1108 ;; Private class methods
1111 ;; testcover: ok.
1112 "Return valid TTL or signal error."
1114 ttl)
1117 ;; testcover: ok.
1118 "Return valid LEVEL for TTL or signal error."
1121 ;; testcover: Never reached because a title may not have a negative level
1124 level)
1127 ;; testcover: ok.
1128 "Return valid CHILDREN for TTL or signal error."
1135 children)
1137 ;; Public methods
1140 ;; testcover: ok.
1141 "Return the beginning of the title of SELF.
1142 Handles missing node properly."
1150 ;; testcover: ok.
1151 "Return title text of SELF or DEFAULT if SELF is a missing node.
1152 For a missing node and no DEFAULT given return a standard title text."
1162 ;; testcover: ok.
1163 "Return non-nil if SELF is a top level node."
1167 \f
1168 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1169 ;; Mode definition
1172 ;; testcover: ok.
1173 "Bind like `define-key' but add deprecated key definitions.
1174 KEYMAP, KEY, and DEF are as in `define-key'. DEPRECATED key
1175 definitions should be in vector notation. These are defined
1176 as well but give an additional message."
1194 ;; FIXME: In Emacs-25 we could use (:documentation ...) instead.
1196 def def)))
1200 ;; Key bindings.
1204 ;; \C-c is the general keymap.
1207 ;;
1208 ;; Section Adornments
1209 ;;
1210 ;; The adjustment function that adorns or rotates a section title.
1213 ; on consoles.
1215 ;; \C-c \C-a is the keymap for adornments.
1217 ;; Another binding which works with all types of input.
1219 ;; Display the hierarchy of adornments implied by the current document
1220 ;; contents.
1222 ;; Homogenize the adornments in the document.
1226 ;;
1227 ;; Section Movement and Selection
1228 ;;
1229 ;; Mark the subsection where the cursor is.
1231 ;; Same as mark-defun sgml-mark-current-element.
1233 ;; Move backward/forward between section titles.
1234 ;; FIXME: Also bind similar to outline mode.
1236 ;; Same as beginning-of-defun.
1239 ;; Same as end-of-defun.
1242 ;;
1243 ;; Operating on regions
1244 ;;
1245 ;; \C-c \C-r is the keymap for regions.
1247 ;; Makes region a line-block.
1250 ;; Shift region left or right according to tabs.
1254 ;;
1255 ;; Operating on lists
1256 ;;
1257 ;; \C-c \C-l is the keymap for lists.
1259 ;; Makes paragraphs in region as a bullet list.
1262 ;; Makes paragraphs in region as a enumeration.
1265 ;; Converts bullets to an enumeration.
1268 ;; Make sure that all the bullets in the region are consistent.
1271 ;; Insert a list item.
1274 ;;
1275 ;; Table-of-Contents Features
1276 ;;
1277 ;; \C-c \C-t is the keymap for table of contents.
1279 ;; Enter a TOC buffer to view and move to a specific section.
1281 ;; Insert a TOC here.
1284 ;; Update the document's TOC (without changing the cursor position).
1287 ;; Go to the section under the cursor (cursor must be in internal TOC).
1291 ;;
1292 ;; Converting Documents from Emacs
1293 ;;
1294 ;; \C-c \C-c is the keymap for compilation.
1296 ;; Run one of two pre-configured toolset commands on the document.
1301 ;; Convert the active region to pseudo-xml using the docutils tools.
1304 ;; Convert the current document to PDF and launch a viewer on the results.
1307 ;; Convert the current document to S5 slides and view in a web browser.
1311 map)
1312 "Keymap for reStructuredText mode commands.
1316 ;; Abbrevs.
1325 ;; FIXME: Add footnotes, links, and more.
1326 ))
1330 ;; Syntax table.
1353 st)
1357 "Hook run when `rst-mode' is turned on.
1358 The hook for `text-mode' is run before this one."
1363 ;; Pull in variable definitions silencing byte-compiler.
1369 ;; Use rst-mode for *.rst and *.rest files. Many ReStructured-Text files
1370 ;; use *.txt, but this is too generic to be set as a default.
1371 ;;;###autoload (add-to-list 'auto-mode-alist (purecopy '("\\.re?st\\'" . rst-mode)))
1372 ;;;###autoload
1374 "Major mode for editing reStructuredText documents.
1377 Turning on `rst-mode' calls the normal hooks `text-mode-hook'
1378 and `rst-mode-hook'. This mode also supports font-lock
1379 highlighting.
1382 :abbrev-table rst-mode-abbrev-table
1383 :syntax-table rst-mode-syntax-table
1386 ;; Paragraph recognition.
1390 lin-end)))
1394 lin-end
1397 ;; Indenting and filling.
1404 ;; Comments.
1410 ;; reStructuredText has not really a comment ender but nil is not really a
1411 ;; permissible value.
1415 ;; Commenting in reStructuredText is very special so use our own set of
1416 ;; functions.
1425 ;; Imenu and which function.
1426 ;; FIXME: Check documentation of `which-function' for alternative ways to
1427 ;; determine the current function name.
1430 ;; Font lock.
1433 t nil nil nil
1438 ;; Text after a changed line may need new fontification.
1441 ;; Indentation is not deterministic.
1444 ;;;###autoload
1446 "Toggle ReST minor mode.
1447 With a prefix argument ARG, enable ReST minor mode if ARG is
1448 positive, and disable it otherwise. If called from Lisp, enable
1449 the mode if ARG is omitted or nil.
1451 When ReST minor mode is enabled, the ReST mode keybindings
1452 are installed on top of the major mode bindings. Use this
1453 for modes derived from Text mode, like Mail mode."
1454 ;; The initial value.
1455 nil
1456 ;; The indicator for the mode line.
1457 " ReST"
1458 ;; The minor mode bindings.
1459 rst-mode-map
1462 ;; FIXME: can I somehow install these too?
1463 ;; :abbrev-table rst-mode-abbrev-table
1464 ;; :syntax-table rst-mode-syntax-table
1466 \f
1467 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1468 ;; Section adornment adjustment
1470 ;; The following functions implement a smart automatic title sectioning feature.
1471 ;; The idea is that with the cursor sitting on a section title, we try to get as
1472 ;; much information from context and try to do the best thing automatically.
1473 ;; This function can be invoked many times and/or with prefix argument to rotate
1474 ;; between the various sectioning adornments.
1475 ;;
1476 ;; Some notes:
1477 ;;
1478 ;; - The underlining character that is used depends on context. The file is
1479 ;; scanned to find other sections and an appropriate character is selected.
1480 ;; If the function is invoked on a section that is complete, the character is
1481 ;; rotated among the existing section adornments.
1482 ;;
1483 ;; Note that when rotating the characters, if we come to the end of the
1484 ;; hierarchy of adornments, the variable `rst-preferred-adornments' is
1485 ;; consulted to propose a new underline adornment, and if continued, we cycle
1486 ;; the adornments all over again. Set this variable to nil if you want to
1487 ;; limit the underlining character propositions to the existing adornments in
1488 ;; the file.
1489 ;;
1490 ;; - An underline/overline that is not extended to the column at which it should
1491 ;; be hanging is dubbed INCOMPLETE. For example::
1492 ;;
1493 ;; |Some Title
1494 ;; |-------
1495 ;;
1496 ;; Examples of default invocation:
1497 ;;
1498 ;; |Some Title ---> |Some Title
1499 ;; | |----------
1500 ;;
1501 ;; |Some Title ---> |Some Title
1502 ;; |----- |----------
1503 ;;
1504 ;; | |------------
1505 ;; | Some Title ---> | Some Title
1506 ;; | |------------
1507 ;;
1508 ;; In over-and-under style, when alternating the style, a variable is
1509 ;; available to select how much default indent to use (it can be zero). Note
1510 ;; that if the current section adornment already has an indent, we don't
1511 ;; adjust it to the default, we rather use the current indent that is already
1512 ;; there for adjustment (unless we cycle, in which case we use the indent
1513 ;; that has been found previously).
1516 "Settings for adjustment and cycling of section title adornments."
1522 ;; FIXME: Default must match suggestion in
1523 ;; http://sphinx-doc.org/rest.html#sections for Python documentation.
1532 "Preferred hierarchy of section title adornments.
1533 A list consisting of lists of the form (CHARACTER STYLE INDENT).
1534 CHARACTER is the character used. STYLE is one of the symbols
1535 `over-and-under' or `simple'. INDENT is an integer giving the
1536 wanted indentation for STYLE `over-and-under'.
1538 This sequence is consulted to offer a new adornment suggestion
1539 when we rotate the underlines at the end of the existing
1540 hierarchy of characters, or when there is no existing section
1541 title in the file.
1543 Set this to an empty list to use only the adornment found in the
1544 file."
1552 rst-adornment-chars))
1560 ;; FIXME: Rename this to `rst-over-and-under-default-indent' and set default to
1561 ;; 0 because the effect of 1 is probably surprising in the few cases
1562 ;; where this is used.
1563 ;; FIXME: A matching adornment style can be looked for in
1564 ;; `rst-preferred-adornments' and its indentation used before using this
1565 ;; variable.
1567 "Number of characters to indent the section title.
1568 This is only used while toggling adornment styles when switching
1569 from a simple adornment style to a over-and-under adornment
1570 style. In addition this is used in cases where the adornments
1571 found in the buffer are to be used but the indentation for
1572 over-and-under adornments is inconsistent across the buffer."
1578 ;; testcover: ok.
1579 "Return a new, preferred `rst-Hdr' different from all in SEEN.
1580 PREV is the previous `rst-Hdr' in the buffer. If given the
1581 search starts after this entry. Return nil if no new preferred
1582 `rst-Hdr' can be found."
1583 ;; All preferred adornments are candidates.
1587 ;; Start searching after the level of the previous adornment.
1592 candidates)))
1595 ;; testcover: ok.
1596 "Unconditionally update the style of the section header at point to HDR.
1597 If there are existing overline and/or underline from the
1598 existing adornment, they are removed before adding the
1599 requested adornment."
1603 new)
1605 ;; Fixup whitespace at the beginning and end of the line.
1614 ;; Remove previous line if it is an adornment.
1615 ;; FIXME refactoring: Check whether this deletes `hdr' which *has* all the
1616 ;; data necessary.
1618 ;; Avoid removing the underline of a title right above us.
1622 ;; Remove following line if it is an adornment.
1626 ;; Insert underline.
1628 ;; Normalize buffer by adding final newline.
1633 ;; Insert overline.
1643 ;; testcover: ok.
1644 "Classify adornment string for section titles and transitions.
1645 ADORNMENT is the complete adornment string as found in the buffer
1646 with optional trailing whitespace. END is the point after the
1647 last character of ADORNMENT. Return a `rst-Ttl' or nil if no
1648 syntactically valid adornment is found. If ACCEPT-OVER-ONLY an
1649 overline with a missing underline is accepted as valid and
1650 returned."
1657 ; adornment.
1666 txt-blw
1674 txt-abv
1710 mtcd
1711 ;; An adornment above may be a legal
1712 ;; adornment for the line above - consider it
1713 ;; a wrong overline only when it is equally
1714 ;; long.
1721 ;; A transition.
1723 nil beg-pnt nil nil))
1725 ;; An overline with an underline.
1727 ovr-fnd ttl-abv beg-pnt txt-abv))
1729 ;; An overline with an underline.
1731 beg-pnt ttl-blw und-fnd txt-blw))
1733 ;; An underline.
1735 nil ttl-abv beg-pnt txt-abv))
1737 ;; An overline with a missing underline.
1739 beg-pnt ttl-blw nil txt-blw))
1741 ;; Invalid adornment.
1742 nil)))))))
1745 ;; testcover: ok.
1746 "Find a section title line around point and return its characteristics.
1747 If the point is on an adornment line find the respective title
1748 line. If the point is on an empty line check previous or next
1749 line whether it is a suitable title line and use it if so. If
1750 point is on a suitable title line use it. Return a `rst-Ttl' for
1751 a section header or nil if no title line is found."
1757 cnd-txt ; Text of a title candidate.
1762 t)))
1763 ttl)
1766 ;; Adornment found - consider it.
1770 ;; Empty line found - check surrounding lines for a title.
1775 ;; Title line found - check for a following underline.
1782 ;; Title candidate found if no valid adornment found.
1786 ttl)
1790 ;; The following function and variables are used to maintain information about
1791 ;; current section adornment in a buffer local cache. Thus they can be used for
1792 ;; font-locking and manipulation commands.
1795 "All section adornments in the buffer as found by `rst-all-ttls'.
1798 ;; FIXME: If this variable is set to a different value font-locking of section
1799 ;; headers is wrong.
1801 "Section hierarchy in the buffer as determined by `rst-hdr-hierarchy'.
1802 Set to t when no section adornments were found.
1807 "Reset all section cache variables.
1808 Should be called by interactive functions which deal with sections."
1810 rst-hdr-hierarchy-cache nil))
1813 ;; testcover: ok.
1814 "Return a list of `rst-Ttl' for current buffer with ascending line number."
1819 ;; Iterate over all the section titles/adornments in the file.
1830 "Return all the section adornments in the current buffer.
1831 Return a list of `rst-Ttl' with ascending line number.
1833 Uses and sets `rst-all-ttls-cache'."
1837 nil
1841 ;; testcover: ok.
1842 "Build a hierarchy from HDRS.
1843 HDRS reflects the order in which the headers appear in the
1844 buffer. Return a `rst-Hdr' list representing the hierarchy of
1845 headers in the buffer. Indentation is unified."
1847 ; it.
1858 rst-default-indent
1859 consistent))))
1863 ;; testcover: ok.
1864 "Return the hierarchy of section titles in the file as a `rst-Hdr' list.
1865 Each returned element may be used directly to create a section
1866 adornment on that level. If IGNORE-POSITION a title containing
1867 this position is not taken into account when building the
1868 hierarchy unless it appears again elsewhere. This catches cases
1869 where the current title is edited and may not be final regarding
1870 its level.
1872 Uses and sets `rst-hdr-hierarchy-cache' unless IGNORE-POSITION is
1873 given."
1880 all-ttls)))
1887 all-ttls)
1893 nil
1894 rst-hdr-hierarchy-cache)
1898 ;; Clear cache reflecting that a possible update is not
1899 ;; reflected.
1900 nil
1902 r)))))
1905 ;; testcover: ok.
1906 "Return the section adornments with levels set according to hierarchy.
1907 Return a list of (`rst-Ttl' . LEVEL) with ascending line number."
1915 "Return the `rst-Hdr' before point or nil if none."
1923 ;; testcover: ok.
1924 "Return t if the adornment ADO around point is complete using INDENT.
1925 The adornment is complete if it is a completely correct
1926 reStructuredText adornment for the title line at point. This
1927 includes indentation and correct length of adornment lines."
1928 ;; Note: we assume that the detection of the overline as being the underline
1929 ;; of a preceding title has already been detected, and has been eliminated
1930 ;; from the adornment that is given to us.
1934 ;; Determine last column of title.
1944 ;; testcover: ok.
1945 "Return the next best `rst-Hdr' upward from HDR.
1946 Consider existing hierarchy HIER and preferred headers. PREV may
1947 be a previous `rst-Hdr' which may be taken into account. If DOWN
1948 return the next best `rst-Hdr' downward instead. Return nil in
1949 HIER is nil."
1951 hier
1956 ;; Next entry in existing hierarchy if it exists.
1959 ;; If current header is found try introducing a new one from preferred
1960 ;; hierarchy.
1962 ;; If not found try using previous header.
1966 ;; All failed - rotate by using first from normalized existing hierarchy.
1969 ;; FIXME: A line "``/`` full" is not accepted as a section title.
1971 ;; testcover: ok.
1972 "Auto-adjust the adornment around point.
1973 Adjust/rotate the section adornment for the section title around
1974 point or promote/demote the adornments inside the region,
1975 depending on whether the region is active. This function is meant
1976 to be invoked possibly multiple times, and can vary its behavior
1977 with a positive PFXARG (toggle style), or with a negative
1978 PFXARG (alternate behavior).
1980 This function is a bit of a swiss knife. It is meant to adjust
1981 the adornments of a section title in reStructuredText. It tries
1985 See the documentations of `rst-adjust-section' and
1986 `rst-adjust-region' for full details.
1988 The method can take either (but not both) of
1990 a. a (non-negative) prefix argument, which means to toggle the
1991 adornment style. Invoke with a prefix argument for example;
1993 b. a negative numerical argument, which generally inverts the
1994 direction of search in the file or hierarchy. Invoke with C--
1995 prefix for example."
2011 "Hooks to be run after running `rst-adjust'."
2018 "Controls level of new adornment for section headers."
2027 "Call `rst-adjust-section' interactively.
2028 Keep this for compatibility for older bindings (are there any?).
2029 Argument PFXARG has the same meaning as for `rst-adjust'."
2037 ;; testcover: ok.
2038 "Return a new `rst-Hdr' for `rst-adjust-section' related to TTL.
2039 TOGGLE-STYLE and REVERSE are from
2040 `rst-adjust-section'. TOGGLE-STYLE may be consumed and thus is
2041 returned.
2043 Return a list (HDR TOGGLE-STYLE MSG...). HDR is the result or
2044 nil. TOGGLE-STYLE is the new TOGGLE-STYLE to use in the
2045 caller. MSG is a list which is non-empty in case HDR is nil
2046 giving an argument list for `message'."
2052 hdr-msg)
2054 hdr-msg
2057 ;; Case 1: No adornment at all.
2060 ;; Previous header exists - use it.
2062 ;; Customization and parameters require that the previous level
2063 ;; is used - use it as is.
2066 prev)
2067 ;; Advance one level down.
2070 ;; First header in the buffer - use the first adornment from
2071 ;; preferences or hierarchy.
2076 ;; Prefer hierarchy for downwards
2078 ;; Prefer preferences for upwards
2082 ;; Case 2: Incomplete adornment.
2083 ;; Use lax since indentation might not match suggestion.
2085 ;; Case 3: Complete adornment exists from here on.
2087 ;; Simply switch the style of the current adornment.
2091 ;; Rotate, ignoring a sole adornment around the current line.
2094 ;; Next header can be determined from hierarchy or preferences.
2096 ;; Use lax since indentation might not match suggestion.
2098 ;; No next header found.
2105 ;; testcover: ok.
2106 "Adjust/rotate the section adornment for the section title around point.
2107 The action this function takes depends on context around the
2108 point, and it is meant to be invoked possibly more than once to
2109 rotate among the various possibilities. Basically, this function
2110 deals with:
2112 - adding an adornment if the title does not have one;
2114 - adjusting the length of the underline characters to fit a
2115 modified title;
2117 - rotating the adornment in the set of already existing
2118 sectioning adornments used in the file;
2120 - switching between simple and over-and-under styles by giving
2121 TOGGLE-STYLE.
2123 Return nil if the function did something. If the function were
2124 not able to do something return an argument list for `message' to
2125 inform the user about what failed.
2127 The following is a detailed description but you should normally
2128 not have to read it.
2130 Before applying the adornment change, the cursor is placed on the
2131 closest line that could contain a section title if such is found
2132 around the cursor. Then the following cases are distinguished.
2134 * Case 1: No Adornment
2136 If the current line has no adornment around it,
2138 - search for a previous adornment, and apply this adornment (unless
2139 `rst-new-adornment-down') or one level lower (otherwise) to the current
2140 line. If there is no defined level below this previous adornment, we
2141 suggest the most appropriate of the `rst-preferred-adornments'.
2143 If REVERSE is true, we simply use the previous adornment found
2144 directly.
2146 - if there is no adornment found in the given direction, we use the first of
2147 `rst-preferred-adornments'.
2149 TOGGLE-STYLE forces a toggle of the prescribed adornment style.
2151 * Case 2: Incomplete Adornment
2153 If the current line does have an existing adornment, but the adornment is
2154 incomplete, that is, the underline/overline does not extend to exactly the
2155 end of the title line (it is either too short or too long), we simply extend
2156 the length of the underlines/overlines to fit exactly the section title.
2158 If TOGGLE-STYLE we toggle the style of the adornment as well.
2160 REVERSE has no effect in this case.
2162 * Case 3: Complete Existing Adornment
2164 If the adornment is complete (i.e. the underline (overline) length is already
2165 adjusted to the end of the title line), we rotate the current title's
2166 adornment according to the adornment hierarchy found in the buffer. This is
2167 meant to be used potentially multiple times, until the desired adornment is
2168 found around the title.
2170 If we hit the boundary of the hierarchy, exactly one choice from the list of
2171 preferred adornments is suggested/chosen, the first of those adornment that
2172 has not been seen in the buffer yet, and the next invocation rolls over to
2173 the other end of the hierarchy (i.e. it cycles).
2175 If REVERSE is we go up in the hierarchy. Otherwise we go down.
2177 However, if TOGGLE-STYLE, we do not rotate the adornment, but instead simply
2178 toggle the style of the current adornment."
2185 &aux
2191 msg
2194 ;; Override indent with present indent if there is some.
2196 ;; Use lax since existing indent may not be valid for new style.
2200 ;; Correct the position of the cursor to more accurately reflect
2201 ;; where it was located when the function was invoked.
2206 nil)))))
2208 ;; Maintain an alias for compatibility.
2212 ;; testcover: ok.
2213 "Promote the section titles within the region.
2214 With argument DEMOTE or a prefix argument, demote the section
2215 titles instead. The algorithm used at the boundaries of the
2216 hierarchy is similar to that used by `rst-adjust-section'."
2228 ;; Apply modifications.
2235 ttls-reg))
2238 ;; `rst-next-hdr' cannot return nil because we apply to a section
2239 ;; header so there is some hierarchy.
2244 ;; testcover: ok.
2245 "Display the current file's section title adornments hierarchy.
2246 Hierarchy is displayed in a temporary buffer."
2260 ;; Maintain an alias for backward compatibility.
2263 ;; FIXME: Should accept an argument giving the hierarchy level to start with
2264 ;; instead of the top of the hierarchy.
2266 ;; testcover: ok.
2267 "Redo the adornments of all section titles in the current buffer.
2268 This is done using the preferred set of adornments. This can be
2269 used, for example, when using somebody else's copy of a document,
2270 in order to adapt it to our preferred style."
2279 ;; Use markers so edits don't disturb the position.
2286 ;; Maintain an alias for compatibility.
2289 \f
2290 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2291 ;; Insert list items
2293 ;; Borrowed from a2r.el (version 1.3), by Lawrence Mitchell <wence@gmx.li>. I
2294 ;; needed to make some tiny changes to the functions, so I put it here.
2295 ;; -- Wei-Wei Guo
2305 ;; testcover: ok.
2306 "Convert Arabic number NUM to its Roman numeral representation.
2308 Obviously, NUM must be greater than zero. Don't blame me, blame the
2310 apologies to Monty Python)."
2320 r))
2323 ;; testcover: ok.
2324 "Convert STRING of Roman numerals to an Arabic number.
2325 If STRING contains a letter which isn't a valid Roman numeral,
2326 the rest of the string from that point onwards is ignored.
2327 Hence:
2328 MMD == 2500
2329 and
2330 MMDFLXXVI == 2500."
2347 res)))
2349 ;; End of borrow.
2351 ;; FIXME: All the following code should not consider single lines as items but
2352 ;; paragraphs as reST does.
2355 ;; testcover: ok.
2356 "Insert first item of a new list tagged with TAG.
2358 Adding a new list might consider three situations:
2360 (a) Current line is a blank line.
2361 (b) Previous line is a blank line.
2362 (c) Following line is a blank line.
2364 When (a) and (b), just add the new list at current line.
2366 when (a) and not (b), a blank line is added before adding the new list.
2368 When not (a), first forward point to the end of the line, and add two
2369 blank lines, then add the new list.
2371 Other situations are just ignored and left to users themselves."
2372 ;; FIXME: Following line is not considered at all.
2374 ;; FIXME: Doesn't work properly for white-space line. See
2375 ;; `rst-insert-list-new-BUGS'.
2378 0
2382 ;; FIXME: The indentation is not fixed to a single space by the syntax. May
2383 ;; be this should be configurable or rather taken from the context.
2396 ;; testcover: ok.
2397 "Insert a new list item.
2399 User is asked to select the item style first, for example (a), i), +.
2400 Use TAB for completion and choices.
2402 If user selects bullets or #, it's just added with position arranged by
2403 `rst-insert-list-new-tag'.
2405 If user selects enumerations, a further prompt is given. User need to
2406 input a starting item, for example 'e' for 'A)' style. The position is
2407 also arranged by `rst-insert-list-new-tag'."
2409 "Select preferred item style [#.]: "
2439 "List of favorite bullets."
2445 rst-bullets)))
2450 ;; testcover: ok.
2451 "Insert a new list tag after the current line according to style.
2452 Style is defined by indentaton IND, TAG and suffix TAB. If
2453 PREFER-ROMAN roman numbering is preferred over using letters."
2456 ;; FIXME: Separating lines must be possible.
2458 ind
2461 tag
2466 pfx
2475 ;; FIXME: Assumes one line list items without separating
2476 ;; empty lines.
2477 ;; Use of `rst-forward-line-looking-at' is very difficult
2478 ;; here so don't do it.
2494 sfx))))
2495 tab))
2497 ;; FIXME: At least the continuation may be folded into
2498 ;; `newline-and-indent`. However, this may not be wanted by everyone so
2499 ;; it should be possible to switch this off.
2501 ;; testcover: ok.
2502 "Insert a list item at the current point.
2504 The command can insert a new list or a continuing list. When it is called at a
2505 non-list line, it will promote to insert new list. When it is called at a list
2506 line, it will insert a list with the same list style.
2508 1. When inserting a new list:
2510 User is asked to select the item style first, for example (a), i), +. Use TAB
2511 for completion and choices.
2513 (a) If user selects bullets or #, it's just added.
2514 (b) If user selects enumerations, a further prompt is given. User needs to
2515 input a starting item, for example `e' for `A)' style.
2517 The position of the new list is arranged according to whether or not the
2518 current line and the previous line are blank lines.
2520 2. When continuing a list, one thing needs to be noticed:
2522 List style alphabetical list, such as `a.', and roman numerical list, such as
2523 `i.', have some overlapping items, for example `v.' The function can deal with
2524 the problem elegantly in most situations. But when those overlapped list are
2525 preceded by a blank line, it is hard to determine which type to use
2526 automatically. The function uses alphabetical list by default. If you want
2527 roman numerical list, just use a prefix to set PREFER-ROMAN."
2532 ;; FIXME: Finds only tags in single line items. Multi-line items should be
2533 ;; considered as well.
2534 ;; Using `rst-forward-line-looking-at' is more complicated so don't do it.
2541 prefer-roman)
2544 ;; FIXME: This is wrong because it misses prefixed lines without intervening
2545 ;; new line. See `rst-straighten-bullets-region-BUGS' and
2546 ;; `rst-find-begs-BUGS'.
2548 ;; testcover: ok.
2549 "Return the positions of begs in region BEG to END.
2550 RST-RE-BEG is a `rst-re' argument and matched at the beginning of
2551 a line. Return a list of (POINT . COLUMN) where POINT gives the
2552 point after indentaton and COLUMN gives its column. The list is
2553 ordererd by POINT."
2557 ;; FIXME refactoring: Consider making this construct a macro looping
2558 ;; over the lines.
2564 ;; FIXME refactoring: Consider using `rst-forward-line-looking-at'.
2574 ; not a beg at same level.
2583 ;; testcover: ok.
2584 "Make all the bulleted list items in the region from BEG to END consistent.
2585 Use this after you have merged multiple bulleted lists to make
2586 them use the preferred bullet characters given by
2587 `rst-preferred-bullets' for each level. If bullets are found on
2588 levels beyond the `rst-preferred-bullets' list, they are not
2589 modified."
2598 ;;; (push point (cdr found)) ; FIXME: Doesn't work with `testcover'.
2603 ;; Zip preferred bullets and sorted columns associating a bullet
2604 ;; with a column and all the points this column is found.
2607 rst-preferred-bullets
2609 ;; Replace the bullets by the preferred ones.
2612 ;; FIXME: Assumes bullet to replace is a single char.
2616 \f
2617 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2618 ;; Table of contents
2621 ;; testcover: ok.
2622 "Return the hierarchical tree of sections as a top level `rst-Stn'.
2623 Return value satisfies `rst-Stn-is-top' or is nil for no
2624 sections."
2628 ;; testcover: ok.
2629 "Process the first entry of UNPROCESSED expected to be on level EXPECTED.
2630 UNPROCESSED is the remaining list of (`rst-Ttl' . LEVEL) entries.
2631 Return (REMAINING . STN) for the first entry of UNPROCESSED.
2632 REMAINING is the list of still unprocessed entries. STN is a
2633 `rst-Stn' or nil if UNPROCESSED is empty."
2640 unprocessed
2642 ;; Consume the current entry and create the current node with it.
2645 ;; Build the child nodes as long as they have deeper level.
2657 ;; testcover: ok.
2658 "Return `rst-Stn' in STN before POINT or nil if in no section.
2659 POINT defaults to the current point. STN may be nil for no
2660 section headers at all."
2664 ;; Point may be in this section or a child.
2672 stn)))))
2675 "Settings for reStructuredText table of contents."
2680 "Indentation for table-of-contents display.
2681 Also used for formatting insertion, when numbering is disabled."
2687 "Insertion style for table-of-contents.
2688 Set this to one of the following values to determine numbering and
2689 indentation style:
2690 - `plain': no numbering (fixed indentation)
2691 - `fixed': numbering, but fixed indentation
2692 - `aligned': numbering, titles aligned under each other
2693 - `listed': titles as list items"
2702 "Separator that goes between the TOC number and the title."
2708 "If non-nil, maximum depth of the inserted TOC."
2714 ;; testcover: ok.
2715 "Insert the table of contents of the current section at the current column.
2716 By default the top level is ignored if there is only one, because
2717 we assume that the document will have a single title. A numeric
2718 prefix argument MAX-LEVEL overrides `rst-toc-insert-max-level'.
2719 Text in the line beyond column is deleted."
2728 rst-toc-insert-max-level))
2732 txt)
2734 ;; Render to temporary buffer so markers are created correctly.
2737 rst-toc-link-keymap nil)
2740 ;; There are lines to indent.
2745 ;; Delete possible trailing text.
2751 ;; testcover: ok.
2752 "Insert text of STN in BUF as a linked section reference at point.
2753 If KEYMAP use this as keymap property. PFX is inserted before text."
2766 ;; testcover: ok.
2767 "Return the link from text property at LINK-PNT in LINK-BUF."
2773 mrkr))
2778 map)
2782 ;; testcover: ok.
2783 "Insert table of contents of tree below top node STN in buffer BUF.
2784 STYLE is the style to use and must be one of the symbols allowed
2785 for `rst-toc-insert-style'. DEPTH is the maximum relative depth
2786 from STN to insert or nil for no maximum depth. See
2787 `rst-toc-insert-link' for KEYMAP. Return beginning of title line
2788 if TGT-STN is rendered or nil if not rendered or TGT-STN is nil.
2789 Just return nil if STN is nil."
2792 tgt-stn)))
2795 keymap tgt-stn)
2796 ;; testcover: ok.
2797 "In the current buffer at point insert CHILDREN in BUF to table of contents.
2798 See `rst-toc-insert-tree' for STYLE, DEPTH and TGT-STN. See
2799 `rst-toc-insert-stn' for INDENT and NUMBERING. See
2800 `rst-toc-insert-link' for KEYMAP."
2802 ;; Child numbering is done from the parent.
2805 fnd)
2807 ;; Add separating dot to existing numbering.
2816 ;; FIXME refactoring: Use `rst-Stn-buffer' instead of `buf'.
2818 ;; testcover: ok.
2819 "In the current buffer at point insert STN in BUF into table of contents.
2820 See `rst-toc-insert-tree' for STYLE, DEPTH and TGT-STN. INDENT
2821 is the indentation depth to use for STN. NUMBERING is the prefix
2822 numbering for STN. See `rst-toc-insert-link' for KEYMAP."
2835 rst-toc-indent))
2842 ;; Indent using spaces so buffer characteristics like `indent-tabs-mode'
2843 ;; do not matter.
2849 fnd))))
2852 ;; testcover: ok.
2853 "Automatically find the contents section of a document and update.
2854 Updates the inserted TOC if present. You can use this in your
2855 file-write hook to always make it up-to-date automatically."
2859 ;; Find and delete an existing comment after the first contents
2860 ;; directive. Delete that region.
2862 ;; FIXME: Should accept indentation of the whole block.
2863 ;; We look for the following and the following only (in other words, if
2864 ;; your syntax differs, this won't work.).
2865 ;;
2866 ;; .. contents:: [...anything here...]
2867 ;; [:field: value]...
2868 ;; ..
2869 ;; XXXXXXXX
2870 ;; XXXXXXXX
2871 ;; [more lines]
2872 ;; FIXME: Works only for the first of these tocs. There should be a
2873 ;; fixed text after the comment such as "RST-MODE ELECTRIC TOC".
2874 ;; May be parameters such as `max-level' should be appended.
2879 nil t))
2880 fnd)
2890 _relind)
2895 nil)))))
2896 t)))
2901 ;; FIXME: Ignores an `max-level' given to the original
2902 ;; `rst-toc-insert'. `max-level' could be rendered to the first
2903 ;; line.
2905 ;; Note: always return nil, because this may be used as a hook.
2906 nil)
2908 ;; FIXME: Updating the toc on saving would be nice. However, this doesn't work
2909 ;; correctly:
2910 ;;
2911 ;; (add-hook 'write-contents-hooks 'rst-toc-update-fun)
2912 ;; (defun rst-toc-update-fun ()
2913 ;; ;; Disable undo for the write file hook.
2914 ;; (let ((buffer-undo-list t)) (rst-toc-update) ))
2916 ;; Maintain an alias for compatibility.
2926 ;; testcover: ok.
2927 "Display a table of contents for current buffer.
2928 Displays all section titles found in the current buffer in a
2929 hierarchical list. The resulting buffer can be navigated, and
2930 selecting a section title moves the cursor to that section."
2938 target-pos)
2943 ;; FIXME: Could use a customizable style.
2951 ;; Maintain an alias for compatibility.
2955 ;; testcover: ok.
2956 "Follow the link to the section at LINK-PNT in LINK-BUF.
2957 LINK-PNT and LINK-BUF default to the point in the current buffer.
2958 With prefix argument KILL a TOC buffer is destroyed. Throw an
2959 error if there is no working link at the given position."
2963 ;; Do not catch errors from `rst-toc-get-link' because otherwise the error is
2964 ;; suppressed and invisible in interactve use.
2968 ;; Catch errors when not in `toc-mode'.
2972 ;; FIXME: Should be a customizable number of lines from beginning or end of
2973 ;; window just like the argument to `recenter`. It would be ideal if
2974 ;; the adornment is always completely visible.
2977 ;; Maintain an alias for compatibility.
2980 ;; FIXME: Cursor before or behind the list must be handled properly; before the
2981 ;; list should jump to the top and behind the list to the last normal
2982 ;; paragraph.
2984 ;; testcover: ok.
2985 "Follow the link to the section at point and kill the TOC buffer."
2989 ;; Maintain an alias for compatibility.
2993 ;; testcover: uncovered.
2994 "In `rst-toc' mode, go to the occurrence whose line you click on.
2995 EVENT is the input event. Kill TOC buffer if KILL."
3000 ;; Maintain an alias for compatibility.
3004 ;; testcover: uncovered.
3005 "Same as `rst-toc-mouse-follow-link', but kill TOC buffer as well.
3006 EVENT is the input event."
3010 ;; Maintain an alias for compatibility.
3014 ;; testcover: ok.
3015 "Leave the current TOC buffer and return to the previous environment.
3016 With prefix argument KILL non-nil, kill the buffer instead of
3017 burying it."
3024 rst-toc-mode-return-wincfg
3032 ;; testcover: uncovered.
3033 "Like `rst-toc-mode-return' but kill TOC buffer."
3047 map)
3053 ;; FIXME: `revert-buffer-function` must be defined so `revert-buffer` works
3054 ;; as expected for a special mode. In particular the referred buffer
3055 ;; needs to be rescanned and the TOC must be updated accordingly.
3056 ;; FIXME: Should contain the name of the buffer this is the toc of.
3059 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3060 ;; Section movement
3062 ;; FIXME testcover: Use `testcover'. Mark up a function with sufficient test
3063 ;; coverage by a comment tagged with `testcover' after the
3064 ;; `defun'. Then move this comment.
3067 "Jump forward OFFSET section titles ending up at the start of the title line.
3068 OFFSET defaults to 1 and may be negative to move backward. An
3069 OFFSET of 0 does not move unless point is inside a title. Go to
3070 end or beginning of buffer if no more section titles in the desired
3071 direction."
3079 ;; Find a title containing or after point.
3085 t)
3087 t))))
3088 ttls)
3089 ;; Point after all titles.
3090 count))
3092 ;; If point is in plain text found title is already one
3093 ;; step forward.
3101 ;; Point not in title and should not move - do not move.
3102 pnt)
3106 "Like `rst-forward-section', except move backward by OFFSET."
3110 ;; FIXME: What is `allow-extend' for? See `mark-paragraph' for an explanation.
3112 "Select COUNT sections around point.
3113 Mark following sections for positive COUNT or preceding sections
3114 for negative COUNT."
3115 ;; Cloned from mark-paragraph.
3133 \f
3134 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3135 ;; Indentation
3138 "Return the leftmost column spanned by region BEG to END.
3139 The line containing the start of the region is always considered
3140 spanned. If the region ends at the beginning of a line this line
3141 is not considered spanned, otherwise it is spanned."
3154 mincol)))
3156 ;; FIXME: At the moment only block comments with leading empty comment line are
3157 ;; supported. Comment lines with leading comment markup should be also
3158 ;; supported. May be a customizable option could control which style to
3159 ;; prefer.
3163 In reStructuredText indentation points are usually determined by
3164 preceding lines. Sometimes the syntax allows arbitrary indentation
3165 points such as where to start the first line following a directive.
3166 These indentation widths can be customized here."
3173 "Indentation when there is no more indentation point given."
3179 "Indentation for first line after a field or 0 to always indent for content."
3186 "Default indentation for literal block after a markup on an own line."
3193 "Default indentation for literal block after a minimized markup."
3200 "Default indentation for first line of a comment."
3206 ;; FIXME: Must consider other tabs:
3207 ;; * Line blocks
3208 ;; * Definition lists
3209 ;; * Option lists
3211 "Return tabs of the current line or nil for no tab.
3212 The list is sorted so the tab where writing continues most likely
3213 is the first one. Each tab is of the form (COLUMN . INNER).
3214 COLUMN is the column of the tab. INNER is non-nil if this is an
3215 inner tab. I.e. a tab which does come from the basic indentation
3216 and not from inner alignment points."
3222 ;; Current indentation is always the least likely tab.
3224 ;; Push inner tabs more likely to continue writing.
3226 ;; Item.
3230 ;; Field.
3240 t)
3241 tabs))))
3242 ;; Directive.
3249 ;; Footnote or citation definition.
3254 ;; Comment.
3257 ;; Start of literal block.
3261 (+ offset
3263 rst-indent-literal-minimized
3264 rst-indent-literal-normal))
3265 t)
3266 tabs)))
3271 tabs))))))
3274 "Build the list of possible tabs for all lines above.
3275 Search backwards from point PT to build the list of possible tabs.
3276 Return a list of tabs sorted by likeliness to continue writing
3277 like `rst-line-tabs'. Nearer lines have generally a higher
3278 likeliness than farther lines. Return nil if no tab is found in
3279 the text above."
3280 ;; FIXME: See test `indent-for-tab-command-BUGS`.
3284 innermost ; Leftmost column for inner tab.
3285 tablist)
3292 ;; Consider only lines indented less or same if not INNERMOST.
3306 leftcol
3307 innermost))
3312 "Indent current line to next best reStructuredText tab.
3313 The next best tab is taken from the tab list returned by
3314 `rst-compute-tabs' which is used in a cyclic manner. If the
3315 current indentation does not end on a tab use the first one. If
3316 the current indentation is on a tab use the next tab. This allows
3318 possible tabs. If no indentation is possible return `noindent' or
3319 use DFLT. Return the indentation indented to. When point is in
3320 indentation it ends up at its end. Otherwise the point is kept
3321 relative to the content."
3327 ind)
3329 'noindent
3342 ind)))
3345 "Shift region BEG to END by CNT tabs.
3346 Shift by one tab to the right (CNT > 0) or left (CNT < 0) or
3347 remove all indentation (CNT = 0). A tab is taken from the text
3348 above. If no suitable tab is found `rst-indent-width' is used."
3355 ;; Apply the indent.
3357 beg end
3360 ;; Find the next tab after the leftmost column.
3366 ;; Get the position of the first tab beyond leftmostcol.
3369 tabs))
3370 ;; Virtual position of tab.
3373 ;; Tab exists - use it.
3375 ;; Column needs to be computed.
3377 ;; Base on last known column.
3379 dir ; Direction to take.
3380 rst-indent-width))))
3384 ;; FIXME: A paragraph with an (incorrectly) indented second line is not filled
3385 ;; correctly::
3386 ;;
3387 ;; Some start
3388 ;; continued wrong
3390 "Return fill prefix found at point.
3391 Value for `adaptive-fill-function'."
3397 ;; An non-comment prefix is fine.
3398 fnd
3399 ;; Matches a comment - return whitespace instead.
3408 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3409 ;; Comments
3412 "Break line and indent, continuing reStructuredText comment if within one.
3413 Value for `comment-line-break-function'. If SOFT use soft
3414 newlines as mandated by `comment-line-break-function'."
3427 "Return indentation for current comment line."
3431 "Insert a comment in the current line."
3436 "Comment or uncomment the current region.
3437 Region is from BEG to END. Uncomment if ARG."
3452 "Uncomment the current region.
3453 Region is from BEG to END. _ARG is ignored"
3463 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3464 ;; Apply to indented block
3466 ;; FIXME: These next functions should become part of a larger effort to redo
3467 ;; the bullets in bulleted lists. The enumerate would just be one of
3468 ;; the possible outputs.
3469 ;;
3470 ;; FIXME: We need to do the enumeration removal as well.
3473 "Apply FUN to all lines from BEG to END in blocks indented to IND.
3474 The first indented block starts with the first non-empty line
3475 containing or after BEG and indented to IND. After the first
3476 line the indented block may contain more lines with same
3477 indentation (the paragraph) followed by empty lines and lines
3478 more indented (the sub-blocks). A following line indented to IND
3479 starts the next paragraph. A non-empty line with less
3480 indentation than IND terminates the current paragraph. FUN is
3481 applied to each line like this
3483 (FUN COUNT IN-FIRST IN-SUB IN-SUPER IN-EMPTY RELIND)
3485 COUNT is 0 before the first paragraph and increments for every
3486 paragraph found on level IND. IN-FIRST is non-nil if this is the
3487 first line of such a paragraph. IN-SUB is non-nil if this line
3488 is part of a sub-block while IN-SUPER is non-nil of this line is
3489 part of a less indented block (super-block). IN-EMPTY is non-nil
3490 if this line is empty where an empty line is considered being
3491 part of the previous block. RELIND is nil for an empty line, 0
3492 for a line indented to IND, and the positive or negative number
3493 of columns more or less indented otherwise. When FUN is called
3494 point is immediately behind indentation of that line. FUN may
3495 change everything as long as a marker at END and at the beginning
3496 of the following line is handled correctly by the change. A
3497 non-nil return value from FUN breaks the loop and is returned.
3498 Otherwise return nil."
3504 in-sub in-super stop)
3511 ;; FIXME refactoring: Replace `(forward-line)
3512 ;; (back-to-indentation)` by
3513 ;; `(forward-to-indentation)`
3520 in-first)
3538 stop
3542 stop))))
3545 "Add enumeration to all the leftmost paragraphs in the given region.
3546 The region is specified between BEG and END. With ALL,
3547 do all lines instead of just paragraphs."
3566 nil))))
3568 ;; FIXME: Does not deal with deeper indentation - although
3569 ;; `rst-apply-indented-blocks' could.
3571 "Add bullets to all the leftmost paragraphs in the given region.
3572 The region is specified between BEG and END. With ALL,
3573 do all lines instead of just paragraphs."
3592 nil))))
3594 ;; FIXME: Does not deal with a varying number of digits appropriately.
3595 ;; FIXME: Does not deal with multiple levels independently.
3596 ;; FIXME: Does not indent a multiline item correctly.
3598 "Convert the bulleted and enumerated items in the region to enumerated lists.
3599 Renumber as necessary. Region is from BEG to END."
3616 "Add line block prefixes for a region.
3617 Region is from BEG to END. With WITH-EMPTY prefix empty lines too."
3621 beg end ind
3626 nil))))
3628 \f
3629 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3630 ;; Font lock
3634 ;; FIXME: The obsolete variables need to disappear.
3636 ;; The following versions have been done inside Emacs and should not be
3637 ;; replaced by `:package-version' attributes until a change.
3645 "Face used for all syntax marking up a special block."
3650 "All syntax marking up a special block."
3656 "customize the face `rst-block' instead."
3660 "Face used for field names and interpreted text."
3665 "Field names and interpreted text."
3671 "customize the face `rst-external' instead."
3675 "Face used for all other defining constructs."
3680 "All other defining constructs."
3686 "customize the face `rst-definition' instead."
3689 ;; XEmacs compatibility (?).
3693 "Face used for directives and roles."
3698 "Directives and roles."
3703 "customize the face `rst-directive' instead."
3707 "Face used for comments."
3712 "Comments."
3718 "customize the face `rst-comment' instead."
3722 "Face used for simple emphasis."
3727 "Simple emphasis."
3733 "customize the face `rst-emphasis1' instead."
3737 "Face used for double emphasis."
3742 "Double emphasis."
3747 "customize the face `rst-emphasis2' instead."
3751 "Face used for literal text."
3756 "Literal text."
3762 "customize the face `rst-literal' instead."
3766 "Face used for references to a definition."
3771 "References to a definition."
3777 "customize the face `rst-reference' instead."
3781 "Face used for a transition."
3786 "Face used for the adornment of a section header."
3790 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3793 rst-level-face-base-light
3794 rst-level-face-format-light
3795 rst-level-face-step-light
3796 rst-level-1-face
3797 rst-level-2-face
3798 rst-level-3-face
3799 rst-level-4-face
3800 rst-level-5-face
3801 rst-level-6-face))
3805 ;; Define faces for the first 6 levels. More levels are possible, however.
3808 "Default face for section title text at level 1."
3813 "Default face for section title text at level 2."
3818 "Default face for section title text at level 3."
3823 "Default face for section title text at level 4."
3828 "Default face for section title text at level 5."
3833 "Default face for section title text at level 6."
3845 "Faces for the various adornment types.
3846 Key is a number (for the section title text of that level
3847 starting with 1), t (for transitions) or nil (for section title
3848 adornment). If you need levels beyond 6 you have to define faces
3849 of your own."
3852 :key-type
3860 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3863 ;; The reST-links in the comments below all relate to sections in
3864 ;; http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html.
3866 ;; start.
3868 ;; Simple `Body Elements`_
3869 ;; `Bullet Lists`_
3870 ;; FIXME: A bullet directly after a field name is not recognized.
3873 ;; `Enumerated Lists`_
3876 ;; `Definition Lists`_
3877 ;; FIXME: missing.
3878 ;; `Field Lists`_
3881 ;; `Option Lists`_
3885 ;; `Line Blocks`_
3886 ;; Only for lines containing no more bar - to distinguish from tables.
3890 ;; `Tables`_
3891 ;; FIXME: missing
3893 ;; All the `Explicit Markup Blocks`_
3894 ;; `Footnotes`_ / `Citations`_
3898 ;; `Directives`_ / `Substitution Definitions`_
3903 ;; `Hyperlink Targets`_
3913 ;; All `Inline Markup`_
3914 ;; Most of them may be multiline though this is uninteresting.
3916 ;; FIXME: Condition 5 preventing fontification of e.g. "*" not implemented
3917 ;; `Strong Emphasis`_.
3920 ;; `Emphasis`_
3923 ;; `Inline Literals`_
3926 ;; `Inline Internal Targets`_
3929 ;; `Hyperlink References`_
3930 ;; FIXME: `Embedded URIs and Aliases`_ not considered.
3931 ;; FIXME: Directly adjacent marked up words are not fontified correctly
3932 ;; unless they are not separated by two spaces: foo_ bar_.
3937 ;; `Interpreted Text`_
3944 ;; `Footnote References`_ / `Citation References`_
3947 ;; `Substitution References`_
3948 ;; FIXME: References substitutions like |this|_ or |this|__ are not
3949 ;; fontified correctly.
3952 ;; `Standalone Hyperlinks`_
3953 ;; FIXME: This takes it easy by using a whitespace as delimiter.
3959 ;; Do all block fontification as late as possible so 'append works.
3961 ;; Sections_ / Transitions_
3962 ;; For sections this is multiline.
3967 nil
3973 ;; FIXME: FACESPEC could be used instead of ordinary faces to set
3974 ;; properties on comments and literal blocks so they are *not*
3975 ;; inline fontified. See (elisp)Search-based Fontification.
3977 ;; FIXME: And / or use `syntax-propertize' functions as in `octave-mod.el'
3978 ;; and other V24 modes. May make `font-lock-extend-region'
3979 ;; superfluous.
3981 ;; `Comments`_
3982 ;; This is multiline.
3987 nil
3994 nil
3997 ;; FIXME: This is not rendered as comment::
3998 ;; .. .. list-table::
3999 ;; :stub-columns: 1
4000 ;; :header-rows: 1
4002 ;; FIXME: This is rendered wrong::
4003 ;;
4004 ;; xxx yyy::
4005 ;;
4006 ;; ----|> KKKKK <|----
4007 ;; / \
4008 ;; -|> AAAAAAAAAAPPPPPP <|- -|> AAAAAAAAAABBBBBBB <|-
4009 ;; | | | |
4010 ;; | | | |
4011 ;; PPPPPP PPPPPPDDDDDDD BBBBBBB PPPPPPBBBBBBB
4012 ;;
4013 ;; Indentation needs to be taken from the line with the ``::`` and not from
4014 ;; the first content line.
4016 ;; `Indented Literal Blocks`_
4017 ;; This is multiline.
4022 nil
4025 ;; FIXME: `Quoted Literal Blocks`_ missing.
4026 ;; This is multiline.
4028 ;; `Doctest Blocks`_
4029 ;; FIXME: This is wrong according to the specification:
4030 ;;
4031 ;; Doctest blocks are text blocks which begin with ">>> ", the Python
4032 ;; interactive interpreter main prompt, and end with a blank line.
4033 ;; Doctest blocks are treated as a special case of literal blocks,
4034 ;; without requiring the literal block syntax. If both are present, the
4035 ;; literal block syntax takes priority over Doctest block syntax:
4036 ;;
4037 ;; This is an ordinary paragraph.
4038 ;;
4039 ;; >>> print 'this is a Doctest block'
4040 ;; this is a Doctest block
4041 ;;
4042 ;; The following is a literal block::
4043 ;;
4044 ;; >>> This is not recognized as a doctest block by
4045 ;; reStructuredText. It *will* be recognized by the doctest
4046 ;; module, though!
4047 ;;
4048 ;; Indentation is not required for doctest blocks.
4058 "Extend the font-lock region if it might be in a multi-line construct.
4059 Return non-nil if so. Font-lock region is from `font-lock-beg'
4060 to `font-lock-end'."
4065 t)))
4068 "Check the region BEG / END for being in the middle of a multi-line construct.
4069 Return nil if not or a cons with new values for BEG / END"
4075 ;; FIXME refactoring: Use `rst-forward-line-strict' instead.
4077 "Like `forward-line' but always end up in column 0 and return accordingly.
4078 Move N lines forward just as `forward-line'."
4081 left
4082 ;; FIXME: This may move back for positive n - is this desired?
4086 ;; FIXME: If a single line is made a section header by `rst-adjust' the header
4087 ;; is not always fontified immediately.
4089 "Extend the region starting at point PT and extending in direction DIR.
4090 Return extended point or nil if not moved."
4091 ;; There are many potential multiline constructs but there are two groups
4092 ;; which are really relevant. The first group consists of
4093 ;;
4094 ;; * comment lines without leading explicit markup tag and
4095 ;;
4096 ;; * literal blocks following "::"
4097 ;;
4098 ;; which are both indented. Thus indentation is the first thing recognized
4099 ;; here. The second criteria is an explicit markup tag which may be a comment
4100 ;; or a double colon at the end of a line.
4101 ;;
4102 ;; The second group consists of the adornment cases.
4104 ;; Move only if we don't start inside a multiline construct already.
4108 ; block tag.
4112 ;; The comments below are for dir == -1 / dir == 1.
4118 ; line if it exists.
4120 ; overline.
4123 ; underline / overline
4124 ; found.
4128 ; overline
4129 ; /
4130 ; underline.
4132 ; title /
4133 ; adornment.
4140 ; underline.
4145 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
4146 ;; Indented blocks
4149 ;; testcover: ok.
4150 "Move forward across one indented block.
4151 Find the next non-empty line which is not indented at least to
4152 COLUMN (defaults to the column of the point). Moves point to
4153 first character of this line or the first of the empty lines
4154 immediately before it and returns that position. If there is no
4155 such line before LIMIT (defaults to the end of the buffer)
4156 returns nil and point is not moved."
4164 nil)
4169 nil)))))
4177 "End of the match as determined by `rst-font-lock-find-unindented-line-limit'.
4181 "Find the next unindented line relative to indentation at IND-PNT.
4182 Return this point, the end of the buffer or nil if nothing found.
4183 If IND-PNT is `next' take the indentation from the next line if
4184 this is not empty and indented more than the current one. If
4185 IND-PNT is non-nil but not a number take the indentation from the
4186 next non-empty line if this is indented more than the current one."
4192 ;; Find indentation point in next line if any.
4194 ;; FIXME: Should be refactored to two different functions
4195 ;; giving their result to this function, may be
4196 ;; integrated in caller.
4202 ;; Not at EOF.
4207 ;; Use end of indentation if non-empty line.
4210 ;; Skip until non-empty line or EOF.
4215 ;; Not at EOF.
4219 ;; Indentation bigger than line of departure.
4228 "Set the match found earlier if match were found.
4229 Match has been found by `rst-font-lock-find-unindented-line-limit'
4230 the first time called or no match is found. Return non-nil if
4231 match was found. _LIMIT is not used but mandated by the caller."
4235 rst-font-lock-find-unindented-line-end))
4237 rst-font-lock-find-unindented-line-end
4239 ;; Make sure this is called only once.
4241 t))
4243 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
4244 ;; Adornments
4247 "Storage for `rst-font-lock-handle-adornment-matcher'.
4251 "Return section level for ADO or t for a transition.
4252 If ADO is found in the hierarchy return its level. Otherwise
4253 return a level one beyond the existing hierarchy."
4255 t
4261 "Storage for match for current adornment.
4262 Set by `rst-font-lock-handle-adornment-pre-match-form'. Also used
4266 "Determine limit for adornments.
4267 Determine all things necessary for font-locking section titles
4268 and transitions and put the result to `rst-font-lock-adornment-match'
4269 and `rst-font-lock-adornment-level'. ADO is the complete adornment
4270 matched. ADO-END is the point where ADO ends. Return the point
4271 where the whole adorned construct ends.
4273 Called as a PRE-MATCH-FORM in the sense of `font-lock-keywords'."
4277 rst-font-lock-adornment-match nil)
4285 "Set the match found earlier if match were found.
4286 Match has been found by
4287 `rst-font-lock-handle-adornment-pre-match-form' the first time
4288 called or no match is found. Return non-nil if match was found.
4290 Called as a MATCHER in the sense of `font-lock-keywords'.
4291 _LIMIT is not used but mandated by the caller."
4293 ;; May run only once - enforce this.
4300 t)))
4302 \f
4303 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
4304 ;; Compilation
4307 "Settings for support of conversion of reStructuredText
4329 ;; FIXME: Add at least those converters officially supported like `rst2odt'
4330 ;; and `rst2man'.
4331 ;; FIXME: To make this really useful there should be a generic command the
4332 ;; user gives one of the symbols and this way select the conversion to
4333 ;; run. This should replace the toolset stuff somehow.
4334 ;; FIXME: Allow a template for the conversion command so `rst2pdf ... -o ...'
4335 ;; can be supported.
4336 "Table describing the command to use for each tool-set.
4337 An association list of the tool-set to a list of the (command to use,
4338 extension of produced filename, options to the tool (nil or a
4339 string)) to be used for converting the document."
4340 ;; FIXME: These are not options but symbols which may be referenced by
4341 ;; `rst-compile-*-toolset` below. The `:validate' keyword of
4342 ;; `defcustom' may help to define this properly in newer Emacs
4343 ;; versions (> 23.1).
4345 :key-type symbol
4356 ;; FIXME: Must be defcustom.
4360 ;; FIXME: Must be defcustom.
4365 "Look for the configuration file in the parents of the current path."
4369 ;; Move up in the dir hierarchy till we find a change log file.
4374 nil)
4376 ;; Move up to the parent dir and try again.
4386 "Compile command to convert reST document into some output file.
4387 Attempts to find configuration file, if it can, overrides the
4388 options. There are two commands to choose from; with USE-ALT,
4389 select the alternative tool-set."
4391 ;; Note: maybe we want to check if there is a Makefile too and not do anything
4392 ;; if that is the case. I dunno.
4398 rst-compile-secondary-toolset
4399 rst-compile-primary-toolset)
4400 rst-compile-toolsets))
4401 ;; Set compile-command before invocation of compile.
4403 compile-command
4405 #'identity
4413 extension)))
4415 ;; Invoke the compile command.
4421 "Compile command with the alternative tool-set."
4426 "Show pseudo-XML rendering.
4427 Rendering is done of the current active region, or of the entire
4428 buffer, if the region is not selected."
4429 ;; FIXME: The region should be given interactively.
4436 standard-output)))
4438 ;; FIXME: Should be integrated in `rst-compile-toolsets'.
4443 "Convert the document to a PDF file and launch a preview program."
4448 buffer-file-name tmp-filename
4449 rst-pdf-program tmp-filename tmp-filename)))
4451 ;; Note: you could also use (compile command) to view the compilation
4452 ;; output.
4453 ))
4455 ;; FIXME: Should be integrated in `rst-compile-toolsets' defaulting to
4456 ;; something like `browse-url'.
4461 "Convert the document to an S5 slide presentation and launch a preview program."
4466 buffer-file-name tmp-filename
4467 rst-slides-program tmp-filename tmp-filename)))
4469 ;; Note: you could also use (compile command) to view the compilation
4470 ;; output.
4471 ))
4473 ;; FIXME: Add `rst-compile-html-preview'.
4475 ;; FIXME: Add support for `restview` (http://mg.pov.lt/restview/). May be a
4476 ;; more general facility for calling commands on a reST file would make
4477 ;; sense.
4479 \f
4480 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
4481 ;; Imenu support
4483 ;; FIXME: Consider a key binding. A key binding needs to definitely switch on
4484 ;; `which-func-mode' - i.e. `which-func-modes' must be set properly.
4486 ;; Based on ideas from Masatake YAMATO <yamato@redhat.com>.
4489 "Convert a STN to an Imenu index node and return it."
4496 name)
4502 ;; FIXME: Overline adornment characters need to be in front so they
4503 ;; become visible even for long title lines. May be an additional
4504 ;; level number is also useful.
4513 ;; FIXME: Document title and subtitle need to be handled properly. They should
4514 ;; get an own "Document" top level entry.
4516 "Create index for Imenu.
4517 Return as described for `imenu--index-alist'."
4523 \f
4524 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
4525 ;; Convenience functions
4527 ;; FIXME: Unbound command - should be bound or removed.
4529 "Replace flush-left lines of FROMCHAR with equal-length lines of TOCHAR."
4531 cSearch for flush-left lines of char:
4544 ;; FIXME: Unbound command - should be bound or removed.
4546 "Join lines in current paragraph into one line, removing end-of-lines."
4551 ;; FIXME: Unbound command - should be bound or removed.
4553 "Fill paragraph at point, first joining the paragraph's lines into one.
4554 This is useful for filling list item paragraphs."
4560 ;; FIXME: Unbound command - should be bound or removed.
4561 ;; Generic character repeater function.
4562 ;; For sections, better to use the specialized function above, but this can
4563 ;; be useful for creating separators.
4565 "Fill the current line using the last character on the current line.
4566 Fill up to the length of the preceding line or up to `fill-column' if preceding
4567 line is empty.
4569 If USE-NEXT, use the next line rather than the preceding line.
4571 If the current line is longer than the desired length, shave the characters off
4572 the current line to fit the desired length.
4574 As an added convenience, if the command is repeated immediately, the alternative
4575 column is used (fill-column vs. end of previous/next line)."
4582 fill-column
4596 ;; Shave characters off the end.
4600 ;; Fill with last characters.
4604 \f
4606 ;; LocalWords: docutils http sourceforge rst html wp svn svnroot txt reST regex
4607 ;; LocalWords: regexes alist seq alt grp keymap abbrev overline overlines toc
4608 ;; LocalWords: XML PNT propertized init referenceable
4612 ;; Local Variables:
4613 ;; sentence-end-double-space: t
4614 ;; End:
4616 ;;; rst.el ends here