blob: 979f9443d5be6855bd09d456861dbde3b040c8f0 (
plain)
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
|
;;; piem.el --- Emacs tools for working with public-index -*- lexical-binding: t; -*-
;; Copyright (C) 2020 Kyle Meyer
;; Author: Kyle Meyer <kyle@kyleam.com>
;; Keywords: vc, tools
;; Version: 0.0.0
;; Package-Requires: ((emacs "26.3"))
;; This program is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
;; This program is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;; GNU General Public License for more details.
;; You should have received a copy of the GNU General Public License
;; along with this program. If not, see <https://www.gnu.org/licenses/>.
;;; Commentary:
;;
;;; Code:
(require 'subr-x)
(defgroup piem ()
"Emacs tools for working with public-inbox archives."
:link '(info-link "(piem)Top")
:group 'tools)
;; TODO: These intentionally follow public-inbox's configuration
;; names. Eventually reading values from there as well should be
;; supported.
;;
;; TODO: Decide how to deal with inboxes that map to more than one
;; coderepos. This is important to support for people that want to
;; use a catchall inbox for small projects which they don't think
;; (yet) need a dedicated address.
(defcustom piem-inboxes nil
"List of public-inbox-archived projects.
Elements have the form (NAME . INFO), where INFO is a property
list that supports the following properties:
:address
:listid
The email address and List-ID for the inbox.
:coderepo
Local path of the code repository associated with the inbox.
:url
A URL hosting HTTPS archives.
Here's an example for the public-inbox project itself:
(\"public-inbox\" .
(:coderepo
\"~/src/public-inbox/\"
:address
\"meta@public-inbox.org\"
:listid
\"meta.public-inbox.org\"
:url
\"https://public-inbox.org/meta/\"))"
:type '(alist :key-type string
:value-type
(plist :value-type string)))
(defcustom piem-get-inbox-functions nil
"Functions tried to get the inbox of the current buffer.
Each function should accept no arguments and return the name of
the inbox associated with the current buffer or nil."
:type 'hook)
(defcustom piem-get-mid-functions nil
"Functions tried to get the message ID of the current buffer.
Each function should accept no arguments and return the
message ID associated with the current buffer or nil."
:type 'hook)
(defcustom piem-mid-to-thread-functions nil
"Functions tried to create an mbox from a message ID.
Each function should accept one argument, the message ID. If the
function knows how to create an mbox for the message ID, it
should return a function that takes no arguments and inserts the
mbox's contents in the current buffer."
:type 'hook)
;;;###autoload
(defun piem-inbox ()
"Return the current buffer's inbox."
(run-hook-with-args-until-success 'piem-get-inbox-functions))
;;;###autoload
(defun piem-inbox-coderepo ()
"Return the code repository of current buffer's inbox."
(when-let ((p (piem-inbox))
(repo (plist-get
(alist-get p piem-inboxes) :coderepo)))
(expand-file-name repo)))
;;;###autoload
(defun piem-mid ()
"Return the current buffer's message ID."
(run-hook-with-args-until-success 'piem-get-mid-functions))
(defun piem-please ()
"How I wish I could intersect my emails, feeds, and repos")
;;; piem.el ends here
(provide 'piem)
|