1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
|
;;; citar-markdown.el --- Markdown adapter for citar -*- lexical-binding: t; -*-
;; SPDX-FileCopyrightText: 2021-2022 Bruce D'Arcus
;; SPDX-License-Identifier: GPL-3.0-or-later
;;; Commentary:
;; A small package that provides functions required to use citar with markdown.
;; Loading this file will enable manipulating the citations with commands
;; provided by citar.
;;; Code:
(require 'citar)
(require 'thingatpt)
(defvar citar-major-mode-functions)
(defcustom citar-markdown-prompt-for-extra-arguments t
"Whether to prompt for additional arguments when inserting a citation."
;; REVIEW this maybe shouldn't be mode specific?
:group 'citar-markdown
:type 'boolean)
(defconst citar-markdown-citation-key-regexp
(concat "-?@" ; @ preceded by optional -
"\\(?:"
"{\\(?1:.*?\\)}" ; brace-delimited key
"\\|"
"\\(?1:[[:alnum:]_][[:alnum:]]*\\(?:[:.#$%&+?<>~/-][[:alnum:]]+\\)*\\)"
"\\)")
"Regular expression for a Pandoc citation key.
Captures the actual key in group 1. Implements the syntax
specified at URL
`https://pandoc.org/MANUAL.html#citation-syntax'.")
;;;###autoload
(defun citar-markdown-insert-keys (keys)
"Insert semicolon-separated and @-prefixed KEYS in a markdown buffer."
(insert (mapconcat (lambda (k) (concat "@" k)) keys "; ")))
;;;###autoload
(defun citar-markdown-insert-citation (keys &optional invert-prompt)
"Insert a pandoc-style citation consisting of KEYS.
If the point is inside a citation, add new keys after the current
key.
If point is immediately after the opening \[, add new keys
to the beginning of the citation.
If INVERT-PROMPT is non-nil, invert the meaning of
`citar-markdown-prompt-for-extra-arguments'."
(let* ((citation (citar-markdown-citation-at-point))
(keys (if citation (seq-difference keys (car citation)) keys))
(keyconcat (mapconcat (lambda (k) (concat "@" k)) keys "; "))
(prompt (xor invert-prompt citar-markdown-prompt-for-extra-arguments)))
(when keys
(if (or (not citation)
(= (point) (cadr citation))
(= (point) (cddr citation)))
(let* ((prenote (when prompt (read-from-minibuffer "Prenote: ")))
(postnote (when prompt (read-from-minibuffer "Postnote: ")))
(prenote (if (string= "" prenote) "" (concat prenote " ")))
(postnote (if (string= "" postnote) "" (concat ", " postnote))))
(insert (format "[%s%s%s]" prenote keyconcat postnote)))
(if (= (point) (1+ (cadr citation)))
(save-excursion (insert keyconcat "; "))
(skip-chars-forward "^;]" (cddr citation))
(insert "; " keyconcat))))))
;;;###autoload
(defun citar-markdown-insert-edit (&optional _arg)
"Prompt for keys and call `citar-markdown-insert-citation.
With ARG non-nil, rebuild the cache before offering candidates."
(citar-markdown-insert-citation (citar-select-refs)))
;;;###autoload
(defun citar-markdown-key-at-point ()
"Return citation key at point (with its bounds) for pandoc markdown citations.
Returns (KEY . BOUNDS), where KEY is the citation key at point
and BOUNDS is a pair of buffer positions. Citation keys are
found using `citar-markdown-citation-key-regexp'. Returns nil if
there is no key at point."
(interactive)
(when (thing-at-point-looking-at citar-markdown-citation-key-regexp)
(cons (match-string-no-properties 1)
(cons (match-beginning 0) (match-end 0)))))
;;;###autoload
(defun citar-markdown-citation-at-point ()
"Return keys of citation at point.
Find balanced expressions starting and ending with square
brackets and containing at least one citation key (matching
`citar-markdown-citation-key-regexp'). Return (KEYS . BOUNDS),
where KEYS is a list of the found citation keys and BOUNDS is a
pair of buffer positions indicating the start and end of the
citation."
(save-excursion
(cond
((eq ?\[ (char-after)) (forward-char))
((eq ?\] (char-before)) (backward-char)))
(seq-some ; for each opening paren
(lambda (startpos) ; return keys in balanced [ ] expr
(when-let ((endpos (and (eq ?\[ (char-after startpos))
(scan-lists startpos 1 0))))
(let (keys)
(goto-char startpos)
(while (re-search-forward citar-markdown-citation-key-regexp endpos t)
(push (match-string-no-properties 1) keys))
(when keys
(cons (nreverse keys) (cons startpos endpos))))))
(reverse (nth 9 (syntax-ppss))))))
;;;###autoload
(defun citar-markdown-list-keys ()
"Return a list of all keys from markdown citations in buffer."
(save-excursion
(let (matches)
(goto-char (point-min))
(while (re-search-forward citar-markdown-citation-key-regexp nil t)
(push (match-string-no-properties 1) matches))
(delete-dups (nreverse matches)))))
(provide 'citar-markdown)
;;; citar-markdown.el ends here
|
