Variable: erc--input-review-functions

erc--input-review-functions is a variable defined in erc.el.gz.

Value

(erc--split-lines
 erc--run-input-validation-checks
 erc--discard-trailing-multiline-nulls
 erc--inhibit-slash-cmd-insertion)

Documentation

Special hook for reviewing and modifying prompt input.

ERC runs this before clearing the prompt and before running any send-related hooks, such as erc-pre-send-functions. Thus, it's quite "safe" to bail out of this hook with a user-error, if necessary. The hook's members are called with one argument, an erc--input-split struct, which they can optionally modify.

The struct has five slots:

  string: the original input as a read-only reference
  insertp: same as in erc-pre-send-functions
  sendp: same as in erc-pre-send-functions
  refoldp: same as in erc-pre-send-functions
  lines: a list of lines to be sent, each one a string
  cmdp: whether to interpret input as a command, like /ignore

When cmdp is non-nil, all but the first line will be discarded.

Aliases

erc--pre-send-split-functions (obsolete since 30.1)

Source Code

;; Defined in /usr/src/emacs/lisp/erc/erc.el.gz
(defvar erc--input-review-functions '(erc--split-lines
                                      erc--run-input-validation-checks
                                      erc--discard-trailing-multiline-nulls
                                      erc--inhibit-slash-cmd-insertion)
  "Special hook for reviewing and modifying prompt input.
ERC runs this before clearing the prompt and before running any
send-related hooks, such as `erc-pre-send-functions'.  Thus, it's
quite \"safe\" to bail out of this hook with a `user-error', if
necessary.  The hook's members are called with one argument, an
`erc--input-split' struct, which they can optionally modify.

The struct has five slots:

  `string': the original input as a read-only reference
  `insertp': same as in `erc-pre-send-functions'
  `sendp': same as in `erc-pre-send-functions'
  `refoldp': same as in `erc-pre-send-functions'
  `lines': a list of lines to be sent, each one a `string'
  `cmdp': whether to interpret input as a command, like /ignore

When `cmdp' is non-nil, all but the first line will be discarded.")