Mercurial > vim
view src/testdir/test_breakindent.vim @ 32936:c517845bd10e v9.0.1776
patch 9.0.1776: No support for stable Python 3 ABI
Commit: https://github.com/vim/vim/commit/c13b3d1350b60b94fe87f0761ea31c0e7fb6ebf3
Author: Yee Cheng Chin <ychin.git@gmail.com>
Date: Sun Aug 20 21:18:38 2023 +0200
patch 9.0.1776: No support for stable Python 3 ABI
Problem: No support for stable Python 3 ABI
Solution: Support Python 3 stable ABI
Commits:
1) Support Python 3 stable ABI to allow mixed version interoperatbility
Vim currently supports embedding Python for use with plugins, and the
"dynamic" linking option allows the user to specify a locally installed
version of Python by setting `pythonthreedll`. However, one caveat is
that the Python 3 libs are not binary compatible across minor versions,
and mixing versions can potentially be dangerous (e.g. let's say Vim was
linked against the Python 3.10 SDK, but the user sets `pythonthreedll`
to a 3.11 lib). Usually, nothing bad happens, but in theory this could
lead to crashes, memory corruption, and other unpredictable behaviors.
It's also difficult for the user to tell something is wrong because Vim
has no way of reporting what Python 3 version Vim was linked with.
For Vim installed via a package manager, this usually isn't an issue
because all the dependencies would already be figured out. For prebuilt
Vim binaries like MacVim (my motivation for working on this), AppImage,
and Win32 installer this could potentially be an issue as usually a
single binary is distributed. This is more tricky when a new Python
version is released, as there's a chicken-and-egg issue with deciding
what Python version to build against and hard to keep in sync when a new
Python version just drops and we have a mix of users of different Python
versions, and a user just blindly upgrading to a new Python could lead to
bad interactions with Vim.
Python 3 does have a solution for this problem: stable ABI / limited API
(see https://docs.python.org/3/c-api/stable.html). The C SDK limits the
API to a set of functions that are promised to be stable across
versions. This pull request adds an ifdef config that allows us to turn
it on when building Vim. Vim binaries built with this option should be
safe to freely link with any Python 3 libraies without having the
constraint of having to use the same minor version.
Note: Python 2 has no such concept and this doesn't change how Python 2
integration works (not that there is going to be a new version of Python
2 that would cause compatibility issues in the future anyway).
---
Technical details:
======
The stable ABI can be accessed when we compile with the Python 3 limited
API (by defining `Py_LIMITED_API`). The Python 3 code (in `if_python3.c`
and `if_py_both.h`) would now handle this and switch to limited API
mode. Without it set, Vim will still use the full API as before so this
is an opt-in change.
The main difference is that `PyType_Object` is now an opaque struct that
we can't directly create "static types" out of, and we have to create
type objects as "heap types" instead. This is because the struct is not
stable and changes from version to version (e.g. 3.8 added a
`tp_vectorcall` field to it). I had to change all the types to be
allocated on the heap instead with just a pointer to them.
Other functions are also simply missing in limited API, or they are
introduced too late (e.g. `PyUnicode_AsUTF8AndSize` in 3.10) to it that
we need some other ways to do the same thing, so I had to abstract a few
things into macros, and sometimes re-implement functions like
`PyObject_NEW`.
One caveat is that in limited API, `OutputType` (used for replacing
`sys.stdout`) no longer inherits from `PyStdPrinter_Type` which I don't
think has any real issue other than minor differences in how they
convert to a string and missing a couple functions like `mode()` and
`fileno()`.
Also fixed an existing bug where `tp_basicsize` was set incorrectly for
`BufferObject`, `TabListObject, `WinListObject`.
Technically, there could be a small performance drop, there is a little
more indirection with accessing type objects, and some APIs like
`PyUnicode_AsUTF8AndSize` are missing, but in practice I didn't see any
difference, and any well-written Python plugin should try to avoid
excessing callbacks to the `vim` module in Python anyway.
I only tested limited API mode down to Python 3.7, which seemes to
compile and work fine. I haven't tried earlier Python versions.
2) Fix PyIter_Check on older Python vers / type##Ptr unused warning
For PyIter_Check, older versions exposed them as either macros (used in
full API), or a function (for use in limited API). A previous change
exposed PyIter_Check to the dynamic build because Python just moved it
to function-only in 3.10 anyway. Because of that, just make sure we
always grab the function in dynamic builds in earlier versions since
that's what Python eventually did anyway.
3) Move Py_LIMITED_API define to configure script
Can now use --with-python-stable-abi flag to customize what stable ABI
version to target. Can also use an env var to do so as well.
4) Show +python/dyn-stable in :version, and allow has() feature query
Not sure if the "/dyn-stable" suffix would break things, or whether we
should do it another way. Or just don't show it in version and rely on
has() feature checking.
5) Documentation first draft. Still need to implement v:python3_version
6) Fix PyIter_Check build breaks when compiling against Python 3.8
7) Add CI coverage stable ABI on Linux/Windows / make configurable on Windows
This adds configurable options for Windows make files (both MinGW and
MSVC). CI will also now exercise both traditional full API and stable
ABI for Linux and Windows in the matrix for coverage.
Also added a "dynamic" option to Linux matrix as a drive-by change to
make other scripting languages like Ruby / Perl testable under both
static and dynamic builds.
8) Fix inaccuracy in Windows docs
Python's own docs are confusing but you don't actually want to use
`python3.dll` for the dynamic linkage.
9) Add generated autoconf file
10) Add v:python3_version support
This variable indicates the version of Python3 that Vim was built
against (PY_VERSION_HEX), and will be useful to check whether the Python
library you are loading in dynamically actually fits it. When built with
stable ABI, it will be the limited ABI version instead
(`Py_LIMITED_API`), which indicates the minimum version of Python 3 the
user should have, rather than the exact match. When stable ABI is used,
we won't be exposing PY_VERSION_HEX in this var because it just doesn't
seem necessary to do so (the whole point of stable ABI is the promise
that it will work across versions), and I don't want to confuse the user
with too many variables.
Also, cleaned up some documentation, and added help tags.
11) Fix Python 3.7 compat issues
Fix a couple issues when using limited API < 3.8
- Crash on exit: In Python 3.7, if a heap-allocated type is destroyed
before all instances are, it would cause a crash later. This happens
when we destroyed `OptionsType` before calling `Py_Finalize` when
using the limited API. To make it worse, later versions changed the
semantics and now each instance has a strong reference to its own type
and the recommendation has changed to have each instance de-ref its
own type and have its type in GC traversal. To avoid dealing with
these cross-version variations, we just don't free the heap type. They
are static types in non-limited-API anyway and are designed to last
through the entirety of the app, and we also don't restart the Python
runtime and therefore do not need it to have absolutely 0 leaks.
See:
- https://docs.python.org/3/whatsnew/3.8.html#changes-in-the-c-api
- https://docs.python.org/3/whatsnew/3.9.html#changes-in-the-c-api
- PyIter_Check: This function is not provided in limited APIs older than
3.8. Previously I was trying to mock it out using manual
PyType_GetSlot() but it was brittle and also does not actually work
properly for static types (it will generate a Python error). Just
return false. It does mean using limited API < 3.8 is not recommended
as you lose the functionality to handle iterators, but from playing
with plugins I couldn't find it to be an issue.
- Fix loading of PyIter_Check so it will be done when limited API < 3.8.
Otherwise loading a 3.7 Python lib will fail even if limited API was
specified to use it.
12) Make sure to only load `PyUnicode_AsUTF8AndSize` in needed in limited API
We don't use this function unless limited API >= 3.10, but we were
loading it regardless. Usually it's ok in Unix-like systems where Python
just has a single lib that we load from, but in Windows where there is a
separate python3.dll this would not work as the symbol would not have
been exposed in this more limited DLL file. This makes it much clearer
under what condition is this function needed.
closes: #12032
Signed-off-by: Christian Brabandt <cb@256bit.org>
Co-authored-by: Yee Cheng Chin <ychin.git@gmail.com>
| author | Christian Brabandt <cb@256bit.org> |
|---|---|
| date | Sun, 20 Aug 2023 21:30:04 +0200 |
| parents | 6a03cc83fcc5 |
| children | 68a12270d21b |
line wrap: on
line source
" Test for breakindent " " Note: if you get strange failures when adding new tests, it might be that " while the test is run, the breakindent caching gets in its way. " It helps to change the tabstop setting and force a redraw (e.g. see " Test_breakindent08()) source check.vim CheckOption breakindent source view_util.vim source screendump.vim func SetUp() let s:input ="\tabcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOP" endfunc func s:screen_lines(lnum, width) abort return ScreenLines([a:lnum, a:lnum + 2], a:width) endfunc func s:screen_lines2(lnums, lnume, width) abort return ScreenLines([a:lnums, a:lnume], a:width) endfunc func s:compare_lines(expect, actual) call assert_equal(join(a:expect, "\n"), join(a:actual, "\n")) endfunc func s:test_windows(...) call NewWindow(10, 20) setl ts=4 sw=4 sts=4 breakindent put =s:input exe get(a:000, 0, '') endfunc func s:close_windows(...) call CloseWindow() exe get(a:000, 0, '') endfunc func Test_breakindent01() " simple breakindent test call s:test_windows('setl briopt=min:0') let lines = s:screen_lines(line('.'),8) let expect = [ \ " abcd", \ " qrst", \ " GHIJ", \ ] call s:compare_lines(expect, lines) call s:close_windows() endfunc func Test_breakindent01_vartabs() " like 01 but with vartabs feature CheckFeature vartabs call s:test_windows('setl briopt=min:0 vts=4') let lines = s:screen_lines(line('.'),8) let expect = [ \ " abcd", \ " qrst", \ " GHIJ", \ ] call s:compare_lines(expect, lines) call s:close_windows('set vts&') endfunc func Test_breakindent02() " simple breakindent test with showbreak set set sbr=>> call s:test_windows('setl briopt=min:0 sbr=') let lines = s:screen_lines(line('.'),8) let expect = [ \ " abcd", \ " >>qr", \ " >>EF", \ ] call s:compare_lines(expect, lines) call s:close_windows('set sbr=') endfunc func Test_breakindent02_vartabs() CheckFeature vartabs " simple breakindent test with showbreak set call s:test_windows('setl briopt=min:0 sbr=>> vts=4') let lines = s:screen_lines(line('.'), 8) let expect = [ \ " abcd", \ " >>qr", \ " >>EF", \ ] call s:compare_lines(expect, lines) call s:close_windows('set sbr= vts&') endfunc func Test_breakindent03() " simple breakindent test with showbreak set and briopt including sbr call s:test_windows('setl briopt=sbr,min:0 sbr=++') let lines = s:screen_lines(line('.'), 8) let expect = [ \ " abcd", \ "++ qrst", \ "++ GHIJ", \ ] call s:compare_lines(expect, lines) " clean up call s:close_windows('set sbr=') endfunc func Test_breakindent03_vartabs() " simple breakindent test with showbreak set and briopt including sbr CheckFeature vartabs call s:test_windows('setl briopt=sbr,min:0 sbr=++ vts=4') let lines = s:screen_lines(line('.'), 8) let expect = [ \ " abcd", \ "++ qrst", \ "++ GHIJ", \ ] call s:compare_lines(expect, lines) " clean up call s:close_windows('set sbr= vts&') endfunc func Test_breakindent04() " breakindent set with min width 18 set sbr=<<< call s:test_windows('setl sbr=NONE briopt=min:18') let lines = s:screen_lines(line('.'), 8) let expect = [ \ " abcd", \ " qrstuv", \ " IJKLMN", \ ] call s:compare_lines(expect, lines) " clean up call s:close_windows('set sbr=') set sbr= endfunc func Test_breakindent04_vartabs() " breakindent set with min width 18 CheckFeature vartabs call s:test_windows('setl sbr= briopt=min:18 vts=4') let lines = s:screen_lines(line('.'), 8) let expect = [ \ " abcd", \ " qrstuv", \ " IJKLMN", \ ] call s:compare_lines(expect, lines) " clean up call s:close_windows('set sbr= vts&') endfunc func Test_breakindent05() " breakindent set and shift by 2 call s:test_windows('setl briopt=shift:2,min:0') let lines = s:screen_lines(line('.'),8) let expect = [ \ " abcd", \ " qr", \ " EF", \ ] call s:compare_lines(expect, lines) call s:close_windows() endfunc func Test_breakindent05_vartabs() " breakindent set and shift by 2 CheckFeature vartabs call s:test_windows('setl briopt=shift:2,min:0 vts=4') let lines = s:screen_lines(line('.'),8) let expect = [ \ " abcd", \ " qr", \ " EF", \ ] call s:compare_lines(expect, lines) call s:close_windows('set vts&') endfunc func Test_breakindent06() " breakindent set and shift by -1 call s:test_windows('setl briopt=shift:-1,min:0') let lines = s:screen_lines(line('.'),8) let expect = [ \ " abcd", \ " qrstu", \ " HIJKL", \ ] call s:compare_lines(expect, lines) call s:close_windows() endfunc func Test_breakindent06_vartabs() " breakindent set and shift by -1 CheckFeature vartabs call s:test_windows('setl briopt=shift:-1,min:0 vts=4') let lines = s:screen_lines(line('.'),8) let expect = [ \ " abcd", \ " qrstu", \ " HIJKL", \ ] call s:compare_lines(expect, lines) call s:close_windows('set vts&') endfunc func Test_breakindent07() " breakindent set and shift by 1, Number set sbr=? and briopt:sbr call s:test_windows('setl briopt=shift:1,sbr,min:0 nu sbr=? nuw=4 cpo+=n') let lines = s:screen_lines(line('.'),10) let expect = [ \ " 2 ab", \ "? m", \ "? x", \ ] call s:compare_lines(expect, lines) " clean up call s:close_windows('set sbr= cpo-=n') endfunc func Test_breakindent07_vartabs() CheckFeature vartabs " breakindent set and shift by 1, Number set sbr=? and briopt:sbr call s:test_windows('setl briopt=shift:1,sbr,min:0 nu sbr=? nuw=4 cpo+=n vts=4') let lines = s:screen_lines(line('.'),10) let expect = [ \ " 2 ab", \ "? m", \ "? x", \ ] call s:compare_lines(expect, lines) " clean up call s:close_windows('set sbr= cpo-=n vts&') endfunc func Test_breakindent07a() " breakindent set and shift by 1, Number set sbr=? and briopt:sbr call s:test_windows('setl briopt=shift:1,sbr,min:0 nu sbr=? nuw=4') let lines = s:screen_lines(line('.'),10) let expect = [ \ " 2 ab", \ " ? m", \ " ? x", \ ] call s:compare_lines(expect, lines) " clean up call s:close_windows('set sbr=') endfunc func Test_breakindent07a_vartabs() CheckFeature vartabs " breakindent set and shift by 1, Number set sbr=? and briopt:sbr call s:test_windows('setl briopt=shift:1,sbr,min:0 nu sbr=? nuw=4 vts=4') let lines = s:screen_lines(line('.'),10) let expect = [ \ " 2 ab", \ " ? m", \ " ? x", \ ] call s:compare_lines(expect, lines) " clean up call s:close_windows('set sbr= vts&') endfunc func Test_breakindent08() " breakindent set and shift by 1, Number and list set sbr=# and briopt:sbr call s:test_windows('setl briopt=shift:1,sbr,min:0 nu nuw=4 sbr=# list cpo+=n ts=4') " make sure, cache is invalidated! set ts=8 redraw! set ts=4 redraw! let lines = s:screen_lines(line('.'),10) let expect = [ \ " 2 ^Iabcd", \ "# opq", \ "# BCD", \ ] call s:compare_lines(expect, lines) call s:close_windows('set sbr= cpo-=n') endfunc func Test_breakindent08_vartabs() CheckFeature vartabs " breakindent set and shift by 1, Number and list set sbr=# and briopt:sbr call s:test_windows('setl briopt=shift:1,sbr,min:0 nu nuw=4 sbr=# list cpo+=n ts=4 vts=4') " make sure, cache is invalidated! set ts=8 redraw! set ts=4 redraw! let lines = s:screen_lines(line('.'),10) let expect = [ \ " 2 ^Iabcd", \ "# opq", \ "# BCD", \ ] call s:compare_lines(expect, lines) call s:close_windows('set sbr= cpo-=n vts&') endfunc func Test_breakindent08a() " breakindent set and shift by 1, Number and list set sbr=# and briopt:sbr call s:test_windows('setl briopt=shift:1,sbr,min:0 nu nuw=4 sbr=# list') let lines = s:screen_lines(line('.'),10) let expect = [ \ " 2 ^Iabcd", \ " # opq", \ " # BCD", \ ] call s:compare_lines(expect, lines) call s:close_windows('set sbr=') endfunc func Test_breakindent08a_vartabs() CheckFeature vartabs " breakindent set and shift by 1, Number and list set sbr=# and briopt:sbr call s:test_windows('setl briopt=shift:1,sbr,min:0 nu nuw=4 sbr=# list vts=4') let lines = s:screen_lines(line('.'),10) let expect = [ \ " 2 ^Iabcd", \ " # opq", \ " # BCD", \ ] call s:compare_lines(expect, lines) call s:close_windows('set sbr= vts&') endfunc func Test_breakindent09() " breakindent set and shift by 1, Number and list set sbr=# call s:test_windows('setl briopt=shift:1,min:0 nu nuw=4 sbr=# list') let lines = s:screen_lines(line('.'),10) let expect = [ \ " 2 ^Iabcd", \ " #op", \ " #AB", \ ] call s:compare_lines(expect, lines) call s:close_windows('set sbr=') endfunc func Test_breakindent09_vartabs() CheckFeature vartabs " breakindent set and shift by 1, Number and list set sbr=# call s:test_windows('setl briopt=shift:1,min:0 nu nuw=4 sbr=# list vts=4') let lines = s:screen_lines(line('.'),10) let expect = [ \ " 2 ^Iabcd", \ " #op", \ " #AB", \ ] call s:compare_lines(expect, lines) call s:close_windows('set sbr= vts&') endfunc func Test_breakindent10() " breakindent set, Number set sbr=~ call s:test_windows('setl cpo+=n sbr=~ nu nuw=4 nolist briopt=sbr,min:0') " make sure, cache is invalidated! set ts=8 redraw! set ts=4 redraw! let lines = s:screen_lines(line('.'),10) let expect = [ \ " 2 ab", \ "~ mn", \ "~ yz", \ ] call s:compare_lines(expect, lines) call s:close_windows('set sbr= cpo-=n') endfunc func Test_breakindent10_vartabs() CheckFeature vartabs " breakindent set, Number set sbr=~ call s:test_windows('setl cpo+=n sbr=~ nu nuw=4 nolist briopt=sbr,min:0 vts=4') " make sure, cache is invalidated! set ts=8 redraw! set ts=4 redraw! let lines = s:screen_lines(line('.'),10) let expect = [ \ " 2 ab", \ "~ mn", \ "~ yz", \ ] call s:compare_lines(expect, lines) call s:close_windows('set sbr= cpo-=n vts&') endfunc func Test_breakindent11() " test strdisplaywidth() call s:test_windows('setl cpo-=n sbr=>> nu nuw=4 nolist briopt= ts=4') let text = getline(2) let width = strlen(text[1:]) + indent(2) + strlen(&sbr) * 3 " text wraps 3 times call assert_equal(width, strdisplaywidth(text)) call s:close_windows('set sbr=') call assert_equal(4, strdisplaywidth("\t", 4)) endfunc func Test_breakindent11_vartabs() CheckFeature vartabs " test strdisplaywidth() call s:test_windows('setl cpo-=n sbr=>> nu nuw=4 nolist briopt= ts=4 vts=4') let text = getline(2) let width = strlen(text[1:]) + 2->indent() + strlen(&sbr) * 3 " text wraps 3 times call assert_equal(width, text->strdisplaywidth()) call s:close_windows('set sbr= vts&') endfunc func Test_breakindent12() " test breakindent with long indent let s:input = "\t\t\t\t\t{" call s:test_windows('setl breakindent linebreak briopt=min:10 nu numberwidth=3 ts=4 list listchars=tab:>-') let lines = s:screen_lines(2,16) let expect = [ \ " 2 >--->--->--->", \ " ---{ ", \ "~ ", \ ] call s:compare_lines(expect, lines) call s:close_windows('set nuw=4 listchars=') endfunc func Test_breakindent12_vartabs() CheckFeature vartabs " test breakindent with long indent let s:input = "\t\t\t\t\t{" call s:test_windows('setl breakindent linebreak briopt=min:10 nu numberwidth=3 ts=4 list listchars=tab:>- vts=4') let lines = s:screen_lines(2,16) let expect = [ \ " 2 >--->--->--->", \ " ---{ ", \ "~ ", \ ] call s:compare_lines(expect, lines) call s:close_windows('set nuw=4 listchars= vts&') endfunc func Test_breakindent13() let s:input = "" call s:test_windows('setl breakindent briopt=min:10 ts=8') vert resize 20 call setline(1, [" a\tb\tc\td\te", " z y x w v"]) 1 norm! fbgj"ayl 2 norm! fygj"byl call assert_equal('d', @a) call assert_equal('w', @b) call s:close_windows() endfunc func Test_breakindent13_vartabs() CheckFeature vartabs let s:input = "" call s:test_windows('setl breakindent briopt=min:10 ts=8 vts=8') vert resize 20 call setline(1, [" a\tb\tc\td\te", " z y x w v"]) 1 norm! fbgj"ayl 2 norm! fygj"byl call assert_equal('d', @a) call assert_equal('w', @b) call s:close_windows('set vts&') endfunc func Test_breakindent14() let s:input = "" call s:test_windows('setl breakindent briopt= ts=8') vert resize 30 norm! 3a1234567890 norm! a abcde exec "norm! 0\<C-V>tex" let lines = s:screen_lines(line('.'),8) let expect = [ \ "e ", \ "~ ", \ "~ ", \ ] call s:compare_lines(expect, lines) call s:close_windows() endfunc func Test_breakindent14_vartabs() CheckFeature vartabs let s:input = "" call s:test_windows('setl breakindent briopt= ts=8 vts=8') vert resize 30 norm! 3a1234567890 norm! a abcde exec "norm! 0\<C-V>tex" let lines = s:screen_lines(line('.'),8) let expect = [ \ "e ", \ "~ ", \ "~ ", \ ] call s:compare_lines(expect, lines) call s:close_windows('set vts&') endfunc func Test_breakindent15() let s:input = "" call s:test_windows('setl breakindent briopt= ts=8 sw=8') vert resize 30 norm! 4a1234567890 exe "normal! >>\<C-V>3f0x" let lines = s:screen_lines(line('.'),20) let expect = [ \ " 1234567890 ", \ "~ ", \ "~ ", \ ] call s:compare_lines(expect, lines) call s:close_windows() endfunc func Test_breakindent15_vartabs() CheckFeature vartabs let s:input = "" call s:test_windows('setl breakindent briopt= ts=8 sw=8 vts=8') vert resize 30 norm! 4a1234567890 exe "normal! >>\<C-V>3f0x" let lines = s:screen_lines(line('.'),20) let expect = [ \ " 1234567890 ", \ "~ ", \ "~ ", \ ] call s:compare_lines(expect, lines) call s:close_windows('set vts&') endfunc func Test_breakindent16() " Check that overlong lines are indented correctly. let s:input = "" call s:test_windows('setl breakindent briopt=min:0 ts=4') call setline(1, "\t".repeat("1234567890", 10)) resize 6 norm! 1gg$ redraw! let lines = s:screen_lines(1,10) let expect = [ \ "<<< 789012", \ " 345678", \ " 901234", \ ] call s:compare_lines(expect, lines) let lines = s:screen_lines(4,10) let expect = [ \ " 567890", \ " 123456", \ " 7890 ", \ ] call s:compare_lines(expect, lines) call s:close_windows() endfunc func Test_breakindent16_vartabs() CheckFeature vartabs " Check that overlong lines are indented correctly. let s:input = "" call s:test_windows('setl breakindent briopt=min:0 ts=4 vts=4') call setline(1, "\t".repeat("1234567890", 10)) resize 6 norm! 1gg$ redraw! let lines = s:screen_lines(1,10) let expect = [ \ "<<< 789012", \ " 345678", \ " 901234", \ ] call s:compare_lines(expect, lines) let lines = s:screen_lines(4,10) let expect = [ \ " 567890", \ " 123456", \ " 7890 ", \ ] call s:compare_lines(expect, lines) call s:close_windows('set vts&') endfunc func Test_breakindent17_vartabs() CheckFeature vartabs let s:input = "" call s:test_windows('setl breakindent list listchars=tab:<-> showbreak=+++') call setline(1, "\t" . repeat('a', 63)) vert resize 30 norm! 1gg$ redraw! let lines = s:screen_lines(1, 30) let expect = [ \ "<-->aaaaaaaaaaaaaaaaaaaaaaaaaa", \ " +++aaaaaaaaaaaaaaaaaaaaaaa", \ " +++aaaaaaaaaaaaaa ", \ ] call s:compare_lines(expect, lines) call s:close_windows('set breakindent& list& listchars& showbreak&') endfunc func Test_breakindent18_vartabs() CheckFeature vartabs let s:input = "" call s:test_windows('setl breakindent list listchars=tab:<->') call setline(1, "\t" . repeat('a', 63)) vert resize 30 norm! 1gg$ redraw! let lines = s:screen_lines(1, 30) let expect = [ \ "<-->aaaaaaaaaaaaaaaaaaaaaaaaaa", \ " aaaaaaaaaaaaaaaaaaaaaaaaaa", \ " aaaaaaaaaaa ", \ ] call s:compare_lines(expect, lines) call s:close_windows('set breakindent& list& listchars&') endfunc func Test_breakindent19_sbr_nextpage() let s:input = "" call s:test_windows('setl breakindent briopt=shift:2,sbr,min:18 sbr=>') call setline(1, repeat('a', 200)) norm! 1gg redraw! let lines = s:screen_lines(1, 20) let expect = [ \ "aaaaaaaaaaaaaaaaaaaa", \ "> aaaaaaaaaaaaaaaaaa", \ "> aaaaaaaaaaaaaaaaaa", \ ] call s:compare_lines(expect, lines) " Scroll down one screen line setl scrolloff=5 norm! 5gj let lines = s:screen_lines(1, 20) let expect = [ \ "aaaaaaaaaaaaaaaaaaaa", \ "> aaaaaaaaaaaaaaaaaa", \ "> aaaaaaaaaaaaaaaaaa", \ ] call s:compare_lines(expect, lines) redraw! " moving the cursor doesn't change the text offset norm! l redraw! let lines = s:screen_lines(1, 20) call s:compare_lines(expect, lines) setl breakindent briopt=min:18 sbr=> norm! 5gj let lines = s:screen_lines(1, 20) let expect = [ \ ">aaaaaaaaaaaaaaaaaaa", \ ">aaaaaaaaaaaaaaaaaaa", \ ">aaaaaaaaaaaaaaaaaaa", \ ] call s:compare_lines(expect, lines) call s:close_windows('set breakindent& briopt& sbr&') endfunc func Test_breakindent20_cpo_n_nextpage() let s:input = "" call s:test_windows('setl breakindent briopt=min:14 cpo+=n number') call setline(1, repeat('abcdefghijklmnopqrst', 10)) norm! 1gg redraw! let lines = s:screen_lines(1, 20) let expect = [ \ " 1 abcdefghijklmnop", \ " qrstabcdefghijkl", \ " mnopqrstabcdefgh", \ ] call s:compare_lines(expect, lines) " Scroll down one screen line setl scrolloff=5 norm! 6gj redraw! let lines = s:screen_lines(1, 20) let expect = [ \ "<<< qrstabcdefghijkl", \ " mnopqrstabcdefgh", \ " ijklmnopqrstabcd", \ ] call s:compare_lines(expect, lines) setl briopt+=shift:2 norm! 1gg let lines = s:screen_lines(1, 20) let expect = [ \ " 1 abcdefghijklmnop", \ " qrstabcdefghij", \ " klmnopqrstabcd", \ ] call s:compare_lines(expect, lines) " Scroll down one screen line norm! 6gj let lines = s:screen_lines(1, 20) let expect = [ \ "<<< qrstabcdefghij", \ " klmnopqrstabcd", \ " efghijklmnopqr", \ ] call s:compare_lines(expect, lines) call s:close_windows('set breakindent& briopt& cpo& number&') endfunc func Test_breakindent20_list() call s:test_windows('setl breakindent breakindentopt= linebreak') " default: call setline(1, [' 1. Congress shall make no law', \ ' 2.) Congress shall make no law', \ ' 3.] Congress shall make no law']) norm! 1gg redraw! let lines = s:screen_lines2(1, 6, 20) let expect = [ \ " 1. Congress ", \ "shall make no law ", \ " 2.) Congress ", \ "shall make no law ", \ " 3.] Congress ", \ "shall make no law ", \ ] call s:compare_lines(expect, lines) " set minimum indent setl briopt=min:5 redraw! let lines = s:screen_lines2(1, 6, 20) let expect = [ \ " 1. Congress ", \ " shall make no law ", \ " 2.) Congress ", \ " shall make no law ", \ " 3.] Congress ", \ " shall make no law ", \ ] call s:compare_lines(expect, lines) " set additional handing indent setl briopt+=list:4 redraw! let expect = [ \ " 1. Congress ", \ " shall make no ", \ " law ", \ " 2.) Congress ", \ " shall make no ", \ " law ", \ " 3.] Congress ", \ " shall make no ", \ " law ", \ ] let lines = s:screen_lines2(1, 9, 20) call s:compare_lines(expect, lines) " reset linebreak option " Note: it indents by one additional " space, because of the leading space. setl linebreak&vim list listchars=eol:$,space:_ redraw! let expect = [ \ "__1.__Congress_shall", \ " _make_no_law$ ", \ "__2.)_Congress_shall", \ " _make_no_law$ ", \ "__3.]_Congress_shall", \ " _make_no_law$ ", \ ] let lines = s:screen_lines2(1, 6, 20) call s:compare_lines(expect, lines) " check formatlistpat indent setl briopt=min:5,list:-1 setl linebreak list&vim listchars&vim let &l:flp = '^\s*\d\+\.\?[\]:)}\t ]\s*' redraw! let expect = [ \ " 1. Congress ", \ " shall make no ", \ " law ", \ " 2.) Congress ", \ " shall make no ", \ " law ", \ " 3.] Congress ", \ " shall make no ", \ " law ", \ ] let lines = s:screen_lines2(1, 9, 20) call s:compare_lines(expect, lines) " check formatlistpat indent with different list levels let &l:flp = '^\s*\*\+\s\+' %delete _ call setline(1, ['* Congress shall make no law', \ '*** Congress shall make no law', \ '**** Congress shall make no law']) norm! 1gg redraw! let expect = [ \ "* Congress shall ", \ " make no law ", \ "*** Congress shall ", \ " make no law ", \ "**** Congress shall ", \ " make no law ", \ ] let lines = s:screen_lines2(1, 6, 20) call s:compare_lines(expect, lines) " check formatlistpat indent with different list level " showbreak and sbr setl briopt=min:5,sbr,list:-1 setl showbreak=> redraw! let expect = [ \ "* Congress shall ", \ "> make no law ", \ "*** Congress shall ", \ "> make no law ", \ "**** Congress shall ", \ "> make no law ", \ ] let lines = s:screen_lines2(1, 6, 20) call s:compare_lines(expect, lines) " check formatlistpat indent with different list level " showbreak sbr and shift setl briopt=min:5,sbr,list:-1,shift:2 setl showbreak=> redraw! let expect = [ \ "* Congress shall ", \ "> make no law ", \ "*** Congress shall ", \ "> make no law ", \ "**** Congress shall ", \ "> make no law ", \ ] let lines = s:screen_lines2(1, 6, 20) call s:compare_lines(expect, lines) " check breakindent works if breakindentopt=list:-1 " for a non list content %delete _ call setline(1, [' Congress shall make no law', \ ' Congress shall make no law', \ ' Congress shall make no law']) norm! 1gg setl briopt=min:5,list:-1 setl showbreak= redraw! let expect = [ \ " Congress shall ", \ " make no law ", \ " Congress shall ", \ " make no law ", \ " Congress shall ", \ " make no law ", \ ] let lines = s:screen_lines2(1, 6, 20) call s:compare_lines(expect, lines) call s:close_windows('set breakindent& briopt& linebreak& list& listchars& showbreak&') endfunc " The following used to crash Vim. This is fixed by 8.2.3391. " This is a regression introduced by 8.2.2903. func Test_window_resize_with_linebreak() new 53vnew setl linebreak setl showbreak=>> setl breakindent setl breakindentopt=shift:4 call setline(1, "\naaaaaaaaa\n\na\naaaaa\n¯aaaaaaaaaa\naaaaaaaaaaaa\naaa\n\"a:aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - aaaaaaaa\"\naaaaaaaa\n\"a") redraw! call assert_equal([" >>aa^@\"a: "], ScreenLines(2, 14)) vertical resize 52 redraw! call assert_equal([" >>aaa^@\"a:"], ScreenLines(2, 14)) set linebreak& showbreak& breakindent& breakindentopt& %bw! endfunc func Test_cursor_position_with_showbreak() CheckScreendump let lines =<< trim END vim9script &signcolumn = 'yes' &showbreak = '+ ' var leftcol: number = win_getid()->getwininfo()->get(0, {})->get('textoff') repeat('x', &columns - leftcol - 1)->setline(1) 'second line'->setline(2) END call writefile(lines, 'XscriptShowbreak', 'D') let buf = RunVimInTerminal('-S XscriptShowbreak', #{rows: 6}) call term_sendkeys(buf, "AX") call VerifyScreenDump(buf, 'Test_cursor_position_with_showbreak', {}) call StopVimInTerminal(buf) endfunc func Test_no_spurious_match() let s:input = printf('- y %s y %s', repeat('x', 50), repeat('x', 50)) call s:test_windows('setl breakindent breakindentopt=list:-1 formatlistpat=^- hls') let @/ = '\%>3v[y]' redraw! call searchcount().total->assert_equal(1) " cleanup set hls&vim bwipeout! endfunc func Test_no_extra_indent() call s:test_windows('setl breakindent breakindentopt=list:-1,min:10') %d let &l:formatlistpat='^\s*\d\+\.\s\+' let text = 'word ' let len = text->strcharlen() let line1 = text->repeat((winwidth(0) / len) * 2) let line2 = repeat(' ', 2) .. '1. ' .. line1 call setline(1, [line2]) redraw! " 1) matches formatlist pattern, so indent let expect = [ \ " 1. word word word ", \ " word word word ", \ " word word ", \ "~ ", \ ] let lines = s:screen_lines2(1, 4, 20) call s:compare_lines(expect, lines) " 2) change formatlist pattern " -> indent adjusted let &l:formatlistpat='^\s*\d\+\.' let expect = [ \ " 1. word word word ", \ " word word word ", \ " word word ", \ "~ ", \ ] let lines = s:screen_lines2(1, 4, 20) " 3) no local formatlist pattern, " so use global one -> indent let g_flp = &g:flp let &g:formatlistpat='^\s*\d\+\.\s\+' let &l:formatlistpat='' let expect = [ \ " 1. word word word ", \ " word word word ", \ " word word ", \ "~ ", \ ] let lines = s:screen_lines2(1, 4, 20) call s:compare_lines(expect, lines) let &g:flp = g_flp let &l:formatlistpat='^\s*\d\+\.' " 4) add something in front, no additional indent norm! gg0 exe ":norm! 5iword \<esc>" redraw! let expect = [ \ "word word word word ", \ "word 1. word word ", \ "word word word word ", \ "word word ", \ "~ ", \ ] let lines = s:screen_lines2(1, 5, 20) call s:compare_lines(expect, lines) bwipeout! endfunc func Test_breakindent_column() call s:test_windows('setl breakindent breakindentopt=column:10') redraw! " 1) default: does not indent, too wide :( let expect = [ \ " ", \ " abcdefghijklmnop", \ "qrstuvwxyzABCDEFGHIJ", \ "KLMNOP " \ ] let lines = s:screen_lines2(1, 4, 20) call s:compare_lines(expect, lines) " 2) lower min value, so that breakindent works setl breakindentopt+=min:5 redraw! let expect = [ \ " ", \ " abcdefghijklmnop", \ " qrstuvwxyz", \ " ABCDEFGHIJ", \ " KLMNOP " \ ] let lines = s:screen_lines2(1, 5, 20) " 3) set shift option -> no influence setl breakindentopt+=shift:5 redraw! let expect = [ \ " ", \ " abcdefghijklmnop", \ " qrstuvwxyz", \ " ABCDEFGHIJ", \ " KLMNOP " \ ] let lines = s:screen_lines2(1, 5, 20) call s:compare_lines(expect, lines) " 4) add showbreak value setl showbreak=++ redraw! let expect = [ \ " ", \ " abcdefghijklmnop", \ " ++qrstuvwx", \ " ++yzABCDEF", \ " ++GHIJKLMN", \ " ++OP " \ ] let lines = s:screen_lines2(1, 6, 20) call s:compare_lines(expect, lines) bwipeout! endfunc func Test_linebreak_list() " This was setting wlv.c_extra to NUL while wlv.p_extra is NULL filetype plugin on syntax enable edit! $VIMRUNTIME/doc/index.txt /v_P setlocal list setlocal listchars=tab:>- setlocal linebreak setlocal nowrap setlocal filetype=help redraw! bwipe! endfunc " vim: shiftwidth=2 sts=2 expandtab