Skip to content

gh-105323: Update readline module to detect apple editline variant #108665

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 19 commits into from
Sep 29, 2023
Merged

gh-105323: Update readline module to detect apple editline variant #108665

Show file tree
Hide file tree
Changes from 12 commits
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
868cb8a
gh-105323: Introduce --with-readline=apple option
corona10 Aug 29, 2023
4266177
Update macOS build
corona10 Aug 30, 2023
08b7a97
Update
corona10 Aug 30, 2023
23c4660
Update build-installer.py
corona10 Aug 30, 2023
33b01c5
Update
corona10 Aug 30, 2023
0220538
Update
corona10 Aug 30, 2023
3465ca4
Update Azure pipeline
corona10 Aug 30, 2023
9b9b8c7
Merge remote-tracking branch 'upstream/main' into gh-105223-apple-rea…
corona10 Sep 15, 2023
b8a99f8
Address Erlend's review
corona10 Sep 15, 2023
d1039b5
Use AX_CHECK_TYPEDEF and revert some changes
corona10 Sep 15, 2023
cd40e26
Update
corona10 Sep 15, 2023
4cfeb1d
Minor fix
corona10 Sep 15, 2023
b9800d9
Use AC_CHECK_TYPES
corona10 Sep 22, 2023
dfcbae0
Use AC_CHECK_TYPE
corona10 Sep 22, 2023
501f1a4
Merge remote-tracking branch 'upstream/main' into gh-105223-apple-rea…
corona10 Sep 22, 2023
33ad827
Address Erlend's code review
corona10 Sep 28, 2023
2201f75
fix
corona10 Sep 28, 2023
abbe94b
Update Doc/using/configure.rst
corona10 Sep 29, 2023
a6bcd03
Update Modules/readline.c
corona10 Sep 29, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions Doc/using/configure.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -615,11 +615,12 @@ Libraries options

.. versionadded:: 3.3

.. cmdoption:: --with-readline=editline
.. cmdoption:: --with-readline=readline|editline

Use ``editline`` library for backend of the :mod:`readline` module.
Desinate a backend library of the :mod:`readline` module.

Define the ``WITH_EDITLINE`` macro.
* readline: Use readline as the backend.
* editline: Use editline as the backend.

.. versionadded:: 3.10

Expand Down
14 changes: 12 additions & 2 deletions Modules/readline.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1018,10 +1018,16 @@ on_hook(PyObject *func)
static int
#if defined(_RL_FUNCTION_TYPEDEF)
on_startup_hook(void)
{
#elif defined(__APPLE__) && defined(WITH_APPLE_EDITLINE)
on_startup_hook(const char *text, int state)
{
(void)text;
(void)state;
#else
on_startup_hook(void)
#endif
{
#endif
int r;
PyGILState_STATE gilstate = PyGILState_Ensure();
r = on_hook(readlinestate_global->startup_hook);
Expand All @@ -1033,10 +1039,14 @@ on_startup_hook(void)
static int
#if defined(_RL_FUNCTION_TYPEDEF)
on_pre_input_hook(void)
{
#elif defined(__APPLE__) && defined(WITH_APPLE_EDITLINE)
on_pre_input_hook(const char *Py_UNUSED(text), int Py_UNUSED(state))
{
#else
on_pre_input_hook(void)
#endif
{
#endif
int r;
PyGILState_STATE gilstate = PyGILState_Ensure();
r = on_hook(readlinestate_global->pre_input_hook);
Expand Down
56 changes: 56 additions & 0 deletions aclocal.m4
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

45 changes: 45 additions & 0 deletions configure
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

7 changes: 7 additions & 0 deletions configure.ac
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5814,6 +5814,7 @@ dnl library (tinfo ncursesw ncurses termcap). We now assume that libreadline
dnl or readline.pc provide correct linker information.

AH_TEMPLATE([WITH_EDITLINE], [Define to build the readline module against libedit.])
AH_TEMPLATE([WITH_APPLE_EDITLINE], [Define to build the readline module against Apple BSD editline.])

AC_ARG_WITH(
[readline],
Expand All @@ -5830,6 +5831,12 @@ AC_ARG_WITH(
[with_readline=readline]
)

dnl gh-105323: Need to handle the macOS editline as an alias of readline.
AS_CASE([$ac_sys_system/$ac_sys_release],
[Darwin/*], [AX_CHECK_TYPEDEF(Function, readline/readline.h, AC_DEFINE([WITH_APPLE_EDITLINE]))],
Copy link
Member Author

@corona10 corona10 Sep 15, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@erlend-aasland cc @ronaldoussoren

I am not sure why AC_DEFINE([WITH_APPLE_EDITLINE]) is not generated in configure file.
Checking itself looks okay but the problem is if the condition is true it doesn't do as my expectation.

checking whether right shift extends the sign bit... yes
checking for getc_unlocked() and friends... yes
checking for Function in readline/readline.h... yes

[]
)

AS_VAR_IF([with_readline], [readline], [
PKG_CHECK_MODULES([LIBREADLINE], [readline], [
LIBREADLINE=readline
Expand Down
3 changes: 3 additions & 0 deletions pyconfig.h.in
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1788,6 +1788,9 @@
/* Define if WINDOW in curses.h offers a field _flags. */
#undef WINDOW_HAS_FLAGS

/* Define to build the readline module against Apple BSD editline. */
#undef WITH_APPLE_EDITLINE

/* Define if you want build the _decimal module using a coroutine-local rather
than a thread-local context */
#undef WITH_DECIMAL_CONTEXTVAR
Expand Down