org-footnote.el 35 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924
  1. ;;; org-footnote.el --- Footnote support in Org and elsewhere
  2. ;;
  3. ;; Copyright (C) 2009-2012 Free Software Foundation, Inc.
  4. ;;
  5. ;; Author: Carsten Dominik <carsten at orgmode dot org>
  6. ;; Keywords: outlines, hypermedia, calendar, wp
  7. ;; Homepage: http://orgmode.org
  8. ;;
  9. ;; This file is part of GNU Emacs.
  10. ;;
  11. ;; GNU Emacs is free software: you can redistribute it and/or modify
  12. ;; it under the terms of the GNU General Public License as published by
  13. ;; the Free Software Foundation, either version 3 of the License, or
  14. ;; (at your option) any later version.
  15. ;; GNU Emacs is distributed in the hope that it will be useful,
  16. ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  17. ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  18. ;; GNU General Public License for more details.
  19. ;; You should have received a copy of the GNU General Public License
  20. ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
  21. ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
  22. ;;
  23. ;;; Commentary:
  24. ;; This file contains the code dealing with footnotes in Org-mode.
  25. ;; The code can also be used in arbitrary text modes to provide
  26. ;; footnotes. Compared to Steven L Baur's footnote.el it provides
  27. ;; better support for resuming editing. It is less configurable than
  28. ;; Steve's code, though.
  29. ;;; Code:
  30. (eval-when-compile
  31. (require 'cl))
  32. (require 'org-macs)
  33. (require 'org-compat)
  34. (declare-function message-point-in-header-p "message" ())
  35. (declare-function org-back-over-empty-lines "org" ())
  36. (declare-function org-back-to-heading "org" (&optional invisible-ok))
  37. (declare-function org-combine-plists "org" (&rest plists))
  38. (declare-function org-end-of-subtree "org" (&optional invisible-ok to-heading))
  39. (declare-function org-export-preprocess-string "org-exp"
  40. (string &rest parameters))
  41. (declare-function org-fill-paragraph "org" (&optional justify))
  42. (declare-function org-icompleting-read "org" (&rest args))
  43. (declare-function org-id-uuid "org-id" ())
  44. (declare-function org-in-block-p "org" (names))
  45. (declare-function org-in-commented-line "org" ())
  46. (declare-function org-in-indented-comment-line "org" ())
  47. (declare-function org-in-regexp "org" (re &optional nlines visually))
  48. (declare-function org-in-verbatim-emphasis "org" ())
  49. (declare-function org-inside-LaTeX-fragment-p "org" ())
  50. (declare-function org-inside-latex-macro-p "org" ())
  51. (declare-function org-mark-ring-push "org" (&optional pos buffer))
  52. (declare-function org-show-context "org" (&optional key))
  53. (declare-function org-trim "org" (s))
  54. (declare-function outline-next-heading "outline")
  55. (defvar org-outline-regexp-bol) ; defined in org.el
  56. (defvar org-odd-levels-only) ; defined in org.el
  57. (defvar org-bracket-link-regexp) ; defined in org.el
  58. (defvar message-cite-prefix-regexp) ; defined in message.el
  59. (defvar message-signature-separator) ; defined in message.el
  60. (defconst org-footnote-re
  61. ;; Only [1]-like footnotes are closed in this regexp, as footnotes
  62. ;; from other types might contain square brackets (i.e. links) in
  63. ;; their definition.
  64. ;;
  65. ;; `org-re' is used for regexp compatibility with XEmacs.
  66. (concat "\\[\\(?:"
  67. ;; Match inline footnotes.
  68. (org-re "fn:\\([-_[:word:]]+\\)?:\\|")
  69. ;; Match other footnotes.
  70. "\\(?:\\([0-9]+\\)\\]\\)\\|"
  71. (org-re "\\(fn:[-_[:word:]]+\\)")
  72. "\\)")
  73. "Regular expression for matching footnotes.")
  74. (defconst org-footnote-definition-re
  75. (org-re "^\\[\\([0-9]+\\|fn:[-_[:word:]]+\\)\\]")
  76. "Regular expression matching the definition of a footnote.")
  77. (defvar org-footnote-forbidden-blocks '("example" "verse" "src" "ascii" "beamer"
  78. "docbook" "html" "latex" "odt")
  79. "Names of blocks where footnotes are not allowed.")
  80. (defgroup org-footnote nil
  81. "Footnotes in Org-mode."
  82. :tag "Org Footnote"
  83. :group 'org)
  84. (defcustom org-footnote-section "Footnotes"
  85. "Outline heading containing footnote definitions before export.
  86. This can be nil, to place footnotes locally at the end of the current
  87. outline node. If can also be the name of a special outline heading
  88. under which footnotes should be put.
  89. This variable defines the place where Org puts the definition
  90. automatically, i.e. when creating the footnote, and when sorting the notes.
  91. However, by hand you may place definitions *anywhere*.
  92. If this is a string, during export, all subtrees starting with this
  93. heading will be removed after extracting footnote definitions."
  94. :group 'org-footnote
  95. :type '(choice
  96. (string :tag "Collect footnotes under heading")
  97. (const :tag "Define footnotes locally" nil)))
  98. (defcustom org-footnote-tag-for-non-org-mode-files "Footnotes:"
  99. "Tag marking the beginning of footnote section.
  100. The Org footnote engine can be used in arbitrary text files as well
  101. as in Org-mode. Outside Org mode, new footnotes are always placed at
  102. the end of the file. When you normalize the notes, any line containing
  103. only this tag will be removed, a new one will be inserted at the end
  104. of the file, followed by the collected and normalized footnotes.
  105. If you don't want any tag in such buffers, set this variable to nil."
  106. :group 'org-footnote
  107. :type '(choice
  108. (string :tag "Collect footnotes under tag")
  109. (const :tag "Don't use a tag" nil)))
  110. (defcustom org-footnote-define-inline nil
  111. "Non-nil means define footnotes inline, at reference location.
  112. When nil, footnotes will be defined in a special section near
  113. the end of the document. When t, the [fn:label:definition] notation
  114. will be used to define the footnote at the reference position."
  115. :group 'org-footnote
  116. :type 'boolean)
  117. (defcustom org-footnote-auto-label t
  118. "Non-nil means define automatically new labels for footnotes.
  119. Possible values are:
  120. nil prompt the user for each label
  121. t create unique labels of the form [fn:1], [fn:2], ...
  122. confirm like t, but let the user edit the created value. In particular,
  123. the label can be removed from the minibuffer, to create
  124. an anonymous footnote.
  125. random Automatically generate a unique, random label.
  126. plain Automatically create plain number labels like [1]"
  127. :group 'org-footnote
  128. :type '(choice
  129. (const :tag "Prompt for label" nil)
  130. (const :tag "Create automatic [fn:N]" t)
  131. (const :tag "Offer automatic [fn:N] for editing" confirm)
  132. (const :tag "Create a random label" random)
  133. (const :tag "Create automatic [N]" plain)))
  134. (defcustom org-footnote-auto-adjust nil
  135. "Non-nil means automatically adjust footnotes after insert/delete.
  136. When this is t, after each insertion or deletion of a footnote,
  137. simple fn:N footnotes will be renumbered, and all footnotes will be sorted.
  138. If you want to have just sorting or just renumbering, set this variable
  139. to `sort' or `renumber'.
  140. The main values of this variable can be set with in-buffer options:
  141. #+STARTUP: fnadjust
  142. #+STARTUP: nofnadjust"
  143. :group 'org-footnote
  144. :type '(choice
  145. (const :tag "Renumber" renumber)
  146. (const :tag "Sort" sort)
  147. (const :tag "Renumber and Sort" t)))
  148. (defcustom org-footnote-fill-after-inline-note-extraction nil
  149. "Non-nil means fill paragraphs after extracting footnotes.
  150. When extracting inline footnotes, the lengths of lines can change a lot.
  151. When this option is set, paragraphs from which an inline footnote has been
  152. extracted will be filled again."
  153. :group 'org-footnote
  154. :type 'boolean)
  155. (defun org-footnote-in-valid-context-p ()
  156. "Is point in a context where footnotes are allowed?"
  157. (save-match-data
  158. (not (or (org-in-commented-line)
  159. (org-in-indented-comment-line)
  160. (org-inside-LaTeX-fragment-p)
  161. ;; Avoid protected environments (LaTeX export)
  162. (get-text-property (point) 'org-protected)
  163. ;; Avoid literal example.
  164. (org-in-verbatim-emphasis)
  165. (save-excursion
  166. (beginning-of-line)
  167. (looking-at "[ \t]*:[ \t]+"))
  168. ;; Avoid cited text and headers in message-mode.
  169. (and (derived-mode-p 'message-mode)
  170. (or (save-excursion
  171. (beginning-of-line)
  172. (looking-at message-cite-prefix-regexp))
  173. (message-point-in-header-p)))
  174. ;; Avoid forbidden blocks.
  175. (org-in-block-p org-footnote-forbidden-blocks)))))
  176. (defun org-footnote-at-reference-p ()
  177. "Is the cursor at a footnote reference?
  178. If so, return a list containing its label, beginning and ending
  179. positions, and the definition, when inlined."
  180. (when (and (org-footnote-in-valid-context-p)
  181. (or (looking-at org-footnote-re)
  182. (org-in-regexp org-footnote-re)
  183. (save-excursion (re-search-backward org-footnote-re nil t)))
  184. (/= (match-beginning 0) (point-at-bol)))
  185. (let* ((beg (match-beginning 0))
  186. (label (or (org-match-string-no-properties 2)
  187. (org-match-string-no-properties 3)
  188. ;; Anonymous footnotes don't have labels
  189. (and (match-string 1)
  190. (concat "fn:" (org-match-string-no-properties 1)))))
  191. ;; Inline footnotes don't end at (match-end 0) as
  192. ;; `org-footnote-re' stops just after the second colon.
  193. ;; Find the real ending with `scan-sexps', so Org doesn't
  194. ;; get fooled by unrelated closing square brackets.
  195. (end (ignore-errors (scan-sexps beg 1))))
  196. ;; Point is really at a reference if it's located before true
  197. ;; ending of the footnote.
  198. (when (and end (< (point) end)
  199. ;; Verify match isn't a part of a link.
  200. (not (save-excursion
  201. (goto-char beg)
  202. (let ((linkp
  203. (save-match-data
  204. (org-in-regexp org-bracket-link-regexp))))
  205. (and linkp (< (point) (cdr linkp))))))
  206. ;; Verify point doesn't belong to a LaTeX macro.
  207. ;; Beware though, when two footnotes are side by
  208. ;; side, once the first one is changed into LaTeX,
  209. ;; the second one might then be considered as an
  210. ;; optional argument of the command. Thus, check
  211. ;; the `org-protected' property of that command.
  212. (or (not (org-inside-latex-macro-p))
  213. (get-text-property (1- beg) 'org-protected)))
  214. (list label beg end
  215. ;; Definition: ensure this is an inline footnote first.
  216. (and (or (not label) (match-string 1))
  217. (org-trim (buffer-substring-no-properties
  218. (match-end 0) (1- end)))))))))
  219. (defun org-footnote-at-definition-p ()
  220. "Is the cursor at a footnote definition?
  221. This matches only pure definitions like [1] or [fn:name] at the beginning
  222. of a line. It does not match references like [fn:name:definition], where the
  223. footnote text is included and defined locally.
  224. The return value will be nil if not at a footnote definition, and a list with
  225. label, start, end and definition of the footnote otherwise."
  226. (when (save-excursion (beginning-of-line) (org-footnote-in-valid-context-p))
  227. (save-excursion
  228. (end-of-line)
  229. (let ((lim (save-excursion (re-search-backward
  230. (concat org-outline-regexp-bol
  231. "\\|^[ \t]*$") nil t))))
  232. (when (re-search-backward org-footnote-definition-re lim t)
  233. (end-of-line)
  234. (list (org-match-string-no-properties 1)
  235. (match-beginning 0)
  236. (save-match-data
  237. ;; In a message, limit search to signature.
  238. (let ((bound (and (derived-mode-p 'message-mode)
  239. (save-excursion
  240. (goto-char (point-max))
  241. (re-search-backward
  242. message-signature-separator nil t)))))
  243. (or (and (re-search-forward
  244. (concat org-outline-regexp-bol "\\|"
  245. org-footnote-definition-re "\\|"
  246. "^[ \t]*$")
  247. bound 'move)
  248. (progn (skip-chars-forward " \t\n") (point-at-bol)))
  249. (point))))
  250. (org-trim (buffer-substring-no-properties
  251. (match-end 0) (point)))))))))
  252. (defun org-footnote-get-next-reference (&optional label backward limit)
  253. "Return complete reference of the next footnote.
  254. If LABEL is provided, get the next reference of that footnote. If
  255. BACKWARD is non-nil, find previous reference instead. LIMIT is
  256. the buffer position bounding the search.
  257. Return value is a list like those provided by `org-footnote-at-reference-p'.
  258. If no footnote is found, return nil."
  259. (save-excursion
  260. (let* ((label-fmt (if label (format "\\[%s[]:]" label) org-footnote-re)))
  261. (catch 'exit
  262. (while t
  263. (unless (funcall (if backward #'re-search-backward #'re-search-forward)
  264. label-fmt limit t)
  265. (throw 'exit nil))
  266. (unless backward (backward-char))
  267. (let ((ref (org-footnote-at-reference-p)))
  268. (when ref (throw 'exit ref))))))))
  269. (defun org-footnote-next-reference-or-definition (limit)
  270. "Move point to next footnote reference or definition.
  271. LIMIT is the buffer position bounding the search.
  272. Return value is a list like those provided by
  273. `org-footnote-at-reference-p' or `org-footnote-at-definition-p'.
  274. If no footnote is found, return nil."
  275. (let* (ref (origin (point)))
  276. (catch 'exit
  277. (while t
  278. (unless (re-search-forward org-footnote-re limit t)
  279. (goto-char origin)
  280. (throw 'exit nil))
  281. ;; Beware: with [1]-like footnotes point will be just after
  282. ;; the closing square bracket.
  283. (backward-char)
  284. (cond
  285. ((setq ref (org-footnote-at-reference-p))
  286. (throw 'exit ref))
  287. ;; Definition: also grab the last square bracket, only
  288. ;; matched in `org-footnote-re' for [1]-like footnotes.
  289. ((save-match-data (org-footnote-at-definition-p))
  290. (let ((end (match-end 0)))
  291. (throw 'exit
  292. (list nil (match-beginning 0)
  293. (if (eq (char-before end) 93) end (1+ end)))))))))))
  294. (defun org-footnote-get-definition (label)
  295. "Return label, boundaries and definition of the footnote LABEL."
  296. (let* ((label (regexp-quote (org-footnote-normalize-label label)))
  297. (re (format "^\\[%s\\]\\|.\\[%s:" label label))
  298. pos)
  299. (save-excursion
  300. (save-restriction
  301. (when (or (re-search-forward re nil t)
  302. (and (goto-char (point-min))
  303. (re-search-forward re nil t))
  304. (and (progn (widen) t)
  305. (goto-char (point-min))
  306. (re-search-forward re nil t)))
  307. (let ((refp (org-footnote-at-reference-p)))
  308. (cond
  309. ((and (nth 3 refp) refp))
  310. ((org-footnote-at-definition-p)))))))))
  311. (defun org-footnote-goto-definition (label)
  312. "Move point to the definition of the footnote LABEL.
  313. Return a non-nil value when a definition has been found."
  314. (interactive "sLabel: ")
  315. (org-mark-ring-push)
  316. (let ((def (org-footnote-get-definition label)))
  317. (if (not def)
  318. (error "Cannot find definition of footnote %s" label)
  319. (goto-char (nth 1 def))
  320. (looking-at (format "\\[%s\\]\\|\\[%s:" label label))
  321. (goto-char (match-end 0))
  322. (org-show-context 'link-search)
  323. (when (eq major-mode 'org-mode)
  324. (message "Edit definition and go back with `C-c &' or, if unique, with `C-c C-c'."))
  325. t)))
  326. (defun org-footnote-goto-previous-reference (label)
  327. "Find the first closest (to point) reference of footnote with label LABEL."
  328. (interactive "sLabel: ")
  329. (org-mark-ring-push)
  330. (let* ((label (org-footnote-normalize-label label)) ref)
  331. (save-excursion
  332. (setq ref (or (org-footnote-get-next-reference label t)
  333. (org-footnote-get-next-reference label)
  334. (save-restriction
  335. (widen)
  336. (or
  337. (org-footnote-get-next-reference label t)
  338. (org-footnote-get-next-reference label))))))
  339. (if (not ref)
  340. (error "Cannot find reference of footnote %s" label)
  341. (goto-char (nth 1 ref))
  342. (org-show-context 'link-search))))
  343. (defun org-footnote-normalize-label (label)
  344. "Return LABEL as an appropriate string."
  345. (cond
  346. ((numberp label) (number-to-string label))
  347. ((equal "" label) nil)
  348. ((not (string-match "^[0-9]+$\\|^fn:" label))
  349. (concat "fn:" label))
  350. (t label)))
  351. (defun org-footnote-all-labels (&optional with-defs)
  352. "Return list with all defined foot labels used in the buffer.
  353. If WITH-DEFS is non-nil, also associate the definition to each
  354. label. The function will then return an alist whose key is label
  355. and value definition."
  356. (let* (rtn
  357. (push-to-rtn
  358. (function
  359. ;; Depending on WITH-DEFS, store label or (label . def) of
  360. ;; footnote reference/definition given as argument in RTN.
  361. (lambda (el)
  362. (let ((lbl (car el)))
  363. (push (if with-defs (cons lbl (nth 3 el)) lbl) rtn))))))
  364. (save-excursion
  365. (save-restriction
  366. (widen)
  367. ;; Find all labels found in definitions.
  368. (goto-char (point-min))
  369. (let (def)
  370. (while (re-search-forward org-footnote-definition-re nil t)
  371. (when (setq def (org-footnote-at-definition-p))
  372. (funcall push-to-rtn def))))
  373. ;; Find all labels found in references.
  374. (goto-char (point-min))
  375. (let (ref)
  376. (while (setq ref (org-footnote-get-next-reference))
  377. (goto-char (nth 2 ref))
  378. (and (car ref) ; ignore anonymous footnotes
  379. (not (funcall (if with-defs #'assoc #'member) (car ref) rtn))
  380. (funcall push-to-rtn ref))))))
  381. rtn))
  382. (defun org-footnote-unique-label (&optional current)
  383. "Return a new unique footnote label.
  384. The function returns the first \"fn:N\" or \"N\" label that is
  385. currently not used.
  386. Optional argument CURRENT is the list of labels active in the
  387. buffer."
  388. (unless current (setq current (org-footnote-all-labels)))
  389. (let ((fmt (if (eq org-footnote-auto-label 'plain) "%d" "fn:%d"))
  390. (cnt 1))
  391. (while (member (format fmt cnt) current)
  392. (incf cnt))
  393. (format fmt cnt)))
  394. (defun org-footnote-new ()
  395. "Insert a new footnote.
  396. This command prompts for a label. If this is a label referencing an
  397. existing label, only insert the label. If the footnote label is empty
  398. or new, let the user edit the definition of the footnote."
  399. (interactive)
  400. (unless (org-footnote-in-valid-context-p)
  401. (error "Cannot insert a footnote here"))
  402. (let* ((lbls (and (not (equal org-footnote-auto-label 'random))
  403. (org-footnote-all-labels)))
  404. (propose (org-footnote-unique-label lbls))
  405. (label
  406. (org-footnote-normalize-label
  407. (cond
  408. ((member org-footnote-auto-label '(t plain))
  409. propose)
  410. ((equal org-footnote-auto-label 'random)
  411. (require 'org-id)
  412. (substring (org-id-uuid) 0 8))
  413. (t
  414. (org-icompleting-read
  415. "Label (leave empty for anonymous): "
  416. (mapcar 'list lbls) nil nil
  417. (if (eq org-footnote-auto-label 'confirm) propose nil)))))))
  418. (cond
  419. ((bolp) (error "Cannot create a footnote reference at left margin"))
  420. ((not label)
  421. (insert "[fn:: ]")
  422. (backward-char 1))
  423. ((member label lbls)
  424. (insert "[" label "]")
  425. (message "New reference to existing note"))
  426. (org-footnote-define-inline
  427. (insert "[" label ": ]")
  428. (backward-char 1)
  429. (org-footnote-auto-adjust-maybe))
  430. (t
  431. (insert "[" label "]")
  432. (org-footnote-create-definition label)
  433. (org-footnote-auto-adjust-maybe)))))
  434. (defvar org-blank-before-new-entry nil) ; silence byte-compiler
  435. (defun org-footnote-create-definition (label)
  436. "Start the definition of a footnote with label LABEL."
  437. (interactive "sLabel: ")
  438. (let ((label (org-footnote-normalize-label label)))
  439. (cond
  440. ;; In an Org file.
  441. ((eq major-mode 'org-mode)
  442. ;; If `org-footnote-section' is defined, find it, or create it
  443. ;; at the end of the buffer.
  444. (when org-footnote-section
  445. (goto-char (point-min))
  446. (let ((re (concat "^\\*+[ \t]+" org-footnote-section "[ \t]*$")))
  447. (unless (or (re-search-forward re nil t)
  448. (and (progn (widen) t)
  449. (re-search-forward re nil t)))
  450. (goto-char (point-max))
  451. (skip-chars-backward " \t\r\n")
  452. (unless (bolp) (newline))
  453. ;; Insert new section. Separate it from the previous one
  454. ;; with a blank line, unless `org-blank-before-new-entry'
  455. ;; explicitly says no.
  456. (when (and (cdr (assq 'heading org-blank-before-new-entry))
  457. (zerop (save-excursion (org-back-over-empty-lines))))
  458. (insert "\n"))
  459. (insert "* " org-footnote-section "\n"))))
  460. ;; Move to the end of this entry (which may be
  461. ;; `org-footnote-section' or the current one).
  462. (org-footnote-goto-local-insertion-point)
  463. (org-show-context 'link-search))
  464. (t
  465. ;; In a non-Org file. Search for footnote tag, or create it if
  466. ;; specified (at the end of buffer, or before signature if in
  467. ;; Message mode). Set point after any definition already there.
  468. (let ((tag (and org-footnote-tag-for-non-org-mode-files
  469. (concat "^" (regexp-quote
  470. org-footnote-tag-for-non-org-mode-files)
  471. "[ \t]*$")))
  472. (max (if (and (derived-mode-p 'message-mode)
  473. (goto-char (point-max))
  474. (re-search-backward
  475. message-signature-separator nil t))
  476. (progn
  477. ;; Ensure one blank line separates last
  478. ;; footnote from signature.
  479. (beginning-of-line)
  480. (open-line 2)
  481. (point-marker))
  482. (point-max-marker))))
  483. (set-marker-insertion-type max t)
  484. (goto-char max)
  485. ;; Check if the footnote tag is defined but missing. In this
  486. ;; case, insert it, before any footnote or one blank line
  487. ;; after any previous text.
  488. (when (and tag (not (re-search-backward tag nil t)))
  489. (skip-chars-backward " \t\r\n")
  490. (while (re-search-backward org-footnote-definition-re nil t))
  491. (unless (bolp) (newline 2))
  492. (insert org-footnote-tag-for-non-org-mode-files "\n\n"))
  493. ;; Remove superfluous white space and clear marker.
  494. (goto-char max)
  495. (skip-chars-backward " \t\r\n")
  496. (delete-region (point) max)
  497. (unless (bolp) (newline))
  498. (set-marker max nil))))
  499. ;; Insert footnote label.
  500. (insert "\n[" label "] ")
  501. ;; Only notify user about next possible action when in an Org
  502. ;; buffer, as the bindings may have different meanings otherwise.
  503. (when (eq major-mode 'org-mode)
  504. (message
  505. "Edit definition and go back with `C-c &' or, if unique, with `C-c C-c'."))))
  506. ;;;###autoload
  507. (defun org-footnote-action (&optional special)
  508. "Do the right thing for footnotes.
  509. When at a footnote reference, jump to the definition.
  510. When at a definition, jump to the references if they exist, offer
  511. to create them otherwise.
  512. When neither at definition or reference, create a new footnote,
  513. interactively.
  514. With prefix arg SPECIAL, offer additional commands in a menu."
  515. (interactive "P")
  516. (let (tmp c)
  517. (cond
  518. (special
  519. (message "Footnotes: [s]ort | [r]enumber fn:N | [S]=r+s |->[n]umeric | [d]elete")
  520. (setq c (read-char-exclusive))
  521. (cond
  522. ((eq c ?s) (org-footnote-normalize 'sort))
  523. ((eq c ?r) (org-footnote-renumber-fn:N))
  524. ((eq c ?S)
  525. (org-footnote-renumber-fn:N)
  526. (org-footnote-normalize 'sort))
  527. ((eq c ?n) (org-footnote-normalize))
  528. ((eq c ?d) (org-footnote-delete))
  529. (t (error "No such footnote command %c" c))))
  530. ((setq tmp (org-footnote-at-reference-p))
  531. (cond
  532. ;; Anonymous footnote: move point at the beginning of its
  533. ;; definition.
  534. ((not (car tmp))
  535. (goto-char (nth 1 tmp))
  536. (forward-char 5))
  537. ;; A definition exists: move to it.
  538. ((ignore-errors (org-footnote-goto-definition (car tmp))))
  539. ;; No definition exists: offer to create it.
  540. ((yes-or-no-p (format "No definition for %s. Create one? " (car tmp)))
  541. (org-footnote-create-definition (car tmp)))))
  542. ((setq tmp (org-footnote-at-definition-p))
  543. (org-footnote-goto-previous-reference (car tmp)))
  544. (t (org-footnote-new)))))
  545. (defvar org-footnote-insert-pos-for-preprocessor 'point-max
  546. "See `org-footnote-normalize'.")
  547. (defvar org-export-footnotes-seen nil) ; silence byte-compiler
  548. (defvar org-export-footnotes-data nil) ; silence byte-compiler
  549. ;;;###autoload
  550. (defun org-footnote-normalize (&optional sort-only export-props)
  551. "Collect the footnotes in various formats and normalize them.
  552. This finds the different sorts of footnotes allowed in Org, and
  553. normalizes them to the usual [N] format that is understood by the
  554. Org-mode exporters.
  555. When SORT-ONLY is set, only sort the footnote definitions into the
  556. referenced sequence.
  557. If Org is amidst an export process, EXPORT-PROPS will hold the
  558. export properties of the buffer.
  559. When EXPORT-PROPS is non-nil, the default action is to insert
  560. normalized footnotes towards the end of the pre-processing
  561. buffer. Some exporters (docbook, odt...) expect footnote
  562. definitions to be available before any references to them. Such
  563. exporters can let bind `org-footnote-insert-pos-for-preprocessor'
  564. to symbol `point-min' to achieve the desired behaviour.
  565. Additional note on `org-footnote-insert-pos-for-preprocessor':
  566. 1. This variable has not effect when FOR-PREPROCESSOR is nil.
  567. 2. This variable (potentially) obviates the need for extra scan
  568. of pre-processor buffer as witnessed in
  569. `org-export-docbook-get-footnotes'."
  570. ;; This is based on Paul's function, but rewritten.
  571. ;;
  572. ;; Re-create `org-with-limited-levels', but not limited to Org
  573. ;; buffers.
  574. (let* ((limit-level
  575. (and (boundp 'org-inlinetask-min-level)
  576. org-inlinetask-min-level
  577. (1- org-inlinetask-min-level)))
  578. (nstars (and limit-level
  579. (if org-odd-levels-only
  580. (and limit-level (1- (* limit-level 2)))
  581. limit-level)))
  582. (org-outline-regexp
  583. (concat "\\*" (if nstars (format "\\{1,%d\\} " nstars) "+ ")))
  584. ;; Determine the highest marker used so far.
  585. (ref-table (when export-props org-export-footnotes-seen))
  586. (count (if (and export-props ref-table)
  587. (apply 'max (mapcar (lambda (e) (nth 1 e)) ref-table))
  588. 0))
  589. ins-point ref)
  590. (save-excursion
  591. ;; 1. Find every footnote reference, extract the definition, and
  592. ;; collect that data in REF-TABLE. If SORT-ONLY is nil, also
  593. ;; normalize references.
  594. (goto-char (point-min))
  595. (while (setq ref (org-footnote-get-next-reference))
  596. (let* ((lbl (car ref))
  597. ;; When footnote isn't anonymous, check if it's label
  598. ;; (REF) is already stored in REF-TABLE. In that case,
  599. ;; extract number used to identify it (MARKER). If
  600. ;; footnote is unknown, increment the global counter
  601. ;; (COUNT) to create an unused identifier.
  602. (a (and lbl (assoc lbl ref-table)))
  603. (marker (or (nth 1 a) (incf count)))
  604. ;; Is the reference inline or pointing to an inline
  605. ;; footnote?
  606. (inlinep (or (stringp (nth 3 ref)) (nth 3 a))))
  607. ;; Replace footnote reference with [MARKER]. Maybe fill
  608. ;; paragraph once done. If SORT-ONLY is non-nil, only move
  609. ;; to the end of reference found to avoid matching it twice.
  610. ;; If EXPORT-PROPS isn't nil, also add `org-footnote'
  611. ;; property to it, so it can be easily recognized by
  612. ;; exporters.
  613. (if sort-only
  614. (goto-char (nth 2 ref))
  615. (delete-region (nth 1 ref) (nth 2 ref))
  616. (goto-char (nth 1 ref))
  617. (let ((new-ref (format "[%d]" marker)))
  618. (when export-props (org-add-props new-ref '(org-footnote t)))
  619. (insert new-ref))
  620. (and inlinep
  621. org-footnote-fill-after-inline-note-extraction
  622. (org-fill-paragraph)))
  623. ;; Add label (REF), identifier (MARKER), definition (DEF)
  624. ;; and type (INLINEP) to REF-TABLE if data was unknown.
  625. (unless a
  626. (let ((def (or (nth 3 ref) ; inline
  627. (and export-props
  628. (cdr (assoc lbl org-export-footnotes-data)))
  629. (nth 3 (org-footnote-get-definition lbl)))))
  630. (push (list lbl marker
  631. ;; When exporting, each definition goes
  632. ;; through `org-export-preprocess-string' so
  633. ;; it is ready to insert in the
  634. ;; backend-specific buffer.
  635. (if (and export-props def)
  636. (let ((parameters
  637. (org-combine-plists
  638. export-props
  639. '(:todo-keywords t :tags t :priority t))))
  640. (org-export-preprocess-string def parameters))
  641. def)
  642. inlinep) ref-table)))))
  643. ;; 2. Find and remove the footnote section, if any. Also
  644. ;; determine where footnotes shall be inserted (INS-POINT).
  645. (goto-char (point-min))
  646. (cond
  647. ((and org-footnote-section
  648. (eq major-mode 'org-mode)
  649. (re-search-forward
  650. (concat "^\\*[ \t]+" (regexp-quote org-footnote-section)
  651. "[ \t]*$")
  652. nil t))
  653. (delete-region (match-beginning 0) (org-end-of-subtree t)))
  654. ((eq major-mode 'org-mode)
  655. (goto-char (point-max))
  656. (unless (bolp) (newline)))
  657. (t
  658. ;; Remove any left-over tag in the buffer, if one is set up.
  659. (when org-footnote-tag-for-non-org-mode-files
  660. (let ((tag (concat "^" (regexp-quote
  661. org-footnote-tag-for-non-org-mode-files)
  662. "[ \t]*$")))
  663. (while (re-search-forward tag nil t)
  664. (replace-match "")
  665. (delete-region (point) (progn (forward-line) (point))))))
  666. ;; In Message mode, ensure footnotes are inserted before the
  667. ;; signature.
  668. (if (and (derived-mode-p 'message-mode)
  669. (goto-char (point-max))
  670. (re-search-backward message-signature-separator nil t))
  671. (beginning-of-line)
  672. (goto-char (point-max)))))
  673. ;; During export, `org-footnote-insert-pos-for-preprocessor' has
  674. ;; precedence over previously found position.
  675. (setq ins-point
  676. (copy-marker
  677. (if (and export-props
  678. (eq org-footnote-insert-pos-for-preprocessor 'point-min))
  679. (point-min)
  680. (point))))
  681. ;; 3. Clean-up REF-TABLE.
  682. (setq ref-table
  683. (delq nil
  684. (mapcar
  685. (lambda (x)
  686. (cond
  687. ;; When only sorting, ignore inline footnotes.
  688. ((and sort-only (nth 3 x)) nil)
  689. ;; No definition available: provide one.
  690. ((not (nth 2 x))
  691. (append (butlast x 2)
  692. (list (format "DEFINITION NOT FOUND: %s" (car x))
  693. (nth 3 x))))
  694. (t x)))
  695. ref-table)))
  696. (setq ref-table (nreverse ref-table))
  697. ;; 4. Remove left-over definitions in the buffer.
  698. (mapc (lambda (x) (unless (nth 3 x)
  699. (org-footnote-delete-definitions (car x))))
  700. ref-table)
  701. ;; 5. Insert the footnotes again in the buffer, at the
  702. ;; appropriate spot.
  703. (goto-char ins-point)
  704. (cond
  705. ;; No footnote: exit.
  706. ((not ref-table))
  707. ;; Cases when footnotes should be inserted in one place.
  708. ((or (not (eq major-mode 'org-mode))
  709. org-footnote-section
  710. (not sort-only))
  711. ;; Insert again the section title, if any. Ensure that title,
  712. ;; or the subsequent footnotes, will be separated by a blank
  713. ;; lines from the rest of the document. In an Org buffer,
  714. ;; separate section with a blank line, unless explicitly
  715. ;; stated in `org-blank-before-new-entry'.
  716. (cond
  717. ((not (eq major-mode 'org-mode))
  718. (skip-chars-backward " \t\n\r")
  719. (delete-region (point) ins-point)
  720. (unless (bolp) (newline))
  721. ;; Keep one blank line between footnotes and signature.
  722. (when (and (derived-mode-p 'message-mode)
  723. (save-excursion
  724. (re-search-forward message-signature-separator nil t)))
  725. (open-line 1))
  726. (when org-footnote-tag-for-non-org-mode-files
  727. (insert "\n" org-footnote-tag-for-non-org-mode-files "\n")))
  728. ((and org-footnote-section (not export-props))
  729. (when (and (cdr (assq 'heading org-blank-before-new-entry))
  730. (zerop (save-excursion (org-back-over-empty-lines))))
  731. (insert "\n"))
  732. (insert "* " org-footnote-section "\n")))
  733. (set-marker ins-point nil)
  734. ;; Insert the footnotes, separated by a blank line.
  735. (insert (mapconcat (lambda (x) (format "\n[%s] %s"
  736. (nth (if sort-only 0 1) x) (nth 2 x)))
  737. ref-table "\n"))
  738. (unless (eobp) (insert "\n"))
  739. ;; When exporting, add newly inserted markers along with their
  740. ;; associated definition to `org-export-footnotes-seen'.
  741. (when export-props
  742. (setq org-export-footnotes-seen ref-table)))
  743. ;; Else, insert each definition at the end of the section
  744. ;; containing their first reference. Happens only in Org files
  745. ;; with no special footnote section, and only when doing
  746. ;; sorting.
  747. (t (mapc 'org-insert-footnote-reference-near-definition
  748. ref-table))))))
  749. (defun org-insert-footnote-reference-near-definition (entry)
  750. "Find first reference of footnote ENTRY and insert the definition there.
  751. ENTRY is (fn-label num-mark definition)."
  752. (when (car entry)
  753. (goto-char (point-min))
  754. (let ((ref (org-footnote-get-next-reference (car entry))))
  755. (when ref
  756. (goto-char (nth 2 ref))
  757. (org-footnote-goto-local-insertion-point)
  758. (insert (format "\n[%s] %s\n" (car entry) (nth 2 entry)))))))
  759. (defun org-footnote-goto-local-insertion-point ()
  760. "Find insertion point for footnote, just before next outline heading."
  761. (org-with-limited-levels (outline-next-heading))
  762. (or (bolp) (newline))
  763. (beginning-of-line 0)
  764. (while (and (not (bobp)) (= (char-after) ?#))
  765. (beginning-of-line 0))
  766. (if (looking-at "[ \t]*#\\+TBLFM:") (beginning-of-line 2))
  767. (end-of-line 1)
  768. (skip-chars-backward "\n\r\t ")
  769. (forward-line))
  770. (defun org-footnote-delete-references (label)
  771. "Delete every reference to footnote LABEL.
  772. Return the number of footnotes removed."
  773. (save-excursion
  774. (goto-char (point-min))
  775. (let (ref (nref 0))
  776. (while (setq ref (org-footnote-get-next-reference label))
  777. (goto-char (nth 1 ref))
  778. (delete-region (nth 1 ref) (nth 2 ref))
  779. (incf nref))
  780. nref)))
  781. (defun org-footnote-delete-definitions (label)
  782. "Delete every definition of the footnote LABEL.
  783. Return the number of footnotes removed."
  784. (save-excursion
  785. (goto-char (point-min))
  786. (let ((def-re (concat "^\\[" (regexp-quote label) "\\]"))
  787. (ndef 0))
  788. (while (re-search-forward def-re nil t)
  789. (let ((full-def (org-footnote-at-definition-p)))
  790. (delete-region (nth 1 full-def) (nth 2 full-def)))
  791. (incf ndef))
  792. ndef)))
  793. (defun org-footnote-delete (&optional label)
  794. "Delete the footnote at point.
  795. This will remove the definition (even multiple definitions if they exist)
  796. and all references of a footnote label.
  797. If LABEL is non-nil, delete that footnote instead."
  798. (catch 'done
  799. (let* ((nref 0) (ndef 0) x
  800. ;; 1. Determine LABEL of footnote at point.
  801. (label (cond
  802. ;; LABEL is provided as argument.
  803. (label)
  804. ;; Footnote reference at point. If the footnote is
  805. ;; anonymous, delete it and exit instead.
  806. ((setq x (org-footnote-at-reference-p))
  807. (or (car x)
  808. (progn
  809. (delete-region (nth 1 x) (nth 2 x))
  810. (message "Anonymous footnote removed")
  811. (throw 'done t))))
  812. ;; Footnote definition at point.
  813. ((setq x (org-footnote-at-definition-p))
  814. (car x))
  815. (t (error "Don't know which footnote to remove")))))
  816. ;; 2. Now that LABEL is non-nil, find every reference and every
  817. ;; definition, and delete them.
  818. (setq nref (org-footnote-delete-references label)
  819. ndef (org-footnote-delete-definitions label))
  820. ;; 3. Verify consistency of footnotes and notify user.
  821. (org-footnote-auto-adjust-maybe)
  822. (message "%d definition(s) of and %d reference(s) of footnote %s removed"
  823. ndef nref label))))
  824. (defun org-footnote-renumber-fn:N ()
  825. "Renumber the simple footnotes like fn:17 into a sequence in the document."
  826. (interactive)
  827. (let (map (n 0))
  828. (org-with-wide-buffer
  829. (goto-char (point-min))
  830. (while (re-search-forward "\\[fn:\\([0-9]+\\)[]:]" nil t)
  831. (save-excursion
  832. (goto-char (match-beginning 0))
  833. ;; Ensure match is a footnote reference or definition.
  834. (when (save-match-data (if (bolp)
  835. (org-footnote-at-definition-p)
  836. (org-footnote-at-reference-p)))
  837. (let ((new-val (or (cdr (assoc (match-string 1) map))
  838. (number-to-string (incf n)))))
  839. (unless (assoc (match-string 1) map)
  840. (push (cons (match-string 1) new-val) map))
  841. (replace-match new-val nil nil nil 1))))))))
  842. (defun org-footnote-auto-adjust-maybe ()
  843. "Renumber and/or sort footnotes according to user settings."
  844. (when (memq org-footnote-auto-adjust '(t renumber))
  845. (org-footnote-renumber-fn:N))
  846. (when (memq org-footnote-auto-adjust '(t sort))
  847. (let ((label (car (org-footnote-at-definition-p))))
  848. (org-footnote-normalize 'sort)
  849. (when label
  850. (goto-char (point-min))
  851. (and (re-search-forward (concat "^\\[" (regexp-quote label) "\\]")
  852. nil t)
  853. (progn (insert " ")
  854. (just-one-space)))))))
  855. (provide 'org-footnote)
  856. ;;; org-footnote.el ends here