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.

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

Fix vi-mode's word-related motions #969

Merged
merged 7 commits into from
Aug 20, 2023
Merged
Show file tree
Hide file tree
Changes from 6 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
110 changes: 18 additions & 92 deletions extensions/vi-mode/commands.lisp
Original file line number Diff line number Diff line change
Expand Up @@ -81,36 +81,6 @@
:vi-keyboard-quit))
(in-package :lem-vi-mode/commands)

;; Vim word
;; See http://vimdoc.sourceforge.net/htmldoc/motion.html#word
;; word = a sequence of letters, digits, underscores, or a
;; sequence of other non-blank characters.
(defun vi-word-char-p (char)
(and (characterp char)
(or (alphanumericp char)
(char= char #\_)
(char= char #\_)
;; TODO: Add mechanism to modify
;; these based on isKeyword from lisp.vim https://github.com/vim/vim/blob/master/runtime/syntax/lisp.vim#L74C1-L387
;; which is modified based on file extension.
(char= char #\*)
(char= char #\/)
(char= char #\%)
(char= char #\<)
(char= char #\=)
(char= char #\>)
(char= char #\:)
(char= char #\$)
(char= char #\?)
(char= char #\!)
(char= char #\^)
(char= char #\-))))

(defun vi-space-char-p (char)
(and (characterp char)
(or (char= char #\Space)
(char= char #\Tab))))

(define-command vi-move-to-beginning-of-line/universal-argument-0 () ()
(if (mode-active-p (current-buffer) 'universal-argument)
(universal-argument-0)
Expand Down Expand Up @@ -151,79 +121,35 @@
(previous-line n)
(fall-within-line (current-point)))

(defun %vi-forward-word-begin (n)
(when (< 0 n)
(let ((p (current-point)))
(cond
((vi-word-char-p (character-at p))
(loop
while (and (not (eolp p)) (vi-word-char-p (character-at p 1)))
do (vi-forward-char))
(character-offset p 1))
((vi-space-char-p (character-at p))
(character-offset p 1)
(skip-chars-forward p '(#\Space #\Tab)))
(t
(loop until (or (eolp p)
(vi-word-char-p (character-at p))
(vi-space-char-p (character-at p)))
do (vi-forward-char))
(when (eolp p)
(character-offset p 1)))))
(%vi-forward-word-begin (1- n))))

(define-vi-motion vi-forward-word-begin (&optional (n 1))
(:type :inclusive)
(when (eolp (current-point))
(line-offset (current-point) 1)
(line-start (current-point)))
(%vi-forward-word-begin n)
(skip-chars-forward (current-point) '(#\Space #\Tab #\Newline)))
(define-command vi-forward-word-begin (&optional (n 1)) ("p")
(dotimes (i n)
(forward-word-begin #'char-type)))

(define-command vi-backward-word-begin (&optional (n 1)) ("p")
(let ((p (current-point)))
(when (and (< 0 n)
(not (and (= (line-number-at-point p) 1)
(bolp p))))
(cond
((vi-word-char-p (character-at p -1))
(loop
while (and (not (bolp p)) (vi-word-char-p (character-at p -1)))
do (vi-backward-char)))
((or (bolp p)
(vi-space-char-p (character-at p -1)))
(skip-chars-backward p '(#\Space #\Tab #\Newline #\Return))
(vi-backward-word-begin n))
(t
(loop until (or (bolp p)
(vi-word-char-p (character-at p -1))
(vi-space-char-p (character-at p -1)))
do (vi-backward-char))))
(vi-backward-word-begin (1- n)))))
(dotimes (i n)
(backward-word-begin #'char-type)))

(define-vi-motion vi-forward-word-end (&optional (n 1))
(:type :inclusive)
(dotimes (i n)
(forward-word-end #'char-type)))

(define-command vi-forward-word-begin-broad (&optional (n 1)) ("p")
(forward-word-begin (current-point) n t))
(dotimes (i n)
(forward-word-begin #'broad-char-type)))

(define-command vi-backward-word-begin-broad (&optional (n 1)) ("p")
(backward-word-begin (current-point) n t))
(dotimes (i n)
(backward-word-begin #'broad-char-type)))

(define-vi-motion vi-forward-word-end (&optional (n 1))
(define-vi-motion vi-forward-word-end-broad (&optional (n 1))
(:type :inclusive)
(character-offset (current-point) 1)
(skip-chars-forward (current-point) (lambda (char)
(or (char= char #\Newline)
(vi-space-char-p char))))
(%vi-forward-word-begin n)
(vi-backward-char))

(define-command vi-forward-word-end-broad (&optional (n 1)) ("p")
(forward-word-end (current-point) n t))
(dotimes (i n)
(forward-word-end #'broad-char-type)))

(define-command vi-backward-word-end (&optional (n 1)) ("p")
(character-offset (current-point) -1)
(skip-chars-backward (current-point) (lambda (char)
(or (char= char #\Newline)
(vi-space-char-p char))))
(skip-chars-backward (current-point) #'blank-char-p)
(vi-backward-word-begin n))

(define-command vi-move-to-beginning-of-line () ()
Expand Down
192 changes: 192 additions & 0 deletions extensions/vi-mode/tests/motion.lisp
Original file line number Diff line number Diff line change
Expand Up @@ -20,3 +20,195 @@
(ok (buf= #?"abcd[e]f\n"))
(cmd "10l")
(ok (buf= #?"abcde[f]\n")))))

(deftest vi-forward-word-end
(with-fake-interface ()
(with-vi-buffer (#?"[a]bc()def#ghi jkl ()\n")
(cmd "e")
(ok (buf= #?"ab[c]()def#ghi jkl ()\n"))
(cmd "e")
(ok (buf= #?"abc([)]def#ghi jkl ()\n"))
(cmd "e")
(ok (buf= #?"abc()de[f]#ghi jkl ()\n"))
(cmd "e")
(ok (buf= #?"abc()def[#]ghi jkl ()\n"))
(cmd "e")
(ok (buf= #?"abc()def#gh[i] jkl ()\n"))
(cmd "2e")
(ok (buf= #?"abc()def#ghi jkl ([)]\n"))
(cmd "e")
(ok (buf= #?"abc()def#ghi jkl ()\n[]"))
(cmd "10e")
(ok (buf= #?"abc()def#ghi jkl ()\n[]")))
(with-vi-buffer (#?"[a]bc def () \n\t # ghi\n")
(cmd "e")
(ok (buf= #?"ab[c] def () \n\t # ghi\n"))
(cmd "e")
(ok (buf= #?"abc de[f] () \n\t # ghi\n"))
(cmd "e")
(ok (buf= #?"abc def ([)] \n\t # ghi\n"))
(cmd "e")
(ok (buf= #?"abc def () \n\t [#] ghi\n"))
(cmd "e")
(ok (buf= #?"abc def () \n\t # gh[i]\n")))
(with-vi-buffer (#?"abc [ ]\t def\n\n ghi")
(cmd "e")
(ok (buf= #?"abc \t de[f]\n\n ghi"))
(cmd "l")
(cmd "e")
(ok (buf= #?"abc \t def\n\n gh[i]")))
(with-vi-buffer (#?"a[b]cd efg hij klm nop")
(cmd "de")
(ok (buf= #?"a[ ]efg hij klm nop"))
(cmd "de")
(ok (buf= #?"a[ ]hij klm nop"))
(cmd "d2e")
(ok (buf= #?"a[ ]nop")))))

(deftest vi-forward-word-end-broad
(with-fake-interface ()
(with-vi-buffer (#?"[a]bc-def (ghi jkl) # \n\t m")
(cmd "E")
(ok (buf= #?"abc-de[f] (ghi jkl) # \n\t m"))
(cmd "E")
(ok (buf= #?"abc-def (gh[i] jkl) # \n\t m"))
(cmd "E")
(ok (buf= #?"abc-def (ghi jkl[)] # \n\t m"))
(cmd "E")
(ok (buf= #?"abc-def (ghi jkl) [#] \n\t m"))
(cmd "E")
(ok (buf= #?"abc-def (ghi jkl) # \n\t [m]"))
(cmd "E")
(ok (buf= #?"abc-def (ghi jkl) # \n\t m[]"))
(cmd "gg")
(cmd "3E")
(ok (buf= #?"abc-def (ghi jkl[)] # \n\t m")))
(with-vi-buffer ("ab[c]-def ghi # jkl")
(cmd "dE")
(ok (buf= "ab[ ]ghi # jkl"))
(cmd "d2E")
(ok (buf= "ab[ ]jkl")))))

(deftest vi-backward-word-begin
(with-fake-interface ()
(with-vi-buffer (#?"abc()def#ghi jkl ()[\n]")
(cmd "b")
(ok (buf= #?"abc()def#ghi jkl [(])\n"))
(cmd "2b")
(ok (buf= #?"abc()def#[g]hi jkl ()\n"))
(cmd "b")
(ok (buf= #?"abc()def[#]ghi jkl ()\n"))
(cmd "b")
(ok (buf= #?"abc()[d]ef#ghi jkl ()\n"))
(cmd "b")
(ok (buf= #?"abc[(])def#ghi jkl ()\n"))
(cmd "b")
(ok (buf= #?"[a]bc()def#ghi jkl ()\n"))
(cmd "10b")
(ok (buf= #?"[a]bc()def#ghi jkl ()\n")))
(with-vi-buffer (#?"abc def () \n\t # ghi[\n]")
(cmd "b")
(ok (buf= #?"abc def () \n\t # [g]hi\n"))
(cmd "b")
(ok (buf= #?"abc def () \n\t [#] ghi\n"))
(cmd "b")
(ok (buf= #?"abc def [(]) \n\t # ghi\n"))
(cmd "b")
(ok (buf= #?"abc [d]ef () \n\t # ghi\n"))
(cmd "b")
(ok (buf= #?"[a]bc def () \n\t # ghi\n")))
(with-vi-buffer (#?"abc\n\n \t de[f]")
(cmd "b")
(ok (buf= #?"abc\n\n \t [d]ef"))
(cmd "h")
(cmd "b")
(ok (buf= #?"[a]bc\n\n \t def")))
(with-vi-buffer ("abc # def-g[h]i")
(cmd "db")
(ok (buf= "abc # def-[h]i"))
(cmd "d2b")
(ok (buf= "abc # [h]i")))))

(deftest vi-backward-word-begin-broad
(with-fake-interface ()
(with-vi-buffer (#?"a \t\n # (bcd efg) hij-kl[m]")
(cmd "B")
(ok (buf= #?"a \t\n # (bcd efg) [h]ij-klm"))
(cmd "B")
(ok (buf= #?"a \t\n # (bcd [e]fg) hij-klm"))
(cmd "B")
(ok (buf= #?"a \t\n # [(]bcd efg) hij-klm"))
(cmd "B")
(ok (buf= #?"a \t\n [#] (bcd efg) hij-klm"))
(cmd "B")
(ok (buf= #?"[a] \t\n # (bcd efg) hij-klm"))
(cmd "G$")
(cmd "3B")
(ok (buf= #?"a \t\n # [(]bcd efg) hij-klm")))
(with-vi-buffer ("jkl # ghi abc-[d]ef")
(cmd "dB")
(ok (buf= "jkl # ghi [d]ef"))
(cmd "d2B")
(ok (buf= "jkl [d]ef")))))

(deftest vi-forward-word-begin
(with-fake-interface ()
(with-vi-buffer (#?"[a]bc()def#ghi jkl ()\n")
(cmd "w")
(ok (buf= #?"abc[(])def#ghi jkl ()\n"))
(cmd "w")
(ok (buf= #?"abc()[d]ef#ghi jkl ()\n"))
(cmd "w")
(ok (buf= #?"abc()def[#]ghi jkl ()\n"))
(cmd "w")
(ok (buf= #?"abc()def#[g]hi jkl ()\n"))
(cmd "2w")
(ok (buf= #?"abc()def#ghi jkl [(])\n"))
(cmd "10w")
(ok (buf= #?"abc()def#ghi jkl ()\n[]")))
(with-vi-buffer (#?"[a]bc def () \n\t # ghi\n")
(cmd "w")
(ok (buf= #?"abc [d]ef () \n\t # ghi\n"))
(cmd "w")
(ok (buf= #?"abc def [(]) \n\t # ghi\n"))
(cmd "w")
(ok (buf= #?"abc def () \n\t [#] ghi\n"))
(cmd "w")
(ok (buf= #?"abc def () \n\t # [g]hi\n"))
(cmd "w")
(ok (buf= #?"abc def () \n\t # ghi\n[]")))
(with-vi-buffer (#?"abc [ ]\t def\n\n ghi")
(cmd "w")
(ok (buf= #?"abc \t [d]ef\n\n ghi"))
(cmd "3l")
(cmd "w")
(ok (buf= #?"abc \t def\n\n [g]hi")))
(with-vi-buffer (#?"a[b]cd efg hij klm nop")
(cmd "dw")
(ok (buf= #?"a[e]fg hij klm nop"))
(cmd "dw")
(ok (buf= #?"a[h]ij klm nop"))
(cmd "d2w")
(ok (buf= #?"a[n]op")))))

(deftest vi-forward-word-begin-broad
(with-fake-interface ()
(with-vi-buffer (#?"[a]bc-def (ghi jkl) # \n\t m")
(cmd "W")
(ok (buf= #?"abc-def [(]ghi jkl) # \n\t m"))
(cmd "W")
(ok (buf= #?"abc-def (ghi [j]kl) # \n\t m"))
(cmd "W")
(ok (buf= #?"abc-def (ghi jkl) [#] \n\t m"))
(cmd "W")
(ok (buf= #?"abc-def (ghi jkl) # \n\t [m]"))
(cmd "W")
(ok (buf= #?"abc-def (ghi jkl) # \n\t m[]"))
(cmd "gg")
(cmd "3W")
(ok (buf= #?"abc-def (ghi jkl) [#] \n\t m")))
(with-vi-buffer ("ab[c]-def ghi # jkl")
(cmd "dW")
(ok (buf= "ab[g]hi # jkl"))
(cmd "d2W")
(ok (buf= "ab[j]kl")))))
3 changes: 2 additions & 1 deletion extensions/vi-mode/tests/utils.lisp
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,7 @@
(nreverse visual-regions))))

(defun %make-buffer-string (buffer-text buffer-pos)
(check-type buffer-pos (integer 0))
(let ((state (current-state)))
(let ((buf-str
(apply #'concatenate 'string
Expand Down Expand Up @@ -263,7 +264,7 @@

(defun cmd (keys)
(check-type keys string)
(diag (format nil "[cmd] ~A" keys))
(diag (format nil "[cmd] ~A~%" keys))
(execute-key-sequence
(parse-command-keys keys)))

Expand Down
Loading