| blob | 516431006f67663d4c4a4fe3c2be4483d29109f5 |
1 ;;; rst.el --- Mode for viewing and editing reStructuredText-documents.
3 ;; Copyright (C) 2003-2014 Free Software Foundation, Inc.
5 ;; Maintainer: Stefan Merten <smerten@oekonux.de>
6 ;; Author: Stefan Merten <smerten@oekonux.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 ;;
57 ;; There are a number of convenient key bindings provided by rst-mode.
58 ;; For more on bindings, see rst-mode-map below. There are also many variables
59 ;; that can be customized, look for defcustom in this file.
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 ;;
71 ;;
72 ;;
73 ;; Customization is done by customizable variables contained in customization
74 ;; group "rst" and subgroups. Group "rst" is contained in the "wp" group.
75 ;;
77 ;;; DOWNLOAD
79 ;; The latest release of this file lies in the docutils source code repository:
80 ;; http://docutils.svn.sourceforge.net/svnroot/docutils/trunk/docutils/tools/editors/emacs/rst.el
82 ;;; INSTALLATION
84 ;; Add the following lines to your init file:
85 ;;
86 ;; (require 'rst)
87 ;;
88 ;; If you are using `.txt' as a standard extension for reST files as
89 ;; http://docutils.sourceforge.net/FAQ.html#what-s-the-standard-filename-extension-for-a-restructuredtext-file
90 ;; suggests you may use one of the `Local Variables in Files' mechanism Emacs
91 ;; provides to set the major mode automatically. For instance you may use::
92 ;;
93 ;; .. -*- mode: rst -*-
94 ;;
95 ;; in the very first line of your file. The following code is useful if you
96 ;; want automatically enter rst-mode from any file with compatible extensions:
97 ;;
98 ;; (setq auto-mode-alist
99 ;; (append '(("\\.txt\\'" . rst-mode)
100 ;; ("\\.rst\\'" . rst-mode)
101 ;; ("\\.rest\\'" . rst-mode)) auto-mode-alist))
102 ;;
104 ;;; Code:
106 ;; FIXME: Check through major mode conventions again.
108 ;; FIXME: Add proper ";;;###autoload" comments.
110 ;; FIXME: When 24.1 is common place remove use of `lexical-let' and put "-*-
111 ;; lexical-binding: t -*-" in the first line.
113 ;; FIXME: Use `testcover'.
115 ;; FIXME: The adornment classification often called `ado' should be a
116 ;; `defstruct'.
118 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
119 ;; Support for `testcover'
123 ;; Below `lambda' is used in a loop with varying parameters and is thus not
124 ;; 1valued.
130 "Remove all customized variables from `testcover-module-constants'.
131 This seems to be a bug in `testcover': `defcustom' variables are
132 considered constants. Revert it with this function after each `defcustom'."
139 sym))
140 testcover-module-constants)))))
143 "Add FUN to `testcover-compose-functions'."
148 "Add FUN to `testcover-1value-functions'."
152 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
153 ;; Common Lisp stuff
155 ;; Only use of macros is allowed - may be replaced by `cl-lib' some time.
159 ;; Redefine some functions from `cl.el' in a proper namespace until they may be
160 ;; used from there.
163 "Return 1 if X is positive, -1 if negative, 0 if zero."
170 "Return non-nil if any element of SEQ yields non-nil when PRED is applied.
171 Apply PRED to each element of list SEQ until the first non-nil
172 result is yielded and return this result. PRED defaults to
173 `identity'."
183 "Return position of first element satisfying PRED in list SEQ or nil."
192 "Return position of ELEM in list SEQ or nil.
193 Comparison done with `equal'."
194 ;; Create a closure containing `elem' so the `lambda' always sees our
195 ;; parameter instead of an `elem' which may be in dynamic scope at the time
196 ;; of execution of the `lambda'.
200 seq)))
202 ;; FIXME: Embed complicated `defconst's in `eval-when-compile'.
204 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
205 ;; Versions
207 ;; testcover: ok.
209 "Extract the version from a variable according to the given regexes.
210 Return the version after regex DELIM-RE and HEAD-RE matching RE
211 and before TAIL-RE and DELIM-RE in VAR or DEFAULT for no match."
214 var)
216 default))
218 ;; Use CVSHeader to really get information from CVS and not other version
219 ;; control systems.
232 ;; Use LastChanged... to really get information from SVN.
236 "The SVN revision of this file.
243 ;; Maintained by the release process.
255 rst-official-version
257 rst-cvs-rev rst-cvs-timestamp))
258 "The version string.
259 Starts with the current official version. For developer versions
270 ))
274 rst-version))
279 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
280 ;; Initialize customization
282 \f
288 \f
289 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
290 ;; Facilities for regular expressions used everywhere
292 ;; The trailing numbers in the names give the number of referenceable regex
293 ;; groups contained in the regex.
295 ;; Used to be customizable but really is not customizable but fixed by the reST
296 ;; syntax.
298 ;; Sorted so they can form a character class when concatenated.
309 ;; Sorted so they can form a character class when concatenated.
313 ?-)
317 1000
321 ;; `*-beg' matches * at the beginning of a line.
322 ;; `*-end' matches * at the end of a line.
323 ;; `*-prt' matches a part of *.
324 ;; `*-tag' matches *.
325 ;; `*-sta' matches the start of * which may be followed by respective content.
326 ;; `*-pfx' matches the delimiter left of *.
327 ;; `*-sfx' matches the delimiter right of *.
328 ;; `*-hlp' helper for *.
329 ;;
330 ;; A trailing number says how many referenceable groups are contained.
331 `(
333 ;; Horizontal white space (`hws')
338 ;; Lines (`lin')
343 ;; Various tags and parts
354 ;; Block lead in (`bli')
356 ; immediate content.
358 ;; Various starts
361 ;; Explicit markup tag (`exm')
366 ;; Counters in enumerations (`cnt')
370 ;; Enumerator (`enm')
377 ; enumerator.
384 ; at the beginning of a line.
386 ;; Items may be enumerated or bulleted (`itm')
389 ; is the item tag.
391 ; beginning of a line, group is the
392 ; item tag.
394 ;; Inline markup (`ilm')
398 ;; Inline markup content (`ilc')
403 ; definition.
406 ; definition.
412 (:seq ilcsgl-tag
413 ilcast-prt ilcrep-hlp
416 (:seq ilcsgl-tag
417 ilcbkq-prt ilcrep-hlp
420 (:seq ilcsgl-tag
421 ilcbkqdef-prt ilcrep-hlp
424 (:seq ilcsgl-tag
425 ilcbar-prt ilcrep-hlp
428 (:seq ilcsgl-tag
429 ilcbardef-prt ilcrep-hlp
432 ;; Fields (`fld')
437 ;; Options (`opt')
444 ;; Footnotes and citations (`fnc')
450 ; tag. First group is the explicit markup
451 ; start, second group is the footnote /
452 ; citation tag.
454 ; definition. First group is the explicit
455 ; markup start, second group is the
456 ; footnote / citation tag.
458 ;; Substitutions (`sub')
461 ; tag.
463 ;; Symbol (`sym')
467 ;; URIs (`uri')
470 ;; Adornment (`ado')
473 ; otherwise explicit markup start would be
474 ; recognized.
476 ; characters is matched differently.
479 ; adornment character and MUST be the FIRST
480 ; group in the whole expression.
483 ; adornment character and MUST be the
484 ; SECOND group in the whole expression.
487 ; adornment and MUST be the FIRST group in the whole
488 ; expression; second group is the first adornment
489 ; character.
491 ;; Titles (`ttl')
495 ;; Directives and substitution definitions (`dir')
499 ; tag. First group is explicit markup
500 ; start, second group is a possibly
501 ; empty substitution tag, third group is
502 ; the directive tag including the double
503 ; colon.
505 ; definition. Groups are as in dir-tag-3.
507 ;; Literal block (`lit')
510 ; any text before the double colon tag which
511 ; may not exist, second group is the double
512 ; colon tag.
514 ;; Comments (`cmt')
518 ; start.
520 ;; Paragraphs (`par')
523 ; certain cases.
524 )
525 "Definition alist of relevant regexes.
526 Each entry consists of the symbol naming the regex and an
531 ;; FIXME: Use `sregex` or `rx` instead of re-inventing the wheel.
533 ;; testcover: ok.
535 "Interpret ARGS as regular expressions and return a regex string.
536 Each element of ARGS may be one of the following:
538 A string which is inserted unchanged.
540 A character which is resolved to a quoted regex.
542 A symbol which is resolved to a string using `rst-re-alist-def'.
544 A list with a keyword in the car. Each element of the cdr of such
545 a list is recursively interpreted as ARGS. The results of this
546 interpretation are concatenated according to the keyword.
548 For the keyword `:seq' the results are simply concatenated.
550 For the keyword `:shy' the results are concatenated and
556 For the keyword `:grp' the results are concatenated and form a
559 After interpretation of ARGS the results are concatenated as for
560 `:seq'."
566 re)
589 args)))
591 ;; FIXME: Remove circular dependency between `rst-re' and `rst-re-alist'.
594 ;; Shadow global value we are just defining so we can construct it step by
595 ;; step.
603 \f
604 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
605 ;; Mode definition
607 ;; testcover: ok.
609 "Bind like `define-key' but add deprecated key definitions.
610 KEYMAP, KEY, and DEF are as in `define-key'. DEPRECATED key
611 definitions should be in vector notation. These are defined as
612 well but give an additional message."
632 def def)))
635 ;; Key bindings.
639 ;; \C-c is the general keymap.
642 ;;
643 ;; Section Adornments
644 ;;
645 ;; The adjustment function that adorns or rotates a section title.
648 ; on consoles.
650 ;; \C-c \C-a is the keymap for adornments.
652 ;; Another binding which works with all types of input.
654 ;; Display the hierarchy of adornments implied by the current document
655 ;; contents.
657 ;; Homogenize the adornments in the document.
661 ;;
662 ;; Section Movement and Selection
663 ;;
664 ;; Mark the subsection where the cursor is.
666 ;; Same as mark-defun sgml-mark-current-element.
668 ;; Move backward/forward between section titles.
669 ;; FIXME: Also bind similar to outline mode.
671 ;; Same as beginning-of-defun.
674 ;; Same as end-of-defun.
677 ;;
678 ;; Operating on regions
679 ;;
680 ;; \C-c \C-r is the keymap for regions.
682 ;; Makes region a line-block.
685 ;; Shift region left or right according to tabs.
689 ;;
690 ;; Operating on lists
691 ;;
692 ;; \C-c \C-l is the keymap for lists.
694 ;; Makes paragraphs in region as a bullet list.
697 ;; Makes paragraphs in region as a enumeration.
700 ;; Converts bullets to an enumeration.
703 ;; Make sure that all the bullets in the region are consistent.
706 ;; Insert a list item.
709 ;;
710 ;; Table-of-Contents Features
711 ;;
712 ;; \C-c \C-t is the keymap for table of contents.
714 ;; Enter a TOC buffer to view and move to a specific section.
716 ;; Insert a TOC here.
719 ;; Update the document's TOC (without changing the cursor position).
722 ;; Go to the section under the cursor (cursor must be in TOC).
726 ;;
727 ;; Converting Documents from Emacs
728 ;;
729 ;; \C-c \C-c is the keymap for compilation.
731 ;; Run one of two pre-configured toolset commands on the document.
736 ;; Convert the active region to pseudo-xml using the docutils tools.
739 ;; Convert the current document to PDF and launch a viewer on the results.
742 ;; Convert the current document to S5 slides and view in a web browser.
746 map)
747 "Keymap for reStructuredText mode commands.
751 ;; Abbrevs.
759 ;; FIXME: Add footnotes, links, and more.
760 ))
764 ;; Syntax table.
788 st)
793 "Hook run when `rst-mode' is turned on.
794 The hook for `text-mode' is run before this one."
799 ;; Pull in variable definitions silencing byte-compiler.
802 ;; Use rst-mode for *.rst and *.rest files. Many ReStructured-Text files
803 ;; use *.txt, but this is too generic to be set as a default.
804 ;;;###autoload (add-to-list 'auto-mode-alist (purecopy '("\\.re?st\\'" . rst-mode)))
805 ;;;###autoload
807 "Major mode for editing reStructuredText documents.
810 Turning on `rst-mode' calls the normal hooks `text-mode-hook'
811 and `rst-mode-hook'. This mode also supports font-lock
812 highlighting.
815 :abbrev-table rst-mode-abbrev-table
816 :syntax-table rst-mode-syntax-table
819 ;; Paragraph recognition.
823 lin-end)))
827 lin-end
830 ;; Indenting and filling.
838 ;; Comments.
845 ;; reStructuredText has not really a comment ender but nil is not really a
846 ;; permissible value.
850 ;; Commenting in reStructuredText is very special so use our own set of
851 ;; functions.
863 ;; Imenu and which function.
864 ;; FIXME: Check documentation of `which-function' for alternative ways to
865 ;; determine the current function name.
869 ;; Font lock.
872 t nil nil nil
877 ;; Text after a changed line may need new fontification.
880 ;; Indentation is not deterministic.
883 ;;;###autoload
885 "Toggle ReST minor mode.
886 With a prefix argument ARG, enable ReST minor mode if ARG is
887 positive, and disable it otherwise. If called from Lisp, enable
888 the mode if ARG is omitted or nil.
890 When ReST minor mode is enabled, the ReST mode keybindings
891 are installed on top of the major mode bindings. Use this
892 for modes derived from Text mode, like Mail mode."
893 ;; The initial value.
894 nil
895 ;; The indicator for the mode line.
896 " ReST"
897 ;; The minor mode bindings.
898 rst-mode-map
901 ;; FIXME: can I somehow install these too?
902 ;; :abbrev-table rst-mode-abbrev-table
903 ;; :syntax-table rst-mode-syntax-table
905 \f
906 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
907 ;; Section Adornment Adjustment
908 ;; ============================
909 ;;
910 ;; The following functions implement a smart automatic title sectioning feature.
911 ;; The idea is that with the cursor sitting on a section title, we try to get as
912 ;; much information from context and try to do the best thing automatically.
913 ;; This function can be invoked many times and/or with prefix argument to rotate
914 ;; between the various sectioning adornments.
915 ;;
916 ;; Definitions: the two forms of sectioning define semantically separate section
917 ;; levels. A sectioning ADORNMENT consists in:
918 ;;
919 ;; - a CHARACTER
920 ;;
921 ;; - a STYLE which can be either of 'simple' or 'over-and-under'.
922 ;;
923 ;; - an INDENT (meaningful for the over-and-under style only) which determines
924 ;; how many characters and over-and-under style is hanging outside of the
925 ;; title at the beginning and ending.
926 ;;
927 ;; Here are two examples of adornments (| represents the window border, column
928 ;; 0):
929 ;;
930 ;; |
931 ;; 1. char: '-' e |Some Title
932 ;; style: simple |----------
933 ;; |
934 ;; 2. char: '=' |==============
935 ;; style: over-and-under | Some Title
936 ;; indent: 2 |==============
937 ;; |
938 ;;
939 ;; Some notes:
940 ;;
941 ;; - The underlining character that is used depends on context. The file is
942 ;; scanned to find other sections and an appropriate character is selected.
943 ;; If the function is invoked on a section that is complete, the character is
944 ;; rotated among the existing section adornments.
945 ;;
946 ;; Note that when rotating the characters, if we come to the end of the
947 ;; hierarchy of adornments, the variable rst-preferred-adornments is
948 ;; consulted to propose a new underline adornment, and if continued, we cycle
949 ;; the adornments all over again. Set this variable to nil if you want to
950 ;; limit the underlining character propositions to the existing adornments in
951 ;; the file.
952 ;;
953 ;; - An underline/overline that is not extended to the column at which it should
954 ;; be hanging is dubbed INCOMPLETE. For example::
955 ;;
956 ;; |Some Title
957 ;; |-------
958 ;;
959 ;; Examples of default invocation:
960 ;;
961 ;; |Some Title ---> |Some Title
962 ;; | |----------
963 ;;
964 ;; |Some Title ---> |Some Title
965 ;; |----- |----------
966 ;;
967 ;; | |------------
968 ;; | Some Title ---> | Some Title
969 ;; | |------------
970 ;;
971 ;; In over-and-under style, when alternating the style, a variable is
972 ;; available to select how much default indent to use (it can be zero). Note
973 ;; that if the current section adornment already has an indent, we don't
974 ;; adjust it to the default, we rather use the current indent that is already
975 ;; there for adjustment (unless we cycle, in which case we use the indent
976 ;; that has been found previously).
979 "Settings for adjustment and cycling of section title adornments."
993 "Preferred hierarchy of section title adornments.
995 A list consisting of lists of the form (CHARACTER STYLE INDENT).
996 CHARACTER is the character used. STYLE is one of the symbols
997 OVER-AND-UNDER or SIMPLE. INDENT is an integer giving the wanted
998 indentation for STYLE OVER-AND-UNDER. CHARACTER and STYLE are
999 always used when a section adornment is described. In other
1000 places t instead of a list stands for a transition.
1002 This sequence is consulted to offer a new adornment suggestion
1003 when we rotate the underlines at the end of the existing
1004 hierarchy of characters, or when there is no existing section
1005 title in the file.
1007 Set this to an empty list to use only the adornment found in the
1008 file."
1016 rst-adornment-chars))
1025 "Number of characters to indent the section title.
1027 This is used for when toggling adornment styles, when switching
1028 from a simple adornment style to a over-and-under adornment
1029 style."
1035 "Compare adornments.
1036 Return true if both ADO1 and ADO2 adornments are equal,
1037 according to restructured text semantics (only the character and
1038 the style are compared, the indentation does not matter)."
1044 "Return the index (level) in hierarchy HIER of adornment ADO.
1045 This basically just searches for the item using the appropriate
1046 comparison and returns the index. Return nil if the item is
1047 not found."
1051 cur))
1053 ;; testcover: FIXME: Test with `rst-preferred-adornments' == nil. Add test
1054 ;; `rst-adjust-no-preference'.
1056 "Suggest a new, different adornment from all that have been seen.
1058 ALLADOS is the set of all adornments, including the line numbers.
1059 PREV is the optional previous adornment, in order to suggest a
1060 better match."
1062 ;; For all the preferred adornments...
1064 ;; If 'prev' is given, reorder the list to start searching after the
1065 ;; match.
1069 ;; List of candidates to search.
1072 ;; For all the adornments...
1074 found)
1077 ;; Found it!
1080 found)
1087 "Delete the entire current line without using the `kill-ring'."
1092 "Unconditionally update the style of a section adornment.
1094 Do this using the given character CHAR, with STYLE 'simple
1095 or 'over-and-under, and with indent INDENT. If the STYLE
1096 is 'simple, whitespace before the title is removed (indent
1097 is always assumed to be 0).
1099 If there are existing overline and/or underline from the
1100 existing adornment, they are removed before adding the
1101 requested adornment."
1104 len)
1106 ;; Fixup whitespace at the beginning and end of the line.
1116 ;; Set the current column, we're at the end of the title line.
1119 ;; Remove previous line if it is an adornment.
1122 ;; of buffer.
1124 ;; Avoid removing the underline of a title right above us.
1129 ;; Remove following line if it is an adornment.
1132 ;; of buffer.
1135 ;; Add a newline if we're at the end of the buffer, for the subsequence
1136 ;; inserting of the underline.
1140 ;; Insert overline.
1147 ;; Insert underline.
1158 "Classify adornment for section titles and transitions.
1159 ADORNMENT is the complete adornment string as found in the buffer
1160 with optional trailing whitespace. END is the point after the
1161 last character of ADORNMENT.
1163 Return a list. The first entry is t for a transition or a
1164 cons (CHARACTER . STYLE). Check `rst-preferred-adornments' for
1165 the meaning of CHARACTER and STYLE.
1167 The remaining list forms four match groups as returned by
1168 `match-data'. Match group 0 matches the whole construct. Match
1169 group 1 matches the overline adornment if present. Match group 2
1170 matches the section title text or the transition. Match group 3
1171 matches the underline adornment.
1173 Return nil if no syntactically valid adornment is found."
1188 ;; testcover: FIXME: Add test classifying at the end of
1189 ;; buffer.
1199 ;; classifying at the end of
1200 ;; buffer.
1213 ;; classifying at the end of
1214 ;; buffer.
1223 key beg-ovr end-ovr beg-txt end-txt beg-und end-und)
1226 ;; A transition.
1228 beg-txt beg-pnt
1229 end-txt end-pnt))
1231 ;; An overline with an underline.
1247 ;; An underline.
1249 beg-und beg-pnt
1250 end-und end-pnt)
1255 ;; Invalid adornment.
1261 beg-ovr end-ovr beg-txt end-txt beg-und end-und)))))))
1264 "Find a section title line around point and return its characteristics.
1265 If the point is on an adornment line find the respective title
1266 line. If the point is on an empty line check previous or next
1267 line whether it is a suitable title line and use it if so. If
1268 point is on a suitable title line use it.
1270 If no title line is found return nil.
1272 Otherwise return as `rst-classify-adornment' does. However, if
1273 the title line has no syntactically valid adornment STYLE is nil
1274 in the first element. If there is no adornment around the title
1275 CHARACTER is also nil and match groups for overline and underline
1276 are nil."
1289 ;; Invalid adornment - check whether this is an incomplete overline.
1296 ;; A section title - not a transition.
1297 r))))
1311 ;; Try to use the underline.
1317 r
1318 ;; No valid adornment found.
1322 ;; The following function and variables are used to maintain information about
1323 ;; current section adornment in a buffer local cache. Thus they can be used for
1324 ;; font-locking and manipulation commands.
1327 "All section adornments in the buffer as found by `rst-find-all-adornments'.
1331 ;; FIXME: If this variable is set to a different value font-locking of section
1332 ;; headers is wrong.
1334 "Section hierarchy in the buffer as determined by `rst-get-hierarchy'.
1335 t when no section adornments were found. Value depends on
1341 "Reset all section cache variables.
1342 Should be called by interactive functions which deal with sections."
1344 rst-section-hierarchy nil))
1347 "Return all the section adornments in the current buffer.
1348 Return a list of (LINE . ADORNMENT) with ascending LINE where
1349 LINE is the line containing the section title. ADORNMENT consists
1350 of a (CHARACTER STYLE INDENT) triple as described for
1351 `rst-preferred-adornments'.
1353 Uses and sets `rst-all-sections'."
1356 ;; Iterate over all the section titles/adornments in the file.
1370 positions)
1375 nil
1376 rst-all-sections))
1379 "Build a hierarchy of adornments using the list of given ADORNMENTS.
1381 ADORNMENTS is a list of (CHARACTER STYLE INDENT) adornment
1382 specifications, in order that they appear in a file, and will
1383 infer a hierarchy of section levels by removing adornments that
1384 have already been seen in a forward traversal of the adornments,
1385 comparing just CHARACTER and STYLE.
1387 Similarly returns a list of (CHARACTER STYLE INDENT), where each
1388 list element should be unique."
1398 "Return the hierarchy of section titles in the file.
1400 Return a list of adornments that represents the hierarchy of
1401 section titles in the file. Each element consists of (CHARACTER
1402 STYLE INDENT) as described for `rst-find-all-adornments'. If the
1403 line number in IGNORE is specified, a possibly adornment found on
1404 that line is not taken into account when building the hierarchy.
1406 Uses and sets `rst-section-hierarchy' unless IGNORE is given."
1409 nil
1410 rst-section-hierarchy)
1414 ignore
1418 ;; Clear cache reflecting that a possible update is not
1419 ;; reflected.
1420 nil
1422 r)))
1425 "Return the adornments around point.
1426 Return a list of the previous and next adornments."
1429 prev next
1432 ;; Search for the adornments around the current line.
1436 ;; 'cur' is the following adornment.
1444 "Return true if the adornment ADO around point is complete."
1445 ;; Note: we assume that the detection of the overline as being the underline
1446 ;; of a preceding title has already been detected, and has been eliminated
1447 ;; from the adornment that is given to us.
1449 ;; There is some sectioning already present, so check if the current
1450 ;; sectioning is complete and correct.
1469 "Get the next adornment for CURADO, in given hierarchy HIER.
1470 If suggesting, suggest for new adornment SUGGESTION.
1471 REVERSE-DIRECTION is used to reverse the cycling order."
1477 ;; Build a new list of adornments for the rotation.
1480 ;; Suggest a new adornment.
1482 ;; If nothing to suggest, use first adornment.
1485 ;; Search for next adornment.
1493 cur))
1495 ;; If not found, take the first of all adornments.
1496 suggestion)))
1499 ;; FIXME: A line "``/`` full" is not accepted as a section title.
1501 "Auto-adjust the adornment around point.
1503 Adjust/rotate the section adornment for the section title around
1504 point or promote/demote the adornments inside the region,
1505 depending on if the region is active. This function is meant to
1506 be invoked possibly multiple times, and can vary its behavior
1507 with a positive PFXARG (toggle style), or with a negative
1508 PFXARG (alternate behavior).
1510 This function is a bit of a swiss knife. It is meant to adjust
1511 the adornments of a section title in reStructuredText. It tries
1512 to deal with all the possible cases gracefully and to do `the
1513 right thing' in all cases.
1515 See the documentations of `rst-adjust-adornment-work' and
1516 `rst-promote-region' for full details.
1518 Prefix Arguments
1519 ================
1521 The method can take either (but not both) of
1523 a. a (non-negative) prefix argument, which means to toggle the
1524 adornment style. Invoke with a prefix argument for example;
1526 b. a negative numerical argument, which generally inverts the
1527 direction of search in the file or hierarchy. Invoke with C--
1528 prefix for example."
1538 ;; Adjust adornments within region.
1540 ;; Adjust adornment around point.
1543 ;; Run the hooks to run after adjusting.
1546 ;; Make sure to reset the cursor position properly after we're done.
1550 "Hooks to be run after running `rst-adjust'."
1557 "Controls level of new adornment for section headers."
1566 "Call `rst-adjust-adornment-work' interactively.
1568 Keep this for compatibility for older bindings (are there any?).
1569 Argument PFXARG has the same meaning as for `rst-adjust'."
1577 "Adjust/rotate the section adornment for the section title around point.
1579 This function is meant to be invoked possibly multiple times, and
1580 can vary its behavior with a true TOGGLE-STYLE argument, or with
1581 a REVERSE-DIRECTION argument.
1583 General Behavior
1584 ================
1586 The next action it takes depends on context around the point, and
1587 it is meant to be invoked possibly more than once to rotate among
1588 the various possibilities. Basically, this function deals with:
1590 - adding a adornment if the title does not have one;
1592 - adjusting the length of the underline characters to fit a
1593 modified title;
1595 - rotating the adornment in the set of already existing
1596 sectioning adornments used in the file;
1598 - switching between simple and over-and-under styles.
1600 You should normally not have to read all the following, just
1601 invoke the method and it will do the most obvious thing that you
1602 would expect.
1605 Adornment Definitions
1606 =====================
1608 The adornments consist in
1610 1. a CHARACTER
1612 2. a STYLE which can be either of 'simple' or 'over-and-under'.
1614 3. an INDENT (meaningful for the over-and-under style only)
1615 which determines how many characters and over-and-under
1616 style is hanging outside of the title at the beginning and
1617 ending.
1619 See source code for mode details.
1622 Detailed Behavior Description
1623 =============================
1625 Here are the gory details of the algorithm (it seems quite
1626 complicated, but really, it does the most obvious thing in all
1627 the particular cases):
1629 Before applying the adornment change, the cursor is placed on
1630 the closest line that could contain a section title.
1632 Case 1: No Adornment
1633 --------------------
1635 If the current line has no adornment around it,
1637 - search backwards for the last previous adornment, and apply
1638 the adornment one level lower to the current line. If there
1639 is no defined level below this previous adornment, we suggest
1640 the most appropriate of the `rst-preferred-adornments'.
1642 If REVERSE-DIRECTION is true, we simply use the previous
1643 adornment found directly.
1645 - if there is no adornment found in the given direction, we use
1646 the first of `rst-preferred-adornments'.
1648 TOGGLE-STYLE forces a toggle of the prescribed adornment style.
1650 Case 2: Incomplete Adornment
1651 ----------------------------
1653 If the current line does have an existing adornment, but the
1654 adornment is incomplete, that is, the underline/overline does
1655 not extend to exactly the end of the title line (it is either too
1656 short or too long), we simply extend the length of the
1657 underlines/overlines to fit exactly the section title.
1659 If TOGGLE-STYLE we toggle the style of the adornment as well.
1661 REVERSE-DIRECTION has no effect in this case.
1663 Case 3: Complete Existing Adornment
1664 -----------------------------------
1666 If the adornment is complete (i.e. the underline (overline)
1667 length is already adjusted to the end of the title line), we
1668 search/parse the file to establish the hierarchy of all the
1669 adornments (making sure not to include the adornment around
1670 point), and we rotate the current title's adornment from within
1671 that list (by default, going *down* the hierarchy that is present
1672 in the file, i.e. to a lower section level). This is meant to be
1673 used potentially multiple times, until the desired adornment is
1674 found around the title.
1676 If we hit the boundary of the hierarchy, exactly one choice from
1677 the list of preferred adornments is suggested/chosen, the first
1678 of those adornment that has not been seen in the file yet (and
1679 not including the adornment around point), and the next
1680 invocation rolls over to the other end of the hierarchy (i.e. it
1681 cycles). This allows you to avoid having to set which character
1682 to use.
1684 If REVERSE-DIRECTION is true, the effect is to change the
1685 direction of rotation in the hierarchy of adornments, thus
1686 instead going *up* the hierarchy.
1688 However, if TOGGLE-STYLE, we do not rotate the adornment, but
1689 instead simply toggle the style of the current adornment (this
1690 should be the most common way to toggle the style of an existing
1691 complete adornment).
1694 Point Location
1695 ==============
1697 The invocation of this function can be carried out anywhere
1698 within the section title line, on an existing underline or
1699 overline, as well as on an empty line following a section title.
1700 This is meant to be as convenient as possible.
1703 Indented Sections
1704 =================
1706 Indented section titles such as ::
1708 My Title
1709 --------
1711 are invalid in reStructuredText and thus not recognized by the
1712 parser. This code will thus not work in a way that would support
1713 indented sections (it would be ambiguous anyway).
1716 Joint Sections
1717 ==============
1719 Section titles that are right next to each other may not be
1720 treated well. More work might be needed to support those, and
1721 special conditions on the completeness of existing adornments
1722 might be required to make it non-ambiguous.
1724 For now we assume that the adornments are disjoint, that is,
1725 there is at least a single line between the titles/adornment
1726 lines."
1738 char-new style-new indent-new)
1740 ;;-------------------------------------------------------------------
1741 ;; Case 1: No valid adornment
1744 cur
1746 ;; Advance one level down.
1752 prev
1756 ;; Invert the style if requested.
1763 ;;-------------------------------------------------------------------
1764 ;; Case 2: Incomplete Adornment
1766 ;; Invert the style if requested.
1770 style-new style
1771 indent-new indent))
1772 ;;-------------------------------------------------------------------
1773 ;; Case 3: Complete Existing Adornment
1776 ;; Simply switch the style of the current adornment.
1779 indent-new rst-default-indent)
1780 ;; Else, we rotate, ignoring the adornment around the current
1781 ;; line...
1783 ;; Suggestion, in case we need to come up with something new.
1785 hier
1788 curado hier suggestion reverse-direction)))
1789 ;; Indent, if present, always overrides the prescribed indent.
1793 ;; Override indent with present indent!
1797 ;; Correct the position of the cursor to more accurately reflect where
1798 ;; it was located when the function was invoked.
1803 ;; Maintain an alias for compatibility.
1808 "Promote the section titles within the region.
1810 With argument DEMOTE or a prefix argument, demote the section
1811 titles instead. The algorithm used at the boundaries of the
1812 hierarchy is similar to that used by `rst-adjust-adornment-work'."
1822 marker-list)
1824 ;; Skip the markers that come before the region beginning.
1828 ;; Create a list of markers for all the adornments which are found within
1829 ;; the region.
1838 ;; Apply modifications.
1840 ;; Go to the adornment to promote.
1843 ;; Update the adornment.
1845 ;; Rotate the next adornment.
1849 ;; Clear marker to avoid slowing down the editing after we're done.
1856 "Display the current file's section title adornments hierarchy.
1857 This function expects a list of (CHARACTER STYLE INDENT) triples
1858 in ADORNMENTS."
1874 "Redo all the adornments in the current buffer.
1875 This is done using our preferred set of adornments. This can be
1876 used, for example, when using somebody else's copy of a document,
1877 in order to adapt it to our preferred style."
1892 ;; Go to the appropriate position.
1895 ;; Apply the new style.
1898 ;; Reset the marker to avoid slowing down editing until it gets GC'ed.
1901 \f
1902 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1903 ;; Insert list items
1904 ;; =================
1907 ;=================================================
1908 ; Borrowed from a2r.el (version 1.3), by Lawrence Mitchell <wence@gmx.li>.
1909 ; I needed to make some tiny changes to the functions, so I put it here.
1910 ; -- Wei-Wei Guo
1920 "Convert Arabic number NUM to its Roman numeral representation.
1922 Obviously, NUM must be greater than zero. Don't blame me, blame the
1924 apologies to Monty Python).
1925 If optional prefix ARG is non-nil, insert in current buffer."
1927 res)
1934 res))
1937 "Convert STRING of Roman numerals to an Arabic number.
1939 If STRING contains a letter which isn't a valid Roman numeral, the rest
1940 of the string from that point onwards is ignored.
1942 Hence:
1943 MMD == 2500
1944 and
1945 MMDFLXXVI == 2500.
1946 If optional ARG is non-nil, insert in current buffer."
1954 res))
1955 ;=================================================
1958 "Find all the positions of prefixes in region between BEG and END.
1959 This is used to find bullets and enumerated list items. PFX-RE is
1960 a regular expression for matching the lines after indentation
1961 with items. Returns a list of cons cells consisting of the point
1962 and the column of the point."
1979 pfx))
1984 "Arrange relative position of a newly inserted list item of style NEWITEM.
1986 Adding a new list might consider three situations:
1988 (a) Current line is a blank line.
1989 (b) Previous line is a blank line.
1990 (c) Following line is a blank line.
1992 When (a) and (b), just add the new list at current line.
1994 when (a) and not (b), a blank line is added before adding the new list.
1996 When not (a), first forward point to the end of the line, and add two
1997 blank lines, then add the new list.
1999 Other situations are just ignored and left to users themselves."
2011 ;; FIXME: Isn't this a `defconst'?
2020 ;; FIXME: Isn't this a `defconst'?
2026 "Insert a new list item.
2028 User is asked to select the item style first, for example (a), i), +. Use TAB
2029 for completion and choices.
2031 If user selects bullets or #, it's just added with position arranged by
2032 `rst-insert-list-pos'.
2034 If user selects enumerations, a further prompt is given. User need to input a
2035 starting item, for example 'e' for 'A)' style. The position is also arranged by
2036 `rst-insert-list-pos'."
2038 ;; FIXME: Make this comply to `interactive' standards.
2040 "Select preferred item style [#.]: "
2046 ;; FIXME: Make this comply to `interactive' standards.
2071 "List of favorite bullets."
2077 rst-bullets)))
2082 "Insert a list item with list start CURITEM including its indentation level.
2083 If PREFER-ROMAN roman numbering is preferred over using letters."
2090 curitem)
2094 nil nil curitem))
2099 ;; FIXME: Assumes one line list items without separating
2100 ;; empty lines.
2117 t nil curitem))
2121 nil nil curitem)))))
2125 "Insert a list item at the current point.
2127 The command can insert a new list or a continuing list. When it is called at a
2128 non-list line, it will promote to insert new list. When it is called at a list
2129 line, it will insert a list with the same list style.
2131 1. When inserting a new list:
2133 User is asked to select the item style first, for example (a), i), +. Use TAB
2134 for completion and choices.
2136 (a) If user selects bullets or #, it's just added.
2137 (b) If user selects enumerations, a further prompt is given. User needs to
2138 input a starting item, for example 'e' for 'A)' style.
2140 The position of the new list is arranged according to whether or not the
2141 current line and the previous line are blank lines.
2143 2. When continuing a list, one thing need to be noticed:
2145 List style alphabetical list, such as 'a.', and roman numerical list, such as
2146 'i.', have some overlapping items, for example 'v.' The function can deal with
2147 the problem elegantly in most situations. But when those overlapped list are
2148 preceded by a blank line, it is hard to determine which type to use
2149 automatically. The function uses alphabetical list by default. If you want
2150 roman numerical list, just use a prefix to set PREFER-ROMAN."
2158 "Make all the bulleted list items in the region consistent.
2159 The region is specified between BEG and END. You can use this
2160 after you have merged multiple bulleted lists to make them use
2161 the same/correct/consistent bullet characters.
2163 See variable `rst-preferred-bullets' for the list of bullets to
2164 adjust. If bullets are found on levels beyond the
2165 `rst-preferred-bullets' list, they are not modified."
2171 ;; Create a map of levels to list of positions.
2177 levtable)))
2179 ;; Sort this map and create a new map of prefix char and list of positions.
2186 ;; Apply the characters.
2193 \f
2194 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2195 ;; Table of contents
2196 ;; =================
2198 ;; FIXME: Return value should be a `defstruct'.
2200 "Return the hierarchical tree of section titles.
2201 A tree entry looks like ((TITLE MARKER) CHILD...). TITLE is the
2202 stripped text of the section title. MARKER is a marker for the
2203 beginning of the title text. For the top node or a missing
2204 section level node TITLE is nil and MARKER points to the title
2205 text of the first child. Each CHILD is another tree entry. The
2206 CHILD list may be empty."
2209 lev-ttl-mrk-l)
2213 ;; Compare just the character and indent in the hash table.
2217 ;; Create a list that contains (LEVEL TITLE MARKER) for each adornment.
2225 ;; Get title.
2236 ;; FIXME: Return value should be a `defstruct'.
2238 "Process the first entry of REMAINING expected to be on level LEV.
2239 REMAINING is the remaining list of adornments consisting
2240 of (LEVEL TITLE MARKER) entries.
2242 Return (UNPROCESSED (TITLE MARKER) CHILD...) for the first entry
2243 of REMAINING where TITLE is nil if the expected level is not
2244 matched. UNPROCESSED is the list of still unprocessed entries.
2245 Each CHILD is a child of this entry in the same format but
2246 without UNPROCESSED."
2249 ttl-mrk children)
2250 ;; If the current adornment matches expected level.
2252 ;; Consume the current entry and create the current node with it.
2256 ;; Build the child nodes as long as they have deeper level.
2265 ;; Node on this level missing - use nil as text and the
2266 ;; marker of the first child.
2268 children))))
2271 "Return section containing POINT by returning the closest node in TREE.
2272 TREE is a section tree as returned by `rst-section-tree'
2273 consisting of (NODE CHILD...) entries. POINT defaults to the
2274 current point. A NODE must have the structure (IGNORED MARKER
2275 ...).
2277 Return (PATH NODE CHILD...). NODE is the node where POINT is in
2278 if any. PATH is a list of nodes from the top of the tree down to
2279 and including NODE. List of CHILD are the children of NODE if
2280 any."
2284 ;; Point behind current node?
2286 ;; Iterate all the children, looking for one that might contain the
2287 ;; current section.
2293 ;; Found section containing point in children.
2295 ;; Extend path with current node and return NODE CHILD... from
2296 ;; sub.
2298 ;; Point in this section: Start a new path with current node and
2299 ;; return current NODE CHILD...
2301 ;; Current node behind point: start a new path with current node and
2302 ;; no NODE CHILD...
2306 "Settings for reStructuredText table of contents."
2311 "Indentation for table-of-contents display.
2312 Also used for formatting insertion, when numbering is disabled."
2318 "Insertion style for table-of-contents.
2319 Set this to one of the following values to determine numbering and
2320 indentation style:
2321 - plain: no numbering (fixed indentation)
2322 - fixed: numbering, but fixed indentation
2323 - aligned: numbering, titles aligned under each other
2324 - listed: numbering, with dashes like list items (EXPERIMENTAL)"
2333 "Separator that goes between the TOC number and the title."
2338 ;; This is used to avoid having to change the user's mode.
2342 map)
2346 "If non-nil, maximum depth of the inserted TOC."
2352 "Insert a simple text rendering of the table of contents.
2353 By default the top level is ignored if there is only one, because
2354 we assume that the document will have a single title.
2356 If a numeric prefix argument PFXARG is given, insert the TOC up
2357 to the specified level.
2359 The TOC is inserted indented at the current column."
2367 ;; Get the section tree for the current cursor point.
2372 ;; Figure out initial indent.
2379 ;; Fixup for the first line.
2382 ;; Delete the last newline added.
2386 "Insert tree node NODE in table-of-contents.
2387 Recursive function that does printing of the inserted toc.
2388 LEVEL is the depth level of the sections in the tree.
2389 INDENT is the indentation string. PFX is the prefix numbering,
2390 that includes the alignment necessary for all the children of
2391 level to align."
2393 ;; Note: we do child numbering from the parent, so we start number the
2394 ;; children one level before we print them.
2403 ;; Add properties to the text, even though in normal text mode it
2404 ;; won't be doing anything for now. Not sure that I want to change
2405 ;; mode stuff. At least the highlighting gives the idea that this
2406 ;; is generated automatically.
2412 ;; Prepare indent for children.
2431 fmt)
2434 ;; Add a separating dot if there is already a prefix.
2439 ;; Calculate the amount of space that the prefix will require
2440 ;; for the numbers.
2449 indent
2456 "Automatically find the contents section of a document and update.
2457 Updates the inserted TOC if present. You can use this in your
2458 file-write hook to always make it up-to-date automatically."
2461 ;; Find and delete an existing comment after the first contents directive.
2462 ;; Delete that region.
2464 ;; We look for the following and the following only (in other words, if your
2465 ;; syntax differs, this won't work.).
2466 ;;
2467 ;; .. contents:: [...anything here...]
2468 ;; [:field: value]...
2469 ;; ..
2470 ;; XXXXXXXX
2471 ;; XXXXXXXX
2472 ;; [more lines]
2476 last-real)
2478 ;; Look for the first line that starts at the first column.
2495 ;; Note: always return nil, because this may be used as a hook.
2496 nil)
2498 ;; Note: we cannot bind the TOC update on file write because it messes with
2499 ;; undo. If we disable undo, since it adds and removes characters, the
2500 ;; positions in the undo list are not making sense anymore. Dunno what to do
2501 ;; with this, it would be nice to update when saving.
2502 ;;
2503 ;; (add-hook 'write-contents-hooks 'rst-toc-update-fun)
2504 ;; (defun rst-toc-update-fun ()
2505 ;; ;; Disable undo for the write file hook.
2506 ;; (let ((buffer-undo-list t)) (rst-toc-update) ))
2510 ;;------------------------------------------------------------------------------
2513 "Recursive function that does insert NODE at LEVEL in the table-of-contents."
2517 ;; Insert line text.
2521 ;; Highlight lines.
2524 ;; Add link on lines.
2533 "Count the number of lines from NODE to the TARGET-NODE node.
2534 This recursive function returns a cons of the number of
2535 additional lines that have been counted for its node and
2536 children, and t if the node has been found."
2539 found)
2558 "Display a table-of-contents.
2559 Finds all the section titles and their adornments in the
2560 file, and displays a hierarchically-organized list of the
2561 titles, which is essentially a table-of-contents of the
2562 document.
2564 The Emacs buffer can be navigated, and selecting a section
2565 brings the cursor in that section."
2572 line
2574 ;; Create a temporary buffer.
2586 ;; Count the lines to our found node.
2592 ;; Save the buffer to return to.
2595 ;; Move the cursor near the right section in the TOC.
2601 "Get the section from text property at point."
2607 pos))
2609 ;; FIXME: Cursor before or behind the list must be handled properly; before the
2610 ;; list should jump to the top and behind the list to the last normal
2611 ;; paragraph.
2613 "Go to the section the current line describes.
2614 If KILL a toc buffer is destroyed."
2618 ;; FIXME: This should rather go to `rst-toc-mode-goto-section'.
2623 ;; FIXME: make the recentering conditional on scroll.
2627 "Go to the section the current line describes and kill the TOC buffer."
2632 "In `rst-toc' mode, go to the occurrence whose line you click on.
2633 EVENT is the input event."
2645 "Same as `rst-toc-mode-mouse-goto', but kill TOC buffer as well.
2646 EVENT is the input event."
2652 "Leave the current TOC buffer."
2666 map)
2671 ;; Could inherit from the new `special-mode'.
2676 ;; Note: use occur-mode (replace.el) as a good example to complete missing
2677 ;; features.
2679 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2680 ;; Section movement commands
2681 ;; =========================
2684 "Skip to the next reStructuredText section title.
2685 OFFSET specifies how many titles to skip. Use a negative OFFSET to move
2686 backwards in the file (default is to use 1)."
2692 ;; Get all the adornments in the file, with their line numbers.
2695 ;; Get the current line.
2701 ;; Find the index of the "next" adornment w.r.t. to the current line.
2705 ;; 'cur' is the adornment on or following the current line.
2710 ;; Find the final index.
2714 ;; If the index is positive, goto the line, otherwise go to the buffer
2715 ;; boundaries.
2723 "Like `rst-forward-section', except move back one title."
2727 ;; FIXME: What is `allow-extend' for?
2729 "Select COUNT sections around point.
2730 Mark following sections for positive COUNT or preceding sections
2731 for negative COUNT."
2732 ;; Cloned from mark-paragraph.
2750 \f
2751 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2752 ;; Functions to work on item lists (e.g. indent/dedent, enumerate), which are
2753 ;; always 2 or 3 characters apart horizontally with rest.
2756 "Return the leftmost column in region BEG to END."
2767 mincol))
2769 ;; FIXME: This definition is old and deprecated. We need to move to the newer
2770 ;; version below.
2773 ;; FIXME: The following comment is pretty useless.
2774 "Call FUN at the beginning of each line, with an argument that
2775 specifies whether we are at the first line of a paragraph that
2776 starts at the leftmost column of the given region BEG and END.
2777 Set FIRST-ONLY to true if you want to callback on the first line
2778 of each paragraph only."
2800 valid)
2801 ,body-consequent
2804 ;; FIXME: This needs to be refactored. Probably this is simply a function
2805 ;; applying BODY rather than a macro.
2807 "Evaluate BODY for each line in region defined by BEG END.
2808 LEFTMOST is set to true if the line is one of the leftmost of the
2809 entire paragraph. PARABEGIN is set to true if the line is the
2810 first of a paragraph."
2840 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2841 ;; Indentation
2843 ;; FIXME: At the moment only block comments with leading empty comment line are
2844 ;; supported. Comment lines with leading comment markup should be also
2845 ;; supported. May be a customizable option could control which style to
2846 ;; prefer.
2850 In reStructuredText indentation points are usually determined by
2851 preceding lines. Sometimes the syntax allows arbitrary
2852 indentation points such as where to start the first line
2853 following a directive. These indentation widths can be customized
2854 here."
2861 "Indentation when there is no more indentation point given."
2867 "Indentation for first line after a field or 0 to always indent for content."
2874 "Default indentation for literal block after a markup on an own line."
2881 "Default indentation for literal block after a minimized markup."
2888 "Default indentation for first line of a comment."
2894 ;; FIXME: Must consider other tabs:
2895 ;; * Line blocks
2896 ;; * Definition lists
2897 ;; * Option lists
2899 "Return tabs of the current line or nil for no tab.
2900 The list is sorted so the tab where writing continues most likely
2901 is the first one. Each tab is of the form (COLUMN . INNER).
2902 COLUMN is the column of the tab. INNER is non-nil if this is an
2903 inner tab. I.e. a tab which does come from the basic indentation
2904 and not from inner alignment points."
2910 ;; Current indentation is always the least likely tab.
2912 ;; Push inner tabs more likely to continue writing.
2914 ;; Item.
2918 ;; Field.
2929 ;; Directive.
2936 ;; Footnote or citation definition.
2941 ;; Comment.
2944 ;; Start of literal block.
2950 rst-indent-literal-minimized
2951 rst-indent-literal-normal))
2956 tabs))))))
2959 "Build the list of possible tabs for all lines above.
2960 Search backwards from point PT to build the list of possible
2961 tabs. Return a list of tabs sorted by likeliness to continue
2962 writing like `rst-line-tabs'. Nearer lines have generally a
2963 higher likeliness than farther lines. Return nil if no tab is found
2964 in the text above."
2968 innermost ; Leftmost column for inner tab.
2969 tablist)
2976 ;; Consider only lines indented less or same if not INNERMOST.
2994 leftcol
2995 innermost))
3000 "Indent current line to next best reStructuredText tab.
3001 The next best tab is taken from the tab list returned by
3002 `rst-compute-tabs' which is used in a cyclic manner. If the
3003 current indentation does not end on a tab use the first one. If
3004 the current indentation is on a tab use the next tab. This allows
3006 possible tabs. If no indentation is possible return `noindent' or
3007 use DFLT. Return the indentation indented to. When point is in
3008 indentation it ends up at its end. Otherwise the point is kept
3009 relative to the content."
3015 ind)
3017 'noindent
3030 ind)))
3033 "Shift region BEG to END by CNT tabs.
3034 Shift by one tab to the right (CNT > 0) or left (CNT < 0) or
3035 remove all indentation (CNT = 0). A tab is taken from the text
3036 above. If no suitable tab is found `rst-indent-width' is used."
3041 ;; Apply the indent.
3043 beg end
3046 ;; Find the next tab after the leftmost column.
3052 ;; Get the position of the first tab beyond leftmostcol.
3057 tabs)))
3058 ;; Virtual position of tab.
3061 ;; Tab exists - use it.
3063 ;; Column needs to be computed.
3065 ;; Base on last known column.
3067 dir ; Direction to take.
3068 rst-indent-width))))
3072 ;; FIXME: A paragraph with an (incorrectly) indented second line is not filled
3073 ;; correctly::
3074 ;;
3075 ;; Some start
3076 ;; continued wrong
3078 "Return fill prefix found at point.
3079 Value for `adaptive-fill-function'."
3084 ;; An non-comment prefix is fine.
3085 fnd
3086 ;; Matches a comment - return whitespace instead.
3095 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3096 ;; Comments
3099 "Break line and indent, continuing reStructuredText comment if within one.
3100 Value for `comment-line-break-function'. If SOFT use soft
3101 newlines as mandated by `comment-line-break-function'."
3114 "Return indentation for current comment line."
3118 "Insert a comment in the current line."
3123 "Comment or uncomment the current region.
3124 Region is from from BEG to END. Uncomment if ARG."
3130 bol)
3140 "Uncomment the current region.
3141 Region is from BEG to END. ARG is ignored"
3152 ;;------------------------------------------------------------------------------
3154 ;; FIXME: These next functions should become part of a larger effort to redo
3155 ;; the bullets in bulleted lists. The enumerate would just be one of
3156 ;; the possible outputs.
3157 ;;
3158 ;; FIXME: We need to do the enumeration removal as well.
3161 "Add enumeration to all the leftmost paragraphs in the given region.
3162 The region is specified between BEG and END. With ALL,
3163 do all lines instead of just paragraphs."
3175 "Add bullets to all the leftmost paragraphs in the given region.
3176 The region is specified between BEG and END. With ALL,
3177 do all lines instead of just paragraphs."
3184 ;; FIXME: Does not deal with a varying number of digits appropriately.
3185 ;; FIXME: Does not deal with multiple levels independently.
3186 ;; FIXME: Does not indent a multiline item correctly.
3188 "Convert the bulleted and enumerated items in the region to enumerated lists.
3189 Renumber as necessary. Region is from BEG to END."
3205 ;;------------------------------------------------------------------------------
3208 "Toggle line block prefixes for a region.
3209 Region is from RBEG to REND. With PFXARG set the empty lines too."
3224 \f
3225 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3226 ;; Font lock
3227 ;; =========
3231 ;; FIXME: The obsolete variables need to disappear.
3233 ;; The following versions have been done inside Emacs and should not be
3234 ;; replaced by `:package-version' attributes until a change.
3242 "Face used for all syntax marking up a special block."
3247 "All syntax marking up a special block."
3253 "customize the face `rst-block' instead."
3257 "Face used for field names and interpreted text."
3262 "Field names and interpreted text."
3268 "customize the face `rst-external' instead."
3272 "Face used for all other defining constructs."
3277 "All other defining constructs."
3283 "customize the face `rst-definition' instead."
3286 ;; XEmacs compatibility (?).
3290 "Face used for directives and roles."
3295 "Directives and roles."
3300 "customize the face `rst-directive' instead."
3304 "Face used for comments."
3309 "Comments."
3315 "customize the face `rst-comment' instead."
3319 "Face used for simple emphasis."
3324 "Simple emphasis."
3330 "customize the face `rst-emphasis1' instead."
3334 "Face used for double emphasis."
3339 "Double emphasis."
3344 "customize the face `rst-emphasis2' instead."
3348 "Face used for literal text."
3353 "Literal text."
3359 "customize the face `rst-literal' instead."
3363 "Face used for references to a definition."
3368 "References to a definition."
3374 "customize the face `rst-reference' instead."
3378 "Face used for a transition."
3383 "Face used for the adornment of a section header."
3387 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3390 rst-level-face-base-light
3391 rst-level-face-format-light
3392 rst-level-face-step-light
3393 rst-level-1-face
3394 rst-level-2-face
3395 rst-level-3-face
3396 rst-level-4-face
3397 rst-level-5-face
3398 rst-level-6-face))
3402 ;; Define faces for the first 6 levels. More levels are possible, however.
3405 "Default face for section title text at level 1."
3410 "Default face for section title text at level 2."
3415 "Default face for section title text at level 3."
3420 "Default face for section title text at level 4."
3425 "Default face for section title text at level 5."
3430 "Default face for section title text at level 6."
3442 "Faces for the various adornment types.
3443 Key is a number (for the section title text of that level
3444 starting with 1), t (for transitions) or nil (for section title
3445 adornment). If you need levels beyond 6 you have to define faces
3446 of your own."
3449 :key-type
3457 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3460 ;; The reST-links in the comments below all relate to sections in
3461 ;; http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html.
3463 ;; start.
3465 ;; Simple `Body Elements`_
3466 ;; `Bullet Lists`_
3467 ;; FIXME: A bullet directly after a field name is not recognized.
3470 ;; `Enumerated Lists`_
3473 ;; `Definition Lists`_
3474 ;; FIXME: missing.
3475 ;; `Field Lists`_
3478 ;; `Option Lists`_
3482 ;; `Line Blocks`_
3483 ;; Only for lines containing no more bar - to distinguish from tables.
3487 ;; `Tables`_
3488 ;; FIXME: missing
3490 ;; All the `Explicit Markup Blocks`_
3491 ;; `Footnotes`_ / `Citations`_
3495 ;; `Directives`_ / `Substitution Definitions`_
3500 ;; `Hyperlink Targets`_
3510 ;; All `Inline Markup`_
3511 ;; Most of them may be multiline though this is uninteresting.
3513 ;; FIXME: Condition 5 preventing fontification of e.g. "*" not implemented
3514 ;; `Strong Emphasis`_.
3517 ;; `Emphasis`_
3520 ;; `Inline Literals`_
3523 ;; `Inline Internal Targets`_
3526 ;; `Hyperlink References`_
3527 ;; FIXME: `Embedded URIs`_ not considered.
3528 ;; FIXME: Directly adjacent marked up words are not fontified correctly
3529 ;; unless they are not separated by two spaces: foo_ bar_.
3534 ;; `Interpreted Text`_
3541 ;; `Footnote References`_ / `Citation References`_
3544 ;; `Substitution References`_
3545 ;; FIXME: References substitutions like |this|_ or |this|__ are not
3546 ;; fontified correctly.
3549 ;; `Standalone Hyperlinks`_
3550 ;; FIXME: This takes it easy by using a whitespace as delimiter.
3556 ;; Do all block fontification as late as possible so 'append works.
3558 ;; Sections_ / Transitions_
3559 ;; For sections this is multiline.
3564 nil
3570 ;; FIXME: FACESPEC could be used instead of ordinary faces to set
3571 ;; properties on comments and literal blocks so they are *not*
3572 ;; inline fontified. See (elisp)Search-based Fontification.
3574 ;; FIXME: And / or use `syntax-propertize` functions as in `octave-mod.el`
3575 ;; and other V24 modes. May make `font-lock-extend-region`
3576 ;; superfluous.
3578 ;; `Comments`_
3579 ;; This is multiline.
3584 nil
3591 nil
3594 ;; FIXME: This is not rendered as comment::
3595 ;; .. .. list-table::
3596 ;; :stub-columns: 1
3597 ;; :header-rows: 1
3599 ;; FIXME: This is rendered wrong::
3600 ;;
3601 ;; xxx yyy::
3602 ;;
3603 ;; ----|> KKKKK <|----
3604 ;; / \
3605 ;; -|> AAAAAAAAAAPPPPPP <|- -|> AAAAAAAAAABBBBBBB <|-
3606 ;; | | | |
3607 ;; | | | |
3608 ;; PPPPPP PPPPPPDDDDDDD BBBBBBB PPPPPPBBBBBBB
3609 ;;
3610 ;; Indentation needs to be taken from the line with the ``::`` and not from
3611 ;; the first content line.
3613 ;; `Indented Literal Blocks`_
3614 ;; This is multiline.
3619 nil
3622 ;; FIXME: `Quoted Literal Blocks`_ missing.
3623 ;; This is multiline.
3625 ;; `Doctest Blocks`_
3626 ;; FIXME: This is wrong according to the specification:
3627 ;;
3628 ;; Doctest blocks are text blocks which begin with ">>> ", the Python
3629 ;; interactive interpreter main prompt, and end with a blank line.
3630 ;; Doctest blocks are treated as a special case of literal blocks,
3631 ;; without requiring the literal block syntax. If both are present, the
3632 ;; literal block syntax takes priority over Doctest block syntax:
3633 ;;
3634 ;; This is an ordinary paragraph.
3635 ;;
3636 ;; >>> print 'this is a Doctest block'
3637 ;; this is a Doctest block
3638 ;;
3639 ;; The following is a literal block::
3640 ;;
3641 ;; >>> This is not recognized as a doctest block by
3642 ;; reStructuredText. It *will* be recognized by the doctest
3643 ;; module, though!
3644 ;;
3645 ;; Indentation is not required for doctest blocks.
3655 "Extend the font-lock region if it might be in a multi-line construct.
3656 Return non-nil if so. Font-lock region is from `font-lock-beg'
3657 to `font-lock-end'."
3662 t)))
3665 "Check the region BEG / END for being in the middle of a multi-line construct.
3666 Return nil if not or a cons with new values for BEG / END"
3673 "Like `forward-line' but always end up in column 0 and return accordingly.
3674 Move N lines forward just as `forward-line'."
3677 moved
3681 ;; FIXME: If a single line is made a section header by `rst-adjust' the header
3682 ;; is not always fontified immediately.
3684 "Extend the region starting at point PT and extending in direction DIR.
3685 Return extended point or nil if not moved."
3686 ;; There are many potential multiline constructs but there are two groups
3687 ;; which are really relevant. The first group consists of
3688 ;;
3689 ;; * comment lines without leading explicit markup tag and
3690 ;;
3691 ;; * literal blocks following "::"
3692 ;;
3693 ;; which are both indented. Thus indentation is the first thing recognized
3694 ;; here. The second criteria is an explicit markup tag which may be a comment
3695 ;; or a double colon at the end of a line.
3696 ;;
3697 ;; The second group consists of the adornment cases.
3699 ;; Move only if we don't start inside a multiline construct already.
3702 ;; block tag.
3706 ;; The comments below are for dir == -1 / dir == 1.
3712 ; line if it exists.
3714 ; overline.
3717 ; underline / overline
3718 ; found.
3722 ; overline /
3723 ; underline.
3725 ; / adornment.
3732 ; underline.
3737 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3738 ;; Indented blocks
3741 "Move forward across one indented block.
3742 Find the next non-empty line which is not indented at least to COLUMN (defaults
3743 to the column of the point). Moves point to first character of this line or the
3744 first empty line immediately before it and returns that position. If there is
3745 no such line before LIMIT (defaults to the end of the buffer) returns nil and
3746 point is not moved."
3750 fnd beg cand)
3761 ;; FIXME: No indentation [(zerop clm)] must be handled in some
3762 ;; useful way - though it is not clear what this should mean
3763 ;; at all.
3770 fnd))
3776 "End of the match as determined by `rst-font-lock-find-unindented-line-limit'.
3777 Also used as a trigger for
3781 "Find the next unindented line relative to indentation at IND-PNT.
3782 Return this point, the end of the buffer or nil if nothing found.
3783 If IND-PNT is `next' take the indentation from the next line if
3784 this is not empty and indented more than the current one. If
3785 IND-PNT is non-nil but not a number take the indentation from the
3786 next non-empty line if this is indented more than the current
3787 one."
3792 ;; Find indentation point in next line if any.
3794 ;; FIXME: Should be refactored to two different functions
3795 ;; giving their result to this function, may be
3796 ;; integrated in caller.
3802 ;; Not at EOF.
3807 ;; Use end of indentation if non-empty line.
3810 ;; Skip until non-empty line or EOF.
3815 ;; Not at EOF.
3819 ;; Indentation bigger than line of departure.
3828 "Set the match found earlier if match were found.
3829 Match has been found by
3830 `rst-font-lock-find-unindented-line-limit' the first time called
3831 or no match is found. Return non-nil if match was found. LIMIT
3832 is not used but mandated by the caller."
3836 rst-font-lock-find-unindented-line-end))
3838 rst-font-lock-find-unindented-line-end
3840 ;; Make sure this is called only once.
3842 t))
3844 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3845 ;; Adornments
3848 "Storage for `rst-font-lock-handle-adornment-matcher'.
3852 "Return section level for adornment KEY.
3853 KEY is the first element of the return list of
3854 `rst-classify-adornment'. If KEY is not a cons return it. If KEY is found
3855 in the hierarchy return its level. Otherwise return a level one
3856 beyond the existing hierarchy."
3858 key
3871 "Storage for match for current adornment.
3872 Set by `rst-font-lock-handle-adornment-pre-match-form'. Also used
3876 "Determine limit for adornments.
3877 Determine all things necessary for font-locking section titles
3878 and transitions and put the result to
3879 `rst-font-lock-adornment-match' and
3880 `rst-font-lock-adornment-level'. ADO is the complete adornment
3881 matched. ADO-END is the point where ADO ends. Return the point
3882 where the whole adorned construct ends.
3884 Called as a PRE-MATCH-FORM in the sense of `font-lock-keywords'."
3888 rst-font-lock-adornment-match nil)
3896 "Set the match found earlier if match were found.
3897 Match has been found by
3898 `rst-font-lock-handle-adornment-pre-match-form' the first time
3899 called or no match is found. Return non-nil if match was found.
3901 Called as a MATCHER in the sense of `font-lock-keywords'.
3902 LIMIT is not used but mandated by the caller."
3904 ;; May run only once - enforce this.
3911 t)))
3913 \f
3914 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3915 ;; Compilation
3918 "Settings for support of conversion of reStructuredText
3940 "Table describing the command to use for each tool-set.
3941 An association list of the tool-set to a list of the (command to use,
3942 extension of produced filename, options to the tool (nil or a
3943 string)) to be used for converting the document."
3944 ;; FIXME: These are not options but symbols which may be referenced by
3945 ;; `rst-compile-*-toolset` below. The `:validate' keyword of
3946 ;; `defcustom' may help to define this properly in newer Emacs
3947 ;; versions (> 23.1).
3949 :key-type symbol
3960 ;; FIXME: Must be `defcustom`.
3964 ;; FIXME: Must be `defcustom`.
3969 "Look for the configuration file in the parents of the current path."
3973 ;; Move up in the dir hierarchy till we find a change log file.
3978 nil)
3980 ;; Move up to the parent dir and try again.
3990 "Compile command to convert reST document into some output file.
3991 Attempts to find configuration file, if it can, overrides the
3992 options. There are two commands to choose from, with USE-ALT,
3993 select the alternative tool-set."
3995 ;; Note: maybe we want to check if there is a Makefile too and not do anything
3996 ;; if that is the case. I dunno.
3998 rst-compile-secondary-toolset
3999 rst-compile-primary-toolset)
4000 rst-compile-toolsets)))
4008 ;; Set compile-command before invocation of compile.
4020 ;; Invoke the compile command.
4026 "Compile command with the alternative tool-set."
4031 "Show pseudo-XML rendering.
4032 Rendering is done of the current active region, or of the entire
4033 buffer, if the region is not selected."
4034 ;; FIXME: The region should be given interactively.
4041 standard-output)))
4043 ;; FIXME: Should be `defcustom`.
4048 "Convert the document to a PDF file and launch a preview program."
4053 buffer-file-name tmp-filename
4054 rst-pdf-program tmp-filename tmp-filename)))
4056 ;; Note: you could also use (compile command) to view the compilation
4057 ;; output.
4058 ))
4060 ;; FIXME: Should be `defcustom` or use something like `browse-url`.
4065 "Convert the document to an S5 slide presentation and launch a preview program."
4070 buffer-file-name tmp-filename
4071 rst-slides-program tmp-filename tmp-filename)))
4073 ;; Note: you could also use (compile command) to view the compilation
4074 ;; output.
4075 ))
4077 \f
4078 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
4079 ;; Imenu support.
4081 ;; FIXME: Integrate this properly. Consider a key binding.
4083 ;; Based on code from Masatake YAMATO <yamato@redhat.com>.
4086 "Find adornments cell in ADORNMENTS for position POS."
4092 adornments nil)
4094 a))
4097 "Convert a cell ELT in a tree returned from `rst-section-tree' to imenu index.
4098 ADORNMENTS is used as hint information for conversion."
4108 ;; FIXME: Overline adornment characters need to be in front so
4109 ;; they become visible even for long title lines. May be
4110 ;; an additional level number is also useful.
4113 title
4115 ""
4119 p
4121 ;; A bit ugly but this make which-func happy.
4125 kdr)))))
4126 nil)))
4128 ;; FIXME: Document title and subtitle need to be handled properly. They should
4129 ;; get an own "Document" top level entry.
4131 "Create index for imenu.
4132 Return as described for `imenu--index-alist'."
4135 ;; Translate line notation to point notation.
4141 ;; FIXME: Need to consider
4142 ;; `imenu-use-markers' here?
4148 tree))))
4150 \f
4151 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
4152 ;; Generic text functions that are more convenient than the defaults.
4154 ;; FIXME: Unbound command - should be bound or removed.
4156 "Replace flush-left lines of FROMCHAR with equal-length lines of TOCHAR."
4158 cSearch for flush-left lines of char:
4171 ;; FIXME: Unbound command - should be bound or removed.
4173 "Join lines in current paragraph into one line, removing end-of-lines."
4178 ;; FIXME: Unbound command - should be bound or removed.
4180 "Fill paragraph at point, first joining the paragraph's lines into one.
4181 This is useful for filling list item paragraphs."
4187 ;; FIXME: Unbound command - should be bound or removed.
4188 ;; Generic character repeater function.
4189 ;; For sections, better to use the specialized function above, but this can
4190 ;; be useful for creating separators.
4192 "Fill the current line using the last character on the current line.
4193 Fill up to the length of the preceding line or up to
4194 `fill-column' if preceding line is empty.
4196 If USE-NEXT, use the next line rather than the preceding line.
4198 If the current line is longer than the desired length, shave the characters off
4199 the current line to fit the desired length.
4201 As an added convenience, if the command is repeated immediately, the alternative
4202 column is used (fill-column vs. end of previous/next line)."
4209 fill-column
4223 ;; Shave characters off the end.
4227 ;; Fill with last characters.
4231 \f
4233 ;; LocalWords: docutils http sourceforge rst html wp svn svnroot txt reST regex
4234 ;; LocalWords: regexes alist seq alt grp keymap abbrev overline overlines toc
4235 ;; LocalWords: XML PNT propertized
4237 ;; Local Variables:
4238 ;; sentence-end-double-space: t
4239 ;; End:
4243 ;;; rst.el ends here