Mercurial > vim
view src/spell.h @ 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 | ce04a773d598 |
children |
line wrap: on
line source
/* vi:set ts=8 sts=4 sw=4 noet: * * VIM - Vi IMproved by Bram Moolenaar * * Do ":help uganda" in Vim to read copying and usage conditions. * Do ":help credits" in Vim to see a list of people who contributed. * See README.txt for an overview of the Vim source code. */ /* * spell.h: common code for spell checking, used by spell.c and spellfile.c. */ // Use SPELL_PRINTTREE for debugging: dump the word tree after adding a word. // Only use it for small word lists! #if 0 # define SPELL_PRINTTREE #endif // Use SPELL_COMPRESS_ALWAYS for debugging: compress the word tree after // adding a word. Only use it for small word lists! #if 0 # define SPELL_COMPRESS_ALWAYS #endif // Use DEBUG_TRIEWALK to print the changes made in suggest_trie_walk() for a // specific word. #if 0 # define DEBUG_TRIEWALK #endif #define MAXWLEN 254 // Assume max. word len is this many bytes. // Some places assume a word length fits in a // byte, thus it can't be above 255. // Must be >= PFD_NOTSPECIAL. #define MAXREGIONS 8 // Number of regions supported. // Type used for indexes in the word tree need to be at least 4 bytes. If int // is 8 bytes we could use something smaller, but what? typedef int idx_T; typedef int salfirst_T; /* * Structure used to store words and other info for one language, loaded from * a .spl file. * The main access is through the tree in "sl_fbyts/sl_fidxs", storing the * case-folded words. "sl_kbyts/sl_kidxs" is for keep-case words. * * The "byts" array stores the possible bytes in each tree node, preceded by * the number of possible bytes, sorted on byte value: * <len> <byte1> <byte2> ... * The "idxs" array stores the index of the child node corresponding to the * byte in "byts". * Exception: when the byte is zero, the word may end here and "idxs" holds * the flags, region mask and affixID for the word. There may be several * zeros in sequence for alternative flag/region/affixID combinations. */ typedef struct slang_S slang_T; struct slang_S { slang_T *sl_next; // next language char_u *sl_name; // language name "en", "en.rare", "nl", etc. char_u *sl_fname; // name of .spl file int sl_add; // TRUE if it's a .add file. char_u *sl_fbyts; // case-folded word bytes long sl_fbyts_len; // length of sl_fbyts idx_T *sl_fidxs; // case-folded word indexes char_u *sl_kbyts; // keep-case word bytes idx_T *sl_kidxs; // keep-case word indexes char_u *sl_pbyts; // prefix tree word bytes idx_T *sl_pidxs; // prefix tree word indexes char_u *sl_info; // infotext string or NULL char_u sl_regions[MAXREGIONS * 2 + 1]; // table with up to 8 region names plus NUL char_u *sl_midword; // MIDWORD string or NULL hashtab_T sl_wordcount; // hashtable with word count, wordcount_T int sl_compmax; // COMPOUNDWORDMAX (default: MAXWLEN) int sl_compminlen; // COMPOUNDMIN (default: 0) int sl_compsylmax; // COMPOUNDSYLMAX (default: MAXWLEN) int sl_compoptions; // COMP_* flags garray_T sl_comppat; // CHECKCOMPOUNDPATTERN items regprog_T *sl_compprog; // COMPOUNDRULE turned into a regexp progrm // (NULL when no compounding) char_u *sl_comprules; // all COMPOUNDRULE concatenated (or NULL) char_u *sl_compstartflags; // flags for first compound word char_u *sl_compallflags; // all flags for compound words char_u sl_nobreak; // When TRUE: no spaces between words char_u *sl_syllable; // SYLLABLE repeatable chars or NULL garray_T sl_syl_items; // syllable items int sl_prefixcnt; // number of items in "sl_prefprog" regprog_T **sl_prefprog; // table with regprogs for prefixes garray_T sl_rep; // list of fromto_T entries from REP lines short sl_rep_first[256]; // indexes where byte first appears, -1 if // there is none garray_T sl_sal; // list of salitem_T entries from SAL lines salfirst_T sl_sal_first[256]; // indexes where byte first appears, -1 if // there is none int sl_followup; // SAL followup int sl_collapse; // SAL collapse_result int sl_rem_accents; // SAL remove_accents int sl_sofo; // SOFOFROM and SOFOTO instead of SAL items: // "sl_sal_first" maps chars, when has_mbyte // "sl_sal" is a list of wide char lists. garray_T sl_repsal; // list of fromto_T entries from REPSAL lines short sl_repsal_first[256]; // sl_rep_first for REPSAL lines int sl_nosplitsugs; // don't suggest splitting a word int sl_nocompoundsugs; // don't suggest compounding // Info from the .sug file. Loaded on demand. time_t sl_sugtime; // timestamp for .sug file char_u *sl_sbyts; // soundfolded word bytes idx_T *sl_sidxs; // soundfolded word indexes buf_T *sl_sugbuf; // buffer with word number table int sl_sugloaded; // TRUE when .sug file was loaded or failed to // load int sl_has_map; // TRUE if there is a MAP line hashtab_T sl_map_hash; // MAP for multi-byte chars int sl_map_array[256]; // MAP for first 256 chars hashtab_T sl_sounddone; // table with soundfolded words that have // handled, see add_sound_suggest() }; #ifdef VMS # define SPL_FNAME_TMPL "%s_%s.spl" # define SPL_FNAME_ADD "_add." # define SPL_FNAME_ASCII "_ascii." #else # define SPL_FNAME_TMPL "%s.%s.spl" # define SPL_FNAME_ADD ".add." # define SPL_FNAME_ASCII ".ascii." #endif // Flags used for a word. Only the lowest byte can be used, the region byte // comes above it. #define WF_REGION 0x01 // region byte follows #define WF_ONECAP 0x02 // word with one capital (or all capitals) #define WF_ALLCAP 0x04 // word must be all capitals #define WF_RARE 0x08 // rare word #define WF_BANNED 0x10 // bad word #define WF_AFX 0x20 // affix ID follows #define WF_FIXCAP 0x40 // keep-case word, allcap not allowed #define WF_KEEPCAP 0x80 // keep-case word #define WF_CAPMASK (WF_ONECAP | WF_ALLCAP | WF_KEEPCAP | WF_FIXCAP) // for <flags2>, shifted up one byte to be used in wn_flags #define WF_HAS_AFF 0x0100 // word includes affix #define WF_NEEDCOMP 0x0200 // word only valid in compound #define WF_NOSUGGEST 0x0400 // word not to be suggested #define WF_COMPROOT 0x0800 // already compounded word, COMPOUNDROOT #define WF_NOCOMPBEF 0x1000 // no compounding before this word #define WF_NOCOMPAFT 0x2000 // no compounding after this word // flags for <pflags> #define WFP_RARE 0x01 // rare prefix #define WFP_NC 0x02 // prefix is not combining #define WFP_UP 0x04 // to-upper prefix #define WFP_COMPPERMIT 0x08 // prefix with COMPOUNDPERMITFLAG #define WFP_COMPFORBID 0x10 // prefix with COMPOUNDFORBIDFLAG // Flags for postponed prefixes in "sl_pidxs". Must be above affixID (one // byte) and prefcondnr (two bytes). #define WF_RAREPFX (WFP_RARE << 24) // rare postponed prefix #define WF_PFX_NC (WFP_NC << 24) // non-combining postponed prefix #define WF_PFX_UP (WFP_UP << 24) // to-upper postponed prefix #define WF_PFX_COMPPERMIT (WFP_COMPPERMIT << 24) // postponed prefix with // COMPOUNDPERMITFLAG #define WF_PFX_COMPFORBID (WFP_COMPFORBID << 24) // postponed prefix with // COMPOUNDFORBIDFLAG // flags for <compoptions> #define COMP_CHECKDUP 1 // CHECKCOMPOUNDDUP #define COMP_CHECKREP 2 // CHECKCOMPOUNDREP #define COMP_CHECKCASE 4 // CHECKCOMPOUNDCASE #define COMP_CHECKTRIPLE 8 // CHECKCOMPOUNDTRIPLE // Info from "REP", "REPSAL" and "SAL" entries in ".aff" file used in si_rep, // si_repsal, sl_rep, and si_sal. Not for sl_sal! // One replacement: from "ft_from" to "ft_to". typedef struct fromto_S { char_u *ft_from; char_u *ft_to; } fromto_T; // Info from "SAL" entries in ".aff" file used in sl_sal. // The info is split for quick processing by spell_soundfold(). // Note that "sm_oneof" and "sm_rules" point into sm_lead. typedef struct salitem_S { char_u *sm_lead; // leading letters int sm_leadlen; // length of "sm_lead" char_u *sm_oneof; // letters from () or NULL char_u *sm_rules; // rules like ^, $, priority char_u *sm_to; // replacement. int *sm_lead_w; // wide character copy of "sm_lead" int *sm_oneof_w; // wide character copy of "sm_oneof" int *sm_to_w; // wide character copy of "sm_to" } salitem_T; // Values for SP_*ERROR are negative, positive values are used by // read_cnt_string(). #define SP_TRUNCERROR (-1) // spell file truncated error #define SP_FORMERROR (-2) // format error in spell file #define SP_OTHERERROR (-3) // other error while reading spell file /* * Structure used in "b_langp", filled from 'spelllang'. */ typedef struct langp_S { slang_T *lp_slang; // info for this language slang_T *lp_sallang; // language used for sound folding or NULL slang_T *lp_replang; // language used for REP items or NULL int lp_region; // bitmask for region or REGION_ALL } langp_T; #define LANGP_ENTRY(ga, i) (((langp_T *)(ga).ga_data) + (i)) #define VIMSUGMAGIC "VIMsug" // string at start of Vim .sug file #define VIMSUGMAGICL 6 #define VIMSUGVERSION 1 /* * The tables used for recognizing word characters according to spelling. * These are only used for the first 256 characters of 'encoding'. */ typedef struct spelltab_S { char_u st_isw[256]; // flags: is word char char_u st_isu[256]; // flags: is uppercase char char_u st_fold[256]; // chars: folded case char_u st_upper[256]; // chars: upper case } spelltab_T; /* * Use our own character-case definitions, because the current locale may * differ from what the .spl file uses. * These must not be called with negative number! */ #if defined(HAVE_WCHAR_H) # include <wchar.h> // for towupper() and towlower() #endif // Multi-byte implementation. For Unicode we can call utf_*(), but don't do // that for ASCII, because we don't want to use 'casemap' here. Otherwise use // the "w" library function for characters above 255 if available. #ifdef HAVE_TOWLOWER # define SPELL_TOFOLD(c) (enc_utf8 && (c) >= 128 ? utf_fold(c) \ : (c) < 256 ? (int)spelltab.st_fold[c] : (int)towlower(c)) #else # define SPELL_TOFOLD(c) (enc_utf8 && (c) >= 128 ? utf_fold(c) \ : (c) < 256 ? (int)spelltab.st_fold[c] : (c)) #endif #ifdef HAVE_TOWUPPER # define SPELL_TOUPPER(c) (enc_utf8 && (c) >= 128 ? utf_toupper(c) \ : (c) < 256 ? (int)spelltab.st_upper[c] : (int)towupper(c)) #else # define SPELL_TOUPPER(c) (enc_utf8 && (c) >= 128 ? utf_toupper(c) \ : (c) < 256 ? (int)spelltab.st_upper[c] : (c)) #endif #ifdef HAVE_ISWUPPER # define SPELL_ISUPPER(c) (enc_utf8 && (c) >= 128 ? utf_isupper(c) \ : (c) < 256 ? spelltab.st_isu[c] : iswupper(c)) #else # define SPELL_ISUPPER(c) (enc_utf8 && (c) >= 128 ? utf_isupper(c) \ : (c) < 256 ? spelltab.st_isu[c] : (FALSE)) #endif #ifdef FEAT_SPELL # ifdef IN_SPELL_C # define SPELL_EXTERN # define SPELL_INIT(x) x # else # define SPELL_EXTERN extern # define SPELL_INIT(x) # endif // First language that is loaded, start of the linked list of loaded // languages. SPELL_EXTERN slang_T *first_lang SPELL_INIT(= NULL); // file used for "zG" and "zW" SPELL_EXTERN char_u *int_wordlist SPELL_INIT(= NULL); SPELL_EXTERN spelltab_T spelltab; SPELL_EXTERN int did_set_spelltab; // Values for "what" argument of spell_add_word() #define SPELL_ADD_GOOD 0 #define SPELL_ADD_BAD 1 #define SPELL_ADD_RARE 2 typedef struct wordcount_S { short_u wc_count; // nr of times word was seen char_u wc_word[1]; // word, actually longer } wordcount_T; #define WC_KEY_OFF offsetof(wordcount_T, wc_word) #define HI2WC(hi) ((wordcount_T *)((hi)->hi_key - WC_KEY_OFF)) #define MAXWORDCOUNT 0xffff // Remember what "z?" replaced. SPELL_EXTERN char_u *repl_from SPELL_INIT(= NULL); SPELL_EXTERN char_u *repl_to SPELL_INIT(= NULL); #endif