Function: avy-jump

avy-jump is a byte-compiled function defined in avy.el.

Signature

(avy-jump REGEX &key WINDOW-FLIP BEG END ACTION PRED GROUP)

Documentation

Jump to REGEX.

The window scope is determined by avy-all-windows. When WINDOW-FLIP is non-nil, do the opposite of avy-all-windows. BEG and END narrow the scope where candidates are searched. ACTION is a function that takes point position as an argument. When PRED is non-nil, it's a filter for matching point positions. When GROUP is non-nil, it's either a match group in REGEX, or a function that returns a cons of match beginning and end.

Source Code

;; Defined in ~/.emacs.d/elpa/avy-20241101.1357/avy.el
(cl-defun avy-jump (regex &key window-flip beg end action pred group)
  "Jump to REGEX.
The window scope is determined by `avy-all-windows'.
When WINDOW-FLIP is non-nil, do the opposite of `avy-all-windows'.
BEG and END narrow the scope where candidates are searched.
ACTION is a function that takes point position as an argument.
When PRED is non-nil, it's a filter for matching point positions.
When GROUP is non-nil, it's either a match group in REGEX, or a function
that returns a cons of match beginning and end."
  (setq avy-action (or action avy-action))
  (let ((avy-all-windows
         (if window-flip
             (not avy-all-windows)
           avy-all-windows)))
    (avy-process
     (avy--regex-candidates regex beg end pred group))))