mirror of
https://github.com/neovim/neovim.git
synced 2025-11-04 09:44:31 +00:00
93c8fe77cb
Add 'mousescroll' option to control how many lines to scroll by when a
mouse wheel keycode is received. The mousescroll option controls both
horizontal and vertical scrolling. The option is a string in the format:
set mousescroll=direction:count,direction:count
Where direction is either "ver" or "hor", and count is a non negative
integer. If a direction is omitted, a default value is used. The default
values remain unchanged, that is 3 for vertical scrolling, and 6 for
horizontal scrolling. As such, the mousescroll default is "ver:3,hor:6".
Add mousescroll documentation
- Add option documentation in options.txt
- Add brief summary in quickref.txt
Update :help scroll-mouse-wheel
- Mention mousescroll option as a means of controlling scrolling.
- Remove obsolete suggestion to map scroll wheel keys to <C-U> to
scroll by a single line -- users should prefer the mousescroll option.
- Add some information about the consequences of remapping scroll wheel
keys (they lose their magic ability to affect inactive windows).
Update :help vim-differences
- Add brief mousescroll summary under Options
Add mousescroll tests
- Test option validation
- Test default mousescroll value and behavior
- Test fallback to default values
- Test mouse vertical and horizontal scrolling in normal mode
- Test mouse vertical and horizontal scrolling in insert mode
152 lines
3.7 KiB
Lua
152 lines
3.7 KiB
Lua
local helpers = require('test.functional.helpers')(after_each)
|
|
local command = helpers.command
|
|
local clear = helpers.clear
|
|
local eval = helpers.eval
|
|
local eq = helpers.eq
|
|
local exc_exec = helpers.exc_exec
|
|
local feed = helpers.feed
|
|
|
|
local scroll = function(direction)
|
|
return helpers.request('nvim_input_mouse', 'wheel', direction, '', 0, 2, 2)
|
|
end
|
|
|
|
local screenrow = function()
|
|
return helpers.call('screenrow')
|
|
end
|
|
|
|
local screencol = function()
|
|
return helpers.call('screencol')
|
|
end
|
|
|
|
describe("'mousescroll'", function()
|
|
local invalid_arg = 'Vim(set):E474: Invalid argument: mousescroll='
|
|
local digit_expected = 'Vim(set):E548: digit expected: mousescroll='
|
|
|
|
local function should_fail(val, errorstr)
|
|
eq(errorstr..val, exc_exec('set mousescroll='..val))
|
|
end
|
|
|
|
local function should_succeed(val)
|
|
eq(0, exc_exec('set mousescroll='..val))
|
|
end
|
|
|
|
before_each(function()
|
|
clear()
|
|
command('set nowrap lines=20 columns=20 virtualedit=all')
|
|
feed('100o<Esc>50G10|')
|
|
end)
|
|
|
|
it('handles invalid values', function()
|
|
should_fail('', invalid_arg) -- empty string
|
|
should_fail('foo:123', invalid_arg) -- unknown direction
|
|
should_fail('hor:1,hor:2', invalid_arg) -- duplicate direction
|
|
should_fail('ver:99999999999999999999', invalid_arg) -- integer overflow
|
|
should_fail('ver:bar', digit_expected) -- expected digit
|
|
should_fail('ver:-1', digit_expected) -- negative count
|
|
end)
|
|
|
|
it('handles valid values', function()
|
|
should_succeed('hor:1,ver:1') -- both directions set
|
|
should_succeed('hor:1') -- only horizontal
|
|
should_succeed('ver:1') -- only vertical
|
|
should_succeed('hor:0,ver:0') -- zero
|
|
should_succeed('hor:2147483647') -- large count
|
|
end)
|
|
|
|
it('default set correctly', function()
|
|
eq('ver:3,hor:6', eval('&mousescroll'))
|
|
|
|
eq(10, screenrow())
|
|
scroll('up')
|
|
eq(13, screenrow())
|
|
scroll('down')
|
|
eq(10, screenrow())
|
|
|
|
eq(10, screencol())
|
|
scroll('right')
|
|
eq(4, screencol())
|
|
scroll('left')
|
|
eq(10, screencol())
|
|
end)
|
|
|
|
it('vertical scrolling falls back to default value', function()
|
|
command('set mousescroll=hor:1')
|
|
eq(10, screenrow())
|
|
scroll('up')
|
|
eq(13, screenrow())
|
|
end)
|
|
|
|
it('horizontal scrolling falls back to default value', function()
|
|
command('set mousescroll=ver:1')
|
|
eq(10, screencol())
|
|
scroll('right')
|
|
eq(4, screencol())
|
|
end)
|
|
|
|
it('count of zero disables mouse scrolling', function()
|
|
command('set mousescroll=hor:0,ver:0')
|
|
|
|
eq(10, screenrow())
|
|
scroll('up')
|
|
eq(10, screenrow())
|
|
scroll('down')
|
|
eq(10, screenrow())
|
|
|
|
eq(10, screencol())
|
|
scroll('right')
|
|
eq(10, screencol())
|
|
scroll('left')
|
|
eq(10, screencol())
|
|
end)
|
|
|
|
local test_vertical_scrolling = function()
|
|
eq(10, screenrow())
|
|
|
|
command('set mousescroll=ver:1')
|
|
scroll('up')
|
|
eq(11, screenrow())
|
|
|
|
command('set mousescroll=ver:2')
|
|
scroll('down')
|
|
eq(9, screenrow())
|
|
|
|
command('set mousescroll=ver:5')
|
|
scroll('up')
|
|
eq(14, screenrow())
|
|
end
|
|
|
|
it('controls vertical scrolling in normal mode', function()
|
|
test_vertical_scrolling()
|
|
end)
|
|
|
|
it('controls vertical scrolling in insert mode', function()
|
|
feed('i')
|
|
test_vertical_scrolling()
|
|
end)
|
|
|
|
local test_horizontal_scrolling = function()
|
|
eq(10, screencol())
|
|
|
|
command('set mousescroll=hor:1')
|
|
scroll('right')
|
|
eq(9, screencol())
|
|
|
|
command('set mousescroll=hor:3')
|
|
scroll('right')
|
|
eq(6, screencol())
|
|
|
|
command('set mousescroll=hor:2')
|
|
scroll('left')
|
|
eq(8, screencol())
|
|
end
|
|
|
|
it('controls horizontal scrolling in normal mode', function()
|
|
test_horizontal_scrolling()
|
|
end)
|
|
|
|
it('controls horizontal scrolling in insert mode', function()
|
|
feed('i')
|
|
test_horizontal_scrolling()
|
|
end)
|
|
end)
|