blob: 0bb962dece5b5aeaba2bf27d6c82d8029487b172 (
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
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
|
;;; erc-list.el --- /list support for ERC -*- lexical-binding:t -*-
;; Copyright (C) 2008-2018 Free Software Foundation, Inc.
;; Author: Tom Tromey <tromey@redhat.com>
;; Maintainer: emacs-devel@gnu.org
;; Old-Version: 0.1
;; Keywords: comm
;; This file is part of GNU Emacs.
;; GNU Emacs 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.
;; GNU Emacs 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 GNU Emacs. If not, see <https://www.gnu.org/licenses/>.
;;; Commentary:
;; This file provides nice support for /list in ERC.
;;; Code:
(require 'erc)
(defgroup erc-list nil
"Support for the /list command."
:group 'erc)
;; This is implicitly the width of the channel name column. Pick
;; something small enough that the topic has a chance of being
;; readable, but long enough that most channel names won't make for
;; strange formatting.
(defconst erc-list-nusers-column 25)
;; Width of the number-of-users column.
(defconst erc-list-topic-column (+ erc-list-nusers-column 10))
;; The list buffer. This is buffer local in the server buffer.
(defvar erc-list-buffer nil)
;; The argument to the last "/list". This is buffer local in the
;; server buffer.
(defvar erc-list-last-argument nil)
;; The server buffer corresponding to the list buffer. This is buffer
;; local in the list buffer.
(defvar erc-list-server-buffer nil)
;; Define module:
;;;###autoload(autoload 'erc-list-mode "erc-list")
(define-erc-module list nil
"List channels nicely in a separate buffer."
((remove-hook 'erc-server-321-functions 'erc-server-321-message)
(remove-hook 'erc-server-322-functions 'erc-server-322-message))
((erc-with-all-buffers-of-server nil
#'erc-open-server-buffer-p
(remove-hook 'erc-server-322-functions 'erc-list-handle-322 t))
(add-hook 'erc-server-321-functions 'erc-server-321-message t)
(add-hook 'erc-server-322-functions 'erc-server-322-message t)))
;; Format a record for display.
(defun erc-list-make-string (channel users topic)
(concat
channel
(erc-propertize " "
'display (list 'space :align-to erc-list-nusers-column)
'face 'fixed-pitch)
users
(erc-propertize " "
'display (list 'space :align-to erc-list-topic-column)
'face 'fixed-pitch)
topic))
;; Insert a record into the list buffer.
(defun erc-list-insert-item (channel users topic)
(save-excursion
(let ((buffer-read-only nil))
(goto-char (point-max))
(insert (erc-list-make-string channel users topic) "\n"))))
(defun erc-list-join ()
"Join the irc channel named on this line."
(interactive)
(unless (eobp)
(beginning-of-line)
(unless (looking-at "\\([&#+!][^ \n]+\\)")
(error "Not looking at channel name?"))
(let ((chan (match-string 1)))
(with-current-buffer erc-list-server-buffer
(erc-join-channel chan)))))
(defun erc-list-kill ()
"Kill the current ERC list buffer."
(interactive)
(kill-buffer (current-buffer)))
(defun erc-list-revert ()
"Refresh the list of channels."
(interactive)
(with-current-buffer erc-list-server-buffer
(erc-cmd-LIST erc-list-last-argument)))
(defun erc-list-menu-sort-by-column (&optional e)
"Sort the channel list by the column clicked on."
(interactive (list last-input-event))
(if e (mouse-select-window e))
(let* ((pos (event-start e))
(obj (posn-object pos))
(col (if obj
(get-text-property (cdr obj) 'column-number (car obj))
(get-text-property (posn-point pos) 'column-number))))
(let ((buffer-read-only nil))
(if (= col 1)
(sort-fields col (point-min) (point-max))
(sort-numeric-fields col (point-min) (point-max))))))
(defvar erc-list-menu-mode-map
(let ((map (make-keymap)))
(set-keymap-parent map special-mode-map)
(define-key map "k" 'erc-list-kill)
(define-key map "j" 'erc-list-join)
(define-key map "g" 'erc-list-revert)
(define-key map "n" 'next-line)
(define-key map "p" 'previous-line)
map)
"Local keymap for `erc-list-mode' buffers.")
(defvar erc-list-menu-sort-button-map
(let ((map (make-sparse-keymap)))
(define-key map [header-line mouse-1] 'erc-list-menu-sort-by-column)
(define-key map [follow-link] 'mouse-face)
map)
"Local keymap for ERC list menu mode sorting buttons.")
;; Helper function that makes a buttonized column header.
(defun erc-list-button (title column)
(erc-propertize title
'column-number column
'help-echo "mouse-1: sort by column"
'mouse-face 'header-line-highlight
'keymap erc-list-menu-sort-button-map))
(define-derived-mode erc-list-menu-mode special-mode "ERC-List"
"Major mode for editing a list of irc channels."
(setq header-line-format
(concat
(erc-propertize " "
'display '(space :align-to 0)
'face 'fixed-pitch)
(erc-list-make-string (erc-list-button "Channel" 1)
(erc-list-button "# Users" 2)
"Topic")))
(setq truncate-lines t))
(put 'erc-list-menu-mode 'mode-class 'special)
;; Handle a "322" response. This response tells us about a single
;; channel.
;; Called via erc-once-with-server-event with two arguments.
(defun erc-list-handle-322 (_proc parsed)
(let* ((args (cdr (erc-response.command-args parsed)))
(channel (car args))
(nusers (car (cdr args)))
(topic (erc-response.contents parsed)))
(when (buffer-live-p erc-list-buffer)
(with-current-buffer erc-list-buffer
(erc-list-insert-item channel nusers topic))))
;; Don't let another hook run.
t)
;; Helper function to install our 322 handler and make our buffer.
(defun erc-list-install-322-handler (server-buffer)
(with-current-buffer server-buffer
;; Arrange for 322 responses to insert into our buffer.
(add-hook 'erc-server-322-functions 'erc-list-handle-322 t t)
;; Arrange for 323 (end of list) to end this.
(erc-once-with-server-event
323
(lambda (_proc _parsed)
(remove-hook 'erc-server-322-functions 'erc-list-handle-322 t)))
;; Find the list buffer, empty it, and display it.
(set (make-local-variable 'erc-list-buffer)
(get-buffer-create (concat "*Channels of "
erc-server-announced-name
"*")))
(with-current-buffer erc-list-buffer
(erc-list-menu-mode)
(setq buffer-read-only nil)
(erase-buffer)
(set (make-local-variable 'erc-list-server-buffer) server-buffer)
(setq buffer-read-only t))
(pop-to-buffer erc-list-buffer))
t)
;; The main entry point.
(defun erc-cmd-LIST (&optional line)
"Show a listing of channels on the current server in a separate window.
If LINE is specified, include it with the /LIST command. It
should usually be one or more channels, separated by commas.
Please note that this function only works with IRC servers which conform
to RFC and send the LIST header (#321) at start of list transmission."
(erc-with-server-buffer
(set (make-local-variable 'erc-list-last-argument) line)
(erc-once-with-server-event
321
(let ((buf (current-buffer)))
(lambda (_proc _parsed)
(erc-list-install-322-handler buf)))))
(erc-server-send (concat "LIST :" (or (and line (substring line 1))
""))))
(put 'erc-cmd-LIST 'do-not-parse-args t)
(provide 'erc-list)
;;; erc-list.el ends here
;;
;; Local Variables:
;; generated-autoload-file: "erc-loaddefs.el"
;; indent-tabs-mode: t
;; tab-width: 8
;; End:
|
