gh-105323: Introduce --with-readline=apple option

Author: corona10

.github/workflows/build.yml

@@ -229,6 +229,7 @@ jobs:
           --config-cache \
           --with-pydebug \
           --prefix=/opt/python-dev \
+          --with-readline=apple \
           --with-openssl="$(brew --prefix [email protected])"
     - name: Build CPython
       run: make -j4

Doc/using/configure.rst

@@ -515,13 +515,17 @@ Libraries options
 
    .. versionadded:: 3.3
 
-.. cmdoption:: --with-readline=editline
+.. cmdoption:: --with-readline=readline|editline|apple
 
-   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: default backend
+   editline: Define the ``WITH_EDITLINE`` macro.
+   apple: Define the ``WITH_APPLE_READLINE`` macro.
 
    .. versionadded:: 3.10
+   .. versionchanged:: 3.13
+      ``apple`` for macOS specific backend library option is added.
 
 .. cmdoption:: --without-readline
 

Misc/NEWS.d/next/Build/2023-08-30-11-56-31.gh-issue-105323.mT3plK.rst

@@ -0,0 +1 @@
+``--with-readline=apple`` is added for macOS build. Patch by Dong-hee Na.

Modules/readline.c

@@ -1019,10 +1019,16 @@ on_hook(PyObject *func)
 static int
 #if defined(_RL_FUNCTION_TYPEDEF)
 on_startup_hook(void)
+{
+#elif defined(__APPLE__) && defined(WITH_APPLE_READLINE)
+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);
@@ -1034,10 +1040,16 @@ on_startup_hook(void)
 static int
 #if defined(_RL_FUNCTION_TYPEDEF)
 on_pre_input_hook(void)
+{
+#elif defined(__APPLE__) && defined(WITH_APPLE_READLINE)
+on_pre_input_hook(const char *text, int state)
+{
+  (void)text;
+  (void)state;
 #else
 on_pre_input_hook(void)
-#endif
 {
+#endif
     int r;
     PyGILState_STATE gilstate = PyGILState_Ensure();
     r = on_hook(readlinestate_global->pre_input_hook);

configure

@@ -5813,6 +5813,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_READLINE], [Define to build the readline module agains apple builtin readline.])
 
 AC_ARG_WITH(
   [readline],
@@ -5822,13 +5823,21 @@ AC_ARG_WITH(
     AS_CASE([$with_readline],
       [editline|edit], [with_readline=edit],
       [yes|readline], [with_readline=readline],
+      [apple], [with_readline=apple],
       [no], [],
       [AC_MSG_ERROR([proper usage is --with(out)-readline@<:@=editline|readline|no@:>@])]
     )
   ],
   [with_readline=readline]
 )
 
+dnl gh-105323: Need to handle the macOS editline as an alias of readline.
+AS_VAR_IF([with_readline], [apple], [
+  AS_CASE([$ac_sys_system/$ac_sys_release],
+    [Darwin/*], [AC_DEFINE([WITH_APPLE_READLINE]) with_readline=readline],
+    [])]
+)
+
 AS_VAR_IF([with_readline], [readline], [
   PKG_CHECK_MODULES([LIBREADLINE], [readline], [
     LIBREADLINE=readline

configure.ac

@@ -1791,6 +1791,9 @@
 /* Define if WINDOW in curses.h offers a field _flags. */
 #undef WINDOW_HAS_FLAGS
 
+/* Define to build the readline module agains apple builtin readline. */
+#undef WITH_APPLE_READLINE
+
 /* Define if you want build the _decimal module using a coroutine-local rather
    than a thread-local context */
 #undef WITH_DECIMAL_CONTEXTVAR