Mercurial > vim
view src/testdir/test_display.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 | 695b50472e85 |
children | 0561bf3ba10c |
line wrap: on
line source
" Test for displaying stuff if !has('gui_running') && has('unix') set term=ansi endif source view_util.vim source check.vim source screendump.vim func Test_display_foldcolumn() CheckFeature folding new vnew vert resize 25 call assert_equal(25, winwidth(winnr())) set isprint=@ 1put='e more noise blah blah more stuff here' let expect = [ \ "e more noise blah blah<82", \ "> more stuff here " \ ] call cursor(2, 1) norm! zt let lines = ScreenLines([1,2], winwidth(0)) call assert_equal(expect, lines) set fdc=2 let lines = ScreenLines([1,2], winwidth(0)) let expect = [ \ " e more noise blah blah<", \ " 82> more stuff here " \ ] call assert_equal(expect, lines) quit! quit! endfunc func Test_display_foldtext_mbyte() CheckFeature folding call NewWindow(10, 40) call append(0, range(1,20)) exe "set foldmethod=manual foldtext=foldtext() fillchars=fold:\u2500,vert:\u2502 fdc=2" call cursor(2, 1) norm! zf13G let lines=ScreenLines([1,3], winwidth(0)+1) let expect=[ \ " 1 \u2502", \ "+ +-- 12 lines: 2". repeat("\u2500", 23). "\u2502", \ " 14 \u2502", \ ] call assert_equal(expect, lines) set fillchars=fold:-,vert:\| let lines=ScreenLines([1,3], winwidth(0)+1) let expect=[ \ " 1 |", \ "+ +-- 12 lines: 2". repeat("-", 23). "|", \ " 14 |", \ ] call assert_equal(expect, lines) set foldtext& fillchars& foldmethod& fdc& bw! endfunc " check that win_ins_lines() and win_del_lines() work when t_cs is empty. func Test_scroll_without_region() CheckScreendump let lines =<< trim END call setline(1, range(1, 20)) set t_cs= set laststatus=2 END call writefile(lines, 'Xtestscroll', 'D') let buf = RunVimInTerminal('-S Xtestscroll', #{rows: 10}) call VerifyScreenDump(buf, 'Test_scroll_no_region_1', {}) call term_sendkeys(buf, ":3delete\<cr>") call VerifyScreenDump(buf, 'Test_scroll_no_region_2', {}) call term_sendkeys(buf, ":4put\<cr>") call VerifyScreenDump(buf, 'Test_scroll_no_region_3', {}) call term_sendkeys(buf, ":undo\<cr>") call term_sendkeys(buf, ":undo\<cr>") call term_sendkeys(buf, ":set laststatus=0\<cr>") call VerifyScreenDump(buf, 'Test_scroll_no_region_4', {}) call term_sendkeys(buf, ":3delete\<cr>") call VerifyScreenDump(buf, 'Test_scroll_no_region_5', {}) call term_sendkeys(buf, ":4put\<cr>") call VerifyScreenDump(buf, 'Test_scroll_no_region_6', {}) " clean up call StopVimInTerminal(buf) endfunc func Test_display_listchars_precedes() call NewWindow(10, 10) " Need a physical line that wraps over the complete " window size call append(0, repeat('aaa aaa aa ', 10)) call append(1, repeat(['bbb bbb bbb bbb'], 2)) " remove blank trailing line $d set list nowrap call cursor(1, 1) " move to end of line and scroll 2 characters back norm! $2zh let lines=ScreenLines([1,4], winwidth(0)+1) let expect = [ \ " aaa aa $ |", \ "$ |", \ "$ |", \ "~ |", \ ] call assert_equal(expect, lines) set list listchars+=precedes:< nowrap call cursor(1, 1) " move to end of line and scroll 2 characters back norm! $2zh let lines = ScreenLines([1,4], winwidth(0)+1) let expect = [ \ "<aaa aa $ |", \ "< |", \ "< |", \ "~ |", \ ] call assert_equal(expect, lines) set wrap call cursor(1, 1) " the complete line should be displayed in the window norm! $ let lines = ScreenLines([1,10], winwidth(0)+1) let expect = [ \ "<aaa aaa a|", \ "a aaa aaa |", \ "aa aaa aaa|", \ " aa aaa aa|", \ "a aa aaa a|", \ "aa aa aaa |", \ "aaa aa aaa|", \ " aaa aa aa|", \ "a aaa aa a|", \ "aa aaa aa |", \ ] call assert_equal(expect, lines) set list& listchars& wrap& bw! endfunc " Check that win_lines() works correctly with the number_only parameter=TRUE " should break early to optimize cost of drawing, but needs to make sure " that the number column is correctly highlighted. func Test_scroll_CursorLineNr_update() CheckScreendump let lines =<< trim END hi CursorLineNr ctermfg=73 ctermbg=236 set nu rnu cursorline cursorlineopt=number exe ":norm! o\<esc>110ia\<esc>" END let filename = 'Xdrawscreen' call writefile(lines, filename, 'D') let buf = RunVimInTerminal('-S '.filename, #{rows: 5, cols: 50}) call term_sendkeys(buf, "k") call VerifyScreenDump(buf, 'Test_winline_rnu', {}) " clean up call StopVimInTerminal(buf) endfunc " check a long file name does not result in the hit-enter prompt func Test_edit_long_file_name() CheckScreendump let longName = 'x'->repeat(min([&columns, 255])) call writefile([], longName, 'D') let buf = RunVimInTerminal('-N -u NONE ' .. longName, #{rows: 8}) call VerifyScreenDump(buf, 'Test_long_file_name_1', {}) " clean up call StopVimInTerminal(buf) endfunc func Test_unprintable_fileformats() CheckScreendump call writefile(["unix\r", "two"], 'Xunix.txt', 'D') call writefile(["mac\r", "two"], 'Xmac.txt', 'D') let lines =<< trim END edit Xunix.txt split Xmac.txt edit ++ff=mac END let filename = 'Xunprintable' call writefile(lines, filename, 'D') let buf = RunVimInTerminal('-S '.filename, #{rows: 9, cols: 50}) call VerifyScreenDump(buf, 'Test_display_unprintable_01', {}) call term_sendkeys(buf, "\<C-W>\<C-W>\<C-L>") call VerifyScreenDump(buf, 'Test_display_unprintable_02', {}) " clean up call StopVimInTerminal(buf) endfunc " Test for scrolling that modifies buffer during visual block func Test_visual_block_scroll() CheckScreendump let lines =<< trim END source $VIMRUNTIME/plugin/matchparen.vim set scrolloff=1 call setline(1, ['a', 'b', 'c', 'd', 'e', '', '{', '}', '{', 'f', 'g', '}']) call cursor(5, 1) END let filename = 'Xvisualblockmodifiedscroll' call writefile(lines, filename, 'D') let buf = RunVimInTerminal('-S '.filename, #{rows: 7}) call term_sendkeys(buf, "V\<C-D>\<C-D>") call VerifyScreenDump(buf, 'Test_display_visual_block_scroll', {}) call StopVimInTerminal(buf) endfunc " Test for clearing paren highlight when switching buffers func Test_matchparen_clear_highlight() CheckScreendump let lines =<< trim END source $VIMRUNTIME/plugin/matchparen.vim set hidden call setline(1, ['()']) normal 0 func OtherBuffer() enew exe "normal iaa\<Esc>0" endfunc END call writefile(lines, 'XMatchparenClear', 'D') let buf = RunVimInTerminal('-S XMatchparenClear', #{rows: 5}) call VerifyScreenDump(buf, 'Test_matchparen_clear_highlight_1', {}) call term_sendkeys(buf, ":call OtherBuffer()\<CR>:\<Esc>") call VerifyScreenDump(buf, 'Test_matchparen_clear_highlight_2', {}) call term_sendkeys(buf, "\<C-^>:\<Esc>") call VerifyScreenDump(buf, 'Test_matchparen_clear_highlight_1', {}) call term_sendkeys(buf, "\<C-^>:\<Esc>") call VerifyScreenDump(buf, 'Test_matchparen_clear_highlight_2', {}) call StopVimInTerminal(buf) endfunc func Test_display_scroll_at_topline() CheckScreendump let buf = RunVimInTerminal('', #{cols: 20}) call term_sendkeys(buf, ":call setline(1, repeat('a', 21))\<CR>") call TermWait(buf) call term_sendkeys(buf, "O\<Esc>") call VerifyScreenDump(buf, 'Test_display_scroll_at_topline', #{rows: 4}) call StopVimInTerminal(buf) endfunc func Test_display_scroll_update_visual() CheckScreendump let lines =<< trim END set scrolloff=0 call setline(1, repeat(['foo'], 10)) call sign_define('foo', { 'text': '>' }) call sign_place(1, 'bar', 'foo', bufnr(), { 'lnum': 2 }) call sign_place(2, 'bar', 'foo', bufnr(), { 'lnum': 1 }) autocmd CursorMoved * if getcurpos()[1] == 2 | call sign_unplace('bar', { 'id': 1 }) | endif END call writefile(lines, 'XupdateVisual.vim', 'D') let buf = RunVimInTerminal('-S XupdateVisual.vim', #{rows: 8, cols: 60}) call term_sendkeys(buf, "VG7kk") call VerifyScreenDump(buf, 'Test_display_scroll_update_visual', {}) call StopVimInTerminal(buf) endfunc " Test for 'eob' (EndOfBuffer) item in 'fillchars' func Test_eob_fillchars() " default value call assert_match('eob:\~', &fillchars) " invalid values call assert_fails(':set fillchars=eob:', 'E474:') call assert_fails(':set fillchars=eob:xy', 'E474:') call assert_fails(':set fillchars=eob:\255', 'E474:') call assert_fails(':set fillchars=eob:<ff>', 'E474:') call assert_fails(":set fillchars=eob:\x01", 'E474:') call assert_fails(':set fillchars=eob:\\x01', 'E474:') " default is ~ new redraw call assert_equal('~', Screenline(2)) set fillchars=eob:+ redraw call assert_equal('+', Screenline(2)) set fillchars=eob:\ redraw call assert_equal(' ', nr2char(screenchar(2, 1))) set fillchars& close endfunc " Test for 'foldopen', 'foldclose' and 'foldsep' in 'fillchars' func Test_fold_fillchars() new set fdc=2 foldenable foldmethod=manual call setline(1, ['one', 'two', 'three', 'four', 'five']) 2,4fold " First check for the default setting for a closed fold let lines = ScreenLines([1, 3], 8) let expected = [ \ ' one ', \ '+ +-- 3', \ ' five ' \ ] call assert_equal(expected, lines) normal 2Gzo " check the characters for an open fold let lines = ScreenLines([1, 5], 8) let expected = [ \ ' one ', \ '- two ', \ '| three ', \ '| four ', \ ' five ' \ ] call assert_equal(expected, lines) " change the setting set fillchars=vert:\|,fold:-,eob:~,foldopen:[,foldclose:],foldsep:- " check the characters for an open fold let lines = ScreenLines([1, 5], 8) let expected = [ \ ' one ', \ '[ two ', \ '- three ', \ '- four ', \ ' five ' \ ] call assert_equal(expected, lines) " check the characters for a closed fold normal 2Gzc let lines = ScreenLines([1, 3], 8) let expected = [ \ ' one ', \ '] +-- 3', \ ' five ' \ ] call assert_equal(expected, lines) %bw! set fillchars& fdc& foldmethod& foldenable& endfunc func Test_local_fillchars() CheckScreendump let lines =<< trim END call setline(1, ['window 1']->repeat(3)) setlocal fillchars=stl:1,stlnc:a,vert:=,eob:x vnew call setline(1, ['window 2']->repeat(3)) setlocal fillchars=stl:2,stlnc:b,vert:+,eob:y new wincmd J call setline(1, ['window 3']->repeat(3)) setlocal fillchars=stl:3,stlnc:c,vert:<,eob:z vnew call setline(1, ['window 4']->repeat(3)) setlocal fillchars=stl:4,stlnc:d,vert:>,eob:o END call writefile(lines, 'Xdisplayfillchars', 'D') let buf = RunVimInTerminal('-S Xdisplayfillchars', #{rows: 12}) call VerifyScreenDump(buf, 'Test_display_fillchars_1', {}) call term_sendkeys(buf, ":wincmd k\r") call VerifyScreenDump(buf, 'Test_display_fillchars_2', {}) call StopVimInTerminal(buf) endfunc func Test_display_linebreak_breakat() new vert resize 25 let _breakat = &breakat setl signcolumn=yes linebreak breakat=) showbreak=+\ call setline(1, repeat('x', winwidth(0) - 2) .. ')abc') let lines = ScreenLines([1, 2], 25) let expected = [ \ ' xxxxxxxxxxxxxxxxxxxxxxx', \ ' + )abc ' \ ] call assert_equal(expected, lines) %bw! let &breakat=_breakat endfunc func Run_Test_display_lastline(euro) let lines =<< trim END call setline(1, ['aaa', 'b'->repeat(200)]) set display=truncate vsplit 100wincmd < END if a:euro != '' let lines[2] = 'set fillchars=vert:\|,lastline:€' endif call writefile(lines, 'XdispLastline', 'D') let buf = RunVimInTerminal('-S XdispLastline', #{rows: 10}) call VerifyScreenDump(buf, $'Test_display_lastline_{a:euro}1', {}) call term_sendkeys(buf, ":set display=lastline\<CR>") call VerifyScreenDump(buf, $'Test_display_lastline_{a:euro}2', {}) call term_sendkeys(buf, ":100wincmd >\<CR>") call VerifyScreenDump(buf, $'Test_display_lastline_{a:euro}3', {}) call term_sendkeys(buf, ":set display=truncate\<CR>") call VerifyScreenDump(buf, $'Test_display_lastline_{a:euro}4', {}) call term_sendkeys(buf, ":close\<CR>") call term_sendkeys(buf, ":3split\<CR>") call VerifyScreenDump(buf, $'Test_display_lastline_{a:euro}5', {}) call term_sendkeys(buf, ":close\<CR>") call term_sendkeys(buf, ":2vsplit\<CR>") call VerifyScreenDump(buf, $'Test_display_lastline_{a:euro}6', {}) call StopVimInTerminal(buf) endfunc func Test_display_lastline() CheckScreendump call Run_Test_display_lastline('') call Run_Test_display_lastline('euro_') call assert_fails(':set fillchars=lastline:', 'E474:') call assert_fails(':set fillchars=lastline:〇', 'E474:') endfunc func Test_display_long_lastline() CheckScreendump let lines =<< trim END set display=lastline smoothscroll scrolloff=0 call setline(1, [ \'aaaaa'->repeat(150), \'bbbbb '->repeat(7) .. 'ccccc '->repeat(7) .. 'ddddd '->repeat(7) \]) END call writefile(lines, 'XdispLongline', 'D') let buf = RunVimInTerminal('-S XdispLongline', #{rows: 14, cols: 35}) call term_sendkeys(buf, "736|") call VerifyScreenDump(buf, 'Test_display_long_line_1', {}) " The correct part of the last line is moved into view. call term_sendkeys(buf, "D") call VerifyScreenDump(buf, 'Test_display_long_line_2', {}) " "w_skipcol" does not change because the topline is still long enough " to maintain the current skipcol. call term_sendkeys(buf, "g04l11gkD") call VerifyScreenDump(buf, 'Test_display_long_line_3', {}) " "w_skipcol" is reset to bring the entire topline into view because " the line length is now smaller than the current skipcol + marker. call term_sendkeys(buf, "x") call VerifyScreenDump(buf, 'Test_display_long_line_4', {}) call StopVimInTerminal(buf) endfunc " Moving the cursor to a line that doesn't fit in the window should show " correctly. func Test_display_cursor_long_line() CheckScreendump let lines =<< trim END call setline(1, ['a', 'b ' .. 'bbbbb'->repeat(150), 'c']) norm $j END call writefile(lines, 'XdispCursorLongline', 'D') let buf = RunVimInTerminal('-S XdispCursorLongline', #{rows: 8}) call VerifyScreenDump(buf, 'Test_display_cursor_long_line_1', {}) " FIXME: moving the cursor above the topline does not set w_skipcol " correctly with cpo+=n and zero scrolloff (curs_columns() extra == 1). call term_sendkeys(buf, ":set number cpo+=n scrolloff=0\<CR>") call term_sendkeys(buf, '$0') call VerifyScreenDump(buf, 'Test_display_cursor_long_line_2', {}) " Going to the start of the line with "b" did not set w_skipcol correctly " with 'smoothscroll'. call term_sendkeys(buf, ":set smoothscroll\<CR>") call term_sendkeys(buf, '$b') call VerifyScreenDump(buf, 'Test_display_cursor_long_line_3', {}) " Same for "ge". call term_sendkeys(buf, '$ge') call VerifyScreenDump(buf, 'Test_display_cursor_long_line_4', {}) call StopVimInTerminal(buf) endfunc " vim: shiftwidth=2 sts=2 expandtab