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>

# vi:set ts=8 sts=4 sw=4 et fdm=marker:
#
# tradchinese.nsi: Traditional Chinese language strings for gvim NSIS
# installer.
#
# Locale ID    : 1028
# fileencoding : UTF-8
# Author       : Guopeng Wen

!insertmacro MUI_LANGUAGE "TradChinese"


# Overwrite the default translation.
# These strings should be always English.  Otherwise dosinst.c fails.
LangString ^SetupCaption     ${LANG_TRADCHINESE} \
        "$(^Name) Setup"
LangString ^UninstallCaption ${LANG_TRADCHINESE} \
        "$(^Name) Uninstall"

##############################################################################
# MUI Configuration Strings                                               {{{1
##############################################################################

#LangString str_dest_folder          ${LANG_TRADCHINESE} \
#    "安裝資料夾 (必須以 vim 結尾)"

LangString str_show_readme          ${LANG_TRADCHINESE} \
    "安裝完成後顯示 README 檔案"

# Install types:
LangString str_type_typical         ${LANG_TRADCHINESE} \
    "典型安裝"

LangString str_type_minimal         ${LANG_TRADCHINESE} \
    "最小安裝"

LangString str_type_full            ${LANG_TRADCHINESE} \
    "完全安裝"


##############################################################################
# Section Titles & Description                                            {{{1
##############################################################################

LangString str_section_old_ver      ${LANG_TRADCHINESE} \
    "移除舊版本"
LangString str_desc_old_ver         ${LANG_TRADCHINESE} \
    "移除閣下電腦上舊版本的 Vim。"

LangString str_section_exe          ${LANG_TRADCHINESE} \
    "安裝 Vim 圖形界面程式"
LangString str_desc_exe             ${LANG_TRADCHINESE} \
    "安裝 Vim 圖形界面程式及腳本。此為必選安裝。"

LangString str_section_console      ${LANG_TRADCHINESE} \
    "安裝 Vim 命令行程式"
LangString str_desc_console         ${LANG_TRADCHINESE} \
    "安裝 Vim 命令行程式 (vim.exe)。該程式在控制臺窗口中運行。"

LangString str_section_batch        ${LANG_TRADCHINESE} \
    "安裝批次檔案"
LangString str_desc_batch           ${LANG_TRADCHINESE} \
    "為 Vim 的各種變體創建批次檔，以便在命令行下啟動 Vim。"

LangString str_group_icons          ${LANG_TRADCHINESE} \
    "建立 Vim 圖示"
LangString str_desc_icons           ${LANG_TRADCHINESE} \
    "建立若干 Vim 圖示，以便于使用 Vim。"

LangString str_section_desktop      ${LANG_TRADCHINESE} \
    "於桌面"
LangString str_desc_desktop         ${LANG_TRADCHINESE} \
    "建立若干 Vim 圖示於桌面上，以方便啟動 Vim。"

LangString str_section_start_menu   ${LANG_TRADCHINESE} \
    "於「開始」功能表的「程式」集"
LangString str_desc_start_menu      ${LANG_TRADCHINESE} \
    "在「開始」功能表的「程式」集中建立 Vim 啟動組。\
     適用于 Windows 95 及以上版本。"

#LangString str_section_quick_launch ${LANG_TRADCHINESE} \
#    "於快速啟動列"
#LangString str_desc_quick_launch    ${LANG_TRADCHINESE} \
#    "在快速啟動列中建立 Vim 圖示。"

LangString str_section_edit_with    ${LANG_TRADCHINESE} \
    "安裝快捷選單"
LangString str_desc_edit_with       ${LANG_TRADCHINESE} \
    "在「打開方式」快捷選單中添加 Vim 項。"

#LangString str_section_edit_with32  ${LANG_TRADCHINESE} \
#    "32 位元版本"
#LangString str_desc_edit_with32     ${LANG_TRADCHINESE} \
#    "在 32 位元程式的「打開方式」快捷選單中添加 Vim 項。"

#LangString str_section_edit_with64  ${LANG_TRADCHINESE} \
#    "64 位元版本"
#LangString str_desc_edit_with64     ${LANG_TRADCHINESE} \
#    "在 64 位元程式的「打開方式」快捷選單中添加 Vim 項。"

LangString str_section_vim_rc       ${LANG_TRADCHINESE} \
    "建立默認設定檔"
LangString str_desc_vim_rc          ${LANG_TRADCHINESE} \
    "在安裝資料夾下建立默認的 Vim 設定檔(_vimrc)。\
     若該設定檔已經存在，則略過此項。"

LangString str_group_plugin         ${LANG_TRADCHINESE} \
    "建立插件資料夾"
LangString str_desc_plugin          ${LANG_TRADCHINESE} \
    "建立(空的)插件資料夾結構。插件資料夾用于安裝 Vim 的擴展插件，\
     只要將檔案復制到相關的子資料夾中即可。"

LangString str_section_plugin_home  ${LANG_TRADCHINESE} \
    "建立插件資料夾"
LangString str_desc_plugin_home     ${LANG_TRADCHINESE} \
    "Create plugin directories in HOME directory."

LangString str_section_plugin_vim   ${LANG_TRADCHINESE} \
    "建立共享插件資料夾"
LangString str_desc_plugin_vim      ${LANG_TRADCHINESE} \
    "在 Vim 安裝資料夾下建立(空的)插件資料夾結構，電腦上所有用戶都能使用安裝\
     在該資料夾里的擴展插件。"

LangString str_section_nls          ${LANG_TRADCHINESE} \
    "安裝本地語言支持"
LangString str_desc_nls             ${LANG_TRADCHINESE} \
    "安裝用于支持本地語言的檔案。"

LangString str_unsection_register   ${LANG_TRADCHINESE} \
    "移除 Vim 系統設定"
LangString str_desc_unregister      ${LANG_TRADCHINESE} \
    "移除與 Vim 相關的系統設定。"

LangString str_unsection_exe        ${LANG_TRADCHINESE} \
    "移除 Vim 程式及腳本"
LangString str_desc_rm_exe          ${LANG_TRADCHINESE} \
    "移除所有的 Vim 程式及腳本。"

LangString str_ungroup_plugin       ${LANG_TRADCHINESE} \
    "Remove plugin directories"
LangString str_desc_rm_plugin       ${LANG_TRADCHINESE} \
    "Remove the plugin directories if they are empty."

LangString str_unsection_plugin_home ${LANG_TRADCHINESE} \
    "Private"
LangString str_desc_rm_plugin_home  ${LANG_TRADCHINESE} \
    "Remove the vimfiles directory in HOME directory."

LangString str_unsection_plugin_vim ${LANG_TRADCHINESE} \
    "Shared"
LangString str_desc_rm_plugin_vim   ${LANG_TRADCHINESE} \
    "Remove the vimfiles directory in Vim install directory."

LangString str_unsection_rootdir    ${LANG_TRADCHINESE} \
    "Remove the Vim root directory"
LangString str_desc_rm_rootdir      ${LANG_TRADCHINESE} \
    "Remove the Vim root directory. It contains your Vim configuration files!"


##############################################################################
# Messages                                                                {{{1
##############################################################################

#LangString str_msg_too_many_ver  ${LANG_TRADCHINESE} \
#    "閣下的電腦上安裝了 $vim_old_ver_count 個不同版本的 Vim，$\r$\n\
#     但是本安裝程式最多只能處理 ${VIM_MAX_OLD_VER} 個版本。$\r$\n\
#     煩請閣下手工移除一些版本以后再運行本安裝程式。"

#LangString str_msg_invalid_root  ${LANG_TRADCHINESE} \
#    "安裝資料夾「$vim_install_root」無效！$\r$\n\
#     該資料夾必須以「vim」結尾。"

#LangString str_msg_bin_mismatch  ${LANG_TRADCHINESE} \
#    "Vim 執行程式安裝路徑異常！$\r$\n$\r$\n\
#     該版本 Vim 的執行程式安裝路徑應該是「$vim_bin_path」,$\r$\n\
#     而系統卻指示該路徑為「$INSTDIR」。"

#LangString str_msg_vim_running   ${LANG_TRADCHINESE} \
#    "閣下的電腦上尚有正在運行之 Vim，$\r$\n\
#     煩請閣下在執行后續步驟前將其全部退出。"

#LangString str_msg_register_ole  ${LANG_TRADCHINESE} \
#    "試圖注冊 Vim OLE 伺服程式。請注意不論成功與否都不再顯示進一步的信息。"

#LangString str_msg_unreg_ole     ${LANG_TRADCHINESE} \
#    "試圖注銷 Vim OLE 伺服程式。請注意不論成功與否都不再顯示進一步的信息。"

#LangString str_msg_rm_start      ${LANG_TRADCHINESE} \
#    "正移除如下版本："

#LangString str_msg_rm_fail       ${LANG_TRADCHINESE} \
#    "以下版本移除失敗："

#LangString str_msg_no_rm_key     ${LANG_TRADCHINESE} \
#    "找不到反安裝程式的登錄檔入口。"

#LangString str_msg_no_rm_reg     ${LANG_TRADCHINESE} \
#    "在登錄檔中未找到反安裝程式路徑。"

#LangString str_msg_no_rm_exe     ${LANG_TRADCHINESE} \
#    "找不到反安裝程式。"

#LangString str_msg_rm_copy_fail  ${LANG_TRADCHINESE} \
#    "無法將法將反安裝程式复制到臨時目錄。"

#LangString str_msg_rm_run_fail   ${LANG_TRADCHINESE} \
#    "執行反安裝程式失敗。"

#LangString str_msg_abort_install ${LANG_TRADCHINESE} \
#    "安裝程式將退出。"

LangString str_msg_install_fail  ${LANG_TRADCHINESE} \
    "安裝失敗。預祝下次好運。"

LangString str_msg_rm_exe_fail   ${LANG_TRADCHINESE} \
    "資料夾「$0」下有部分檔案未能移除！$\r$\n\
     閣下只能手工移除該資料夾。"

#LangString str_msg_rm_root_fail  ${LANG_TRADCHINESE} \
#    "警告：無法刪除 Vim 安裝資料夾「$vim_install_root」，\
#     該資料夾下仍有其他檔案。"

LangString str_msg_uninstalling  ${LANG_TRADCHINESE} \
    "Uninstalling the old version..."

LangString str_msg_registering   ${LANG_TRADCHINESE} \
    "Registering..."

LangString str_msg_unregistering ${LANG_TRADCHINESE} \
    "Unregistering..."


##############################################################################
# Dialog Box                                                              {{{1
##############################################################################

LangString str_vimrc_page_title    ${LANG_TRADCHINESE} \
    "Choose _vimrc settings"
LangString str_vimrc_page_subtitle ${LANG_TRADCHINESE} \
    "Choose the settings for enhancement, keyboard and mouse."

LangString str_msg_compat_title    ${LANG_TRADCHINESE} \
    " Vi / Vim behavior "
LangString str_msg_compat_desc     ${LANG_TRADCHINESE} \
    "&Compatibility and enhancements"
LangString str_msg_compat_vi       ${LANG_TRADCHINESE} \
    "Vi compatible"
LangString str_msg_compat_vim      ${LANG_TRADCHINESE} \
    "Vim original"
LangString str_msg_compat_defaults ${LANG_TRADCHINESE} \
    "Vim with some enhancements (load defaults.vim)"
LangString str_msg_compat_all      ${LANG_TRADCHINESE} \
    "Vim with all enhancements (load vimrc_example.vim) (Default)"

LangString str_msg_keymap_title   ${LANG_TRADCHINESE} \
    " Mappings "
LangString str_msg_keymap_desc    ${LANG_TRADCHINESE} \
    "&Remap a few keys for Windows (Ctrl-V, Ctrl-C, Ctrl-A, Ctrl-S, Ctrl-F, etc)"
LangString str_msg_keymap_default ${LANG_TRADCHINESE} \
    "Do not remap keys (Default)"
LangString str_msg_keymap_windows ${LANG_TRADCHINESE} \
    "Remap a few keys"

LangString str_msg_mouse_title   ${LANG_TRADCHINESE} \
    " Mouse "
LangString str_msg_mouse_desc    ${LANG_TRADCHINESE} \
    "&Behavior of right and left buttons"
LangString str_msg_mouse_default ${LANG_TRADCHINESE} \
    "Right: popup menu, Left: visual mode (Default)"
LangString str_msg_mouse_windows ${LANG_TRADCHINESE} \
    "Right: popup menu, Left: select mode (Windows)"
LangString str_msg_mouse_unix    ${LANG_TRADCHINESE} \
    "Right: extends selection, Left: visual mode (Unix)"