mirror of
https://git.savannah.gnu.org/git/emacs.git
synced 2024-12-03 08:30:09 +00:00
5011554529
* lisp/erc/erc-goodies.el: Obviate the need for forward declarations by requiring `erc'. Add minor-mode autoloads for `scrolltobottom', `readonly', `move-to-prompt', `keep-place', `noncommands', `irccontrols', `smiley', and `unmorse'. Add Local variables footer with `generated-autoload-file'. (erc-controls-strip): Autoload this function. * lisp/erc/erc-ibuffer.el: Require `erc-goodies' for `erc-control-interpret'. The justification for the blanket `require' is this module isn't a member of `erc-modules' by default. * lisp/erc/erc-page.el: (erc-ctcp-query-PAGE): Require `erc-goodies' and put forward declaration for `erc-control-interpret' atop file. * lisp/erc/erc-speedbar.el: Require `erc-goodies' for the same reason as erc-ibuffer.el. * lisp/erc/erc.el: Remove `require' for `erc-goodies' at end of file and `pp' at top of file because `pp-to-string' is autoloaded on Emacs 27. Also remove `require's for `thingatpt', `time-date', and `iso8601'. They're all used sparingly and the latter two have only been around for one major release, so their removal likely won't cause much churn. And `thingatpt' already has a call-site `require', so the top-level one is redundant, but autoload `word-at-point' anyway for the benefit of third-party libraries like `hl-nicks'. Also wrap local loaddefs `require' call in `eval-and-compile'. (erc--read-time-period): Require dependencies. (Bug#60954.)
114 lines
3.8 KiB
EmacsLisp
114 lines
3.8 KiB
EmacsLisp
;;; erc-page.el --- CTCP PAGE support for ERC -*- lexical-binding: t; -*-
|
|
|
|
;; Copyright (C) 2002, 2004, 2006-2023 Free Software Foundation, Inc.
|
|
|
|
;; Maintainer: Amin Bandali <bandali@gnu.org>, F. Jason Park <jp@neverwas.me>
|
|
|
|
;; 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:
|
|
|
|
;; Requiring this file will make ERC react to CTCP PAGE messages
|
|
;; received, and it will provide a new /PAGE command to send such
|
|
;; messages yourself. To enable it, customize the variable
|
|
;; `erc-page-mode'.
|
|
|
|
;;; Code:
|
|
|
|
(require 'erc)
|
|
|
|
(declare-function erc-controls-interpret "erc-goodies" (str))
|
|
|
|
(defgroup erc-page nil
|
|
"React to CTCP PAGE messages."
|
|
:group 'erc)
|
|
|
|
;;;###autoload(put 'ctcp-page 'erc--module 'page)
|
|
;;;###autoload(autoload 'erc-page-mode "erc-page")
|
|
(define-erc-module page ctcp-page
|
|
"Process CTCP PAGE requests from IRC."
|
|
nil nil)
|
|
|
|
(erc-define-catalog-entry 'english 'CTCP-PAGE "Page from %n (%u@%h): %m")
|
|
|
|
(defcustom erc-page-function nil
|
|
"A function to process a \"page\" request.
|
|
If nil, this prints the page message in the minibuffer and calls
|
|
`beep'. If non-nil, it must be a function that takes two arguments:
|
|
SENDER and MSG, both strings.
|
|
|
|
Example for your init file:
|
|
|
|
\(setq erc-page-function
|
|
(lambda (sender msg)
|
|
(play-sound-file \"/home/alex/elisp/erc/sounds/ni.wav\")
|
|
(message \"IRC Page from %s: %s\" sender msg)))"
|
|
:type '(choice (const nil)
|
|
(function)))
|
|
|
|
(defcustom erc-ctcp-query-PAGE-hook (list #'erc-ctcp-query-PAGE)
|
|
"List of functions to be called when a CTCP PAGE is received.
|
|
This is called from `erc-process-ctcp-query'. The functions are called
|
|
with six arguments: PROC NICK LOGIN HOST TO MSG. Note that you can
|
|
also set `erc-page-function' to a function, which only gets two arguments,
|
|
SENDER and MSG, so that might be easier to use."
|
|
:type '(repeat function))
|
|
|
|
(defun erc-ctcp-query-PAGE (_proc nick login host _to msg)
|
|
"Deal with an CTCP PAGE query, if `erc-page-mode' is non-nil.
|
|
This will call `erc-page-function', if defined, or it will just print
|
|
a message and `beep'. In addition to that, the page message is also
|
|
inserted into the server buffer."
|
|
(require 'erc-goodies) ; for `erc-controls-interpret'
|
|
(when (and erc-page-mode
|
|
(string-match "PAGE\\(\\s-+.*\\)?$" msg))
|
|
(let* ((m (match-string 1 msg))
|
|
(page-msg (if m (erc-controls-interpret (substring m 1))
|
|
"[no message]"))
|
|
text)
|
|
(if m (setq m (substring m 1)))
|
|
(setq text (erc-format-message 'CTCP-PAGE
|
|
?n nick ?u login
|
|
?h host ?m page-msg))
|
|
(if erc-page-function
|
|
(funcall erc-page-function nick page-msg)
|
|
;; if no function is defined
|
|
(message "%s" text)
|
|
(beep))
|
|
;; insert text into buffer
|
|
(erc-display-message
|
|
nil 'notice nil text)))
|
|
nil)
|
|
|
|
(defun erc-cmd-PAGE (line &optional _force)
|
|
"Send a CTCP page to the user given as the first word in LINE.
|
|
The rest of LINE is the message to send. Note that you will only
|
|
receive pages if `erc-page-mode' is on."
|
|
(when (string-match "^\\s-*\\(\\S-+\\) ?\\(.*\\)" line)
|
|
(let ((nick (match-string 1 line))
|
|
(msg (match-string 2 line)))
|
|
(erc-cmd-CTCP nick "PAGE" msg))))
|
|
|
|
(put 'erc-cmd-PAGE 'do-not-parse-args t)
|
|
|
|
(provide 'erc-page)
|
|
|
|
;;; erc-page.el ends here
|
|
;;
|
|
;; Local Variables:
|
|
;; generated-autoload-file: "erc-loaddefs.el"
|
|
;; End:
|