Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Bind mouse events #1279

Closed
wants to merge 11 commits into from
Closed

Bind mouse events #1279

Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
52547d4
Interpret mouse events in the minibuffer managed by ivy.
mookid Nov 12, 2017
5b70f4b
mouse events: add help-echo property.
mookid Nov 12, 2017
f14ce05
mouse events: use interactive magic strings.
mookid Nov 12, 2017
32e8ffd
Fix backquoting.
mookid Nov 12, 2017
bf5f3a3
Fix mouse-minibuffer-check error.
mookid Nov 13, 2017
e158476
Apply mouse face even when non fancy.
mookid Nov 13, 2017
2a1ad83
Handle scroll events.
mookid Nov 16, 2017
9b43ae1
Fix scroll inversion.
mookid Nov 29, 2017
8b25843
Bind ivy-dispatching-done to mouse 3.
mookid Nov 29, 2017
7099c10
Adapt tooltip.
mookid Nov 29, 2017
1d801cd
Amend: cosmetic, cleanup.
mookid Nov 30, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
73 changes: 67 additions & 6 deletions ivy.el
View file
Open in desktop
Expand Up @@ -58,6 +58,10 @@
:background "#65a7e2" :foreground "black"))
"Face used by Ivy for highlighting the current match.")

(defface ivy-minibuffer-match-highlight
'((t :inherit highlight))
"Face used by Ivy for highlighting the match under the cursor.")

(defface ivy-minibuffer-match-face-1
'((((class color) (background light))
:background "#d3d3d3")
Expand Down Expand Up @@ -294,6 +298,9 @@ action functions.")
(defvar ivy-minibuffer-map
(let ((map (make-sparse-keymap)))
(define-key map (kbd "C-m") 'ivy-done)
(define-key map [down-mouse-1] 'ignore)
(define-key map [mouse-1] 'ivy-mouse-done)
(define-key map [mouse-3] 'ivy-mouse-dispatching-done)
(define-key map (kbd "C-M-m") 'ivy-call)
(define-key map (kbd "C-j") 'ivy-alt-done)
(define-key map (kbd "C-M-j") 'ivy-immediate-done)
Expand Down Expand Up @@ -427,6 +434,9 @@ of `history-length'.")
(defvar ivy--index 0
"Store the index of the current candidate.")

(defvar ivy--window-index 0
"Store the index of the current candidate in the minibuffer window.")

(defvar ivy-exit nil
"Store `done' if the completion was successfully selected.
Otherwise, store nil.")
Expand Down Expand Up @@ -611,6 +621,43 @@ candidate, not the prompt."
(insert ivy-text)
(ivy--exhibit)))))

(defvar ivy-mouse-1-tooltip
"Exit the minibuffer with the selected candidate."
"The doc visible in the tooltip for mouse-1 binding in the minibuffer")
(defvar ivy-mouse-3-tooltip
"Display alternative actions."
"The doc visible in the tooltip for mouse-3 binding in the minibuffer")

(defun ivy-mouse-offset (event)
"Compute the offset between the candidate at point and the selected one."
(if event
(let* ((line-number-at-point
(max 2
(line-number-at-pos (posn-point (event-start event)))))

(line-number-candidate ;; convert to 0 based index
(- line-number-at-point 2))
(offset
(- line-number-candidate
ivy--window-index)))
offset)
nil))
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nitpick: can also be

(and event
     (let* ((...))
       ...
       offset)

if you like.


(defun ivy-mouse-done (event)
(interactive "@e")
(let ((offset (ivy-mouse-offset event)))
(when offset
(ivy-next-line-and-call offset)
(ivy-alt-done))))

(defun ivy-mouse-dispatching-done (event)
(interactive "@e")
(let ((offset (ivy-mouse-offset event)))
(when offset
(ivy-next-line offset)
(ivy--exhibit)
(ivy-dispatching-done))))

(defvar ivy-read-action-format-function 'ivy-read-action-format-default
"Function used to transform the actions list into a docstring.")

Expand Down Expand Up @@ -2348,6 +2395,8 @@ tries to ensure that it does not change depending on the number of candidates."

(defun ivy--minibuffer-setup ()
"Setup ivy completion in the minibuffer."
(setq-local mwheel-scroll-up-function 'ivy-next-line)
(setq-local mwheel-scroll-down-function 'ivy-previous-line)
(setq-local completion-show-inline-help nil)
(setq-local minibuffer-default-add-function
(lambda ()
Expand Down Expand Up @@ -3135,7 +3184,7 @@ and SEPARATOR is used to join them."
(let ((i -1))
(mapconcat
(lambda (str)
(let ((curr (eq (cl-incf i) ivy--index)))
(let ((curr (eq (cl-incf i) ivy--window-index)))
(if curr
(funcall selected-fn str)
(funcall other-fn str))))
Expand Down Expand Up @@ -3237,9 +3286,21 @@ FACE is the face to apply to STR."

(defun ivy--format-minibuffer-line (str)
"Format line STR for use in minibuffer."
(if (eq ivy-display-style 'fancy)
(funcall ivy--highlight-function (copy-sequence str))
(copy-sequence str)))
(let ((str (if (eq ivy-display-style 'fancy)
(funcall ivy--highlight-function (copy-sequence str))
(copy-sequence str))))
(add-text-properties
0 (length str)
'(mouse-face
ivy-minibuffer-match-highlight
help-echo
(format
(if tooltip-mode
"mouse-1: %s\nmouse-3: %s"
"mouse-1: %s mouse-3: %s")
ivy-mouse-1-tooltip ivy-mouse-3-tooltip))
str)
str))

(ivy-set-display-transformer
'counsel-find-file 'ivy-read-file-transformer)
Expand Down Expand Up @@ -3267,13 +3328,13 @@ CANDS is a list of strings."
(cands (cl-subseq cands start end))
(index (- ivy--index start))
transformer-fn)
(setq ivy--window-index index)
(setf (ivy-state-current ivy-last) (copy-sequence (nth index cands)))
(when (setq transformer-fn (ivy-state-display-transformer-fn ivy-last))
(with-ivy-window
(with-current-buffer (ivy-state-buffer ivy-last)
(setq cands (mapcar transformer-fn cands)))))
(let* ((ivy--index index)
(cands (mapcar
(let* ((cands (mapcar
#'ivy--format-minibuffer-line
cands))
(res (concat "\n" (funcall ivy-format-function cands))))
Expand Down