1 ;;; riece-commands.el --- commands available in command buffer
2 ;; Copyright (C) 1998-2003 Daiki Ueno
4 ;; Author: Daiki Ueno <ueno@unixuser.org>
6 ;; Keywords: IRC, riece
8 ;; This file is part of Riece.
10 ;; This program is free software; you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation; either version 2, or (at your option)
15 ;; This program 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.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs; see the file COPYING. If not, write to the
22 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
23 ;; Boston, MA 02110-1301, USA.
27 (require 'riece-channel)
28 (require 'riece-complete)
29 (require 'riece-layout)
30 (require 'riece-display)
31 (require 'riece-server)
33 (require 'riece-identity)
34 (require 'riece-message)
37 (autoload 'derived-mode-class "derived")
40 (defun riece-command-switch-to-channel (channel)
41 (interactive (list (riece-completing-read-identity
42 (riece-mcat "Switch to channel/user: ")
43 riece-current-channels nil t)))
44 (unless (equal channel riece-current-channel)
45 (riece-switch-to-channel channel)))
47 (defun riece-command-switch-to-channel-by-number (number)
49 (let ((command-name (symbol-name this-command)))
50 (if (string-match "[0-9]+$" command-name)
51 (list (string-to-number (match-string 0 command-name)))
52 (list (string-to-number (read-string (riece-mcat "Switch to number: ")))))))
53 (let ((channel (nth (1- number) riece-current-channels)))
55 (riece-command-switch-to-channel channel)
56 (error "No such number!"))))
61 (defalias (intern (concat "riece-command-switch-to-channel-by-number-"
62 (number-to-string number)))
63 'riece-command-switch-to-channel-by-number)
64 (setq number (1+ number)))))
66 (defun riece-command-next-channel ()
67 "Select the next channel."
69 (when (> (length riece-current-channels) 1)
70 (let ((pointer (cdr (riece-identity-member
72 riece-current-channels))))
75 (setq pointer (cdr pointer)))
77 (setq pointer riece-current-channels)
80 (setq pointer (cdr pointer))))
82 (riece-command-switch-to-channel (car pointer))
83 (error "No such channel!")))))
85 (defun riece-command-previous-channel ()
86 "Select the previous channel."
88 (when (> (length riece-current-channels) 1)
89 (let ((pointer (riece-identity-member
91 riece-current-channels))
92 (start riece-current-channels)
94 (while (and start (not (eq start pointer)))
96 (setq channel (car start)))
97 (setq start (cdr start)))
99 (setq start (copy-sequence riece-current-channels))
100 (setq start (delq nil start))
101 (and (> (length start) 1)
102 (setq channel (nth (1- (length start)) start))))
104 (riece-command-switch-to-channel channel)
105 (error "No such channel!")))))
107 (defun riece-command-select-command-buffer ()
108 "Select the command buffer."
110 (let ((window (get-buffer-window riece-command-buffer)))
112 (select-window window))))
114 (defun riece-command-configure-windows ()
116 "Reconfigure windows with the current layout."
117 (riece-redisplay-buffers t))
119 (defun riece-command-suspend-resume ()
121 "Save or restore the current window configuration."
122 (let ((entry (assq 'riece-window-configuration (frame-parameters))))
123 (modify-frame-parameters (selected-frame)
124 (list (cons 'riece-window-configuration
125 (current-window-configuration))))
127 (set-window-configuration (cdr entry))
128 (delete-other-windows))
130 (substitute-command-keys
131 "\\[riece-command-suspend-resume] to get back the last windows"))))
133 (defun riece-command-change-layout (name)
134 "Select a layout-name from all current available layouts and change
135 the layout to the selected layout-name."
136 (interactive (list (completing-read (riece-mcat "Change layout: ")
137 riece-layout-alist)))
138 (setq riece-layout name
139 riece-save-variables-are-dirty t)
140 (riece-command-configure-windows))
142 (defun riece-command-toggle-channel-buffer-mode ()
144 (setq riece-channel-buffer-mode
145 (not riece-channel-buffer-mode)
146 riece-save-variables-are-dirty t)
147 (riece-command-configure-windows))
149 (defun riece-command-toggle-others-buffer-mode ()
151 (setq riece-others-buffer-mode
152 (not riece-others-buffer-mode)
153 riece-save-variables-are-dirty t)
154 (riece-command-configure-windows))
156 (defun riece-command-toggle-user-list-buffer-mode ()
158 (setq riece-user-list-buffer-mode
159 (not riece-user-list-buffer-mode)
160 riece-save-variables-are-dirty t)
161 (riece-command-configure-windows))
163 (defun riece-command-toggle-channel-list-buffer-mode ()
165 (setq riece-channel-list-buffer-mode
166 (not riece-channel-list-buffer-mode)
167 riece-save-variables-are-dirty t)
168 (riece-command-configure-windows))
170 (defun riece-command-finger (user &optional recurse)
172 (let* ((completion-ignore-case t)
173 (user (riece-completing-read-identity
174 (riece-mcat "Finger user: ")
175 (riece-get-users-on-server (riece-current-server-name))
176 nil nil nil nil nil t)))
177 (list user current-prefix-arg)))
179 (riece-send-string (format "WHOIS %s %s\r\n"
180 (riece-identity-prefix user)
181 (riece-identity-prefix user)))
182 (riece-send-string (format "WHOIS %s\r\n" (riece-identity-prefix user)))))
184 (defun riece-command-topic (topic)
187 (riece-check-channel-commands-are-usable t)
188 (list (read-from-minibuffer
189 (riece-mcat "Set topic: ")
190 (cons (or (riece-with-server-buffer
191 (riece-identity-server
192 riece-current-channel)
193 (riece-channel-get-topic
194 (riece-identity-prefix
195 riece-current-channel)))
198 (riece-send-string (format "TOPIC %s :%s\r\n"
199 (riece-identity-prefix riece-current-channel)
201 riece-current-channel))
203 (defun riece-command-invite (user)
205 (let ((completion-ignore-case t))
206 (riece-check-channel-commands-are-usable t)
207 (list (riece-completing-read-identity
208 (riece-mcat "Invite user: ")
209 (riece-get-users-on-server (riece-current-server-name))
210 nil nil nil nil nil t))))
211 (riece-send-string (format "INVITE %s :%s\r\n"
212 (riece-identity-prefix user)
213 (riece-identity-prefix riece-current-channel))))
215 (defun riece-command-kick (user &optional message)
217 (let ((completion-ignore-case t))
218 (riece-check-channel-commands-are-usable t)
219 (list (completing-read
220 (riece-mcat "Kick user: ")
221 (riece-with-server-buffer
222 (riece-identity-server riece-current-channel)
223 (riece-channel-get-users (riece-identity-prefix
224 riece-current-channel))))
225 (if current-prefix-arg
226 (read-string "Message: ")))))
229 (format "KICK %s %s :%s\r\n"
230 (riece-identity-prefix riece-current-channel)
232 (format "KICK %s %s\r\n"
233 (riece-identity-prefix riece-current-channel)
235 riece-current-channel))
237 (defun riece-command-names (pattern)
239 (let ((completion-ignore-case t))
240 (list (read-from-minibuffer
241 (riece-mcat "NAMES pattern: ")
242 (if (and riece-current-channel
243 (riece-channel-p (riece-identity-prefix
244 riece-current-channel)))
245 (cons (riece-identity-prefix riece-current-channel)
247 (if (or (not (equal pattern ""))
248 (yes-or-no-p (riece-mcat
249 "Really want to query NAMES without argument? ")))
250 (riece-send-string (format "NAMES %s\r\n" pattern))))
252 (defun riece-command-who (pattern)
254 (let ((completion-ignore-case t))
255 (list (read-from-minibuffer
256 (riece-mcat "WHO pattern: ")
257 (if (and riece-current-channel
258 (riece-channel-p (riece-identity-prefix
259 riece-current-channel)))
260 (cons (riece-identity-prefix riece-current-channel)
262 (if (or (not (equal pattern ""))
263 (yes-or-no-p (riece-mcat
264 "Really want to query WHO without argument? ")))
265 (riece-send-string (format "WHO %s\r\n" pattern))))
267 (defun riece-command-list (pattern)
269 (let ((completion-ignore-case t))
270 (list (read-from-minibuffer
271 (riece-mcat "LIST pattern: ")
272 (if (and riece-current-channel
273 (riece-channel-p (riece-identity-prefix
274 riece-current-channel)))
275 (cons (riece-identity-prefix riece-current-channel)
277 (if (or (not (equal pattern ""))
278 (yes-or-no-p (riece-mcat
279 "Really want to query LIST without argument? ")))
280 (riece-send-string (format "LIST %s\r\n" pattern))))
282 (defun riece-command-change-mode (channel change)
284 (let* ((completion-ignore-case t)
286 (if current-prefix-arg
287 (riece-completing-read-identity
288 (riece-mcat "Change mode for channel/user: ")
289 (riece-get-identities-on-server (riece-current-server-name))
290 nil nil nil nil nil t)
291 (riece-check-channel-commands-are-usable t)
292 riece-current-channel))
293 (riece-overriding-server-name (riece-identity-server channel))
294 (riece-temp-minibuffer-message
295 (concat (riece-mcat "[Available modes: ")
296 (riece-with-server-buffer (riece-identity-server channel)
297 (if (riece-channel-p (riece-identity-prefix channel))
298 (if riece-supported-channel-modes
299 (apply #'string riece-supported-channel-modes))
300 (if riece-supported-user-modes
301 (apply #'string riece-supported-user-modes))))
304 (read-from-minibuffer
305 (concat (riece-concat-channel-modes
306 channel (riece-mcat "Mode (? for help)")) ": ")
307 nil riece-minibuffer-map))))
308 (if (equal change "")
309 (riece-send-string (format "MODE %s\r\n"
310 (riece-identity-prefix channel)))
311 (riece-send-string (format "MODE %s %s\r\n"
312 (riece-identity-prefix channel)
315 (defun riece-command-set-operators (users &optional arg)
318 (riece-check-channel-commands-are-usable t)
319 (let ((completion-ignore-case t))
320 (list (riece-completing-read-multiple
321 (if current-prefix-arg
322 (riece-mcat "Unset +o for users")
323 (riece-mcat "Set +o for users"))
324 (riece-with-server-buffer
325 (riece-identity-server riece-current-channel)
326 (riece-channel-get-users (riece-identity-prefix
327 riece-current-channel)))
328 (if current-prefix-arg
330 (memq ?o (cdr user)))
332 (not (memq ?o (cdr user))))))
333 current-prefix-arg))))
336 (setq group (cons (car users) group)
338 (when (or (= (length group) 3)
341 (format "MODE %s %c%s %s\r\n"
342 (riece-identity-prefix riece-current-channel)
343 (if current-prefix-arg
346 (make-string (length group) ?o)
347 (mapconcat #'identity (nreverse group) " ")))
350 (defun riece-command-set-speakers (users &optional arg)
353 (riece-check-channel-commands-are-usable t)
354 (let ((completion-ignore-case t))
355 (list (riece-completing-read-multiple
356 (if current-prefix-arg
357 (riece-mcat "Unset +v for users")
358 (riece-mcat "Set +v for users"))
359 (riece-with-server-buffer
360 (riece-identity-server riece-current-channel)
361 (riece-channel-get-users (riece-identity-prefix
362 riece-current-channel)))
363 (if current-prefix-arg
365 (memq ?v (cdr user)))
367 (not (memq ?v (cdr user))))))
368 current-prefix-arg))))
371 (setq group (cons (car users) group)
373 (when (or (= (length group) 3)
376 (format "MODE %s %c%s %s\r\n"
377 (riece-identity-prefix riece-current-channel)
378 (if current-prefix-arg
381 (make-string (length group) ?v)
382 (mapconcat #'identity (nreverse group) " ")))
385 (defun riece-command-send-message (message notice)
386 "Send MESSAGE to the current channel."
387 (run-hooks 'riece-command-send-message-hook)
388 (if (equal message "")
389 (error (riece-mcat "No text to send")))
390 (riece-check-channel-commands-are-usable)
394 (format "NOTICE %s :%s\r\n"
395 (riece-identity-prefix riece-current-channel)
397 riece-current-channel)
398 (riece-display-message
399 (riece-make-message (riece-current-nickname) riece-current-channel
402 (format "PRIVMSG %s :%s\r\n"
403 (riece-identity-prefix riece-current-channel)
405 riece-current-channel)
406 (riece-display-message
407 (riece-make-message (riece-current-nickname) riece-current-channel
410 (defun riece-command-enter-message ()
411 "Send the current line to the current channel."
413 (riece-command-send-message (buffer-substring
414 (riece-line-beginning-position)
415 (riece-line-end-position))
417 (let ((next-line-add-newlines t))
420 (defun riece-command-enter-message-as-notice ()
421 "Send the current line to the current channel as NOTICE."
423 (riece-command-send-message (buffer-substring
424 (riece-line-beginning-position)
425 (riece-line-end-position))
427 (let ((next-line-add-newlines t))
430 (defun riece-command-enter-message-to-user (user)
431 "Send the current line to USER."
433 (if (and (bolp) (eolp))
434 (error "No text to send")
435 (let ((completion-ignore-case t))
436 (list (riece-completing-read-identity
437 (riece-mcat "Message to user: ")
438 (riece-get-users-on-server (riece-current-server-name))
439 nil nil nil nil nil t)))))
440 (let ((text (buffer-substring
441 (riece-line-beginning-position)
442 (riece-line-end-position))))
444 (format "PRIVMSG %s :%s\r\n" (riece-identity-prefix user) text)
446 (riece-display-message
447 (riece-make-message (riece-current-nickname) user text nil t)))
448 (let ((next-line-add-newlines t))
451 (defun riece-command-join-channel (target key)
452 (unless (riece-server-opened (riece-identity-server target))
453 (error "%s" (substitute-command-keys
454 "Type \\[riece-command-open-server] to open server.")))
455 (riece-send-string (if key
456 (format "JOIN %s :%s\r\n"
457 (riece-identity-prefix target)
459 (format "JOIN %s\r\n"
460 (riece-identity-prefix target)))
463 (defun riece-command-join-partner (target)
464 (let ((pointer (riece-identity-member target riece-current-channels)))
466 (riece-command-switch-to-channel (car pointer))
467 (riece-join-channel target)
468 (riece-switch-to-channel target))))
470 (defun riece-command-join (target)
472 (let ((completion-ignore-case t))
474 (if riece-join-channel-candidate
475 (let ((default (riece-format-identity
476 riece-join-channel-candidate)))
477 (riece-completing-read-identity
478 (format (riece-mcat "Join channel/user (default %s): ") default)
479 (riece-get-identities-on-server (riece-current-server-name))
480 nil nil nil nil default))
481 (riece-completing-read-identity
482 (riece-mcat "Join channel/user: ")
483 (riece-get-identities-on-server (riece-current-server-name)))))))
484 (let ((pointer (riece-identity-member target riece-current-channels)))
486 (riece-command-switch-to-channel (car pointer))
487 (if (riece-channel-p (riece-identity-prefix target))
488 (riece-command-join-channel target nil)
489 (riece-command-join-partner target)))))
491 (defun riece-command-part-channel (target message)
492 (unless (riece-server-opened (riece-identity-server target))
493 (error "%s" (substitute-command-keys
494 "Type \\[riece-command-open-server] to open server.")))
495 (riece-send-string (if message
496 (format "PART %s :%s\r\n"
497 (riece-identity-prefix target)
499 (format "PART %s\r\n"
500 (riece-identity-prefix target)))
503 (defun riece-command-part (target &optional message)
506 (riece-check-channel-commands-are-usable)
507 (let* ((completion-ignore-case t)
509 (riece-completing-read-identity
510 (format (riece-mcat "Part from channel/user (default %s): ")
511 (riece-format-identity riece-current-channel))
512 riece-current-channels nil nil nil nil
513 (riece-format-identity riece-current-channel)))
515 (if current-prefix-arg
516 (read-string (riece-mcat "Message: "))
517 riece-part-message)))
518 (list target message))))
519 (if (riece-identity-member target riece-current-channels)
520 (if (riece-channel-p (riece-identity-prefix target))
521 (riece-command-part-channel target message)
522 (riece-part-channel target))
523 (error "You are not talking with %s" target)))
525 (defun riece-command-change-nickname (nickname)
526 "Change your nickname to NICK."
527 (interactive "sEnter your nickname: ")
528 (riece-send-string (format "NICK %s\r\n" nickname)))
530 (defun riece-command-scroll-down (lines)
531 "Scroll LINES down dialogue buffer from command buffer."
533 (let ((buffer (if (and riece-channel-buffer-mode
534 riece-current-channel)
536 riece-dialogue-buffer)))
537 (if (get-buffer-window buffer)
539 (let ((other-window-scroll-buffer buffer))
540 (scroll-other-window-down lines))
542 (message (riece-mcat "Beginning of buffer")))))))
544 (defun riece-command-scroll-up (lines)
545 "Scroll LINES up dialogue buffer from command buffer."
547 (let ((buffer (if (and riece-channel-buffer-mode
548 riece-current-channel)
550 riece-dialogue-buffer)))
551 (if (get-buffer-window buffer)
553 (let ((other-window-scroll-buffer buffer))
554 (scroll-other-window lines))
556 (message (riece-mcat "End of buffer")))))))
558 (defun riece-command-user-list-scroll-down (lines)
559 "Scroll LINES down user list buffer from command buffer."
561 (if (get-buffer-window riece-user-list-buffer)
563 (let ((other-window-scroll-buffer riece-user-list-buffer))
564 (scroll-other-window-down lines))
566 (message (riece-mcat "Beginning of buffer"))))))
568 (defun riece-command-user-list-scroll-up (lines)
569 "Scroll LINES up user list buffer from command buffer."
571 (if (get-buffer-window riece-user-list-buffer)
573 (let ((other-window-scroll-buffer riece-user-list-buffer))
574 (scroll-other-window lines))
576 (message (riece-mcat "End of buffer"))))))
578 (defun riece-command-toggle-away (&optional message)
579 "Mark yourself as being away."
581 (if (and (not (riece-with-server-buffer (riece-identity-server
582 (riece-current-nickname))
583 (riece-user-get-away (riece-identity-prefix
584 (riece-current-nickname)))))
586 (list (read-from-minibuffer
587 (riece-mcat "Away message: ") (cons (or riece-away-message "")
589 (if (riece-with-server-buffer (riece-identity-server
590 (riece-current-nickname))
591 (riece-user-get-away (riece-identity-prefix
592 (riece-current-nickname))))
593 (riece-send-string "AWAY\r\n")
594 (riece-send-string (format "AWAY :%s\r\n" (or message
595 riece-away-message)))))
597 (defun riece-command-toggle-freeze (&optional arg)
598 "Prevent automatic scrolling of the dialogue window.
599 If prefix argument ARG is non-nil, toggle frozen status."
601 (with-current-buffer (if (eq (derived-mode-class major-mode)
602 'riece-dialogue-mode)
604 (if (and riece-channel-buffer-mode
605 riece-channel-buffer)
607 riece-dialogue-buffer))
608 (setq riece-freeze (if arg
609 (< 0 (prefix-numeric-value arg))
611 (riece-emit-signal 'buffer-freeze-changed
612 (current-buffer) riece-freeze)))
614 (defun riece-command-toggle-own-freeze (&optional arg)
615 "Prevent automatic scrolling of the dialogue window.
616 The difference from `riece-command-freeze' is that your messages are hidden.
617 If prefix argument ARG is non-nil, toggle frozen status."
619 (with-current-buffer (if (eq (derived-mode-class major-mode)
620 'riece-dialogue-mode)
622 (if (and riece-channel-buffer-mode
623 riece-channel-buffer)
625 riece-dialogue-buffer))
627 (< 0 (prefix-numeric-value arg))
628 (not (eq riece-freeze 'own)))
629 (setq riece-freeze 'own)
630 (setq riece-freeze nil))
631 (riece-emit-signal 'buffer-freeze-changed
632 (current-buffer) riece-freeze)))
635 (autoload 'riece-exit "riece"))
636 (defun riece-command-quit (&optional arg)
639 (if (null riece-server-process-alist)
641 (message (riece-mcat "No server process"))
643 (if (y-or-n-p (riece-mcat "Really quit IRC? "))
646 (read-string (riece-mcat "Message: "))
648 (alist riece-server-process-alist))
650 (riece-quit-server-process (cdr (car alist)) message)
651 (setq alist (cdr alist)))))))
653 (defun riece-command-raw (command)
654 "Enter raw IRC command, which is sent to the server."
655 (interactive "sIRC command: ")
656 (riece-send-string (concat command "\r\n")))
658 (defun riece-command-beginning-of-buffer ()
659 "Scroll channel buffer to the beginning."
662 (setq buffer (if riece-channel-buffer-mode
664 riece-dialogue-buffer))
665 (or (setq window (get-buffer-window buffer))
666 (setq window (get-buffer-window riece-dialogue-buffer)
667 buffer riece-dialogue-buffer))
669 (save-selected-window
670 (select-window window)
671 (goto-char (point-min))))))
673 (defun riece-command-end-of-buffer ()
674 "Scroll channel buffer to the end."
677 (setq buffer (if riece-channel-buffer-mode
679 riece-dialogue-buffer))
680 (or (setq window (get-buffer-window buffer))
681 (setq window (get-buffer-window riece-dialogue-buffer)
682 buffer riece-dialogue-buffer))
684 (save-selected-window
685 (select-window window)
686 (goto-char (point-max))))))
688 (defun riece-command-copy-region (start end)
689 "Move current region between START and END to `kill-ring'."
691 (kill-new (buffer-substring-no-properties start end)))
693 (defun riece-command-complete-user ()
694 "Complete a user name in the current buffer."
696 (let* ((completion-ignore-case t)
697 (table (mapcar (lambda (user)
698 (list (riece-format-identity user t)))
699 (riece-get-users-on-server
700 (riece-current-server-name))))
701 (current (or (current-word) ""))
702 (completion (try-completion current table))
703 (all (all-completions current table)))
704 (if (eq completion t)
706 (if (null completion)
707 (message (riece-mcat "Can't find completion for \"%s\"") current)
708 (if (equal current completion)
709 (with-output-to-temp-buffer "*Help*"
710 (display-completion-list all))
711 (re-search-forward "\\>" nil t)
712 (delete-region (point) (- (point) (length current)))
713 (insert completion))))))
715 (defun riece-command-open-server (server-name)
717 (list (completing-read (riece-mcat "Open server: ") riece-server-alist)))
718 (if (riece-server-process server-name)
719 (error "%s is already opened" server-name))
721 (riece-server-name-to-server server-name)
724 (defun riece-command-close-server (server-name &optional message)
726 (list (completing-read (riece-mcat "Close server: ")
727 riece-server-process-alist)
728 (if current-prefix-arg
729 (read-string (riece-mcat "Message: "))
730 riece-quit-message)))
731 (let ((process (riece-server-process server-name)))
733 (error "%s is not opened" server-name))
734 (riece-quit-server-process process message)))
736 (defun riece-command-universal-server-name-argument ()
738 (let* ((riece-overriding-server-name
739 (completing-read (riece-mcat "Server: ") riece-server-process-alist))
741 (key-binding (read-key-sequence
742 (format (riece-mcat "Command to execute on \"%s\":")
743 riece-overriding-server-name)))))
745 (call-interactively command)))
748 (autoload 'riece-save-variables-files "riece"))
749 (defun riece-command-save-variables ()
750 "Save `riece-variables-file'."
752 (if (or riece-save-variables-are-dirty
753 (y-or-n-p (riece-mcat "No changes made. Save anyway? ")))
754 (riece-save-variables-files)))
756 (provide 'riece-commands)
758 ;;; riece-commands.el ends here