| blob | a10f2d296eb6ca0e3a230dda213a64f6a088a530 |
1 ;;; rst.el --- Mode for viewing and editing reStructuredText-documents.
3 ;; Copyright (C) 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010
4 ;; Free Software Foundation, Inc.
6 ;; Maintainer: Stefan Merten <smerten@oekonux.de>
7 ;; Author: 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 up
29 ;; using the reStructuredText format. Support includes font locking as well as
30 ;; some convenience functions for editing. It does this by defining a Emacs
31 ;; major mode: rst-mode (ReST). This mode is derived from text-mode (and
32 ;; inherits much of it). 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 notable reStructuredText structures;
43 ;; - Some other convenience functions.
44 ;;
45 ;; See the accompanying document in the docutils documentation about
46 ;; the contents of this package and how to use it.
47 ;;
48 ;; For more information about reStructuredText, see
49 ;; http://docutils.sourceforge.net/rst.html
50 ;;
51 ;; For full details on how to use the contents of this file, see
52 ;; http://docutils.sourceforge.net/docs/user/emacs.html
53 ;;
54 ;;
55 ;; There are a number of convenient keybindings provided by rst-mode.
56 ;; The main one is
57 ;;
58 ;; C-c C-a (also C-=): rst-adjust
59 ;;
60 ;; Updates or rotates the section title around point or promotes/demotes the
61 ;; adornments within the region (see full details below). Note that C-= is a
62 ;; good binding, since it allows you to specify a negative arg easily with C--
63 ;; C-= (easy to type), as well as ordinary prefix arg with C-u C-=.
64 ;;
65 ;; For more on bindings, see rst-mode-map below. There are also many variables
66 ;; that can be customized, look for defcustom and defvar in this file.
67 ;;
68 ;; If you use the table-of-contents feature, you may want to add a hook to
69 ;; update the TOC automatically everytime you adjust a section title::
70 ;;
71 ;; (add-hook 'rst-adjust-hook 'rst-toc-update)
72 ;;
73 ;; Syntax highlighting: font-lock is enabled by default. If you want to turn
74 ;; off syntax highlighting to rst-mode, you can use the following::
75 ;;
76 ;; (setq font-lock-global-modes '(not rst-mode ...))
77 ;;
80 ;; CUSTOMIZATION
81 ;;
82 ;; rst
83 ;; ---
84 ;; This group contains some general customizable features.
85 ;;
86 ;; The group is contained in the wp group.
87 ;;
88 ;; rst-faces
89 ;; ---------
90 ;; This group contains all necessary for customizing fonts. The default
91 ;; settings use standard font-lock-*-face's so if you set these to your
92 ;; liking they are probably good in rst-mode also.
93 ;;
94 ;; The group is contained in the faces group as well as in the rst group.
95 ;;
96 ;; rst-faces-defaults
97 ;; ------------------
98 ;; This group contains all necessary for customizing the default fonts used for
99 ;; section title faces.
100 ;;
101 ;; The general idea for section title faces is to have a non-default background
102 ;; but do not change the background. The section level is shown by the
103 ;; lightness of the background color. If you like this general idea of
104 ;; generating faces for section titles but do not like the details this group
105 ;; is the point where you can customize the details. If you do not like the
106 ;; general idea, however, you should customize the faces used in
107 ;; rst-adornment-faces-alist.
108 ;;
109 ;; Note: If you are using a dark background please make sure the variable
110 ;; frame-background-mode is set to the symbol dark. This triggers
111 ;; some default values which are probably right for you.
112 ;;
113 ;; The group is contained in the rst-faces group.
114 ;;
115 ;; All customizable features have a comment explaining their meaning.
116 ;; Refer to the customization of your Emacs (try ``M-x customize``).
119 ;;; DOWNLOAD
121 ;; The latest version of this file lies in the docutils source code repository:
122 ;; http://svn.berlios.de/svnroot/repos/docutils/trunk/docutils/tools/editors/emacs/rst.el
125 ;;; INSTALLATION
127 ;; Add the following lines to your `.emacs' file:
128 ;;
129 ;; (require 'rst)
130 ;;
131 ;; If you are using `.txt' as a standard extension for reST files as
132 ;; http://docutils.sourceforge.net/FAQ.html#what-s-the-standard-filename-extension-for-a-restructuredtext-file
133 ;; suggests you may use one of the `Local Variables in Files' mechanism Emacs
134 ;; provides to set the major mode automatically. For instance you may use::
135 ;;
136 ;; .. -*- mode: rst -*-
137 ;;
138 ;; in the very first line of your file. The following code is useful if you
139 ;; want automatically enter rst-mode from any file with compatible extensions:
140 ;;
141 ;; (setq auto-mode-alist
142 ;; (append '(("\\.txt$" . rst-mode)
143 ;; ("\\.rst$" . rst-mode)
144 ;; ("\\.rest$" . rst-mode)) auto-mode-alist))
145 ;;
147 ;;; BUGS
149 ;; - rst-enumeration-region: Select a single paragraph, with the top at one
150 ;; blank line before the beginning, and it will fail.
151 ;; - The active region goes away when we shift it left or right, and this
152 ;; prevents us from refilling it automatically when shifting many times.
153 ;; - The suggested adornments when adjusting should not have to cycle
154 ;; below one below the last section adornment level preceding the
155 ;; cursor. We need to fix that.
157 ;;; TODO LIST
159 ;; rst-toc-insert features
160 ;; ------------------------
161 ;; - rst-toc-insert: We should parse the contents:: options to figure out how
162 ;; deep to render the inserted TOC.
163 ;; - On load, detect any existing TOCs and set the properties for links.
164 ;; - TOC insertion should have an option to add empty lines.
165 ;; - TOC insertion should deal with multiple lines.
166 ;; - There is a bug on redo after undo of adjust when rst-adjust-hook uses the
167 ;; automatic toc update. The cursor ends up in the TOC and this is
168 ;; annoying. Gotta fix that.
169 ;; - numbering: automatically detect if we have a section-numbering directive in
170 ;; the corresponding section, to render the toc.
171 ;;
172 ;; Other
173 ;; -----
174 ;; - It would be nice to differentiate between text files using
175 ;; reStructuredText_ and other general text files. If we had a
176 ;; function to automatically guess whether a .txt file is following the
177 ;; reStructuredText_ conventions, we could trigger rst-mode without
178 ;; having to hard-code this in every text file, nor forcing the user to
179 ;; add a local mode variable at the top of the file.
180 ;; We could perform this guessing by searching for a valid adornment
181 ;; at the top of the document or searching for reStructuredText_
182 ;; directives further on.
185 ;;; HISTORY
186 ;;
188 ;;; Code:
192 \f
198 \f
199 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
200 ;; Facilities for regular expressions used everywhere
202 ;; The trailing numbers in the names give the number of referenceable regex
203 ;; groups contained in the regex
205 ;; Used to be customizable but really is not customizable but fixed by the reST
206 ;; syntax
208 ;; Sorted so they can form a character class when concatenated
219 ;; Sorted so they can form a character class when concatenated
223 ?-)
227 1000
231 ;; `*-beg' matches * at the beginning of a line
232 ;; `*-end' matches * at the end of a line
233 ;; `*-prt' matches a part of *
234 ;; `*-tag' matches *
235 ;; `*-sta' matches the start of * which may be followed by respective content
236 ;; `*-pfx' matches the delimiter left of *
237 ;; `*-sfx' matches the delimiter right of *
238 ;; `*-hlp' helper for *
239 ;;
240 ;; A trailing number says how many referenceable groups are contained.
241 `(
243 ;; Horizontal white space (`hws')
248 ;; Lines (`lin')
253 ;; Various tags and parts
264 ;; Block lead in (`bli')
266 ; immediate content
268 ;; Various starts
271 ;; Explicit markup tag (`exm')
276 ;; Counters in enumerations (`cnt')
280 ;; Enumerator (`enm')
287 ; enumerator
294 ; at the beginning of a line
296 ;; Items may be enumerated or bulleted (`itm')
299 ; is the item tag
301 ; beginning of a line, group is the
302 ; item tag
304 ;; Inline markup (`ilm')
308 ;; Inline markup content (`ilc')
313 ; definition
316 ; definition
322 (:seq ilcsgl-tag
323 ilcast-prt ilcrep-hlp
326 (:seq ilcsgl-tag
327 ilcbkq-prt ilcrep-hlp
330 (:seq ilcsgl-tag
331 ilcbkqdef-prt ilcrep-hlp
334 (:seq ilcsgl-tag
335 ilcbar-prt ilcrep-hlp
338 (:seq ilcsgl-tag
339 ilcbardef-prt ilcrep-hlp
342 ;; Fields (`fld')
347 ;; Options (`opt')
354 ;; Footnotes and citations (`fnc')
359 ;; Substitutions (`sub')
362 ; tag
364 ;; Symbol (`sym')
368 ;; URIs (`uri')
371 ;; Adornment (`ado')
374 ; otherwise explicit markup start would be
375 ; recognized
378 ; adornment character and MUST be the FIRST
379 ; group in the whole expression
382 ; adornment character and MUST be the
383 ; SECOND group in the whole expression
386 ; adornment and MUST be the FIRST group in the whole
387 ; expression; second group is the first adornment
388 ; character
390 ;; Titles (`ttl')
393 )
394 "Definition alist of relevant regexes.
395 Each entry consists of the symbol naming the regex and an
399 "Interpret ARGS as regular expressions and return a regex string.
400 Each element of ARGS may be one of the following:
402 A string which is inserted unchanged.
404 A character which is resolved to a quoted regex.
406 A symbol which is resolved to a string using `rst-re-alist-def'.
408 A list with a keyword in the car. Each element of the cdr of such
409 a list is recursively interpreted as ARGS. The results of this
410 interpretation are concatenated according to the keyword.
412 For the keyword `:seq' the results are simply concatenated.
414 For the keyword `:shy' the results are concatenated and
420 For the keyword `:grp' the results are concatenated and form a
423 After interpretation of ARGS the results are concatenated as for
424 `:seq'.
425 "
431 re)
454 args)))
457 ;; Shadow global value we are just defining so we can construct it step by
458 ;; step
464 rst-re-alist)
467 \f
468 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
469 ;; Mode definition.
482 ;; Exact key sequence not found. Maybe a deprecated key sequence has
483 ;; been followed by another key.
489 ;; Don't execute the command in this case
498 "Bind like `define-key' using DEPRECATED as deprecated key definitions.
499 DEPRECATED key definitions should be in vector notation. These
500 are defined as well but give an additional message."
506 ;; Key bindings.
510 ;; \C-c is the general keymap
513 ;;
514 ;; Section Adornments.
515 ;;
516 ;; The adjustment function that adorns or rotates a section title.
520 ;; \C-c \C-a is the keymap for adornments
522 ;; Display the hierarchy of adornments implied by the current document contents.
524 ;; Homogeneize the adornments in the document.
528 ;;
529 ;; Section Movement and Selection.
530 ;;
531 ;; Mark the subsection where the cursor is.
533 ;; same as mark-defun sgml-mark-current-element
535 ;; Move forward/backward between section titles.
537 ;; same as beginning-of-defun
540 ;; same as end-of-defun
543 ;;
544 ;; Operating on regions.
545 ;;
546 ;; \C-c \C-r is the keymap for regions
548 ;; Makes region a line-block.
551 ;; Shift region left or right (taking into account of enumerations/bullets,
552 ;; etc.).
558 ;;
559 ;; Operating on lists.
560 ;;
561 ;; \C-c \C-l is the keymap for regions
563 ;; Makes paragraphs in region as a bullet list.
566 ;; Makes paragraphs in region as a enumeration.
569 ;; Converts bullets to an enumeration.
572 ;; Make sure that all the bullets in the region are consistent.
575 ;; Insert a list item
578 ;;
579 ;; Table-of-Contents Features.
580 ;;
581 ;; \C-c \C-t is the keymap for table of contents
583 ;; Enter a TOC buffer to view and move to a specific section.
585 ;; Insert a TOC here.
588 ;; Update the document's TOC (without changing the cursor position).
591 ;; Got to the section under the cursor (cursor must be in TOC).
595 ;;
596 ;; Converting Documents from Emacs.
597 ;;
598 ;; \C-c \C-c is the keymap for compilation
600 ;; Run one of two pre-configured toolset commands on the document.
605 ;; Convert the active region to pseudo-xml using the docutils tools.
608 ;; Convert the current document to PDF and launch a viewer on the results.
611 ;; Convert the current document to S5 slides and view in a web browser.
615 map)
616 "Keymap for reStructuredText mode commands.
620 ;; Abbrevs.
630 ;; FIXME: Add footnotes, links, and more.
631 )))
634 ;; Syntax table.
659 st)
664 "Hook run when `rst-mode' is turned on.
665 The hook for `text-mode' is run before this one."
670 ;; Use rst-mode for *.rst and *.rest files. Many ReStructured-Text files
671 ;; use *.txt, but this is too generic to be set as a default.
672 ;;;###autoload (add-to-list 'auto-mode-alist (purecopy '("\\.re?st\\'" . rst-mode)))
673 ;;;###autoload
675 "Major mode for editing reStructuredText documents.
678 There are a number of convenient keybindings provided by Rst
680 section title around point or promotes/demotes the adornments
681 within the region (see full details below). Use negative prefix
682 arg to rotate in the other direction.
684 Turning on `rst-mode' calls the normal hooks `text-mode-hook'
685 and `rst-mode-hook'. This mode also supports font-lock
686 highlighting.
689 :abbrev-table rst-mode-abbrev-table
690 :syntax-table rst-mode-syntax-table
696 lin-end)))
699 'indent-relative-maybe
704 lin-end
708 ;; The details of the following comment setup is important because it affects
709 ;; auto-fill, and it is pretty common in running text to have an ellipsis
710 ;; ("...") which trips because of the rest comment syntax (".. ").
711 ;; FIXME: Auto-fill continues a comment if there is an explicit markup start;
712 ;; maybe comments can be made multi-line somehow (see
713 ;; `comment-multi-line')
717 ;; Text after a changed line may need new fontification - though we don't use
718 ;; jit-lock-mode at the moment...
721 ;; Special variables
724 ;; Font lock
727 t nil nil nil
730 ;; rst-mode does not need font-lock-support-mode because it's fast
731 ;; enough. In fact using `jit-lock-mode` slows things down
732 ;; considerably even if `rst-font-lock-extend-region` is in place and
733 ;; compiled.
735 ))
740 ;;;###autoload
742 "ReST Minor Mode.
743 Toggle ReST minor mode.
744 With no argument, this command toggles the mode.
745 Non-null prefix argument turns on the mode.
746 Null prefix argument turns off the mode.
748 When ReST minor mode is enabled, the ReST mode keybindings
749 are installed on top of the major mode bindings. Use this
750 for modes derived from Text mode, like Mail mode."
751 ;; The initial value.
752 nil
753 ;; The indicator for the mode line.
754 " ReST"
755 ;; The minor mode bindings.
756 rst-mode-map
759 ;; FIXME: can I somehow install these too?
760 ;; :abbrev-table rst-mode-abbrev-table
761 ;; :syntax-table rst-mode-syntax-table
763 \f
764 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
765 ;; Section Adornment Adjustment
766 ;; ============================
767 ;;
768 ;; The following functions implement a smart automatic title sectioning feature.
769 ;; The idea is that with the cursor sitting on a section title, we try to get as
770 ;; much information from context and try to do the best thing automatically.
771 ;; This function can be invoked many times and/or with prefix argument to rotate
772 ;; between the various sectioning adornments.
773 ;;
774 ;; Definitions: the two forms of sectioning define semantically separate section
775 ;; levels. A sectioning ADORNMENT consists in:
776 ;;
777 ;; - a CHARACTER
778 ;;
779 ;; - a STYLE which can be either of 'simple' or 'over-and-under'.
780 ;;
781 ;; - an INDENT (meaningful for the over-and-under style only) which determines
782 ;; how many characters and over-and-under style is hanging outside of the
783 ;; title at the beginning and ending.
784 ;;
785 ;; Important note: an existing adornment must be formed by at least two
786 ;; characters to be recognized.
787 ;;
788 ;; Here are two examples of adornments (| represents the window border, column
789 ;; 0):
790 ;;
791 ;; |
792 ;; 1. char: '-' e |Some Title
793 ;; style: simple |----------
794 ;; |
795 ;; 2. char: '=' |==============
796 ;; style: over-and-under | Some Title
797 ;; indent: 2 |==============
798 ;; |
799 ;;
800 ;; Some notes:
801 ;;
802 ;; - The underlining character that is used depends on context. The file is
803 ;; scanned to find other sections and an appropriate character is selected.
804 ;; If the function is invoked on a section that is complete, the character is
805 ;; rotated among the existing section adornments.
806 ;;
807 ;; Note that when rotating the characters, if we come to the end of the
808 ;; hierarchy of adornments, the variable rst-preferred-adornments is
809 ;; consulted to propose a new underline adornment, and if continued, we cycle
810 ;; the adornments all over again. Set this variable to nil if you want to
811 ;; limit the underlining character propositions to the existing adornments in
812 ;; the file.
813 ;;
814 ;; - A prefix argument can be used to alternate the style.
815 ;;
816 ;; - An underline/overline that is not extended to the column at which it should
817 ;; be hanging is dubbed INCOMPLETE. For example::
818 ;;
819 ;; |Some Title
820 ;; |-------
821 ;;
822 ;; Examples of default invocation:
823 ;;
824 ;; |Some Title ---> |Some Title
825 ;; | |----------
826 ;;
827 ;; |Some Title ---> |Some Title
828 ;; |----- |----------
829 ;;
830 ;; | |------------
831 ;; | Some Title ---> | Some Title
832 ;; | |------------
833 ;;
834 ;; In over-and-under style, when alternating the style, a variable is
835 ;; available to select how much default indent to use (it can be zero). Note
836 ;; that if the current section adornment already has an indent, we don't
837 ;; adjust it to the default, we rather use the current indent that is already
838 ;; there for adjustment (unless we cycle, in which case we use the indent
839 ;; that has been found previously).
842 "Settings for adjustment and cycling of section title adornments."
854 "Preferred ordering of section title adornments.
856 This sequence is consulted to offer a new adornment suggestion
857 when we rotate the underlines at the end of the existing
858 hierarchy of characters, or when there is no existing section
859 title in the file."
864 "Number of characters to indent the section title.
866 This is used for when toggling adornment styles, when switching
867 from a simple adornment style to a over-and-under adornment
868 style."
873 "Compare adornments.
874 Return true if both ADO1 and ADO2 adornments are equal,
875 according to restructured text semantics (only the character and
876 the style are compared, the indentation does not matter)."
882 "Return the index (level) in hierarchy HIER of adornment ADO.
883 This basically just searches for the item using the appropriate
884 comparison and returns the index. Return nil if the item is
885 not found."
889 cur))
893 "Suggest a new, different adornment from all that have been seen.
895 ALLADOS is the set of all adornments, including the line numbers.
896 PREV is the optional previous adornment, in order to suggest a
897 better match."
899 ;; For all the preferred adornments...
901 ;; If 'prev' is given, reorder the list to start searching after the
902 ;; match.
906 ;; List of candidates to search.
909 ;; For all the adornments...
911 found)
914 ;; Found it!
917 found)
924 "Delete the entire current line without using the `kill-ring'."
929 "Unconditionally update the style of a section adornment.
931 Do this using the given character CHAR, with STYLE 'simple
932 or 'over-and-under, and with indent INDENT. If the STYLE
933 is 'simple, whitespace before the title is removed (indent
934 is always assumed to be 0).
936 If there are existing overline and/or underline from the
937 existing adornment, they are removed before adding the
938 requested adornment."
942 len)
947 ;; Fixup whitespace at the beginning and end of the line
957 ;; Set the current column, we're at the end of the title line
960 ;; Remove previous line if it is an adornment
964 ;; Avoid removing the underline of a title right above us.
969 ;; Remove following line if it is an adornment
974 ;; Add a newline if we're at the end of the buffer, for the subsequence
975 ;; inserting of the underline
979 ;; Insert overline
986 ;; Insert underline
993 ))
997 "Normalize the cursor position.
998 If the cursor is on an adornment line or an empty line, place it
999 on the section title line (at the beginning). Return the line
1000 offset by which the cursor was moved. This works both over or
1001 under a line."
1024 "Find all the adornments in the file.
1025 Return a list of (line, adornment) pairs. Each adornment
1026 consists in a (char, style, indent) triple.
1028 This function does not detect the hierarchy of adornments, it
1029 just finds all of them in a file. You can then invoke another
1030 function to remove redundancies and inconsistencies."
1034 ;; Iterate over all the section titles/adornments in the file.
1042 ;; Here we have found a potential site for a adornment,
1043 ;; characterize it.
1046 ;; Found a real adornment site.
1049 ;; Push beyond the underline.
1052 )))
1053 ))
1056 ))
1061 "Build a hierarchy of adornments using the list of given ADORNMENTS.
1063 This function expects a list of (char, style, indent) adornment
1064 specifications, in order that they appear in a file, and will
1065 infer a hierarchy of section levels by removing adornments that
1066 have already been seen in a forward traversal of the adornments,
1067 comparing just the character and style.
1069 Similarly returns a list of (char, style, indent), where each
1070 list element should be unique."
1078 ))
1081 ))
1085 "Return the hierarchy of section titles in the file.
1087 Return a list of adornments that represents the hierarchy of
1088 section titles in the file. Reuse the list of adornments
1089 already computed in ALLADOS if present. If the line number in
1090 IGNORE is specified, the adornment found on that line (if there
1091 is one) is not taken into account when building the hierarchy."
1098 "Get the adornment at POINT.
1100 Looks around point and finds the characteristics of the
1101 adornment that is found there. Assumes that the cursor is
1102 already placed on the title line (and not on the overline or
1103 underline).
1105 This function returns a (char, style, indent) triple. If the
1106 characters of overline and underline are different, return
1107 the underline character. The indent is always calculated.
1108 A adornment can be said to exist if the style is not nil.
1110 A point can be specified to go to the given location before
1111 extracting the adornment."
1126 )
1128 ;; Check that the line above the overline is not part of a title
1129 ;; above it.
1137 ;; No adornment found, leave all return values nil.
1140 ;; Overline only, leave all return values nil.
1141 ;;
1142 ;; Note: we don't return the overline character, but it could
1143 ;; perhaps in some cases be used to do something.
1146 ;; Underline only.
1151 ;; Both overline and underline.
1155 )
1156 )
1157 )
1158 ;; Find indentation.
1160 )
1161 ;; Return values.
1166 "Return the adornments around point.
1168 Given the list of all adornments ALLADOS (with positions),
1169 find the adornments before and after the given point.
1170 A list of the previous and next adornments is returned."
1173 prev next
1176 ;; Search for the adornments around the current line.
1180 ;; 'cur' is the following adornment.
1186 ))
1190 "Return true if the adornment ADO around point is complete."
1191 ;; Note: we assume that the detection of the overline as being the underline
1192 ;; of a preceding title has already been detected, and has been eliminated
1193 ;; from the adornment that is given to us.
1195 ;; There is some sectioning already present, so check if the current
1196 ;; sectioning is complete and correct.
1201 )
1212 ))
1213 ))
1218 "Get the next adornment for CURADO, in given hierarchy HIER.
1219 If suggesting, suggest for new adornment SUGGESTION.
1220 REVERSE-DIRECTION is used to reverse the cycling order."
1226 ;; Build a new list of adornments for the rotation.
1229 ;; Suggest a new adornment.
1231 ;; If nothing to suggest, use first adornment.
1234 ;; Search for next adornment.
1242 cur))
1244 ;; If not found, take the first of all adornments.
1245 suggestion
1246 )))
1250 "Auto-adjust the adornment around point.
1252 Adjust/rotate the section adornment for the section title
1253 around point or promote/demote the adornments inside the region,
1254 depending on if the region is active. This function is meant to
1255 be invoked possibly multiple times, and can vary its behavior
1256 with a positive prefix argument (toggle style), or with a
1257 negative prefix argument (alternate behavior).
1259 This function is the main focus of this module and is a bit of a
1260 swiss knife. It is meant as the single most essential function
1261 to be bound to invoke to adjust the adornments of a section
1262 title in restructuredtext. It tries to deal with all the
1263 possible cases gracefully and to do `the right thing' in all
1264 cases.
1266 See the documentations of `rst-adjust-adornment-work' and
1267 `rst-promote-region' for full details.
1269 Prefix Arguments
1270 ================
1272 The method can take either (but not both) of
1274 a. a (non-negative) prefix argument, which means to toggle the
1275 adornment style. Invoke with a prefix arg for example;
1277 b. a negative numerical argument, which generally inverts the
1278 direction of search in the file or hierarchy. Invoke with C--
1279 prefix for example."
1289 ;; Adjust adornments within region.
1291 ;; Adjust adornment around point.
1294 ;; Run the hooks to run after adjusting.
1297 ;; Make sure to reset the cursor position properly after we're done.
1300 ))
1306 "Non-nil if new adornment is added deeper.
1307 If non-nil, a new adornment being added will be initialized to
1308 be one level down from the previous adornment. If nil, a new
1309 adornment will be equal to the level of the previous
1313 "Call `rst-adjust-adornment-work' interactively.
1315 Keep this for compatibility for older bindings (are there any?)."
1323 "Adjust/rotate the section adornment for the section title around point.
1325 This function is meant to be invoked possibly multiple times, and
1326 can vary its behavior with a true TOGGLE-STYLE argument, or with
1327 a REVERSE-DIRECTION argument.
1329 General Behavior
1330 ================
1332 The next action it takes depends on context around the point, and
1333 it is meant to be invoked possibly more than once to rotate among
1334 the various possibilities. Basically, this function deals with:
1336 - adding a adornment if the title does not have one;
1338 - adjusting the length of the underline characters to fit a
1339 modified title;
1341 - rotating the adornment in the set of already existing
1342 sectioning adornments used in the file;
1344 - switching between simple and over-and-under styles.
1346 You should normally not have to read all the following, just
1347 invoke the method and it will do the most obvious thing that you
1348 would expect.
1351 Adornment Definitions
1352 =====================
1354 The adornments consist in
1356 1. a CHARACTER
1358 2. a STYLE which can be either of 'simple' or 'over-and-under'.
1360 3. an INDENT (meaningful for the over-and-under style only)
1361 which determines how many characters and over-and-under
1362 style is hanging outside of the title at the beginning and
1363 ending.
1365 See source code for mode details.
1368 Detailed Behavior Description
1369 =============================
1371 Here are the gory details of the algorithm (it seems quite
1372 complicated, but really, it does the most obvious thing in all
1373 the particular cases):
1375 Before applying the adornment change, the cursor is placed on
1376 the closest line that could contain a section title.
1378 Case 1: No Adornment
1379 --------------------
1381 If the current line has no adornment around it,
1383 - search backwards for the last previous adornment, and apply
1384 the adornment one level lower to the current line. If there
1385 is no defined level below this previous adornment, we suggest
1386 the most appropriate of the `rst-preferred-adornments'.
1388 If REVERSE-DIRECTION is true, we simply use the previous
1389 adornment found directly.
1391 - if there is no adornment found in the given direction, we use
1392 the first of `rst-preferred-adornments'.
1394 The prefix argument forces a toggle of the prescribed adornment
1395 style.
1397 Case 2: Incomplete Adornment
1398 ----------------------------
1400 If the current line does have an existing adornment, but the
1401 adornment is incomplete, that is, the underline/overline does
1402 not extend to exactly the end of the title line (it is either too
1403 short or too long), we simply extend the length of the
1404 underlines/overlines to fit exactly the section title.
1406 If the prefix argument is given, we toggle the style of the
1407 adornment as well.
1409 REVERSE-DIRECTION has no effect in this case.
1411 Case 3: Complete Existing Adornment
1412 -----------------------------------
1414 If the adornment is complete (i.e. the underline (overline)
1415 length is already adjusted to the end of the title line), we
1416 search/parse the file to establish the hierarchy of all the
1417 adornments (making sure not to include the adornment around
1418 point), and we rotate the current title's adornment from within
1419 that list (by default, going *down* the hierarchy that is present
1420 in the file, i.e. to a lower section level). This is meant to be
1421 used potentially multiple times, until the desired adornment is
1422 found around the title.
1424 If we hit the boundary of the hierarchy, exactly one choice from
1425 the list of preferred adornments is suggested/chosen, the first
1426 of those adornment that has not been seen in the file yet (and
1427 not including the adornment around point), and the next
1428 invocation rolls over to the other end of the hierarchy (i.e. it
1429 cycles). This allows you to avoid having to set which character
1430 to use.
1432 If REVERSE-DIRECTION is true, the effect is to change the
1433 direction of rotation in the hierarchy of adornments, thus
1434 instead going *up* the hierarchy.
1436 However, if there is a non-negative prefix argument, we do not
1437 rotate the adornment, but instead simply toggle the style of the
1438 current adornment (this should be the most common way to toggle
1439 the style of an existing complete adornment).
1442 Point Location
1443 ==============
1445 The invocation of this function can be carried out anywhere
1446 within the section title line, on an existing underline or
1447 overline, as well as on an empty line following a section title.
1448 This is meant to be as convenient as possible.
1451 Indented Sections
1452 =================
1454 Indented section titles such as ::
1456 My Title
1457 --------
1459 are invalid in restructuredtext and thus not recognized by the
1460 parser. This code will thus not work in a way that would support
1461 indented sections (it would be ambiguous anyway).
1464 Joint Sections
1465 ==============
1467 Section titles that are right next to each other may not be
1468 treated well. More work might be needed to support those, and
1469 special conditions on the completeness of existing adornments
1470 might be required to make it non-ambiguous.
1472 For now we assume that the adornments are disjoint, that is,
1473 there is at least a single line between the titles/adornment
1474 lines."
1476 ;; cursor to the title if this is the case.
1479 ;; Find the adornment and completeness around point.
1485 ;; New values to be computed.
1486 char-new style-new indent-new
1487 )
1489 ;; We've moved the cursor... if we're not looking at some text, we have
1490 ;; nothing to do.
1495 ;;-------------------------------------------------------------------
1496 ;; Case 1: No Adornment
1503 cur
1506 )
1508 ;; Advance one level down.
1513 prev
1518 ;; Invert the style if requested.
1526 ))
1528 ;;-------------------------------------------------------------------
1529 ;; Case 2: Incomplete Adornment
1532 ;; Invert the style if requested.
1537 style-new style
1538 indent-new indent))
1540 ;;-------------------------------------------------------------------
1541 ;; Case 3: Complete Existing Adornment
1545 ;; Simply switch the style of the current adornment.
1548 indent-new rst-default-indent)
1550 ;; Else, we rotate, ignoring the adornment around the current
1551 ;; line...
1556 ;; Suggestion, in case we need to come up with something
1557 ;; new
1559 hier
1563 curado hier suggestion reverse-direction))
1565 )
1567 ;; Indent, if present, always overrides the prescribed indent.
1572 )))
1573 )
1575 ;; Override indent with present indent!
1580 ))
1583 ;; Correct the position of the cursor to more accurately reflect where it
1584 ;; was located when the function was invoked.
1589 ))
1591 ;; Maintain an alias for compatibility.
1596 "Promote the section titles within the region.
1598 With argument DEMOTE or a prefix argument, demote the section
1599 titles instead. The algorithm used at the boundaries of the
1600 hierarchy is similar to that used by `rst-adjust-adornment-work'."
1612 marker-list
1613 )
1615 ;; Skip the markers that come before the region beginning
1619 ;; Create a list of markers for all the adornments which are found within
1620 ;; the region.
1630 ;; Apply modifications.
1633 ;; Go to the adornment to promote.
1636 ;; Rotate the next adornment.
1640 ;; Update the adornment.
1643 ;; Clear marker to avoid slowing down the editing after we're done.
1645 ))
1647 )))
1652 "Display the current file's section title adornments hierarchy.
1653 This function expects a list of (char, style, indent) triples in
1654 ADORNMENTS."
1668 ))
1669 )))
1672 "Return position of ELEM in LIST or nil."
1677 "Redo all the adornments in the current buffer.
1678 This is done using our preferred set of adornments. This can be
1679 used, for example, when using somebody else's copy of a document,
1680 in order to adapt it to our preferred style."
1686 ;; Get a list of pairs of (level . marker)
1694 m)))
1695 allados))
1696 )
1698 ;; Go to the appropriate position
1701 ;; Apply the new styule
1704 ;; Reset the market to avoid slowing down editing until it gets GC'ed
1706 )
1707 )))
1710 \f
1711 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1712 ;; Insert list items
1713 ;; =================
1716 ;=================================================
1717 ; Borrowed from a2r.el (version 1.3), by Lawrence Mitchell <wence@gmx.li>
1718 ; I needed to make some tiny changes to the functions, so I put it here.
1719 ; -- Wei-Wei Guo
1729 "Convert Arabic number NUM to its Roman numeral representation.
1731 Obviously, NUM must be greater than zero. Don't blame me, blame the
1733 apologies to Monty Python).
1734 If optional prefix ARG is non-nil, insert in current buffer."
1736 res)
1743 res))
1746 "Convert STRING of Roman numerals to an Arabic number.
1748 If STRING contains a letter which isn't a valid Roman numeral, the rest
1749 of the string from that point onwards is ignored.
1751 Hence:
1752 MMD == 2500
1753 and
1754 MMDFLXXVI == 2500.
1755 If optional ARG is non-nil, insert in current buffer."
1763 res))
1764 ;=================================================
1767 "Find all the positions of prefixes in region between BEG and END.
1768 This is used to find bullets and enumerated list items. PFX-RE is
1769 a regular expression for matching the lines after indentation
1770 with items. Returns a list of cons cells consisting of the point
1771 and the column of the point."
1788 pfx))
1793 "Arrange relative position of a newly inserted list item.
1795 Adding a new list might consider three situations:
1797 (a) Current line is a blank line.
1798 (b) Previous line is a blank line.
1799 (c) Following line is a blank line.
1801 When (a) and (b), just add the new list at current line.
1803 when (a) and not (b), a blank line is added before adding the new list.
1805 When not (a), first forward point to the end of the line, and add two
1806 blank lines, then add the new list.
1808 Other situations are just ignored and left to users themselves."
1833 "Insert a new list item.
1835 User is asked to select the item style first, for example (a), i), +. Use TAB
1836 for completition and choices.
1838 If user selects bullets or #, it's just added with position arranged by
1839 `rst-insert-list-pos'.
1841 If user selects enumerations, a further prompt is given. User need to input a
1842 starting item, for example 'e' for 'A)' style. The position is also arranged by
1843 `rst-insert-list-pos'."
1845 ;; FIXME: Make this comply to `interactive' standards
1847 "Select preferred item style [#.]: "
1853 ;; FIXME: Make this comply to `interactive' standards
1881 "Insert a list item with list start CURITEM including its indentation level."
1888 curitem)
1892 nil nil curitem))
1897 ;; FIXME: Assumes one line list items without separating
1898 ;; empty lines
1915 t nil curitem))
1919 nil nil curitem)))))
1923 "Insert a list item at the current point.
1925 The command can insert a new list or a continuing list. When it is called at a
1926 non-list line, it will promote to insert new list. When it is called at a list
1927 line, it will insert a list with the same list style.
1929 1. When inserting a new list:
1931 User is asked to select the item style first, for example (a), i), +. Use TAB
1932 for completition and choices.
1934 (a) If user selects bullets or #, it's just added.
1935 (b) If user selects enumerations, a further prompt is given. User needs to
1936 input a starting item, for example 'e' for 'A)' style.
1938 The position of the new list is arranged according to whether or not the
1939 current line and the previous line are blank lines.
1941 2. When continuing a list, one thing need to be noticed:
1943 List style alphabetical list, such as 'a.', and roman numerical list, such as
1944 'i.', have some overlapping items, for example 'v.' The function can deal with
1945 the problem elegantly in most situations. But when those overlapped list are
1946 preceded by a blank line, it is hard to determine which type to use
1947 automatically. The function uses alphabetical list by default. If you want
1956 "Make all the bulleted list items in the region consistent.
1957 The region is specified between BEG and END. You can use this
1958 after you have merged multiple bulleted lists to make them use
1959 the same/correct/consistent bullet characters.
1961 See variable `rst-preferred-bullets' for the list of bullets to
1962 adjust. If bullets are found on levels beyond the
1963 `rst-preferred-bullets' list, they are not modified."
1969 ;; Create a map of levels to list of positions.
1975 levtable)))
1977 ;; Sort this map and create a new map of prefix char and list of positions.
1984 ;; Apply the characters.
1991 \f
1992 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1993 ;; Table of contents
1994 ;; =================
1997 "Return the line at cursor, stripped from whitespace."
2003 "Get the hierarchical tree of section titles.
2005 Returns a hierarchical tree of the sections titles in the
2006 document, for adornments ALLADOS. This can be used to generate
2007 a table of contents for the document. The top node will always
2008 be a nil node, with the top level titles as children (there may
2009 potentially be more than one).
2011 Each section title consists in a cons of the stripped title
2012 string and a marker to the section in the original text document.
2014 If there are missing section levels, the section titles are
2015 inserted automatically, and the title string is set to nil, and
2016 the marker set to the first non-nil child of itself.
2017 Conceptually, the nil nodes--i.e. those which have no title--are
2018 to be considered as being the same line as their first non-nil
2019 child. This has advantages later in processing the graph."
2023 lines)
2027 ;; Compare just the character and indent in the hash table.
2031 ;; Create a list of lines that contains (text, level, marker) for each
2032 ;; adornment.
2043 ))
2044 allados)))
2051 "Recursive guts of the section tree construction.
2052 ADOS is a cons cell whose cdr is the remaining list of
2053 adornments, and we change it as we consume them. LEV is
2054 the current level of that node. This function returns a
2055 pair of the subtree that was built. This treats the ADOS
2056 list destructively."
2059 node
2060 children)
2062 ;; If the next adornment matches our level
2064 ;; Pop the next adornment and create the current node with it
2067 ;; Else we let the node title/marker be unset.
2069 ;; Build the child nodes
2073 children)))
2076 ;; If node is still unset, we use the marker of the first child.
2080 ;; Return this node with its children.
2082 ))
2086 "Find tree node at point.
2087 Given a computed and valid section tree in NODE and a point
2088 POINT (default being the current point in the current buffer),
2089 find and return the node within the sectree where the cursor
2090 lives.
2092 Return values: a pair of (parent path, container subtree).
2093 The parent path is simply a list of the nodes above the
2094 container subtree node that we're returning."
2100 ;; Check if we are before the current node.
2103 ;; Iterate all the children, looking for one that might contain the
2104 ;; current section.
2106 last)
2118 )))
2120 ))
2124 "Settings for reStructuredText table of contents."
2129 "Indentation for table-of-contents display.
2130 Also used for formatting insertion, when numbering is disabled."
2134 "Insertion style for table-of-contents.
2135 Set this to one of the following values to determine numbering and
2136 indentation style:
2137 - plain: no numbering (fixed indentation)
2138 - fixed: numbering, but fixed indentation
2139 - aligned: numbering, titles aligned under each other
2140 - listed: numbering, with dashes like list items (EXPERIMENTAL)"
2144 "Separator that goes between the TOC number and the title."
2147 ;; This is used to avoid having to change the user's mode.
2151 map)
2155 "If non-nil, maximum depth of the inserted TOC."
2160 "Insert a simple text rendering of the table of contents.
2161 By default the top level is ignored if there is only one, because
2162 we assume that the document will have a single title.
2164 If a numeric prefix argument PFXARG is given, insert the TOC up
2165 to the specified level.
2167 The TOC is inserted indented at the current column."
2176 ;; Get the section tree for the current cursor point.
2181 ;; Figure out initial indent.
2188 ;; Fixup for the first line.
2191 ;; Delete the last newline added.
2193 )))
2196 "Insert tree node NODE in table-of-contents.
2197 Recursive function that does printing of the inserted toc.
2198 LEVEL is the depth level of the sections in the tree.
2199 INDENT is the indentation string. PFX is the prefix numbering,
2200 that includes the alignment necessary for all the children of
2201 level to align."
2203 ;; Note: we do child numbering from the parent, so we start number the
2204 ;; children one level before we print them.
2213 ;; Add properties to the text, even though in normal text mode it
2214 ;; won't be doing anything for now. Not sure that I want to change
2215 ;; mode stuff. At least the highlighting gives the idea that this
2216 ;; is generated automatically.
2221 )
2224 ;; Prepare indent for children.
2239 ))
2240 )
2245 fmt)
2248 ;; Add a separating dot if there is already a prefix
2253 ;; Calculate the amount of space that the prefix will require
2254 ;; for the numbers.
2259 ))
2264 indent
2269 )))
2273 "Automatically find the contents section of a document and update.
2274 Updates the inserted TOC if present. You can use this in your
2275 file-write hook to always make it up-to-date automatically."
2278 ;; Find and delete an existing comment after the first contents directive.
2279 ;; Delete that region.
2281 ;; We look for the following and the following only (in other words, if your
2282 ;; syntax differs, this won't work.).
2283 ;;
2284 ;; .. contents:: [...anything here...]
2285 ;; [:field: value]...
2286 ;; ..
2287 ;; XXXXXXXX
2288 ;; XXXXXXXX
2289 ;; [more lines]
2293 last-real)
2295 ;; Look for the first line that starts at the first column.
2312 ;; Note: always return nil, because this may be used as a hook.
2313 nil)
2315 ;; Note: we cannot bind the TOC update on file write because it messes with
2316 ;; undo. If we disable undo, since it adds and removes characters, the
2317 ;; positions in the undo list are not making sense anymore. Dunno what to do
2318 ;; with this, it would be nice to update when saving.
2319 ;;
2320 ;; (add-hook 'write-contents-hooks 'rst-toc-update-fun)
2321 ;; (defun rst-toc-update-fun ()
2322 ;; ;; Disable undo for the write file hook.
2323 ;; (let ((buffer-undo-list t)) (rst-toc-update) ))
2327 ;;------------------------------------------------------------------------------
2330 "Recursive function that does insert NODE at LEVEL in the table-of-contents."
2334 ;; Insert line text.
2338 ;; Highlight lines.
2341 ;; Add link on lines.
2345 ))
2351 "Count the number of lines from NODE to the TARGET-NODE node.
2352 This recursive function returns a cons of the number of
2353 additional lines that have been counted for its node and
2354 children, and t if the node has been found."
2357 found)
2376 "Display a table-of-contents.
2377 Finds all the section titles and their adornments in the
2378 file, and displays a hierarchically-organized list of the
2379 titles, which is essentially a table-of-contents of the
2380 document.
2382 The Emacs buffer can be navigated, and selecting a section
2383 brings the cursor in that section."
2387 ;; Get the section tree
2392 line
2394 ;; Create a temporary buffer.
2396 )
2407 ;; Count the lines to our found node.
2410 ))
2414 ;; Save the buffer to return to.
2417 ;; Move the cursor near the right section in the TOC.
2420 ))
2424 "Get the section from text property at point."
2430 pos))
2432 ;; FIXME: Cursor before of behind the list must be handled properly, before the
2433 ;; list should jump to the top and behind the list to the last normal
2434 ;; paragraph
2436 "Go to the section the current line describes."
2444 ;; FIXME: make the recentering conditional on scroll.
2448 "Go to the section the current line describes and kill the TOC buffer."
2453 "In `rst-toc' mode, go to the occurrence whose line you click on.
2454 EVENT is the input event."
2466 "Same as `rst-toc-mode-mouse-goto', but kill TOC buffer as well."
2472 "Leave the current TOC buffer."
2486 map)
2491 ;; Could inherit from the new `special-mode'.
2496 ;; Note: use occur-mode (replace.el) as a good example to complete missing
2497 ;; features.
2500 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2501 ;; Section movement commands
2502 ;; =========================
2505 "Skip to the next restructured text section title.
2506 OFFSET specifies how many titles to skip. Use a negative OFFSET to move
2507 backwards in the file (default is to use 1)."
2512 ;; Get all the adornments in the file, with their line numbers.
2515 ;; Get the current line.
2520 )
2522 ;; Find the index of the "next" adornment w.r.t. to the current line.
2526 ;; 'cur' is the adornment on or following the current line.
2531 ;; Find the final index.
2535 ;; If the index is positive, goto the line, otherwise go to the buffer
2536 ;; boundaries.
2542 ))
2545 "Like `rst-forward-section', except move back one title."
2550 "Select the section that point is currently in."
2551 ;; Cloned from mark-paragraph.
2569 \f
2570 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2571 ;; Functions to work on item lists (e.g. indent/dedent, enumerate), which are
2572 ;; always 2 or 3 characters apart horizontally with rest.
2574 ;; (FIXME: there is currently a bug that makes the region go away when we do that.)
2579 "Find the leftmost column in the region."
2588 ))
2589 mincol))
2592 ;; What we really need to do is compute all the possible alignment possibilities
2593 ;; and then select one.
2594 ;;
2595 ;; .. line-block::
2596 ;;
2597 ;; a) sdjsds
2598 ;;
2599 ;; - sdjsd jsjds
2600 ;;
2601 ;; sdsdsjdsj
2602 ;;
2603 ;; 11. sjdss jddjs
2604 ;;
2605 ;; * * * * * * *
2606 ;;
2607 ;; Move backwards, accumulate the beginning positions, and also the second
2608 ;; positions, in case the line matches the bullet pattern, and then sort.
2611 "Build the list of possible horizontal alignment points.
2612 Search backwards from point (or point PT if specified) to
2613 build the list of possible horizontal alignment points that
2614 includes the beginning and contents of a restructuredtext
2615 bulleted or enumerated list item. Return a sorted list
2616 of (COLUMN-NUMBER . LINE) pairs."
2620 ;; We work our way backwards and towards the left.
2623 )
2625 ;; Start by skipping the current line.
2628 ;; Search backwards for each line.
2632 ;; Skip empty lines.
2634 ;; Inspect the current non-empty line
2637 ;; Skip lines that are beyond the current column (we want to move
2638 ;; towards the left).
2642 ;; Add the beginning of the line as a tabbing point.
2646 ;; Look at the line to figure out if it is a bulleted or enumerate
2647 ;; list item.
2649 `(:grp
2650 (:alt
2651 itmany-tag
2652 ;; FIXME: What does this mean?
2654 hws-sta)
2656 ;; Add the column of the contained item.
2662 tablist)))
2663 )
2666 )))
2671 )))
2674 "Insert a line and place special characters at the tab points in TABLIST."
2683 ))
2686 "Insert a line and place special characters at the tab points in TABLIST."
2697 "(See `rst-shift-region-right' for a description)."
2702 )
2703 ;; Add basic offset tabs at the end of the list. This is a better
2704 ;; implementation technique than hysteresis and a basic offset because it
2705 ;; insures that movement in both directions is consistently using the same
2706 ;; column positions. This makes it more predictable.
2714 nil
2718 )))
2720 ;; (For debugging.)
2721 ;;; (save-excursion (goto-char mbeg) (forward-char -1) (rst-debug-print-tabs tabs))))
2722 ;;; (print tabs)
2723 ;;; (save-excursion (rst-debug-mark-found tabs))
2725 ;; Apply the indent.
2727 mbeg mend
2729 ;; Find the next tab after the leftmost columnt.
2741 )
2744 ;; Otherwise use the basic offset
2746 )))
2748 ;; Optionally reindent.
2751 ))
2753 ;; FIXME Doesn't keep the region
2754 ;; FIXME Should work more like `indent-rigidly'
2756 "Indent region ridigly, by a few characters to the right.
2757 This function first computes all possible alignment columns by
2758 inspecting the lines preceding the region for bulleted or
2759 enumerated list items. If the leftmost column is beyond the
2760 preceding lines, the region is moved to the right by
2761 `rst-shift-basic-offset'. With a prefix argument, do not
2762 automatically fill the region."
2770 cur))
2771 'identity
2772 )))
2775 "Like `rst-shift-region-right', except we move to the left.
2776 Also, if invoked with a negative prefix arg, the entire
2777 indentation is removed, up to the leftmost character in the
2778 region, and automatic filling is disabled."
2793 )
2798 cur))
2799 '-
2800 ))
2801 )))
2805 "FIXME This definition is old and deprecated / we need to move
2806 to the newer version below:
2808 Call FUN at the beginning of each line, with an argument that
2809 specifies whether we are at the first line of a paragraph that
2810 starts at the leftmost column of the given region BEG and END.
2811 Set FIRST-ONLY to true if you want to callback on the first line
2812 of each paragraph only."
2816 )
2831 )
2836 valid)
2837 ,body-consequent
2840 ))))
2844 "Evaluate BODY for each line in region defined by BEG END.
2845 LEFTMOST is set to true if the line is one of the leftmost of the
2846 entire paragraph. PARABEGIN is set to true if the line is the
2847 first of a paragraph."
2855 )
2874 )
2879 )))))
2882 ;;------------------------------------------------------------------------------
2884 ;; FIXME: these next functions should become part of a larger effort to redo the
2885 ;; bullets in bulletted lists. The enumerate would just be one of the possible
2886 ;; outputs.
2887 ;;
2888 ;; FIXME: TODO we need to do the enumeration removal as well.
2891 "Add enumeration to all the leftmost paragraphs in the given region.
2892 The region is specified between BEG and END. With ALL,
2893 do all lines instead of just paragraphs."
2903 )))
2906 "Add bullets to all the leftmost paragraphs in the given region.
2907 The region is specified between BEG and END. With ALL,
2908 do all lines instead of just paragraphs."
2914 ))
2917 ;; FIXME: there are some problems left with the following function
2918 ;; implementation:
2919 ;;
2920 ;; * It does not deal with a varying number of digits appropriately
2921 ;; * It does not deal with multiple levels independently, and it should.
2922 ;;
2923 ;; I suppose it does 90% of the job for now.
2926 "Convert the bulleted and enumerated items in the region to enumerated lists.
2927 Renumber as necessary."
2934 m)
2938 )
2945 ))
2946 ))
2950 ;;------------------------------------------------------------------------------
2953 "Toggle line block prefixes for a region.
2954 With prefix argument set the empty lines too."
2969 \f
2970 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2971 ;; Font lock
2972 ;; =========
2982 "All syntax marking up a special block."
2987 "Field names and interpreted text."
2992 "All other defining constructs."
2997 ;; XEmacs compatibility
2999 'font-lock-builtin-face
3001 "Directives and roles."
3006 "Comments."
3011 ;; XEmacs compatibility
3013 ''italic
3015 "Simple emphasis."
3020 ;; XEmacs compatibility
3022 ''bold
3024 "Double emphasis."
3029 "Literal text."
3034 "References to a definition."
3038 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3041 "Values used to generate default faces for section titles on all levels.
3042 Tweak these if you are content with how section title faces are built in
3043 general but you do not like the details."
3048 "Set custom var SYM affecting section title text face and recompute the faces."
3050 ;; Also defines the faces initially when all values are available
3059 ;; Faces for displaying items on several levels; these definitions define
3060 ;; different shades of grey where the lightest one (i.e. least contrasting) is
3061 ;; used for level 1
3063 "Maximum depth of levels for which section title faces are defined."
3068 "Base name of the color for creating background colors in section title faces."
3074 15
3076 "The lightness factor for the base color. This value is used for level 1.
3077 The default depends on whether the value of `frame-background-mode' is
3078 `dark' or not."
3083 "The format for the lightness factor appended to the base name of the color.
3084 This value is expanded by `format' with an integer."
3090 7
3092 "The step width to use for the next color.
3093 The formula
3095 `rst-level-face-base-light'
3096 + (`rst-level-face-max' - 1) * `rst-level-face-step-light'
3098 must result in a color level which appended to `rst-level-face-base-color'
3099 using `rst-level-face-format-light' results in a valid color such as `grey50'.
3100 This color is used as background for section title text on level
3101 `rst-level-face-max'."
3113 alist)
3114 "Faces for the various adornment types.
3115 Key is a number (for the section title text of that level),
3116 t (for transitions) or nil (for section title adornment).
3117 If you generally do not like how section title text faces are
3118 set up tweak here. If the general idea is ok for you but you do not like the
3119 details check the Rst Faces Defaults group."
3122 :key-type
3125 :tag
3132 "Define the faces for the section title text faces from the values."
3133 ;; All variables used here must be checked in `rst-set-level-default'
3139 rst-level-face-base-color
3141 rst-level-face-base-light))))
3150 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3153 ;; The reST-links in the comments below all relate to sections in
3154 ;; http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html
3156 ;; start
3158 ;; Simple `Body Elements`_
3159 ;; `Bullet Lists`_
3160 ;; FIXME: A bullet directly after a field name is not recognized
3163 ;; `Enumerated Lists`_
3166 ;; `Definition Lists`_ FIXME: missing
3167 ;; `Field Lists`_
3170 ;; `Option Lists`_
3174 ;; `Line Blocks`_
3175 ;; Only for lines containing no more bar - to distinguish from tables
3179 ;; `Tables`_ FIXME: missing
3181 ;; All the `Explicit Markup Blocks`_
3182 ;; `Footnotes`_ / `Citations`_
3185 ;; `Directives`_ / `Substitution Definitions`_
3192 ;; `Hyperlink Targets`_
3202 ;; All `Inline Markup`_ - most of them may be multiline though this is
3203 ;; uninteresting
3205 ;; FIXME: Condition 5 preventing fontification of e.g. "*" not implemented
3206 ;; `Strong Emphasis`_
3209 ;; `Emphasis`_
3212 ;; `Inline Literals`_
3215 ;; `Inline Internal Targets`_
3218 ;; `Hyperlink References`_
3219 ;; FIXME: `Embedded URIs`_ not considered
3220 ;; FIXME: Directly adjacing marked up words are not fontified correctly
3221 ;; unless they are not separated by two spaces: foo_ bar_
3226 ;; `Interpreted Text`_
3233 ;; `Footnote References`_ / `Citation References`_
3236 ;; `Substitution References`_
3237 ;; FIXME: References substitutions like |this|_ or |this|__ are not
3238 ;; fontified correctly
3241 ;; `Standalone Hyperlinks`_
3242 ;; FIXME: This takes it easy by using a whitespace as delimiter
3248 ;; Do all block fontification as late as possible so 'append works
3250 ;; Sections_ / Transitions_ - for sections this is multiline
3255 nil
3261 ;; FIXME: FACESPEC could be used instead of ordinary faces to set
3262 ;; properties on comments and literal blocks so they are *not*
3263 ;; inline fontified; see (elisp)Search-based Fontification
3265 ;; `Comments`_ - this is multiline
3271 nil
3278 nil
3281 ;; FIXME: This is not rendered as comment::
3282 ;; .. .. list-table::
3283 ;; :stub-columns: 1
3284 ;; :header-rows: 1
3286 ;; `Literal Blocks`_ - this is multiline
3292 nil
3295 ;; `Doctest Blocks`_
3299 )
3303 "Extend the region `font-lock-beg' / `font-lock-end' iff it may
3304 be in the middle of a multiline construct and return non-nil if so."
3305 ;; There are many potential multiline constructs but really relevant ones are
3306 ;; comment lines without leading explicit markup tag and literal blocks
3307 ;; following "::" which are both indented. Thus indendation is what is
3308 ;; recognized here. The second criteria is an explicit markup tag which may
3309 ;; be a comment or a double colon at the end of a line.
3311 ;; Don't move if we start with a multiline construct already
3322 ;; FIXME: Shouldn't this allow whitespace
3323 ;; after the explicit markup tag?
3325 ;; non-empty indented line, explicit markup tag or literal
3326 ;; block tag
3329 ;; no more previous line
3333 t)))))
3335 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3336 ;; Indented blocks
3339 "Move forward across one indented block.
3340 Find the next non-empty line which is not indented at least to COLUMN (defaults
3341 to the column of the point). Moves point to first character of this line or the
3342 first empty line immediately before it and returns that position. If there is
3343 no such line before LIMIT (defaults to the end of the buffer) returns nil and
3344 point is not moved."
3348 fnd beg cand)
3359 ;; FIXME: No indentation [(zerop clm)] must be handled in some
3360 ;; useful way - though it is not clear what this should mean at all
3367 fnd))
3373 "End of the match as determined by `rst-font-lock-find-unindented-line-limit'.
3374 Also used as a trigger for
3378 "Find the next unindented line relative to indenation at IND-PNT.
3379 Return this point, the end of the buffer or nil if nothing found.
3380 If IND-PNT is `next' take the indentation from the next line if
3381 this is not empty and indented more than the current one. If
3382 IND-PNT is non-nil but not a number take the indentation from the
3383 next non-empty line if this is indented more than the current
3384 one."
3389 ;; Find indentation point in next line if any
3391 ;; FIXME: Should be refactored to two different functions
3392 ;; giving their result to this function, may be
3393 ;; integrated in caller
3399 ;; Not at EOF
3404 ;; Use end of indentation if non-empty line
3407 ;; Skip until non-empty line or EOF
3412 ;; Not at EOF
3416 ;; Indentation bigger than line of departure
3425 "Set the match found by
3426 `rst-font-lock-find-unindented-line-limit' the first time called
3427 or nil."
3431 rst-font-lock-find-unindented-line-end))
3433 rst-font-lock-find-unindented-line-end
3435 ;; Make sure this is called only once
3437 t))
3439 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3440 ;; Adornments
3442 ;; FIXMEFIXME: This must be merged with the adornment functions for section
3443 ;; adjustment.
3446 "Storage for `rst-font-lock-handle-adornment-match'.
3449 ;; FIXME: It would be good if this could be used to markup section titles of
3450 ;; given level with a special key; it would be even better to be able to
3451 ;; customize this so it can be used for a generally available personal style
3452 ;;
3453 ;; FIXME: There should be some way to reset and reload this variable - probably
3454 ;; a special key
3455 ;;
3456 ;; FIXME: Some support for `outline-mode' would be nice which should be based
3457 ;; on this information
3459 "Associates adornments with section levels.
3460 The key is a two character string. The first character is the adornment
3461 character. The second character distinguishes underline section titles (`u')
3462 from overline/underline section titles (`o'). The value is the section level.
3464 This is made buffer local on start and adornments found during font lock are
3468 "Return section level for adornment key KEY.
3469 Add new section level if KEY is not found and ADD. If KEY is not
3470 a string it is simply returned."
3475 key)
3483 new))))
3486 "Classify adornment for section titles and transitions.
3487 ADORNMENT is the complete adornment string as found in the
3488 buffer. END is the point after the last character of ADORNMENT.
3489 For overline section adornment LIMIT limits the search for the
3490 matching underline.
3492 Return a list. The first entry is t for a transition, or a key
3493 string for `rst-adornment-level' for a section title. The
3494 following eight values forming four match groups as can be used
3495 for `set-match-data'. First match group contains the maximum
3496 points of the whole construct. Second and last match group
3497 matched pure section title adornment while third match group
3498 matched the section title text or the transition. Each group but
3499 the first may or may not exist."
3517 key beg-ovr end-ovr beg-txt end-txt beg-und end-und)
3520 ;; A transition
3525 ;; An overline
3533 ;; No underline found
3536 ado-re)
3543 ;; An underline
3554 ado-re)
3556 ;; There is a matching overline
3563 beg-ovr end-ovr beg-txt end-txt beg-und end-und)))))
3566 "Storage for `rst-classify-adornment'.
3567 Also used as a trigger for
3571 "Determine limit for adornments for font-locking section titles and transitions.
3572 In fact determine all things necessary and put the result to
3573 `rst-font-lock-adornment-data'. ADO is the complete adornment
3574 matched. ADO-END is the point where ADO ends. Return the point
3575 where the whole adorned construct ends."
3583 "Set the match found by `rst-font-lock-handle-adornment-limit'
3584 the first time called or nil"
3586 ;; May run only once - enforce this
3593 t)))
3595 \f
3596 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3597 ;; Support for conversion from within Emacs
3600 "Settings for support of conversion of reStructuredText
3613 "Table describing the command to use for each toolset.
3614 An association list of the toolset to a list of the (command to use,
3615 extension of produced filename, options to the tool (nil or a
3618 ;; Note for Python programmers not familiar with association lists: you can set
3619 ;; values in an alists like this, e.g. :
3620 ;; (setcdr (assq 'html rst-compile-toolsets)
3621 ;; '("rst2html.py" ".htm" "--stylesheet=/docutils.css"))
3631 "Look for the configuration file in the parents of the current path."
3635 ;; Move up in the dir hierarchy till we find a change log file.
3640 nil)
3642 ;; Move up to the parent dir and try again.
3647 )
3649 )))
3655 "Compile command to convert reST document into some output file.
3656 Attempts to find configuration file, if it can, overrides the
3657 options. There are two commands to choose from, with USE-ALT,
3658 select the alternative toolset."
3660 ;; Note: maybe we want to check if there is a Makefile too and not do anything
3661 ;; if that is the case. I dunno.
3663 rst-compile-secondary-toolset
3664 rst-compile-primary-toolset)
3665 rst-compile-toolsets)))
3673 ;; Set compile-command before invocation of compile.
3685 ;; Invoke the compile command.
3689 ))
3692 "Compile command with the alternative toolset."
3697 "Show the pseudo-XML rendering of the current active region,
3698 or of the entire buffer, if the region is not selected."
3705 standard-output)))
3711 "Convert the document to a PDF file and launch a preview program."
3716 buffer-file-name tmp-filename
3717 rst-pdf-program tmp-filename)))
3719 ;; Note: you could also use (compile command) to view the compilation
3720 ;; output.
3721 ))
3727 "Convert the document to an S5 slide presentation and launch a preview program."
3732 buffer-file-name tmp-filename
3733 rst-slides-program tmp-filename)))
3735 ;; Note: you could also use (compile command) to view the compilation
3736 ;; output.
3737 ))
3740 \f
3741 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3742 ;; Generic text functions that are more convenient than the defaults.
3745 "Replace flush-left lines, consisting of multiple FROMCHAR characters,
3746 with equal-length lines of TOCHAR."
3748 cSearch for flush-left lines of char:
3762 "Join lines in current paragraph into one line, removing end-of-lines."
3768 "Fill paragraph at point, first joining the paragraph's lines into one.
3769 This is useful for filling list item paragraphs."
3775 ;; Generic character repeater function.
3776 ;; For sections, better to use the specialized function above, but this can
3777 ;; be useful for creating separators.
3779 "Fill the current line up to the length of the preceding line (if not
3780 empty), using the last character on the current line. If the preceding line is
3781 empty, we use the `fill-column'.
3783 If USE-NEXT, use the next line rather than the preceding line.
3785 If the current line is longer than the desired length, shave the characters off
3786 the current line to fit the desired length.
3788 As an added convenience, if the command is repeated immediately, the alternative
3789 column is used (fill-column vs. end of previous/next line)."
3796 fill-column
3808 )) )
3811 ;; shave characters off the end
3815 ;; fill with last characters
3818 ))
3822 "A portable function that returns non-nil if the mark is active."
3828 \f
3830 ;;; rst.el ends here