annotate lisp/mail/footnote.el @ 33000:ab3f9a850b5f

*** empty log message ***
author Miles Bader <miles@gnu.org>
date Sat, 28 Oct 2000 06:07:30 +0000
parents 99b1d31f039b
children b174db545cfd
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
27830
99b1d31f039b (footnote): Add :version to defgroup.
Dave Love <fx@gnu.org>
parents: 26815
diff changeset
1 ;;; footnote.el --- Footnote support for message mode -*- coding: iso-latin-1;-*-
26784
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
2
27830
99b1d31f039b (footnote): Add :version to defgroup.
Dave Love <fx@gnu.org>
parents: 26815
diff changeset
3 ;; Copyright (C) 1997, 2000 by Free Software Foundation, Inc.
26784
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
4
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
5 ;; Author: Steven L Baur <steve@xemacs.org>
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
6 ;; Keywords: mail, news
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
7 ;; Version: 0.19
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
8
26815
9fa9fd18d083 Require cl when compiling. Don't autoload kemap and minor-mode-alist
Dave Love <fx@gnu.org>
parents: 26784
diff changeset
9 ;; This file is part of GNU Emacs.
26784
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
10
26815
9fa9fd18d083 Require cl when compiling. Don't autoload kemap and minor-mode-alist
Dave Love <fx@gnu.org>
parents: 26784
diff changeset
11 ;; GNU Emacs is free software; you can redistribute it and/or modify it
26784
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
12 ;; under the terms of the GNU General Public License as published by
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
13 ;; the Free Software Foundation; either version 2, or (at your option)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
14 ;; any later version.
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
15
26815
9fa9fd18d083 Require cl when compiling. Don't autoload kemap and minor-mode-alist
Dave Love <fx@gnu.org>
parents: 26784
diff changeset
16 ;; GNU Emacs is distributed in the hope that it will be useful, but
26784
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
17 ;; WITHOUT ANY WARRANTY; without even the implied warranty of
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
19 ;; General Public License for more details.
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
20
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
21 ;; You should have received a copy of the GNU General Public License
26815
9fa9fd18d083 Require cl when compiling. Don't autoload kemap and minor-mode-alist
Dave Love <fx@gnu.org>
parents: 26784
diff changeset
22 ;; along with GNU Emacs; see the file COPYING. If not, write to the Free
26784
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
23 ;; Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
24 ;; 02111-1307, USA.
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
25
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
26 ;;; Commentary:
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
27
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
28 ;; This file provides footnote[1] support for message-mode in emacsen.
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
29 ;; footnote-mode is implemented as a minor mode.
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
30
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
31 ;; [1] Footnotes look something like this. Along with some decorative
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
32 ;; stuff.
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
33
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
34 ;; TODO:
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
35 ;; Reasonable Undo support.
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
36 ;; more language styles.
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
37
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
38 ;;; Code:
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
39
26815
9fa9fd18d083 Require cl when compiling. Don't autoload kemap and minor-mode-alist
Dave Love <fx@gnu.org>
parents: 26784
diff changeset
40 (eval-when-compile
9fa9fd18d083 Require cl when compiling. Don't autoload kemap and minor-mode-alist
Dave Love <fx@gnu.org>
parents: 26784
diff changeset
41 (require 'cl)
9fa9fd18d083 Require cl when compiling. Don't autoload kemap and minor-mode-alist
Dave Love <fx@gnu.org>
parents: 26784
diff changeset
42 (defvar filladapt-token-table))
9fa9fd18d083 Require cl when compiling. Don't autoload kemap and minor-mode-alist
Dave Love <fx@gnu.org>
parents: 26784
diff changeset
43
26784
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
44 (defgroup footnote nil
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
45 "Support for footnotes in mail and news messages."
27830
99b1d31f039b (footnote): Add :version to defgroup.
Dave Love <fx@gnu.org>
parents: 26815
diff changeset
46 :version "21.1"
26784
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
47 :group 'message)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
48
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
49 (defcustom footnote-mode-line-string " FN"
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
50 "*String to display in modes section of the mode-line."
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
51 :group 'footnote)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
52
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
53 (defcustom footnote-mode-hook nil
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
54 "*Hook functions run when footnote-mode is activated."
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
55 :type 'hook
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
56 :group 'footnote)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
57
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
58 (defcustom footnote-narrow-to-footnotes-when-editing nil
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
59 "*If set, narrow to footnote text body while editing a footnote."
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
60 :type 'boolean
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
61 :group 'footnote)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
62
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
63 (defcustom footnote-prompt-before-deletion t
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
64 "*If set, prompt before deleting a footnote.
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
65 There is currently no way to undo deletions."
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
66 :type 'boolean
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
67 :group 'footnote)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
68
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
69 (defcustom footnote-spaced-footnotes t
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
70 "If set true it will put a blank line between each footnote.
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
71 If nil, no blank line will be inserted."
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
72 :type 'boolean
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
73 :group 'footnote)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
74
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
75 (defcustom footnote-use-message-mode t
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
76 "*If non-nil assume Footnoting will be done in message-mode."
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
77 :type 'boolean
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
78 :group 'footnote)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
79
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
80 (defcustom footnote-body-tag-spacing 2
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
81 "*Number of blanks separating a footnote body tag and its text."
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
82 :type 'integer
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
83 :group 'footnote)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
84
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
85 (defvar footnote-prefix [(control ?c) ?!]
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
86 "*When not using message mode, the prefix to bind in `mode-specific-map'")
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
87
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
88 ;;; Interface variables that probably shouldn't be changed
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
89
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
90 (defconst footnote-section-tag "Footnotes: "
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
91 "*Tag inserted at beginning of footnote section.")
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
92
27830
99b1d31f039b (footnote): Add :version to defgroup.
Dave Love <fx@gnu.org>
parents: 26815
diff changeset
93 (defcustom footnote-section-tag-regexp "Footnotes\\(\\[.\\]\\)?: "
99b1d31f039b (footnote): Add :version to defgroup.
Dave Love <fx@gnu.org>
parents: 26815
diff changeset
94 "*Regexp which indicates the start of a footnote section.
99b1d31f039b (footnote): Add :version to defgroup.
Dave Love <fx@gnu.org>
parents: 26815
diff changeset
95 See also `footnote-section-tag'."
99b1d31f039b (footnote): Add :version to defgroup.
Dave Love <fx@gnu.org>
parents: 26815
diff changeset
96 :type 'regexp
99b1d31f039b (footnote): Add :version to defgroup.
Dave Love <fx@gnu.org>
parents: 26815
diff changeset
97 :group 'footnote)
26784
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
98
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
99 ;; The following three should be consumed by footnote styles.
27830
99b1d31f039b (footnote): Add :version to defgroup.
Dave Love <fx@gnu.org>
parents: 26815
diff changeset
100 (defcustom footnote-start-tag "["
99b1d31f039b (footnote): Add :version to defgroup.
Dave Love <fx@gnu.org>
parents: 26815
diff changeset
101 "*String used to denote start of numbered footnote."
99b1d31f039b (footnote): Add :version to defgroup.
Dave Love <fx@gnu.org>
parents: 26815
diff changeset
102 :type 'string
99b1d31f039b (footnote): Add :version to defgroup.
Dave Love <fx@gnu.org>
parents: 26815
diff changeset
103 :group 'footnote)
26784
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
104
27830
99b1d31f039b (footnote): Add :version to defgroup.
Dave Love <fx@gnu.org>
parents: 26815
diff changeset
105 (defcustom footnote-end-tag "]"
99b1d31f039b (footnote): Add :version to defgroup.
Dave Love <fx@gnu.org>
parents: 26815
diff changeset
106 "*String used to denote end of numbered footnote."
99b1d31f039b (footnote): Add :version to defgroup.
Dave Love <fx@gnu.org>
parents: 26815
diff changeset
107 :type 'string
99b1d31f039b (footnote): Add :version to defgroup.
Dave Love <fx@gnu.org>
parents: 26815
diff changeset
108 :group 'footnote)
26784
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
109
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
110 (defvar footnote-signature-separator (if (boundp 'message-signature-separator)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
111 message-signature-separator
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
112 "^-- $")
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
113 "*String used to recognize .signatures.")
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
114
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
115 ;;; Private variables
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
116
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
117 (defvar footnote-style-number nil
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
118 "Footnote style represented as an index into footnote-style-alist.")
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
119 (make-variable-buffer-local 'footnote-style-number)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
120
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
121 (defvar footnote-text-marker-alist nil
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
122 "List of markers pointing to text of footnotes in message buffer.")
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
123 (make-variable-buffer-local 'footnote-text-marker-alist)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
124
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
125 (defvar footnote-pointer-marker-alist nil
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
126 "List of markers pointing to footnote pointers in message buffer.")
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
127 (make-variable-buffer-local 'footnote-pointer-marker-alist)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
128
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
129 (defvar footnote-mouse-highlight 'highlight
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
130 "Text property name to enable mouse over highlight.")
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
131
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
132 (defvar footnote-mode nil
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
133 "Variable indicating whether footnote minor mode is active.")
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
134 (make-variable-buffer-local 'footnote-mode)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
135
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
136 ;;; Default styles
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
137 ;;; NUMERIC
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
138 (defconst footnote-numeric-regexp "[0-9]"
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
139 "Regexp for digits.")
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
140
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
141 (defun Footnote-numeric (n)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
142 "Numeric footnote style.
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
143 Use Arabic numerals for footnoting."
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
144 (int-to-string n))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
145
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
146 ;;; ENGLISH UPPER
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
147 (defconst footnote-english-upper "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
148 "Upper case English alphabet.")
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
149
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
150 (defconst footnote-english-upper-regexp "[A-Z]"
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
151 "Regexp for upper case English alphabet.")
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
152
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
153 (defun Footnote-english-upper (n)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
154 "Upper case English footnoting.
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
155 Wrapping around the alphabet implies successive repetitions of letters."
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
156 (let* ((ltr (mod (1- n) (length footnote-english-upper)))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
157 (rep (/ (1- n) (length footnote-english-upper)))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
158 (chr (char-to-string (aref footnote-english-upper ltr)))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
159 rc)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
160 (while (>= rep 0)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
161 (setq rc (concat rc chr))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
162 (setq rep (1- rep)))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
163 rc))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
164
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
165 ;;; ENGLISH LOWER
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
166 (defconst footnote-english-lower "abcdefghijklmnopqrstuvwxyz"
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
167 "Lower case English alphabet.")
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
168
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
169 (defconst footnote-english-lower-regexp "[a-z]"
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
170 "Regexp of lower case English alphabet.")
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
171
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
172 (defun Footnote-english-lower (n)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
173 "Lower case English footnoting.
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
174 Wrapping around the alphabet implies successive repetitions of letters."
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
175 (let* ((ltr (mod (1- n) (length footnote-english-lower)))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
176 (rep (/ (1- n) (length footnote-english-lower)))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
177 (chr (char-to-string (aref footnote-english-lower ltr)))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
178 rc)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
179 (while (>= rep 0)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
180 (setq rc (concat rc chr))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
181 (setq rep (1- rep)))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
182 rc))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
183
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
184 ;;; ROMAN LOWER
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
185 (defconst footnote-roman-lower-list
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
186 '((1 . "i") (5 . "v") (10 . "x")
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
187 (50 . "l") (100 . "c") (500 . "d") (1000 . "m"))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
188 "List of roman numerals with their values.")
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
189
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
190 (defconst footnote-roman-lower-regexp "[ivxlcdm]"
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
191 "Regexp of roman numerals.")
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
192
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
193 (defun Footnote-roman-lower (n)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
194 "Generic Roman number footnoting."
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
195 (Footnote-roman-common n footnote-roman-lower-list))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
196
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
197 ;;; ROMAN UPPER
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
198 (defconst footnote-roman-upper-list
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
199 '((1 . "I") (5 . "V") (10 . "X")
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
200 (50 . "L") (100 . "C") (500 . "D") (1000 . "M"))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
201 "List of roman numerals with their values.")
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
202
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
203 (defconst footnote-roman-upper-regexp "[IVXLCDM]"
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
204 "Regexp of roman numerals. Not complete")
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
205
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
206 (defun Footnote-roman-upper (n)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
207 "Generic Roman number footnoting."
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
208 (Footnote-roman-common n footnote-roman-upper-list))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
209
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
210 (defun Footnote-roman-common (n footnote-roman-list)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
211 "Lower case Roman footnoting."
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
212 (let* ((our-list footnote-roman-list)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
213 (rom-lngth (length our-list))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
214 (rom-high 0)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
215 (rom-low 0)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
216 (rom-div -1)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
217 (count-high 0)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
218 (count-low 0))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
219 ;; find surrounding numbers
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
220 (while (and (<= count-high (1- rom-lngth))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
221 (>= n (car (nth count-high our-list))))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
222 ;; (message "Checking %d" (car (nth count-high our-list)))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
223 (setq count-high (1+ count-high)))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
224 (setq rom-high count-high)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
225 (setq rom-low (1- count-high))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
226 ;; find the appropriate divisor (if it exists)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
227 (while (and (= rom-div -1)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
228 (< count-low rom-high))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
229 (when (or (> n (- (car (nth rom-high our-list))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
230 (/ (car (nth count-low our-list))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
231 2)))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
232 (= n (- (car (nth rom-high our-list))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
233 (car (nth count-low our-list)))))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
234 (setq rom-div count-low))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
235 ;; (message "Checking %d and %d in div loop" rom-high count-low)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
236 (setq count-low (1+ count-low)))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
237 ;;(message "We now have high: %d, low: %d, div: %d, n: %d"
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
238 ;; rom-high rom-low (if rom-div rom-div -1) n)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
239 (let ((rom-low-pair (nth rom-low our-list))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
240 (rom-high-pair (nth rom-high our-list))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
241 (rom-div-pair (if (not (= rom-div -1)) (nth rom-div our-list) nil)))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
242 ;; (message "pairs are: rom-low: %S, rom-high: %S, rom-div: %S"
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
243 ;; rom-low-pair rom-high-pair rom-div-pair)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
244 (cond
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
245 ((< n 0) (error "Footnote-roman-common called with n < 0"))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
246 ((= n 0) "")
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
247 ((= n (car rom-low-pair)) (cdr rom-low-pair))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
248 ((= n (car rom-high-pair)) (cdr rom-high-pair))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
249 ((= (car rom-low-pair) (car rom-high-pair))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
250 (concat (cdr rom-low-pair)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
251 (Footnote-roman-common
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
252 (- n (car rom-low-pair))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
253 footnote-roman-list)))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
254 ((>= rom-div 0) (concat (cdr rom-div-pair) (cdr rom-high-pair)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
255 (Footnote-roman-common
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
256 (- n (- (car rom-high-pair)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
257 (car rom-div-pair)))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
258 footnote-roman-list)))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
259 (t (concat (cdr rom-low-pair)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
260 (Footnote-roman-common
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
261 (- n (car rom-low-pair))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
262 footnote-roman-list)))))))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
263
27830
99b1d31f039b (footnote): Add :version to defgroup.
Dave Love <fx@gnu.org>
parents: 26815
diff changeset
264 ;; Latin-1
99b1d31f039b (footnote): Add :version to defgroup.
Dave Love <fx@gnu.org>
parents: 26815
diff changeset
265
99b1d31f039b (footnote): Add :version to defgroup.
Dave Love <fx@gnu.org>
parents: 26815
diff changeset
266 (defconst footnote-latin-regexp "¹²³ºª§¶"
99b1d31f039b (footnote): Add :version to defgroup.
Dave Love <fx@gnu.org>
parents: 26815
diff changeset
267 "Regexp for Latin-1 footnoting characters.")
99b1d31f039b (footnote): Add :version to defgroup.
Dave Love <fx@gnu.org>
parents: 26815
diff changeset
268
99b1d31f039b (footnote): Add :version to defgroup.
Dave Love <fx@gnu.org>
parents: 26815
diff changeset
269 (defun Footnote-latin (n)
99b1d31f039b (footnote): Add :version to defgroup.
Dave Love <fx@gnu.org>
parents: 26815
diff changeset
270 "Latin-1 footnote style.
99b1d31f039b (footnote): Add :version to defgroup.
Dave Love <fx@gnu.org>
parents: 26815
diff changeset
271 Use a range of Latin-1 non-ASCII characters for footnoting."
99b1d31f039b (footnote): Add :version to defgroup.
Dave Love <fx@gnu.org>
parents: 26815
diff changeset
272 (string (aref footnote-latin-regexp
99b1d31f039b (footnote): Add :version to defgroup.
Dave Love <fx@gnu.org>
parents: 26815
diff changeset
273 (mod (1- n) (length footnote-latin-regexp)))))
99b1d31f039b (footnote): Add :version to defgroup.
Dave Love <fx@gnu.org>
parents: 26815
diff changeset
274
26784
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
275 ;;; list of all footnote styles
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
276 (defvar footnote-style-alist
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
277 `((numeric Footnote-numeric ,footnote-numeric-regexp)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
278 (english-lower Footnote-english-lower ,footnote-english-lower-regexp)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
279 (english-upper Footnote-english-upper ,footnote-english-upper-regexp)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
280 (roman-lower Footnote-roman-lower ,footnote-roman-lower-regexp)
27830
99b1d31f039b (footnote): Add :version to defgroup.
Dave Love <fx@gnu.org>
parents: 26815
diff changeset
281 (roman-upper Footnote-roman-upper ,footnote-roman-upper-regexp)
99b1d31f039b (footnote): Add :version to defgroup.
Dave Love <fx@gnu.org>
parents: 26815
diff changeset
282 (latin Footnote-latin ,footnote-latin-regexp))
26784
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
283 "Styles of footnote tags available.
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
284 By default only boring Arabic numbers, English letters and Roman Numerals
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
285 are available.
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
286 See footnote-han.el, footnote-greek.el and footnote-hebrew.el for more
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
287 exciting styles.")
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
288
27830
99b1d31f039b (footnote): Add :version to defgroup.
Dave Love <fx@gnu.org>
parents: 26815
diff changeset
289 (defcustom footnote-style 'numeric
99b1d31f039b (footnote): Add :version to defgroup.
Dave Love <fx@gnu.org>
parents: 26815
diff changeset
290 "*Style used for footnoting.
99b1d31f039b (footnote): Add :version to defgroup.
Dave Love <fx@gnu.org>
parents: 26815
diff changeset
291 numeric == 1, 2, 3, ...
99b1d31f039b (footnote): Add :version to defgroup.
Dave Love <fx@gnu.org>
parents: 26815
diff changeset
292 english-lower == a, b, c, ...
99b1d31f039b (footnote): Add :version to defgroup.
Dave Love <fx@gnu.org>
parents: 26815
diff changeset
293 english-upper == A, B, C, ...
99b1d31f039b (footnote): Add :version to defgroup.
Dave Love <fx@gnu.org>
parents: 26815
diff changeset
294 roman-lower == i, ii, iii, iv, v, ...
99b1d31f039b (footnote): Add :version to defgroup.
Dave Love <fx@gnu.org>
parents: 26815
diff changeset
295 roman-upper == I, II, III, IV, V, ...
99b1d31f039b (footnote): Add :version to defgroup.
Dave Love <fx@gnu.org>
parents: 26815
diff changeset
296 latin == ¹ ² ³ º ª § ¶
99b1d31f039b (footnote): Add :version to defgroup.
Dave Love <fx@gnu.org>
parents: 26815
diff changeset
297 See also variables `footnote-start-tag' and `footnote-end-tag'."
99b1d31f039b (footnote): Add :version to defgroup.
Dave Love <fx@gnu.org>
parents: 26815
diff changeset
298 :type (cons 'choice (mapcar (lambda (x) (list 'const (car x)))
99b1d31f039b (footnote): Add :version to defgroup.
Dave Love <fx@gnu.org>
parents: 26815
diff changeset
299 footnote-style-alist))
99b1d31f039b (footnote): Add :version to defgroup.
Dave Love <fx@gnu.org>
parents: 26815
diff changeset
300 :group 'footnote)
99b1d31f039b (footnote): Add :version to defgroup.
Dave Love <fx@gnu.org>
parents: 26815
diff changeset
301
26784
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
302 ;;; Style utilities & functions
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
303 (defun Footnote-style-p (style)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
304 "Return non-nil if style is a valid style known to footnote-mode."
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
305 (assq style footnote-style-alist))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
306
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
307 (defun Footnote-index-to-string (index)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
308 "Convert a binary index into a string to display as a footnote.
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
309 Conversion is done based upon the current selected style."
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
310 (let ((alist (if (Footnote-style-p footnote-style)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
311 (assq footnote-style footnote-style-alist)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
312 (nth 0 footnote-style-alist))))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
313 (funcall (nth 1 alist) index)))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
314
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
315 (defun Footnote-current-regexp ()
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
316 "Return the regexp of the index of the current style."
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
317 (concat (nth 2 (or (assq footnote-style footnote-style-alist)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
318 (nth 0 footnote-style-alist))) "*"))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
319
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
320 (defun Footnote-refresh-footnotes (&optional index-regexp)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
321 "Redraw all footnotes.
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
322 You must call this or arrange to have this called after changing footnote
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
323 styles."
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
324 (unless index-regexp
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
325 (setq index-regexp (Footnote-current-regexp)))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
326 (save-excursion
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
327 ;; Take care of the pointers first
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
328 (let ((i 0) locn alist)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
329 (while (setq alist (nth i footnote-pointer-marker-alist))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
330 (setq locn (cdr alist))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
331 (while locn
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
332 (goto-char (car locn))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
333 (search-backward footnote-start-tag nil t)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
334 (when (looking-at (concat
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
335 (regexp-quote footnote-start-tag)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
336 "\\(" index-regexp "\\)"
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
337 (regexp-quote footnote-end-tag)))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
338 (replace-match (concat
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
339 footnote-start-tag
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
340 (Footnote-index-to-string (1+ i))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
341 footnote-end-tag)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
342 nil "\\1"))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
343 (setq locn (cdr locn)))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
344 (setq i (1+ i))))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
345
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
346 ;; Now take care of the text section
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
347 (let ((i 0) alist)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
348 (while (setq alist (nth i footnote-text-marker-alist))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
349 (goto-char (cdr alist))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
350 (when (looking-at (concat
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
351 (regexp-quote footnote-start-tag)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
352 "\\(" index-regexp "\\)"
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
353 (regexp-quote footnote-end-tag)))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
354 (replace-match (concat
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
355 footnote-start-tag
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
356 (Footnote-index-to-string (1+ i))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
357 footnote-end-tag)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
358 nil "\\1"))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
359 (setq i (1+ i))))))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
360
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
361 (defun Footnote-assoc-index (key alist)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
362 "Give index of key in alist."
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
363 (let ((i 0) (max (length alist)) rc)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
364 (while (and (null rc)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
365 (< i max))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
366 (when (eq key (car (nth i alist)))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
367 (setq rc i))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
368 (setq i (1+ i)))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
369 rc))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
370
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
371 (defun Footnote-cycle-style ()
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
372 "Select next defined footnote style."
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
373 (interactive)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
374 (let ((old (Footnote-assoc-index footnote-style footnote-style-alist))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
375 (max (length footnote-style-alist))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
376 idx)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
377 (setq idx (1+ old))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
378 (when (>= idx max)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
379 (setq idx 0))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
380 (setq footnote-style (car (nth idx footnote-style-alist)))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
381 (Footnote-refresh-footnotes (nth 2 (nth old footnote-style-alist)))))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
382
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
383 (defun Footnote-set-style (&optional style)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
384 "Select a specific style."
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
385 (interactive
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
386 (list (intern (completing-read
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
387 "Footnote Style: "
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
388 obarray #'Footnote-style-p 'require-match))))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
389 (setq footnote-style style))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
390
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
391 ;; Internal functions
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
392 (defun Footnote-insert-numbered-footnote (arg &optional mousable)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
393 "Insert numbered footnote at (point)."
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
394 (let* ((start (point))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
395 (end (progn
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
396 (insert-before-markers (concat footnote-start-tag
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
397 (Footnote-index-to-string arg)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
398 footnote-end-tag))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
399 (point))))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
400
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
401 (add-text-properties start end
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
402 (list 'footnote-number arg))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
403 (when mousable
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
404 (add-text-properties start end
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
405 (list footnote-mouse-highlight t)))))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
406
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
407 (defun Footnote-renumber (from to pointer-alist text-alist)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
408 "Renumber a single footnote."
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
409 (let* ((posn-list (cdr pointer-alist)))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
410 (setcar pointer-alist to)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
411 (setcar text-alist to)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
412 (while posn-list
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
413 (goto-char (car posn-list))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
414 (search-backward footnote-start-tag nil t)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
415 (when (looking-at (format "%s%s%s"
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
416 (regexp-quote footnote-start-tag)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
417 (Footnote-current-regexp)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
418 (regexp-quote footnote-end-tag)))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
419 (add-text-properties (match-beginning 0) (match-end 0)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
420 (list 'footnote-number to))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
421 (replace-match (format "%s%s%s"
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
422 footnote-start-tag
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
423 (Footnote-index-to-string to)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
424 footnote-end-tag)))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
425 (setq posn-list (cdr posn-list)))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
426 (goto-char (cdr text-alist))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
427 (when (looking-at (format "%s%s%s"
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
428 (regexp-quote footnote-start-tag)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
429 (Footnote-current-regexp)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
430 (regexp-quote footnote-end-tag)))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
431 (add-text-properties (match-beginning 0) (match-end 0)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
432 (list 'footnote-number to))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
433 (replace-match (format "%s%s%s"
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
434 footnote-start-tag
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
435 (Footnote-index-to-string to)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
436 footnote-end-tag) nil t))))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
437
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
438 ;; Not needed?
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
439 (defun Footnote-narrow-to-footnotes ()
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
440 "Restrict text in buffer to show only text of footnotes."
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
441 (interactive) ; testing
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
442 (goto-char (point-max))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
443 (when (re-search-backward footnote-signature-separator nil t)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
444 (let ((end (point)))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
445 (when (re-search-backward (concat "^" footnote-section-tag-regexp) nil t)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
446 (narrow-to-region (point) end)))))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
447
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
448 (defun Footnote-goto-char-point-max ()
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
449 "Move to end of buffer or prior to start of .signature."
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
450 (goto-char (point-max))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
451 (or (re-search-backward footnote-signature-separator nil t)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
452 (point)))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
453
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
454 (defun Footnote-insert-text-marker (arg locn)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
455 "Insert a marker pointing to footnote arg, at buffer location locn."
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
456 (let ((marker (make-marker)))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
457 (unless (assq arg footnote-text-marker-alist)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
458 (set-marker marker locn)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
459 (setq footnote-text-marker-alist
26815
9fa9fd18d083 Require cl when compiling. Don't autoload kemap and minor-mode-alist
Dave Love <fx@gnu.org>
parents: 26784
diff changeset
460 (cons (cons arg marker) footnote-text-marker-alist))
26784
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
461 (setq footnote-text-marker-alist
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
462 (Footnote-sort footnote-text-marker-alist)))))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
463
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
464 (defun Footnote-insert-pointer-marker (arg locn)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
465 "Insert a marker pointing to footnote arg, at buffer location locn."
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
466 (let ((marker (make-marker))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
467 alist)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
468 (set-marker marker locn)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
469 (if (setq alist (assq arg footnote-pointer-marker-alist))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
470 (setf alist
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
471 (cons marker (cdr alist)))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
472 (setq footnote-pointer-marker-alist
26815
9fa9fd18d083 Require cl when compiling. Don't autoload kemap and minor-mode-alist
Dave Love <fx@gnu.org>
parents: 26784
diff changeset
473 (cons (cons arg (list marker)) footnote-pointer-marker-alist))
26784
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
474 (setq footnote-pointer-marker-alist
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
475 (Footnote-sort footnote-pointer-marker-alist)))))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
476
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
477 (defun Footnote-insert-footnote (arg)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
478 "Insert a footnote numbered arg, at (point)."
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
479 (push-mark)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
480 (Footnote-insert-pointer-marker arg (point))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
481 (Footnote-insert-numbered-footnote arg t)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
482 (Footnote-goto-char-point-max)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
483 (if (re-search-backward (concat "^" footnote-section-tag-regexp) nil t)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
484 (save-restriction
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
485 (when footnote-narrow-to-footnotes-when-editing
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
486 (Footnote-narrow-to-footnotes))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
487 (Footnote-goto-footnote (1- arg)) ; evil, FIXME (less evil now)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
488 ;; (message "Inserting footnote %d" arg)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
489 (unless
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
490 (or (eq arg 1)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
491 (when (re-search-forward
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
492 (if footnote-spaced-footnotes
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
493 "\n\n"
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
494 (concat "\n"
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
495 (regexp-quote footnote-start-tag)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
496 (Footnote-current-regexp)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
497 (regexp-quote footnote-end-tag)))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
498 nil t)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
499 (unless (beginning-of-line) t))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
500 (goto-char (point-max)))))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
501 (unless (looking-at "^$")
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
502 (insert "\n"))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
503 (when (eobp)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
504 (insert "\n"))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
505 (insert footnote-section-tag "\n"))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
506 (let ((old-point (point)))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
507 (Footnote-insert-numbered-footnote arg nil)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
508 (Footnote-insert-text-marker arg old-point)))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
509
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
510 (defun Footnote-sort (list)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
511 (sort list (lambda (e1 e2)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
512 (< (car e1) (car e2)))))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
513
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
514 (defun Footnote-text-under-cursor ()
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
515 "Return the number of footnote if in footnote text.
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
516 Nil is returned if the cursor is not positioned over the text of
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
517 a footnote."
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
518 (when (and (let ((old-point (point)))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
519 (save-excursion
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
520 (save-restriction
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
521 (Footnote-narrow-to-footnotes)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
522 (and (>= old-point (point-min))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
523 (<= old-point (point-max))))))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
524 (>= (point) (cdar footnote-text-marker-alist)))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
525 (let ((i 1)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
526 alist-txt rc)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
527 (while (and (setq alist-txt (nth i footnote-text-marker-alist))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
528 (null rc))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
529 (when (< (point) (cdr alist-txt))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
530 (setq rc (car (nth (1- i) footnote-text-marker-alist))))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
531 (setq i (1+ i)))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
532 (when (and (null rc)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
533 (null alist-txt))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
534 (setq rc (car (nth (1- i) footnote-text-marker-alist))))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
535 rc)))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
536
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
537 (defun Footnote-under-cursor ()
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
538 "Return the number of the footnote underneath the cursor.
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
539 Nil is returned if the cursor is not over a footnote."
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
540 (or (get-text-property (point) 'footnote-number)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
541 (Footnote-text-under-cursor)))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
542
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
543 ;;; User functions
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
544
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
545 (defun Footnote-make-hole ()
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
546 (save-excursion
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
547 (let ((i 0)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
548 (notes (length footnote-pointer-marker-alist))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
549 alist-ptr alist-txt rc)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
550 (while (< i notes)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
551 (setq alist-ptr (nth i footnote-pointer-marker-alist))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
552 (setq alist-txt (nth i footnote-text-marker-alist))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
553 (when (< (point) (- (cadr alist-ptr) 3))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
554 (unless rc
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
555 (setq rc (car alist-ptr)))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
556 (save-excursion
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
557 (message "Renumbering from %s to %s"
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
558 (Footnote-index-to-string (car alist-ptr))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
559 (Footnote-index-to-string
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
560 (1+ (car alist-ptr))))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
561 (Footnote-renumber (car alist-ptr)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
562 (1+ (car alist-ptr))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
563 alist-ptr
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
564 alist-txt)))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
565 (setq i (1+ i)))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
566 rc)))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
567
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
568 (defun Footnote-add-footnote (&optional arg)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
569 "Add a numbered footnote.
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
570 The number the footnote receives is dependent upon the relative location
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
571 of any other previously existing footnotes.
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
572 If the variable `footnote-narrow-to-footnotes-when-editing' is set,
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
573 the buffer is narrowed to the footnote body. The restriction is removed
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
574 by using `Footnote-back-to-message'."
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
575 (interactive "*P")
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
576 (let (num)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
577 (if footnote-text-marker-alist
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
578 (if (< (point) (cadar (last footnote-pointer-marker-alist)))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
579 (setq num (Footnote-make-hole))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
580 (setq num (1+ (caar (last footnote-text-marker-alist)))))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
581 (setq num 1))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
582 (message "Adding footnote %d" num)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
583 (Footnote-insert-footnote num)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
584 (insert-before-markers (make-string footnote-body-tag-spacing ? ))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
585 (let ((opoint (point)))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
586 (save-excursion
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
587 (insert-before-markers
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
588 (if footnote-spaced-footnotes
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
589 "\n\n"
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
590 "\n"))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
591 (when footnote-narrow-to-footnotes-when-editing
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
592 (Footnote-narrow-to-footnotes)))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
593 ;; Emacs/XEmacs bug? save-excursion doesn't restore point when using
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
594 ;; insert-before-markers.
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
595 (goto-char opoint))))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
596
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
597 (defun Footnote-delete-footnote (&optional arg)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
598 "Delete a numbered footnote.
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
599 With no parameter, delete the footnote under (point). With arg specified,
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
600 delete the footnote with that number."
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
601 (interactive "*P")
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
602 (unless arg
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
603 (setq arg (Footnote-under-cursor)))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
604 (when (and arg
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
605 (or (not footnote-prompt-before-deletion)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
606 (y-or-n-p (format "Really delete footnote %d?" arg))))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
607 (let (alist-ptr alist-txt locn)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
608 (setq alist-ptr (assq arg footnote-pointer-marker-alist))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
609 (setq alist-txt (assq arg footnote-text-marker-alist))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
610 (unless (and alist-ptr alist-txt)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
611 (error "Can't delete footnote %d" arg))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
612 (setq locn (cdr alist-ptr))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
613 (while (car locn)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
614 (save-excursion
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
615 (goto-char (car locn))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
616 (let* ((end (point))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
617 (start (search-backward footnote-start-tag nil t)))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
618 (kill-region start end)))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
619 (setq locn (cdr locn)))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
620 (save-excursion
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
621 (goto-char (cdr alist-txt))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
622 (kill-region (point) (search-forward "\n\n" nil t)))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
623 (setq footnote-pointer-marker-alist
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
624 (delq alist-ptr footnote-pointer-marker-alist))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
625 (setq footnote-text-marker-alist
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
626 (delq alist-txt footnote-text-marker-alist))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
627 (Footnote-renumber-footnotes)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
628 (when (and (null footnote-text-marker-alist)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
629 (null footnote-pointer-marker-alist))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
630 (save-excursion
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
631 (let* ((end (Footnote-goto-char-point-max))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
632 (start (1- (re-search-backward
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
633 (concat "^" footnote-section-tag-regexp)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
634 nil t))))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
635 (forward-line -1)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
636 (when (looking-at "\n")
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
637 (kill-line))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
638 (kill-region start (if (< end (point-max))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
639 end
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
640 (point-max)))))))))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
641
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
642 (defun Footnote-renumber-footnotes (&optional arg)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
643 "Renumber footnotes, starting from 1."
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
644 (interactive "*P")
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
645 (save-excursion
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
646 (let ((i 0)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
647 (notes (length footnote-pointer-marker-alist))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
648 alist-ptr alist-txt)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
649 (while (< i notes)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
650 (setq alist-ptr (nth i footnote-pointer-marker-alist))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
651 (setq alist-txt (nth i footnote-text-marker-alist))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
652 (unless (eq (1+ i) (car alist-ptr))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
653 (Footnote-renumber (car alist-ptr) (1+ i) alist-ptr alist-txt))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
654 (setq i (1+ i))))))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
655
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
656 (defun Footnote-goto-footnote (&optional arg)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
657 "Jump to the text of a footnote.
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
658 With no parameter, jump to the text of the footnote under (point). With arg
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
659 specified, jump to the text of that footnote."
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
660 (interactive "P")
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
661 (let (footnote)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
662 (if arg
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
663 (setq footnote (assq arg footnote-text-marker-alist))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
664 (when (setq arg (Footnote-under-cursor))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
665 (setq footnote (assq arg footnote-text-marker-alist))))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
666 (if footnote
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
667 (goto-char (cdr footnote))
27830
99b1d31f039b (footnote): Add :version to defgroup.
Dave Love <fx@gnu.org>
parents: 26815
diff changeset
668 (if (eq arg 0)
26784
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
669 (progn
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
670 (goto-char (point-max))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
671 (re-search-backward (concat "^" footnote-section-tag-regexp))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
672 (forward-line 1))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
673 (error "I don't see a footnote here.")))))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
674
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
675 (defun Footnote-back-to-message (&optional arg)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
676 "Move cursor back to footnote referent.
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
677 If the cursor is not over the text of a footnote, point is not changed.
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
678 If the buffer was narrowed due to `footnote-narrow-to-footnotes-when-editing'
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
679 being set it is automatically widened."
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
680 (interactive "P")
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
681 (let ((note (Footnote-text-under-cursor)))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
682 (when note
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
683 (when footnote-narrow-to-footnotes-when-editing
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
684 (widen))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
685 (goto-char (cadr (assq note footnote-pointer-marker-alist))))))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
686
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
687 (defvar footnote-mode-map nil
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
688 "Keymap used for footnote minor mode.")
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
689
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
690 ;; Set up our keys
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
691 (unless footnote-mode-map
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
692 (setq footnote-mode-map (make-sparse-keymap))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
693 (define-key footnote-mode-map "a" 'Footnote-add-footnote)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
694 (define-key footnote-mode-map "b" 'Footnote-back-to-message)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
695 (define-key footnote-mode-map "c" 'Footnote-cycle-style)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
696 (define-key footnote-mode-map "d" 'Footnote-delete-footnote)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
697 (define-key footnote-mode-map "g" 'Footnote-goto-footnote)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
698 (define-key footnote-mode-map "r" 'Footnote-renumber-footnotes)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
699 (define-key footnote-mode-map "s" 'Footnote-set-style))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
700
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
701 (defvar footnote-minor-mode-map nil
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
702 "Keymap used for binding footnote minor mode.")
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
703
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
704 (unless footnote-minor-mode-map
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
705 (define-key global-map footnote-prefix footnote-mode-map))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
706
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
707 ;;;###autoload
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
708 (defun footnote-mode (&optional arg)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
709 "Toggle footnote minor mode.
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
710 \\<message-mode-map>
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
711 key binding
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
712 --- -------
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
713
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
714 \\[Footnote-renumber-footnotes] Footnote-renumber-footnotes
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
715 \\[Footnote-goto-footnote] Footnote-goto-footnote
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
716 \\[Footnote-delete-footnote] Footnote-delete-footnote
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
717 \\[Footnote-cycle-style] Footnote-cycle-style
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
718 \\[Footnote-back-to-message] Footnote-back-to-message
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
719 \\[Footnote-add-footnote] Footnote-add-footnote
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
720 "
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
721 (interactive "*P")
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
722 ;; (filladapt-mode t)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
723 (setq footnote-mode
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
724 (if (null arg) (not footnote-mode)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
725 (> (prefix-numeric-value arg) 0)))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
726 (when footnote-mode
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
727 ;; (Footnote-setup-keybindings)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
728 (make-local-variable 'footnote-style)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
729 (if (fboundp 'force-mode-line-update)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
730 (force-mode-line-update)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
731 (set-buffer-modified-p (buffer-modified-p)))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
732
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
733 (when (boundp 'filladapt-token-table)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
734 ;; add tokens to filladapt to match footnotes
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
735 ;; 1] xxxxxxxxxxx x x x or [1] x x x x x x x
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
736 ;; xxx x xx xxx xxxx x x x xxxxxxxxxx
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
737 (let ((bullet-regexp (concat (regexp-quote footnote-start-tag)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
738 "?[0-9a-zA-Z]+"
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
739 (regexp-quote footnote-end-tag)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
740 "[ \t]")))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
741 (unless (assoc bullet-regexp filladapt-token-table)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
742 (setq filladapt-token-table
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
743 (append filladapt-token-table
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
744 (list (list bullet-regexp 'bullet)))))))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
745
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
746 (run-hooks 'footnote-mode-hook)))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
747
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
748 (unless (assq 'footnote-mode minor-mode-alist)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
749 (setq minor-mode-alist
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
750 (cons '(footnote-mode footnote-mode-line-string)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
751 minor-mode-alist)))
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
752
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
753 (provide 'footnote)
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
754
4d1698b6a3bb Current XEmacs version.
Dave Love <fx@gnu.org>
parents:
diff changeset
755 ;;; footnote.el ends here